@langchain/classic 1.0.0-alpha.1

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

@@ -0,0 +1,61 @@
+import { BaseDocumentTransformer, DocumentInterface } from "@langchain/core/documents";
+import { Callbacks } from "@langchain/core/callbacks/manager";
+
+//#region src/retrievers/document_compressors/index.d.ts
+
+/**
+ * Base Document Compression class. All compressors should extend this class.
+ */
+declare abstract class BaseDocumentCompressor {
+  /**
+   * Abstract method that must be implemented by any class that extends
+   * `BaseDocumentCompressor`. This method takes an array of `Document`
+   * objects and a query string as parameters and returns a Promise that
+   * resolves with an array of compressed `Document` objects.
+   * @param documents An array of `Document` objects to be compressed.
+   * @param query A query string.
+   * @returns A Promise that resolves with an array of compressed `Document` objects.
+   */
+  abstract compressDocuments(documents: DocumentInterface[], query: string, callbacks?: Callbacks): Promise<DocumentInterface[]>;
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  static isBaseDocumentCompressor(x: any): x is BaseDocumentCompressor;
+}
+/**
+ * Document compressor that uses a pipeline of Transformers.
+ * @example
+ * ```typescript
+ * const compressorPipeline = new DocumentCompressorPipeline({
+ *   transformers: [
+ *     new RecursiveCharacterTextSplitter({
+ *       chunkSize: 200,
+ *       chunkOverlap: 0,
+ *     }),
+ *     new EmbeddingsFilter({
+ *       embeddings: new OpenAIEmbeddings(),
+ *       similarityThreshold: 0.8,
+ *       k: 5,
+ *     }),
+ *   ],
+ * });
+ * const retriever = new ContextualCompressionRetriever({
+ *   baseCompressor: compressorPipeline,
+ *   baseRetriever: new TavilySearchAPIRetriever({
+ *     includeRawContent: true,
+ *   }),
+ * });
+ * const retrievedDocs = await retriever.invoke(
+ *   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+ * );
+ * console.log({ retrievedDocs });
+ * ```
+ */
+declare class DocumentCompressorPipeline extends BaseDocumentCompressor {
+  transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];
+  constructor(fields: {
+    transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];
+  });
+  compressDocuments(documents: DocumentInterface[], query: string, callbacks?: Callbacks): Promise<DocumentInterface[]>;
+}
+//#endregion
+export { BaseDocumentCompressor, DocumentCompressorPipeline };
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":["DocumentInterface","BaseDocumentTransformer","Callbacks","BaseDocumentCompressor","Promise","DocumentCompressorPipeline"],"sources":["../../../src/retrievers/document_compressors/index.d.ts"],"sourcesContent":["import type { DocumentInterface } from \"@langchain/core/documents\";\nimport { BaseDocumentTransformer } from \"@langchain/core/documents\";\nimport { Callbacks } from \"@langchain/core/callbacks/manager\";\n/**\n * Base Document Compression class. All compressors should extend this class.\n */\nexport declare abstract class BaseDocumentCompressor {\n    /**\n     * Abstract method that must be implemented by any class that extends\n     * `BaseDocumentCompressor`. This method takes an array of `Document`\n     * objects and a query string as parameters and returns a Promise that\n     * resolves with an array of compressed `Document` objects.\n     * @param documents An array of `Document` objects to be compressed.\n     * @param query A query string.\n     * @returns A Promise that resolves with an array of compressed `Document` objects.\n     */\n    abstract compressDocuments(documents: DocumentInterface[], query: string, callbacks?: Callbacks): Promise<DocumentInterface[]>;\n    // eslint-disable-next-line @typescript-eslint/no-explicit-any\n    static isBaseDocumentCompressor(x: any): x is BaseDocumentCompressor;\n}\n/**\n * Document compressor that uses a pipeline of Transformers.\n * @example\n * ```typescript\n * const compressorPipeline = new DocumentCompressorPipeline({\n *   transformers: [\n *     new RecursiveCharacterTextSplitter({\n *       chunkSize: 200,\n *       chunkOverlap: 0,\n *     }),\n *     new EmbeddingsFilter({\n *       embeddings: new OpenAIEmbeddings(),\n *       similarityThreshold: 0.8,\n *       k: 5,\n *     }),\n *   ],\n * });\n * const retriever = new ContextualCompressionRetriever({\n *   baseCompressor: compressorPipeline,\n *   baseRetriever: new TavilySearchAPIRetriever({\n *     includeRawContent: true,\n *   }),\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What did the speaker say about Justice Breyer in the 2022 State of the Union?\",\n * );\n * console.log({ retrievedDocs });\n * ```\n */\nexport declare class DocumentCompressorPipeline extends BaseDocumentCompressor {\n    transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];\n    constructor(fields: {\n        transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];\n    });\n    compressDocuments(documents: DocumentInterface[], query: string, callbacks?: Callbacks): Promise<DocumentInterface[]>;\n}\n"],"mappings":";;;;;;AAMA;;AAU0CA,uBAVZG,sBAAAA,CAUYH;EAAiB;;;;AAEa;AA+BxE;;;;EACmE,SAE5CC,iBAAAA,CAAAA,SAAAA,EApCmBD,iBAoCnBC,EAAAA,EAAAA,KAAAA,EAAAA,MAAAA,EAAAA,SAAAA,CAAAA,EApCmEC,SAoCnED,CAAAA,EApC+EG,OAoC/EH,CApCuFD,iBAoCvFC,EAAAA,CAAAA;EAAuB;EAAyB,OAEtCD,wBAAAA,CAAAA,CAAAA,EAAAA,GAAAA,CAAAA,EAAAA,CAAAA,IApCiBG,sBAoCjBH;;;;;AAL6C;;;;;;;;;;;;;;;;;;;;;;;;;;cAAzDK,0BAAAA,SAAmCF,sBAAAA;iBACrCF,0BAA0BE;;mBAEtBF,0BAA0BE;;+BAEhBH,gDAAgDE,YAAYE,QAAQJ"}

package/dist/retrievers/document_compressors/index.js

