Tools
Tavily
Tavily は AI アプリケーション向けに設計された検索 API です。OpenClaw はこれを 2 つの方法で公開します。
- 汎用検索ツールの
web_searchプロバイダーとして - 明示的な Plugin ツールとして:
tavily_searchとtavily_extract
Tavily は、設定可能な検索深度、トピックフィルタリング、ドメインフィルター、AI 生成の回答要約、URL からのコンテンツ抽出(JavaScript でレンダリングされたページを含む)を備え、LLM での利用に最適化された構造化結果を返します。
| プロパティ | 値 |
|---|---|
| Plugin ID | tavily |
| パッケージ | @openclaw/tavily-plugin |
| 認証 | TAVILY_API_KEY または config apiKey |
| ベース URL | https://api.tavily.com(デフォルト) |
| ツール | tavily_search, tavily_extract |
はじめに
Plugin をインストールする
openclaw plugins install @openclaw/tavily-pluginAPI キーを取得する
tavily.com で Tavily アカウントを作成し、ダッシュボードで API キーを生成します。
Plugin とプロバイダーを設定する
{ plugins: { entries: { tavily: { enabled: true, config: { webSearch: { apiKey: "tvly-...", // optional if TAVILY_API_KEY is set baseUrl: "https://api.tavily.com", }, }, }, }, }, tools: { web: { search: { provider: "tavily", }, }, },}検索が実行されることを確認する
任意のエージェントから web_search をトリガーするか、tavily_search を直接呼び出します。
ツールリファレンス
tavily_search
汎用の web_search ではなく Tavily 固有の検索コントロールを使いたい場合に使用します。
| パラメーター | 型 | 制約 / デフォルト | 説明 |
|---|---|---|---|
query |
string | 必須 | 検索クエリ文字列。400 文字未満にしてください。 |
search_depth |
enum | basic(デフォルト), advanced |
advanced は遅くなりますが、関連性が高くなります。 |
topic |
enum | general(デフォルト), news, finance |
トピックファミリーでフィルタリングします。 |
max_results |
integer | 1-20 | 結果の数。 |
include_answer |
boolean | デフォルト false |
Tavily の AI 生成回答要約を含めます。 |
time_range |
enum | day, week, month, year |
新しさで結果をフィルタリングします。 |
include_domains |
string array | (なし) | これらのドメインからの結果のみを含めます。 |
exclude_domains |
string array | (なし) | これらのドメインからの結果を除外します。 |
検索深度のトレードオフ:
| 深度 | 速度 | 関連性 | 最適な用途 |
|---|---|---|---|
basic |
高速 | 高い | 汎用クエリ(デフォルト)。 |
advanced |
低速 | 最高 | 精密な調査と事実確認。 |
tavily_extract
1 つ以上の URL からクリーンなコンテンツを抽出するために使用します。JavaScript でレンダリングされたページを扱い、対象を絞った抽出のためのクエリ重視のチャンク化をサポートします。
| パラメーター | 型 | 制約 / デフォルト | 説明 |
|---|---|---|---|
urls |
string array | 必須, 1-20 | コンテンツを抽出する URL。 |
query |
string | (任意) | 抽出したチャンクをこのクエリへの関連性で再ランクします。 |
extract_depth |
enum | basic(デフォルト), advanced |
JS が多いページ、SPA、または動的テーブルには advanced を使用します。 |
chunks_per_source |
integer | 1-5; query が必要 |
URL ごとに返されるチャンク数。query なしで設定するとエラーになります。 |
include_images |
boolean | デフォルト false |
結果に画像 URL を含めます。 |
抽出深度のトレードオフ:
| 深度 | 使用する場面 |
|---|---|
basic |
シンプルなページ。まずこれを試してください。 |
advanced |
JS でレンダリングされた SPA、動的コンテンツ、テーブル。 |
適切なツールを選ぶ
| ニーズ | ツール |
|---|---|
| 特別なオプションなしのクイック Web 検索 | web_search |
| 深度、トピック、AI 回答付きの検索 | tavily_search |
| 特定の URL からコンテンツを抽出する | tavily_extract |
高度な設定
API キーの解決順序
Tavily クライアントは次の順序で API キーを検索します。
plugins.entries.tavily.config.webSearch.apiKey(SecretRefs 経由で解決)。- Gateway 環境の
TAVILY_API_KEY。
どちらも存在しない場合、tavily_extract はセットアップエラーを発生させます。
カスタムベース URL
Tavily をプロキシ経由で前段に置く場合は、plugins.entries.tavily.config.webSearch.baseUrl を上書きします。デフォルトは https://api.tavily.com です。
`chunks_per_source` には `query` が必要
tavily_extract は、query なしで chunks_per_source を渡す呼び出しを拒否します。Tavily はクエリへの関連性でチャンクをランク付けするため、このパラメーターはクエリなしでは意味がありません。