tavily-best-practices

Tavily

Tavily は、LLM 向けに設計された検索 API で、AI アプリケーションがリアルタイムのウェブデータにアクセスできるようにします。

インストール

Python:

pip install tavily-python

JavaScript:

npm install @tavily/core

SDK の完全なリファレンスについては、references/sdk.md を参照してください。

クライアントの初期化

from tavily import TavilyClient

# Uses TAVILY_API_KEY env var (recommended)
client = TavilyClient()

#With project tracking (for usage organization)
client = TavilyClient(project_id="your-project-id")

# Async client for parallel queries
from tavily import AsyncTavilyClient
async_client = AsyncTavilyClient()

適切なメソッドの選択

カスタムエージェント／ワークフロー向け：

必要なもの	メソッド
ウェブ検索結果	search()
特定の URL のコンテンツ	extract()
サイト全体のコンテンツ	crawl()
サイトからの URL 検出	map()

すぐに使えるリサーチ向け：

必要なもの	メソッド
AI による統合を含むエンドツーエンドのリサーチ	research()

クイックリファレンス

search() - ウェブ検索

response = client.search(
    query="quantum computing breakthroughs",  # Keep under 400 chars
    max_results=10,
    search_depth="advanced"
)
print(response)

主なパラメーター：query、max_results、search_depth（ultra-fast/fast/basic/advanced）、include_domains、exclude_domains、time_range

検索の完全なリファレンスについては、references/search.md を参照してください。

extract() - URL コンテンツの抽出

# Simple one-step extraction
response = client.extract(
    urls=["https://docs.example.com"],
    extract_depth="advanced"
)
print(response)

主なパラメーター：urls（最大 20 件）、extract_depth、query、chunks_per_source（1～5）

extract の完全なリファレンスについては、references/extract.md を参照してください。

crawl() - サイト全体の抽出

response = client.crawl(
    url="https://docs.example.com",
    instructions="Find API documentation pages",  # Semantic focus
    extract_depth="advanced"
)
print(response)

主なパラメーター：url、max_depth、max_breadth、limit、instructions、chunks_per_source、select_paths、exclude_paths

crawl の完全なリファレンスについては、references/crawl.md を参照してください。

map() - URL の検出

response = client.map(
    url="https://docs.example.com"
)
print(response)

research() - AI を活用したリサーチ

import time

# For comprehensive multi-topic research
result = client.research(
    input="Analyze competitive landscape for X in SMB market",
    model="pro"  # or "mini" for focused queries, "auto" when unsure
)
request_id = result["request_id"]

# Poll until completed
response = client.get_research(request_id)
while response["status"] not in ["completed", "failed"]:
    time.sleep(10)
    response = client.get_research(request_id)

print(response["content"])  # The research report

主なパラメーター：input、model（"mini"/"pro"/"auto"）、stream、output_schema、citation_format

research の完全なリファレンスについては、references/research.md を参照してください。

詳細ガイド

パラメーター、レスポンスフィールド、パターン、例の全容については、以下を参照してください。

• references/sdk.md - Python および JavaScript SDK のリファレンス、非同期パターン、ハイブリッド RAG
• references/search.md - クエリの最適化、検索深度の選択、ドメインフィルタリング、非同期パターン、後処理フィルタリング
• references/extract.md - 1 段階と 2 段階の抽出、対象指定のためのクエリ／チャンク、高度なモード
• references/crawl.md - Crawl と Map の比較、意味的な焦点を指定するための指示、ユースケース、Map の後に Extract を行うパターン
• references/research.md - プロンプト作成のベストプラクティス、モデルの選択、ストリーミング、構造化出力スキーマ
• references/integrations.md - LangChain、LlamaIndex、CrewAI、Vercel AI SDK、およびフレームワークとの統合