mirror of
https://github.com/jina-ai/node-DeepResearch.git
synced 2025-12-26 06:28:56 +08:00
140 lines
4.1 KiB
Markdown
140 lines
4.1 KiB
Markdown
# DeepResearch
|
|
|
|
Keep searching and reading webpages until finding the answer (or exceeding the token budget).
|
|
|
|
Query: `"who is the biggest? cohere, jina ai, voyage?"` - 13 steps
|
|
|
|
|
|
|
|
## Install
|
|
|
|
We use gemini for llm, brave for search, jina reader for reading a webpage.
|
|
|
|
```bash
|
|
export GOOGLE_API_KEY=... # ask han
|
|
export BRAVE_API_KEY=... # brave provide free key, ask han
|
|
export JINA_API_KEY=jina_... # get from jina.ai
|
|
|
|
git clone https://github.com/jina-ai/node-DeepResearch.git
|
|
cd node-DeepResearch
|
|
npm install
|
|
```
|
|
|
|
## Example
|
|
```
|
|
# example: no tool calling
|
|
npm run dev "1+1="
|
|
npm run dev "what is the capital of France?"
|
|
|
|
# example: 2-step
|
|
npm run dev "what is the latest news from Jina AI?"
|
|
|
|
# example: 3-step
|
|
npm run dev "what is the twitter account of jina ai's founder"
|
|
|
|
# example: many-step, ambiguious question
|
|
npm run dev "who is bigger? cohere, jina ai, voyage?"
|
|
|
|
# example: open question, long chain of thoughts
|
|
npm run dev "who will be president of US in 2028?"
|
|
npm run dev "what should be jina ai strategy for 2025?"
|
|
```
|
|
|
|
## Web Server API
|
|
|
|
Start the server:
|
|
```bash
|
|
npm run serve
|
|
```
|
|
|
|
The server will start on http://localhost:3000 with the following endpoints:
|
|
|
|
### POST /api/v1/query
|
|
Submit a query to be answered:
|
|
```bash
|
|
curl -X POST http://localhost:3000/api/v1/query \
|
|
-H "Content-Type: application/json" \
|
|
-d '{
|
|
"q": "what is the capital of France?",
|
|
"budget": 1000000,
|
|
"maxBadAttempt": 3
|
|
}'
|
|
```
|
|
|
|
Response:
|
|
```json
|
|
{
|
|
"requestId": "1234567890"
|
|
}
|
|
```
|
|
|
|
### GET /api/v1/stream/:requestId
|
|
Connect to the Server-Sent Events stream to receive progress updates and the final answer:
|
|
```bash
|
|
curl -N http://localhost:3000/api/v1/stream/1234567890
|
|
```
|
|
|
|
The server will emit the following event types:
|
|
- Progress updates: Step number and budget usage
|
|
- Final answer with complete response data
|
|
- Error messages if something goes wrong
|
|
|
|
Example events:
|
|
```
|
|
data: {"type":"progress","data":"Step 1 / Budget used 10%"}
|
|
data: {"type":"progress","data":"Step 2 / Budget used 25%"}
|
|
data: {"type":"answer","data":{"action":"answer","answer":"Paris is the capital of France","references":[]}}
|
|
```
|
|
|
|
|
|
## How Does it Work?
|
|
|
|
Not sure a flowchart helps, but here it is:
|
|
|
|
```mermaid
|
|
flowchart TD
|
|
Start([Start]) --> Init[Initialize context & variables]
|
|
Init --> CheckBudget{Token budget<br/>exceeded?}
|
|
CheckBudget -->|No| GetQuestion[Get current question<br/>from gaps]
|
|
CheckBudget -->|Yes| BeastMode[Enter Beast Mode]
|
|
|
|
GetQuestion --> GenPrompt[Generate prompt]
|
|
GenPrompt --> ModelGen[Generate response<br/>using Gemini]
|
|
ModelGen --> ActionCheck{Check action<br/>type}
|
|
|
|
ActionCheck -->|answer| AnswerCheck{Is original<br/>question?}
|
|
AnswerCheck -->|Yes| EvalAnswer[Evaluate answer]
|
|
EvalAnswer --> IsGoodAnswer{Is answer<br/>definitive?}
|
|
IsGoodAnswer -->|Yes| HasRefs{Has<br/>references?}
|
|
HasRefs -->|Yes| End([End])
|
|
HasRefs -->|No| GetQuestion
|
|
IsGoodAnswer -->|No| StoreBad[Store bad attempt<br/>Reset context]
|
|
StoreBad --> GetQuestion
|
|
|
|
AnswerCheck -->|No| StoreKnowledge[Store as intermediate<br/>knowledge]
|
|
StoreKnowledge --> GetQuestion
|
|
|
|
ActionCheck -->|reflect| ProcessQuestions[Process new<br/>sub-questions]
|
|
ProcessQuestions --> DedupQuestions{New unique<br/>questions?}
|
|
DedupQuestions -->|Yes| AddGaps[Add to gaps queue]
|
|
DedupQuestions -->|No| DisableReflect[Disable reflect<br/>for next step]
|
|
AddGaps --> GetQuestion
|
|
DisableReflect --> GetQuestion
|
|
|
|
ActionCheck -->|search| SearchQuery[Execute search]
|
|
SearchQuery --> NewURLs{New URLs<br/>found?}
|
|
NewURLs -->|Yes| StoreURLs[Store URLs for<br/>future visits]
|
|
NewURLs -->|No| DisableSearch[Disable search<br/>for next step]
|
|
StoreURLs --> GetQuestion
|
|
DisableSearch --> GetQuestion
|
|
|
|
ActionCheck -->|visit| VisitURLs[Visit URLs]
|
|
VisitURLs --> NewContent{New content<br/>found?}
|
|
NewContent -->|Yes| StoreContent[Store content as<br/>knowledge]
|
|
NewContent -->|No| DisableVisit[Disable visit<br/>for next step]
|
|
StoreContent --> GetQuestion
|
|
DisableVisit --> GetQuestion
|
|
|
|
BeastMode --> FinalAnswer[Generate final answer] --> End
|
|
```
|