@@ -0,0 +1,62 @@
+import { __export } from "../../_virtual/rolldown_runtime.js";
+
+//#region src/retrievers/document_compressors/index.ts
+var document_compressors_exports = {};
+__export(document_compressors_exports, {
+	BaseDocumentCompressor: () => BaseDocumentCompressor,
+	DocumentCompressorPipeline: () => DocumentCompressorPipeline
+});
+/**
+* Base Document Compression class. All compressors should extend this class.
+*/
+var BaseDocumentCompressor = class {
+	static isBaseDocumentCompressor(x) {
+		return x?.compressDocuments !== void 0;
+	}
+};
+/**
+* Document compressor that uses a pipeline of Transformers.
+* @example
+* ```typescript
+* const compressorPipeline = new DocumentCompressorPipeline({
+*   transformers: [
+*     new RecursiveCharacterTextSplitter({
+*       chunkSize: 200,
+*       chunkOverlap: 0,
+*     }),
+*     new EmbeddingsFilter({
+*       embeddings: new OpenAIEmbeddings(),
+*       similarityThreshold: 0.8,
+*       k: 5,
+*     }),
+*   ],
+* });
+* const retriever = new ContextualCompressionRetriever({
+*   baseCompressor: compressorPipeline,
+*   baseRetriever: new TavilySearchAPIRetriever({
+*     includeRawContent: true,
+*   }),
+* });
+* const retrievedDocs = await retriever.invoke(
+*   "What did the speaker say about Justice Breyer in the 2022 State of the Union?",
+* );
+* console.log({ retrievedDocs });
+* ```
+*/
+var DocumentCompressorPipeline = class extends BaseDocumentCompressor {
+	transformers;
+	constructor(fields) {
+		super();
+		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;
+	}
+};
+
+//#endregion
+export { BaseDocumentCompressor, DocumentCompressorPipeline, document_compressors_exports };
+//# sourceMappingURL=index.js.map

package/dist/retrievers/document_compressors/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["x: any","fields: {\n    transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];\n  }","documents: DocumentInterface[]","query: string","callbacks?: Callbacks"],"sources":["../../../src/retrievers/document_compressors/index.ts"],"sourcesContent":["import type { DocumentInterface } from \"@langchain/core/documents\";\nimport { BaseDocumentTransformer } from \"@langchain/core/documents\";\nimport { Callbacks } from \"@langchain/core/callbacks/manager\";\n\n/**\n * Base Document Compression class. All compressors should extend this class.\n */\nexport abstract class BaseDocumentCompressor {\n  /**\n   * Abstract method that must be implemented by any class that extends\n   * `BaseDocumentCompressor`. This method takes an array of `Document`\n   * objects and a query string as parameters and returns a Promise that\n   * resolves with an array of compressed `Document` objects.\n   * @param documents An array of `Document` objects to be compressed.\n   * @param query A query string.\n   * @returns A Promise that resolves with an array of compressed `Document` objects.\n   */\n  abstract compressDocuments(\n    documents: DocumentInterface[],\n    query: string,\n    callbacks?: Callbacks\n  ): Promise<DocumentInterface[]>;\n\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  static isBaseDocumentCompressor(x: any): x is BaseDocumentCompressor {\n    return x?.compressDocuments !== undefined;\n  }\n}\n\n/**\n * Document compressor that uses a pipeline of Transformers.\n * @example\n * ```typescript\n * const compressorPipeline = new DocumentCompressorPipeline({\n *   transformers: [\n *     new RecursiveCharacterTextSplitter({\n *       chunkSize: 200,\n *       chunkOverlap: 0,\n *     }),\n *     new EmbeddingsFilter({\n *       embeddings: new OpenAIEmbeddings(),\n *       similarityThreshold: 0.8,\n *       k: 5,\n *     }),\n *   ],\n * });\n * const retriever = new ContextualCompressionRetriever({\n *   baseCompressor: compressorPipeline,\n *   baseRetriever: new TavilySearchAPIRetriever({\n *     includeRawContent: true,\n *   }),\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What did the speaker say about Justice Breyer in the 2022 State of the Union?\",\n * );\n * console.log({ retrievedDocs });\n * ```\n */\nexport class DocumentCompressorPipeline extends BaseDocumentCompressor {\n  transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];\n\n  constructor(fields: {\n    transformers: (BaseDocumentTransformer | BaseDocumentCompressor)[];\n  }) {\n    super();\n    this.transformers = fields.transformers;\n  }\n\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string,\n    callbacks?: Callbacks\n  ): Promise<DocumentInterface[]> {\n    let transformedDocuments = documents;\n    for (const transformer of this.transformers) {\n      if (BaseDocumentCompressor.isBaseDocumentCompressor(transformer)) {\n        transformedDocuments = await transformer.compressDocuments(\n          transformedDocuments,\n          query,\n          callbacks\n        );\n      } else {\n        transformedDocuments = await transformer.transformDocuments(\n          transformedDocuments\n        );\n      }\n    }\n    return transformedDocuments;\n  }\n}\n"],"mappings":";;;;;;;;;;;AAOA,IAAsB,yBAAtB,MAA6C;CAiB3C,OAAO,yBAAyBA,GAAqC;AACnE,SAAO,GAAG,sBAAsB;CACjC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BD,IAAa,6BAAb,cAAgD,uBAAuB;CACrE;CAEA,YAAYC,QAET;EACD,OAAO;EACP,KAAK,eAAe,OAAO;CAC5B;CAED,MAAM,kBACJC,WACAC,OACAC,WAC8B;EAC9B,IAAI,uBAAuB;AAC3B,OAAK,MAAM,eAAe,KAAK,aAC7B,KAAI,uBAAuB,yBAAyB,YAAY,EAC9D,uBAAuB,MAAM,YAAY,kBACvC,sBACA,OACA,UACD;OAED,uBAAuB,MAAM,YAAY,mBACvC,qBACD;AAGL,SAAO;CACR;AACF"}

package/dist/retrievers/ensemble.cjs

