跳轉到主要內容

Documentation Index

Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

Tavily 是專為 AI 應用程式設計的搜尋 API。OpenClaw 以兩種方式公開它：
  • 作為通用搜尋工具的 web_search provider
  • 作為明確的 Plugin 工具：tavily_search 和 tavily_extract
Tavily 會傳回針對 LLM 使用最佳化的結構化結果，並支援可設定的搜尋深度、主題篩選、網域篩選、AI 產生的答案摘要，以及從 URL 擷取內容（包括以 JavaScript 渲染的頁面）。
屬性值
Plugin idtavily
驗證TAVILY_API_KEY 或設定 apiKey
Base URLhttps://api.tavily.com（預設）
內建工具tavily_search, tavily_extract

​
開始使用

1

取得 API 金鑰

在 tavily.com 建立 Tavily 帳號，然後在儀表板中產生 API 金鑰。
2

設定 Plugin 和 provider

{
  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",
      },
    },
  },
}
3

驗證搜尋是否執行

從任何 agent 觸發 web_search，或直接呼叫 tavily_search。
在 onboarding 或 openclaw configure --section web 中選擇 Tavily，會自動啟用內建的 Tavily Plugin。

​
工具參考

當你想使用 Tavily 專屬的搜尋控制項，而不是通用的 web_search 時，請使用這個工具。
參數類型限制 / 預設說明
querystring必填搜尋查詢字串。保持在 400 個字元以內。
search_depthenumbasic（預設）, advancedadvanced 較慢，但相關性更高。
topicenumgeneral（預設）, news, finance依主題類別篩選。
max_resultsinteger1-20結果數量。
include_answerboolean預設 false包含 Tavily AI 產生的答案摘要。
time_rangeenumday, week, month, year依新近程度篩選結果。
include_domainsstring array（無）只包含來自這些網域的結果。
exclude_domainsstring array（無）排除來自這些網域的結果。
搜尋深度取捨：
深度速度相關性最適合
basic較快高一般用途查詢（預設）。
advanced較慢最高精準研究與事實查核。

​
tavily_extract

使用這個工具從一個或多個 URL 擷取乾淨內容。可處理以 JavaScript 渲染的頁面，並支援以查詢為焦點的分塊，以進行目標式擷取。
參數類型限制 / 預設說明
urlsstring array必填，1-20要擷取內容的 URL。
querystring（選填）依此查詢的相關性重新排序擷取出的區塊。
extract_depthenumbasic（預設）, advanced對 JS-heavy 頁面、SPA 或動態表格使用 advanced。
chunks_per_sourceinteger1-5；需要 query每個 URL 傳回的區塊數。如果未設定 query 就設定會出錯。
include_imagesboolean預設 false在結果中包含圖片 URL。
擷取深度取捨：
深度使用時機
basic簡單頁面。先嘗試這個。
advancedJS-rendered SPA、動態內容、表格。
將較大的 URL 清單分批為多次 tavily_extract 呼叫（每個請求最多 20 個）。使用 query 搭配 chunks_per_source，只取得相關內容，而不是完整頁面。

​
選擇正確的工具

需求工具
快速網頁搜尋，不需要特殊選項web_search
使用深度、主題、AI 答案進行搜尋tavily_search
從特定 URL 擷取內容tavily_extract
將 Tavily 作為 provider 的通用 web_search 工具支援 query 和 count（最多 20 筆結果）。若要使用 Tavily 專屬控制項（search_depth、topic、include_answer、網域篩選、時間範圍），請改用 tavily_search。

​
進階設定

Tavily client 會依下列順序查找其 API 金鑰：
  1. plugins.entries.tavily.config.webSearch.apiKey（透過 SecretRefs 解析）。
  2. Gateway 環境中的 TAVILY_API_KEY。
如果兩者都不存在，tavily_extract 會引發設定錯誤。
如果你透過 proxy front Tavily，請覆寫 plugins.entries.tavily.config.webSearch.baseUrl。預設為 https://api.tavily.com。
tavily_extract 會拒絕傳入 chunks_per_source 但未傳入 query 的呼叫。Tavily 會依查詢相關性排序區塊，因此沒有查詢時此參數沒有意義。

​
相關

Web Search 概觀

所有 provider 和自動偵測規則。

Firecrawl

搜尋加上具備內容擷取的 scraping。

Exa Search

具備內容擷取的神經搜尋。

設定

Plugin entries 和工具路由的完整設定 schema。