tavily-ai/tavily-python

Tavily‑Python とは？

Tavily‑Python は Tavily API の公式 Python SDK です。この API は、シンプルな検索、質問応答、コンテンツ抽出、サイトクローリング、サイトマッピング、自動研究レポート生成といったウェブ検索関連のサービスを提供し、Python コードから呼び出せます。

---

主な機能

機能	機能の概要	一般的な用途
search	クエリに該当するウェブ検索結果のリストを返します。	LLM にフィードするか、ユーザーに表示する。
qna_search	質問に簡潔な回答を提供（RAG に適しています）。	プロンプトエンジニアリングやチャットボットのバックエンド。
get_search_context	上位結果から構築された単一のコンテキスト文字列を返します。	Retrieval‑Augmented Generation パイプラインに直接挿入。
extract	最大 20 件の URL からテキスト（およびオプションで画像）を抽出します。	埋め込みや要約の前処理に使用。
crawl (招待制)	スタート URL からサイトを深さ・制限・カスタム指示に従って巡回します。	ドメインからフォーカスされたデータセットを構築。
map (招待制)	サイトの階層構造を返します。	サイトアーキテクチャの可視化やクローリング対象の決定。
research	引用付きのマルチソース研究レポートを生成；ストリーミングと使用状況追跡をサポート。	エージェントやアナリスト向けの自動レポート生成。
feedback	各結果に対するスコアとコメントを Tavily に送信します。	自分のエージェントのランキング改善やユーザーのフィードバック収集。

---

インストールと使い方

pip install tavily-python

from tavily import TavilyClient

# API キーを使用（フル機能を活用するには推奨）
client = TavilyClient(api_key="tvly‑YOUR_KEY")

# シンプルなウェブ検索
results = client.search("リオナルド・メッシは誰ですか？")
print(results)

また、キーレスモード（API キー不要）も利用可能で、search と extract のみが利用可能で、レート制限があります：

client = TavilyClient()  # キーなし
try:
    print(client.search("量子コンピューティングとは何ですか？"))
except TavilyKeylessLimitError as e:
    print(e.retry_after_seconds, "秒後に次のクォータが利用可能")

---

高度な使い方

• カスタム HTTP セッション – 事前に設定された requests.Session または httpx.AsyncClient を挿入（企業のゲートウェイの裏で有用）。
• メタデータヘッダー – オプションの project_id、session_id、human_id、client_name は HTTP ヘッダーとして送信され、追跡に使用されます。
• ストリーミング研究 – stream=True を設定すると、生成されるたびにチャンクを受信できます。
• 使用状況／クレジット – get_research(..., include_usage=True) を呼び出すと、タスクに消費されたクレジット数を確認できます（無料トライアル：月間 1 000 クレジット）。

---

どんな人が使う？

• LLM開発者：迅速かつ信頼性の高いウェブ検索ソースが必要な Retrieval‑Augmented Generation パイプラインを構築する人。
• データエンジニア：独自のクローラーを書かずにコンテンツをスクレイピング・抽出したい人。
• プロダクトチーム：SaaS アプリに「ウェブに質問する」機能を追加したい人。
• 研究アシスタント：引用付きでレポートを自動生成する人。

---

ライセンスとサポート

• MIT ライセンス – 無料で使用・改変・再配布可能。
• 補助が必要な場合は、support@tavily.com までメールを送信するか、Tavily Developer Community に参加してください。

---

すべての詳細はリポジトリの README から直接取得しています。