@@ -0,0 +1,76 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const __langchain_core_retrievers = require_rolldown_runtime.__toESM(require("@langchain/core/retrievers"));
+
+//#region src/retrievers/ensemble.ts
+var ensemble_exports = {};
+require_rolldown_runtime.__export(ensemble_exports, { EnsembleRetriever: () => EnsembleRetriever });
+/**
+* Ensemble retriever that aggregates and orders the results of
+* multiple retrievers by using weighted Reciprocal Rank Fusion.
+*/
+var EnsembleRetriever = class extends __langchain_core_retrievers.BaseRetriever {
+	static lc_name() {
+		return "EnsembleRetriever";
+	}
+	lc_namespace = [
+		"langchain",
+		"retrievers",
+		"ensemble_retriever"
+	];
+	retrievers;
+	weights;
+	c = 60;
+	constructor(args) {
+		super(args);
+		this.retrievers = args.retrievers;
+		this.weights = args.weights || new Array(args.retrievers.length).fill(1 / args.retrievers.length);
+		this.c = args.c || 60;
+	}
+	async _getRelevantDocuments(query, runManager) {
+		return this._rankFusion(query, runManager);
+	}
+	async _rankFusion(query, runManager) {
+		const retrieverDocs = await Promise.all(this.retrievers.map((retriever, i) => retriever.invoke(query, { callbacks: runManager?.getChild(`retriever_${i + 1}`) })));
+		const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);
+		return fusedDocs;
+	}
+	async _weightedReciprocalRank(docList) {
+		if (docList.length !== this.weights.length) throw new Error("Number of retrieved document lists must be equal to the number of weights.");
+		const rrfScoreDict = docList.reduce((rffScore, retrieverDoc, idx) => {
+			let rank = 1;
+			const weight = this.weights[idx];
+			while (rank <= retrieverDoc.length) {
+				const { pageContent } = retrieverDoc[rank - 1];
+				if (!rffScore[pageContent]) rffScore[pageContent] = 0;
+				rffScore[pageContent] += weight / (rank + this.c);
+				rank += 1;
+			}
+			return rffScore;
+		}, {});
+		const uniqueDocs = this._uniqueUnion(docList.flat());
+		const sortedDocs = Array.from(uniqueDocs).sort((a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]);
+		return sortedDocs;
+	}
+	_uniqueUnion(documents) {
+		const documentSet = /* @__PURE__ */ new Set();
+		const result = [];
+		for (const doc of documents) {
+			const key = doc.pageContent;
+			if (!documentSet.has(key)) {
+				documentSet.add(key);
+				result.push(doc);
+			}
+		}
+		return result;
+	}
+};
+
+//#endregion
+exports.EnsembleRetriever = EnsembleRetriever;
+Object.defineProperty(exports, 'ensemble_exports', {
+  enumerable: true,
+  get: function () {
+    return ensemble_exports;
+  }
+});
+//# sourceMappingURL=ensemble.cjs.map

package/dist/retrievers/ensemble.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensemble.cjs","names":["BaseRetriever","args: EnsembleRetrieverInput","query: string","runManager?: CallbackManagerForRetrieverRun","docList: DocumentInterface[][]","rffScore: Record<string, number>","documents: Document[]"],"sources":["../../src/retrievers/ensemble.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n  /** A list of retrievers to ensemble. */\n  retrievers: BaseRetriever[];\n  /**\n   * A list of weights corresponding to the retrievers. Defaults to equal\n   * weighting for all retrievers.\n   */\n  weights?: number[];\n  /**\n   * A constant added to the rank, controlling the balance between the importance\n   * of high-ranked items and the consideration given to lower-ranked items.\n   * Default is 60.\n   */\n  c?: number;\n}\n\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport class EnsembleRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"EnsembleRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"ensemble_retriever\"];\n\n  retrievers: BaseRetriever[];\n\n  weights: number[];\n\n  c = 60;\n\n  constructor(args: EnsembleRetrieverInput) {\n    super(args);\n    this.retrievers = args.retrievers;\n    this.weights =\n      args.weights ||\n      new Array(args.retrievers.length).fill(1 / args.retrievers.length);\n    this.c = args.c || 60;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    return this._rankFusion(query, runManager);\n  }\n\n  async _rankFusion(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    const retrieverDocs = await Promise.all(\n      this.retrievers.map((retriever, i) =>\n        retriever.invoke(query, {\n          callbacks: runManager?.getChild(`retriever_${i + 1}`),\n        })\n      )\n    );\n\n    const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);\n    return fusedDocs;\n  }\n\n  async _weightedReciprocalRank(docList: DocumentInterface[][]) {\n    if (docList.length !== this.weights.length) {\n      throw new Error(\n        \"Number of retrieved document lists must be equal to the number of weights.\"\n      );\n    }\n\n    const rrfScoreDict = docList.reduce(\n      (rffScore: Record<string, number>, retrieverDoc, idx) => {\n        let rank = 1;\n        const weight = this.weights[idx];\n        while (rank <= retrieverDoc.length) {\n          const { pageContent } = retrieverDoc[rank - 1];\n          if (!rffScore[pageContent]) {\n            rffScore[pageContent] = 0;\n          }\n          rffScore[pageContent] += weight / (rank + this.c);\n          rank += 1;\n        }\n\n        return rffScore;\n      },\n      {}\n    );\n\n    const uniqueDocs = this._uniqueUnion(docList.flat());\n    const sortedDocs = Array.from(uniqueDocs).sort(\n      (a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]\n    );\n\n    return sortedDocs;\n  }\n\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const documentSet = new Set();\n    const result = [];\n\n    for (const doc of documents) {\n      const key = doc.pageContent;\n      if (!documentSet.has(key)) {\n        documentSet.add(key);\n        result.push(doc);\n      }\n    }\n\n    return result;\n  }\n}\n"],"mappings":";;;;;;;;;;AAwBA,IAAa,oBAAb,cAAuCA,0CAAc;CACnD,OAAO,UAAU;AACf,SAAO;CACR;CAED,eAAe;EAAC;EAAa;EAAc;CAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAYC,MAA8B;EACxC,MAAM,KAAK;EACX,KAAK,aAAa,KAAK;EACvB,KAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,QAAQ,KAAK,IAAI,KAAK,WAAW,OAAO;EACpE,KAAK,IAAI,KAAK,KAAK;CACpB;CAED,MAAM,sBACJC,OACAC,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;CAC3C;CAED,MAAM,YACJD,OACAC,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,IAAI,CAAC,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,CAAC,UAAU,EAAE,IAAI,GAAG,CAAC,CACtD,EAAC,CACH,CACF;EAED,MAAM,YAAY,MAAM,KAAK,wBAAwB,cAAc;AACnE,SAAO;CACR;CAED,MAAM,wBAAwBC,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR;EAIJ,MAAM,eAAe,QAAQ,OAC3B,CAACC,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,aAAa,GAAG,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,cACZ,SAAS,eAAe;IAE1B,SAAS,gBAAgB,UAAU,OAAO,KAAK;IAC/C,QAAQ;GACT;AAED,UAAO;EACR,GACD,CAAE,EACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;EACpD,MAAM,aAAa,MAAM,KAAK,WAAW,CAAC,KACxC,CAAC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aACxD;AAED,SAAO;CACR;CAED,AAAQ,aAAaC,WAAmC;EACtD,MAAM,8BAAc,IAAI;EACxB,MAAM,SAAS,CAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;IACzB,YAAY,IAAI,IAAI;IACpB,OAAO,KAAK,IAAI;GACjB;EACF;AAED,SAAO;CACR;AACF"}

package/dist/retrievers/ensemble.d.cts

