@langchain/community/dist/document_loaders/web/searchapi.js

Third-party integrations for LangChain.js

import { __exportAll } from "../../_virtual/_rolldown/runtime.js";
import { getEnvironmentVariable } from "@langchain/core/utils/env";
import { Document } from "@langchain/core/documents";
import { BaseDocumentLoader } from "@langchain/core/document_loaders/base";
//#region src/document_loaders/web/searchapi.ts
var searchapi_exports = /* @__PURE__ */ __exportAll({ SearchApiLoader: () => SearchApiLoader });
/**
* Class representing a document loader for loading search results from
* the SearchApi. It extends the BaseDocumentLoader class.
* @example
* ```typescript
* const loader = new SearchApiLoader({
*   q: "{query}",
*   apiKey: "{apiKey}",
*   engine: "google",
* });
* const docs = await loader.load();
* ```
*/
var SearchApiLoader = class extends BaseDocumentLoader {
	apiKey;
	parameters;
	constructor(params) {
		super();
		const { apiKey = getEnvironmentVariable("SEARCHAPI_API_KEY") } = params;
		if (typeof apiKey !== "string") throw new Error("Invalid type for apiKey. Expected string.");
		if (!apiKey) throw new Error("SearchApi API key not set. You can set it as SEARCHAPI_API_KEY in your .env file, or pass it to SearchApi.");
		this.apiKey = apiKey;
		this.parameters = { ...params };
	}
	/**
	* Builds the URL for the SearchApi search request.
	* @returns The URL for the search request.
	*/
	buildUrl() {
		this.parameters = {
			engine: "google",
			api_key: this.apiKey,
			...this.parameters
		};
		const preparedParams = Object.entries(this.parameters).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)}`;
	}
	/**
	* Extracts documents from the provided output.
	* @param output - The output to extract documents from.
	* @param responseType - The type of the response to extract documents from.
	* @returns An array of Documents.
	*/
	extractDocuments(output, responseType) {
		const documents = [];
		const results = Array.isArray(output) ? output : [output];
		if (responseType === "transcripts") {
			const pageContent = results.map((result) => result.text).join("\n");
			const metadata = {
				source: "SearchApi",
				responseType
			};
			documents.push(new Document({
				pageContent,
				metadata
			}));
		} else for (const result of results) {
			const pageContent = JSON.stringify(result);
			const metadata = {
				source: "SearchApi",
				responseType
			};
			documents.push(new Document({
				pageContent,
				metadata
			}));
		}
		return documents;
	}
	/**
	* Processes the response data from the SearchApi search request and converts it into an array of Documents.
	* @param data - The response data from the SearchApi search request.
	* @returns An array of Documents.
	*/
	processResponseData(data) {
		const documents = [];
		for (const responseType of [
			"answer_box",
			"shopping_results",
			"knowledge_graph",
			"organic_results",
			"transcripts"
		]) if (responseType in data) documents.push(...this.extractDocuments(data[responseType], responseType));
		return documents;
	}
	/**
	* Fetches the data from the provided URL and returns it as a JSON object.
	* If an error occurs during the fetch operation, an exception is thrown with the error message.
	* @param url - The URL to fetch data from.
	* @returns A promise that resolves to the fetched data as a JSON object.
	* @throws An error if the fetch operation fails.
	*/
	async fetchData(url) {
		const data = await (await fetch(url)).json();
		if (data.error) throw new Error(`Failed to load search results from SearchApi due to: ${data.error}`);
		return data;
	}
	/**
	* Loads the search results from the SearchApi.
	* @returns An array of Documents representing the search results.
	* @throws An error if the search results could not be loaded.
	*/
	async load() {
		const url = this.buildUrl();
		const data = await this.fetchData(url);
		try {
			return this.processResponseData(data);
		} catch (error) {
			console.error(error);
			throw new Error(`Failed to process search results from SearchApi: ${error}`);
		}
	}
};
//#endregion
export { SearchApiLoader, searchapi_exports };

//# sourceMappingURL=searchapi.js.map