import { Tool } from "@langchain/core/tools"; import { search } from "duck-duck-scrape"; export { SafeSearchType, SearchTimeType, } from "duck-duck-scrape"; const DEFAULT_MAX_RESULTS = 10; /** * DuckDuckGo tool integration. * * Setup: * Install `@langchain/community` and `duck-duck-scrape`. * * ```bash * npm install @langchain/community duck-duck-scrape * ``` * * ## [Constructor args](https://api.js.langchain.com/classes/_langchain_community.tools_duckduckgo_search.DuckDuckGoSearch.html#constructor) * *
* Instantiate * * ```typescript * import { DuckDuckGoSearch } from "@langchain/community/tools/duckduckgo_search"; * * const tool = new DuckDuckGoSearch({ maxResults: 1 }); * ``` *
* *
* *
* * Invocation * * ```typescript * await tool.invoke("what is the current weather in sf?"); * * // output: [{"title":"San Francisco, CA Current Weather | AccuWeather","link":"https://www.accuweather.com/en/us/san-francisco/94103/current-weather/347629","snippet":"Current weather in San Francisco, CA. Check current conditions in San Francisco, CA with radar, hourly, and more."}] * ``` *
* *
* *
* * Invocation with tool call * * ```typescript * // This is usually generated by a model, but we'll create a tool call directly for demo purposes. * const modelGeneratedToolCall = { * args: { * input: "what is the current weather in sf?", * }, * id: "tool_call_id", * name: tool.name, * type: "tool_call", * }; * await tool.invoke(modelGeneratedToolCall); * ``` * * ```text * ToolMessage { * "content": "[{\"title\":\"San Francisco, CA Weather Conditions | Weather Underground\",\"link\":\"https://www.wunderground.com/weather/us/ca/san-francisco\",\"snippet\":\"San Francisco Weather Forecasts. Weather Underground provides local & long-range weather forecasts, weatherreports, maps & tropical weather conditions for the San Francisco area.\"}]", * "name": "duckduckgo-search", * "additional_kwargs": {}, * "response_metadata": {}, * "tool_call_id": "tool_call_id" * } * ``` *
*/ export class DuckDuckGoSearch extends Tool { constructor(params) { super(params ?? {}); Object.defineProperty(this, "searchOptions", { enumerable: true, configurable: true, writable: true, value: void 0 }); Object.defineProperty(this, "maxResults", { enumerable: true, configurable: true, writable: true, value: DEFAULT_MAX_RESULTS }); Object.defineProperty(this, "name", { enumerable: true, configurable: true, writable: true, value: "duckduckgo-search" }); Object.defineProperty(this, "description", { enumerable: true, configurable: true, writable: true, value: "A search engine. Useful for when you need to answer questions about current events. Input should be a search query." }); const { searchOptions, maxResults } = params ?? {}; this.searchOptions = searchOptions; this.maxResults = maxResults || this.maxResults; } static lc_name() { return "DuckDuckGoSearch"; } async _call(input) { const { results } = await search(input, this.searchOptions); return JSON.stringify(results .map((result) => ({ title: result.title, link: result.url, snippet: result.description, })) .slice(0, this.maxResults)); } }