@@ -0,0 +1,39 @@
+import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
+import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
+import { Document, DocumentInterface } from "@langchain/core/documents";
+
+//#region src/retrievers/ensemble.d.ts
+interface EnsembleRetrieverInput extends BaseRetrieverInput {
+  /** A list of retrievers to ensemble. */
+  retrievers: BaseRetriever[];
+  /**
+   * A list of weights corresponding to the retrievers. Defaults to equal
+   * weighting for all retrievers.
+   */
+  weights?: number[];
+  /**
+   * A constant added to the rank, controlling the balance between the importance
+   * of high-ranked items and the consideration given to lower-ranked items.
+   * Default is 60.
+   */
+  c?: number;
+}
+/**
+ * Ensemble retriever that aggregates and orders the results of
+ * multiple retrievers by using weighted Reciprocal Rank Fusion.
+ */
+declare class EnsembleRetriever extends BaseRetriever {
+  static lc_name(): string;
+  lc_namespace: string[];
+  retrievers: BaseRetriever[];
+  weights: number[];
+  c: number;
+  constructor(args: EnsembleRetrieverInput);
+  _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;
+  _rankFusion(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;
+  _weightedReciprocalRank(docList: DocumentInterface[][]): Promise<Document<Record<string, any>>[]>;
+  private _uniqueUnion;
+}
+//#endregion
+export { EnsembleRetriever, EnsembleRetrieverInput };
+//# sourceMappingURL=ensemble.d.cts.map

package/dist/retrievers/ensemble.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensemble.d.cts","names":["BaseRetriever","BaseRetrieverInput","Document","DocumentInterface","CallbackManagerForRetrieverRun","EnsembleRetrieverInput","EnsembleRetriever","Record","Promise"],"sources":["../../src/retrievers/ensemble.d.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n    /** A list of retrievers to ensemble. */\n    retrievers: BaseRetriever[];\n    /**\n     * A list of weights corresponding to the retrievers. Defaults to equal\n     * weighting for all retrievers.\n     */\n    weights?: number[];\n    /**\n     * A constant added to the rank, controlling the balance between the importance\n     * of high-ranked items and the consideration given to lower-ranked items.\n     * Default is 60.\n     */\n    c?: number;\n}\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport declare class EnsembleRetriever extends BaseRetriever {\n    static lc_name(): string;\n    lc_namespace: string[];\n    retrievers: BaseRetriever[];\n    weights: number[];\n    c: number;\n    constructor(args: EnsembleRetrieverInput);\n    _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;\n    _rankFusion(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;\n    _weightedReciprocalRank(docList: DocumentInterface[][]): Promise<Document<Record<string, any>>[]>;\n    private _uniqueUnion;\n}\n"],"mappings":";;;;;UAGiBK,sBAAAA,SAA+BJ;;EAA/BI,UAAAA,EAEDL,aAFuB,EAAA;EAAA;;;AAA2B;EAmB7CM,OAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAiB;;;;;EAOwE,CAAA,CAAA,EAAfJ,MAAAA;;;;;;AAE1DC,cAThBG,iBAAAA,SAA0BN,aAAAA,CASVG;EAAiB,OAAwBI,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAM,YAAfL,EAAAA,MAAAA,EAAAA;EAAQ,UAAhBM,EAN7CR,aAM6CQ,EAAAA;EAAO,OATrBR,EAAAA,MAAAA,EAAAA;EAAa,CAAA,EAAA,MAAA;oBAMtCK;oDACgCD,iCAAiCI,QAAQN,SAASK;0CAC5DH,iCAAiCI,QAAQN,SAASK;mCACzDJ,wBAAwBK,QAAQN,SAASK"}

package/dist/retrievers/ensemble.d.ts

@@ -0,0 +1,39 @@
+import { Document, DocumentInterface } from "@langchain/core/documents";
+import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
+import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
+
+//#region src/retrievers/ensemble.d.ts
+interface EnsembleRetrieverInput extends BaseRetrieverInput {
+  /** A list of retrievers to ensemble. */
+  retrievers: BaseRetriever[];
+  /**
+   * A list of weights corresponding to the retrievers. Defaults to equal
+   * weighting for all retrievers.
+   */
+  weights?: number[];
+  /**
+   * A constant added to the rank, controlling the balance between the importance
+   * of high-ranked items and the consideration given to lower-ranked items.
+   * Default is 60.
+   */
+  c?: number;
+}
+/**
+ * Ensemble retriever that aggregates and orders the results of
+ * multiple retrievers by using weighted Reciprocal Rank Fusion.
+ */
+declare class EnsembleRetriever extends BaseRetriever {
+  static lc_name(): string;
+  lc_namespace: string[];
+  retrievers: BaseRetriever[];
+  weights: number[];
+  c: number;
+  constructor(args: EnsembleRetrieverInput);
+  _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;
+  _rankFusion(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;
+  _weightedReciprocalRank(docList: DocumentInterface[][]): Promise<Document<Record<string, any>>[]>;
+  private _uniqueUnion;
+}
+//#endregion
+export { EnsembleRetriever, EnsembleRetrieverInput };
+//# sourceMappingURL=ensemble.d.ts.map

package/dist/retrievers/ensemble.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensemble.d.ts","names":["BaseRetriever","BaseRetrieverInput","Document","DocumentInterface","CallbackManagerForRetrieverRun","EnsembleRetrieverInput","EnsembleRetriever","Record","Promise"],"sources":["../../src/retrievers/ensemble.d.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n    /** A list of retrievers to ensemble. */\n    retrievers: BaseRetriever[];\n    /**\n     * A list of weights corresponding to the retrievers. Defaults to equal\n     * weighting for all retrievers.\n     */\n    weights?: number[];\n    /**\n     * A constant added to the rank, controlling the balance between the importance\n     * of high-ranked items and the consideration given to lower-ranked items.\n     * Default is 60.\n     */\n    c?: number;\n}\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport declare class EnsembleRetriever extends BaseRetriever {\n    static lc_name(): string;\n    lc_namespace: string[];\n    retrievers: BaseRetriever[];\n    weights: number[];\n    c: number;\n    constructor(args: EnsembleRetrieverInput);\n    _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;\n    _rankFusion(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document<Record<string, any>>[]>;\n    _weightedReciprocalRank(docList: DocumentInterface[][]): Promise<Document<Record<string, any>>[]>;\n    private _uniqueUnion;\n}\n"],"mappings":";;;;;UAGiBK,sBAAAA,SAA+BJ;;EAA/BI,UAAAA,EAEDL,aAFuB,EAAA;EAAA;;;AAA2B;EAmB7CM,OAAAA,CAAAA,EAAAA,MAAAA,EAAAA;EAAiB;;;;;EAOwE,CAAA,CAAA,EAAfJ,MAAAA;;;;;;AAE1DC,cAThBG,iBAAAA,SAA0BN,aAAAA,CASVG;EAAiB,OAAwBI,OAAAA,CAAAA,CAAAA,EAAAA,MAAAA;EAAM,YAAfL,EAAAA,MAAAA,EAAAA;EAAQ,UAAhBM,EAN7CR,aAM6CQ,EAAAA;EAAO,OATrBR,EAAAA,MAAAA,EAAAA;EAAa,CAAA,EAAA,MAAA;oBAMtCK;oDACgCD,iCAAiCI,QAAQN,SAASK;0CAC5DH,iCAAiCI,QAAQN,SAASK;mCACzDJ,wBAAwBK,QAAQN,SAASK"}

package/dist/retrievers/ensemble.js

@@ -0,0 +1,70 @@
+import { __export } from "../_virtual/rolldown_runtime.js";
+import { BaseRetriever } from "@langchain/core/retrievers";
+
+//#region src/retrievers/ensemble.ts
+var ensemble_exports = {};
+__export(ensemble_exports, { EnsembleRetriever: () => EnsembleRetriever });
+/**
+* Ensemble retriever that aggregates and orders the results of
+* multiple retrievers by using weighted Reciprocal Rank Fusion.
+*/
+var EnsembleRetriever = class extends BaseRetriever {
+	static lc_name() {
+		return "EnsembleRetriever";
+	}
+	lc_namespace = [
+		"langchain",
+		"retrievers",
+		"ensemble_retriever"
+	];
+	retrievers;
+	weights;
+	c = 60;
+	constructor(args) {
+		super(args);
+		this.retrievers = args.retrievers;
+		this.weights = args.weights || new Array(args.retrievers.length).fill(1 / args.retrievers.length);
+		this.c = args.c || 60;
+	}
+	async _getRelevantDocuments(query, runManager) {
+		return this._rankFusion(query, runManager);
+	}
+	async _rankFusion(query, runManager) {
+		const retrieverDocs = await Promise.all(this.retrievers.map((retriever, i) => retriever.invoke(query, { callbacks: runManager?.getChild(`retriever_${i + 1}`) })));
+		const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);
+		return fusedDocs;
+	}
+	async _weightedReciprocalRank(docList) {
+		if (docList.length !== this.weights.length) throw new Error("Number of retrieved document lists must be equal to the number of weights.");
+		const rrfScoreDict = docList.reduce((rffScore, retrieverDoc, idx) => {
+			let rank = 1;
+			const weight = this.weights[idx];
+			while (rank <= retrieverDoc.length) {
+				const { pageContent } = retrieverDoc[rank - 1];
+				if (!rffScore[pageContent]) rffScore[pageContent] = 0;
+				rffScore[pageContent] += weight / (rank + this.c);
+				rank += 1;
+			}
+			return rffScore;
+		}, {});
+		const uniqueDocs = this._uniqueUnion(docList.flat());
+		const sortedDocs = Array.from(uniqueDocs).sort((a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]);
+		return sortedDocs;
+	}
+	_uniqueUnion(documents) {
+		const documentSet = /* @__PURE__ */ new Set();
+		const result = [];
+		for (const doc of documents) {
+			const key = doc.pageContent;
+			if (!documentSet.has(key)) {
+				documentSet.add(key);
+				result.push(doc);
+			}
+		}
+		return result;
+	}
+};
+
+//#endregion
+export { EnsembleRetriever, ensemble_exports };
+//# sourceMappingURL=ensemble.js.map

package/dist/retrievers/ensemble.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ensemble.js","names":["args: EnsembleRetrieverInput","query: string","runManager?: CallbackManagerForRetrieverRun","docList: DocumentInterface[][]","rffScore: Record<string, number>","documents: Document[]"],"sources":["../../src/retrievers/ensemble.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n  /** A list of retrievers to ensemble. */\n  retrievers: BaseRetriever[];\n  /**\n   * A list of weights corresponding to the retrievers. Defaults to equal\n   * weighting for all retrievers.\n   */\n  weights?: number[];\n  /**\n   * A constant added to the rank, controlling the balance between the importance\n   * of high-ranked items and the consideration given to lower-ranked items.\n   * Default is 60.\n   */\n  c?: number;\n}\n\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport class EnsembleRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"EnsembleRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"ensemble_retriever\"];\n\n  retrievers: BaseRetriever[];\n\n  weights: number[];\n\n  c = 60;\n\n  constructor(args: EnsembleRetrieverInput) {\n    super(args);\n    this.retrievers = args.retrievers;\n    this.weights =\n      args.weights ||\n      new Array(args.retrievers.length).fill(1 / args.retrievers.length);\n    this.c = args.c || 60;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    return this._rankFusion(query, runManager);\n  }\n\n  async _rankFusion(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    const retrieverDocs = await Promise.all(\n      this.retrievers.map((retriever, i) =>\n        retriever.invoke(query, {\n          callbacks: runManager?.getChild(`retriever_${i + 1}`),\n        })\n      )\n    );\n\n    const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);\n    return fusedDocs;\n  }\n\n  async _weightedReciprocalRank(docList: DocumentInterface[][]) {\n    if (docList.length !== this.weights.length) {\n      throw new Error(\n        \"Number of retrieved document lists must be equal to the number of weights.\"\n      );\n    }\n\n    const rrfScoreDict = docList.reduce(\n      (rffScore: Record<string, number>, retrieverDoc, idx) => {\n        let rank = 1;\n        const weight = this.weights[idx];\n        while (rank <= retrieverDoc.length) {\n          const { pageContent } = retrieverDoc[rank - 1];\n          if (!rffScore[pageContent]) {\n            rffScore[pageContent] = 0;\n          }\n          rffScore[pageContent] += weight / (rank + this.c);\n          rank += 1;\n        }\n\n        return rffScore;\n      },\n      {}\n    );\n\n    const uniqueDocs = this._uniqueUnion(docList.flat());\n    const sortedDocs = Array.from(uniqueDocs).sort(\n      (a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]\n    );\n\n    return sortedDocs;\n  }\n\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const documentSet = new Set();\n    const result = [];\n\n    for (const doc of documents) {\n      const key = doc.pageContent;\n      if (!documentSet.has(key)) {\n        documentSet.add(key);\n        result.push(doc);\n      }\n    }\n\n    return result;\n  }\n}\n"],"mappings":";;;;;;;;;;AAwBA,IAAa,oBAAb,cAAuC,cAAc;CACnD,OAAO,UAAU;AACf,SAAO;CACR;CAED,eAAe;EAAC;EAAa;EAAc;CAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAYA,MAA8B;EACxC,MAAM,KAAK;EACX,KAAK,aAAa,KAAK;EACvB,KAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,QAAQ,KAAK,IAAI,KAAK,WAAW,OAAO;EACpE,KAAK,IAAI,KAAK,KAAK;CACpB;CAED,MAAM,sBACJC,OACAC,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;CAC3C;CAED,MAAM,YACJD,OACAC,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,IAAI,CAAC,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,CAAC,UAAU,EAAE,IAAI,GAAG,CAAC,CACtD,EAAC,CACH,CACF;EAED,MAAM,YAAY,MAAM,KAAK,wBAAwB,cAAc;AACnE,SAAO;CACR;CAED,MAAM,wBAAwBC,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR;EAIJ,MAAM,eAAe,QAAQ,OAC3B,CAACC,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,aAAa,GAAG,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,cACZ,SAAS,eAAe;IAE1B,SAAS,gBAAgB,UAAU,OAAO,KAAK;IAC/C,QAAQ;GACT;AAED,UAAO;EACR,GACD,CAAE,EACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;EACpD,MAAM,aAAa,MAAM,KAAK,WAAW,CAAC,KACxC,CAAC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aACxD;AAED,SAAO;CACR;CAED,AAAQ,aAAaC,WAAmC;EACtD,MAAM,8BAAc,IAAI;EACxB,MAAM,SAAS,CAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;IACzB,YAAY,IAAI,IAAI;IACpB,OAAO,KAAK,IAAI;GACjB;EACF;AAED,SAAO;CACR;AACF"}

