x-deep-research
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseDeep Research
深度调研
Conduct citation-backed research using OpenAI's deep research models.
使用OpenAI的深度研究模型开展带引用的调研。
Agent Workflow
Agent工作流
bash
cd ~/brain/git/personal/agent-instructions0. Ask model → 1. Submit → 2. Poll status → 3. Download → 4. Post-process
bash
cd ~/brain/git/personal/agent-instructions0. 询问模型 → 1. 提交任务 → 2. 轮询状态 → 3. 下载结果 → 4. 后处理
0. Ask User: Model Selection (REQUIRED)
0. 询问用户:模型选择(必填)
Before submitting, ask the user which model to use:
| Model | Quality | Cost | Use When |
|---|---|---|---|
| o3-deep-research | Higher | $1-3 | Important research, external-facing, deep analysis |
| o4-mini-deep-research | Good | $0.20-0.60 | Quick lookups, internal use, cost-sensitive |
Present this choice and wait for user response before proceeding.
提交任务前,需询问用户使用哪个模型:
| 模型 | 质量 | 成本 | 适用场景 |
|---|---|---|---|
| o3-deep-research | 更高 | $1-3 | 重要调研、对外输出、深度分析 |
| o4-mini-deep-research | 良好 | $0.20-0.60 | 快速查询、内部使用、成本敏感 |
向用户展示该选项,等待用户回复后再继续。
1. Submit
1. 提交任务
bash
poetry run python scripts/deep_research.py submit \
--template company \
--topic "Company Name" \
--model o3-deep-research \
--output ~/brain/obsidian/Timatron/Raw\ Transcripts\ \&\ Research/research/Templates: , , , (use for custom)
Models: (default),
companypersonproductcustom--queryo3-deep-researcho4-mini-deep-researchbash
poetry run python scripts/deep_research.py submit \
--template company \
--topic "Company Name" \
--model o3-deep-research \
--output ~/brain/obsidian/Timatron/Raw\ Transcripts\ \&\ Research/research/模板选项:、、、(使用参数自定义)
模型选项:(默认)、
companypersonproductcustom--queryo3-deep-researcho4-mini-deep-research2. Poll Status
2. 轮询状态
bash
poetry run python scripts/deep_research.py status <response_id>Research takes 5-30 minutes. Poll every few minutes until .
completedbash
poetry run python scripts/deep_research.py status <response_id>调研耗时5-30分钟。每隔几分钟轮询一次,直到状态变为。
completed3. Download
3. 下载结果
bash
poetry run python scripts/deep_research.py download <response_id> \
--output ~/brain/obsidian/Timatron/Raw\ Transcripts\ \&\ Research/research/Report usage stats to user (shown after download):
- Model, duration, token counts, cost
bash
poetry run python scripts/deep_research.py download <response_id> \
--output ~/brain/obsidian/Timatron/Raw\ Transcripts\ \&\ Research/research/向用户报告使用统计数据(下载完成后显示):
- 模型、耗时、token数量、成本
4. Post-Process Citations (REQUIRED)
4. 引用后处理(必填)
After downloading, edit the report to convert parenthetical citations to inline links:
Before:
After:
The company raised $100M ([source.com](url)).The company [raised $100M](url).Also consolidate duplicate citations — one link per fact is sufficient.
下载完成后,编辑报告将括号内的引用转换为内联链接:
转换前:
转换后:
The company raised $100M ([source.com](url)).The company [raised $100M](url).同时合并重复引用——每个事实只需一个链接即可。
API Key Setup
API密钥配置
Edit :
~/.config/openai/profiles.jsonjson
{
"default": "personal",
"profiles": {
"personal": {
"api_key": "sk-proj-YOUR-KEY-HERE"
}
}
}Use to select a profile. Falls back to env var.
--profile <name>OPENAI_API_KEY编辑文件:
~/.config/openai/profiles.jsonjson
{
"default": "personal",
"profiles": {
"personal": {
"api_key": "sk-proj-YOUR-KEY-HERE"
}
}
}使用参数选择配置文件。若未配置,将 fallback 到环境变量。
--profile <name>OPENAI_API_KEYPricing Reference
定价参考
| Model | Input/M tokens | Output/M tokens |
|---|---|---|
| o3-deep-research | $10.00 | $40.00 |
| o4-mini-deep-research | $2.00 | $8.00 |
Typical query uses 50-100K tokens. Exact cost reported after download.
| 模型 | 输入/百万tokens | 输出/百万tokens |
|---|---|---|
| o3-deep-research | $10.00 | $40.00 |
| o4-mini-deep-research | $2.00 | $8.00 |
典型查询会使用50-100K tokens。具体成本将在下载完成后显示。
Prompt Templates
提示词模板
Located in :
prompts/- — Common instructions (word limits, citation style, format rules)
base.md - — Company research structure
company.md - — Person research structure
person.md - — Product research structure
product.md
模板文件位于目录下:
prompts/- — 通用指令(字数限制、引用格式、排版规则)
base.md - — 公司调研结构模板
company.md - — 人物调研结构模板
person.md - — 产品调研结构模板
product.md
Troubleshooting
故障排除
- "API key not found": Configure profiles.json or set
OPENAI_API_KEY - "model_not_found": Verify org at https://platform.openai.com/settings/organization/general
- "insufficient_quota": Add credits at https://platform.openai.com/settings/organization/billing
- "API key not found":配置profiles.json文件或设置环境变量
OPENAI_API_KEY - "model_not_found":在https://platform.openai.com/settings/organization/general验证组织权限
- "insufficient_quota":在https://platform.openai.com/settings/organization/billing添加账户余额