> ## 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

[Tavily](https://tavily.com) 是專為 AI 應用程式設計的搜尋 API。OpenClaw 以兩種方式公開它：

* 作為通用搜尋工具的 `web_search` provider
* 作為明確的外掛工具：`tavily_search` 與 `tavily_extract`

Tavily 會傳回針對 LLM 使用最佳化的結構化結果，具備可設定的搜尋深度、主題篩選、網域篩選、AI 產生的答案摘要，以及從 URL 擷取內容（包含 JavaScript 算繪頁面）。

| 屬性     | 值                                                                          |
| ------ | -------------------------------------------------------------------------- |
| 外掛 id  | `tavily`                                                                   |
| 套件     | `@openclaw/tavily-plugin`                                                  |
| 驗證     | `TAVILY_API_KEY` 環境變數或 config `apiKey`                                     |
| 基礎 URL | `https://api.tavily.com`（預設）；以 `TAVILY_BASE_URL` 環境變數或 config `baseUrl` 覆寫 |
| 逾時     | 搜尋 30 秒、擷取 60 秒（預設）                                                        |
| 工具     | `tavily_search`、`tavily_extract`                                           |

## 開始使用

<Steps>
  <Step title="Install the plugin">
    ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
    openclaw plugins install @openclaw/tavily-plugin
    ```
  </Step>

  <Step title="Get an API key">
    在 [tavily.com](https://tavily.com) 建立 Tavily 帳戶，然後在儀表板中產生 API 金鑰。
  </Step>

  <Step title="Configure the plugin and provider">
    ```json5 theme={"theme":{"light":"min-light","dark":"min-dark"}}
    {
      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",
          },
        },
      },
    }
    ```
  </Step>

  <Step title="Verify search runs">
    從任何 agent 觸發 `web_search`，或直接呼叫 `tavily_search`。
  </Step>
</Steps>

<Tip>
  在入門設定或 `openclaw configure --section web` 中選擇 Tavily，會在需要時安裝並啟用官方 Tavily 外掛。
</Tip>

## 工具參考

### `tavily_search`

當你想使用 Tavily 專屬搜尋控制，而不是通用的 `web_search` 時使用此工具。

| 參數                | 類型           | 限制 / 預設值                       | 說明                    |
| ----------------- | ------------ | ------------------------------ | --------------------- |
| `query`           | string       | 必填                             | 搜尋查詢字串。               |
| `search_depth`    | enum         | `basic`（預設）、`advanced`         | `advanced` 較慢，但相關性較高。 |
| `topic`           | enum         | `general`（預設）、`news`、`finance` | 依主題類型篩選。              |
| `max_results`     | integer      | 1-20，預設 `5`                    | 結果數量。                 |
| `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`

使用此工具從一個或多個 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、動態內容、表格。 |

<Tip>
  將較大的 URL 清單分批成多次 `tavily_extract` 呼叫（每個請求最多 20 個）。使用 `query` 搭配 `chunks_per_source`，只取得相關內容，而不是完整頁面。
</Tip>

## 選擇正確的工具

| 需求             | 工具               |
| -------------- | ---------------- |
| 快速網頁搜尋，無特殊選項   | `web_search`     |
| 以深度、主題、AI 答案搜尋 | `tavily_search`  |
| 從特定 URL 擷取內容   | `tavily_extract` |

<Note>
  以 Tavily 作為 provider 的通用 `web_search` 工具支援 `query` 與 `count`（最多 20 筆結果）。若要使用 Tavily 專屬控制（`search_depth`、`topic`、`include_answer`、網域篩選、時間範圍），請改用 `tavily_search`。
</Note>

## 進階設定

<AccordionGroup>
  <Accordion title="API key resolution order">
    Tavily 用戶端會依下列順序查找 API 金鑰：

    1. `plugins.entries.tavily.config.webSearch.apiKey`（透過 SecretRefs 解析）。
    2. 閘道環境中的 `TAVILY_API_KEY`。

    若兩者皆不存在，`tavily_search` 與 `tavily_extract` 都會引發設定錯誤。
  </Accordion>

  <Accordion title="Custom base URL">
    如果你透過代理伺服器連到 Tavily，請覆寫 `plugins.entries.tavily.config.webSearch.baseUrl`，或設定 `TAVILY_BASE_URL`。Config 的優先順序高於環境變數。預設值為 `https://api.tavily.com`。
  </Accordion>

  <Accordion title="`chunks_per_source` requires `query`">
    `tavily_extract` 會拒絕傳入 `chunks_per_source` 但未提供 `query` 的呼叫。Tavily 會依查詢相關性排序分塊，因此沒有查詢時，此參數沒有意義。
  </Accordion>
</AccordionGroup>

## 相關

<CardGroup cols={2}>
  <Card title="Web Search overview" href="/zh-TW/tools/web" icon="magnifying-glass">
    所有 provider 與自動偵測規則。
  </Card>

  <Card title="Firecrawl" href="/zh-TW/tools/firecrawl" icon="fire">
    搜尋加上含內容擷取的爬取。
  </Card>

  <Card title="Exa Search" href="/zh-TW/tools/exa-search" icon="binoculars">
    含內容擷取的神經搜尋。
  </Card>

  <Card title="Configuration" href="/zh-TW/gateway/configuration" icon="gear">
    外掛項目與工具路由的完整 config schema。
  </Card>
</CardGroup>