package/dist/retrievers/hyde.cjs

@@ -0,0 +1,128 @@
+const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
+const __langchain_core_prompts = require_rolldown_runtime.__toESM(require("@langchain/core/prompts"));
+const __langchain_core_vectorstores = require_rolldown_runtime.__toESM(require("@langchain/core/vectorstores"));
+const __langchain_core_prompt_values = require_rolldown_runtime.__toESM(require("@langchain/core/prompt_values"));
+
+//#region src/retrievers/hyde.ts
+var hyde_exports = {};
+require_rolldown_runtime.__export(hyde_exports, {
+	HydeRetriever: () => HydeRetriever,
+	getPromptTemplateFromKey: () => getPromptTemplateFromKey
+});
+/**
+* A class for retrieving relevant documents based on a given query. It
+* extends the VectorStoreRetriever class and uses a BaseLanguageModel to
+* generate a hypothetical answer to the query, which is then used to
+* retrieve relevant documents.
+* @example
+* ```typescript
+* const retriever = new HydeRetriever({
+*   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+*   llm: new ChatOpenAI({ model: "gpt-4o-mini" }),
+*   k: 1,
+* });
+* await vectorStore.addDocuments(
+*   [
+*     "My name is John.",
+*     "My name is Bob.",
+*     "My favourite food is pizza.",
+*     "My favourite food is pasta.",
+*   ].map((pageContent) => new Document({ pageContent })),
+* );
+* const results = await retriever.invoke(
+*   "What is my favourite food?",
+* );
+* ```
+*/
+var HydeRetriever = class extends __langchain_core_vectorstores.VectorStoreRetriever {
+	static lc_name() {
+		return "HydeRetriever";
+	}
+	get lc_namespace() {
+		return [
+			"langchain",
+			"retrievers",
+			"hyde"
+		];
+	}
+	llm;
+	promptTemplate;
+	constructor(fields) {
+		super(fields);
+		this.llm = fields.llm;
+		this.promptTemplate = typeof fields.promptTemplate === "string" ? getPromptTemplateFromKey(fields.promptTemplate) : fields.promptTemplate;
+		if (this.promptTemplate) {
+			const { inputVariables } = this.promptTemplate;
+			if (inputVariables.length !== 1 && inputVariables[0] !== "question") throw new Error(`Prompt template must accept a single input variable 'question'. Invalid input variables for prompt template: ${inputVariables}`);
+		}
+	}
+	async _getRelevantDocuments(query, runManager) {
+		let value = new __langchain_core_prompt_values.StringPromptValue(query);
+		if (this.promptTemplate) value = await this.promptTemplate.formatPromptValue({ question: query });
+		const res = await this.llm.generatePrompt([value]);
+		const answer = res.generations[0][0].text;
+		const results = await this.vectorStore.similaritySearch(answer, this.k, this.filter, runManager?.getChild("vectorstore"));
+		return results;
+	}
+};
+/**
+* Returns a BasePromptTemplate instance based on a given PromptKey.
+*/
+function getPromptTemplateFromKey(key) {
+	let template;
+	switch (key) {
+		case "websearch":
+			template = `Please write a passage to answer the question
+Question: {question}
+Passage:`;
+			break;
+		case "scifact":
+			template = `Please write a scientific paper passage to support/refute the claim
+Claim: {question}
+Passage:`;
+			break;
+		case "arguana":
+			template = `Please write a counter argument for the passage
+Passage: {question}
+Counter Argument:`;
+			break;
+		case "trec-covid":
+			template = `Please write a scientific paper passage to answer the question
+Question: {question}
+Passage:`;
+			break;
+		case "fiqa":
+			template = `Please write a financial article passage to answer the question
+Question: {question}
+Passage:`;
+			break;
+		case "dbpedia-entity":
+			template = `Please write a passage to answer the question.
+Question: {question}
+Passage:`;
+			break;
+		case "trec-news":
+			template = `Please write a news passage about the topic.
+Topic: {question}
+Passage:`;
+			break;
+		case "mr-tydi":
+			template = `Please write a passage in Swahili/Korean/Japanese/Bengali to answer the question in detail.
+Question: {question}
+Passage:`;
+			break;
+		default: throw new Error(`Invalid prompt key: ${key}`);
+	}
+	return __langchain_core_prompts.PromptTemplate.fromTemplate(template);
+}
+
+//#endregion
+exports.HydeRetriever = HydeRetriever;
+exports.getPromptTemplateFromKey = getPromptTemplateFromKey;
+Object.defineProperty(exports, 'hyde_exports', {
+  enumerable: true,
+  get: function () {
+    return hyde_exports;
+  }
+});
+//# sourceMappingURL=hyde.cjs.map

