@langchain/classic 1.0.39 → 1.0.41

package/dist/retrievers/document_compressors/embeddings_filter.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"embeddings_filter.cjs","names":["BaseDocumentCompressor","cosineSimilarity"],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"sourcesContent":["import type { EmbeddingsInterface } from \"@langchain/core/embeddings\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { cosineSimilarity } from \"@langchain/core/utils/math\";\nimport { BaseDocumentCompressor } from \"./index.js\";\n\n/**\n * Interface for the parameters of the `EmbeddingsFilter` class.\n */\nexport interface EmbeddingsFilterParams {\n  embeddings: EmbeddingsInterface;\n  similarityFn?: (x: number[][], y: number[][]) => number[][];\n  similarityThreshold?: number;\n  k?: number;\n}\n\n/**\n * Class that represents a document compressor that uses embeddings to\n * drop documents unrelated to the query.\n * @example\n * ```typescript\n * const embeddingsFilter = new EmbeddingsFilter({\n *   embeddings: new OpenAIEmbeddings(),\n *   similarityThreshold: 0.8,\n *   k: 5,\n * });\n * const retrievedDocs = await embeddingsFilter.filterDocuments(\n *   getDocuments(),\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 EmbeddingsFilter extends BaseDocumentCompressor {\n  /**\n   * Embeddings to use for embedding document contents and queries.\n   */\n  embeddings: EmbeddingsInterface;\n\n  /**\n   * Similarity function for comparing documents.\n   */\n  similarityFn = cosineSimilarity;\n\n  /**\n   * Threshold for determining when two documents are similar enough\n   * to be considered redundant. Must be specified if `k` is not set.\n   */\n  similarityThreshold?: number;\n\n  /**\n   * The number of relevant documents to return. Can be explicitly set to undefined, in which case\n   * similarity_threshold` must be specified. Defaults to 20\n   */\n  k? = 20;\n\n  constructor(params: EmbeddingsFilterParams) {\n    super();\n    this.embeddings = params.embeddings;\n    this.similarityFn = params.similarityFn ?? this.similarityFn;\n    this.similarityThreshold = params.similarityThreshold;\n    this.k = \"k\" in params ? params.k : this.k;\n    if (this.k === undefined && this.similarityThreshold === undefined) {\n      throw new Error(`Must specify one of \"k\" or \"similarity_threshold\".`);\n    }\n  }\n\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const embeddedDocuments = await this.embeddings.embedDocuments(\n      documents.map((doc) => doc.pageContent)\n    );\n    const embeddedQuery = await this.embeddings.embedQuery(query);\n    const similarity = this.similarityFn([embeddedQuery], embeddedDocuments)[0];\n    let includedIdxs = Array.from(\n      { length: embeddedDocuments.length },\n      (_, i) => i\n    );\n\n    if (this.k !== undefined) {\n      includedIdxs = includedIdxs\n        .map((v, i) => [similarity[i], v])\n        .sort(([a], [b]) => b - a)\n        .slice(0, this.k)\n        .map(([, i]) => i);\n    }\n\n    if (this.similarityThreshold !== undefined) {\n      const threshold = this.similarityThreshold;\n      includedIdxs = includedIdxs.filter((i) => similarity[i] > threshold);\n    }\n\n    return includedIdxs.map((i) => documents[i]);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAgCA,IAAa,mBAAb,cAAsCA,8CAAAA,uBAAuB;;;;CAI3D;;;;CAKA,eAAeC,2BAAAA;;;;;CAMf;;;;;CAMA,IAAK;CAEL,YAAY,QAAgC;AAC1C,SAAO;AACP,OAAK,aAAa,OAAO;AACzB,OAAK,eAAe,OAAO,gBAAgB,KAAK;AAChD,OAAK,sBAAsB,OAAO;AAClC,OAAK,IAAI,OAAO,SAAS,OAAO,IAAI,KAAK;AACzC,MAAI,KAAK,MAAM,KAAA,KAAa,KAAK,wBAAwB,KAAA,EACvD,OAAM,IAAI,MAAM,qDAAqD;;CAIzE,MAAM,kBACJ,WACA,OAC8B;EAC9B,MAAM,oBAAoB,MAAM,KAAK,WAAW,eAC9C,UAAU,KAAK,QAAQ,IAAI,YAAY,CACxC;EACD,MAAM,gBAAgB,MAAM,KAAK,WAAW,WAAW,MAAM;EAC7D,MAAM,aAAa,KAAK,aAAa,CAAC,cAAc,EAAE,kBAAkB,CAAC;EACzE,IAAI,eAAe,MAAM,KACvB,EAAE,QAAQ,kBAAkB,QAAQ,GACnC,GAAG,MAAM,EACX;AAED,MAAI,KAAK,MAAM,KAAA,EACb,gBAAe,aACZ,KAAK,GAAG,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,CACjC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CACzB,MAAM,GAAG,KAAK,EAAE,CAChB,KAAK,GAAG,OAAO,EAAE;AAGtB,MAAI,KAAK,wBAAwB,KAAA,GAAW;GAC1C,MAAM,YAAY,KAAK;AACvB,kBAAe,aAAa,QAAQ,MAAM,WAAW,KAAK,UAAU;;AAGtE,SAAO,aAAa,KAAK,MAAM,UAAU,GAAG"}
+{"version":3,"file":"embeddings_filter.cjs","names":["BaseDocumentCompressor","cosineSimilarity"],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"sourcesContent":["import type { EmbeddingsInterface } from \"@langchain/core/embeddings\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { cosineSimilarity } from \"@langchain/core/utils/math\";\nimport { BaseDocumentCompressor } from \"./index.js\";\n\n/**\n * Interface for the parameters of the `EmbeddingsFilter` class.\n */\nexport interface EmbeddingsFilterParams {\n  embeddings: EmbeddingsInterface;\n  similarityFn?: (x: number[][], y: number[][]) => number[][];\n  similarityThreshold?: number;\n  k?: number;\n}\n\n/**\n * Class that represents a document compressor that uses embeddings to\n * drop documents unrelated to the query.\n * @example\n * ```typescript\n * const embeddingsFilter = new EmbeddingsFilter({\n *   embeddings: new OpenAIEmbeddings(),\n *   similarityThreshold: 0.8,\n *   k: 5,\n * });\n * const retrievedDocs = await embeddingsFilter.filterDocuments(\n *   getDocuments(),\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 EmbeddingsFilter extends BaseDocumentCompressor {\n  /**\n   * Embeddings to use for embedding document contents and queries.\n   */\n  embeddings: EmbeddingsInterface;\n\n  /**\n   * Similarity function for comparing documents.\n   */\n  similarityFn = cosineSimilarity;\n\n  /**\n   * Threshold for determining when two documents are similar enough\n   * to be considered redundant. Must be specified if `k` is not set.\n   */\n  similarityThreshold?: number;\n\n  /**\n   * The number of relevant documents to return. Can be explicitly set to undefined, in which case\n   * similarity_threshold` must be specified. Defaults to 20\n   */\n  k? = 20;\n\n  constructor(params: EmbeddingsFilterParams) {\n    super();\n    this.embeddings = params.embeddings;\n    this.similarityFn = params.similarityFn ?? this.similarityFn;\n    this.similarityThreshold = params.similarityThreshold;\n    this.k = \"k\" in params ? params.k : this.k;\n    if (this.k === undefined && this.similarityThreshold === undefined) {\n      throw new Error(`Must specify one of \"k\" or \"similarity_threshold\".`);\n    }\n  }\n\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const embeddedDocuments = await this.embeddings.embedDocuments(\n      documents.map((doc) => doc.pageContent)\n    );\n    const embeddedQuery = await this.embeddings.embedQuery(query);\n    const similarity = this.similarityFn([embeddedQuery], embeddedDocuments)[0];\n    let includedIdxs = Array.from(\n      { length: embeddedDocuments.length },\n      (_, i) => i\n    );\n\n    if (this.k !== undefined) {\n      includedIdxs = includedIdxs\n        .map((v, i) => [similarity[i], v])\n        .sort(([a], [b]) => b - a)\n        .slice(0, this.k)\n        .map(([, i]) => i);\n    }\n\n    if (this.similarityThreshold !== undefined) {\n      const threshold = this.similarityThreshold;\n      includedIdxs = includedIdxs.filter((i) => similarity[i] > threshold);\n    }\n\n    return includedIdxs.map((i) => documents[i]);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAgCA,IAAa,mBAAb,cAAsCA,8CAAAA,uBAAuB;;;;CAI3D;;;;CAKA,eAAeC,2BAAAA;;;;;CAMf;;;;;CAMA,IAAK;CAEL,YAAY,QAAgC;EAC1C,MAAM;EACN,KAAK,aAAa,OAAO;EACzB,KAAK,eAAe,OAAO,gBAAgB,KAAK;EAChD,KAAK,sBAAsB,OAAO;EAClC,KAAK,IAAI,OAAO,SAAS,OAAO,IAAI,KAAK;EACzC,IAAI,KAAK,MAAM,KAAA,KAAa,KAAK,wBAAwB,KAAA,GACvD,MAAM,IAAI,MAAM,oDAAoD;CAExE;CAEA,MAAM,kBACJ,WACA,OAC8B;EAC9B,MAAM,oBAAoB,MAAM,KAAK,WAAW,eAC9C,UAAU,KAAK,QAAQ,IAAI,WAAW,CACxC;EACA,MAAM,gBAAgB,MAAM,KAAK,WAAW,WAAW,KAAK;EAC5D,MAAM,aAAa,KAAK,aAAa,CAAC,aAAa,GAAG,iBAAiB,CAAC,CAAC;EACzE,IAAI,eAAe,MAAM,KACvB,EAAE,QAAQ,kBAAkB,OAAO,IAClC,GAAG,MAAM,CACZ;EAEA,IAAI,KAAK,MAAM,KAAA,GACb,eAAe,aACZ,KAAK,GAAG,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CACjC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,CACzB,MAAM,GAAG,KAAK,CAAC,CAAC,CAChB,KAAK,GAAG,OAAO,CAAC;EAGrB,IAAI,KAAK,wBAAwB,KAAA,GAAW;GAC1C,MAAM,YAAY,KAAK;GACvB,eAAe,aAAa,QAAQ,MAAM,WAAW,KAAK,SAAS;EACrE;EAEA,OAAO,aAAa,KAAK,MAAM,UAAU,EAAE;CAC7C;AACF"}

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

@@ -2,7 +2,6 @@ import { BaseDocumentCompressor } from "./index.cjs";
 import { DocumentInterface } from "@langchain/core/documents";
 import { EmbeddingsInterface } from "@langchain/core/embeddings";
 import { cosineSimilarity } from "@langchain/core/utils/math";
-
 //#region src/retrievers/document_compressors/embeddings_filter.d.ts
 /**
  * Interface for the parameters of the `EmbeddingsFilter` class.

package/dist/retrievers/document_compressors/embeddings_filter.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"embeddings_filter.d.cts","names":[],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"mappings":";;;;;;;;AAQA;UAAiB,sBAAA;EACf,UAAA,EAAY,mBAAA;EACZ,YAAA,IAAgB,CAAA,cAAe,CAAA;EAC/B,mBAAA;EACA,CAAA;AAAA;;;;;;;AAoBF;;;;;;;;;;;cAAa,gBAAA,SAAyB,sBAAA;EAAA;;;EAIpC,UAAA,EAAY,mBAAA;EAKA;;;EAAZ,YAAA,SAAY,gBAAA;EAcQ;;;;EARpB,mBAAA;EAqBE;;;;EAfF,CAAA;EAEA,WAAA,CAAY,MAAA,EAAQ,sBAAA;EAWd,iBAAA,CACJ,SAAA,EAAW,iBAAA,IACX,KAAA,WACC,OAAA,CAAQ,iBAAA;AAAA"}
+{"version":3,"file":"embeddings_filter.d.cts","names":[],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"mappings":";;;;;;;;UAQiB;EACf,YAAY;EACZ,gBAAgB,eAAe;EAC/B;EACA;;;;;;;;;;;;;;;;;;;cAoBW,yBAAyB;;;;EAIpC,YAAY;;;;EAKZ,qBAAY;;;;;EAMZ;;;;;EAMA;EAEA,YAAY,QAAQ;EAWd,kBACJ,WAAW,qBACX,gBACC,QAAQ"}

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

@@ -2,7 +2,6 @@ import { BaseDocumentCompressor } from "./index.js";
 import { DocumentInterface } from "@langchain/core/documents";
 import { EmbeddingsInterface } from "@langchain/core/embeddings";
 import { cosineSimilarity } from "@langchain/core/utils/math";
-
 //#region src/retrievers/document_compressors/embeddings_filter.d.ts
 /**
  * Interface for the parameters of the `EmbeddingsFilter` class.

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

@@ -1 +1 @@
-{"version":3,"file":"embeddings_filter.d.ts","names":[],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"mappings":";;;;;;;;AAQA;UAAiB,sBAAA;EACf,UAAA,EAAY,mBAAA;EACZ,YAAA,IAAgB,CAAA,cAAe,CAAA;EAC/B,mBAAA;EACA,CAAA;AAAA;;;;;;;AAoBF;;;;;;;;;;;cAAa,gBAAA,SAAyB,sBAAA;EAAA;;;EAIpC,UAAA,EAAY,mBAAA;EAKA;;;EAAZ,YAAA,SAAY,gBAAA;EAcQ;;;;EARpB,mBAAA;EAqBE;;;;EAfF,CAAA;EAEA,WAAA,CAAY,MAAA,EAAQ,sBAAA;EAWd,iBAAA,CACJ,SAAA,EAAW,iBAAA,IACX,KAAA,WACC,OAAA,CAAQ,iBAAA;AAAA"}
+{"version":3,"file":"embeddings_filter.d.ts","names":[],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"mappings":";;;;;;;;UAQiB;EACf,YAAY;EACZ,gBAAgB,eAAe;EAC/B;EACA;;;;;;;;;;;;;;;;;;;cAoBW,yBAAyB;;;;EAIpC,YAAY;;;;EAKZ,qBAAY;;;;;EAMZ;;;;;EAMA;EAEA,YAAY,QAAQ;EAWd,kBACJ,WAAW,qBACX,gBACC,QAAQ"}

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

@@ -1 +1 @@
-{"version":3,"file":"embeddings_filter.js","names":[],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"sourcesContent":["import type { EmbeddingsInterface } from \"@langchain/core/embeddings\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { cosineSimilarity } from \"@langchain/core/utils/math\";\nimport { BaseDocumentCompressor } from \"./index.js\";\n\n/**\n * Interface for the parameters of the `EmbeddingsFilter` class.\n */\nexport interface EmbeddingsFilterParams {\n  embeddings: EmbeddingsInterface;\n  similarityFn?: (x: number[][], y: number[][]) => number[][];\n  similarityThreshold?: number;\n  k?: number;\n}\n\n/**\n * Class that represents a document compressor that uses embeddings to\n * drop documents unrelated to the query.\n * @example\n * ```typescript\n * const embeddingsFilter = new EmbeddingsFilter({\n *   embeddings: new OpenAIEmbeddings(),\n *   similarityThreshold: 0.8,\n *   k: 5,\n * });\n * const retrievedDocs = await embeddingsFilter.filterDocuments(\n *   getDocuments(),\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 EmbeddingsFilter extends BaseDocumentCompressor {\n  /**\n   * Embeddings to use for embedding document contents and queries.\n   */\n  embeddings: EmbeddingsInterface;\n\n  /**\n   * Similarity function for comparing documents.\n   */\n  similarityFn = cosineSimilarity;\n\n  /**\n   * Threshold for determining when two documents are similar enough\n   * to be considered redundant. Must be specified if `k` is not set.\n   */\n  similarityThreshold?: number;\n\n  /**\n   * The number of relevant documents to return. Can be explicitly set to undefined, in which case\n   * similarity_threshold` must be specified. Defaults to 20\n   */\n  k? = 20;\n\n  constructor(params: EmbeddingsFilterParams) {\n    super();\n    this.embeddings = params.embeddings;\n    this.similarityFn = params.similarityFn ?? this.similarityFn;\n    this.similarityThreshold = params.similarityThreshold;\n    this.k = \"k\" in params ? params.k : this.k;\n    if (this.k === undefined && this.similarityThreshold === undefined) {\n      throw new Error(`Must specify one of \"k\" or \"similarity_threshold\".`);\n    }\n  }\n\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const embeddedDocuments = await this.embeddings.embedDocuments(\n      documents.map((doc) => doc.pageContent)\n    );\n    const embeddedQuery = await this.embeddings.embedQuery(query);\n    const similarity = this.similarityFn([embeddedQuery], embeddedDocuments)[0];\n    let includedIdxs = Array.from(\n      { length: embeddedDocuments.length },\n      (_, i) => i\n    );\n\n    if (this.k !== undefined) {\n      includedIdxs = includedIdxs\n        .map((v, i) => [similarity[i], v])\n        .sort(([a], [b]) => b - a)\n        .slice(0, this.k)\n        .map(([, i]) => i);\n    }\n\n    if (this.similarityThreshold !== undefined) {\n      const threshold = this.similarityThreshold;\n      includedIdxs = includedIdxs.filter((i) => similarity[i] > threshold);\n    }\n\n    return includedIdxs.map((i) => documents[i]);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAgCA,IAAa,mBAAb,cAAsC,uBAAuB;;;;CAI3D;;;;CAKA,eAAe;;;;;CAMf;;;;;CAMA,IAAK;CAEL,YAAY,QAAgC;AAC1C,SAAO;AACP,OAAK,aAAa,OAAO;AACzB,OAAK,eAAe,OAAO,gBAAgB,KAAK;AAChD,OAAK,sBAAsB,OAAO;AAClC,OAAK,IAAI,OAAO,SAAS,OAAO,IAAI,KAAK;AACzC,MAAI,KAAK,MAAM,KAAA,KAAa,KAAK,wBAAwB,KAAA,EACvD,OAAM,IAAI,MAAM,qDAAqD;;CAIzE,MAAM,kBACJ,WACA,OAC8B;EAC9B,MAAM,oBAAoB,MAAM,KAAK,WAAW,eAC9C,UAAU,KAAK,QAAQ,IAAI,YAAY,CACxC;EACD,MAAM,gBAAgB,MAAM,KAAK,WAAW,WAAW,MAAM;EAC7D,MAAM,aAAa,KAAK,aAAa,CAAC,cAAc,EAAE,kBAAkB,CAAC;EACzE,IAAI,eAAe,MAAM,KACvB,EAAE,QAAQ,kBAAkB,QAAQ,GACnC,GAAG,MAAM,EACX;AAED,MAAI,KAAK,MAAM,KAAA,EACb,gBAAe,aACZ,KAAK,GAAG,MAAM,CAAC,WAAW,IAAI,EAAE,CAAC,CACjC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CACzB,MAAM,GAAG,KAAK,EAAE,CAChB,KAAK,GAAG,OAAO,EAAE;AAGtB,MAAI,KAAK,wBAAwB,KAAA,GAAW;GAC1C,MAAM,YAAY,KAAK;AACvB,kBAAe,aAAa,QAAQ,MAAM,WAAW,KAAK,UAAU;;AAGtE,SAAO,aAAa,KAAK,MAAM,UAAU,GAAG"}
+{"version":3,"file":"embeddings_filter.js","names":[],"sources":["../../../src/retrievers/document_compressors/embeddings_filter.ts"],"sourcesContent":["import type { EmbeddingsInterface } from \"@langchain/core/embeddings\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { cosineSimilarity } from \"@langchain/core/utils/math\";\nimport { BaseDocumentCompressor } from \"./index.js\";\n\n/**\n * Interface for the parameters of the `EmbeddingsFilter` class.\n */\nexport interface EmbeddingsFilterParams {\n  embeddings: EmbeddingsInterface;\n  similarityFn?: (x: number[][], y: number[][]) => number[][];\n  similarityThreshold?: number;\n  k?: number;\n}\n\n/**\n * Class that represents a document compressor that uses embeddings to\n * drop documents unrelated to the query.\n * @example\n * ```typescript\n * const embeddingsFilter = new EmbeddingsFilter({\n *   embeddings: new OpenAIEmbeddings(),\n *   similarityThreshold: 0.8,\n *   k: 5,\n * });\n * const retrievedDocs = await embeddingsFilter.filterDocuments(\n *   getDocuments(),\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 EmbeddingsFilter extends BaseDocumentCompressor {\n  /**\n   * Embeddings to use for embedding document contents and queries.\n   */\n  embeddings: EmbeddingsInterface;\n\n  /**\n   * Similarity function for comparing documents.\n   */\n  similarityFn = cosineSimilarity;\n\n  /**\n   * Threshold for determining when two documents are similar enough\n   * to be considered redundant. Must be specified if `k` is not set.\n   */\n  similarityThreshold?: number;\n\n  /**\n   * The number of relevant documents to return. Can be explicitly set to undefined, in which case\n   * similarity_threshold` must be specified. Defaults to 20\n   */\n  k? = 20;\n\n  constructor(params: EmbeddingsFilterParams) {\n    super();\n    this.embeddings = params.embeddings;\n    this.similarityFn = params.similarityFn ?? this.similarityFn;\n    this.similarityThreshold = params.similarityThreshold;\n    this.k = \"k\" in params ? params.k : this.k;\n    if (this.k === undefined && this.similarityThreshold === undefined) {\n      throw new Error(`Must specify one of \"k\" or \"similarity_threshold\".`);\n    }\n  }\n\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const embeddedDocuments = await this.embeddings.embedDocuments(\n      documents.map((doc) => doc.pageContent)\n    );\n    const embeddedQuery = await this.embeddings.embedQuery(query);\n    const similarity = this.similarityFn([embeddedQuery], embeddedDocuments)[0];\n    let includedIdxs = Array.from(\n      { length: embeddedDocuments.length },\n      (_, i) => i\n    );\n\n    if (this.k !== undefined) {\n      includedIdxs = includedIdxs\n        .map((v, i) => [similarity[i], v])\n        .sort(([a], [b]) => b - a)\n        .slice(0, this.k)\n        .map(([, i]) => i);\n    }\n\n    if (this.similarityThreshold !== undefined) {\n      const threshold = this.similarityThreshold;\n      includedIdxs = includedIdxs.filter((i) => similarity[i] > threshold);\n    }\n\n    return includedIdxs.map((i) => documents[i]);\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAgCA,IAAa,mBAAb,cAAsC,uBAAuB;;;;CAI3D;;;;CAKA,eAAe;;;;;CAMf;;;;;CAMA,IAAK;CAEL,YAAY,QAAgC;EAC1C,MAAM;EACN,KAAK,aAAa,OAAO;EACzB,KAAK,eAAe,OAAO,gBAAgB,KAAK;EAChD,KAAK,sBAAsB,OAAO;EAClC,KAAK,IAAI,OAAO,SAAS,OAAO,IAAI,KAAK;EACzC,IAAI,KAAK,MAAM,KAAA,KAAa,KAAK,wBAAwB,KAAA,GACvD,MAAM,IAAI,MAAM,oDAAoD;CAExE;CAEA,MAAM,kBACJ,WACA,OAC8B;EAC9B,MAAM,oBAAoB,MAAM,KAAK,WAAW,eAC9C,UAAU,KAAK,QAAQ,IAAI,WAAW,CACxC;EACA,MAAM,gBAAgB,MAAM,KAAK,WAAW,WAAW,KAAK;EAC5D,MAAM,aAAa,KAAK,aAAa,CAAC,aAAa,GAAG,iBAAiB,CAAC,CAAC;EACzE,IAAI,eAAe,MAAM,KACvB,EAAE,QAAQ,kBAAkB,OAAO,IAClC,GAAG,MAAM,CACZ;EAEA,IAAI,KAAK,MAAM,KAAA,GACb,eAAe,aACZ,KAAK,GAAG,MAAM,CAAC,WAAW,IAAI,CAAC,CAAC,CAAC,CACjC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,CACzB,MAAM,GAAG,KAAK,CAAC,CAAC,CAChB,KAAK,GAAG,OAAO,CAAC;EAGrB,IAAI,KAAK,wBAAwB,KAAA,GAAW;GAC1C,MAAM,YAAY,KAAK;GACvB,eAAe,aAAa,QAAQ,MAAM,WAAW,KAAK,SAAS;EACrE;EAEA,OAAO,aAAa,KAAK,MAAM,UAAU,EAAE;CAC7C;AACF"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":[],"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  // oxlint-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 =\n          await transformer.transformDocuments(transformedDocuments);\n      }\n    }\n    return transformedDocuments;\n  }\n}\n"],"mappings":";;;;;;;;;AAOA,IAAsB,yBAAtB,MAA6C;CAiB3C,OAAO,yBAAyB,GAAqC;AACnE,SAAO,GAAG,sBAAsB,KAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCpC,IAAa,6BAAb,cAAgD,uBAAuB;CACrE;CAEA,YAAY,QAET;AACD,SAAO;AACP,OAAK,eAAe,OAAO;;CAG7B,MAAM,kBACJ,WACA,OACA,WAC8B;EAC9B,IAAI,uBAAuB;AAC3B,OAAK,MAAM,eAAe,KAAK,aAC7B,KAAI,uBAAuB,yBAAyB,YAAY,CAC9D,wBAAuB,MAAM,YAAY,kBACvC,sBACA,OACA,UACD;MAED,wBACE,MAAM,YAAY,mBAAmB,qBAAqB;AAGhE,SAAO"}
+{"version":3,"file":"index.cjs","names":[],"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  // oxlint-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 =\n          await transformer.transformDocuments(transformedDocuments);\n      }\n    }\n    return transformedDocuments;\n  }\n}\n"],"mappings":";;;;;;;;;AAOA,IAAsB,yBAAtB,MAA6C;CAiB3C,OAAO,yBAAyB,GAAqC;EACnE,OAAO,GAAG,sBAAsB,KAAA;CAClC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,IAAa,6BAAb,cAAgD,uBAAuB;CACrE;CAEA,YAAY,QAET;EACD,MAAM;EACN,KAAK,eAAe,OAAO;CAC7B;CAEA,MAAM,kBACJ,WACA,OACA,WAC8B;EAC9B,IAAI,uBAAuB;EAC3B,KAAK,MAAM,eAAe,KAAK,cAC7B,IAAI,uBAAuB,yBAAyB,WAAW,GAC7D,uBAAuB,MAAM,YAAY,kBACvC,sBACA,OACA,SACF;OAEA,uBACE,MAAM,YAAY,mBAAmB,oBAAoB;EAG/D,OAAO;CACT;AACF"}

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

@@ -1,6 +1,5 @@
 import { Callbacks } from "@langchain/core/callbacks/manager";
 import { BaseDocumentTransformer, DocumentInterface } from "@langchain/core/documents";
-
 //#region src/retrievers/document_compressors/index.d.ts
 /**
  * Base Document Compression class. All compressors should extend this class.

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../../src/retrievers/document_compressors/index.ts"],"mappings":";;;;;AAOA;;uBAAsB,sBAAA;EAWP;;;;;;;;;EAAA,SADJ,iBAAA,CACP,SAAA,EAAW,iBAAA,IACX,KAAA,UACA,SAAA,GAAY,SAAA,GACX,OAAA,CAAQ,iBAAA;EAAA,OAGJ,wBAAA,CAAyB,CAAA,QAAS,CAAA,IAAK,sBAAA;AAAA;;;;;;;;;;AAkChD;;;;;;;;;;;;;;;;;;;;cAAa,0BAAA,SAAmC,sBAAA;EAC9C,YAAA,GAAe,uBAAA,GAA0B,sBAAA;EAEzC,WAAA,CAAY,MAAA;IACV,YAAA,GAAe,uBAAA,GAA0B,sBAAA;EAAA;EAMrC,iBAAA,CACJ,SAAA,EAAW,iBAAA,IACX,KAAA,UACA,SAAA,GAAY,SAAA,GACX,OAAA,CAAQ,iBAAA;AAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../../src/retrievers/document_compressors/index.ts"],"mappings":";;;;;;uBAOsB;;;;;;;;;;WAUX,kBACP,WAAW,qBACX,eACA,YAAY,YACX,QAAQ;SAGJ,yBAAyB,SAAS,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAkCnC,mCAAmC;EAC9C,eAAe,0BAA0B;EAEzC,YAAY;IACV,eAAe,0BAA0B;;EAMrC,kBACJ,WAAW,qBACX,eACA,YAAY,YACX,QAAQ"}

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

@@ -1,6 +1,5 @@
 import { Callbacks } from "@langchain/core/callbacks/manager";
 import { BaseDocumentTransformer, DocumentInterface } from "@langchain/core/documents";
-
 //#region src/retrievers/document_compressors/index.d.ts
 /**
  * Base Document Compression class. All compressors should extend this class.

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/retrievers/document_compressors/index.ts"],"mappings":";;;;;AAOA;;uBAAsB,sBAAA;EAWP;;;;;;;;;EAAA,SADJ,iBAAA,CACP,SAAA,EAAW,iBAAA,IACX,KAAA,UACA,SAAA,GAAY,SAAA,GACX,OAAA,CAAQ,iBAAA;EAAA,OAGJ,wBAAA,CAAyB,CAAA,QAAS,CAAA,IAAK,sBAAA;AAAA;;;;;;;;;;AAkChD;;;;;;;;;;;;;;;;;;;;cAAa,0BAAA,SAAmC,sBAAA;EAC9C,YAAA,GAAe,uBAAA,GAA0B,sBAAA;EAEzC,WAAA,CAAY,MAAA;IACV,YAAA,GAAe,uBAAA,GAA0B,sBAAA;EAAA;EAMrC,iBAAA,CACJ,SAAA,EAAW,iBAAA,IACX,KAAA,UACA,SAAA,GAAY,SAAA,GACX,OAAA,CAAQ,iBAAA;AAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/retrievers/document_compressors/index.ts"],"mappings":";;;;;;uBAOsB;;;;;;;;;;WAUX,kBACP,WAAW,qBACX,eACA,YAAY,YACX,QAAQ;SAGJ,yBAAyB,SAAS,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAkCnC,mCAAmC;EAC9C,eAAe,0BAA0B;EAEzC,YAAY;IACV,eAAe,0BAA0B;;EAMrC,kBACJ,WAAW,qBACX,eACA,YAAY,YACX,QAAQ"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"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  // oxlint-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 =\n          await transformer.transformDocuments(transformedDocuments);\n      }\n    }\n    return transformedDocuments;\n  }\n}\n"],"mappings":";;;;;;;;;AAOA,IAAsB,yBAAtB,MAA6C;CAiB3C,OAAO,yBAAyB,GAAqC;AACnE,SAAO,GAAG,sBAAsB,KAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiCpC,IAAa,6BAAb,cAAgD,uBAAuB;CACrE;CAEA,YAAY,QAET;AACD,SAAO;AACP,OAAK,eAAe,OAAO;;CAG7B,MAAM,kBACJ,WACA,OACA,WAC8B;EAC9B,IAAI,uBAAuB;AAC3B,OAAK,MAAM,eAAe,KAAK,aAC7B,KAAI,uBAAuB,yBAAyB,YAAY,CAC9D,wBAAuB,MAAM,YAAY,kBACvC,sBACA,OACA,UACD;MAED,wBACE,MAAM,YAAY,mBAAmB,qBAAqB;AAGhE,SAAO"}
+{"version":3,"file":"index.js","names":[],"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  // oxlint-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 =\n          await transformer.transformDocuments(transformedDocuments);\n      }\n    }\n    return transformedDocuments;\n  }\n}\n"],"mappings":";;;;;;;;;AAOA,IAAsB,yBAAtB,MAA6C;CAiB3C,OAAO,yBAAyB,GAAqC;EACnE,OAAO,GAAG,sBAAsB,KAAA;CAClC;AACF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA+BA,IAAa,6BAAb,cAAgD,uBAAuB;CACrE;CAEA,YAAY,QAET;EACD,MAAM;EACN,KAAK,eAAe,OAAO;CAC7B;CAEA,MAAM,kBACJ,WACA,OACA,WAC8B;EAC9B,IAAI,uBAAuB;EAC3B,KAAK,MAAM,eAAe,KAAK,cAC7B,IAAI,uBAAuB,yBAAyB,WAAW,GAC7D,uBAAuB,MAAM,YAAY,kBACvC,sBACA,OACA,SACF;OAEA,uBACE,MAAM,YAAY,mBAAmB,oBAAoB;EAG/D,OAAO;CACT;AACF"}

package/dist/retrievers/ensemble.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ensemble.cjs","names":["BaseRetriever"],"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,2BAAAA,cAAc;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;AACxC,QAAM,KAAK;AACX,OAAK,aAAa,KAAK;AACvB,OAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,OAAO,CAAC,KAAK,IAAI,KAAK,WAAW,OAAO;AACpE,OAAK,IAAI,KAAK,KAAK;;CAGrB,MAAM,sBACJ,OACA,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;;CAG5C,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,IAAI,EACtD,CAAC,CACH,CACF;AAGD,SAAO,MADiB,KAAK,wBAAwB,cAAc;;CAIrE,MAAM,wBAAwB,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR,6EACD;EAGH,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,aACZ,UAAS,eAAe;AAE1B,aAAS,gBAAgB,UAAU,OAAO,KAAK;AAC/C,YAAQ;;AAGV,UAAO;KAET,EAAE,CACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;AAKpD,SAJmB,MAAM,KAAK,WAAW,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aAGxC;;CAGnB,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,KAAK;EAC7B,MAAM,SAAS,EAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;AACzB,gBAAY,IAAI,IAAI;AACpB,WAAO,KAAK,IAAI;;;AAIpB,SAAO"}
+{"version":3,"file":"ensemble.cjs","names":["BaseRetriever"],"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,2BAAAA,cAAc;CACnD,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAoB;CAE/D;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;EACxC,MAAM,IAAI;EACV,KAAK,aAAa,KAAK;EACvB,KAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,MAAM,CAAC,CAAC,KAAK,IAAI,KAAK,WAAW,MAAM;EACnE,KAAK,IAAI,KAAK,KAAK;CACrB;CAEA,MAAM,sBACJ,OACA,YACA;EACA,OAAO,KAAK,YAAY,OAAO,UAAU;CAC3C;CAEA,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,GAAG,EACtD,CAAC,CACH,CACF;EAGA,OAAO,MADiB,KAAK,wBAAwB,aAAa;CAEpE;CAEA,MAAM,wBAAwB,SAAgC;EAC5D,IAAI,QAAQ,WAAW,KAAK,QAAQ,QAClC,MAAM,IAAI,MACR,4EACF;EAGF,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;GAC5B,OAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;IAC5C,IAAI,CAAC,SAAS,cACZ,SAAS,eAAe;IAE1B,SAAS,gBAAgB,UAAU,OAAO,KAAK;IAC/C,QAAQ;GACV;GAEA,OAAO;EACT,GACA,CAAC,CACH;EAEA,MAAM,aAAa,KAAK,aAAa,QAAQ,KAAK,CAAC;EAKnD,OAJmB,MAAM,KAAK,UAAU,CAAC,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,YAGzC;CAClB;CAEA,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,IAAI;EAC5B,MAAM,SAAS,CAAC;EAEhB,KAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;GAChB,IAAI,CAAC,YAAY,IAAI,GAAG,GAAG;IACzB,YAAY,IAAI,GAAG;IACnB,OAAO,KAAK,GAAG;GACjB;EACF;EAEA,OAAO;CACT;AACF"}

package/dist/retrievers/ensemble.d.cts

@@ -1,7 +1,6 @@
 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. */

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

@@ -1 +1 @@
-{"version":3,"file":"ensemble.d.cts","names":[],"sources":["../../src/retrievers/ensemble.ts"],"mappings":";;;;;UAIiB,sBAAA,SAA+B,kBAAA;;EAE9C,UAAA,EAAY,aAAA;EAF0B;;;;EAOtC,OAAA;EALY;;;;;EAWZ,CAAA;AAAA;;;;;cAOW,iBAAA,SAA0B,aAAA;EAAA,OAC9B,OAAA,CAAA;EAIP,YAAA;EAEA,UAAA,EAAY,aAAA;EAEZ,OAAA;EAEA,CAAA;EAEA,WAAA,CAAY,IAAA,EAAM,sBAAA;EASZ,qBAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GAA8B,OAAA,CAAA,QAAA,CAAA,MAAA;EAKvC,WAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GAA8B,OAAA,CAAA,QAAA,CAAA,MAAA;EAcvC,uBAAA,CAAwB,OAAA,EAAS,iBAAA,OAAqB,OAAA,CAAA,QAAA,CAAA,MAAA;EAAA,QAiCpD,YAAA;AAAA"}
+{"version":3,"file":"ensemble.d.cts","names":[],"sources":["../../src/retrievers/ensemble.ts"],"mappings":";;;;UAIiB,+BAA+B;;EAE9C,YAAY;;;;;EAKZ;;;;;;EAMA;;;;;;cAOW,0BAA0B;SAC9B;EAIP;EAEA,YAAY;EAEZ;EAEA;EAEA,YAAY,MAAM;EASZ,sBACJ,eACA,aAAa,iCAA8B,QAAA,SAAA;EAKvC,YACJ,eACA,aAAa,iCAA8B,QAAA,SAAA;EAcvC,wBAAwB,SAAS,wBAAqB,QAAA,SAAA;UAiCpD"}

package/dist/retrievers/ensemble.d.ts

@@ -1,7 +1,6 @@
 import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
 import { Document, DocumentInterface } from "@langchain/core/documents";
 import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
-
 //#region src/retrievers/ensemble.d.ts
 interface EnsembleRetrieverInput extends BaseRetrieverInput {
   /** A list of retrievers to ensemble. */

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

@@ -1 +1 @@
-{"version":3,"file":"ensemble.d.ts","names":[],"sources":["../../src/retrievers/ensemble.ts"],"mappings":";;;;;UAIiB,sBAAA,SAA+B,kBAAA;;EAE9C,UAAA,EAAY,aAAA;EAF0B;;;;EAOtC,OAAA;EALY;;;;;EAWZ,CAAA;AAAA;;;;;cAOW,iBAAA,SAA0B,aAAA;EAAA,OAC9B,OAAA,CAAA;EAIP,YAAA;EAEA,UAAA,EAAY,aAAA;EAEZ,OAAA;EAEA,CAAA;EAEA,WAAA,CAAY,IAAA,EAAM,sBAAA;EASZ,qBAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GAA8B,OAAA,CAAA,QAAA,CAAA,MAAA;EAKvC,WAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GAA8B,OAAA,CAAA,QAAA,CAAA,MAAA;EAcvC,uBAAA,CAAwB,OAAA,EAAS,iBAAA,OAAqB,OAAA,CAAA,QAAA,CAAA,MAAA;EAAA,QAiCpD,YAAA;AAAA"}
+{"version":3,"file":"ensemble.d.ts","names":[],"sources":["../../src/retrievers/ensemble.ts"],"mappings":";;;;UAIiB,+BAA+B;;EAE9C,YAAY;;;;;EAKZ;;;;;;EAMA;;;;;;cAOW,0BAA0B;SAC9B;EAIP;EAEA,YAAY;EAEZ;EAEA;EAEA,YAAY,MAAM;EASZ,sBACJ,eACA,aAAa,iCAA8B,QAAA,SAAA;EAKvC,YACJ,eACA,aAAa,iCAA8B,QAAA,SAAA;EAcvC,wBAAwB,SAAS,wBAAqB,QAAA,SAAA;UAiCpD"}

package/dist/retrievers/ensemble.js.map

@@ -1 +1 @@
-{"version":3,"file":"ensemble.js","names":[],"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;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;AACxC,QAAM,KAAK;AACX,OAAK,aAAa,KAAK;AACvB,OAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,OAAO,CAAC,KAAK,IAAI,KAAK,WAAW,OAAO;AACpE,OAAK,IAAI,KAAK,KAAK;;CAGrB,MAAM,sBACJ,OACA,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;;CAG5C,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,IAAI,EACtD,CAAC,CACH,CACF;AAGD,SAAO,MADiB,KAAK,wBAAwB,cAAc;;CAIrE,MAAM,wBAAwB,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR,6EACD;EAGH,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,aACZ,UAAS,eAAe;AAE1B,aAAS,gBAAgB,UAAU,OAAO,KAAK;AAC/C,YAAQ;;AAGV,UAAO;KAET,EAAE,CACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;AAKpD,SAJmB,MAAM,KAAK,WAAW,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aAGxC;;CAGnB,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,KAAK;EAC7B,MAAM,SAAS,EAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;AACzB,gBAAY,IAAI,IAAI;AACpB,WAAO,KAAK,IAAI;;;AAIpB,SAAO"}
+{"version":3,"file":"ensemble.js","names":[],"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;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAoB;CAE/D;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;EACxC,MAAM,IAAI;EACV,KAAK,aAAa,KAAK;EACvB,KAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,MAAM,CAAC,CAAC,KAAK,IAAI,KAAK,WAAW,MAAM;EACnE,KAAK,IAAI,KAAK,KAAK;CACrB;CAEA,MAAM,sBACJ,OACA,YACA;EACA,OAAO,KAAK,YAAY,OAAO,UAAU;CAC3C;CAEA,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,GAAG,EACtD,CAAC,CACH,CACF;EAGA,OAAO,MADiB,KAAK,wBAAwB,aAAa;CAEpE;CAEA,MAAM,wBAAwB,SAAgC;EAC5D,IAAI,QAAQ,WAAW,KAAK,QAAQ,QAClC,MAAM,IAAI,MACR,4EACF;EAGF,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;GAC5B,OAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;IAC5C,IAAI,CAAC,SAAS,cACZ,SAAS,eAAe;IAE1B,SAAS,gBAAgB,UAAU,OAAO,KAAK;IAC/C,QAAQ;GACV;GAEA,OAAO;EACT,GACA,CAAC,CACH;EAEA,MAAM,aAAa,KAAK,aAAa,QAAQ,KAAK,CAAC;EAKnD,OAJmB,MAAM,KAAK,UAAU,CAAC,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,YAGzC;CAClB;CAEA,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,IAAI;EAC5B,MAAM,SAAS,CAAC;EAEhB,KAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;GAChB,IAAI,CAAC,YAAY,IAAI,GAAG,GAAG;IACzB,YAAY,IAAI,GAAG;IACnB,OAAO,KAAK,GAAG;GACjB;EACF;EAEA,OAAO;CACT;AACF"}

package/dist/retrievers/hyde.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"hyde.cjs","names":["VectorStoreRetriever","StringPromptValue","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,6BAAAA,qBAAwB;CAChC,OAAO,UAAU;AACf,SAAO;;CAGT,IAAI,eAAyB;AAC3B,SAAO;GAAC;GAAa;GAAc;GAAO;;CAG5C;CAEA;CAEA,YAAY,QAAiC;AAC3C,QAAM,OAAO;AACb,OAAK,MAAM,OAAO;AAClB,OAAK,iBACH,OAAO,OAAO,mBAAmB,WAC7B,yBAAyB,OAAO,eAAe,GAC/C,OAAO;AACb,MAAI,KAAK,gBAAgB;GACvB,MAAM,EAAE,mBAAmB,KAAK;AAChC,OAAI,eAAe,WAAW,KAAK,eAAe,OAAO,WACvD,OAAM,IAAI,MACR,gHAAgH,iBACjH;;;CAKP,MAAM,sBACJ,OACA,YACqB;EACrB,IAAI,QAAyB,IAAIC,8BAAAA,kBAAkB,MAAM;AAGzD,MAAI,KAAK,eACP,SAAQ,MAAM,KAAK,eAAe,kBAAkB,EAAE,UAAU,OAAO,CAAC;EAK1E,MAAM,UAAS,MADG,KAAK,IAAI,eAAe,CAAC,MAAM,CAAC,EAC/B,YAAY,GAAG,GAAG;AAUrC,SAAO,MAPe,KAAK,YAAY,iBACrC,QACA,KAAK,GACL,KAAK,QACL,YAAY,SAAS,cAAc,CACpC;;;;;;AASL,SAAgB,yBAAyB,KAAoC;CAC3E,IAAI;AAEJ,SAAQ,KAAR;EACE,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,QACE,OAAM,IAAI,MAAM,uBAAuB,MAAM;;AAGjD,QAAOC,wBAAAA,eAAe,aAAa,SAAS"}
+{"version":3,"file":"hyde.cjs","names":["VectorStoreRetriever","StringPromptValue","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,6BAAAA,qBAAwB;CAChC,OAAO,UAAU;EACf,OAAO;CACT;CAEA,IAAI,eAAyB;EAC3B,OAAO;GAAC;GAAa;GAAc;EAAM;CAC3C;CAEA;CAEA;CAEA,YAAY,QAAiC;EAC3C,MAAM,MAAM;EACZ,KAAK,MAAM,OAAO;EAClB,KAAK,iBACH,OAAO,OAAO,mBAAmB,WAC7B,yBAAyB,OAAO,cAAc,IAC9C,OAAO;EACb,IAAI,KAAK,gBAAgB;GACvB,MAAM,EAAE,mBAAmB,KAAK;GAChC,IAAI,eAAe,WAAW,KAAK,eAAe,OAAO,YACvD,MAAM,IAAI,MACR,gHAAgH,gBAClH;EAEJ;CACF;CAEA,MAAM,sBACJ,OACA,YACqB;EACrB,IAAI,QAAyB,IAAIC,8BAAAA,kBAAkB,KAAK;EAGxD,IAAI,KAAK,gBACP,QAAQ,MAAM,KAAK,eAAe,kBAAkB,EAAE,UAAU,MAAM,CAAC;EAKzE,MAAM,UAAS,MADG,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,EAAA,CAC9B,YAAY,EAAE,CAAC,EAAE,CAAC;EAUrC,OAAO,MAPe,KAAK,YAAY,iBACrC,QACA,KAAK,GACL,KAAK,QACL,YAAY,SAAS,aAAa,CACpC;CAGF;AACF;;;;AAKA,SAAgB,yBAAyB,KAAoC;CAC3E,IAAI;CAEJ,QAAQ,KAAR;EACE,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,SACE,MAAM,IAAI,MAAM,uBAAuB,KAAK;CAChD;CAEA,OAAOC,wBAAAA,eAAe,aAAa,QAAQ;AAC7C"}

package/dist/retrievers/hyde.d.cts

@@ -3,7 +3,6 @@ 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.

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

@@ -1 +1 @@
-{"version":3,"file":"hyde.d.cts","names":[],"sources":["../../src/retrievers/hyde.ts"],"mappings":";;;;;;;;;AAiBA;KAAY,SAAA;;;;AAeZ;;KAAY,oBAAA,WAA+B,WAAA,IACzC,yBAAA,CAA0B,CAAA;EACxB,GAAA,EAAK,0BAAA;EACL,cAAA,GAAiB,kBAAA,GAAqB,SAAA;AAAA;;;;;;;;;;;;;;;;;AA4B1C;;;;;;;;;cAAa,aAAA,WACD,WAAA,GAAc,WAAA,UAChB,oBAAA,CAAqB,CAAA;EAAA,OACtB,OAAA,CAAA;EAAA,IAIH,YAAA,CAAA;EAIJ,GAAA,EAAK,0BAAA;EAEL,cAAA,GAAiB,kBAAA;EAEjB,WAAA,CAAY,MAAA,EAAQ,oBAAA,CAAqB,CAAA;EAiBnC,qBAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GACZ,OAAA,CAAQ,QAAA;AAAA;;;;iBA2BG,wBAAA,CAAyB,GAAA,EAAK,SAAA,GAAY,kBAAA"}
+{"version":3,"file":"hyde.d.cts","names":[],"sources":["../../src/retrievers/hyde.ts"],"mappings":";;;;;;;;;KAiBY;;;;;;KAeA,qBAAqB,UAAU,eACzC,0BAA0B;EACxB,KAAK;EACL,iBAAiB,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;cA4B7B,cACX,UAAU,cAAc,qBAChB,qBAAqB;SACtB;MAIH;EAIJ,KAAK;EAEL,iBAAiB;EAEjB,YAAY,QAAQ,qBAAqB;EAiBnC,sBACJ,eACA,aAAa,iCACZ,QAAQ;;;;;iBA2BG,yBAAyB,KAAK,YAAY"}

package/dist/retrievers/hyde.d.ts

@@ -3,7 +3,6 @@ import { BaseLanguageModelInterface } from "@langchain/core/language_models/base
 import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
 import { Document } from "@langchain/core/documents";
 import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
-
 //#region src/retrievers/hyde.d.ts
 /**
  * A string that corresponds to a specific prompt template.

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

@@ -1 +1 @@
-{"version":3,"file":"hyde.d.ts","names":[],"sources":["../../src/retrievers/hyde.ts"],"mappings":";;;;;;;;;AAiBA;KAAY,SAAA;;;;AAeZ;;KAAY,oBAAA,WAA+B,WAAA,IACzC,yBAAA,CAA0B,CAAA;EACxB,GAAA,EAAK,0BAAA;EACL,cAAA,GAAiB,kBAAA,GAAqB,SAAA;AAAA;;;;;;;;;;;;;;;;;AA4B1C;;;;;;;;;cAAa,aAAA,WACD,WAAA,GAAc,WAAA,UAChB,oBAAA,CAAqB,CAAA;EAAA,OACtB,OAAA,CAAA;EAAA,IAIH,YAAA,CAAA;EAIJ,GAAA,EAAK,0BAAA;EAEL,cAAA,GAAiB,kBAAA;EAEjB,WAAA,CAAY,MAAA,EAAQ,oBAAA,CAAqB,CAAA;EAiBnC,qBAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GACZ,OAAA,CAAQ,QAAA;AAAA;;;;iBA2BG,wBAAA,CAAyB,GAAA,EAAK,SAAA,GAAY,kBAAA"}
+{"version":3,"file":"hyde.d.ts","names":[],"sources":["../../src/retrievers/hyde.ts"],"mappings":";;;;;;;;;KAiBY;;;;;;KAeA,qBAAqB,UAAU,eACzC,0BAA0B;EACxB,KAAK;EACL,iBAAiB,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;cA4B7B,cACX,UAAU,cAAc,qBAChB,qBAAqB;SACtB;MAIH;EAIJ,KAAK;EAEL,iBAAiB;EAEjB,YAAY,QAAQ,qBAAqB;EAiBnC,sBACJ,eACA,aAAa,iCACZ,QAAQ;;;;;iBA2BG,yBAAyB,KAAK,YAAY"}

package/dist/retrievers/hyde.js.map

@@ -1 +1 @@
-{"version":3,"file":"hyde.js","names":[],"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,cAEU,qBAAwB;CAChC,OAAO,UAAU;AACf,SAAO;;CAGT,IAAI,eAAyB;AAC3B,SAAO;GAAC;GAAa;GAAc;GAAO;;CAG5C;CAEA;CAEA,YAAY,QAAiC;AAC3C,QAAM,OAAO;AACb,OAAK,MAAM,OAAO;AAClB,OAAK,iBACH,OAAO,OAAO,mBAAmB,WAC7B,yBAAyB,OAAO,eAAe,GAC/C,OAAO;AACb,MAAI,KAAK,gBAAgB;GACvB,MAAM,EAAE,mBAAmB,KAAK;AAChC,OAAI,eAAe,WAAW,KAAK,eAAe,OAAO,WACvD,OAAM,IAAI,MACR,gHAAgH,iBACjH;;;CAKP,MAAM,sBACJ,OACA,YACqB;EACrB,IAAI,QAAyB,IAAI,kBAAkB,MAAM;AAGzD,MAAI,KAAK,eACP,SAAQ,MAAM,KAAK,eAAe,kBAAkB,EAAE,UAAU,OAAO,CAAC;EAK1E,MAAM,UAAS,MADG,KAAK,IAAI,eAAe,CAAC,MAAM,CAAC,EAC/B,YAAY,GAAG,GAAG;AAUrC,SAAO,MAPe,KAAK,YAAY,iBACrC,QACA,KAAK,GACL,KAAK,QACL,YAAY,SAAS,cAAc,CACpC;;;;;;AASL,SAAgB,yBAAyB,KAAoC;CAC3E,IAAI;AAEJ,SAAQ,KAAR;EACE,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,KAAK;AACH,cAAW;;;AAGX;EACF,QACE,OAAM,IAAI,MAAM,uBAAuB,MAAM;;AAGjD,QAAO,eAAe,aAAa,SAAS"}
+{"version":3,"file":"hyde.js","names":[],"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,cAEU,qBAAwB;CAChC,OAAO,UAAU;EACf,OAAO;CACT;CAEA,IAAI,eAAyB;EAC3B,OAAO;GAAC;GAAa;GAAc;EAAM;CAC3C;CAEA;CAEA;CAEA,YAAY,QAAiC;EAC3C,MAAM,MAAM;EACZ,KAAK,MAAM,OAAO;EAClB,KAAK,iBACH,OAAO,OAAO,mBAAmB,WAC7B,yBAAyB,OAAO,cAAc,IAC9C,OAAO;EACb,IAAI,KAAK,gBAAgB;GACvB,MAAM,EAAE,mBAAmB,KAAK;GAChC,IAAI,eAAe,WAAW,KAAK,eAAe,OAAO,YACvD,MAAM,IAAI,MACR,gHAAgH,gBAClH;EAEJ;CACF;CAEA,MAAM,sBACJ,OACA,YACqB;EACrB,IAAI,QAAyB,IAAI,kBAAkB,KAAK;EAGxD,IAAI,KAAK,gBACP,QAAQ,MAAM,KAAK,eAAe,kBAAkB,EAAE,UAAU,MAAM,CAAC;EAKzE,MAAM,UAAS,MADG,KAAK,IAAI,eAAe,CAAC,KAAK,CAAC,EAAA,CAC9B,YAAY,EAAE,CAAC,EAAE,CAAC;EAUrC,OAAO,MAPe,KAAK,YAAY,iBACrC,QACA,KAAK,GACL,KAAK,QACL,YAAY,SAAS,aAAa,CACpC;CAGF;AACF;;;;AAKA,SAAgB,yBAAyB,KAAoC;CAC3E,IAAI;CAEJ,QAAQ,KAAR;EACE,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,KAAK;GACH,WAAW;;;GAGX;EACF,SACE,MAAM,IAAI,MAAM,uBAAuB,KAAK;CAChD;CAEA,OAAO,eAAe,aAAa,QAAQ;AAC7C"}

package/dist/retrievers/matryoshka_retriever.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"matryoshka_retriever.cjs","names":["VectorStoreRetriever"],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"sourcesContent":["import { DocumentInterface } from \"@langchain/core/documents\";\nimport { Embeddings } from \"@langchain/core/embeddings\";\nimport {\n  cosineSimilarity,\n  euclideanDistance,\n  innerProduct,\n} from \"@langchain/core/utils/math\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\n/**\n * Type for options when adding a document to the VectorStore.\n */\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\ntype AddDocumentOptions = Record<string, any>;\n\nexport interface MatryoshkaRetrieverFields {\n  /**\n   * The number of documents to retrieve from the small store.\n   * @default 50\n   */\n  smallK?: number;\n  /**\n   * The number of documents to retrieve from the large store.\n   * @default 8\n   */\n  largeK?: number;\n  /**\n   * The metadata key to store the larger embeddings.\n   * @default \"lc_large_embedding\"\n   */\n  largeEmbeddingKey?: string;\n  /**\n   * The embedding model to use when generating the large\n   * embeddings.\n   */\n  largeEmbeddingModel: Embeddings;\n  /**\n   * The type of search to perform using the large embeddings.\n   * @default \"cosine\"\n   */\n  searchType?: \"cosine\" | \"innerProduct\" | \"euclidean\";\n}\n\n/**\n * A retriever that uses two sets of embeddings to perform adaptive retrieval. Based\n * off of the \"Matryoshka embeddings: faster OpenAI vector search using Adaptive Retrieval\"\n * blog post {@link https://supabase.com/blog/matryoshka-embeddings}.\n *\n *\n * This class performs \"Adaptive Retrieval\" for searching text embeddings efficiently using the\n * Matryoshka Representation Learning (MRL) technique. It retrieves documents similar to a query\n * embedding in two steps:\n *\n * First-pass: Uses a lower dimensional sub-vector from the MRL embedding for an initial, fast,\n * but less accurate search.\n *\n * Second-pass: Re-ranks the top results from the first pass using the full, high-dimensional\n * embedding for higher accuracy.\n *\n *\n * This code implements MRL embeddings for efficient vector search by combining faster,\n * lower-dimensional initial search with accurate, high-dimensional re-ranking.\n */\nexport class MatryoshkaRetriever<\n  Store extends VectorStore = VectorStore,\n> extends VectorStoreRetriever<Store> {\n  smallK = 50;\n\n  largeK = 8;\n\n  largeEmbeddingKey = \"lc_large_embedding\";\n\n  largeEmbeddingModel: Embeddings;\n\n  searchType: \"cosine\" | \"innerProduct\" | \"euclidean\" = \"cosine\";\n\n  constructor(\n    fields: MatryoshkaRetrieverFields & VectorStoreRetrieverInput<Store>\n  ) {\n    super(fields);\n    this.smallK = fields.smallK ?? this.smallK;\n    this.largeK = fields.largeK ?? this.largeK;\n    this.largeEmbeddingKey = fields.largeEmbeddingKey ?? this.largeEmbeddingKey;\n    this.largeEmbeddingModel = fields.largeEmbeddingModel;\n    this.searchType = fields.searchType ?? this.searchType;\n  }\n\n  /**\n   * Ranks documents based on their similarity to a query embedding using larger embeddings.\n   *\n   * This method takes a query embedding and a list of documents (smallResults) as input. Each document\n   * in the smallResults array has previously been associated with a large embedding stored in its metadata.\n   * Depending on the `searchType` (cosine, innerProduct, or euclidean), it calculates the similarity scores\n   * between the query embedding and each document's large embedding. It then ranks the documents based on\n   * these similarity scores, from the most similar to the least similar.\n   *\n   * The method returns a promise that resolves to an array of the top `largeK` documents, where `largeK`\n   * is a class property defining the number of documents to return. This subset of documents is determined\n   * by sorting the entire list of documents based on their similarity scores and then selecting the top\n   * `largeK` documents.\n   *\n   * @param {number[]} embeddedQuery The embedding of the query, represented as an array of numbers.\n   * @param {DocumentInterface[]} smallResults An array of documents, each with metadata that includes a large embedding for similarity comparison.\n   * @returns {Promise<DocumentInterface[]>} A promise that resolves to an array of the top `largeK` ranked documents based on their similarity to the query embedding.\n   */\n  private _rankByLargeEmbeddings(\n    embeddedQuery: number[],\n    smallResults: DocumentInterface[]\n  ): DocumentInterface[] {\n    const largeEmbeddings: Array<number[]> = smallResults.map((doc) =>\n      JSON.parse(doc.metadata[this.largeEmbeddingKey])\n    );\n    let func: () => Array<number[]>;\n\n    switch (this.searchType) {\n      case \"cosine\":\n        func = () => cosineSimilarity([embeddedQuery], largeEmbeddings);\n        break;\n      case \"innerProduct\":\n        func = () => innerProduct([embeddedQuery], largeEmbeddings);\n        break;\n      case \"euclidean\":\n        func = () => euclideanDistance([embeddedQuery], largeEmbeddings);\n        break;\n      default:\n        throw new Error(`Unknown search type: ${this.searchType}`);\n    }\n\n    // Calculate the similarity scores between the query embedding and the large embeddings\n    const [similarityScores] = func();\n\n    // Create an array of indices from 0 to N-1, where N is the number of documents\n    let indices = Array.from(\n      { length: smallResults.length },\n      (_, index) => index\n    );\n\n    indices = indices\n      .map((v, i) => [similarityScores[i], v])\n      .sort(([a], [b]) => b - a)\n      .slice(0, this.largeK)\n      .map(([, i]) => i);\n\n    return indices.map((i) => smallResults[i]);\n  }\n\n  async _getRelevantDocuments(query: string): Promise<DocumentInterface[]> {\n    const [embeddedQuery, smallResults] = await Promise.all([\n      this.largeEmbeddingModel.embedQuery(query),\n      this.vectorStore.similaritySearch(query, this.smallK, this.filter),\n    ]);\n\n    return this._rankByLargeEmbeddings(embeddedQuery, smallResults);\n  }\n\n  /**\n   * Override the default `addDocuments` method to embed the documents twice,\n   * once using the larger embeddings model, and then again using the default\n   * embedding model linked to the vector store.\n   *\n   * @param {DocumentInterface[]} documents - An array of documents to add to the vector store.\n   * @param {AddDocumentOptions} options - An optional object containing additional options for adding documents.\n   * @returns {Promise<string[] | void>} A promise that resolves to an array of the document IDs that were added to the vector store.\n   */\n  override addDocuments = async (\n    documents: DocumentInterface[],\n    options?: AddDocumentOptions\n  ): Promise<string[] | void> => {\n    // Insure documents metadata does not contain the large embedding key\n    if (documents.some((doc) => this.largeEmbeddingKey in doc.metadata)) {\n      throw new Error(\n        `All documents must not contain the large embedding key: ${this.largeEmbeddingKey} in their metadata.`\n      );\n    }\n\n    const allDocPageContent = documents.map((doc) => doc.pageContent);\n    const allDocLargeEmbeddings =\n      await this.largeEmbeddingModel.embedDocuments(allDocPageContent);\n\n    const newDocuments: Array<DocumentInterface> = documents.map(\n      (doc, idx) => ({\n        ...doc,\n        metadata: {\n          ...doc.metadata,\n          [this.largeEmbeddingKey]: JSON.stringify(allDocLargeEmbeddings[idx]),\n        },\n      })\n    );\n\n    return this.vectorStore.addDocuments(newDocuments, options);\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,sBAAb,cAEUA,6BAAAA,qBAA4B;CACpC,SAAS;CAET,SAAS;CAET,oBAAoB;CAEpB;CAEA,aAAsD;CAEtD,YACE,QACA;AACA,QAAM,OAAO;AACb,OAAK,SAAS,OAAO,UAAU,KAAK;AACpC,OAAK,SAAS,OAAO,UAAU,KAAK;AACpC,OAAK,oBAAoB,OAAO,qBAAqB,KAAK;AAC1D,OAAK,sBAAsB,OAAO;AAClC,OAAK,aAAa,OAAO,cAAc,KAAK;;;;;;;;;;;;;;;;;;;;CAqB9C,uBACE,eACA,cACqB;EACrB,MAAM,kBAAmC,aAAa,KAAK,QACzD,KAAK,MAAM,IAAI,SAAS,KAAK,mBAAmB,CACjD;EACD,IAAI;AAEJ,UAAQ,KAAK,YAAb;GACE,KAAK;AACH,kBAAA,GAAA,2BAAA,kBAA8B,CAAC,cAAc,EAAE,gBAAgB;AAC/D;GACF,KAAK;AACH,kBAAA,GAAA,2BAAA,cAA0B,CAAC,cAAc,EAAE,gBAAgB;AAC3D;GACF,KAAK;AACH,kBAAA,GAAA,2BAAA,mBAA+B,CAAC,cAAc,EAAE,gBAAgB;AAChE;GACF,QACE,OAAM,IAAI,MAAM,wBAAwB,KAAK,aAAa;;EAI9D,MAAM,CAAC,oBAAoB,MAAM;EAGjC,IAAI,UAAU,MAAM,KAClB,EAAE,QAAQ,aAAa,QAAQ,GAC9B,GAAG,UAAU,MACf;AAED,YAAU,QACP,KAAK,GAAG,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC,CACvC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CACzB,MAAM,GAAG,KAAK,OAAO,CACrB,KAAK,GAAG,OAAO,EAAE;AAEpB,SAAO,QAAQ,KAAK,MAAM,aAAa,GAAG;;CAG5C,MAAM,sBAAsB,OAA6C;EACvE,MAAM,CAAC,eAAe,gBAAgB,MAAM,QAAQ,IAAI,CACtD,KAAK,oBAAoB,WAAW,MAAM,EAC1C,KAAK,YAAY,iBAAiB,OAAO,KAAK,QAAQ,KAAK,OAAO,CACnE,CAAC;AAEF,SAAO,KAAK,uBAAuB,eAAe,aAAa;;;;;;;;;;;CAYjE,eAAwB,OACtB,WACA,YAC6B;AAE7B,MAAI,UAAU,MAAM,QAAQ,KAAK,qBAAqB,IAAI,SAAS,CACjE,OAAM,IAAI,MACR,2DAA2D,KAAK,kBAAkB,qBACnF;EAGH,MAAM,oBAAoB,UAAU,KAAK,QAAQ,IAAI,YAAY;EACjE,MAAM,wBACJ,MAAM,KAAK,oBAAoB,eAAe,kBAAkB;EAElE,MAAM,eAAyC,UAAU,KACtD,KAAK,SAAS;GACb,GAAG;GACH,UAAU;IACR,GAAG,IAAI;KACN,KAAK,oBAAoB,KAAK,UAAU,sBAAsB,KAAK;IACrE;GACF,EACF;AAED,SAAO,KAAK,YAAY,aAAa,cAAc,QAAQ"}
+{"version":3,"file":"matryoshka_retriever.cjs","names":["VectorStoreRetriever"],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"sourcesContent":["import { DocumentInterface } from \"@langchain/core/documents\";\nimport { Embeddings } from \"@langchain/core/embeddings\";\nimport {\n  cosineSimilarity,\n  euclideanDistance,\n  innerProduct,\n} from \"@langchain/core/utils/math\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\n/**\n * Type for options when adding a document to the VectorStore.\n */\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\ntype AddDocumentOptions = Record<string, any>;\n\nexport interface MatryoshkaRetrieverFields {\n  /**\n   * The number of documents to retrieve from the small store.\n   * @default 50\n   */\n  smallK?: number;\n  /**\n   * The number of documents to retrieve from the large store.\n   * @default 8\n   */\n  largeK?: number;\n  /**\n   * The metadata key to store the larger embeddings.\n   * @default \"lc_large_embedding\"\n   */\n  largeEmbeddingKey?: string;\n  /**\n   * The embedding model to use when generating the large\n   * embeddings.\n   */\n  largeEmbeddingModel: Embeddings;\n  /**\n   * The type of search to perform using the large embeddings.\n   * @default \"cosine\"\n   */\n  searchType?: \"cosine\" | \"innerProduct\" | \"euclidean\";\n}\n\n/**\n * A retriever that uses two sets of embeddings to perform adaptive retrieval. Based\n * off of the \"Matryoshka embeddings: faster OpenAI vector search using Adaptive Retrieval\"\n * blog post {@link https://supabase.com/blog/matryoshka-embeddings}.\n *\n *\n * This class performs \"Adaptive Retrieval\" for searching text embeddings efficiently using the\n * Matryoshka Representation Learning (MRL) technique. It retrieves documents similar to a query\n * embedding in two steps:\n *\n * First-pass: Uses a lower dimensional sub-vector from the MRL embedding for an initial, fast,\n * but less accurate search.\n *\n * Second-pass: Re-ranks the top results from the first pass using the full, high-dimensional\n * embedding for higher accuracy.\n *\n *\n * This code implements MRL embeddings for efficient vector search by combining faster,\n * lower-dimensional initial search with accurate, high-dimensional re-ranking.\n */\nexport class MatryoshkaRetriever<\n  Store extends VectorStore = VectorStore,\n> extends VectorStoreRetriever<Store> {\n  smallK = 50;\n\n  largeK = 8;\n\n  largeEmbeddingKey = \"lc_large_embedding\";\n\n  largeEmbeddingModel: Embeddings;\n\n  searchType: \"cosine\" | \"innerProduct\" | \"euclidean\" = \"cosine\";\n\n  constructor(\n    fields: MatryoshkaRetrieverFields & VectorStoreRetrieverInput<Store>\n  ) {\n    super(fields);\n    this.smallK = fields.smallK ?? this.smallK;\n    this.largeK = fields.largeK ?? this.largeK;\n    this.largeEmbeddingKey = fields.largeEmbeddingKey ?? this.largeEmbeddingKey;\n    this.largeEmbeddingModel = fields.largeEmbeddingModel;\n    this.searchType = fields.searchType ?? this.searchType;\n  }\n\n  /**\n   * Ranks documents based on their similarity to a query embedding using larger embeddings.\n   *\n   * This method takes a query embedding and a list of documents (smallResults) as input. Each document\n   * in the smallResults array has previously been associated with a large embedding stored in its metadata.\n   * Depending on the `searchType` (cosine, innerProduct, or euclidean), it calculates the similarity scores\n   * between the query embedding and each document's large embedding. It then ranks the documents based on\n   * these similarity scores, from the most similar to the least similar.\n   *\n   * The method returns a promise that resolves to an array of the top `largeK` documents, where `largeK`\n   * is a class property defining the number of documents to return. This subset of documents is determined\n   * by sorting the entire list of documents based on their similarity scores and then selecting the top\n   * `largeK` documents.\n   *\n   * @param {number[]} embeddedQuery The embedding of the query, represented as an array of numbers.\n   * @param {DocumentInterface[]} smallResults An array of documents, each with metadata that includes a large embedding for similarity comparison.\n   * @returns {Promise<DocumentInterface[]>} A promise that resolves to an array of the top `largeK` ranked documents based on their similarity to the query embedding.\n   */\n  private _rankByLargeEmbeddings(\n    embeddedQuery: number[],\n    smallResults: DocumentInterface[]\n  ): DocumentInterface[] {\n    const largeEmbeddings: Array<number[]> = smallResults.map((doc) =>\n      JSON.parse(doc.metadata[this.largeEmbeddingKey])\n    );\n    let func: () => Array<number[]>;\n\n    switch (this.searchType) {\n      case \"cosine\":\n        func = () => cosineSimilarity([embeddedQuery], largeEmbeddings);\n        break;\n      case \"innerProduct\":\n        func = () => innerProduct([embeddedQuery], largeEmbeddings);\n        break;\n      case \"euclidean\":\n        func = () => euclideanDistance([embeddedQuery], largeEmbeddings);\n        break;\n      default:\n        throw new Error(`Unknown search type: ${this.searchType}`);\n    }\n\n    // Calculate the similarity scores between the query embedding and the large embeddings\n    const [similarityScores] = func();\n\n    // Create an array of indices from 0 to N-1, where N is the number of documents\n    let indices = Array.from(\n      { length: smallResults.length },\n      (_, index) => index\n    );\n\n    indices = indices\n      .map((v, i) => [similarityScores[i], v])\n      .sort(([a], [b]) => b - a)\n      .slice(0, this.largeK)\n      .map(([, i]) => i);\n\n    return indices.map((i) => smallResults[i]);\n  }\n\n  async _getRelevantDocuments(query: string): Promise<DocumentInterface[]> {\n    const [embeddedQuery, smallResults] = await Promise.all([\n      this.largeEmbeddingModel.embedQuery(query),\n      this.vectorStore.similaritySearch(query, this.smallK, this.filter),\n    ]);\n\n    return this._rankByLargeEmbeddings(embeddedQuery, smallResults);\n  }\n\n  /**\n   * Override the default `addDocuments` method to embed the documents twice,\n   * once using the larger embeddings model, and then again using the default\n   * embedding model linked to the vector store.\n   *\n   * @param {DocumentInterface[]} documents - An array of documents to add to the vector store.\n   * @param {AddDocumentOptions} options - An optional object containing additional options for adding documents.\n   * @returns {Promise<string[] | void>} A promise that resolves to an array of the document IDs that were added to the vector store.\n   */\n  override addDocuments = async (\n    documents: DocumentInterface[],\n    options?: AddDocumentOptions\n  ): Promise<string[] | void> => {\n    // Insure documents metadata does not contain the large embedding key\n    if (documents.some((doc) => this.largeEmbeddingKey in doc.metadata)) {\n      throw new Error(\n        `All documents must not contain the large embedding key: ${this.largeEmbeddingKey} in their metadata.`\n      );\n    }\n\n    const allDocPageContent = documents.map((doc) => doc.pageContent);\n    const allDocLargeEmbeddings =\n      await this.largeEmbeddingModel.embedDocuments(allDocPageContent);\n\n    const newDocuments: Array<DocumentInterface> = documents.map(\n      (doc, idx) => ({\n        ...doc,\n        metadata: {\n          ...doc.metadata,\n          [this.largeEmbeddingKey]: JSON.stringify(allDocLargeEmbeddings[idx]),\n        },\n      })\n    );\n\n    return this.vectorStore.addDocuments(newDocuments, options);\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,sBAAb,cAEUA,6BAAAA,qBAA4B;CACpC,SAAS;CAET,SAAS;CAET,oBAAoB;CAEpB;CAEA,aAAsD;CAEtD,YACE,QACA;EACA,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO,UAAU,KAAK;EACpC,KAAK,SAAS,OAAO,UAAU,KAAK;EACpC,KAAK,oBAAoB,OAAO,qBAAqB,KAAK;EAC1D,KAAK,sBAAsB,OAAO;EAClC,KAAK,aAAa,OAAO,cAAc,KAAK;CAC9C;;;;;;;;;;;;;;;;;;;CAoBA,uBACE,eACA,cACqB;EACrB,MAAM,kBAAmC,aAAa,KAAK,QACzD,KAAK,MAAM,IAAI,SAAS,KAAK,kBAAkB,CACjD;EACA,IAAI;EAEJ,QAAQ,KAAK,YAAb;GACE,KAAK;IACH,cAAA,GAAA,2BAAA,iBAAA,CAA8B,CAAC,aAAa,GAAG,eAAe;IAC9D;GACF,KAAK;IACH,cAAA,GAAA,2BAAA,aAAA,CAA0B,CAAC,aAAa,GAAG,eAAe;IAC1D;GACF,KAAK;IACH,cAAA,GAAA,2BAAA,kBAAA,CAA+B,CAAC,aAAa,GAAG,eAAe;IAC/D;GACF,SACE,MAAM,IAAI,MAAM,wBAAwB,KAAK,YAAY;EAC7D;EAGA,MAAM,CAAC,oBAAoB,KAAK;EAGhC,IAAI,UAAU,MAAM,KAClB,EAAE,QAAQ,aAAa,OAAO,IAC7B,GAAG,UAAU,KAChB;EAEA,UAAU,QACP,KAAK,GAAG,MAAM,CAAC,iBAAiB,IAAI,CAAC,CAAC,CAAC,CACvC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,CACzB,MAAM,GAAG,KAAK,MAAM,CAAC,CACrB,KAAK,GAAG,OAAO,CAAC;EAEnB,OAAO,QAAQ,KAAK,MAAM,aAAa,EAAE;CAC3C;CAEA,MAAM,sBAAsB,OAA6C;EACvE,MAAM,CAAC,eAAe,gBAAgB,MAAM,QAAQ,IAAI,CACtD,KAAK,oBAAoB,WAAW,KAAK,GACzC,KAAK,YAAY,iBAAiB,OAAO,KAAK,QAAQ,KAAK,MAAM,CACnE,CAAC;EAED,OAAO,KAAK,uBAAuB,eAAe,YAAY;CAChE;;;;;;;;;;CAWA,eAAwB,OACtB,WACA,YAC6B;EAE7B,IAAI,UAAU,MAAM,QAAQ,KAAK,qBAAqB,IAAI,QAAQ,GAChE,MAAM,IAAI,MACR,2DAA2D,KAAK,kBAAkB,oBACpF;EAGF,MAAM,oBAAoB,UAAU,KAAK,QAAQ,IAAI,WAAW;EAChE,MAAM,wBACJ,MAAM,KAAK,oBAAoB,eAAe,iBAAiB;EAEjE,MAAM,eAAyC,UAAU,KACtD,KAAK,SAAS;GACb,GAAG;GACH,UAAU;IACR,GAAG,IAAI;KACN,KAAK,oBAAoB,KAAK,UAAU,sBAAsB,IAAI;GACrE;EACF,EACF;EAEA,OAAO,KAAK,YAAY,aAAa,cAAc,OAAO;CAC5D;AACF"}

package/dist/retrievers/matryoshka_retriever.d.cts

@@ -1,7 +1,6 @@
 import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
 import { DocumentInterface } from "@langchain/core/documents";
 import { Embeddings } from "@langchain/core/embeddings";
-
 //#region src/retrievers/matryoshka_retriever.d.ts
 /**
  * Type for options when adding a document to the VectorStore.

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

@@ -1 +1 @@
-{"version":3,"file":"matryoshka_retriever.d.cts","names":[],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"mappings":";;;;;;;AAWsC;KAMjC,kBAAA,GAAqB,MAAA;AAAA,UAET,yBAAA;EAFS;;AAE1B;;EAKE,MAAA;EAe+B;;;;EAV/B,MAAA;EAUqB;;;;EALrB,iBAAA;EAiC8B;;;;EA5B9B,mBAAA,EAAqB,UAAA;EAqCA;;;;EAhCrB,UAAA;AAAA;;;;;;;;;;;;;;;;;;;;;cAuBW,mBAAA,eACG,WAAA,GAAc,WAAA,UACpB,oBAAA,CAAqB,KAAA;EAC7B,MAAA;EAEA,MAAA;EAEA,iBAAA;EAEA,mBAAA,EAAqB,UAAA;EAErB,UAAA;EAEA,WAAA,CACE,MAAA,EAAQ,yBAAA,GAA4B,yBAAA,CAA0B,KAAA;EAuFvD;;;;;;;;;;;;;;;;;;EAAA,QA3DD,sBAAA;EAyCF,qBAAA,CAAsB,KAAA,WAAgB,OAAA,CAAQ,iBAAA;;;;;;;;;;EAkB3C,YAAA,GAAY,SAAA,EACR,iBAAA,IAAmB,OAAA,GACpB,kBAAA,KACT,OAAA;AAAA"}
+{"version":3,"file":"matryoshka_retriever.d.cts","names":[],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"mappings":";;;;;;;KAiBK,qBAAqB;UAET;;;;;EAKf;;;;;EAKA;;;;;EAKA;;;;;EAKA,qBAAqB;;;;;EAKrB;;;;;;;;;;;;;;;;;;;;;;cAuBW,oBACX,cAAc,cAAc,qBACpB,qBAAqB;EAC7B;EAEA;EAEA;EAEA,qBAAqB;EAErB;EAEA,YACE,QAAQ,4BAA4B,0BAA0B;;;;;;;;;;;;;;;;;;;UA4BxD;EAyCF,sBAAsB,gBAAgB,QAAQ;;;;;;;;;;EAkB3C,eAAY,WACR,qBAAmB,UACpB,uBACT"}

package/dist/retrievers/matryoshka_retriever.d.ts

@@ -1,7 +1,6 @@
 import { DocumentInterface } from "@langchain/core/documents";
 import { Embeddings } from "@langchain/core/embeddings";
 import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
-
 //#region src/retrievers/matryoshka_retriever.d.ts
 /**
  * Type for options when adding a document to the VectorStore.

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

@@ -1 +1 @@
-{"version":3,"file":"matryoshka_retriever.d.ts","names":[],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"mappings":";;;;;;;AAWsC;KAMjC,kBAAA,GAAqB,MAAA;AAAA,UAET,yBAAA;EAFS;;AAE1B;;EAKE,MAAA;EAe+B;;;;EAV/B,MAAA;EAUqB;;;;EALrB,iBAAA;EAiC8B;;;;EA5B9B,mBAAA,EAAqB,UAAA;EAqCA;;;;EAhCrB,UAAA;AAAA;;;;;;;;;;;;;;;;;;;;;cAuBW,mBAAA,eACG,WAAA,GAAc,WAAA,UACpB,oBAAA,CAAqB,KAAA;EAC7B,MAAA;EAEA,MAAA;EAEA,iBAAA;EAEA,mBAAA,EAAqB,UAAA;EAErB,UAAA;EAEA,WAAA,CACE,MAAA,EAAQ,yBAAA,GAA4B,yBAAA,CAA0B,KAAA;EAuFvD;;;;;;;;;;;;;;;;;;EAAA,QA3DD,sBAAA;EAyCF,qBAAA,CAAsB,KAAA,WAAgB,OAAA,CAAQ,iBAAA;;;;;;;;;;EAkB3C,YAAA,GAAY,SAAA,EACR,iBAAA,IAAmB,OAAA,GACpB,kBAAA,KACT,OAAA;AAAA"}
+{"version":3,"file":"matryoshka_retriever.d.ts","names":[],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"mappings":";;;;;;;KAiBK,qBAAqB;UAET;;;;;EAKf;;;;;EAKA;;;;;EAKA;;;;;EAKA,qBAAqB;;;;;EAKrB;;;;;;;;;;;;;;;;;;;;;;cAuBW,oBACX,cAAc,cAAc,qBACpB,qBAAqB;EAC7B;EAEA;EAEA;EAEA,qBAAqB;EAErB;EAEA,YACE,QAAQ,4BAA4B,0BAA0B;;;;;;;;;;;;;;;;;;;UA4BxD;EAyCF,sBAAsB,gBAAgB,QAAQ;;;;;;;;;;EAkB3C,eAAY,WACR,qBAAmB,UACpB,uBACT"}

package/dist/retrievers/matryoshka_retriever.js.map

@@ -1 +1 @@
-{"version":3,"file":"matryoshka_retriever.js","names":[],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"sourcesContent":["import { DocumentInterface } from \"@langchain/core/documents\";\nimport { Embeddings } from \"@langchain/core/embeddings\";\nimport {\n  cosineSimilarity,\n  euclideanDistance,\n  innerProduct,\n} from \"@langchain/core/utils/math\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\n/**\n * Type for options when adding a document to the VectorStore.\n */\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\ntype AddDocumentOptions = Record<string, any>;\n\nexport interface MatryoshkaRetrieverFields {\n  /**\n   * The number of documents to retrieve from the small store.\n   * @default 50\n   */\n  smallK?: number;\n  /**\n   * The number of documents to retrieve from the large store.\n   * @default 8\n   */\n  largeK?: number;\n  /**\n   * The metadata key to store the larger embeddings.\n   * @default \"lc_large_embedding\"\n   */\n  largeEmbeddingKey?: string;\n  /**\n   * The embedding model to use when generating the large\n   * embeddings.\n   */\n  largeEmbeddingModel: Embeddings;\n  /**\n   * The type of search to perform using the large embeddings.\n   * @default \"cosine\"\n   */\n  searchType?: \"cosine\" | \"innerProduct\" | \"euclidean\";\n}\n\n/**\n * A retriever that uses two sets of embeddings to perform adaptive retrieval. Based\n * off of the \"Matryoshka embeddings: faster OpenAI vector search using Adaptive Retrieval\"\n * blog post {@link https://supabase.com/blog/matryoshka-embeddings}.\n *\n *\n * This class performs \"Adaptive Retrieval\" for searching text embeddings efficiently using the\n * Matryoshka Representation Learning (MRL) technique. It retrieves documents similar to a query\n * embedding in two steps:\n *\n * First-pass: Uses a lower dimensional sub-vector from the MRL embedding for an initial, fast,\n * but less accurate search.\n *\n * Second-pass: Re-ranks the top results from the first pass using the full, high-dimensional\n * embedding for higher accuracy.\n *\n *\n * This code implements MRL embeddings for efficient vector search by combining faster,\n * lower-dimensional initial search with accurate, high-dimensional re-ranking.\n */\nexport class MatryoshkaRetriever<\n  Store extends VectorStore = VectorStore,\n> extends VectorStoreRetriever<Store> {\n  smallK = 50;\n\n  largeK = 8;\n\n  largeEmbeddingKey = \"lc_large_embedding\";\n\n  largeEmbeddingModel: Embeddings;\n\n  searchType: \"cosine\" | \"innerProduct\" | \"euclidean\" = \"cosine\";\n\n  constructor(\n    fields: MatryoshkaRetrieverFields & VectorStoreRetrieverInput<Store>\n  ) {\n    super(fields);\n    this.smallK = fields.smallK ?? this.smallK;\n    this.largeK = fields.largeK ?? this.largeK;\n    this.largeEmbeddingKey = fields.largeEmbeddingKey ?? this.largeEmbeddingKey;\n    this.largeEmbeddingModel = fields.largeEmbeddingModel;\n    this.searchType = fields.searchType ?? this.searchType;\n  }\n\n  /**\n   * Ranks documents based on their similarity to a query embedding using larger embeddings.\n   *\n   * This method takes a query embedding and a list of documents (smallResults) as input. Each document\n   * in the smallResults array has previously been associated with a large embedding stored in its metadata.\n   * Depending on the `searchType` (cosine, innerProduct, or euclidean), it calculates the similarity scores\n   * between the query embedding and each document's large embedding. It then ranks the documents based on\n   * these similarity scores, from the most similar to the least similar.\n   *\n   * The method returns a promise that resolves to an array of the top `largeK` documents, where `largeK`\n   * is a class property defining the number of documents to return. This subset of documents is determined\n   * by sorting the entire list of documents based on their similarity scores and then selecting the top\n   * `largeK` documents.\n   *\n   * @param {number[]} embeddedQuery The embedding of the query, represented as an array of numbers.\n   * @param {DocumentInterface[]} smallResults An array of documents, each with metadata that includes a large embedding for similarity comparison.\n   * @returns {Promise<DocumentInterface[]>} A promise that resolves to an array of the top `largeK` ranked documents based on their similarity to the query embedding.\n   */\n  private _rankByLargeEmbeddings(\n    embeddedQuery: number[],\n    smallResults: DocumentInterface[]\n  ): DocumentInterface[] {\n    const largeEmbeddings: Array<number[]> = smallResults.map((doc) =>\n      JSON.parse(doc.metadata[this.largeEmbeddingKey])\n    );\n    let func: () => Array<number[]>;\n\n    switch (this.searchType) {\n      case \"cosine\":\n        func = () => cosineSimilarity([embeddedQuery], largeEmbeddings);\n        break;\n      case \"innerProduct\":\n        func = () => innerProduct([embeddedQuery], largeEmbeddings);\n        break;\n      case \"euclidean\":\n        func = () => euclideanDistance([embeddedQuery], largeEmbeddings);\n        break;\n      default:\n        throw new Error(`Unknown search type: ${this.searchType}`);\n    }\n\n    // Calculate the similarity scores between the query embedding and the large embeddings\n    const [similarityScores] = func();\n\n    // Create an array of indices from 0 to N-1, where N is the number of documents\n    let indices = Array.from(\n      { length: smallResults.length },\n      (_, index) => index\n    );\n\n    indices = indices\n      .map((v, i) => [similarityScores[i], v])\n      .sort(([a], [b]) => b - a)\n      .slice(0, this.largeK)\n      .map(([, i]) => i);\n\n    return indices.map((i) => smallResults[i]);\n  }\n\n  async _getRelevantDocuments(query: string): Promise<DocumentInterface[]> {\n    const [embeddedQuery, smallResults] = await Promise.all([\n      this.largeEmbeddingModel.embedQuery(query),\n      this.vectorStore.similaritySearch(query, this.smallK, this.filter),\n    ]);\n\n    return this._rankByLargeEmbeddings(embeddedQuery, smallResults);\n  }\n\n  /**\n   * Override the default `addDocuments` method to embed the documents twice,\n   * once using the larger embeddings model, and then again using the default\n   * embedding model linked to the vector store.\n   *\n   * @param {DocumentInterface[]} documents - An array of documents to add to the vector store.\n   * @param {AddDocumentOptions} options - An optional object containing additional options for adding documents.\n   * @returns {Promise<string[] | void>} A promise that resolves to an array of the document IDs that were added to the vector store.\n   */\n  override addDocuments = async (\n    documents: DocumentInterface[],\n    options?: AddDocumentOptions\n  ): Promise<string[] | void> => {\n    // Insure documents metadata does not contain the large embedding key\n    if (documents.some((doc) => this.largeEmbeddingKey in doc.metadata)) {\n      throw new Error(\n        `All documents must not contain the large embedding key: ${this.largeEmbeddingKey} in their metadata.`\n      );\n    }\n\n    const allDocPageContent = documents.map((doc) => doc.pageContent);\n    const allDocLargeEmbeddings =\n      await this.largeEmbeddingModel.embedDocuments(allDocPageContent);\n\n    const newDocuments: Array<DocumentInterface> = documents.map(\n      (doc, idx) => ({\n        ...doc,\n        metadata: {\n          ...doc.metadata,\n          [this.largeEmbeddingKey]: JSON.stringify(allDocLargeEmbeddings[idx]),\n        },\n      })\n    );\n\n    return this.vectorStore.addDocuments(newDocuments, options);\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,sBAAb,cAEU,qBAA4B;CACpC,SAAS;CAET,SAAS;CAET,oBAAoB;CAEpB;CAEA,aAAsD;CAEtD,YACE,QACA;AACA,QAAM,OAAO;AACb,OAAK,SAAS,OAAO,UAAU,KAAK;AACpC,OAAK,SAAS,OAAO,UAAU,KAAK;AACpC,OAAK,oBAAoB,OAAO,qBAAqB,KAAK;AAC1D,OAAK,sBAAsB,OAAO;AAClC,OAAK,aAAa,OAAO,cAAc,KAAK;;;;;;;;;;;;;;;;;;;;CAqB9C,uBACE,eACA,cACqB;EACrB,MAAM,kBAAmC,aAAa,KAAK,QACzD,KAAK,MAAM,IAAI,SAAS,KAAK,mBAAmB,CACjD;EACD,IAAI;AAEJ,UAAQ,KAAK,YAAb;GACE,KAAK;AACH,iBAAa,iBAAiB,CAAC,cAAc,EAAE,gBAAgB;AAC/D;GACF,KAAK;AACH,iBAAa,aAAa,CAAC,cAAc,EAAE,gBAAgB;AAC3D;GACF,KAAK;AACH,iBAAa,kBAAkB,CAAC,cAAc,EAAE,gBAAgB;AAChE;GACF,QACE,OAAM,IAAI,MAAM,wBAAwB,KAAK,aAAa;;EAI9D,MAAM,CAAC,oBAAoB,MAAM;EAGjC,IAAI,UAAU,MAAM,KAClB,EAAE,QAAQ,aAAa,QAAQ,GAC9B,GAAG,UAAU,MACf;AAED,YAAU,QACP,KAAK,GAAG,MAAM,CAAC,iBAAiB,IAAI,EAAE,CAAC,CACvC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,EAAE,CACzB,MAAM,GAAG,KAAK,OAAO,CACrB,KAAK,GAAG,OAAO,EAAE;AAEpB,SAAO,QAAQ,KAAK,MAAM,aAAa,GAAG;;CAG5C,MAAM,sBAAsB,OAA6C;EACvE,MAAM,CAAC,eAAe,gBAAgB,MAAM,QAAQ,IAAI,CACtD,KAAK,oBAAoB,WAAW,MAAM,EAC1C,KAAK,YAAY,iBAAiB,OAAO,KAAK,QAAQ,KAAK,OAAO,CACnE,CAAC;AAEF,SAAO,KAAK,uBAAuB,eAAe,aAAa;;;;;;;;;;;CAYjE,eAAwB,OACtB,WACA,YAC6B;AAE7B,MAAI,UAAU,MAAM,QAAQ,KAAK,qBAAqB,IAAI,SAAS,CACjE,OAAM,IAAI,MACR,2DAA2D,KAAK,kBAAkB,qBACnF;EAGH,MAAM,oBAAoB,UAAU,KAAK,QAAQ,IAAI,YAAY;EACjE,MAAM,wBACJ,MAAM,KAAK,oBAAoB,eAAe,kBAAkB;EAElE,MAAM,eAAyC,UAAU,KACtD,KAAK,SAAS;GACb,GAAG;GACH,UAAU;IACR,GAAG,IAAI;KACN,KAAK,oBAAoB,KAAK,UAAU,sBAAsB,KAAK;IACrE;GACF,EACF;AAED,SAAO,KAAK,YAAY,aAAa,cAAc,QAAQ"}
+{"version":3,"file":"matryoshka_retriever.js","names":[],"sources":["../../src/retrievers/matryoshka_retriever.ts"],"sourcesContent":["import { DocumentInterface } from \"@langchain/core/documents\";\nimport { Embeddings } from \"@langchain/core/embeddings\";\nimport {\n  cosineSimilarity,\n  euclideanDistance,\n  innerProduct,\n} from \"@langchain/core/utils/math\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\n/**\n * Type for options when adding a document to the VectorStore.\n */\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\ntype AddDocumentOptions = Record<string, any>;\n\nexport interface MatryoshkaRetrieverFields {\n  /**\n   * The number of documents to retrieve from the small store.\n   * @default 50\n   */\n  smallK?: number;\n  /**\n   * The number of documents to retrieve from the large store.\n   * @default 8\n   */\n  largeK?: number;\n  /**\n   * The metadata key to store the larger embeddings.\n   * @default \"lc_large_embedding\"\n   */\n  largeEmbeddingKey?: string;\n  /**\n   * The embedding model to use when generating the large\n   * embeddings.\n   */\n  largeEmbeddingModel: Embeddings;\n  /**\n   * The type of search to perform using the large embeddings.\n   * @default \"cosine\"\n   */\n  searchType?: \"cosine\" | \"innerProduct\" | \"euclidean\";\n}\n\n/**\n * A retriever that uses two sets of embeddings to perform adaptive retrieval. Based\n * off of the \"Matryoshka embeddings: faster OpenAI vector search using Adaptive Retrieval\"\n * blog post {@link https://supabase.com/blog/matryoshka-embeddings}.\n *\n *\n * This class performs \"Adaptive Retrieval\" for searching text embeddings efficiently using the\n * Matryoshka Representation Learning (MRL) technique. It retrieves documents similar to a query\n * embedding in two steps:\n *\n * First-pass: Uses a lower dimensional sub-vector from the MRL embedding for an initial, fast,\n * but less accurate search.\n *\n * Second-pass: Re-ranks the top results from the first pass using the full, high-dimensional\n * embedding for higher accuracy.\n *\n *\n * This code implements MRL embeddings for efficient vector search by combining faster,\n * lower-dimensional initial search with accurate, high-dimensional re-ranking.\n */\nexport class MatryoshkaRetriever<\n  Store extends VectorStore = VectorStore,\n> extends VectorStoreRetriever<Store> {\n  smallK = 50;\n\n  largeK = 8;\n\n  largeEmbeddingKey = \"lc_large_embedding\";\n\n  largeEmbeddingModel: Embeddings;\n\n  searchType: \"cosine\" | \"innerProduct\" | \"euclidean\" = \"cosine\";\n\n  constructor(\n    fields: MatryoshkaRetrieverFields & VectorStoreRetrieverInput<Store>\n  ) {\n    super(fields);\n    this.smallK = fields.smallK ?? this.smallK;\n    this.largeK = fields.largeK ?? this.largeK;\n    this.largeEmbeddingKey = fields.largeEmbeddingKey ?? this.largeEmbeddingKey;\n    this.largeEmbeddingModel = fields.largeEmbeddingModel;\n    this.searchType = fields.searchType ?? this.searchType;\n  }\n\n  /**\n   * Ranks documents based on their similarity to a query embedding using larger embeddings.\n   *\n   * This method takes a query embedding and a list of documents (smallResults) as input. Each document\n   * in the smallResults array has previously been associated with a large embedding stored in its metadata.\n   * Depending on the `searchType` (cosine, innerProduct, or euclidean), it calculates the similarity scores\n   * between the query embedding and each document's large embedding. It then ranks the documents based on\n   * these similarity scores, from the most similar to the least similar.\n   *\n   * The method returns a promise that resolves to an array of the top `largeK` documents, where `largeK`\n   * is a class property defining the number of documents to return. This subset of documents is determined\n   * by sorting the entire list of documents based on their similarity scores and then selecting the top\n   * `largeK` documents.\n   *\n   * @param {number[]} embeddedQuery The embedding of the query, represented as an array of numbers.\n   * @param {DocumentInterface[]} smallResults An array of documents, each with metadata that includes a large embedding for similarity comparison.\n   * @returns {Promise<DocumentInterface[]>} A promise that resolves to an array of the top `largeK` ranked documents based on their similarity to the query embedding.\n   */\n  private _rankByLargeEmbeddings(\n    embeddedQuery: number[],\n    smallResults: DocumentInterface[]\n  ): DocumentInterface[] {\n    const largeEmbeddings: Array<number[]> = smallResults.map((doc) =>\n      JSON.parse(doc.metadata[this.largeEmbeddingKey])\n    );\n    let func: () => Array<number[]>;\n\n    switch (this.searchType) {\n      case \"cosine\":\n        func = () => cosineSimilarity([embeddedQuery], largeEmbeddings);\n        break;\n      case \"innerProduct\":\n        func = () => innerProduct([embeddedQuery], largeEmbeddings);\n        break;\n      case \"euclidean\":\n        func = () => euclideanDistance([embeddedQuery], largeEmbeddings);\n        break;\n      default:\n        throw new Error(`Unknown search type: ${this.searchType}`);\n    }\n\n    // Calculate the similarity scores between the query embedding and the large embeddings\n    const [similarityScores] = func();\n\n    // Create an array of indices from 0 to N-1, where N is the number of documents\n    let indices = Array.from(\n      { length: smallResults.length },\n      (_, index) => index\n    );\n\n    indices = indices\n      .map((v, i) => [similarityScores[i], v])\n      .sort(([a], [b]) => b - a)\n      .slice(0, this.largeK)\n      .map(([, i]) => i);\n\n    return indices.map((i) => smallResults[i]);\n  }\n\n  async _getRelevantDocuments(query: string): Promise<DocumentInterface[]> {\n    const [embeddedQuery, smallResults] = await Promise.all([\n      this.largeEmbeddingModel.embedQuery(query),\n      this.vectorStore.similaritySearch(query, this.smallK, this.filter),\n    ]);\n\n    return this._rankByLargeEmbeddings(embeddedQuery, smallResults);\n  }\n\n  /**\n   * Override the default `addDocuments` method to embed the documents twice,\n   * once using the larger embeddings model, and then again using the default\n   * embedding model linked to the vector store.\n   *\n   * @param {DocumentInterface[]} documents - An array of documents to add to the vector store.\n   * @param {AddDocumentOptions} options - An optional object containing additional options for adding documents.\n   * @returns {Promise<string[] | void>} A promise that resolves to an array of the document IDs that were added to the vector store.\n   */\n  override addDocuments = async (\n    documents: DocumentInterface[],\n    options?: AddDocumentOptions\n  ): Promise<string[] | void> => {\n    // Insure documents metadata does not contain the large embedding key\n    if (documents.some((doc) => this.largeEmbeddingKey in doc.metadata)) {\n      throw new Error(\n        `All documents must not contain the large embedding key: ${this.largeEmbeddingKey} in their metadata.`\n      );\n    }\n\n    const allDocPageContent = documents.map((doc) => doc.pageContent);\n    const allDocLargeEmbeddings =\n      await this.largeEmbeddingModel.embedDocuments(allDocPageContent);\n\n    const newDocuments: Array<DocumentInterface> = documents.map(\n      (doc, idx) => ({\n        ...doc,\n        metadata: {\n          ...doc.metadata,\n          [this.largeEmbeddingKey]: JSON.stringify(allDocLargeEmbeddings[idx]),\n        },\n      })\n    );\n\n    return this.vectorStore.addDocuments(newDocuments, options);\n  };\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;AAmEA,IAAa,sBAAb,cAEU,qBAA4B;CACpC,SAAS;CAET,SAAS;CAET,oBAAoB;CAEpB;CAEA,aAAsD;CAEtD,YACE,QACA;EACA,MAAM,MAAM;EACZ,KAAK,SAAS,OAAO,UAAU,KAAK;EACpC,KAAK,SAAS,OAAO,UAAU,KAAK;EACpC,KAAK,oBAAoB,OAAO,qBAAqB,KAAK;EAC1D,KAAK,sBAAsB,OAAO;EAClC,KAAK,aAAa,OAAO,cAAc,KAAK;CAC9C;;;;;;;;;;;;;;;;;;;CAoBA,uBACE,eACA,cACqB;EACrB,MAAM,kBAAmC,aAAa,KAAK,QACzD,KAAK,MAAM,IAAI,SAAS,KAAK,kBAAkB,CACjD;EACA,IAAI;EAEJ,QAAQ,KAAK,YAAb;GACE,KAAK;IACH,aAAa,iBAAiB,CAAC,aAAa,GAAG,eAAe;IAC9D;GACF,KAAK;IACH,aAAa,aAAa,CAAC,aAAa,GAAG,eAAe;IAC1D;GACF,KAAK;IACH,aAAa,kBAAkB,CAAC,aAAa,GAAG,eAAe;IAC/D;GACF,SACE,MAAM,IAAI,MAAM,wBAAwB,KAAK,YAAY;EAC7D;EAGA,MAAM,CAAC,oBAAoB,KAAK;EAGhC,IAAI,UAAU,MAAM,KAClB,EAAE,QAAQ,aAAa,OAAO,IAC7B,GAAG,UAAU,KAChB;EAEA,UAAU,QACP,KAAK,GAAG,MAAM,CAAC,iBAAiB,IAAI,CAAC,CAAC,CAAC,CACvC,MAAM,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,CAAC,CACzB,MAAM,GAAG,KAAK,MAAM,CAAC,CACrB,KAAK,GAAG,OAAO,CAAC;EAEnB,OAAO,QAAQ,KAAK,MAAM,aAAa,EAAE;CAC3C;CAEA,MAAM,sBAAsB,OAA6C;EACvE,MAAM,CAAC,eAAe,gBAAgB,MAAM,QAAQ,IAAI,CACtD,KAAK,oBAAoB,WAAW,KAAK,GACzC,KAAK,YAAY,iBAAiB,OAAO,KAAK,QAAQ,KAAK,MAAM,CACnE,CAAC;EAED,OAAO,KAAK,uBAAuB,eAAe,YAAY;CAChE;;;;;;;;;;CAWA,eAAwB,OACtB,WACA,YAC6B;EAE7B,IAAI,UAAU,MAAM,QAAQ,KAAK,qBAAqB,IAAI,QAAQ,GAChE,MAAM,IAAI,MACR,2DAA2D,KAAK,kBAAkB,oBACpF;EAGF,MAAM,oBAAoB,UAAU,KAAK,QAAQ,IAAI,WAAW;EAChE,MAAM,wBACJ,MAAM,KAAK,oBAAoB,eAAe,iBAAiB;EAEjE,MAAM,eAAyC,UAAU,KACtD,KAAK,SAAS;GACb,GAAG;GACH,UAAU;IACR,GAAG,IAAI;KACN,KAAK,oBAAoB,KAAK,UAAU,sBAAsB,IAAI;GACrE;EACF,EACF;EAEA,OAAO,KAAK,YAAY,aAAa,cAAc,OAAO;CAC5D;AACF"}

package/dist/retrievers/multi_query.cjs

@@ -26,7 +26,7 @@ var LineListOutputParser = class extends _langchain_core_output_parsers.BaseOutp
 		throw new Error("Not implemented.");
 	}
 };
-const DEFAULT_QUERY_PROMPT = /* @__PURE__ */ new _langchain_core_prompts.PromptTemplate({
+const DEFAULT_QUERY_PROMPT = /* #__PURE__ */ new _langchain_core_prompts.PromptTemplate({
 	inputVariables: ["question", "queryCount"],
 	template: `You are an AI language model assistant. Your task is
 to generate {queryCount} different versions of the given user

package/dist/retrievers/multi_query.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"multi_query.cjs","names":["BaseOutputParser","PromptTemplate","BaseRetriever","LLMChain"],"sources":["../../src/retrievers/multi_query.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport {\n  BaseRetriever,\n  type BaseRetrieverInput,\n  type BaseRetrieverInterface,\n} from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport { PromptTemplate, BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { LLMChain } from \"../chains/llm_chain.js\";\nimport type { BaseDocumentCompressor } from \"./document_compressors/index.js\";\n\ninterface LineList {\n  lines: string[];\n}\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport type MultiDocs = Document<Record<string, any>>[];\n\nclass LineListOutputParser extends BaseOutputParser<LineList> {\n  static lc_name() {\n    return \"LineListOutputParser\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multiquery\"];\n\n  async parse(text: string): Promise<LineList> {\n    const startKeyIndex = text.indexOf(\"<questions>\");\n    const endKeyIndex = text.indexOf(\"</questions>\");\n    const questionsStartIndex =\n      startKeyIndex === -1 ? 0 : startKeyIndex + \"<questions>\".length;\n    const questionsEndIndex = endKeyIndex === -1 ? text.length : endKeyIndex;\n    const lines = text\n      .slice(questionsStartIndex, questionsEndIndex)\n      .trim()\n      .split(\"\\n\")\n      .filter((line) => line.trim() !== \"\");\n    return { lines };\n  }\n\n  getFormatInstructions(): string {\n    throw new Error(\"Not implemented.\");\n  }\n}\n\n// Create template\nconst DEFAULT_QUERY_PROMPT = /* #__PURE__ */ new PromptTemplate({\n  inputVariables: [\"question\", \"queryCount\"],\n  template: `You are an AI language model assistant. Your task is\nto generate {queryCount} different versions of the given user\nquestion to retrieve relevant documents from a vector database.\nBy generating multiple perspectives on the user question,\nyour goal is to help the user overcome some of the limitations\nof distance-based similarity search.\n\nProvide these alternative questions separated by newlines between XML tags. For example:\n\n<questions>\nQuestion 1\nQuestion 2\nQuestion 3\n</questions>\n\nOriginal question: {question}`,\n});\n\nexport interface MultiQueryRetrieverInput extends BaseRetrieverInput {\n  retriever: BaseRetrieverInterface;\n  /** @deprecated Pass a custom prompt into `.fromLLM` instead. */\n  llmChain: LLMChain<LineList>;\n  queryCount?: number;\n  parserKey?: string;\n  documentCompressor?: BaseDocumentCompressor | undefined;\n  documentCompressorFilteringFn?: (docs: MultiDocs) => MultiDocs;\n}\n\n/**\n * @example\n * ```typescript\n * const retriever = new MultiQueryRetriever.fromLLM({\n *   llm: new ChatAnthropic({}),\n *   retriever: new MemoryVectorStore().asRetriever(),\n *   verbose: true,\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What are mitochondria made of?\",\n * );\n * ```\n */\nexport class MultiQueryRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"MultiQueryRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multiquery\"];\n\n  private retriever: BaseRetrieverInterface;\n\n  private llmChain: LLMChain<LineList>;\n\n  private queryCount = 3;\n\n  private parserKey = \"lines\";\n\n  documentCompressor: BaseDocumentCompressor | undefined;\n\n  documentCompressorFilteringFn?: MultiQueryRetrieverInput[\"documentCompressorFilteringFn\"];\n\n  constructor(fields: MultiQueryRetrieverInput) {\n    super(fields);\n    this.retriever = fields.retriever;\n    this.llmChain = fields.llmChain;\n    this.queryCount = fields.queryCount ?? this.queryCount;\n    this.parserKey = fields.parserKey ?? this.parserKey;\n    this.documentCompressor = fields.documentCompressor;\n    this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;\n  }\n\n  static fromLLM(\n    fields: Omit<MultiQueryRetrieverInput, \"llmChain\"> & {\n      llm: BaseLanguageModelInterface;\n      prompt?: BasePromptTemplate;\n    }\n  ): MultiQueryRetriever {\n    const {\n      retriever,\n      llm,\n      prompt = DEFAULT_QUERY_PROMPT,\n      queryCount,\n      parserKey,\n      ...rest\n    } = fields;\n    const outputParser = new LineListOutputParser();\n    const llmChain = new LLMChain({ llm, prompt, outputParser });\n    return new this({ retriever, llmChain, queryCount, parserKey, ...rest });\n  }\n\n  // Generate the different queries for each retrieval, using our llmChain\n  private async _generateQueries(\n    question: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<string[]> {\n    const response = await this.llmChain.call(\n      { question, queryCount: this.queryCount },\n      runManager?.getChild()\n    );\n    const lines = response.text[this.parserKey] || [];\n    if (this.verbose) {\n      console.log(`Generated queries: ${lines}`);\n    }\n    return lines;\n  }\n\n  // Retrieve documents using the original retriever\n  private async _retrieveDocuments(\n    queries: string[],\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document[]> {\n    const documents: Document[] = [];\n    await Promise.all(\n      queries.map(async (query) => {\n        const docs = await this.retriever.invoke(query, runManager?.getChild());\n        documents.push(...docs);\n      })\n    );\n    return documents;\n  }\n\n  // Deduplicate the documents that were returned in multiple retrievals\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const uniqueDocumentsDict: { [key: string]: Document } = {};\n\n    for (const doc of documents) {\n      const key = `${doc.pageContent}:${JSON.stringify(\n        Object.entries(doc.metadata).sort()\n      )}`;\n      uniqueDocumentsDict[key] = doc;\n    }\n\n    const uniqueDocuments = Object.values(uniqueDocumentsDict);\n    return uniqueDocuments;\n  }\n\n  async _getRelevantDocuments(\n    question: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document[]> {\n    const queries = await this._generateQueries(question, runManager);\n    const documents = await this._retrieveDocuments(queries, runManager);\n    const uniqueDocuments = this._uniqueUnion(documents);\n\n    let outputDocs = uniqueDocuments;\n    if (this.documentCompressor && uniqueDocuments.length) {\n      outputDocs = await this.documentCompressor.compressDocuments(\n        uniqueDocuments,\n        question,\n        runManager?.getChild()\n      );\n      if (this.documentCompressorFilteringFn) {\n        outputDocs = this.documentCompressorFilteringFn(outputDocs);\n      }\n    }\n\n    return outputDocs;\n  }\n}\n"],"mappings":";;;;;;;;AAoBA,IAAM,uBAAN,cAAmCA,+BAAAA,iBAA2B;CAC5D,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAa;CAExD,MAAM,MAAM,MAAiC;EAC3C,MAAM,gBAAgB,KAAK,QAAQ,cAAc;EACjD,MAAM,cAAc,KAAK,QAAQ,eAAe;EAChD,MAAM,sBACJ,kBAAkB,KAAK,IAAI,gBAAgB;EAC7C,MAAM,oBAAoB,gBAAgB,KAAK,KAAK,SAAS;AAM7D,SAAO,EAAE,OALK,KACX,MAAM,qBAAqB,kBAAkB,CAC7C,MAAM,CACN,MAAM,KAAK,CACX,QAAQ,SAAS,KAAK,MAAM,KAAK,GACtB,EAAE;;CAGlB,wBAAgC;AAC9B,QAAM,IAAI,MAAM,mBAAmB;;;AAKvC,MAAM,uCAAuC,IAAIC,wBAAAA,eAAe;CAC9D,gBAAgB,CAAC,YAAY,aAAa;CAC1C,UAAU;;;;;;;;;;;;;;;;CAgBX,CAAC;;;;;;;;;;;;;;AAyBF,IAAa,sBAAb,cAAyCC,2BAAAA,cAAc;CACrD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAa;CAExD;CAEA;CAEA,aAAqB;CAErB,YAAoB;CAEpB;CAEA;CAEA,YAAY,QAAkC;AAC5C,QAAM,OAAO;AACb,OAAK,YAAY,OAAO;AACxB,OAAK,WAAW,OAAO;AACvB,OAAK,aAAa,OAAO,cAAc,KAAK;AAC5C,OAAK,YAAY,OAAO,aAAa,KAAK;AAC1C,OAAK,qBAAqB,OAAO;AACjC,OAAK,gCAAgC,OAAO;;CAG9C,OAAO,QACL,QAIqB;EACrB,MAAM,EACJ,WACA,KACA,SAAS,sBACT,YACA,WACA,GAAG,SACD;EAEJ,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAAE;GAAK;GAAQ,cAAA,IADpB,sBACgC;GAAE,CAAC;AAC5D,SAAO,IAAI,KAAK;GAAE;GAAW;GAAU;GAAY;GAAW,GAAG;GAAM,CAAC;;CAI1E,MAAc,iBACZ,UACA,YACmB;EAKnB,MAAM,SAAQ,MAJS,KAAK,SAAS,KACnC;GAAE;GAAU,YAAY,KAAK;GAAY,EACzC,YAAY,UAAU,CACvB,EACsB,KAAK,KAAK,cAAc,EAAE;AACjD,MAAI,KAAK,QACP,SAAQ,IAAI,sBAAsB,QAAQ;AAE5C,SAAO;;CAIT,MAAc,mBACZ,SACA,YACqB;EACrB,MAAM,YAAwB,EAAE;AAChC,QAAM,QAAQ,IACZ,QAAQ,IAAI,OAAO,UAAU;GAC3B,MAAM,OAAO,MAAM,KAAK,UAAU,OAAO,OAAO,YAAY,UAAU,CAAC;AACvE,aAAU,KAAK,GAAG,KAAK;IACvB,CACH;AACD,SAAO;;CAIT,aAAqB,WAAmC;EACtD,MAAM,sBAAmD,EAAE;AAE3D,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,GAAG,IAAI,YAAY,GAAG,KAAK,UACrC,OAAO,QAAQ,IAAI,SAAS,CAAC,MAAM,CACpC;AACD,uBAAoB,OAAO;;AAI7B,SADwB,OAAO,OAAO,oBAChB;;CAGxB,MAAM,sBACJ,UACA,YACqB;EACrB,MAAM,UAAU,MAAM,KAAK,iBAAiB,UAAU,WAAW;EACjE,MAAM,YAAY,MAAM,KAAK,mBAAmB,SAAS,WAAW;EACpE,MAAM,kBAAkB,KAAK,aAAa,UAAU;EAEpD,IAAI,aAAa;AACjB,MAAI,KAAK,sBAAsB,gBAAgB,QAAQ;AACrD,gBAAa,MAAM,KAAK,mBAAmB,kBACzC,iBACA,UACA,YAAY,UAAU,CACvB;AACD,OAAI,KAAK,8BACP,cAAa,KAAK,8BAA8B,WAAW;;AAI/D,SAAO"}
+{"version":3,"file":"multi_query.cjs","names":["BaseOutputParser","PromptTemplate","BaseRetriever","LLMChain"],"sources":["../../src/retrievers/multi_query.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport {\n  BaseRetriever,\n  type BaseRetrieverInput,\n  type BaseRetrieverInterface,\n} from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport { PromptTemplate, BasePromptTemplate } from \"@langchain/core/prompts\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { LLMChain } from \"../chains/llm_chain.js\";\nimport type { BaseDocumentCompressor } from \"./document_compressors/index.js\";\n\ninterface LineList {\n  lines: string[];\n}\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport type MultiDocs = Document<Record<string, any>>[];\n\nclass LineListOutputParser extends BaseOutputParser<LineList> {\n  static lc_name() {\n    return \"LineListOutputParser\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multiquery\"];\n\n  async parse(text: string): Promise<LineList> {\n    const startKeyIndex = text.indexOf(\"<questions>\");\n    const endKeyIndex = text.indexOf(\"</questions>\");\n    const questionsStartIndex =\n      startKeyIndex === -1 ? 0 : startKeyIndex + \"<questions>\".length;\n    const questionsEndIndex = endKeyIndex === -1 ? text.length : endKeyIndex;\n    const lines = text\n      .slice(questionsStartIndex, questionsEndIndex)\n      .trim()\n      .split(\"\\n\")\n      .filter((line) => line.trim() !== \"\");\n    return { lines };\n  }\n\n  getFormatInstructions(): string {\n    throw new Error(\"Not implemented.\");\n  }\n}\n\n// Create template\nconst DEFAULT_QUERY_PROMPT = /* #__PURE__ */ new PromptTemplate({\n  inputVariables: [\"question\", \"queryCount\"],\n  template: `You are an AI language model assistant. Your task is\nto generate {queryCount} different versions of the given user\nquestion to retrieve relevant documents from a vector database.\nBy generating multiple perspectives on the user question,\nyour goal is to help the user overcome some of the limitations\nof distance-based similarity search.\n\nProvide these alternative questions separated by newlines between XML tags. For example:\n\n<questions>\nQuestion 1\nQuestion 2\nQuestion 3\n</questions>\n\nOriginal question: {question}`,\n});\n\nexport interface MultiQueryRetrieverInput extends BaseRetrieverInput {\n  retriever: BaseRetrieverInterface;\n  /** @deprecated Pass a custom prompt into `.fromLLM` instead. */\n  llmChain: LLMChain<LineList>;\n  queryCount?: number;\n  parserKey?: string;\n  documentCompressor?: BaseDocumentCompressor | undefined;\n  documentCompressorFilteringFn?: (docs: MultiDocs) => MultiDocs;\n}\n\n/**\n * @example\n * ```typescript\n * const retriever = new MultiQueryRetriever.fromLLM({\n *   llm: new ChatAnthropic({}),\n *   retriever: new MemoryVectorStore().asRetriever(),\n *   verbose: true,\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What are mitochondria made of?\",\n * );\n * ```\n */\nexport class MultiQueryRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"MultiQueryRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multiquery\"];\n\n  private retriever: BaseRetrieverInterface;\n\n  private llmChain: LLMChain<LineList>;\n\n  private queryCount = 3;\n\n  private parserKey = \"lines\";\n\n  documentCompressor: BaseDocumentCompressor | undefined;\n\n  documentCompressorFilteringFn?: MultiQueryRetrieverInput[\"documentCompressorFilteringFn\"];\n\n  constructor(fields: MultiQueryRetrieverInput) {\n    super(fields);\n    this.retriever = fields.retriever;\n    this.llmChain = fields.llmChain;\n    this.queryCount = fields.queryCount ?? this.queryCount;\n    this.parserKey = fields.parserKey ?? this.parserKey;\n    this.documentCompressor = fields.documentCompressor;\n    this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;\n  }\n\n  static fromLLM(\n    fields: Omit<MultiQueryRetrieverInput, \"llmChain\"> & {\n      llm: BaseLanguageModelInterface;\n      prompt?: BasePromptTemplate;\n    }\n  ): MultiQueryRetriever {\n    const {\n      retriever,\n      llm,\n      prompt = DEFAULT_QUERY_PROMPT,\n      queryCount,\n      parserKey,\n      ...rest\n    } = fields;\n    const outputParser = new LineListOutputParser();\n    const llmChain = new LLMChain({ llm, prompt, outputParser });\n    return new this({ retriever, llmChain, queryCount, parserKey, ...rest });\n  }\n\n  // Generate the different queries for each retrieval, using our llmChain\n  private async _generateQueries(\n    question: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<string[]> {\n    const response = await this.llmChain.call(\n      { question, queryCount: this.queryCount },\n      runManager?.getChild()\n    );\n    const lines = response.text[this.parserKey] || [];\n    if (this.verbose) {\n      console.log(`Generated queries: ${lines}`);\n    }\n    return lines;\n  }\n\n  // Retrieve documents using the original retriever\n  private async _retrieveDocuments(\n    queries: string[],\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document[]> {\n    const documents: Document[] = [];\n    await Promise.all(\n      queries.map(async (query) => {\n        const docs = await this.retriever.invoke(query, runManager?.getChild());\n        documents.push(...docs);\n      })\n    );\n    return documents;\n  }\n\n  // Deduplicate the documents that were returned in multiple retrievals\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const uniqueDocumentsDict: { [key: string]: Document } = {};\n\n    for (const doc of documents) {\n      const key = `${doc.pageContent}:${JSON.stringify(\n        Object.entries(doc.metadata).sort()\n      )}`;\n      uniqueDocumentsDict[key] = doc;\n    }\n\n    const uniqueDocuments = Object.values(uniqueDocumentsDict);\n    return uniqueDocuments;\n  }\n\n  async _getRelevantDocuments(\n    question: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document[]> {\n    const queries = await this._generateQueries(question, runManager);\n    const documents = await this._retrieveDocuments(queries, runManager);\n    const uniqueDocuments = this._uniqueUnion(documents);\n\n    let outputDocs = uniqueDocuments;\n    if (this.documentCompressor && uniqueDocuments.length) {\n      outputDocs = await this.documentCompressor.compressDocuments(\n        uniqueDocuments,\n        question,\n        runManager?.getChild()\n      );\n      if (this.documentCompressorFilteringFn) {\n        outputDocs = this.documentCompressorFilteringFn(outputDocs);\n      }\n    }\n\n    return outputDocs;\n  }\n}\n"],"mappings":";;;;;;;;AAoBA,IAAM,uBAAN,cAAmCA,+BAAAA,iBAA2B;CAC5D,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAY;CAEvD,MAAM,MAAM,MAAiC;EAC3C,MAAM,gBAAgB,KAAK,QAAQ,aAAa;EAChD,MAAM,cAAc,KAAK,QAAQ,cAAc;EAC/C,MAAM,sBACJ,kBAAkB,KAAK,IAAI,gBAAgB;EAC7C,MAAM,oBAAoB,gBAAgB,KAAK,KAAK,SAAS;EAM7D,OAAO,EAAE,OALK,KACX,MAAM,qBAAqB,iBAAiB,CAAC,CAC7C,KAAK,CAAC,CACN,MAAM,IAAI,CAAC,CACX,QAAQ,SAAS,KAAK,KAAK,MAAM,EACvB,EAAE;CACjB;CAEA,wBAAgC;EAC9B,MAAM,IAAI,MAAM,kBAAkB;CACpC;AACF;AAGA,MAAM,uCAAuC,IAAIC,wBAAAA,eAAe;CAC9D,gBAAgB,CAAC,YAAY,YAAY;CACzC,UAAU;;;;;;;;;;;;;;;;AAgBZ,CAAC;;;;;;;;;;;;;;AAyBD,IAAa,sBAAb,cAAyCC,2BAAAA,cAAc;CACrD,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAY;CAEvD;CAEA;CAEA,aAAqB;CAErB,YAAoB;CAEpB;CAEA;CAEA,YAAY,QAAkC;EAC5C,MAAM,MAAM;EACZ,KAAK,YAAY,OAAO;EACxB,KAAK,WAAW,OAAO;EACvB,KAAK,aAAa,OAAO,cAAc,KAAK;EAC5C,KAAK,YAAY,OAAO,aAAa,KAAK;EAC1C,KAAK,qBAAqB,OAAO;EACjC,KAAK,gCAAgC,OAAO;CAC9C;CAEA,OAAO,QACL,QAIqB;EACrB,MAAM,EACJ,WACA,KACA,SAAS,sBACT,YACA,WACA,GAAG,SACD;EAEJ,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAAE;GAAK;GAAQ,cAAA,IADpB,qBAC+B;EAAE,CAAC;EAC3D,OAAO,IAAI,KAAK;GAAE;GAAW;GAAU;GAAY;GAAW,GAAG;EAAK,CAAC;CACzE;CAGA,MAAc,iBACZ,UACA,YACmB;EAKnB,MAAM,SAAQ,MAJS,KAAK,SAAS,KACnC;GAAE;GAAU,YAAY,KAAK;EAAW,GACxC,YAAY,SAAS,CACvB,EAAA,CACuB,KAAK,KAAK,cAAc,CAAC;EAChD,IAAI,KAAK,SACP,QAAQ,IAAI,sBAAsB,OAAO;EAE3C,OAAO;CACT;CAGA,MAAc,mBACZ,SACA,YACqB;EACrB,MAAM,YAAwB,CAAC;EAC/B,MAAM,QAAQ,IACZ,QAAQ,IAAI,OAAO,UAAU;GAC3B,MAAM,OAAO,MAAM,KAAK,UAAU,OAAO,OAAO,YAAY,SAAS,CAAC;GACtE,UAAU,KAAK,GAAG,IAAI;EACxB,CAAC,CACH;EACA,OAAO;CACT;CAGA,aAAqB,WAAmC;EACtD,MAAM,sBAAmD,CAAC;EAE1D,KAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,GAAG,IAAI,YAAY,GAAG,KAAK,UACrC,OAAO,QAAQ,IAAI,QAAQ,CAAC,CAAC,KAAK,CACpC;GACA,oBAAoB,OAAO;EAC7B;EAGA,OADwB,OAAO,OAAO,mBACjB;CACvB;CAEA,MAAM,sBACJ,UACA,YACqB;EACrB,MAAM,UAAU,MAAM,KAAK,iBAAiB,UAAU,UAAU;EAChE,MAAM,YAAY,MAAM,KAAK,mBAAmB,SAAS,UAAU;EACnE,MAAM,kBAAkB,KAAK,aAAa,SAAS;EAEnD,IAAI,aAAa;EACjB,IAAI,KAAK,sBAAsB,gBAAgB,QAAQ;GACrD,aAAa,MAAM,KAAK,mBAAmB,kBACzC,iBACA,UACA,YAAY,SAAS,CACvB;GACA,IAAI,KAAK,+BACP,aAAa,KAAK,8BAA8B,UAAU;EAE9D;EAEA,OAAO;CACT;AACF"}

package/dist/retrievers/multi_query.d.cts

@@ -5,7 +5,6 @@ import { BaseLanguageModelInterface } from "@langchain/core/language_models/base
 import { CallbackManagerForRetrieverRun } from "@langchain/core/callbacks/manager";
 import { BaseRetriever, BaseRetrieverInput, BaseRetrieverInterface } from "@langchain/core/retrievers";
 import { Document } from "@langchain/core/documents";
-
 //#region src/retrievers/multi_query.d.ts
 interface LineList {
   lines: string[];