@langchain/community/dist/tools/searchapi.js

Third-party integrations for LangChain.js

import { __exportAll } from "../_virtual/_rolldown/runtime.js";
import { Tool } from "@langchain/core/tools";
import { getEnvironmentVariable } from "@langchain/core/utils/env";
//#region src/tools/searchapi.ts
var searchapi_exports = /* @__PURE__ */ __exportAll({ SearchApi: () => SearchApi });
function isJSONObject(value) {
	return value !== null && typeof value === "object" && !Array.isArray(value);
}
/**
* SearchApi Class Definition.
*
* Provides a wrapper around the SearchApi.
*
* Ensure you've set the SEARCHAPI_API_KEY environment variable for authentication.
* You can obtain a free API key from https://www.searchapi.io/.
* @example
* ```typescript
* const searchApi = new SearchApi("your-api-key", {
*   engine: "google_news",
* });
* const agent = RunnableSequence.from([
*   ChatPromptTemplate.fromMessages([
*     ["ai", "Answer the following questions using a bulleted list markdown format.""],
*     ["human", "{input}"],
*   ]),
*   new ChatOpenAI({ model: "gpt-4o-mini", temperature: 0 }),
*   (input: BaseMessageChunk) => ({
*     log: "test",
*     returnValues: {
*       output: input,
*     },
*   }),
* ]);
* const executor = AgentExecutor.fromAgentAndTools({
*   agent,
*   tools: [searchApi],
* });
* const res = await executor.invoke({
*   input: "What's happening in Ukraine today?"",
* });
* console.log(res);
* ```
*/
var SearchApi = class extends Tool {
	static lc_name() {
		return "SearchApi";
	}
	/**
	* Converts the SearchApi instance to JSON. This method is not implemented
	* and will throw an error if called.
	* @returns Throws an error.
	*/
	toJSON() {
		return this.toJSONNotImplemented();
	}
	apiKey;
	params;
	constructor(apiKey = getEnvironmentVariable("SEARCHAPI_API_KEY"), params = {}) {
		super(...arguments);
		if (!apiKey) throw new Error("SearchApi requires an API key. Please set it as SEARCHAPI_API_KEY in your .env file, or pass it as a parameter to the SearchApi constructor.");
		this.apiKey = apiKey;
		this.params = params;
	}
	name = "search";
	/**
	* Builds a URL for the SearchApi request.
	* @param parameters The parameters for the request.
	* @returns A string representing the built URL.
	*/
	buildUrl(searchQuery) {
		const preparedParams = Object.entries({
			engine: "google",
			api_key: this.apiKey,
			...this.params,
			q: searchQuery
		}).filter(([key, value]) => value !== void 0 && value !== null && key !== "apiKey").map(([key, value]) => [key, `${value}`]);
		return `https://www.searchapi.io/api/v1/search?${new URLSearchParams(preparedParams)}`;
	}
	/** @ignore */
	/**
	* Calls the SearchAPI.
	*
	* Accepts an input query and fetches the result from SearchApi.
	*
	* @param {string} input - Search query.
	* @returns {string} - Formatted search results or an error message.
	*
	* NOTE: This method is the core search handler and processes various types
	* of search results including Google organic results, videos, jobs, and images.
	*/
	async _call(input) {
		const json = await (await fetch(this.buildUrl(input))).json();
		if (json.error) throw new Error(`Failed to load search results from SearchApi due to: ${json.error}`);
		if (json.answer_box?.answer) return json.answer_box.answer;
		if (json.answer_box?.snippet) return json.answer_box.snippet;
		if (json.knowledge_graph?.description) return json.knowledge_graph.description;
		if (json.organic_results) return json.organic_results.filter((r) => r.snippet).map((r) => r.snippet).join("\n");
		if (json.jobs) return json.jobs.slice(0, 1).filter((r) => r.description).map((r) => r.description).join("\n");
		if (json.videos) return json.videos.filter((r) => r.title && r.link).map((r) => `Title: "${r.title}" Link: ${r.link}`).join("\n");
		if (json.images) return json.images.slice(0, 15).filter((r) => r.title && r.original && isJSONObject(r.original) && r.original.link).map((r) => `Title: "${r.title}" Link: ${r.original.link}`).join("\n");
		return "No good search result found";
	}
	description = "a search engine. useful for when you need to answer questions about current events. input should be a search query.";
};
//#endregion
export { SearchApi, searchapi_exports };

//# sourceMappingURL=searchapi.js.map