package/dist/retrievers/hyde.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"hyde.cjs","names":["VectorStoreRetriever","fields: HydeRetrieverOptions<V>","query: string","runManager?: CallbackManagerForRetrieverRun","value: BasePromptValue","StringPromptValue","key: PromptKey","template: string","PromptTemplate"],"sources":["../../src/retrievers/hyde.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { Document } from \"@langchain/core/documents\";\nimport { PromptTemplate, BasePromptTemplate } from \"@langchain/core/prompts\";\nimport {\n  StringPromptValue,\n  BasePromptValue,\n} from \"@langchain/core/prompt_values\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\n/**\n * A string that corresponds to a specific prompt template.\n */\nexport type PromptKey =\n  | \"websearch\"\n  | \"scifact\"\n  | \"arguana\"\n  | \"trec-covid\"\n  | \"fiqa\"\n  | \"dbpedia-entity\"\n  | \"trec-news\"\n  | \"mr-tydi\";\n\n/**\n * Options for the HydeRetriever class, which includes a BaseLanguageModel\n * instance, a VectorStore instance, and an optional promptTemplate which\n * can either be a BasePromptTemplate instance or a PromptKey.\n */\nexport type HydeRetrieverOptions<V extends VectorStore> =\n  VectorStoreRetrieverInput<V> & {\n    llm: BaseLanguageModelInterface;\n    promptTemplate?: BasePromptTemplate | PromptKey;\n  };\n\n/**\n * A class for retrieving relevant documents based on a given query. It\n * extends the VectorStoreRetriever class and uses a BaseLanguageModel to\n * generate a hypothetical answer to the query, which is then used to\n * retrieve relevant documents.\n * @example\n * ```typescript\n * const retriever = new HydeRetriever({\n *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   k: 1,\n * });\n * await vectorStore.addDocuments(\n *   [\n *     \"My name is John.\",\n *     \"My name is Bob.\",\n *     \"My favourite food is pizza.\",\n *     \"My favourite food is pasta.\",\n *   ].map((pageContent) => new Document({ pageContent })),\n * );\n * const results = await retriever.invoke(\n *   \"What is my favourite food?\",\n * );\n * ```\n */\nexport class HydeRetriever<\n  V extends VectorStore = VectorStore\n> extends VectorStoreRetriever<V> {\n  static lc_name() {\n    return \"HydeRetriever\";\n  }\n\n  get lc_namespace(): string[] {\n    return [\"langchain\", \"retrievers\", \"hyde\"];\n  }\n\n  llm: BaseLanguageModelInterface;\n\n  promptTemplate?: BasePromptTemplate;\n\n  constructor(fields: HydeRetrieverOptions<V>) {\n    super(fields);\n    this.llm = fields.llm;\n    this.promptTemplate =\n      typeof fields.promptTemplate === \"string\"\n        ? getPromptTemplateFromKey(fields.promptTemplate)\n        : fields.promptTemplate;\n    if (this.promptTemplate) {\n      const { inputVariables } = this.promptTemplate;\n      if (inputVariables.length !== 1 && inputVariables[0] !== \"question\") {\n        throw new Error(\n          `Prompt template must accept a single input variable 'question'. Invalid input variables for prompt template: ${inputVariables}`\n        );\n      }\n    }\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document[]> {\n    let value: BasePromptValue = new StringPromptValue(query);\n\n    // Use a custom template if provided\n    if (this.promptTemplate) {\n      value = await this.promptTemplate.formatPromptValue({ question: query });\n    }\n\n    // Get a hypothetical answer from the LLM\n    const res = await this.llm.generatePrompt([value]);\n    const answer = res.generations[0][0].text;\n\n    // Retrieve relevant documents based on the hypothetical answer\n    const results = await this.vectorStore.similaritySearch(\n      answer,\n      this.k,\n      this.filter,\n      runManager?.getChild(\"vectorstore\")\n    );\n\n    return results;\n  }\n}\n\n/**\n * Returns a BasePromptTemplate instance based on a given PromptKey.\n */\nexport function getPromptTemplateFromKey(key: PromptKey): BasePromptTemplate {\n  let template: string;\n\n  switch (key) {\n    case \"websearch\":\n      template = `Please write a passage to answer the question\nQuestion: {question}\nPassage:`;\n      break;\n    case \"scifact\":\n      template = `Please write a scientific paper passage to support/refute the claim\nClaim: {question}\nPassage:`;\n      break;\n    case \"arguana\":\n      template = `Please write a counter argument for the passage\nPassage: {question}\nCounter Argument:`;\n      break;\n    case \"trec-covid\":\n      template = `Please write a scientific paper passage to answer the question\nQuestion: {question}\nPassage:`;\n      break;\n    case \"fiqa\":\n      template = `Please write a financial article passage to answer the question\nQuestion: {question}\nPassage:`;\n      break;\n    case \"dbpedia-entity\":\n      template = `Please write a passage to answer the question.\nQuestion: {question}\nPassage:`;\n      break;\n    case \"trec-news\":\n      template = `Please write a news passage about the topic.\nTopic: {question}\nPassage:`;\n      break;\n    case \"mr-tydi\":\n      template = `Please write a passage in Swahili/Korean/Japanese/Bengali to answer the question in detail.\nQuestion: {question}\nPassage:`;\n      break;\n    default:\n      throw new Error(`Invalid prompt key: ${key}`);\n  }\n\n  return PromptTemplate.fromTemplate(template);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+DA,IAAa,gBAAb,cAEUA,mDAAwB;CAChC,OAAO,UAAU;AACf,SAAO;CACR;CAED,IAAI,eAAyB;AAC3B,SAAO;GAAC;GAAa;GAAc;EAAO;CAC3C;CAED;CAEA;CAEA,YAAYC,QAAiC;EAC3C,MAAM,OAAO;EACb,KAAK,MAAM,OAAO;EAClB,KAAK,iBACH,OAAO,OAAO,mBAAmB,WAC7B,yBAAyB,OAAO,eAAe,GAC/C,OAAO;AACb,MAAI,KAAK,gBAAgB;GACvB,MAAM,EAAE,gBAAgB,GAAG,KAAK;AAChC,OAAI,eAAe,WAAW,KAAK,eAAe,OAAO,WACvD,OAAM,IAAI,MACR,CAAC,6GAA6G,EAAE,gBAAgB;EAGrI;CACF;CAED,MAAM,sBACJC,OACAC,YACqB;EACrB,IAAIC,QAAyB,IAAIC,iDAAkB;AAGnD,MAAI,KAAK,gBACP,QAAQ,MAAM,KAAK,eAAe,kBAAkB,EAAE,UAAU,MAAO,EAAC;EAI1E,MAAM,MAAM,MAAM,KAAK,IAAI,eAAe,CAAC,KAAM,EAAC;EAClD,MAAM,SAAS,IAAI,YAAY,GAAG,GAAG;EAGrC,MAAM,UAAU,MAAM,KAAK,YAAY,iBACrC,QACA,KAAK,GACL,KAAK,QACL,YAAY,SAAS,cAAc,CACpC;AAED,SAAO;CACR;AACF;;;;AAKD,SAAgB,yBAAyBC,KAAoC;CAC3E,IAAIC;AAEJ,SAAQ,KAAR;EACE,KAAK;GACH,WAAW,CAAC;;QAEV,CAAC;AACH;EACF,KAAK;GACH,WAAW,CAAC;;QAEV,CAAC;AACH;EACF,KAAK;GACH,WAAW,CAAC;;iBAED,CAAC;AACZ;EACF,KAAK;GACH,WAAW,CAAC;;QAEV,CAAC;AACH;EACF,KAAK;GACH,WAAW,CAAC;;QAEV,CAAC;AACH;EACF,KAAK;GACH,WAAW,CAAC;;QAEV,CAAC;AACH;EACF,KAAK;GACH,WAAW,CAAC;;QAEV,CAAC;AACH;EACF,KAAK;GACH,WAAW,CAAC;;QAEV,CAAC;AACH;EACF,QACE,OAAM,IAAI,MAAM,CAAC,oBAAoB,EAAE,KAAK;CAC/C;AAED,QAAOC,wCAAe,aAAa,SAAS;AAC7C"}

