91 lines
2.9 KiB
TypeScript
91 lines
2.9 KiB
TypeScript
|
import { Tool, ToolParams } from "@langchain/core/tools";
|
||
|
|
import { SearchOptions } from "duck-duck-scrape";
|
||
|
|
export { SafeSearchType, SearchOptions, SearchTimeType, } from "duck-duck-scrape";
|
||
|
|
export interface DuckDuckGoSearchParameters extends ToolParams {
|
||
|
|
/**
|
||
|
|
* The search options for the search using the SearchOptions interface
|
||
|
|
* from the duck-duck-scrape package.
|
||
|
|
*/
|
||
|
|
searchOptions?: SearchOptions;
|
||
|
|
/**
|
||
|
|
* The maximum number of results to return from the search.
|
||
|
|
* Limiting to 10 to avoid context overload.
|
||
|
|
* @default 10
|
||
|
|
*/
|
||
|
|
maxResults?: number;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* 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)
|
||
|
|
*
|
||
|
|
* <details open>
|
||
|
|
* <summary><strong>Instantiate</strong></summary>
|
||
|
|
*
|
||
|
|
* ```typescript
|
||
|
|
* import { DuckDuckGoSearch } from "@langchain/community/tools/duckduckgo_search";
|
||
|
|
*
|
||
|
|
* const tool = new DuckDuckGoSearch({ maxResults: 1 });
|
||
|
|
* ```
|
||
|
|
* </details>
|
||
|
|
*
|
||
|
|
* <br />
|
||
|
|
*
|
||
|
|
* <details>
|
||
|
|
*
|
||
|
|
* <summary><strong>Invocation</strong></summary>
|
||
|
|
*
|
||
|
|
* ```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":"<b>Current</b> <b>weather</b> <b>in</b> San Francisco, CA. Check <b>current</b> conditions in San Francisco, CA with radar, hourly, and more."}]
|
||
|
|
* ```
|
||
|
|
* </details>
|
||
|
|
*
|
||
|
|
* <br />
|
||
|
|
*
|
||
|
|
* <details>
|
||
|
|
*
|
||
|
|
* <summary><strong>Invocation with tool call</strong></summary>
|
||
|
|
*
|
||
|
|
* ```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 <b>Weather</b> Forecasts. <b>Weather</b> Underground provides local & long-range <b>weather</b> forecasts, weatherreports, maps & tropical <b>weather</b> conditions for the San Francisco area.\"}]",
|
||
|
|
* "name": "duckduckgo-search",
|
||
|
|
* "additional_kwargs": {},
|
||
|
|
* "response_metadata": {},
|
||
|
|
* "tool_call_id": "tool_call_id"
|
||
|
|
* }
|
||
|
|
* ```
|
||
|
|
* </details>
|
||
|
|
*/
|
||
|
|
export declare class DuckDuckGoSearch extends Tool {
|
||
|
|
private searchOptions?;
|
||
|
|
private maxResults;
|
||
|
|
constructor(params?: DuckDuckGoSearchParameters);
|
||
|
|
static lc_name(): string;
|
||
|
|
name: string;
|
||
|
|
description: string;
|
||
|
|
_call(input: string): Promise<string>;
|
||
|
|
}
|