@langchain/community/dist/retrievers/tavily_search_api.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 { BaseRetriever } from "@langchain/core/retrievers";
//#region src/retrievers/tavily_search_api.ts
var tavily_search_api_exports = /* @__PURE__ */ __exportAll({ TavilySearchAPIRetriever: () => TavilySearchAPIRetriever });
/**
* A class for retrieving documents related to a given search term
* using the Tavily Search API.
*/
var TavilySearchAPIRetriever = class extends BaseRetriever {
	static lc_name() {
		return "TavilySearchAPIRetriever";
	}
	get lc_namespace() {
		return [
			"langchain",
			"retrievers",
			"tavily_search_api"
		];
	}
	k = 10;
	includeGeneratedAnswer = false;
	includeRawContent = false;
	includeImages = false;
	searchDepth = "basic";
	includeDomains;
	excludeDomains;
	kwargs = {};
	apiKey;
	constructor(fields) {
		super(fields);
		this.k = fields?.k ?? this.k;
		this.includeGeneratedAnswer = fields?.includeGeneratedAnswer ?? this.includeGeneratedAnswer;
		this.includeRawContent = fields?.includeRawContent ?? this.includeRawContent;
		this.includeImages = fields?.includeImages ?? this.includeImages;
		this.searchDepth = fields?.searchDepth ?? this.searchDepth;
		this.includeDomains = fields?.includeDomains ?? this.includeDomains;
		this.excludeDomains = fields?.excludeDomains ?? this.excludeDomains;
		this.kwargs = fields?.kwargs ?? this.kwargs;
		this.apiKey = fields?.apiKey ?? getEnvironmentVariable("TAVILY_API_KEY");
		if (this.apiKey === void 0) throw new Error(`No Tavily API key found. Either set an environment variable named "TAVILY_API_KEY" or pass an API key as "apiKey".`);
	}
	async _getRelevantDocuments(query, _runManager) {
		const body = {
			query,
			include_answer: this.includeGeneratedAnswer,
			include_raw_content: this.includeRawContent,
			include_images: this.includeImages,
			max_results: this.k,
			search_depth: this.searchDepth,
			api_key: this.apiKey
		};
		if (this.includeDomains) body.include_domains = this.includeDomains;
		if (this.excludeDomains) body.exclude_domains = this.excludeDomains;
		const response = await fetch("https://api.tavily.com/search", {
			method: "POST",
			headers: { "content-type": "application/json" },
			body: JSON.stringify({
				...body,
				...this.kwargs
			})
		});
		const json = await response.json();
		if (!response.ok) throw new Error(`Request failed with status code ${response.status}: ${json.error}`);
		if (!Array.isArray(json.results)) throw new Error(`Could not parse Tavily results. Please try again.`);
		const docs = json.results.map((result) => {
			return new Document({
				pageContent: this.includeRawContent ? result.raw_content : result.content,
				metadata: {
					title: result.title,
					source: result.url,
					...Object.fromEntries(Object.entries(result).filter(([k]) => ![
						"content",
						"title",
						"url",
						"raw_content"
					].includes(k))),
					images: json.images
				}
			});
		});
		if (this.includeGeneratedAnswer) docs.push(new Document({
			pageContent: json.answer,
			metadata: {
				title: "Suggested Answer",
				source: "https://tavily.com/"
			}
		}));
		return docs;
	}
};
//#endregion
export { TavilySearchAPIRetriever, tavily_search_api_exports };

//# sourceMappingURL=tavily_search_api.js.map