> ## 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) — это поисковый API, разработанный для приложений ИИ. OpenClaw предоставляет к нему доступ двумя способами:

* как к провайдеру `web_search` для универсального инструмента поиска
* как к отдельным инструментам плагина: `tavily_search` и `tavily_extract`

Tavily возвращает структурированные результаты, оптимизированные для обработки LLM, с настраиваемой глубиной поиска, фильтрацией по темам и доменам, сводками ответов, созданными ИИ, и извлечением содержимого из URL-адресов (включая страницы, отрисовываемые с помощью JavaScript).

| Свойство | Значение |
| - | - |
| ID плагина | `tavily` |
| Пакет | `@openclaw/tavily-plugin` |
| Аутентификация | переменная среды `TAVILY_API_KEY` или параметр конфигурации `apiKey` |
| Базовый URL | `https://api.tavily.com` (по умолчанию); для переопределения используйте переменную среды `TAVILY_BASE_URL` или параметр конфигурации `baseUrl` |
| Тайм-ауты | 30 с для поиска, 60 с для извлечения (по умолчанию) |
| Инструменты | `tavily_search`, `tavily_extract` |

## Начало работы

**1. Установите плагин**

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
openclaw plugins install @openclaw/tavily-plugin
```

**2. Получите ключ API**

Создайте учетную запись Tavily на сайте [tavily.com](https://tavily.com), затем сгенерируйте ключ API на панели управления.

**3. Настройте плагин и провайдер**

```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",
      },
    },
  },
}
```

**4. Проверьте выполнение поиска**

Запустите `web_search` из любого агента или вызовите `tavily_search` напрямую.

> [!TIP]
>
> При выборе Tavily во время первоначальной настройки или в `openclaw configure --section web` официальный плагин Tavily при необходимости устанавливается и включается.

## Справочник по инструментам

### `tavily_search`

Используйте этот инструмент, если вместо универсального `web_search` вам нужны параметры поиска, специфичные для Tavily.

| Параметр | Тип | Ограничения / значение по умолчанию | Описание |
| - | - | - | - |
| `query` | строка | обязателен | Строка поискового запроса. |
| `search_depth` | перечисление | `basic` (по умолчанию), `advanced` | `advanced` работает медленнее, но обеспечивает более высокую релевантность. |
| `topic` | перечисление | `general` (по умолчанию), `news`, `finance` | Фильтрация по категории темы. |
| `max_results` | целое число | 1-20, по умолчанию `5` | Количество результатов. |
| `include_answer` | логический | по умолчанию `false` | Включить созданную ИИ Tavily сводку ответа. |
| `time_range` | перечисление | `day`, `week`, `month`, `year` | Фильтрация результатов по давности. |
| `include_domains` | массив строк | (нет) | Включать только результаты с этих доменов. |
| `exclude_domains` | массив строк | (нет) | Исключать результаты с этих доменов. |

Компромисс при выборе глубины поиска:

| Глубина | Скорость | Релевантность | Оптимальное применение |
| - | - | - | - |
| `basic` | Выше | Высокая | Запросы общего назначения (по умолчанию). |
| `advanced` | Ниже | Максимальная | Точные исследования и поиск фактов. |

### `tavily_extract`

Используйте этот инструмент для извлечения очищенного содержимого из одного или нескольких URL-адресов. Он обрабатывает страницы, отрисовываемые с помощью JavaScript, и поддерживает разбиение на фрагменты с учетом запроса для целевого извлечения.

| Параметр | Тип | Ограничения / значение по умолчанию | Описание |
| - | - | - | - |
| `urls` | массив строк | обязателен, 1-20 | URL-адреса, из которых нужно извлечь содержимое. |
| `query` | строка | (необязательно) | Повторно ранжировать извлеченные фрагменты по релевантности этому запросу. |
| `extract_depth` | перечисление | `basic` (по умолчанию), `advanced` | Используйте `advanced` для страниц с интенсивным использованием JS, SPA или динамических таблиц. |
| `chunks_per_source` | целое число | 1-5; **требуется `query`** | Количество фрагментов, возвращаемых для каждого URL-адреса. Если параметр задан без `query`, возникает ошибка. |
| `include_images` | логический | по умолчанию `false` | Включить URL-адреса изображений в результаты. |

Компромисс при выборе глубины извлечения:

| Глубина | Когда использовать |
| - | - |
| `basic` | Простые страницы. Сначала попробуйте этот вариант. |
| `advanced` | SPA, отрисовываемые с помощью JS, динамическое содержимое и таблицы. |

> [!TIP]
>
> Разделяйте большие списки URL-адресов на несколько вызовов `tavily_extract` (не более 20 на запрос). Используйте `query` вместе с `chunks_per_source`, чтобы получать только релевантное содержимое вместо полных страниц.

## Выбор подходящего инструмента

| Задача | Инструмент |
| - | - |
| Быстрый поиск в интернете без особых параметров | `web_search` |
| Поиск с настройкой глубины, темы и ответами ИИ | `tavily_search` |
| Извлечение содержимого из конкретных URL-адресов | `tavily_extract` |

> [!NOTE]
>
> Универсальный инструмент `web_search` с Tavily в качестве провайдера поддерживает `query` и `count` (до 20 результатов). Для параметров, специфичных для Tavily (`search_depth`, `topic`, `include_answer`, фильтры доменов, временной диапазон), вместо него используйте `tavily_search`.

## Расширенная конфигурация

> [accordion] Порядок определения ключа API
>
> Клиент Tavily ищет ключ API в следующем порядке:
>
> 1. `plugins.entries.tavily.config.webSearch.apiKey` (разрешается через SecretRefs).
> 2. `TAVILY_API_KEY` из среды Gateway.
>
> Если ни одно из значений не задано, `tavily_search` и `tavily_extract` вызывают ошибку настройки.

> [accordion] Пользовательский базовый URL
>
> Если доступ к Tavily осуществляется через прокси, переопределите `plugins.entries.tavily.config.webSearch.baseUrl` или задайте `TAVILY_BASE_URL`. Параметр конфигурации имеет приоритет над переменной среды. Значение по умолчанию — `https://api.tavily.com`.

> [accordion] Для `chunks_per_source` требуется `query`
>
> `tavily_extract` отклоняет вызовы, в которых передан `chunks_per_source` без `query`. Tavily ранжирует фрагменты по релевантности запросу, поэтому без него этот параметр не имеет смысла.

## Связанные материалы

> [card] [Обзор поиска в интернете](https://docs2.openclaw.ai/ru/tools/web.md)
>
> Все провайдеры и правила автоматического обнаружения.

> [card] [Firecrawl](https://docs2.openclaw.ai/ru/tools/firecrawl.md)
>
> Поиск и сбор данных с извлечением содержимого.

> [card] [Поиск Exa](https://docs2.openclaw.ai/ru/tools/exa-search.md)
>
> Нейронный поиск с извлечением содержимого.

> [card] [Конфигурация](https://docs2.openclaw.ai/ru/gateway/configuration.md)
>
> Полная схема конфигурации записей плагинов и маршрутизации инструментов.
