Skip to content
This repository was archived by the owner on May 20, 2025. It is now read-only.

Commit f420076

Browse files
committed
apply heading suggestions.
1 parent 196bf2a commit f420076

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/guides/deno/byo-deep-research.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -172,11 +172,11 @@ const OAI = new OpenAI({
172172
// LLM_MODEL=llama3.2:3b # For local testing
173173
```
174174

175-
### Prompt Templates
175+
### 3. Prompt Templates
176176

177177
The system uses three types of LLM calls, each with its own prompt template:
178178

179-
1. **Query Generation** (`queryPrompt`): Generates search queries based on the research topic
179+
#### 1. **Query Generation** (`queryPrompt`): Generates search queries based on the research topic
180180

181181
```typescript title:prompts/query.ts
182182
export default (date: string, topic: string) => `
@@ -209,7 +209,7 @@ Provide your response only in JSON format:
209209
`
210210
```
211211

212-
2. **Content Summarization** (`summarizerPrompt`): Summarizes content in the context of research topics
212+
#### 2. **Content Summarization** (`summarizerPrompt`): Summarizes content in the context of research topics
213213

214214
```typescript title:prompts/summarizer.ts
215215
export default (topics: string[]) => `<GOAL>
@@ -237,12 +237,12 @@ When EXTENDING an existing summary:
237237
- Start directly with the updated summary, without preamble or titles. Do not use XML tags in the output.
238238
</FORMATTING>
239239
240-
<Task>
240+
<TASK>
241241
Think carefully about the provided Context first. Then generate a summary of the context to address the User Input.
242-
</Task>`
242+
</TASK>`
243243
```
244244

245-
3. **Research Reflection** (`reflectionPrompt`): Analyzes current research to identify knowledge gaps
245+
#### 3. **Research Reflection** (`reflectionPrompt`): Analyzes current research to identify knowledge gaps
246246

247247
```typescript title:prompts/reflect.ts
248248
export default (topics: string[]) => `
@@ -273,7 +273,7 @@ These prompts work together to create a research system that:
273273
- Attempts to identify knowledge gaps
274274
- Continues research if required
275275

276-
### 3. Topic-based Research Pipeline
276+
### 4. Topic-based Research Pipeline
277277

278278
The system uses a topic-based approach to conduct research, with different message types for each stage of the process:
279279

@@ -312,7 +312,7 @@ interface ReflectTopicMessage extends ResearchTopicMessage<'reflect'> {
312312
}
313313
```
314314

315-
### 4. Content Processing
315+
### 5. Content Processing
316316

317317
The system includes HTML cleaning and markdown conversion:
318318

@@ -355,7 +355,7 @@ function cleanHtml(html: string): string {
355355
}
356356
```
357357

358-
### 5. The Nitric API Implementation
358+
### 6. The Nitric API Implementation
359359

360360
The main API implementation ties everything together:
361361

0 commit comments

Comments
 (0)