Tools
Tavily
Tavily é uma API de busca projetada para aplicações de IA. O OpenClaw a expõe de duas formas:
- como o provedor
web_searchpara a ferramenta de busca genérica - como ferramentas explícitas de Plugin:
tavily_searchetavily_extract
O Tavily retorna resultados estruturados otimizados para consumo por LLMs, com profundidade de busca configurável, filtragem por tópico, filtros de domínio, resumos de respostas gerados por IA e extração de conteúdo de URLs (incluindo páginas renderizadas por JavaScript).
| Propriedade | Valor |
|---|---|
| ID do Plugin | tavily |
| Pacote | @openclaw/tavily-plugin |
| Auth | TAVILY_API_KEY ou configuração apiKey |
| URL base | https://api.tavily.com (padrão) |
| Ferramentas | tavily_search, tavily_extract |
Primeiros passos
Install the plugin
openclaw plugins install @openclaw/tavily-pluginGet an API key
Crie uma conta Tavily em tavily.com e então gere uma chave de API no painel.
Configure the plugin and 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", }, }, },}Verify search runs
Acione um web_search de qualquer agente ou chame tavily_search diretamente.
Referência de ferramentas
tavily_search
Use isto quando quiser controles de busca específicos do Tavily em vez do web_search genérico.
| Parâmetro | Tipo | Restrições / padrão | Descrição |
|---|---|---|---|
query |
string | obrigatório | String de consulta de busca. Mantenha abaixo de 400 caracteres. |
search_depth |
enum | basic (padrão), advanced |
advanced é mais lento, mas tem maior relevância. |
topic |
enum | general (padrão), news, finance |
Filtra por família de tópicos. |
max_results |
integer | 1-20 | Número de resultados. |
include_answer |
boolean | padrão false |
Inclui um resumo de resposta gerado por IA do Tavily. |
time_range |
enum | day, week, month, year |
Filtra resultados por recência. |
include_domains |
array de strings | (nenhum) | Inclui apenas resultados destes domínios. |
exclude_domains |
array de strings | (nenhum) | Exclui resultados destes domínios. |
Tradeoff de profundidade de busca:
| Profundidade | Velocidade | Relevância | Melhor para |
|---|---|---|---|
basic |
Mais rápido | Alta | Consultas de uso geral (padrão). |
advanced |
Mais lento | Máxima | Pesquisa precisa e verificação de fatos. |
tavily_extract
Use isto para extrair conteúdo limpo de uma ou mais URLs. Lida com páginas renderizadas por JavaScript e oferece suporte a divisão em chunks focada em consulta para extração direcionada.
| Parâmetro | Tipo | Restrições / padrão | Descrição |
|---|---|---|---|
urls |
array de strings | obrigatório, 1-20 | URLs das quais extrair conteúdo. |
query |
string | (opcional) | Reordena chunks extraídos por relevância para esta consulta. |
extract_depth |
enum | basic (padrão), advanced |
Use advanced para páginas pesadas em JS, SPAs ou tabelas dinâmicas. |
chunks_per_source |
integer | 1-5; requer query |
Chunks retornados por URL. Gera erro se definido sem query. |
include_images |
boolean | padrão false |
Inclui URLs de imagens nos resultados. |
Tradeoff de profundidade de extração:
| Profundidade | Quando usar |
|---|---|
basic |
Páginas simples. Tente isto primeiro. |
advanced |
SPAs renderizadas por JS, conteúdo dinâmico, tabelas. |
Escolhendo a ferramenta certa
| Necessidade | Ferramenta |
|---|---|
| Busca web rápida, sem opções especiais | web_search |
| Busca com profundidade, tópico, respostas de IA | tavily_search |
| Extrair conteúdo de URLs específicas | tavily_extract |
Configuração avançada
API key resolution order
O cliente Tavily procura sua chave de API nesta ordem:
plugins.entries.tavily.config.webSearch.apiKey(resolvida por SecretRefs).TAVILY_API_KEYdo ambiente do Gateway.
tavily_extract gera um erro de configuração se nenhum dos dois estiver presente.
Custom base URL
Substitua plugins.entries.tavily.config.webSearch.baseUrl se você expõe o Tavily por meio de um proxy. O padrão é https://api.tavily.com.
`chunks_per_source` requires `query`
tavily_extract rejeita chamadas que passam chunks_per_source sem uma query. O Tavily classifica chunks por relevância da consulta, portanto o parâmetro não tem significado sem uma.
