120 lines
4.2 KiB
JavaScript
120 lines
4.2 KiB
JavaScript
"use strict";
|
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
exports.DuckDuckGoSearch = exports.SearchTimeType = exports.SafeSearchType = void 0;
|
|
const tools_1 = require("@langchain/core/tools");
|
|
const duck_duck_scrape_1 = require("duck-duck-scrape");
|
|
var duck_duck_scrape_2 = require("duck-duck-scrape");
|
|
Object.defineProperty(exports, "SafeSearchType", { enumerable: true, get: function () { return duck_duck_scrape_2.SafeSearchType; } });
|
|
Object.defineProperty(exports, "SearchTimeType", { enumerable: true, get: function () { return duck_duck_scrape_2.SearchTimeType; } });
|
|
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)
|
|
*
|
|
* <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>
|
|
*/
|
|
class DuckDuckGoSearch extends tools_1.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 (0, duck_duck_scrape_1.search)(input, this.searchOptions);
|
|
return JSON.stringify(results
|
|
.map((result) => ({
|
|
title: result.title,
|
|
link: result.url,
|
|
snippet: result.description,
|
|
}))
|
|
.slice(0, this.maxResults));
|
|
}
|
|
}
|
|
exports.DuckDuckGoSearch = DuckDuckGoSearch;
|