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

feat: add official api

Browse Source
This commit is contained in:
Han Xiao 2025-02-12 15:56:00 +08:00
parent 16a2f60fec
commit 48f9863c59
2 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -1,5 +1,7 @@
# DeepResearch
[API](#official-api) | [Evaluation](#evaluation)
Keep searching, reading webpages, reasoning until an answer is found (or the token budget is exceeded). Useful for deeply investigating a query.
```mermaid
@ -23,7 +25,7 @@ flowchart LR
```
Note that this project doesn't try to mimic what OpenAI or Gemini do with their deep research product. The idea in this project is about using this loop cycle to repeat the search until finding the answer. This project doesn't implement the structural article generation part. So if you want a service that can do deep searches and give you an answer, this is it. If you want a service that mimics long article writing like OpenAI/Gemini, **this isn't it.**
Note that this project does *not* try to mimic what OpenAI or Gemini do with their deep research product. **We focus on finding the right answer with this loop cycle.** There is no plan to implement the structural article generation part. So if you want a service that can do deep searches and give you an answer, this is it. If you want a service that mimics long article writing like OpenAI/Gemini, **this isn't it.**
## Install
@ -51,6 +53,19 @@ export JINA_API_KEY=jina_... # free jina api key, get from https://jina.ai/read
npm run dev $QUERY
```
### Official API
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.
For the authentication Bearer token, you can get Jina API key from https://jina.ai
## Demo
> was recorded with `gemini-1.5-flash`, the latest `gemini-2.0-flash` leads to much better results!

4
jina-ai/src/dto/jina-embeddings-auth.ts
View File

@ -208,7 +208,7 @@ export class JinaEmbeddingsAuthDTO extends AutoCastable {
async getBrief(ignoreCache?: boolean | string) {
if (!this.bearerToken) {
throw new AuthenticationRequiredError({
message: 'Absence of bearer token'
message: 'Jina API key is required to authenticate. Please get one from https://jina.ai'
});
}
@ -250,7 +250,7 @@ export class JinaEmbeddingsAuthDTO extends AutoCastable {
if (err?.status === 401) {
throw new AuthenticationFailedError({
message: 'Invalid bearer token'
message: 'Invalid API key, please get a new one from https://jina.ai'
});
}