@langchain/community/dist/tools/wikipedia_query_run.cjs

Third-party integrations for LangChain.js

Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
const require_runtime = require("../_virtual/_rolldown/runtime.cjs");
let _langchain_core_tools = require("@langchain/core/tools");
//#region src/tools/wikipedia_query_run.ts
var wikipedia_query_run_exports = /* @__PURE__ */ require_runtime.__exportAll({ WikipediaQueryRun: () => WikipediaQueryRun });
/**
* Wikipedia query tool integration.
*
* Setup:
* Install `@langchain/community`. You'll also need an API key.
*
* ```bash
* npm install @langchain/community
* ```
*
* ## [Constructor args](https://api.js.langchain.com/classes/_langchain_community.tools_wikipedia_query_run.WikipediaQueryRun.html#constructor)
*
* <details open>
* <summary><strong>Instantiate</strong></summary>
*
* ```typescript
* import { WikipediaQueryRun } from "@langchain/community/tools/wikipedia_query_run";
*
* const tool = new WikipediaQueryRun({
*   topKResults: 3,
*   maxDocContentLength: 4000,
* });
* ```
* </details>
*
* <br />
*
* <details>
*
* <summary><strong>Invocation</strong></summary>
*
* ```typescript
* await tool.invoke("what is the current weather in sf?");
* ```
* </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": "...",
*   "name": "wikipedia-api",
*   "additional_kwargs": {},
*   "response_metadata": {},
*   "tool_call_id": "tool_call_id"
* }
* ```
* </details>
*/
var WikipediaQueryRun = class extends _langchain_core_tools.Tool {
	static lc_name() {
		return "WikipediaQueryRun";
	}
	name = "wikipedia-api";
	description = "A tool for interacting with and fetching data from the Wikipedia API.";
	topKResults = 3;
	maxDocContentLength = 4e3;
	baseUrl = "https://en.wikipedia.org/w/api.php";
	constructor(params = {}) {
		super();
		this.topKResults = params.topKResults ?? this.topKResults;
		this.maxDocContentLength = params.maxDocContentLength ?? this.maxDocContentLength;
		this.baseUrl = params.baseUrl ?? this.baseUrl;
	}
	async _call(query) {
		const searchResults = await this._fetchSearchResults(query);
		const summaries = [];
		for (let i = 0; i < Math.min(this.topKResults, searchResults.query.search.length); i += 1) {
			const page = searchResults.query.search[i].title;
			const pageDetails = await this._fetchPage(page, true);
			if (pageDetails) {
				const summary = `Page: ${page}\nSummary: ${pageDetails.extract}`;
				summaries.push(summary);
			}
		}
		if (summaries.length === 0) return "No good Wikipedia Search Result was found";
		else return summaries.join("\n\n").slice(0, this.maxDocContentLength);
	}
	/**
	* Fetches the content of a specific Wikipedia page. It returns the
	* extracted content as a string.
	* @param page The specific Wikipedia page to fetch its content.
	* @param redirect A boolean value to indicate whether to redirect or not.
	* @returns The extracted content of the specific Wikipedia page as a string.
	*/
	async content(page, redirect = true) {
		try {
			return (await this._fetchPage(page, redirect)).extract;
		} catch (error) {
			throw new Error(`Failed to fetch content for page "${page}": ${error}`);
		}
	}
	/**
	* Builds a URL for the Wikipedia API using the provided parameters.
	* @param parameters The parameters to be used in building the URL.
	* @returns A string representing the built URL.
	*/
	buildUrl(parameters) {
		const nonUndefinedParams = Object.entries(parameters).filter(([_, value]) => value !== void 0).map(([key, value]) => [key, `${value}`]);
		const searchParams = new URLSearchParams(nonUndefinedParams);
		return `${this.baseUrl}?${searchParams}`;
	}
	async _fetchSearchResults(query) {
		const searchParams = new URLSearchParams({
			action: "query",
			list: "search",
			srsearch: query,
			format: "json"
		});
		const response = await fetch(`${this.baseUrl}?${searchParams.toString()}`);
		if (!response.ok) throw new Error("Network response was not ok");
		return await response.json();
	}
	async _fetchPage(page, redirect) {
		const params = new URLSearchParams({
			action: "query",
			prop: "extracts",
			explaintext: "true",
			redirects: redirect ? "1" : "0",
			format: "json",
			titles: page
		});
		const response = await fetch(`${this.baseUrl}?${params.toString()}`);
		if (!response.ok) throw new Error("Network response was not ok");
		const { pages } = (await response.json()).query;
		return pages[Object.keys(pages)[0]];
	}
};
//#endregion
exports.WikipediaQueryRun = WikipediaQueryRun;
Object.defineProperty(exports, "wikipedia_query_run_exports", {
	enumerable: true,
	get: function() {
		return wikipedia_query_run_exports;
	}
});

//# sourceMappingURL=wikipedia_query_run.cjs.map