mirror of
https://github.com/crewAIInc/crewAI.git
synced 2026-07-05 06:59:23 +00:00
* feat: adopt directory-based docs versioning with Edge channel Switch docs.crewai.com from navigation-only versioning (every version selector entry rendered the same docs/<lang>/* source files) to Mintlify's directory-based versioning so each version selector entry renders its own snapshot. Add an "Edge" channel under docs/edge/<lang>/* that always reflects main HEAD for unreleased work, eliminating pre-release leakage onto frozen release labels. External links to canonical /<lang>/* URLs are preserved via wildcard redirects that always land on the current default version. Layout: - docs/edge/<lang>/* rolling source (you edit here) - docs/edge/enterprise-api.*.yaml - docs/v<X.Y.Z>/<lang>/* frozen, immutable snapshots - docs/v<X.Y.Z>/enterprise-api.*.yaml - docs/images/ shared, append-only - docs/docs.json nav + redirects URLs follow the Mintlify-idiomatic shape: /edge/<lang>/<page> for Edge, /v<X.Y.Z>/<lang>/<page> for every frozen snapshot. The wildcard redirects /<lang>/:slug* -> /<default>/<lang>/:slug* keep stale links working, and every freeze rewrites them (plus all per-section/per-page redirects) so destinations always resolve to the current default without depending on a second redirect hop. Release flow integration (devtools release): - New module crewai_devtools.docs_versioning.freeze() materialises docs/v<X.Y.Z>/ from docs/edge/, rewrites openapi: refs inside the snapshot, inserts the version into every language block in docs.json, and refreshes all redirect destinations. - _update_docs_and_create_pr() in cli.py now calls that freeze during Phase 2 of devtools release. Edge changelogs are updated first (so the snapshot freeze picks them up), then the snapshot is staged alongside docs.json, branched as docs/freeze-v<X.Y.Z>, and the PR is titled [docs-freeze] docs: snapshot and changelog for v<X.Y.Z> — the title prefix the new CI guard reads. - The PR still gates tag, GitHub release, PyPI publish, and the enterprise release as before; no new PRs are added. - Pre-releases (1.X.YaN, 1.X.YbN, ...) skip the snapshot — they ride Edge — and the docs PR title omits the [docs-freeze] prefix. - docs_check (AI-generated docs scaffolding) writes to docs/edge/<lang>/* so newly-generated unreleased docs land in Edge and never accidentally touch a frozen snapshot. Migration scripts (one-shot): - scripts/docs/freeze_historical_versions.py reconstructs all 16 historical snapshots (v1.10.0 .. v1.14.7) from git tags via git archive | tar, rewriting openapi: MDX refs so each snapshot reads its own enterprise-api YAML rather than the live one. - scripts/docs/prefix_version_paths.py one-shot-migrates docs.json: rewrites every page path in 16 versioned blocks to point under docs/v<X.Y.Z>/, inserts a new Edge entry per language, tags v1.14.7 as Latest (default), prunes pages whose target file doesn't exist in the snapshot (e.g. docs/ar/ didn't exist before v1.12.0), and writes the wildcard + per-section redirects. - scripts/docs/freeze_current_edge.py is now a thin CLI wrapper around docs_versioning.freeze for manual one-off freezes (e.g. retroactively snapshotting a forgotten release). CI guards (.github/workflows/docs-snapshots.yml): - Frozen snapshots under docs/v[0-9]*/ are immutable; only PRs whose title contains [docs-freeze] (i.e. release-cut PRs generated by devtools release or the manual wrapper) may modify them. - Images under docs/images/ are append-only since snapshots share a single image directory. Deleting or renaming an image breaks every historical snapshot that still references it. Restored docs/images/crewai-otel-export.png from PR #3673; it was deleted in PR #4908 but v1.10.0 / v1.10.1 snapshots still reference it. Restoring instead of editing the snapshots preserves historical rendering fidelity and validates the new append-only rule retroactively. Tests: - lib/devtools/tests/test_docs_versioning.py covers the freeze: file copy, openapi rewrite, version insertion, default demotion, redirect upserts, per-section redirect rewriting, idempotency, and invalid inputs. Verified locally with mintlify broken-links: 0 broken links across the full site (Edge + 16 frozen versions, 4 locales). AGENTS.md (repo root) is the contributor guide for the new model; RELEASING.md is the release-cut runbook; README's Contribution section links to both. Co-authored-by: Cursor <cursoragent@cursor.com> * style: resolve linter issues --------- Co-authored-by: Cursor <cursoragent@cursor.com>
126 lines
4.3 KiB
Plaintext
126 lines
4.3 KiB
Plaintext
---
|
|
title: "Tavily Research Tool"
|
|
description: "Run multi-step research tasks and get cited reports using the Tavily Research API"
|
|
icon: "flask"
|
|
mode: "wide"
|
|
---
|
|
|
|
The `TavilyResearchTool` lets CrewAI agents kick off Tavily research tasks, returning a synthesized, cited report (or a stream of progress events) instead of raw search results. Use it when an agent needs an investigative answer rather than a single web search.
|
|
|
|
## Installation
|
|
|
|
To use the `TavilyResearchTool`, install the `tavily-python` library alongside `crewai-tools`:
|
|
|
|
```shell
|
|
uv add 'crewai[tools]' tavily-python
|
|
```
|
|
|
|
## Environment Variables
|
|
|
|
Set your Tavily API key:
|
|
|
|
```bash
|
|
export TAVILY_API_KEY='your_tavily_api_key'
|
|
```
|
|
|
|
Get an API key at [https://app.tavily.com/](https://app.tavily.com/) (sign up, then create a key).
|
|
|
|
## Example Usage
|
|
|
|
```python
|
|
import os
|
|
from crewai import Agent, Crew, Task
|
|
from crewai_tools import TavilyResearchTool
|
|
|
|
# Ensure TAVILY_API_KEY is set in your environment
|
|
# os.environ["TAVILY_API_KEY"] = "YOUR_API_KEY"
|
|
|
|
tavily_tool = TavilyResearchTool()
|
|
|
|
researcher = Agent(
|
|
role="Research Analyst",
|
|
goal="Investigate questions and produce concise, well-cited briefings.",
|
|
backstory=(
|
|
"You are a meticulous analyst who delegates web research to the Tavily "
|
|
"Research tool, then synthesizes the findings into short briefings."
|
|
),
|
|
tools=[tavily_tool],
|
|
verbose=True,
|
|
)
|
|
|
|
research_task = Task(
|
|
description=(
|
|
"Investigate notable open-source agent orchestration frameworks released "
|
|
"in the last six months and summarize their differentiators."
|
|
),
|
|
expected_output="A bulleted briefing with citations.",
|
|
agent=researcher,
|
|
)
|
|
|
|
crew = Crew(agents=[researcher], tasks=[research_task])
|
|
print(crew.kickoff())
|
|
```
|
|
|
|
## Configuration Options
|
|
|
|
The `TavilyResearchTool` accepts the following arguments — all can be set on the tool instance (defaults for every call) or per-call via the agent's tool input:
|
|
|
|
- `input` (str): **Required.** The research task or question to investigate.
|
|
- `model` (Literal["mini", "pro", "auto"]): The Tavily research model. `"auto"` lets Tavily pick; `"mini"` is faster/cheaper; `"pro"` is the most capable. Defaults to `"auto"`.
|
|
- `output_schema` (dict | None): Optional JSON Schema that structures the research output. Useful when you want strictly typed results.
|
|
- `stream` (bool): When `True`, the tool returns an iterator of SSE chunks emitting research progress and the final result instead of a single string. Defaults to `False`.
|
|
- `citation_format` (Literal["numbered", "mla", "apa", "chicago"]): Citation format for the report. Defaults to `"numbered"`.
|
|
|
|
## Advanced Usage
|
|
|
|
### Configure defaults on the tool instance
|
|
|
|
```python
|
|
from crewai_tools import TavilyResearchTool
|
|
|
|
tavily_tool = TavilyResearchTool(
|
|
model="pro", # use Tavily's most capable research model
|
|
citation_format="apa", # APA-style citations
|
|
)
|
|
```
|
|
|
|
### Stream research progress
|
|
|
|
When `stream=True`, the tool returns a generator (or async generator from `_arun`) of SSE chunks so your application can surface incremental progress:
|
|
|
|
```python
|
|
tavily_tool = TavilyResearchTool(stream=True)
|
|
|
|
for chunk in tavily_tool.run(input="Summarize recent advances in retrieval-augmented generation."):
|
|
print(chunk)
|
|
```
|
|
|
|
### Structured output via JSON Schema
|
|
|
|
Pass an `output_schema` when you need a typed result instead of a free-form report:
|
|
|
|
```python
|
|
output_schema = {
|
|
"type": "object",
|
|
"properties": {
|
|
"summary": {"type": "string"},
|
|
"key_points": {"type": "array", "items": {"type": "string"}},
|
|
"sources": {"type": "array", "items": {"type": "string"}},
|
|
},
|
|
"required": ["summary", "key_points", "sources"],
|
|
}
|
|
|
|
tavily_tool = TavilyResearchTool(output_schema=output_schema)
|
|
```
|
|
|
|
## Features
|
|
|
|
- **End-to-end research**: Returns a synthesized, cited report rather than raw search hits.
|
|
- **Model selection**: Trade off cost, speed, and depth via `mini`, `pro`, or `auto`.
|
|
- **Streaming**: Stream incremental progress and results as SSE chunks for responsive UIs.
|
|
- **Structured output**: Coerce results to a JSON Schema you define.
|
|
- **Multiple citation styles**: Choose from numbered, MLA, APA, or Chicago citations.
|
|
- **Sync and async**: Use either `_run` or `_arun` depending on your application's runtime.
|
|
|
|
Refer to the [Tavily API documentation](https://docs.tavily.com/) for full details on the Research API.
|