package/dist/retrievers/hyde.d.cts

@@ -0,0 +1,61 @@
+import { BasePromptTemplate } from "@langchain/core/prompts";
+import { BaseLanguageModelInterface } from "@langchain/core/language_models/base";
+import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
+import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
+import { Document } from "@langchain/core/documents";
+
+//#region src/retrievers/hyde.d.ts
+
+/**
+ * A string that corresponds to a specific prompt template.
+ */
+type PromptKey = "websearch" | "scifact" | "arguana" | "trec-covid" | "fiqa" | "dbpedia-entity" | "trec-news" | "mr-tydi";
+/**
+ * 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.
+ */
+type HydeRetrieverOptions<V extends VectorStore> = VectorStoreRetrieverInput<V> & {
+  llm: BaseLanguageModelInterface;
+  promptTemplate?: BasePromptTemplate | PromptKey;
+};
+/**
+ * A class for retrieving relevant documents based on a given query. It
+ * extends the VectorStoreRetriever class and uses a BaseLanguageModel to
+ * generate a hypothetical answer to the query, which is then used to
+ * retrieve relevant documents.
+ * @example
+ * ```typescript
+ * const retriever = new HydeRetriever({
+ *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),
+ *   llm: new ChatOpenAI({ model: "gpt-4o-mini" }),
+ *   k: 1,
+ * });
+ * await vectorStore.addDocuments(
+ *   [
+ *     "My name is John.",
+ *     "My name is Bob.",
+ *     "My favourite food is pizza.",
+ *     "My favourite food is pasta.",
+ *   ].map((pageContent) => new Document({ pageContent })),
+ * );
+ * const results = await retriever.invoke(
+ *   "What is my favourite food?",
+ * );
+ * ```
+ */
+declare class HydeRetriever<V extends VectorStore = VectorStore> extends VectorStoreRetriever<V> {
+  static lc_name(): string;
+  get lc_namespace(): string[];
+  llm: BaseLanguageModelInterface;
+  promptTemplate?: BasePromptTemplate;
+  constructor(fields: HydeRetrieverOptions<V>);
+  _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;
+}
+/**
+ * Returns a BasePromptTemplate instance based on a given PromptKey.
+ */
+declare function getPromptTemplateFromKey(key: PromptKey): BasePromptTemplate;
+//#endregion
+export { HydeRetriever, HydeRetrieverOptions, PromptKey, getPromptTemplateFromKey };
+//# sourceMappingURL=hyde.d.cts.map

