Skip to main content
Tavily 的搜索 API 是专为 AI 代理 (LLM) 构建的搜索引擎，可快速提供实时、准确和真实的结果。

​
概述

这将帮助你开始使用 Tavily 搜索 API 检索器。有关所有 TavilySearchAPIRetriever 功能和配置的详细文档，请参阅 API 参考。

​
集成细节

检索器来源包
TavilySearchAPIRetriever网络上的信息。@langchain/community

​
设置

你需要使用你的 Tavily API 密钥填充 TAVILY_API_KEY 环境变量，或将其作为 apiKey 传递给构造函数。通过在其网站上注册来获取密钥。 如果你想从单个查询中获得自动跟踪，你也可以通过取消注释下面来设置你的 LangSmith API 密钥： 
// process.env.LANGSMITH_API_KEY = "<YOUR API KEY HERE>";
// process.env.LANGSMITH_TRACING = "true";

​
安装

此检索器位于 @langchain/community 包中： 
npm install @langchain/community @langchain/core

​
实例化

现在我们可以实例化我们的检索器： 
import { TavilySearchAPIRetriever } from "@langchain/community/retrievers/tavily_search_api";

const retriever = new TavilySearchAPIRetriever({
  k: 3,
});
有关允许参数的完整列表，请参阅 官方文档。你可以通过 kwargs 对象将任何参数传递给 SDK。

​
用法

const query = "what is the current weather in SF?";

await retriever.invoke(query);

[
  Document {
    pageContent: "{'location': {'name': 'San Francisco', 'region': 'California', 'country': 'United States of America', 'lat': 37.78, 'lon': -122.42, 'tz_id': 'America/Los_Angeles', 'localtime_epoch': 1722900266, 'localtime': '2024-08-05 16:24'}, 'current': {'last_updated_epoch': 1722899700, 'last_updated': '2024-08-05 16:15', 'temp_c': 16.8, 'temp_f': 62.2, 'is_day': 1, 'condition': {'text': 'Partly Cloudy', 'icon': '//cdn.weatherapi.com/weather/64x64/day/116.png', 'code': 1003}, 'wind_mph': 13.2, 'wind_kph': 21.2, 'wind_degree': 261, 'wind_dir': 'W', 'pressure_mb': 1014.0, 'pressure_in': 29.94, 'precip_mm': 0.0, 'precip_in': 0.0, 'humidity': 74, 'cloud': 60, 'feelslike_c': 16.8, 'feelslike_f': 62.2, 'windchill_c': 16.8, 'windchill_f': 62.2, 'heatindex_c': 16.8, 'heatindex_f': 62.2, 'dewpoint_c': 12.3, 'dewpoint_f': 54.1, 'vis_km': 10.0, 'vis_miles': 6.0, 'uv': 5.0, 'gust_mph': 17.3, 'gust_kph': 27.8}}",
    metadata: {
      title: 'Weather in San Francisco',
      source: 'https://www.weatherapi.com/',
      score: 0.9947009,
      images: []
    },
    id: undefined
  },
  Document {
    pageContent: 'Current Weather for Popular Cities . San Francisco, CA 56 ° F Mostly Cloudy; Manhattan, NY warning 85 ° F Fair; Schiller Park, IL (60176) 71 ° F Mostly Cloudy; Boston, MA warning 84 ° F Partly ...',
    metadata: {
      title: 'San Francisco, CA Hourly Weather Forecast | Weather Underground',
      source: 'https://www.wunderground.com/hourly/us/ca/san-francisco/date/2024-08-02',
      score: 0.9859904,
      images: []
    },
    id: undefined
  },
  Document {
    pageContent: 'San Francisco CA 37.77°N 122.41°W (Elev. 131 ft) Last Update: 2:42 pm PDT Aug 4, 2024. Forecast Valid: 5pm PDT Aug 4, 2024-6pm PDT Aug 11, 2024 . Forecast Discussion . Additional Resources. Radar & Satellite Image. Hourly Weather Forecast. ... Severe Weather ; Current Outlook Maps ; Drought ; Fire Weather ; Fronts/Precipitation Maps ; Current ...',
    metadata: {
      title: 'National Weather Service',
      source: 'https://forecast.weather.gov/zipcity.php?inputstring=San+Francisco,CA',
      score: 0.98141783,
      images: []
    },
    id: undefined
  }
]

​
API 参考

有关 TavilySearchAPIRetriever 所有功能和配置的详细文档，请参阅 API 参考。
Edit this page on GitHub or file an issue.
Connect these docs to Claude, VSCode, and more via MCP for real-time answers.