|
| 1 | +# NVIDIA Deep Researcher — GitAgent PoC |
| 2 | + |
| 3 | +This is a working proof of concept that defines NVIDIA's [AIQ Deep Researcher](https://github.com/NVIDIA-AI-Blueprints/aiq) agent in the gitagent standard. It demonstrates how GitAgent enhances a production multi-agent system with portability, versioning, compliance, and git-native lifecycle management. |
| 4 | + |
| 5 | +## What This Is |
| 6 | + |
| 7 | +NVIDIA's Deep Researcher is a 3-agent hierarchy that produces comprehensive research reports: |
| 8 | + |
| 9 | +- **Orchestrator** — coordinates workflow, writes final 3000-5000 word report |
| 10 | +- **Planner** — builds TOC, generates search queries, writes structured plan |
| 11 | +- **Researcher** — executes searches (max 8 calls), writes cited findings |
| 12 | + |
| 13 | +This gitagent definition faithfully translates the NVIDIA Jinja2 prompts (`orchestrator.j2`, `planner.j2`, `researcher.j2`) into the gitagent standard format (`SOUL.md`, `RULES.md`, `DUTIES.md`, `agent.yaml`). |
| 14 | + |
| 15 | +## What GitAgent Adds |
| 16 | + |
| 17 | +| Capability | Without GitAgent | With GitAgent | |
| 18 | +|---|---|---| |
| 19 | +| **Portability** | Locked to LangChain runtime | Export to Claude Code, OpenAI, CrewAI, system-prompt | |
| 20 | +| **Prompt versioning** | Prompts in Jinja2 templates | Every SOUL.md change is a git commit; bisect regressions | |
| 21 | +| **SOD enforcement** | Implicit in code | Explicit roles, conflicts, and handoffs validated in CI | |
| 22 | +| **Fork & customize** | Modify Python code | Fork for legal/medical/finance variants without touching code | |
| 23 | +| **Memory** | No persistence across sessions | Version-controlled research session history | |
| 24 | +| **CI/CD** | Manual testing | `gitagent validate --compliance` on every push | |
| 25 | +| **Audit trail** | None | Every prompt, skill, and rule change traced via git | |
| 26 | + |
| 27 | +## Quick Start |
| 28 | + |
| 29 | +### Validate |
| 30 | + |
| 31 | +```bash |
| 32 | +cd examples/nvidia-deep-researcher |
| 33 | +gitagent validate --compliance |
| 34 | +``` |
| 35 | + |
| 36 | +### Export |
| 37 | + |
| 38 | +```bash |
| 39 | +# System prompt (for any LLM) |
| 40 | +gitagent export --format system-prompt |
| 41 | + |
| 42 | +# Claude Code (generates CLAUDE.md) |
| 43 | +gitagent export --format claude-code |
| 44 | +``` |
| 45 | + |
| 46 | +### Info |
| 47 | + |
| 48 | +```bash |
| 49 | +gitagent info |
| 50 | +``` |
| 51 | + |
| 52 | +## Structure |
| 53 | + |
| 54 | +``` |
| 55 | +nvidia-deep-researcher/ |
| 56 | +├── agent.yaml # Agent manifest (models, skills, tools, SOD) |
| 57 | +├── SOUL.md # Orchestrator identity and 8-step workflow |
| 58 | +├── RULES.md # Hard constraints (citations, report format, limits) |
| 59 | +├── AGENTS.md # Multi-agent architecture overview |
| 60 | +├── DUTIES.md # Segregation of duties policy |
| 61 | +├── agents/ |
| 62 | +│ ├── planner/ # Plan generation sub-agent |
| 63 | +│ └── researcher/ # Search execution sub-agent |
| 64 | +├── skills/ |
| 65 | +│ ├── web-search/ # Tavily web search skill |
| 66 | +│ ├── paper-search/ # Google Scholar skill |
| 67 | +│ └── knowledge-retrieval/# RAG knowledge base skill |
| 68 | +├── tools/ |
| 69 | +│ ├── tavily-web-search.yaml |
| 70 | +│ ├── paper-search.yaml |
| 71 | +│ └── knowledge-retrieval.yaml |
| 72 | +├── knowledge/ # Document ingestion index |
| 73 | +├── memory/ # Research session persistence |
| 74 | +├── hooks/ # Bootstrap and teardown hooks |
| 75 | +└── config/ # Environment configurations |
| 76 | +``` |
| 77 | + |
| 78 | +## Fork & Customize |
| 79 | + |
| 80 | +To create a domain-specific variant (e.g., legal research): |
| 81 | + |
| 82 | +```bash |
| 83 | +cp -r examples/nvidia-deep-researcher my-legal-researcher |
| 84 | +cd my-legal-researcher |
| 85 | + |
| 86 | +# Edit SOUL.md to add legal domain expertise |
| 87 | +# Edit RULES.md to add legal citation requirements |
| 88 | +# Add legal knowledge docs to knowledge/ |
| 89 | +# Update agent.yaml with domain-specific metadata |
| 90 | + |
| 91 | +gitagent validate --compliance |
| 92 | +``` |
| 93 | + |
| 94 | +No Python code changes needed — just edit the markdown and YAML files. |
| 95 | + |
| 96 | +## Upstream |
| 97 | + |
| 98 | +This PoC is based on the NVIDIA AIQ Deep Researcher Blueprint: |
| 99 | +- **Repository**: https://github.com/NVIDIA-AI-Blueprints/aiq |
| 100 | +- **Source path**: `src/aiq_agent/agents/deep_researcher` |
| 101 | +- **Prompts**: `prompts/orchestrator.j2`, `prompts/planner.j2`, `prompts/researcher.j2` |
0 commit comments