github/node-DeepResearch
1
0
Fork 0
mirror of https://github.com/jina-ai/node-DeepResearch.git synced 2025-12-26 06:28:56 +08:00
Code Issues Packages Projects Releases Wiki Activity

chore: add client integration guidelines

Browse Source
This commit is contained in:
Han Xiao 2025-02-12 16:11:21 +08:00
parent cdb56cc80c
commit 1bae809e41
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -55,16 +55,22 @@ npm run dev $QUERY
### Official API
You can also use our official deepsearch API, hosted and optimized by Jina AI:
You can also use our official DeepSearch API, hosted and optimized by Jina AI:
```
https://deepsearch.jina.ai/v1/chat/completions
```
This API is fully compatible with OpenAI API, so you can use it with any OpenAI-compatible client.
You can use it with any OpenAI-compatible client. For the authentication Bearer, get your Jina API key from https://jina.ai
For the authentication Bearer token, you can get Jina API key from https://jina.ai
#### Client integration guidelines
If you are building a web/local/mobile client that uses `Jina DeepSearch API`, here are some design guidelines:
- Our API is fully compatible with OpenAI API, this should greatly simplify the integration process. The model name is `jina-deepsearch-v1`.
- DeepSearch API is a reasoning+search grounding LLM, so it's best for questions that require deep reasoning and search.
- Two special tokens are introduced `<think>...</think>`, `<references>...</references>`. Please render them with care.
- Guide the user to get a Jina API key from https://jina.ai
- [Download Jina AI logo here](https://jina.ai/logo-Jina-1024.zip)
## Demo
> was recorded with `gemini-1.5-flash`, the latest `gemini-2.0-flash` leads to much better results!