Tools

Tavily

Tavily は、AI アプリケーション向けに設計された検索 API です。OpenClaw では、次の 2 つの方法で利用できます。

  • 汎用検索ツールの web_search プロバイダーとして
  • 明示的な Plugin ツールとして:tavily_searchtavily_extract

Tavily は、LLM での利用に最適化された構造化結果を返します。検索深度、トピックフィルタリング、ドメインフィルター、AI が生成する回答要約、URL からのコンテンツ抽出(JavaScript でレンダリングされるページを含む)を設定できます。

プロパティ
Plugin ID tavily
パッケージ @openclaw/tavily-plugin
認証 TAVILY_API_KEY 環境変数または設定 apiKey
ベース URL https://api.tavily.com(デフォルト)。オーバーライドするには TAVILY_BASE_URL 環境変数または設定 baseUrl
タイムアウト 検索 30s、抽出 60s(デフォルト)
ツール tavily_searchtavily_extract

はじめに

  • Plugin をインストールする

    bash
    openclaw plugins install @openclaw/tavily-plugin
  • API キーを取得する

    tavily.com で Tavily アカウントを作成し、ダッシュボードで API キーを生成します。

  • Plugin とプロバイダーを設定する

    json5
    {  plugins: {    entries: {      tavily: {        enabled: true,        config: {          webSearch: {            apiKey: "tvly-...", // TAVILY_API_KEY が設定されている場合は省略可能            baseUrl: "https://api.tavily.com",          },        },      },    },  },  tools: {    web: {      search: {        provider: "tavily",      },    },  },}
  • 検索が実行されることを確認する

    任意のエージェントから web_search をトリガーするか、tavily_search を直接呼び出します。

  • ツールリファレンス

    汎用の web_search ではなく、Tavily 固有の検索制御を使用する場合に利用します。

    パラメーター 制約/デフォルト 説明
    query 文字列 必須 検索クエリ文字列。
    search_depth 列挙型 basic(デフォルト)、advanced advanced は低速ですが、関連性が高くなります。
    topic 列挙型 general(デフォルト)、newsfinance トピックカテゴリーでフィルタリングします。
    max_results 整数 1-20、デフォルト 5 結果数。
    include_answer 真偽値 デフォルト false Tavily AI が生成した回答要約を含めます。
    time_range 列挙型 dayweekmonthyear 新しさで結果をフィルタリングします。
    include_domains 文字列配列 (なし) これらのドメインの結果のみを含めます。
    exclude_domains 文字列配列 (なし) これらのドメインの結果を除外します。

    検索深度のトレードオフ:

    深度 速度 関連性 最適な用途
    basic 高速 高い 汎用クエリ(デフォルト)。
    advanced 低速 最高 精密な調査と事実確認。

    tavily_extract

    1 つ以上の URL からクリーンなコンテンツを抽出する場合に利用します。JavaScript でレンダリングされるページを処理でき、対象を絞った抽出のためにクエリに基づくチャンク化をサポートします。

    パラメーター 制約/デフォルト 説明
    urls 文字列配列 必須、1-20 コンテンツの抽出元 URL。
    query 文字列 (任意) このクエリとの関連性に基づいて、抽出されたチャンクを再順位付けします。
    extract_depth 列挙型 basic(デフォルト)、advanced JS を多用するページ、SPA、または動的テーブルには advanced を使用します。
    chunks_per_source 整数 1-5。query が必要 URL ごとに返されるチャンク数。query なしで設定するとエラーになります。
    include_images 真偽値 デフォルト false 結果に画像 URL を含めます。

    抽出深度のトレードオフ:

    深度 使用する場合
    basic 単純なページ。まずはこちらを試してください。
    advanced JS でレンダリングされる SPA、動的コンテンツ、テーブル。

    適切なツールの選択

    ニーズ ツール
    特別なオプションを使用しない高速なウェブ検索 web_search
    深度、トピック、AI 回答を指定した検索 tavily_search
    特定の URL からコンテンツを抽出 tavily_extract

    高度な設定

    API キーの解決順序

    Tavily クライアントは、次の順序で API キーを検索します。

    1. plugins.entries.tavily.config.webSearch.apiKey(SecretRefs を介して解決)。
    2. Gateway 環境の TAVILY_API_KEY

    どちらも存在しない場合、tavily_searchtavily_extract はセットアップエラーを発生させます。

    カスタムベース URL

    プロキシ経由で Tavily を利用する場合は、plugins.entries.tavily.config.webSearch.baseUrl をオーバーライドするか、TAVILY_BASE_URL を設定します。設定は環境変数より優先されます。デフォルトは https://api.tavily.com です。

    `chunks_per_source` には `query` が必要

    tavily_extract は、query なしで chunks_per_source を渡す呼び出しを拒否します。Tavily はクエリとの関連性に基づいてチャンクを順位付けするため、クエリがなければこのパラメーターに意味はありません。

    関連項目

    Was this useful?
    On this page

    On this page