package/dist/retrievers/hyde.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hyde.d.cts","names":["BaseLanguageModelInterface","Document","BasePromptTemplate","VectorStore","VectorStoreRetriever","VectorStoreRetrieverInput","CallbackManagerForRetrieverRun","PromptKey","HydeRetrieverOptions","V","HydeRetriever","Promise","getPromptTemplateFromKey"],"sources":["../../src/retrievers/hyde.d.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { Document } from \"@langchain/core/documents\";\nimport { BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from \"@langchain/core/vectorstores\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n/**\n * A string that corresponds to a specific prompt template.\n */\nexport type PromptKey = \"websearch\" | \"scifact\" | \"arguana\" | \"trec-covid\" | \"fiqa\" | \"dbpedia-entity\" | \"trec-news\" | \"mr-tydi\";\n/**\n * Options for the HydeRetriever class, which includes a BaseLanguageModel\n * instance, a VectorStore instance, and an optional promptTemplate which\n * can either be a BasePromptTemplate instance or a PromptKey.\n */\nexport type HydeRetrieverOptions<V extends VectorStore> = VectorStoreRetrieverInput<V> & {\n    llm: BaseLanguageModelInterface;\n    promptTemplate?: BasePromptTemplate | PromptKey;\n};\n/**\n * A class for retrieving relevant documents based on a given query. It\n * extends the VectorStoreRetriever class and uses a BaseLanguageModel to\n * generate a hypothetical answer to the query, which is then used to\n * retrieve relevant documents.\n * @example\n * ```typescript\n * const retriever = new HydeRetriever({\n *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   k: 1,\n * });\n * await vectorStore.addDocuments(\n *   [\n *     \"My name is John.\",\n *     \"My name is Bob.\",\n *     \"My favourite food is pizza.\",\n *     \"My favourite food is pasta.\",\n *   ].map((pageContent) => new Document({ pageContent })),\n * );\n * const results = await retriever.invoke(\n *   \"What is my favourite food?\",\n * );\n * ```\n */\nexport declare class HydeRetriever<V extends VectorStore = VectorStore> extends VectorStoreRetriever<V> {\n    static lc_name(): string;\n    get lc_namespace(): string[];\n    llm: BaseLanguageModelInterface;\n    promptTemplate?: BasePromptTemplate;\n    constructor(fields: HydeRetrieverOptions<V>);\n    _getRelevantDocuments(query: string, runManager?: CallbackManagerForRetrieverRun): Promise<Document[]>;\n}\n/**\n * Returns a BasePromptTemplate instance based on a given PromptKey.\n */\nexport declare function getPromptTemplateFromKey(key: PromptKey): BasePromptTemplate;\n"],"mappings":";;;;;;;;;;AAQA;AAMYQ,KANAD,SAAAA,GAMAC,WAAoB,GAAA,SAAA,GAAA,SAAA,GAAA,YAAA,GAAA,MAAA,GAAA,gBAAA,GAAA,WAAA,GAAA,SAAA;;;;;;AAEXN,KAFTM,oBAESN,CAAAA,UAFsBC,WAEtBD,CAAAA,GAFqCG,yBAErCH,CAF+DO,CAE/DP,CAAAA,GAAAA;EAAkB,GAAGK,EADjCP,0BACiCO;EAAS,cAAA,CAAA,EAA9BL,kBAA8B,GAATK,SAAS;AA2BnD,CAAA;;;;;;;;;;;;;AAAoG;AAWpG;;;;AAAoF;;;;;;;;cAX/DG,wBAAwBP,cAAcA,qBAAqBC,qBAAqBK;;;OAG5FT;mBACYE;sBACGM,qBAAqBC;oDACSH,iCAAiCK,QAAQV;;;;;iBAKvEW,wBAAAA,MAA8BL,YAAYL"}