langchain 0.0.159 → 0.0.161

package/dist/retrievers/document_compressors/embeddings_filter.cjs

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EmbeddingsFilter = void 0;
+const index_js_1 = require("./index.cjs");
+const math_js_1 = require("../../util/math.cjs");
+/**
+ * Class that represents a document compressor that uses embeddings to
+ * drop documents unrelated to the query.
+ */
+class EmbeddingsFilter extends index_js_1.BaseDocumentCompressor {
+    constructor(params) {
+        super();
+        /**
+         * Embeddings to use for embedding document contents and queries.
+         */
+        Object.defineProperty(this, "embeddings", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Similarity function for comparing documents.
+         */
+        Object.defineProperty(this, "similarityFn", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: math_js_1.cosineSimilarity
+        });
+        /**
+         * Threshold for determining when two documents are similar enough
+         * to be considered redundant. Must be specified if `k` is not set.
+         */
+        Object.defineProperty(this, "similarityThreshold", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The number of relevant documents to return. Can be explicitly set to undefined, in which case
+         * similarity_threshold` must be specified. Defaults to 20
+         */
+        Object.defineProperty(this, "k", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 20
+        });
+        this.embeddings = params.embeddings;
+        this.similarityFn = params.similarityFn ?? this.similarityFn;
+        this.similarityThreshold = params.similarityThreshold;
+        this.k = "k" in params ? params.k : this.k;
+        if (this.k === undefined && this.similarityThreshold === undefined) {
+            throw new Error(`Must specify one of "k" or "similarity_threshold".`);
+        }
+    }
+    async compressDocuments(documents, query) {
+        const embeddedDocuments = await this.embeddings.embedDocuments(documents.map((doc) => doc.pageContent));
+        const embeddedQuery = await this.embeddings.embedQuery(query);
+        const similarity = this.similarityFn([embeddedQuery], embeddedDocuments)[0];
+        let includedIdxs = Array.from({ length: embeddedDocuments.length }, (_, i) => i);
+        if (this.k !== undefined) {
+            includedIdxs = includedIdxs
+                .map((v, i) => [similarity[i], v])
+                .sort(([a], [b]) => b - a)
+                .slice(0, this.k)
+                .map(([, i]) => i);
+        }
+        if (this.similarityThreshold !== undefined) {
+            const threshold = this.similarityThreshold;
+            includedIdxs = includedIdxs.filter((i) => similarity[i] > threshold);
+        }
+        return includedIdxs.map((i) => documents[i]);
+    }
+}
+exports.EmbeddingsFilter = EmbeddingsFilter;

package/dist/retrievers/document_compressors/embeddings_filter.d.ts

@@ -0,0 +1,39 @@
+import { Document } from "../../document.js";
+import { Embeddings } from "../../embeddings/base.js";
+import { BaseDocumentCompressor } from "./index.js";
+import { cosineSimilarity } from "../../util/math.js";
+/**
+ * Interface for the parameters of the `EmbeddingsFilter` class.
+ */
+export interface EmbeddingsFilterParams {
+    embeddings: Embeddings;
+    similarityFn?: (x: number[][], y: number[][]) => number[][];
+    similarityThreshold?: number;
+    k?: number;
+}
+/**
+ * Class that represents a document compressor that uses embeddings to
+ * drop documents unrelated to the query.
+ */
+export declare class EmbeddingsFilter extends BaseDocumentCompressor {
+    /**
+     * Embeddings to use for embedding document contents and queries.
+     */
+    embeddings: Embeddings;
+    /**
+     * Similarity function for comparing documents.
+     */
+    similarityFn: typeof cosineSimilarity;
+    /**
+     * Threshold for determining when two documents are similar enough
+     * to be considered redundant. Must be specified if `k` is not set.
+     */
+    similarityThreshold?: number;
+    /**
+     * The number of relevant documents to return. Can be explicitly set to undefined, in which case
+     * similarity_threshold` must be specified. Defaults to 20
+     */
+    k?: number | undefined;
+    constructor(params: EmbeddingsFilterParams);
+    compressDocuments(documents: Document[], query: string): Promise<Document[]>;
+}

package/dist/retrievers/document_compressors/embeddings_filter.js

@@ -0,0 +1,74 @@
+import { BaseDocumentCompressor } from "./index.js";
+import { cosineSimilarity } from "../../util/math.js";
+/**
+ * Class that represents a document compressor that uses embeddings to
+ * drop documents unrelated to the query.
+ */
+export class EmbeddingsFilter extends BaseDocumentCompressor {
+    constructor(params) {
+        super();
+        /**
+         * Embeddings to use for embedding document contents and queries.
+         */
+        Object.defineProperty(this, "embeddings", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Similarity function for comparing documents.
+         */
+        Object.defineProperty(this, "similarityFn", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: cosineSimilarity
+        });
+        /**
+         * Threshold for determining when two documents are similar enough
+         * to be considered redundant. Must be specified if `k` is not set.
+         */
+        Object.defineProperty(this, "similarityThreshold", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * The number of relevant documents to return. Can be explicitly set to undefined, in which case
+         * similarity_threshold` must be specified. Defaults to 20
+         */
+        Object.defineProperty(this, "k", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 20
+        });
+        this.embeddings = params.embeddings;
+        this.similarityFn = params.similarityFn ?? this.similarityFn;
+        this.similarityThreshold = params.similarityThreshold;
+        this.k = "k" in params ? params.k : this.k;
+        if (this.k === undefined && this.similarityThreshold === undefined) {
+            throw new Error(`Must specify one of "k" or "similarity_threshold".`);
+        }
+    }
+    async compressDocuments(documents, query) {
+        const embeddedDocuments = await this.embeddings.embedDocuments(documents.map((doc) => doc.pageContent));
+        const embeddedQuery = await this.embeddings.embedQuery(query);
+        const similarity = this.similarityFn([embeddedQuery], embeddedDocuments)[0];
+        let includedIdxs = Array.from({ length: embeddedDocuments.length }, (_, i) => i);
+        if (this.k !== undefined) {
+            includedIdxs = includedIdxs
+                .map((v, i) => [similarity[i], v])
+                .sort(([a], [b]) => b - a)
+                .slice(0, this.k)
+                .map(([, i]) => i);
+        }
+        if (this.similarityThreshold !== undefined) {
+            const threshold = this.similarityThreshold;
+            includedIdxs = includedIdxs.filter((i) => similarity[i] > threshold);
+        }
+        return includedIdxs.map((i) => documents[i]);
+    }
+}

package/dist/retrievers/document_compressors/index.cjs

@@ -1,9 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseDocumentCompressor = void 0;
+exports.DocumentCompressorPipeline = exports.BaseDocumentCompressor = void 0;
 /**
  * Base Document Compression class. All compressors should extend this class.
  */
 class BaseDocumentCompressor {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static isBaseDocumentCompressor(x) {
+        return x?.compressDocuments !== undefined;
+    }
 }
 exports.BaseDocumentCompressor = BaseDocumentCompressor;
+/**
+ * Document compressor that uses a pipeline of Transformers.
+ */
+class DocumentCompressorPipeline extends BaseDocumentCompressor {
+    constructor(fields) {
+        super();
+        Object.defineProperty(this, "transformers", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.transformers = fields.transformers;
+    }
+    async compressDocuments(documents, query, callbacks) {
+        let transformedDocuments = documents;
+        for (const transformer of this.transformers) {
+            if (BaseDocumentCompressor.isBaseDocumentCompressor(transformer)) {
+                transformedDocuments = await transformer.compressDocuments(transformedDocuments, query, callbacks);
+            }
+            else {
+                transformedDocuments = await transformer.transformDocuments(transformedDocuments);
+            }
+        }
+        return transformedDocuments;
+    }
+}
+exports.DocumentCompressorPipeline = DocumentCompressorPipeline;

package/dist/retrievers/document_compressors/index.d.ts

@@ -1,4 +1,6 @@
 import { Document } from "../../document.js";
+import { BaseDocumentTransformer } from "../../schema/document.js";
+import { Callbacks } from "../../callbacks/manager.js";
 /**
  * Base Document Compression class. All compressors should extend this class.
  */
@@ -12,5 +14,16 @@ export declare abstract class BaseDocumentCompressor {
      * @param query A query string.
      * @returns A Promise that resolves with an array of compressed `Document` objects.
      */
-    abstract compressDocuments(documents: Document[], query: string): Promise<Document[]>;
+    abstract compressDocuments(documents: Document[], query: string, callbacks?: Callbacks): Promise<Document[]>;
+    static isBaseDocumentCompressor(x: any): x is BaseDocumentCompressor;
+}
+/**
+ * Document compressor that uses a pipeline of Transformers.
+ */
+export declare class DocumentCompressorPipeline extends BaseDocumentCompressor {
+    transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];
+    constructor(fields: {
+        transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];
+    });
+    compressDocuments(documents: Document[], query: string, callbacks?: Callbacks): Promise<Document[]>;
 }

package/dist/retrievers/document_compressors/index.js

@@ -2,4 +2,35 @@
  * Base Document Compression class. All compressors should extend this class.
  */
 export class BaseDocumentCompressor {
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    static isBaseDocumentCompressor(x) {
+        return x?.compressDocuments !== undefined;
+    }
+}
+/**
+ * Document compressor that uses a pipeline of Transformers.
+ */
+export class DocumentCompressorPipeline extends BaseDocumentCompressor {
+    constructor(fields) {
+        super();
+        Object.defineProperty(this, "transformers", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.transformers = fields.transformers;
+    }
+    async compressDocuments(documents, query, callbacks) {
+        let transformedDocuments = documents;
+        for (const transformer of this.transformers) {
+            if (BaseDocumentCompressor.isBaseDocumentCompressor(transformer)) {
+                transformedDocuments = await transformer.compressDocuments(transformedDocuments, query, callbacks);
+            }
+            else {
+                transformedDocuments = await transformer.transformDocuments(transformedDocuments);
+            }
+        }
+        return transformedDocuments;
+    }
 }

package/dist/retrievers/document_compressors/test/document_compressor.int.test.cjs

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const globals_1 = require("@jest/globals");
+const openai_js_1 = require("../../../embeddings/openai.cjs");
+const text_splitter_js_1 = require("../../../text_splitter.cjs");
+const embeddings_filter_js_1 = require("../embeddings_filter.cjs");
+const index_js_1 = require("../index.cjs");
+const document_js_1 = require("../../../document.cjs");
+(0, globals_1.test)("Test DocumentCompressorPipeline", async () => {
+    const embeddings = new openai_js_1.OpenAIEmbeddings();
+    const splitter = new text_splitter_js_1.RecursiveCharacterTextSplitter({
+        chunkSize: 30,
+        chunkOverlap: 0,
+        separators: [". "],
+    });
+    const relevantFilter = new embeddings_filter_js_1.EmbeddingsFilter({
+        embeddings,
+        similarityThreshold: 0.8,
+    });
+    const pipelineFilter = new index_js_1.DocumentCompressorPipeline({
+        transformers: [splitter, relevantFilter],
+    });
+    const texts = ["This sentence is about cows", "foo bar baz"];
+    const docs = [new document_js_1.Document({ pageContent: texts.join(". ") })];
+    const actual = await pipelineFilter.compressDocuments(docs, "Tell me about farm animals");
+    (0, globals_1.expect)(actual.length).toBe(1);
+    (0, globals_1.expect)(texts[0].includes(actual[0].pageContent)).toBeTruthy();
+});

package/dist/retrievers/document_compressors/test/document_compressor.int.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/retrievers/document_compressors/test/document_compressor.int.test.js

@@ -0,0 +1,26 @@
+import { test, expect } from "@jest/globals";
+import { OpenAIEmbeddings } from "../../../embeddings/openai.js";
+import { RecursiveCharacterTextSplitter } from "../../../text_splitter.js";
+import { EmbeddingsFilter } from "../embeddings_filter.js";
+import { DocumentCompressorPipeline } from "../index.js";
+import { Document } from "../../../document.js";
+test("Test DocumentCompressorPipeline", async () => {
+    const embeddings = new OpenAIEmbeddings();
+    const splitter = new RecursiveCharacterTextSplitter({
+        chunkSize: 30,
+        chunkOverlap: 0,
+        separators: [". "],
+    });
+    const relevantFilter = new EmbeddingsFilter({
+        embeddings,
+        similarityThreshold: 0.8,
+    });
+    const pipelineFilter = new DocumentCompressorPipeline({
+        transformers: [splitter, relevantFilter],
+    });
+    const texts = ["This sentence is about cows", "foo bar baz"];
+    const docs = [new Document({ pageContent: texts.join(". ") })];
+    const actual = await pipelineFilter.compressDocuments(docs, "Tell me about farm animals");
+    expect(actual.length).toBe(1);
+    expect(texts[0].includes(actual[0].pageContent)).toBeTruthy();
+});

package/dist/retrievers/tavily_search_api.cjs

@@ -0,0 +1,144 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TavilySearchAPIRetriever = void 0;
+const document_js_1 = require("../document.cjs");
+const retriever_js_1 = require("../schema/retriever.cjs");
+const env_js_1 = require("../util/env.cjs");
+/**
+ * A class for retrieving documents related to a given search term
+ * using the Tavily Search API.
+ */
+class TavilySearchAPIRetriever extends retriever_js_1.BaseRetriever {
+    static lc_name() {
+        return "TavilySearchAPIRetriever";
+    }
+    get lc_namespace() {
+        return ["langchain", "retrievers", "tavily_search_api"];
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "k", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 10
+        });
+        Object.defineProperty(this, "includeGeneratedAnswer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "includeRawContent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "includeImages", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "searchDepth", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "basic"
+        });
+        Object.defineProperty(this, "includeDomains", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "excludeDomains", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "kwargs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {}
+        });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        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 ?? (0, env_js_1.getEnvironmentVariable)("TAVILY_API_KEY");
+        if (this.apiKey === undefined) {
+            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.`);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const docs = json.results.map((result) => {
+            const pageContent = this.includeRawContent
+                ? result.raw_content
+                : result.content;
+            const metadata = {
+                title: result.title,
+                source: result.url,
+                ...Object.fromEntries(Object.entries(result).filter(([k]) => !["content", "title", "url", "raw_content"].includes(k))),
+                images: json.images,
+            };
+            return new document_js_1.Document({ pageContent, metadata });
+        });
+        if (this.includeGeneratedAnswer) {
+            docs.push(new document_js_1.Document({
+                pageContent: json.answer,
+                metadata: {
+                    title: "Suggested Answer",
+                    source: "https://tavily.com/",
+                },
+            }));
+        }
+        return docs;
+    }
+}
+exports.TavilySearchAPIRetriever = TavilySearchAPIRetriever;

package/dist/retrievers/tavily_search_api.d.ts

@@ -0,0 +1,38 @@
+import { Document } from "../document.js";
+import { CallbackManagerForRetrieverRun } from "../callbacks/manager.js";
+import { BaseRetriever, type BaseRetrieverInput } from "../schema/retriever.js";
+/**
+ * Options for the HydeRetriever class, which includes a BaseLanguageModel
+ * instance, a VectorStore instance, and an optional promptTemplate which
+ * can either be a BasePromptTemplate instance or a PromptKey.
+ */
+export type TavilySearchAPIRetrieverFields = BaseRetrieverInput & {
+    k?: number;
+    includeGeneratedAnswer?: boolean;
+    includeRawContent?: boolean;
+    includeImages?: boolean;
+    searchDepth?: "basic" | "advanced";
+    includeDomains?: string[];
+    excludeDomains?: string[];
+    kwargs?: Record<string, unknown>;
+    apiKey?: string;
+};
+/**
+ * A class for retrieving documents related to a given search term
+ * using the Tavily Search API.
+ */
+export declare class TavilySearchAPIRetriever extends BaseRetriever {
+    static lc_name(): string;
+    get lc_namespace(): string[];
+    k: number;
+    includeGeneratedAnswer: boolean;
+    includeRawContent: boolean;
+    includeImages: boolean;
+    searchDepth: string;
+    includeDomains?: string[];
+    excludeDomains?: string[];
+    kwargs: Record<string, unknown>;
+    apiKey?: string;
+    constructor(fields?: TavilySearchAPIRetrieverFields);
+    _getRelevantDocuments(query: string, _runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
+}

package/dist/retrievers/tavily_search_api.js

@@ -0,0 +1,140 @@
+import { Document } from "../document.js";
+import { BaseRetriever } from "../schema/retriever.js";
+import { getEnvironmentVariable } from "../util/env.js";
+/**
+ * A class for retrieving documents related to a given search term
+ * using the Tavily Search API.
+ */
+export class TavilySearchAPIRetriever extends BaseRetriever {
+    static lc_name() {
+        return "TavilySearchAPIRetriever";
+    }
+    get lc_namespace() {
+        return ["langchain", "retrievers", "tavily_search_api"];
+    }
+    constructor(fields) {
+        super(fields);
+        Object.defineProperty(this, "k", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: 10
+        });
+        Object.defineProperty(this, "includeGeneratedAnswer", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "includeRawContent", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "includeImages", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: false
+        });
+        Object.defineProperty(this, "searchDepth", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: "basic"
+        });
+        Object.defineProperty(this, "includeDomains", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "excludeDomains", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "kwargs", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: {}
+        });
+        Object.defineProperty(this, "apiKey", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        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 === undefined) {
+            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.`);
+        }
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        const docs = json.results.map((result) => {
+            const pageContent = this.includeRawContent
+                ? result.raw_content
+                : result.content;
+            const metadata = {
+                title: result.title,
+                source: result.url,
+                ...Object.fromEntries(Object.entries(result).filter(([k]) => !["content", "title", "url", "raw_content"].includes(k))),
+                images: json.images,
+            };
+            return new Document({ pageContent, metadata });
+        });
+        if (this.includeGeneratedAnswer) {
+            docs.push(new Document({
+                pageContent: json.answer,
+                metadata: {
+                    title: "Suggested Answer",
+                    source: "https://tavily.com/",
+                },
+            }));
+        }
+        return docs;
+    }
+}