@langchain/classic 1.0.39 → 1.0.41

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

@@ -1 +1 @@
-{"version":3,"file":"multi_query.d.cts","names":[],"sources":["../../src/retrievers/multi_query.ts"],"mappings":";;;;;;;;;UAaU,QAAA;EACR,KAAA;AAAA;AAAA,KAIU,SAAA,GAAY,QAAA,CAAS,MAAA;AAAA,UAiDhB,wBAAA,SAAiC,kBAAA;EAChD,SAAA,EAAW,sBAAA;EAtDN;EAwDL,QAAA,EAAU,QAAA,CAAS,QAAA;EACnB,UAAA;EACA,SAAA;EACA,kBAAA,GAAqB,sBAAA;EACrB,6BAAA,IAAiC,IAAA,EAAM,SAAA,KAAc,SAAA;AAAA;;;;;;;;;;;;;;cAgB1C,mBAAA,SAA4B,aAAA;EAAA,OAChC,OAAA,CAAA;EAIP,YAAA;EAAA,QAEQ,SAAA;EAAA,QAEA,QAAA;EAAA,QAEA,UAAA;EAAA,QAEA,SAAA;EAER,kBAAA,EAAoB,sBAAA;EAEpB,6BAAA,GAAgC,wBAAA;EAEhC,WAAA,CAAY,MAAA,EAAQ,wBAAA;EAAA,OAUb,OAAA,CACL,MAAA,EAAQ,IAAA,CAAK,wBAAA;IACX,GAAA,EAAK,0BAAA;IACL,MAAA,GAAS,kBAAA;EAAA,IAEV,mBAAA;EAAA,QAeW,gBAAA;EAAA,QAgBA,kBAAA;EAAA,QAeN,YAAA;EAcF,qBAAA,CACJ,QAAA,UACA,UAAA,GAAa,8BAAA,GACZ,OAAA,CAAQ,QAAA;AAAA"}
+{"version":3,"file":"multi_query.d.cts","names":[],"sources":["../../src/retrievers/multi_query.ts"],"mappings":";;;;;;;;UAaU;EACR;;KAIU,YAAY,SAAS;UAiDhB,iCAAiC;EAChD,WAAW;;EAEX,UAAU,SAAS;EACnB;EACA;EACA,qBAAqB;EACrB,iCAAiC,MAAM,cAAc;;;;;;;;;;;;;;;cAgB1C,4BAA4B;SAChC;EAIP;UAEQ;UAEA;UAEA;UAEA;EAER,oBAAoB;EAEpB,gCAAgC;EAEhC,YAAY,QAAQ;SAUb,QACL,QAAQ,KAAK;IACX,KAAK;IACL,SAAS;MAEV;UAeW;UAgBA;UAeN;EAcF,sBACJ,kBACA,aAAa,iCACZ,QAAQ"}

package/dist/retrievers/multi_query.d.ts

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

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

@@ -1 +1 @@
-{"version":3,"file":"multi_query.d.ts","names":[],"sources":["../../src/retrievers/multi_query.ts"],"mappings":";;;;;;;;;UAaU,QAAA;EACR,KAAA;AAAA;AAAA,KAIU,SAAA,GAAY,QAAA,CAAS,MAAA;AAAA,UAiDhB,wBAAA,SAAiC,kBAAA;EAChD,SAAA,EAAW,sBAAA;EAtDN;EAwDL,QAAA,EAAU,QAAA,CAAS,QAAA;EACnB,UAAA;EACA,SAAA;EACA,kBAAA,GAAqB,sBAAA;EACrB,6BAAA,IAAiC,IAAA,EAAM,SAAA,KAAc,SAAA;AAAA;;;;;;;;;;;;;;cAgB1C,mBAAA,SAA4B,aAAA;EAAA,OAChC,OAAA,CAAA;EAIP,YAAA;EAAA,QAEQ,SAAA;EAAA,QAEA,QAAA;EAAA,QAEA,UAAA;EAAA,QAEA,SAAA;EAER,kBAAA,EAAoB,sBAAA;EAEpB,6BAAA,GAAgC,wBAAA;EAEhC,WAAA,CAAY,MAAA,EAAQ,wBAAA;EAAA,OAUb,OAAA,CACL,MAAA,EAAQ,IAAA,CAAK,wBAAA;IACX,GAAA,EAAK,0BAAA;IACL,MAAA,GAAS,kBAAA;EAAA,IAEV,mBAAA;EAAA,QAeW,gBAAA;EAAA,QAgBA,kBAAA;EAAA,QAeN,YAAA;EAcF,qBAAA,CACJ,QAAA,UACA,UAAA,GAAa,8BAAA,GACZ,OAAA,CAAQ,QAAA;AAAA"}
+{"version":3,"file":"multi_query.d.ts","names":[],"sources":["../../src/retrievers/multi_query.ts"],"mappings":";;;;;;;;UAaU;EACR;;KAIU,YAAY,SAAS;UAiDhB,iCAAiC;EAChD,WAAW;;EAEX,UAAU,SAAS;EACnB;EACA;EACA,qBAAqB;EACrB,iCAAiC,MAAM,cAAc;;;;;;;;;;;;;;;cAgB1C,4BAA4B;SAChC;EAIP;UAEQ;UAEA;UAEA;UAEA;EAER,oBAAoB;EAEpB,gCAAgC;EAEhC,YAAY,QAAQ;SAUb,QACL,QAAQ,KAAK;IACX,KAAK;IACL,SAAS;MAEV;UAeW;UAgBA;UAeN;EAcF,sBACJ,kBACA,aAAa,iCACZ,QAAQ"}

package/dist/retrievers/multi_query.js

@@ -25,7 +25,7 @@ var LineListOutputParser = class extends BaseOutputParser {
 		throw new Error("Not implemented.");
 	}
 };
-const DEFAULT_QUERY_PROMPT = /* @__PURE__ */ new PromptTemplate({
+const DEFAULT_QUERY_PROMPT = /* #__PURE__ */ new 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.js.map

@@ -1 +1 @@
-{"version":3,"file":"multi_query.js","names":[],"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,cAAmC,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,IAAI,eAAe;CAC9D,gBAAgB,CAAC,YAAY,aAAa;CAC1C,UAAU;;;;;;;;;;;;;;;;CAgBX,CAAC;;;;;;;;;;;;;;AAyBF,IAAa,sBAAb,cAAyC,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,IAAI,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.js","names":[],"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,cAAmC,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,IAAI,eAAe;CAC9D,gBAAgB,CAAC,YAAY,YAAY;CACzC,UAAU;;;;;;;;;;;;;;;;AAgBZ,CAAC;;;;;;;;;;;;;;AAyBD,IAAa,sBAAb,cAAyC,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,IAAI,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_vector.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"multi_vector.cjs","names":["BaseRetriever","createDocumentStoreFromByteStore"],"sources":["../../src/retrievers/multi_vector.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport { BaseStore, type BaseStoreInterface } from \"@langchain/core/stores\";\nimport { createDocumentStoreFromByteStore } from \"../storage/encoder_backed.js\";\n\n/**\n * Arguments for the MultiVectorRetriever class.\n */\nexport interface MultiVectorRetrieverInput extends BaseRetrieverInput {\n  vectorstore: VectorStoreInterface;\n  /** @deprecated Prefer `byteStore`. */\n  docstore?: BaseStoreInterface<string, Document>;\n  byteStore?: BaseStore<string, Uint8Array>;\n  idKey?: string;\n  childK?: number;\n  parentK?: number;\n}\n\n/**\n * A retriever that retrieves documents from a vector store and a document\n * store. It uses the vector store to find relevant documents based on a\n * query, and then retrieves the full documents from the document store.\n * @example\n * ```typescript\n * const retriever = new MultiVectorRetriever({\n *   vectorstore: new FaissStore(),\n *   byteStore: new InMemoryStore<Unit8Array>(),\n *   idKey: \"doc_id\",\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const retrieverResult = await retriever.invoke(\"justice breyer\");\n * console.log(retrieverResult[0].pageContent.length);\n * ```\n */\nexport class MultiVectorRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"MultiVectorRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multi_vector\"];\n\n  public vectorstore: VectorStoreInterface;\n\n  public docstore: BaseStoreInterface<string, Document>;\n\n  protected idKey: string;\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  constructor(args: MultiVectorRetrieverInput) {\n    super(args);\n    this.vectorstore = args.vectorstore;\n    if (args.byteStore) {\n      this.docstore = createDocumentStoreFromByteStore(args.byteStore);\n    } else if (args.docstore) {\n      this.docstore = args.docstore;\n    } else {\n      throw new Error(\n        \"byteStore and docstore are undefined. Please provide at least one.\"\n      );\n    }\n    this.idKey = args.idKey ?? \"doc_id\";\n    this.childK = args.childK;\n    this.parentK = args.parentK;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    const subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    const ids: string[] = [];\n    for (const doc of subDocs) {\n      if (doc.metadata[this.idKey] && !ids.includes(doc.metadata[this.idKey])) {\n        ids.push(doc.metadata[this.idKey]);\n      }\n    }\n    const docs = await this.docstore.mget(ids);\n    return docs\n      .filter((doc) => doc !== undefined)\n      .slice(0, this.parentK) as Document[];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAwCA,IAAa,uBAAb,cAA0CA,2BAAAA,cAAc;CACtD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAe;CAE1D;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY,MAAiC;AAC3C,QAAM,KAAK;AACX,OAAK,cAAc,KAAK;AACxB,MAAI,KAAK,UACP,MAAK,WAAWC,+BAAAA,iCAAiC,KAAK,UAAU;WACvD,KAAK,SACd,MAAK,WAAW,KAAK;MAErB,OAAM,IAAI,MACR,qEACD;AAEH,OAAK,QAAQ,KAAK,SAAS;AAC3B,OAAK,SAAS,KAAK;AACnB,OAAK,UAAU,KAAK;;CAGtB,MAAM,sBAAsB,OAAoC;EAC9D,MAAM,UAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,OAAO;EAC3E,MAAM,MAAgB,EAAE;AACxB,OAAK,MAAM,OAAO,QAChB,KAAI,IAAI,SAAS,KAAK,UAAU,CAAC,IAAI,SAAS,IAAI,SAAS,KAAK,OAAO,CACrE,KAAI,KAAK,IAAI,SAAS,KAAK,OAAO;AAItC,UAAO,MADY,KAAK,SAAS,KAAK,IAAI,EAEvC,QAAQ,QAAQ,QAAQ,KAAA,EAAU,CAClC,MAAM,GAAG,KAAK,QAAQ"}
+{"version":3,"file":"multi_vector.cjs","names":["BaseRetriever","createDocumentStoreFromByteStore"],"sources":["../../src/retrievers/multi_vector.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport { BaseStore, type BaseStoreInterface } from \"@langchain/core/stores\";\nimport { createDocumentStoreFromByteStore } from \"../storage/encoder_backed.js\";\n\n/**\n * Arguments for the MultiVectorRetriever class.\n */\nexport interface MultiVectorRetrieverInput extends BaseRetrieverInput {\n  vectorstore: VectorStoreInterface;\n  /** @deprecated Prefer `byteStore`. */\n  docstore?: BaseStoreInterface<string, Document>;\n  byteStore?: BaseStore<string, Uint8Array>;\n  idKey?: string;\n  childK?: number;\n  parentK?: number;\n}\n\n/**\n * A retriever that retrieves documents from a vector store and a document\n * store. It uses the vector store to find relevant documents based on a\n * query, and then retrieves the full documents from the document store.\n * @example\n * ```typescript\n * const retriever = new MultiVectorRetriever({\n *   vectorstore: new FaissStore(),\n *   byteStore: new InMemoryStore<Unit8Array>(),\n *   idKey: \"doc_id\",\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const retrieverResult = await retriever.invoke(\"justice breyer\");\n * console.log(retrieverResult[0].pageContent.length);\n * ```\n */\nexport class MultiVectorRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"MultiVectorRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multi_vector\"];\n\n  public vectorstore: VectorStoreInterface;\n\n  public docstore: BaseStoreInterface<string, Document>;\n\n  protected idKey: string;\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  constructor(args: MultiVectorRetrieverInput) {\n    super(args);\n    this.vectorstore = args.vectorstore;\n    if (args.byteStore) {\n      this.docstore = createDocumentStoreFromByteStore(args.byteStore);\n    } else if (args.docstore) {\n      this.docstore = args.docstore;\n    } else {\n      throw new Error(\n        \"byteStore and docstore are undefined. Please provide at least one.\"\n      );\n    }\n    this.idKey = args.idKey ?? \"doc_id\";\n    this.childK = args.childK;\n    this.parentK = args.parentK;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    const subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    const ids: string[] = [];\n    for (const doc of subDocs) {\n      if (doc.metadata[this.idKey] && !ids.includes(doc.metadata[this.idKey])) {\n        ids.push(doc.metadata[this.idKey]);\n      }\n    }\n    const docs = await this.docstore.mget(ids);\n    return docs\n      .filter((doc) => doc !== undefined)\n      .slice(0, this.parentK) as Document[];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;AAwCA,IAAa,uBAAb,cAA0CA,2BAAAA,cAAc;CACtD,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAc;CAEzD;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY,MAAiC;EAC3C,MAAM,IAAI;EACV,KAAK,cAAc,KAAK;EACxB,IAAI,KAAK,WACP,KAAK,WAAWC,+BAAAA,iCAAiC,KAAK,SAAS;OAC1D,IAAI,KAAK,UACd,KAAK,WAAW,KAAK;OAErB,MAAM,IAAI,MACR,oEACF;EAEF,KAAK,QAAQ,KAAK,SAAS;EAC3B,KAAK,SAAS,KAAK;EACnB,KAAK,UAAU,KAAK;CACtB;CAEA,MAAM,sBAAsB,OAAoC;EAC9D,MAAM,UAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,MAAM;EAC1E,MAAM,MAAgB,CAAC;EACvB,KAAK,MAAM,OAAO,SAChB,IAAI,IAAI,SAAS,KAAK,UAAU,CAAC,IAAI,SAAS,IAAI,SAAS,KAAK,MAAM,GACpE,IAAI,KAAK,IAAI,SAAS,KAAK,MAAM;EAIrC,QAAO,MADY,KAAK,SAAS,KAAK,GAAG,EAAA,CAEtC,QAAQ,QAAQ,QAAQ,KAAA,CAAS,CAAC,CAClC,MAAM,GAAG,KAAK,OAAO;CAC1B;AACF"}

package/dist/retrievers/multi_vector.d.cts

@@ -2,7 +2,6 @@ import { VectorStoreInterface } from "@langchain/core/vectorstores";
 import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
 import { Document } from "@langchain/core/documents";
 import { BaseStore, BaseStoreInterface } from "@langchain/core/stores";
-
 //#region src/retrievers/multi_vector.d.ts
 /**
  * Arguments for the MultiVectorRetriever class.

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

@@ -1 +1 @@
-{"version":3,"file":"multi_vector.d.cts","names":[],"sources":["../../src/retrievers/multi_vector.ts"],"mappings":";;;;;;;;AAYA;UAAiB,yBAAA,SAAkC,kBAAA;EACjD,WAAA,EAAa,oBAAA;EAAA;EAEb,QAAA,GAAW,kBAAA,SAA2B,QAAA;EACtC,SAAA,GAAY,SAAA,SAAkB,UAAA;EAC9B,KAAA;EACA,MAAA;EACA,OAAA;AAAA;;;;;;;;;;;;;;;;AAqBF;;;cAAa,oBAAA,SAA6B,aAAA;EAAA,OACjC,OAAA,CAAA;EAIP,YAAA;EAEO,WAAA,EAAa,oBAAA;EAEb,QAAA,EAAU,kBAAA,SAA2B,QAAA;EAAA,UAElC,KAAA;EAAA,UAEA,MAAA;EAAA,UAEA,OAAA;EAEV,WAAA,CAAY,IAAA,EAAM,yBAAA;EAiBZ,qBAAA,CAAsB,KAAA,WAAgB,OAAA,CAAQ,QAAA;AAAA"}
+{"version":3,"file":"multi_vector.d.cts","names":[],"sources":["../../src/retrievers/multi_vector.ts"],"mappings":";;;;;;;;UAYiB,kCAAkC;EACjD,aAAa;;EAEb,WAAW,2BAA2B;EACtC,YAAY,kBAAkB;EAC9B;EACA;EACA;;;;;;;;;;;;;;;;;;;;cAqBW,6BAA6B;SACjC;EAIP;EAEO,aAAa;EAEb,UAAU,2BAA2B;YAElC;YAEA;YAEA;EAEV,YAAY,MAAM;EAiBZ,sBAAsB,gBAAgB,QAAQ"}

package/dist/retrievers/multi_vector.d.ts

@@ -2,7 +2,6 @@ import { Document } from "@langchain/core/documents";
 import { BaseStore, BaseStoreInterface } from "@langchain/core/stores";
 import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
 import { VectorStoreInterface } from "@langchain/core/vectorstores";
-
 //#region src/retrievers/multi_vector.d.ts
 /**
  * Arguments for the MultiVectorRetriever class.

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

@@ -1 +1 @@
-{"version":3,"file":"multi_vector.d.ts","names":[],"sources":["../../src/retrievers/multi_vector.ts"],"mappings":";;;;;;;;AAYA;UAAiB,yBAAA,SAAkC,kBAAA;EACjD,WAAA,EAAa,oBAAA;EAAA;EAEb,QAAA,GAAW,kBAAA,SAA2B,QAAA;EACtC,SAAA,GAAY,SAAA,SAAkB,UAAA;EAC9B,KAAA;EACA,MAAA;EACA,OAAA;AAAA;;;;;;;;;;;;;;;;AAqBF;;;cAAa,oBAAA,SAA6B,aAAA;EAAA,OACjC,OAAA,CAAA;EAIP,YAAA;EAEO,WAAA,EAAa,oBAAA;EAEb,QAAA,EAAU,kBAAA,SAA2B,QAAA;EAAA,UAElC,KAAA;EAAA,UAEA,MAAA;EAAA,UAEA,OAAA;EAEV,WAAA,CAAY,IAAA,EAAM,yBAAA;EAiBZ,qBAAA,CAAsB,KAAA,WAAgB,OAAA,CAAQ,QAAA;AAAA"}
+{"version":3,"file":"multi_vector.d.ts","names":[],"sources":["../../src/retrievers/multi_vector.ts"],"mappings":";;;;;;;;UAYiB,kCAAkC;EACjD,aAAa;;EAEb,WAAW,2BAA2B;EACtC,YAAY,kBAAkB;EAC9B;EACA;EACA;;;;;;;;;;;;;;;;;;;;cAqBW,6BAA6B;SACjC;EAIP;EAEO,aAAa;EAEb,UAAU,2BAA2B;YAElC;YAEA;YAEA;EAEV,YAAY,MAAM;EAiBZ,sBAAsB,gBAAgB,QAAQ"}

package/dist/retrievers/multi_vector.js.map

@@ -1 +1 @@
-{"version":3,"file":"multi_vector.js","names":[],"sources":["../../src/retrievers/multi_vector.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport { BaseStore, type BaseStoreInterface } from \"@langchain/core/stores\";\nimport { createDocumentStoreFromByteStore } from \"../storage/encoder_backed.js\";\n\n/**\n * Arguments for the MultiVectorRetriever class.\n */\nexport interface MultiVectorRetrieverInput extends BaseRetrieverInput {\n  vectorstore: VectorStoreInterface;\n  /** @deprecated Prefer `byteStore`. */\n  docstore?: BaseStoreInterface<string, Document>;\n  byteStore?: BaseStore<string, Uint8Array>;\n  idKey?: string;\n  childK?: number;\n  parentK?: number;\n}\n\n/**\n * A retriever that retrieves documents from a vector store and a document\n * store. It uses the vector store to find relevant documents based on a\n * query, and then retrieves the full documents from the document store.\n * @example\n * ```typescript\n * const retriever = new MultiVectorRetriever({\n *   vectorstore: new FaissStore(),\n *   byteStore: new InMemoryStore<Unit8Array>(),\n *   idKey: \"doc_id\",\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const retrieverResult = await retriever.invoke(\"justice breyer\");\n * console.log(retrieverResult[0].pageContent.length);\n * ```\n */\nexport class MultiVectorRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"MultiVectorRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multi_vector\"];\n\n  public vectorstore: VectorStoreInterface;\n\n  public docstore: BaseStoreInterface<string, Document>;\n\n  protected idKey: string;\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  constructor(args: MultiVectorRetrieverInput) {\n    super(args);\n    this.vectorstore = args.vectorstore;\n    if (args.byteStore) {\n      this.docstore = createDocumentStoreFromByteStore(args.byteStore);\n    } else if (args.docstore) {\n      this.docstore = args.docstore;\n    } else {\n      throw new Error(\n        \"byteStore and docstore are undefined. Please provide at least one.\"\n      );\n    }\n    this.idKey = args.idKey ?? \"doc_id\";\n    this.childK = args.childK;\n    this.parentK = args.parentK;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    const subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    const ids: string[] = [];\n    for (const doc of subDocs) {\n      if (doc.metadata[this.idKey] && !ids.includes(doc.metadata[this.idKey])) {\n        ids.push(doc.metadata[this.idKey]);\n      }\n    }\n    const docs = await this.docstore.mget(ids);\n    return docs\n      .filter((doc) => doc !== undefined)\n      .slice(0, this.parentK) as Document[];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAwCA,IAAa,uBAAb,cAA0C,cAAc;CACtD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAe;CAE1D;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY,MAAiC;AAC3C,QAAM,KAAK;AACX,OAAK,cAAc,KAAK;AACxB,MAAI,KAAK,UACP,MAAK,WAAW,iCAAiC,KAAK,UAAU;WACvD,KAAK,SACd,MAAK,WAAW,KAAK;MAErB,OAAM,IAAI,MACR,qEACD;AAEH,OAAK,QAAQ,KAAK,SAAS;AAC3B,OAAK,SAAS,KAAK;AACnB,OAAK,UAAU,KAAK;;CAGtB,MAAM,sBAAsB,OAAoC;EAC9D,MAAM,UAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,OAAO;EAC3E,MAAM,MAAgB,EAAE;AACxB,OAAK,MAAM,OAAO,QAChB,KAAI,IAAI,SAAS,KAAK,UAAU,CAAC,IAAI,SAAS,IAAI,SAAS,KAAK,OAAO,CACrE,KAAI,KAAK,IAAI,SAAS,KAAK,OAAO;AAItC,UAAO,MADY,KAAK,SAAS,KAAK,IAAI,EAEvC,QAAQ,QAAQ,QAAQ,KAAA,EAAU,CAClC,MAAM,GAAG,KAAK,QAAQ"}
+{"version":3,"file":"multi_vector.js","names":[],"sources":["../../src/retrievers/multi_vector.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport { BaseStore, type BaseStoreInterface } from \"@langchain/core/stores\";\nimport { createDocumentStoreFromByteStore } from \"../storage/encoder_backed.js\";\n\n/**\n * Arguments for the MultiVectorRetriever class.\n */\nexport interface MultiVectorRetrieverInput extends BaseRetrieverInput {\n  vectorstore: VectorStoreInterface;\n  /** @deprecated Prefer `byteStore`. */\n  docstore?: BaseStoreInterface<string, Document>;\n  byteStore?: BaseStore<string, Uint8Array>;\n  idKey?: string;\n  childK?: number;\n  parentK?: number;\n}\n\n/**\n * A retriever that retrieves documents from a vector store and a document\n * store. It uses the vector store to find relevant documents based on a\n * query, and then retrieves the full documents from the document store.\n * @example\n * ```typescript\n * const retriever = new MultiVectorRetriever({\n *   vectorstore: new FaissStore(),\n *   byteStore: new InMemoryStore<Unit8Array>(),\n *   idKey: \"doc_id\",\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const retrieverResult = await retriever.invoke(\"justice breyer\");\n * console.log(retrieverResult[0].pageContent.length);\n * ```\n */\nexport class MultiVectorRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"MultiVectorRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"multi_vector\"];\n\n  public vectorstore: VectorStoreInterface;\n\n  public docstore: BaseStoreInterface<string, Document>;\n\n  protected idKey: string;\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  constructor(args: MultiVectorRetrieverInput) {\n    super(args);\n    this.vectorstore = args.vectorstore;\n    if (args.byteStore) {\n      this.docstore = createDocumentStoreFromByteStore(args.byteStore);\n    } else if (args.docstore) {\n      this.docstore = args.docstore;\n    } else {\n      throw new Error(\n        \"byteStore and docstore are undefined. Please provide at least one.\"\n      );\n    }\n    this.idKey = args.idKey ?? \"doc_id\";\n    this.childK = args.childK;\n    this.parentK = args.parentK;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    const subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    const ids: string[] = [];\n    for (const doc of subDocs) {\n      if (doc.metadata[this.idKey] && !ids.includes(doc.metadata[this.idKey])) {\n        ids.push(doc.metadata[this.idKey]);\n      }\n    }\n    const docs = await this.docstore.mget(ids);\n    return docs\n      .filter((doc) => doc !== undefined)\n      .slice(0, this.parentK) as Document[];\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAwCA,IAAa,uBAAb,cAA0C,cAAc;CACtD,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAc;CAEzD;CAEA;CAEA;CAEA;CAEA;CAEA,YAAY,MAAiC;EAC3C,MAAM,IAAI;EACV,KAAK,cAAc,KAAK;EACxB,IAAI,KAAK,WACP,KAAK,WAAW,iCAAiC,KAAK,SAAS;OAC1D,IAAI,KAAK,UACd,KAAK,WAAW,KAAK;OAErB,MAAM,IAAI,MACR,oEACF;EAEF,KAAK,QAAQ,KAAK,SAAS;EAC3B,KAAK,SAAS,KAAK;EACnB,KAAK,UAAU,KAAK;CACtB;CAEA,MAAM,sBAAsB,OAAoC;EAC9D,MAAM,UAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,MAAM;EAC1E,MAAM,MAAgB,CAAC;EACvB,KAAK,MAAM,OAAO,SAChB,IAAI,IAAI,SAAS,KAAK,UAAU,CAAC,IAAI,SAAS,IAAI,SAAS,KAAK,MAAM,GACpE,IAAI,KAAK,IAAI,SAAS,KAAK,MAAM;EAIrC,QAAO,MADY,KAAK,SAAS,KAAK,GAAG,EAAA,CAEtC,QAAQ,QAAQ,QAAQ,KAAA,CAAS,CAAC,CAClC,MAAM,GAAG,KAAK,OAAO;CAC1B;AACF"}

package/dist/retrievers/parent_document.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"parent_document.cjs","names":["MultiVectorRetriever","uuid","Document"],"sources":["../../src/retrievers/parent_document.ts"],"sourcesContent":["import * as uuid from \"@langchain/core/utils/uuid\";\n\nimport {\n  type VectorStoreInterface,\n  type VectorStoreRetrieverInterface,\n} from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport {\n  TextSplitter,\n  TextSplitterChunkHeaderOptions,\n} from \"@langchain/textsplitters\";\nimport type { BaseDocumentCompressor } from \"./document_compressors/index.js\";\nimport {\n  MultiVectorRetriever,\n  type MultiVectorRetrieverInput,\n} from \"./multi_vector.js\";\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport type SubDocs = Document<Record<string, any>>[];\n\n/**\n * Interface for the fields required to initialize a\n * ParentDocumentRetriever instance.\n */\nexport type ParentDocumentRetrieverFields = MultiVectorRetrieverInput & {\n  childSplitter: TextSplitter;\n  parentSplitter?: TextSplitter;\n  /**\n   * A custom retriever to use when retrieving instead of\n   * the `.similaritySearch` method of the vectorstore.\n   */\n  childDocumentRetriever?: VectorStoreRetrieverInterface<VectorStoreInterface>;\n  documentCompressor?: BaseDocumentCompressor | undefined;\n  documentCompressorFilteringFn?: (docs: SubDocs) => SubDocs;\n};\n\n/**\n * A type of document retriever that splits input documents into smaller chunks\n * while separately storing and preserving the original documents.\n * The small chunks are embedded, then on retrieval, the original\n * \"parent\" documents are retrieved.\n *\n * This strikes a balance between better targeted retrieval with small documents\n * and the more context-rich larger documents.\n * @example\n * ```typescript\n * const retriever = new ParentDocumentRetriever({\n *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   byteStore: new InMemoryStore<Uint8Array>(),\n *   parentSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 500,\n *   }),\n *   childSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 50,\n *   }),\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const parentDocuments = await getDocuments();\n * await retriever.addDocuments(parentDocuments);\n * const retrievedDocs = await retriever.invoke(\"justice breyer\");\n * ```\n */\nexport class ParentDocumentRetriever extends MultiVectorRetriever {\n  static lc_name() {\n    return \"ParentDocumentRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"parent_document\"];\n\n  vectorstore: VectorStoreInterface;\n\n  protected childSplitter: TextSplitter;\n\n  protected parentSplitter?: TextSplitter;\n\n  protected idKey = \"doc_id\";\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  childDocumentRetriever:\n    | VectorStoreRetrieverInterface<VectorStoreInterface>\n    | undefined;\n\n  documentCompressor: BaseDocumentCompressor | undefined;\n\n  documentCompressorFilteringFn?: ParentDocumentRetrieverFields[\"documentCompressorFilteringFn\"];\n\n  constructor(fields: ParentDocumentRetrieverFields) {\n    super(fields);\n    this.vectorstore = fields.vectorstore;\n    this.childSplitter = fields.childSplitter;\n    this.parentSplitter = fields.parentSplitter;\n    this.idKey = fields.idKey ?? this.idKey;\n    this.childK = fields.childK;\n    this.parentK = fields.parentK;\n    this.childDocumentRetriever = fields.childDocumentRetriever;\n    this.documentCompressor = fields.documentCompressor;\n    this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    let subDocs: SubDocs = [];\n    if (this.childDocumentRetriever) {\n      subDocs = await this.childDocumentRetriever.invoke(query);\n    } else {\n      subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    }\n\n    if (this.documentCompressor && subDocs.length) {\n      subDocs = await this.documentCompressor.compressDocuments(subDocs, query);\n      if (this.documentCompressorFilteringFn) {\n        subDocs = this.documentCompressorFilteringFn(subDocs);\n      }\n    }\n\n    // Maintain order\n    const parentDocIds: string[] = [];\n    for (const doc of subDocs) {\n      if (!parentDocIds.includes(doc.metadata[this.idKey])) {\n        parentDocIds.push(doc.metadata[this.idKey]);\n      }\n    }\n    const parentDocs: Document[] = [];\n    const storedParentDocs = await this.docstore.mget(parentDocIds);\n    const retrievedDocs: Document[] = storedParentDocs.filter(\n      (doc?: Document): doc is Document => doc !== undefined\n    );\n    parentDocs.push(...retrievedDocs);\n    return parentDocs.slice(0, this.parentK);\n  }\n\n  async _storeDocuments(\n    parentDoc: Record<string, Document>,\n    childDocs: Document[],\n    addToDocstore: boolean\n  ) {\n    if (this.childDocumentRetriever) {\n      await this.childDocumentRetriever.addDocuments(childDocs);\n    } else {\n      await this.vectorstore.addDocuments(childDocs);\n    }\n    if (addToDocstore) {\n      await this.docstore.mset(Object.entries(parentDoc));\n    }\n  }\n\n  /**\n   * Adds documents to the docstore and vectorstores.\n   * If a retriever is provided, it will be used to add documents instead of the vectorstore.\n   * @param docs The documents to add\n   * @param config.ids Optional list of ids for documents. If provided should be the same\n   *   length as the list of documents. Can provided if parent documents\n   *   are already in the document store and you don't want to re-add\n   *   to the docstore. If not provided, random UUIDs will be used as ids.\n   * @param config.addToDocstore Boolean of whether to add documents to docstore.\n   * This can be false if and only if `ids` are provided. You may want\n   *   to set this to False if the documents are already in the docstore\n   *   and you don't want to re-add them.\n   * @param config.chunkHeaderOptions Object with options for adding Contextual chunk headers\n   */\n  async addDocuments(\n    docs: Document[],\n    config?: {\n      ids?: string[];\n      addToDocstore?: boolean;\n      childDocChunkHeaderOptions?: TextSplitterChunkHeaderOptions;\n    }\n  ): Promise<void> {\n    const {\n      ids,\n      addToDocstore = true,\n      childDocChunkHeaderOptions = {},\n    } = config ?? {};\n    const parentDocs = this.parentSplitter\n      ? await this.parentSplitter.splitDocuments(docs)\n      : docs;\n    let parentDocIds;\n    if (ids === undefined) {\n      if (!addToDocstore) {\n        throw new Error(\n          `If ids are not passed in, \"config.addToDocstore\" MUST be true`\n        );\n      }\n      parentDocIds = parentDocs.map((_doc: Document) => uuid.v4());\n    } else {\n      parentDocIds = ids;\n    }\n    if (parentDocs.length !== parentDocIds.length) {\n      throw new Error(\n        `Got uneven list of documents and ids.\\nIf \"ids\" is provided, should be same length as \"documents\".`\n      );\n    }\n    for (let i = 0; i < parentDocs.length; i += 1) {\n      const parentDoc = parentDocs[i];\n      const parentDocId = parentDocIds[i];\n      const subDocs = await this.childSplitter.splitDocuments(\n        [parentDoc],\n        childDocChunkHeaderOptions\n      );\n      const taggedSubDocs = subDocs.map(\n        (subDoc: Document) =>\n          new Document({\n            pageContent: subDoc.pageContent,\n            metadata: { ...subDoc.metadata, [this.idKey]: parentDocId },\n          })\n      );\n      await this._storeDocuments(\n        { [parentDocId]: parentDoc },\n        taggedSubDocs,\n        addToDocstore\n      );\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEA,IAAa,0BAAb,cAA6CA,gCAAAA,qBAAqB;CAChE,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAkB;CAE7D;CAEA;CAEA;CAEA,QAAkB;CAElB;CAEA;CAEA;CAIA;CAEA;CAEA,YAAY,QAAuC;AACjD,QAAM,OAAO;AACb,OAAK,cAAc,OAAO;AAC1B,OAAK,gBAAgB,OAAO;AAC5B,OAAK,iBAAiB,OAAO;AAC7B,OAAK,QAAQ,OAAO,SAAS,KAAK;AAClC,OAAK,SAAS,OAAO;AACrB,OAAK,UAAU,OAAO;AACtB,OAAK,yBAAyB,OAAO;AACrC,OAAK,qBAAqB,OAAO;AACjC,OAAK,gCAAgC,OAAO;;CAG9C,MAAM,sBAAsB,OAAoC;EAC9D,IAAI,UAAmB,EAAE;AACzB,MAAI,KAAK,uBACP,WAAU,MAAM,KAAK,uBAAuB,OAAO,MAAM;MAEzD,WAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,OAAO;AAGvE,MAAI,KAAK,sBAAsB,QAAQ,QAAQ;AAC7C,aAAU,MAAM,KAAK,mBAAmB,kBAAkB,SAAS,MAAM;AACzE,OAAI,KAAK,8BACP,WAAU,KAAK,8BAA8B,QAAQ;;EAKzD,MAAM,eAAyB,EAAE;AACjC,OAAK,MAAM,OAAO,QAChB,KAAI,CAAC,aAAa,SAAS,IAAI,SAAS,KAAK,OAAO,CAClD,cAAa,KAAK,IAAI,SAAS,KAAK,OAAO;EAG/C,MAAM,aAAyB,EAAE;EAEjC,MAAM,iBAA4B,MADH,KAAK,SAAS,KAAK,aAAa,EACZ,QAChD,QAAoC,QAAQ,KAAA,EAC9C;AACD,aAAW,KAAK,GAAG,cAAc;AACjC,SAAO,WAAW,MAAM,GAAG,KAAK,QAAQ;;CAG1C,MAAM,gBACJ,WACA,WACA,eACA;AACA,MAAI,KAAK,uBACP,OAAM,KAAK,uBAAuB,aAAa,UAAU;MAEzD,OAAM,KAAK,YAAY,aAAa,UAAU;AAEhD,MAAI,cACF,OAAM,KAAK,SAAS,KAAK,OAAO,QAAQ,UAAU,CAAC;;;;;;;;;;;;;;;;CAkBvD,MAAM,aACJ,MACA,QAKe;EACf,MAAM,EACJ,KACA,gBAAgB,MAChB,6BAA6B,EAAE,KAC7B,UAAU,EAAE;EAChB,MAAM,aAAa,KAAK,iBACpB,MAAM,KAAK,eAAe,eAAe,KAAK,GAC9C;EACJ,IAAI;AACJ,MAAI,QAAQ,KAAA,GAAW;AACrB,OAAI,CAAC,cACH,OAAM,IAAI,MACR,gEACD;AAEH,kBAAe,WAAW,KAAK,SAAmBC,2BAAK,IAAI,CAAC;QAE5D,gBAAe;AAEjB,MAAI,WAAW,WAAW,aAAa,OACrC,OAAM,IAAI,MACR,qGACD;AAEH,OAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,GAAG;GAC7C,MAAM,YAAY,WAAW;GAC7B,MAAM,cAAc,aAAa;GAKjC,MAAM,iBAAgB,MAJA,KAAK,cAAc,eACvC,CAAC,UAAU,EACX,2BACD,EAC6B,KAC3B,WACC,IAAIC,0BAAAA,SAAS;IACX,aAAa,OAAO;IACpB,UAAU;KAAE,GAAG,OAAO;MAAW,KAAK,QAAQ;KAAa;IAC5D,CAAC,CACL;AACD,SAAM,KAAK,gBACT,GAAG,cAAc,WAAW,EAC5B,eACA,cACD"}
+{"version":3,"file":"parent_document.cjs","names":["MultiVectorRetriever","uuid","Document"],"sources":["../../src/retrievers/parent_document.ts"],"sourcesContent":["import * as uuid from \"@langchain/core/utils/uuid\";\n\nimport {\n  type VectorStoreInterface,\n  type VectorStoreRetrieverInterface,\n} from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport {\n  TextSplitter,\n  TextSplitterChunkHeaderOptions,\n} from \"@langchain/textsplitters\";\nimport type { BaseDocumentCompressor } from \"./document_compressors/index.js\";\nimport {\n  MultiVectorRetriever,\n  type MultiVectorRetrieverInput,\n} from \"./multi_vector.js\";\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport type SubDocs = Document<Record<string, any>>[];\n\n/**\n * Interface for the fields required to initialize a\n * ParentDocumentRetriever instance.\n */\nexport type ParentDocumentRetrieverFields = MultiVectorRetrieverInput & {\n  childSplitter: TextSplitter;\n  parentSplitter?: TextSplitter;\n  /**\n   * A custom retriever to use when retrieving instead of\n   * the `.similaritySearch` method of the vectorstore.\n   */\n  childDocumentRetriever?: VectorStoreRetrieverInterface<VectorStoreInterface>;\n  documentCompressor?: BaseDocumentCompressor | undefined;\n  documentCompressorFilteringFn?: (docs: SubDocs) => SubDocs;\n};\n\n/**\n * A type of document retriever that splits input documents into smaller chunks\n * while separately storing and preserving the original documents.\n * The small chunks are embedded, then on retrieval, the original\n * \"parent\" documents are retrieved.\n *\n * This strikes a balance between better targeted retrieval with small documents\n * and the more context-rich larger documents.\n * @example\n * ```typescript\n * const retriever = new ParentDocumentRetriever({\n *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   byteStore: new InMemoryStore<Uint8Array>(),\n *   parentSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 500,\n *   }),\n *   childSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 50,\n *   }),\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const parentDocuments = await getDocuments();\n * await retriever.addDocuments(parentDocuments);\n * const retrievedDocs = await retriever.invoke(\"justice breyer\");\n * ```\n */\nexport class ParentDocumentRetriever extends MultiVectorRetriever {\n  static lc_name() {\n    return \"ParentDocumentRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"parent_document\"];\n\n  vectorstore: VectorStoreInterface;\n\n  protected childSplitter: TextSplitter;\n\n  protected parentSplitter?: TextSplitter;\n\n  protected idKey = \"doc_id\";\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  childDocumentRetriever:\n    | VectorStoreRetrieverInterface<VectorStoreInterface>\n    | undefined;\n\n  documentCompressor: BaseDocumentCompressor | undefined;\n\n  documentCompressorFilteringFn?: ParentDocumentRetrieverFields[\"documentCompressorFilteringFn\"];\n\n  constructor(fields: ParentDocumentRetrieverFields) {\n    super(fields);\n    this.vectorstore = fields.vectorstore;\n    this.childSplitter = fields.childSplitter;\n    this.parentSplitter = fields.parentSplitter;\n    this.idKey = fields.idKey ?? this.idKey;\n    this.childK = fields.childK;\n    this.parentK = fields.parentK;\n    this.childDocumentRetriever = fields.childDocumentRetriever;\n    this.documentCompressor = fields.documentCompressor;\n    this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    let subDocs: SubDocs = [];\n    if (this.childDocumentRetriever) {\n      subDocs = await this.childDocumentRetriever.invoke(query);\n    } else {\n      subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    }\n\n    if (this.documentCompressor && subDocs.length) {\n      subDocs = await this.documentCompressor.compressDocuments(subDocs, query);\n      if (this.documentCompressorFilteringFn) {\n        subDocs = this.documentCompressorFilteringFn(subDocs);\n      }\n    }\n\n    // Maintain order\n    const parentDocIds: string[] = [];\n    for (const doc of subDocs) {\n      if (!parentDocIds.includes(doc.metadata[this.idKey])) {\n        parentDocIds.push(doc.metadata[this.idKey]);\n      }\n    }\n    const parentDocs: Document[] = [];\n    const storedParentDocs = await this.docstore.mget(parentDocIds);\n    const retrievedDocs: Document[] = storedParentDocs.filter(\n      (doc?: Document): doc is Document => doc !== undefined\n    );\n    parentDocs.push(...retrievedDocs);\n    return parentDocs.slice(0, this.parentK);\n  }\n\n  async _storeDocuments(\n    parentDoc: Record<string, Document>,\n    childDocs: Document[],\n    addToDocstore: boolean\n  ) {\n    if (this.childDocumentRetriever) {\n      await this.childDocumentRetriever.addDocuments(childDocs);\n    } else {\n      await this.vectorstore.addDocuments(childDocs);\n    }\n    if (addToDocstore) {\n      await this.docstore.mset(Object.entries(parentDoc));\n    }\n  }\n\n  /**\n   * Adds documents to the docstore and vectorstores.\n   * If a retriever is provided, it will be used to add documents instead of the vectorstore.\n   * @param docs The documents to add\n   * @param config.ids Optional list of ids for documents. If provided should be the same\n   *   length as the list of documents. Can provided if parent documents\n   *   are already in the document store and you don't want to re-add\n   *   to the docstore. If not provided, random UUIDs will be used as ids.\n   * @param config.addToDocstore Boolean of whether to add documents to docstore.\n   * This can be false if and only if `ids` are provided. You may want\n   *   to set this to False if the documents are already in the docstore\n   *   and you don't want to re-add them.\n   * @param config.chunkHeaderOptions Object with options for adding Contextual chunk headers\n   */\n  async addDocuments(\n    docs: Document[],\n    config?: {\n      ids?: string[];\n      addToDocstore?: boolean;\n      childDocChunkHeaderOptions?: TextSplitterChunkHeaderOptions;\n    }\n  ): Promise<void> {\n    const {\n      ids,\n      addToDocstore = true,\n      childDocChunkHeaderOptions = {},\n    } = config ?? {};\n    const parentDocs = this.parentSplitter\n      ? await this.parentSplitter.splitDocuments(docs)\n      : docs;\n    let parentDocIds;\n    if (ids === undefined) {\n      if (!addToDocstore) {\n        throw new Error(\n          `If ids are not passed in, \"config.addToDocstore\" MUST be true`\n        );\n      }\n      parentDocIds = parentDocs.map((_doc: Document) => uuid.v4());\n    } else {\n      parentDocIds = ids;\n    }\n    if (parentDocs.length !== parentDocIds.length) {\n      throw new Error(\n        `Got uneven list of documents and ids.\\nIf \"ids\" is provided, should be same length as \"documents\".`\n      );\n    }\n    for (let i = 0; i < parentDocs.length; i += 1) {\n      const parentDoc = parentDocs[i];\n      const parentDocId = parentDocIds[i];\n      const subDocs = await this.childSplitter.splitDocuments(\n        [parentDoc],\n        childDocChunkHeaderOptions\n      );\n      const taggedSubDocs = subDocs.map(\n        (subDoc: Document) =>\n          new Document({\n            pageContent: subDoc.pageContent,\n            metadata: { ...subDoc.metadata, [this.idKey]: parentDocId },\n          })\n      );\n      await this._storeDocuments(\n        { [parentDocId]: parentDoc },\n        taggedSubDocs,\n        addToDocstore\n      );\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEA,IAAa,0BAAb,cAA6CA,gCAAAA,qBAAqB;CAChE,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAiB;CAE5D;CAEA;CAEA;CAEA,QAAkB;CAElB;CAEA;CAEA;CAIA;CAEA;CAEA,YAAY,QAAuC;EACjD,MAAM,MAAM;EACZ,KAAK,cAAc,OAAO;EAC1B,KAAK,gBAAgB,OAAO;EAC5B,KAAK,iBAAiB,OAAO;EAC7B,KAAK,QAAQ,OAAO,SAAS,KAAK;EAClC,KAAK,SAAS,OAAO;EACrB,KAAK,UAAU,OAAO;EACtB,KAAK,yBAAyB,OAAO;EACrC,KAAK,qBAAqB,OAAO;EACjC,KAAK,gCAAgC,OAAO;CAC9C;CAEA,MAAM,sBAAsB,OAAoC;EAC9D,IAAI,UAAmB,CAAC;EACxB,IAAI,KAAK,wBACP,UAAU,MAAM,KAAK,uBAAuB,OAAO,KAAK;OAExD,UAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,MAAM;EAGtE,IAAI,KAAK,sBAAsB,QAAQ,QAAQ;GAC7C,UAAU,MAAM,KAAK,mBAAmB,kBAAkB,SAAS,KAAK;GACxE,IAAI,KAAK,+BACP,UAAU,KAAK,8BAA8B,OAAO;EAExD;EAGA,MAAM,eAAyB,CAAC;EAChC,KAAK,MAAM,OAAO,SAChB,IAAI,CAAC,aAAa,SAAS,IAAI,SAAS,KAAK,MAAM,GACjD,aAAa,KAAK,IAAI,SAAS,KAAK,MAAM;EAG9C,MAAM,aAAyB,CAAC;EAEhC,MAAM,iBAA4B,MADH,KAAK,SAAS,KAAK,YAAY,EAAA,CACX,QAChD,QAAoC,QAAQ,KAAA,CAC/C;EACA,WAAW,KAAK,GAAG,aAAa;EAChC,OAAO,WAAW,MAAM,GAAG,KAAK,OAAO;CACzC;CAEA,MAAM,gBACJ,WACA,WACA,eACA;EACA,IAAI,KAAK,wBACP,MAAM,KAAK,uBAAuB,aAAa,SAAS;OAExD,MAAM,KAAK,YAAY,aAAa,SAAS;EAE/C,IAAI,eACF,MAAM,KAAK,SAAS,KAAK,OAAO,QAAQ,SAAS,CAAC;CAEtD;;;;;;;;;;;;;;;CAgBA,MAAM,aACJ,MACA,QAKe;EACf,MAAM,EACJ,KACA,gBAAgB,MAChB,6BAA6B,CAAC,MAC5B,UAAU,CAAC;EACf,MAAM,aAAa,KAAK,iBACpB,MAAM,KAAK,eAAe,eAAe,IAAI,IAC7C;EACJ,IAAI;EACJ,IAAI,QAAQ,KAAA,GAAW;GACrB,IAAI,CAAC,eACH,MAAM,IAAI,MACR,+DACF;GAEF,eAAe,WAAW,KAAK,SAAmBC,2BAAK,GAAG,CAAC;EAC7D,OACE,eAAe;EAEjB,IAAI,WAAW,WAAW,aAAa,QACrC,MAAM,IAAI,MACR,oGACF;EAEF,KAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,GAAG;GAC7C,MAAM,YAAY,WAAW;GAC7B,MAAM,cAAc,aAAa;GAKjC,MAAM,iBAAgB,MAJA,KAAK,cAAc,eACvC,CAAC,SAAS,GACV,0BACF,EAAA,CAC8B,KAC3B,WACC,IAAIC,0BAAAA,SAAS;IACX,aAAa,OAAO;IACpB,UAAU;KAAE,GAAG,OAAO;MAAW,KAAK,QAAQ;IAAY;GAC5D,CAAC,CACL;GACA,MAAM,KAAK,gBACT,GAAG,cAAc,UAAU,GAC3B,eACA,aACF;EACF;CACF;AACF"}

package/dist/retrievers/parent_document.d.cts

@@ -3,7 +3,6 @@ import { MultiVectorRetriever, MultiVectorRetrieverInput } from "./multi_vector.
 import { VectorStoreInterface, VectorStoreRetrieverInterface } from "@langchain/core/vectorstores";
 import { Document } from "@langchain/core/documents";
 import { TextSplitter, TextSplitterChunkHeaderOptions } from "@langchain/textsplitters";
-
 //#region src/retrievers/parent_document.d.ts
 type SubDocs = Document<Record<string, any>>[];
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"parent_document.d.cts","names":[],"sources":["../../src/retrievers/parent_document.ts"],"mappings":";;;;;;;KAkBY,OAAA,GAAU,QAAA,CAAS,MAAA;;AAA/B;;;KAMY,6BAAA,GAAgC,yBAAA;EAC1C,aAAA,EAAe,YAAA;EACf,cAAA,GAAiB,YAAA;EAFsB;;;;EAOvC,sBAAA,GAAyB,6BAAA,CAA8B,oBAAA;EACvD,kBAAA,GAAqB,sBAAA;EACrB,6BAAA,IAAiC,IAAA,EAAM,OAAA,KAAY,OAAA;AAAA;;;;;;;;;;;;;;;;;;;;;AAiCrD;;;;;;;;;;cAAa,uBAAA,SAAgC,oBAAA;EAAA,OACpC,OAAA,CAAA;EAIP,YAAA;EAEA,WAAA,EAAa,oBAAA;EAAA,UAEH,aAAA,EAAe,YAAA;EAAA,UAEf,cAAA,GAAiB,YAAA;EAAA,UAEjB,KAAA;EAAA,UAEA,MAAA;EAAA,UAEA,OAAA;EAEV,sBAAA,EACI,6BAAA,CAA8B,oBAAA;EAGlC,kBAAA,EAAoB,sBAAA;EAEpB,6BAAA,GAAgC,6BAAA;EAEhC,WAAA,CAAY,MAAA,EAAQ,6BAAA;EAad,qBAAA,CAAsB,KAAA,WAAgB,OAAA,CAAQ,QAAA;EA+B9C,eAAA,CACJ,SAAA,EAAW,MAAA,SAAe,QAAA,GAC1B,SAAA,EAAW,QAAA,IACX,aAAA,YAAsB,OAAA;EArExB;;;;;;;;;;;;;;EA+FM,YAAA,CACJ,IAAA,EAAM,QAAA,IACN,MAAA;IACE,GAAA;IACA,aAAA;IACA,0BAAA,GAA6B,8BAAA;EAAA,IAE9B,OAAA;AAAA"}
+{"version":3,"file":"parent_document.d.cts","names":[],"sources":["../../src/retrievers/parent_document.ts"],"mappings":";;;;;;KAkBY,UAAU,SAAS;;;;;KAMnB,gCAAgC;EAC1C,eAAe;EACf,iBAAiB;;;;;EAKjB,yBAAyB,8BAA8B;EACvD,qBAAqB;EACrB,iCAAiC,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAiCxC,gCAAgC;SACpC;EAIP;EAEA,aAAa;YAEH,eAAe;YAEf,iBAAiB;YAEjB;YAEA;YAEA;EAEV,wBACI,8BAA8B;EAGlC,oBAAoB;EAEpB,gCAAgC;EAEhC,YAAY,QAAQ;EAad,sBAAsB,gBAAgB,QAAQ;EA+B9C,gBACJ,WAAW,eAAe,WAC1B,WAAW,YACX,yBAAsB;;;;;;;;;;;;;;;EA0BlB,aACJ,MAAM,YACN;IACE;IACA;IACA,6BAA6B;MAE9B"}

package/dist/retrievers/parent_document.d.ts

@@ -3,7 +3,6 @@ import { MultiVectorRetriever, MultiVectorRetrieverInput } from "./multi_vector.
 import { TextSplitter, TextSplitterChunkHeaderOptions } from "@langchain/textsplitters";
 import { Document } from "@langchain/core/documents";
 import { VectorStoreInterface, VectorStoreRetrieverInterface } from "@langchain/core/vectorstores";
-
 //#region src/retrievers/parent_document.d.ts
 type SubDocs = Document<Record<string, any>>[];
 /**

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

@@ -1 +1 @@
-{"version":3,"file":"parent_document.d.ts","names":[],"sources":["../../src/retrievers/parent_document.ts"],"mappings":";;;;;;;KAkBY,OAAA,GAAU,QAAA,CAAS,MAAA;;AAA/B;;;KAMY,6BAAA,GAAgC,yBAAA;EAC1C,aAAA,EAAe,YAAA;EACf,cAAA,GAAiB,YAAA;EAFsB;;;;EAOvC,sBAAA,GAAyB,6BAAA,CAA8B,oBAAA;EACvD,kBAAA,GAAqB,sBAAA;EACrB,6BAAA,IAAiC,IAAA,EAAM,OAAA,KAAY,OAAA;AAAA;;;;;;;;;;;;;;;;;;;;;AAiCrD;;;;;;;;;;cAAa,uBAAA,SAAgC,oBAAA;EAAA,OACpC,OAAA,CAAA;EAIP,YAAA;EAEA,WAAA,EAAa,oBAAA;EAAA,UAEH,aAAA,EAAe,YAAA;EAAA,UAEf,cAAA,GAAiB,YAAA;EAAA,UAEjB,KAAA;EAAA,UAEA,MAAA;EAAA,UAEA,OAAA;EAEV,sBAAA,EACI,6BAAA,CAA8B,oBAAA;EAGlC,kBAAA,EAAoB,sBAAA;EAEpB,6BAAA,GAAgC,6BAAA;EAEhC,WAAA,CAAY,MAAA,EAAQ,6BAAA;EAad,qBAAA,CAAsB,KAAA,WAAgB,OAAA,CAAQ,QAAA;EA+B9C,eAAA,CACJ,SAAA,EAAW,MAAA,SAAe,QAAA,GAC1B,SAAA,EAAW,QAAA,IACX,aAAA,YAAsB,OAAA;EArExB;;;;;;;;;;;;;;EA+FM,YAAA,CACJ,IAAA,EAAM,QAAA,IACN,MAAA;IACE,GAAA;IACA,aAAA;IACA,0BAAA,GAA6B,8BAAA;EAAA,IAE9B,OAAA;AAAA"}
+{"version":3,"file":"parent_document.d.ts","names":[],"sources":["../../src/retrievers/parent_document.ts"],"mappings":";;;;;;KAkBY,UAAU,SAAS;;;;;KAMnB,gCAAgC;EAC1C,eAAe;EACf,iBAAiB;;;;;EAKjB,yBAAyB,8BAA8B;EACvD,qBAAqB;EACrB,iCAAiC,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAiCxC,gCAAgC;SACpC;EAIP;EAEA,aAAa;YAEH,eAAe;YAEf,iBAAiB;YAEjB;YAEA;YAEA;EAEV,wBACI,8BAA8B;EAGlC,oBAAoB;EAEpB,gCAAgC;EAEhC,YAAY,QAAQ;EAad,sBAAsB,gBAAgB,QAAQ;EA+B9C,gBACJ,WAAW,eAAe,WAC1B,WAAW,YACX,yBAAsB;;;;;;;;;;;;;;;EA0BlB,aACJ,MAAM,YACN;IACE;IACA;IACA,6BAA6B;MAE9B"}

package/dist/retrievers/parent_document.js.map

@@ -1 +1 @@
-{"version":3,"file":"parent_document.js","names":[],"sources":["../../src/retrievers/parent_document.ts"],"sourcesContent":["import * as uuid from \"@langchain/core/utils/uuid\";\n\nimport {\n  type VectorStoreInterface,\n  type VectorStoreRetrieverInterface,\n} from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport {\n  TextSplitter,\n  TextSplitterChunkHeaderOptions,\n} from \"@langchain/textsplitters\";\nimport type { BaseDocumentCompressor } from \"./document_compressors/index.js\";\nimport {\n  MultiVectorRetriever,\n  type MultiVectorRetrieverInput,\n} from \"./multi_vector.js\";\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport type SubDocs = Document<Record<string, any>>[];\n\n/**\n * Interface for the fields required to initialize a\n * ParentDocumentRetriever instance.\n */\nexport type ParentDocumentRetrieverFields = MultiVectorRetrieverInput & {\n  childSplitter: TextSplitter;\n  parentSplitter?: TextSplitter;\n  /**\n   * A custom retriever to use when retrieving instead of\n   * the `.similaritySearch` method of the vectorstore.\n   */\n  childDocumentRetriever?: VectorStoreRetrieverInterface<VectorStoreInterface>;\n  documentCompressor?: BaseDocumentCompressor | undefined;\n  documentCompressorFilteringFn?: (docs: SubDocs) => SubDocs;\n};\n\n/**\n * A type of document retriever that splits input documents into smaller chunks\n * while separately storing and preserving the original documents.\n * The small chunks are embedded, then on retrieval, the original\n * \"parent\" documents are retrieved.\n *\n * This strikes a balance between better targeted retrieval with small documents\n * and the more context-rich larger documents.\n * @example\n * ```typescript\n * const retriever = new ParentDocumentRetriever({\n *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   byteStore: new InMemoryStore<Uint8Array>(),\n *   parentSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 500,\n *   }),\n *   childSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 50,\n *   }),\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const parentDocuments = await getDocuments();\n * await retriever.addDocuments(parentDocuments);\n * const retrievedDocs = await retriever.invoke(\"justice breyer\");\n * ```\n */\nexport class ParentDocumentRetriever extends MultiVectorRetriever {\n  static lc_name() {\n    return \"ParentDocumentRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"parent_document\"];\n\n  vectorstore: VectorStoreInterface;\n\n  protected childSplitter: TextSplitter;\n\n  protected parentSplitter?: TextSplitter;\n\n  protected idKey = \"doc_id\";\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  childDocumentRetriever:\n    | VectorStoreRetrieverInterface<VectorStoreInterface>\n    | undefined;\n\n  documentCompressor: BaseDocumentCompressor | undefined;\n\n  documentCompressorFilteringFn?: ParentDocumentRetrieverFields[\"documentCompressorFilteringFn\"];\n\n  constructor(fields: ParentDocumentRetrieverFields) {\n    super(fields);\n    this.vectorstore = fields.vectorstore;\n    this.childSplitter = fields.childSplitter;\n    this.parentSplitter = fields.parentSplitter;\n    this.idKey = fields.idKey ?? this.idKey;\n    this.childK = fields.childK;\n    this.parentK = fields.parentK;\n    this.childDocumentRetriever = fields.childDocumentRetriever;\n    this.documentCompressor = fields.documentCompressor;\n    this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    let subDocs: SubDocs = [];\n    if (this.childDocumentRetriever) {\n      subDocs = await this.childDocumentRetriever.invoke(query);\n    } else {\n      subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    }\n\n    if (this.documentCompressor && subDocs.length) {\n      subDocs = await this.documentCompressor.compressDocuments(subDocs, query);\n      if (this.documentCompressorFilteringFn) {\n        subDocs = this.documentCompressorFilteringFn(subDocs);\n      }\n    }\n\n    // Maintain order\n    const parentDocIds: string[] = [];\n    for (const doc of subDocs) {\n      if (!parentDocIds.includes(doc.metadata[this.idKey])) {\n        parentDocIds.push(doc.metadata[this.idKey]);\n      }\n    }\n    const parentDocs: Document[] = [];\n    const storedParentDocs = await this.docstore.mget(parentDocIds);\n    const retrievedDocs: Document[] = storedParentDocs.filter(\n      (doc?: Document): doc is Document => doc !== undefined\n    );\n    parentDocs.push(...retrievedDocs);\n    return parentDocs.slice(0, this.parentK);\n  }\n\n  async _storeDocuments(\n    parentDoc: Record<string, Document>,\n    childDocs: Document[],\n    addToDocstore: boolean\n  ) {\n    if (this.childDocumentRetriever) {\n      await this.childDocumentRetriever.addDocuments(childDocs);\n    } else {\n      await this.vectorstore.addDocuments(childDocs);\n    }\n    if (addToDocstore) {\n      await this.docstore.mset(Object.entries(parentDoc));\n    }\n  }\n\n  /**\n   * Adds documents to the docstore and vectorstores.\n   * If a retriever is provided, it will be used to add documents instead of the vectorstore.\n   * @param docs The documents to add\n   * @param config.ids Optional list of ids for documents. If provided should be the same\n   *   length as the list of documents. Can provided if parent documents\n   *   are already in the document store and you don't want to re-add\n   *   to the docstore. If not provided, random UUIDs will be used as ids.\n   * @param config.addToDocstore Boolean of whether to add documents to docstore.\n   * This can be false if and only if `ids` are provided. You may want\n   *   to set this to False if the documents are already in the docstore\n   *   and you don't want to re-add them.\n   * @param config.chunkHeaderOptions Object with options for adding Contextual chunk headers\n   */\n  async addDocuments(\n    docs: Document[],\n    config?: {\n      ids?: string[];\n      addToDocstore?: boolean;\n      childDocChunkHeaderOptions?: TextSplitterChunkHeaderOptions;\n    }\n  ): Promise<void> {\n    const {\n      ids,\n      addToDocstore = true,\n      childDocChunkHeaderOptions = {},\n    } = config ?? {};\n    const parentDocs = this.parentSplitter\n      ? await this.parentSplitter.splitDocuments(docs)\n      : docs;\n    let parentDocIds;\n    if (ids === undefined) {\n      if (!addToDocstore) {\n        throw new Error(\n          `If ids are not passed in, \"config.addToDocstore\" MUST be true`\n        );\n      }\n      parentDocIds = parentDocs.map((_doc: Document) => uuid.v4());\n    } else {\n      parentDocIds = ids;\n    }\n    if (parentDocs.length !== parentDocIds.length) {\n      throw new Error(\n        `Got uneven list of documents and ids.\\nIf \"ids\" is provided, should be same length as \"documents\".`\n      );\n    }\n    for (let i = 0; i < parentDocs.length; i += 1) {\n      const parentDoc = parentDocs[i];\n      const parentDocId = parentDocIds[i];\n      const subDocs = await this.childSplitter.splitDocuments(\n        [parentDoc],\n        childDocChunkHeaderOptions\n      );\n      const taggedSubDocs = subDocs.map(\n        (subDoc: Document) =>\n          new Document({\n            pageContent: subDoc.pageContent,\n            metadata: { ...subDoc.metadata, [this.idKey]: parentDocId },\n          })\n      );\n      await this._storeDocuments(\n        { [parentDocId]: parentDoc },\n        taggedSubDocs,\n        addToDocstore\n      );\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEA,IAAa,0BAAb,cAA6C,qBAAqB;CAChE,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAkB;CAE7D;CAEA;CAEA;CAEA,QAAkB;CAElB;CAEA;CAEA;CAIA;CAEA;CAEA,YAAY,QAAuC;AACjD,QAAM,OAAO;AACb,OAAK,cAAc,OAAO;AAC1B,OAAK,gBAAgB,OAAO;AAC5B,OAAK,iBAAiB,OAAO;AAC7B,OAAK,QAAQ,OAAO,SAAS,KAAK;AAClC,OAAK,SAAS,OAAO;AACrB,OAAK,UAAU,OAAO;AACtB,OAAK,yBAAyB,OAAO;AACrC,OAAK,qBAAqB,OAAO;AACjC,OAAK,gCAAgC,OAAO;;CAG9C,MAAM,sBAAsB,OAAoC;EAC9D,IAAI,UAAmB,EAAE;AACzB,MAAI,KAAK,uBACP,WAAU,MAAM,KAAK,uBAAuB,OAAO,MAAM;MAEzD,WAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,OAAO;AAGvE,MAAI,KAAK,sBAAsB,QAAQ,QAAQ;AAC7C,aAAU,MAAM,KAAK,mBAAmB,kBAAkB,SAAS,MAAM;AACzE,OAAI,KAAK,8BACP,WAAU,KAAK,8BAA8B,QAAQ;;EAKzD,MAAM,eAAyB,EAAE;AACjC,OAAK,MAAM,OAAO,QAChB,KAAI,CAAC,aAAa,SAAS,IAAI,SAAS,KAAK,OAAO,CAClD,cAAa,KAAK,IAAI,SAAS,KAAK,OAAO;EAG/C,MAAM,aAAyB,EAAE;EAEjC,MAAM,iBAA4B,MADH,KAAK,SAAS,KAAK,aAAa,EACZ,QAChD,QAAoC,QAAQ,KAAA,EAC9C;AACD,aAAW,KAAK,GAAG,cAAc;AACjC,SAAO,WAAW,MAAM,GAAG,KAAK,QAAQ;;CAG1C,MAAM,gBACJ,WACA,WACA,eACA;AACA,MAAI,KAAK,uBACP,OAAM,KAAK,uBAAuB,aAAa,UAAU;MAEzD,OAAM,KAAK,YAAY,aAAa,UAAU;AAEhD,MAAI,cACF,OAAM,KAAK,SAAS,KAAK,OAAO,QAAQ,UAAU,CAAC;;;;;;;;;;;;;;;;CAkBvD,MAAM,aACJ,MACA,QAKe;EACf,MAAM,EACJ,KACA,gBAAgB,MAChB,6BAA6B,EAAE,KAC7B,UAAU,EAAE;EAChB,MAAM,aAAa,KAAK,iBACpB,MAAM,KAAK,eAAe,eAAe,KAAK,GAC9C;EACJ,IAAI;AACJ,MAAI,QAAQ,KAAA,GAAW;AACrB,OAAI,CAAC,cACH,OAAM,IAAI,MACR,gEACD;AAEH,kBAAe,WAAW,KAAK,SAAmB,KAAK,IAAI,CAAC;QAE5D,gBAAe;AAEjB,MAAI,WAAW,WAAW,aAAa,OACrC,OAAM,IAAI,MACR,qGACD;AAEH,OAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,GAAG;GAC7C,MAAM,YAAY,WAAW;GAC7B,MAAM,cAAc,aAAa;GAKjC,MAAM,iBAAgB,MAJA,KAAK,cAAc,eACvC,CAAC,UAAU,EACX,2BACD,EAC6B,KAC3B,WACC,IAAI,SAAS;IACX,aAAa,OAAO;IACpB,UAAU;KAAE,GAAG,OAAO;MAAW,KAAK,QAAQ;KAAa;IAC5D,CAAC,CACL;AACD,SAAM,KAAK,gBACT,GAAG,cAAc,WAAW,EAC5B,eACA,cACD"}
+{"version":3,"file":"parent_document.js","names":[],"sources":["../../src/retrievers/parent_document.ts"],"sourcesContent":["import * as uuid from \"@langchain/core/utils/uuid\";\n\nimport {\n  type VectorStoreInterface,\n  type VectorStoreRetrieverInterface,\n} from \"@langchain/core/vectorstores\";\nimport { Document } from \"@langchain/core/documents\";\nimport {\n  TextSplitter,\n  TextSplitterChunkHeaderOptions,\n} from \"@langchain/textsplitters\";\nimport type { BaseDocumentCompressor } from \"./document_compressors/index.js\";\nimport {\n  MultiVectorRetriever,\n  type MultiVectorRetrieverInput,\n} from \"./multi_vector.js\";\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nexport type SubDocs = Document<Record<string, any>>[];\n\n/**\n * Interface for the fields required to initialize a\n * ParentDocumentRetriever instance.\n */\nexport type ParentDocumentRetrieverFields = MultiVectorRetrieverInput & {\n  childSplitter: TextSplitter;\n  parentSplitter?: TextSplitter;\n  /**\n   * A custom retriever to use when retrieving instead of\n   * the `.similaritySearch` method of the vectorstore.\n   */\n  childDocumentRetriever?: VectorStoreRetrieverInterface<VectorStoreInterface>;\n  documentCompressor?: BaseDocumentCompressor | undefined;\n  documentCompressorFilteringFn?: (docs: SubDocs) => SubDocs;\n};\n\n/**\n * A type of document retriever that splits input documents into smaller chunks\n * while separately storing and preserving the original documents.\n * The small chunks are embedded, then on retrieval, the original\n * \"parent\" documents are retrieved.\n *\n * This strikes a balance between better targeted retrieval with small documents\n * and the more context-rich larger documents.\n * @example\n * ```typescript\n * const retriever = new ParentDocumentRetriever({\n *   vectorstore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   byteStore: new InMemoryStore<Uint8Array>(),\n *   parentSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 500,\n *   }),\n *   childSplitter: new RecursiveCharacterTextSplitter({\n *     chunkOverlap: 0,\n *     chunkSize: 50,\n *   }),\n *   childK: 20,\n *   parentK: 5,\n * });\n *\n * const parentDocuments = await getDocuments();\n * await retriever.addDocuments(parentDocuments);\n * const retrievedDocs = await retriever.invoke(\"justice breyer\");\n * ```\n */\nexport class ParentDocumentRetriever extends MultiVectorRetriever {\n  static lc_name() {\n    return \"ParentDocumentRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"parent_document\"];\n\n  vectorstore: VectorStoreInterface;\n\n  protected childSplitter: TextSplitter;\n\n  protected parentSplitter?: TextSplitter;\n\n  protected idKey = \"doc_id\";\n\n  protected childK?: number;\n\n  protected parentK?: number;\n\n  childDocumentRetriever:\n    | VectorStoreRetrieverInterface<VectorStoreInterface>\n    | undefined;\n\n  documentCompressor: BaseDocumentCompressor | undefined;\n\n  documentCompressorFilteringFn?: ParentDocumentRetrieverFields[\"documentCompressorFilteringFn\"];\n\n  constructor(fields: ParentDocumentRetrieverFields) {\n    super(fields);\n    this.vectorstore = fields.vectorstore;\n    this.childSplitter = fields.childSplitter;\n    this.parentSplitter = fields.parentSplitter;\n    this.idKey = fields.idKey ?? this.idKey;\n    this.childK = fields.childK;\n    this.parentK = fields.parentK;\n    this.childDocumentRetriever = fields.childDocumentRetriever;\n    this.documentCompressor = fields.documentCompressor;\n    this.documentCompressorFilteringFn = fields.documentCompressorFilteringFn;\n  }\n\n  async _getRelevantDocuments(query: string): Promise<Document[]> {\n    let subDocs: SubDocs = [];\n    if (this.childDocumentRetriever) {\n      subDocs = await this.childDocumentRetriever.invoke(query);\n    } else {\n      subDocs = await this.vectorstore.similaritySearch(query, this.childK);\n    }\n\n    if (this.documentCompressor && subDocs.length) {\n      subDocs = await this.documentCompressor.compressDocuments(subDocs, query);\n      if (this.documentCompressorFilteringFn) {\n        subDocs = this.documentCompressorFilteringFn(subDocs);\n      }\n    }\n\n    // Maintain order\n    const parentDocIds: string[] = [];\n    for (const doc of subDocs) {\n      if (!parentDocIds.includes(doc.metadata[this.idKey])) {\n        parentDocIds.push(doc.metadata[this.idKey]);\n      }\n    }\n    const parentDocs: Document[] = [];\n    const storedParentDocs = await this.docstore.mget(parentDocIds);\n    const retrievedDocs: Document[] = storedParentDocs.filter(\n      (doc?: Document): doc is Document => doc !== undefined\n    );\n    parentDocs.push(...retrievedDocs);\n    return parentDocs.slice(0, this.parentK);\n  }\n\n  async _storeDocuments(\n    parentDoc: Record<string, Document>,\n    childDocs: Document[],\n    addToDocstore: boolean\n  ) {\n    if (this.childDocumentRetriever) {\n      await this.childDocumentRetriever.addDocuments(childDocs);\n    } else {\n      await this.vectorstore.addDocuments(childDocs);\n    }\n    if (addToDocstore) {\n      await this.docstore.mset(Object.entries(parentDoc));\n    }\n  }\n\n  /**\n   * Adds documents to the docstore and vectorstores.\n   * If a retriever is provided, it will be used to add documents instead of the vectorstore.\n   * @param docs The documents to add\n   * @param config.ids Optional list of ids for documents. If provided should be the same\n   *   length as the list of documents. Can provided if parent documents\n   *   are already in the document store and you don't want to re-add\n   *   to the docstore. If not provided, random UUIDs will be used as ids.\n   * @param config.addToDocstore Boolean of whether to add documents to docstore.\n   * This can be false if and only if `ids` are provided. You may want\n   *   to set this to False if the documents are already in the docstore\n   *   and you don't want to re-add them.\n   * @param config.chunkHeaderOptions Object with options for adding Contextual chunk headers\n   */\n  async addDocuments(\n    docs: Document[],\n    config?: {\n      ids?: string[];\n      addToDocstore?: boolean;\n      childDocChunkHeaderOptions?: TextSplitterChunkHeaderOptions;\n    }\n  ): Promise<void> {\n    const {\n      ids,\n      addToDocstore = true,\n      childDocChunkHeaderOptions = {},\n    } = config ?? {};\n    const parentDocs = this.parentSplitter\n      ? await this.parentSplitter.splitDocuments(docs)\n      : docs;\n    let parentDocIds;\n    if (ids === undefined) {\n      if (!addToDocstore) {\n        throw new Error(\n          `If ids are not passed in, \"config.addToDocstore\" MUST be true`\n        );\n      }\n      parentDocIds = parentDocs.map((_doc: Document) => uuid.v4());\n    } else {\n      parentDocIds = ids;\n    }\n    if (parentDocs.length !== parentDocIds.length) {\n      throw new Error(\n        `Got uneven list of documents and ids.\\nIf \"ids\" is provided, should be same length as \"documents\".`\n      );\n    }\n    for (let i = 0; i < parentDocs.length; i += 1) {\n      const parentDoc = parentDocs[i];\n      const parentDocId = parentDocIds[i];\n      const subDocs = await this.childSplitter.splitDocuments(\n        [parentDoc],\n        childDocChunkHeaderOptions\n      );\n      const taggedSubDocs = subDocs.map(\n        (subDoc: Document) =>\n          new Document({\n            pageContent: subDoc.pageContent,\n            metadata: { ...subDoc.metadata, [this.idKey]: parentDocId },\n          })\n      );\n      await this._storeDocuments(\n        { [parentDocId]: parentDoc },\n        taggedSubDocs,\n        addToDocstore\n      );\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkEA,IAAa,0BAAb,cAA6C,qBAAqB;CAChE,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAc;CAAiB;CAE5D;CAEA;CAEA;CAEA,QAAkB;CAElB;CAEA;CAEA;CAIA;CAEA;CAEA,YAAY,QAAuC;EACjD,MAAM,MAAM;EACZ,KAAK,cAAc,OAAO;EAC1B,KAAK,gBAAgB,OAAO;EAC5B,KAAK,iBAAiB,OAAO;EAC7B,KAAK,QAAQ,OAAO,SAAS,KAAK;EAClC,KAAK,SAAS,OAAO;EACrB,KAAK,UAAU,OAAO;EACtB,KAAK,yBAAyB,OAAO;EACrC,KAAK,qBAAqB,OAAO;EACjC,KAAK,gCAAgC,OAAO;CAC9C;CAEA,MAAM,sBAAsB,OAAoC;EAC9D,IAAI,UAAmB,CAAC;EACxB,IAAI,KAAK,wBACP,UAAU,MAAM,KAAK,uBAAuB,OAAO,KAAK;OAExD,UAAU,MAAM,KAAK,YAAY,iBAAiB,OAAO,KAAK,MAAM;EAGtE,IAAI,KAAK,sBAAsB,QAAQ,QAAQ;GAC7C,UAAU,MAAM,KAAK,mBAAmB,kBAAkB,SAAS,KAAK;GACxE,IAAI,KAAK,+BACP,UAAU,KAAK,8BAA8B,OAAO;EAExD;EAGA,MAAM,eAAyB,CAAC;EAChC,KAAK,MAAM,OAAO,SAChB,IAAI,CAAC,aAAa,SAAS,IAAI,SAAS,KAAK,MAAM,GACjD,aAAa,KAAK,IAAI,SAAS,KAAK,MAAM;EAG9C,MAAM,aAAyB,CAAC;EAEhC,MAAM,iBAA4B,MADH,KAAK,SAAS,KAAK,YAAY,EAAA,CACX,QAChD,QAAoC,QAAQ,KAAA,CAC/C;EACA,WAAW,KAAK,GAAG,aAAa;EAChC,OAAO,WAAW,MAAM,GAAG,KAAK,OAAO;CACzC;CAEA,MAAM,gBACJ,WACA,WACA,eACA;EACA,IAAI,KAAK,wBACP,MAAM,KAAK,uBAAuB,aAAa,SAAS;OAExD,MAAM,KAAK,YAAY,aAAa,SAAS;EAE/C,IAAI,eACF,MAAM,KAAK,SAAS,KAAK,OAAO,QAAQ,SAAS,CAAC;CAEtD;;;;;;;;;;;;;;;CAgBA,MAAM,aACJ,MACA,QAKe;EACf,MAAM,EACJ,KACA,gBAAgB,MAChB,6BAA6B,CAAC,MAC5B,UAAU,CAAC;EACf,MAAM,aAAa,KAAK,iBACpB,MAAM,KAAK,eAAe,eAAe,IAAI,IAC7C;EACJ,IAAI;EACJ,IAAI,QAAQ,KAAA,GAAW;GACrB,IAAI,CAAC,eACH,MAAM,IAAI,MACR,+DACF;GAEF,eAAe,WAAW,KAAK,SAAmB,KAAK,GAAG,CAAC;EAC7D,OACE,eAAe;EAEjB,IAAI,WAAW,WAAW,aAAa,QACrC,MAAM,IAAI,MACR,oGACF;EAEF,KAAK,IAAI,IAAI,GAAG,IAAI,WAAW,QAAQ,KAAK,GAAG;GAC7C,MAAM,YAAY,WAAW;GAC7B,MAAM,cAAc,aAAa;GAKjC,MAAM,iBAAgB,MAJA,KAAK,cAAc,eACvC,CAAC,SAAS,GACV,0BACF,EAAA,CAC8B,KAC3B,WACC,IAAI,SAAS;IACX,aAAa,OAAO;IACpB,UAAU;KAAE,GAAG,OAAO;MAAW,KAAK,QAAQ;IAAY;GAC5D,CAAC,CACL;GACA,MAAM,KAAK,gBACT,GAAG,cAAc,UAAU,GAC3B,eACA,aACF;EACF;CACF;AACF"}

package/dist/retrievers/score_threshold.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"score_threshold.cjs","names":["VectorStoreRetriever"],"sources":["../../src/retrievers/score_threshold.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<\n  VectorStoreRetrieverInput<V>,\n  \"k\"\n> & {\n  maxK?: number;\n  kIncrement?: number;\n  minSimilarityScore: number;\n};\n\nexport class ScoreThresholdRetriever<\n  V extends VectorStore,\n> extends VectorStoreRetriever<V> {\n  minSimilarityScore: number;\n\n  kIncrement = 10;\n\n  maxK = 100;\n\n  constructor(input: ScoreThresholdRetrieverInput<V>) {\n    super(input);\n    this.maxK = input.maxK ?? this.maxK;\n    this.minSimilarityScore =\n      input.minSimilarityScore ?? this.minSimilarityScore;\n    this.kIncrement = input.kIncrement ?? this.kIncrement;\n  }\n\n  async invoke(query: string): Promise<Document[]> {\n    let currentK = 0;\n    let filteredResults: [Document, number][] = [];\n    do {\n      currentK += this.kIncrement;\n      const results = await this.vectorStore.similaritySearchWithScore(\n        query,\n        currentK,\n        this.filter\n      );\n      filteredResults = results.filter(\n        ([, score]) => score >= this.minSimilarityScore\n      );\n    } while (filteredResults.length >= currentK && currentK < this.maxK);\n    return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);\n  }\n\n  static fromVectorStore<V extends VectorStore>(\n    vectorStore: V,\n    options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">\n  ) {\n    return new this<V>({ ...options, vectorStore });\n  }\n}\n"],"mappings":";;;;;AAgBA,IAAa,0BAAb,cAEUA,6BAAAA,qBAAwB;CAChC;CAEA,aAAa;CAEb,OAAO;CAEP,YAAY,OAAwC;AAClD,QAAM,MAAM;AACZ,OAAK,OAAO,MAAM,QAAQ,KAAK;AAC/B,OAAK,qBACH,MAAM,sBAAsB,KAAK;AACnC,OAAK,aAAa,MAAM,cAAc,KAAK;;CAG7C,MAAM,OAAO,OAAoC;EAC/C,IAAI,WAAW;EACf,IAAI,kBAAwC,EAAE;AAC9C,KAAG;AACD,eAAY,KAAK;AAMjB,sBAAkB,MALI,KAAK,YAAY,0BACrC,OACA,UACA,KAAK,OACN,EACyB,QACvB,GAAG,WAAW,SAAS,KAAK,mBAC9B;WACM,gBAAgB,UAAU,YAAY,WAAW,KAAK;AAC/D,SAAO,gBAAgB,KAAK,cAAc,UAAU,GAAG,CAAC,MAAM,GAAG,KAAK,KAAK;;CAG7E,OAAO,gBACL,aACA,SACA;AACA,SAAO,IAAI,KAAQ;GAAE,GAAG;GAAS;GAAa,CAAC"}
+{"version":3,"file":"score_threshold.cjs","names":["VectorStoreRetriever"],"sources":["../../src/retrievers/score_threshold.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<\n  VectorStoreRetrieverInput<V>,\n  \"k\"\n> & {\n  maxK?: number;\n  kIncrement?: number;\n  minSimilarityScore: number;\n};\n\nexport class ScoreThresholdRetriever<\n  V extends VectorStore,\n> extends VectorStoreRetriever<V> {\n  minSimilarityScore: number;\n\n  kIncrement = 10;\n\n  maxK = 100;\n\n  constructor(input: ScoreThresholdRetrieverInput<V>) {\n    super(input);\n    this.maxK = input.maxK ?? this.maxK;\n    this.minSimilarityScore =\n      input.minSimilarityScore ?? this.minSimilarityScore;\n    this.kIncrement = input.kIncrement ?? this.kIncrement;\n  }\n\n  async invoke(query: string): Promise<Document[]> {\n    let currentK = 0;\n    let filteredResults: [Document, number][] = [];\n    do {\n      currentK += this.kIncrement;\n      const results = await this.vectorStore.similaritySearchWithScore(\n        query,\n        currentK,\n        this.filter\n      );\n      filteredResults = results.filter(\n        ([, score]) => score >= this.minSimilarityScore\n      );\n    } while (filteredResults.length >= currentK && currentK < this.maxK);\n    return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);\n  }\n\n  static fromVectorStore<V extends VectorStore>(\n    vectorStore: V,\n    options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">\n  ) {\n    return new this<V>({ ...options, vectorStore });\n  }\n}\n"],"mappings":";;;;;AAgBA,IAAa,0BAAb,cAEUA,6BAAAA,qBAAwB;CAChC;CAEA,aAAa;CAEb,OAAO;CAEP,YAAY,OAAwC;EAClD,MAAM,KAAK;EACX,KAAK,OAAO,MAAM,QAAQ,KAAK;EAC/B,KAAK,qBACH,MAAM,sBAAsB,KAAK;EACnC,KAAK,aAAa,MAAM,cAAc,KAAK;CAC7C;CAEA,MAAM,OAAO,OAAoC;EAC/C,IAAI,WAAW;EACf,IAAI,kBAAwC,CAAC;EAC7C,GAAG;GACD,YAAY,KAAK;GAMjB,mBAAkB,MALI,KAAK,YAAY,0BACrC,OACA,UACA,KAAK,MACP,EAAA,CAC0B,QACvB,GAAG,WAAW,SAAS,KAAK,kBAC/B;EACF,SAAS,gBAAgB,UAAU,YAAY,WAAW,KAAK;EAC/D,OAAO,gBAAgB,KAAK,cAAc,UAAU,EAAE,CAAC,CAAC,MAAM,GAAG,KAAK,IAAI;CAC5E;CAEA,OAAO,gBACL,aACA,SACA;EACA,OAAO,IAAI,KAAQ;GAAE,GAAG;GAAS;EAAY,CAAC;CAChD;AACF"}

package/dist/retrievers/score_threshold.d.cts

@@ -1,6 +1,5 @@
 import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
 import { Document } from "@langchain/core/documents";
-
 //#region src/retrievers/score_threshold.d.ts
 type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<VectorStoreRetrieverInput<V>, "k"> & {
   maxK?: number;

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

@@ -1 +1 @@
-{"version":3,"file":"score_threshold.d.cts","names":[],"sources":["../../src/retrievers/score_threshold.ts"],"mappings":";;;;KAOY,4BAAA,WAAuC,WAAA,IAAe,IAAA,CAChE,yBAAA,CAA0B,CAAA;EAG1B,IAAA;EACA,UAAA;EACA,kBAAA;AAAA;AAAA,cAGW,uBAAA,WACD,WAAA,UACF,oBAAA,CAAqB,CAAA;EAC7B,kBAAA;EAEA,UAAA;EAEA,IAAA;EAEA,WAAA,CAAY,KAAA,EAAO,4BAAA,CAA6B,CAAA;EAQ1C,MAAA,CAAO,KAAA,WAAgB,OAAA,CAAQ,QAAA;EAAA,OAiB9B,eAAA,WAA0B,WAAA,CAAA,CAC/B,WAAA,EAAa,CAAA,EACb,OAAA,EAAS,IAAA,CAAK,4BAAA,CAA6B,CAAA,oBAAkB,uBAAA,CAAA,CAAA;AAAA"}
+{"version":3,"file":"score_threshold.d.cts","names":[],"sources":["../../src/retrievers/score_threshold.ts"],"mappings":";;;KAOY,6BAA6B,UAAU,eAAe,KAChE,0BAA0B;EAG1B;EACA;EACA;;cAGW,wBACX,UAAU,qBACF,qBAAqB;EAC7B;EAEA;EAEA;EAEA,YAAY,OAAO,6BAA6B;EAQ1C,OAAO,gBAAgB,QAAQ;SAiB9B,gBAAgB,UAAU,aAC/B,aAAa,GACb,SAAS,KAAK,6BAA6B,qBAAkB,wBAAA"}

package/dist/retrievers/score_threshold.d.ts

@@ -1,6 +1,5 @@
 import { Document } from "@langchain/core/documents";
 import { VectorStore, VectorStoreRetriever, VectorStoreRetrieverInput } from "@langchain/core/vectorstores";
-
 //#region src/retrievers/score_threshold.d.ts
 type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<VectorStoreRetrieverInput<V>, "k"> & {
   maxK?: number;

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

@@ -1 +1 @@
-{"version":3,"file":"score_threshold.d.ts","names":[],"sources":["../../src/retrievers/score_threshold.ts"],"mappings":";;;;KAOY,4BAAA,WAAuC,WAAA,IAAe,IAAA,CAChE,yBAAA,CAA0B,CAAA;EAG1B,IAAA;EACA,UAAA;EACA,kBAAA;AAAA;AAAA,cAGW,uBAAA,WACD,WAAA,UACF,oBAAA,CAAqB,CAAA;EAC7B,kBAAA;EAEA,UAAA;EAEA,IAAA;EAEA,WAAA,CAAY,KAAA,EAAO,4BAAA,CAA6B,CAAA;EAQ1C,MAAA,CAAO,KAAA,WAAgB,OAAA,CAAQ,QAAA;EAAA,OAiB9B,eAAA,WAA0B,WAAA,CAAA,CAC/B,WAAA,EAAa,CAAA,EACb,OAAA,EAAS,IAAA,CAAK,4BAAA,CAA6B,CAAA,oBAAkB,uBAAA,CAAA,CAAA;AAAA"}
+{"version":3,"file":"score_threshold.d.ts","names":[],"sources":["../../src/retrievers/score_threshold.ts"],"mappings":";;;KAOY,6BAA6B,UAAU,eAAe,KAChE,0BAA0B;EAG1B;EACA;EACA;;cAGW,wBACX,UAAU,qBACF,qBAAqB;EAC7B;EAEA;EAEA;EAEA,YAAY,OAAO,6BAA6B;EAQ1C,OAAO,gBAAgB,QAAQ;SAiB9B,gBAAgB,UAAU,aAC/B,aAAa,GACb,SAAS,KAAK,6BAA6B,qBAAkB,wBAAA"}

package/dist/retrievers/score_threshold.js.map

@@ -1 +1 @@
-{"version":3,"file":"score_threshold.js","names":[],"sources":["../../src/retrievers/score_threshold.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<\n  VectorStoreRetrieverInput<V>,\n  \"k\"\n> & {\n  maxK?: number;\n  kIncrement?: number;\n  minSimilarityScore: number;\n};\n\nexport class ScoreThresholdRetriever<\n  V extends VectorStore,\n> extends VectorStoreRetriever<V> {\n  minSimilarityScore: number;\n\n  kIncrement = 10;\n\n  maxK = 100;\n\n  constructor(input: ScoreThresholdRetrieverInput<V>) {\n    super(input);\n    this.maxK = input.maxK ?? this.maxK;\n    this.minSimilarityScore =\n      input.minSimilarityScore ?? this.minSimilarityScore;\n    this.kIncrement = input.kIncrement ?? this.kIncrement;\n  }\n\n  async invoke(query: string): Promise<Document[]> {\n    let currentK = 0;\n    let filteredResults: [Document, number][] = [];\n    do {\n      currentK += this.kIncrement;\n      const results = await this.vectorStore.similaritySearchWithScore(\n        query,\n        currentK,\n        this.filter\n      );\n      filteredResults = results.filter(\n        ([, score]) => score >= this.minSimilarityScore\n      );\n    } while (filteredResults.length >= currentK && currentK < this.maxK);\n    return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);\n  }\n\n  static fromVectorStore<V extends VectorStore>(\n    vectorStore: V,\n    options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">\n  ) {\n    return new this<V>({ ...options, vectorStore });\n  }\n}\n"],"mappings":";;;;AAgBA,IAAa,0BAAb,cAEU,qBAAwB;CAChC;CAEA,aAAa;CAEb,OAAO;CAEP,YAAY,OAAwC;AAClD,QAAM,MAAM;AACZ,OAAK,OAAO,MAAM,QAAQ,KAAK;AAC/B,OAAK,qBACH,MAAM,sBAAsB,KAAK;AACnC,OAAK,aAAa,MAAM,cAAc,KAAK;;CAG7C,MAAM,OAAO,OAAoC;EAC/C,IAAI,WAAW;EACf,IAAI,kBAAwC,EAAE;AAC9C,KAAG;AACD,eAAY,KAAK;AAMjB,sBAAkB,MALI,KAAK,YAAY,0BACrC,OACA,UACA,KAAK,OACN,EACyB,QACvB,GAAG,WAAW,SAAS,KAAK,mBAC9B;WACM,gBAAgB,UAAU,YAAY,WAAW,KAAK;AAC/D,SAAO,gBAAgB,KAAK,cAAc,UAAU,GAAG,CAAC,MAAM,GAAG,KAAK,KAAK;;CAG7E,OAAO,gBACL,aACA,SACA;AACA,SAAO,IAAI,KAAQ;GAAE,GAAG;GAAS;GAAa,CAAC"}
+{"version":3,"file":"score_threshold.js","names":[],"sources":["../../src/retrievers/score_threshold.ts"],"sourcesContent":["import { Document } from \"@langchain/core/documents\";\nimport {\n  VectorStore,\n  VectorStoreRetriever,\n  VectorStoreRetrieverInput,\n} from \"@langchain/core/vectorstores\";\n\nexport type ScoreThresholdRetrieverInput<V extends VectorStore> = Omit<\n  VectorStoreRetrieverInput<V>,\n  \"k\"\n> & {\n  maxK?: number;\n  kIncrement?: number;\n  minSimilarityScore: number;\n};\n\nexport class ScoreThresholdRetriever<\n  V extends VectorStore,\n> extends VectorStoreRetriever<V> {\n  minSimilarityScore: number;\n\n  kIncrement = 10;\n\n  maxK = 100;\n\n  constructor(input: ScoreThresholdRetrieverInput<V>) {\n    super(input);\n    this.maxK = input.maxK ?? this.maxK;\n    this.minSimilarityScore =\n      input.minSimilarityScore ?? this.minSimilarityScore;\n    this.kIncrement = input.kIncrement ?? this.kIncrement;\n  }\n\n  async invoke(query: string): Promise<Document[]> {\n    let currentK = 0;\n    let filteredResults: [Document, number][] = [];\n    do {\n      currentK += this.kIncrement;\n      const results = await this.vectorStore.similaritySearchWithScore(\n        query,\n        currentK,\n        this.filter\n      );\n      filteredResults = results.filter(\n        ([, score]) => score >= this.minSimilarityScore\n      );\n    } while (filteredResults.length >= currentK && currentK < this.maxK);\n    return filteredResults.map((documents) => documents[0]).slice(0, this.maxK);\n  }\n\n  static fromVectorStore<V extends VectorStore>(\n    vectorStore: V,\n    options: Omit<ScoreThresholdRetrieverInput<V>, \"vectorStore\">\n  ) {\n    return new this<V>({ ...options, vectorStore });\n  }\n}\n"],"mappings":";;;;AAgBA,IAAa,0BAAb,cAEU,qBAAwB;CAChC;CAEA,aAAa;CAEb,OAAO;CAEP,YAAY,OAAwC;EAClD,MAAM,KAAK;EACX,KAAK,OAAO,MAAM,QAAQ,KAAK;EAC/B,KAAK,qBACH,MAAM,sBAAsB,KAAK;EACnC,KAAK,aAAa,MAAM,cAAc,KAAK;CAC7C;CAEA,MAAM,OAAO,OAAoC;EAC/C,IAAI,WAAW;EACf,IAAI,kBAAwC,CAAC;EAC7C,GAAG;GACD,YAAY,KAAK;GAMjB,mBAAkB,MALI,KAAK,YAAY,0BACrC,OACA,UACA,KAAK,MACP,EAAA,CAC0B,QACvB,GAAG,WAAW,SAAS,KAAK,kBAC/B;EACF,SAAS,gBAAgB,UAAU,YAAY,WAAW,KAAK;EAC/D,OAAO,gBAAgB,KAAK,cAAc,UAAU,EAAE,CAAC,CAAC,MAAM,GAAG,KAAK,IAAI;CAC5E;CAEA,OAAO,gBACL,aACA,SACA;EACA,OAAO,IAAI,KAAQ;GAAE,GAAG;GAAS;EAAY,CAAC;CAChD;AACF"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.cjs","names":["BaseRetriever","loadQueryConstructorRunnable"],"sources":["../../../src/retrievers/self_query/index.ts"],"sourcesContent":["import { RunnableInterface } from \"@langchain/core/runnables\";\nimport {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { VectorStore } from \"@langchain/core/vectorstores\";\nimport {\n  BaseTranslator,\n  StructuredQuery,\n} from \"@langchain/core/structured_query\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  loadQueryConstructorRunnable,\n  QueryConstructorRunnableOptions,\n} from \"../../chains/query_constructor/index.js\";\n\nexport { BaseTranslator } from \"@langchain/core/structured_query\";\nexport {\n  BasicTranslator,\n  FunctionalTranslator,\n} from \"@langchain/core/structured_query\";\n\n/**\n * Interface for the arguments required to create a SelfQueryRetriever\n * instance. It extends the BaseRetrieverInput interface.\n */\nexport interface SelfQueryRetrieverArgs<\n  T extends VectorStore,\n> extends BaseRetrieverInput {\n  vectorStore: T;\n  structuredQueryTranslator: BaseTranslator<T>;\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n  verbose?: boolean;\n  useOriginalQuery?: boolean;\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  };\n}\n\n/**\n * Class for question answering over an index. It retrieves relevant\n * documents based on a query. It extends the BaseRetriever class and\n * implements the SelfQueryRetrieverArgs interface.\n * @example\n * ```typescript\n * const selfQueryRetriever = SelfQueryRetriever.fromLLM({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),\n *   documentContents: \"Brief summary of a movie\",\n *   attributeInfo: attributeInfo,\n *   structuredQueryTranslator: new FunctionalTranslator(),\n * });\n * const relevantDocuments = await selfQueryRetriever.invoke(\n *   \"Which movies are directed by Greta Gerwig?\",\n * );\n * ```\n */\nexport class SelfQueryRetriever<T extends VectorStore>\n  extends BaseRetriever\n  implements SelfQueryRetrieverArgs<T>\n{\n  static lc_name() {\n    return \"SelfQueryRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"self_query\"];\n  }\n\n  vectorStore: T;\n\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n\n  verbose?: boolean;\n\n  structuredQueryTranslator: BaseTranslator<T>;\n\n  useOriginalQuery = false;\n\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  } = { k: 4, forceDefaultFilter: false };\n\n  constructor(options: SelfQueryRetrieverArgs<T>) {\n    super(options);\n    this.vectorStore = options.vectorStore;\n    this.queryConstructor = options.queryConstructor;\n    this.verbose = options.verbose ?? false;\n    this.searchParams = options.searchParams ?? this.searchParams;\n    this.useOriginalQuery = options.useOriginalQuery ?? this.useOriginalQuery;\n    this.structuredQueryTranslator = options.structuredQueryTranslator;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document<Record<string, unknown>>[]> {\n    const generatedStructuredQuery = await this.queryConstructor.invoke(\n      { query },\n      {\n        callbacks: runManager?.getChild(\"query_constructor\"),\n        runName: \"query_constructor\",\n      }\n    );\n\n    const nextArg = this.structuredQueryTranslator.visitStructuredQuery(\n      generatedStructuredQuery\n    );\n\n    const filter = this.structuredQueryTranslator.mergeFilters(\n      this.searchParams?.filter,\n      nextArg.filter,\n      this.searchParams?.mergeFiltersOperator,\n      this.searchParams?.forceDefaultFilter\n    );\n\n    const generatedQuery = generatedStructuredQuery.query;\n    let myQuery = query;\n\n    if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) {\n      myQuery = generatedQuery;\n    }\n\n    return this.vectorStore\n      .asRetriever({\n        k: this.searchParams?.k,\n        filter,\n      })\n      .invoke(myQuery, { callbacks: runManager?.getChild(\"retriever\") });\n  }\n\n  /**\n   * Static method to create a new SelfQueryRetriever instance from a\n   * BaseLanguageModel and a VectorStore. It first loads a query constructor\n   * chain using the loadQueryConstructorChain function, then creates a new\n   * SelfQueryRetriever instance with the loaded chain and the provided\n   * options.\n   * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.\n   * @returns A new instance of SelfQueryRetriever.\n   */\n  static fromLLM<T extends VectorStore>(\n    options: QueryConstructorRunnableOptions &\n      Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">\n  ): SelfQueryRetriever<T> {\n    const {\n      structuredQueryTranslator,\n      allowedComparators,\n      allowedOperators,\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      vectorStore,\n      ...rest\n    } = options;\n    const queryConstructor = loadQueryConstructorRunnable({\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      allowedComparators:\n        allowedComparators ?? structuredQueryTranslator.allowedComparators,\n      allowedOperators:\n        allowedOperators ?? structuredQueryTranslator.allowedOperators,\n    });\n    return new SelfQueryRetriever<T>({\n      ...rest,\n      queryConstructor,\n      vectorStore,\n      structuredQueryTranslator,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6DA,IAAa,qBAAb,MAAa,2BACHA,2BAAAA,cAEV;CACE,OAAO,UAAU;AACf,SAAO;;CAGT,IAAI,eAAe;AACjB,SAAO;GAAC;GAAa;GAAc;GAAa;;CAGlD;CAEA;CAEA;CAEA;CAEA,mBAAmB;CAEnB,eAKI;EAAE,GAAG;EAAG,oBAAoB;EAAO;CAEvC,YAAY,SAAoC;AAC9C,QAAM,QAAQ;AACd,OAAK,cAAc,QAAQ;AAC3B,OAAK,mBAAmB,QAAQ;AAChC,OAAK,UAAU,QAAQ,WAAW;AAClC,OAAK,eAAe,QAAQ,gBAAgB,KAAK;AACjD,OAAK,mBAAmB,QAAQ,oBAAoB,KAAK;AACzD,OAAK,4BAA4B,QAAQ;;CAG3C,MAAM,sBACJ,OACA,YAC8C;EAC9C,MAAM,2BAA2B,MAAM,KAAK,iBAAiB,OAC3D,EAAE,OAAO,EACT;GACE,WAAW,YAAY,SAAS,oBAAoB;GACpD,SAAS;GACV,CACF;EAED,MAAM,UAAU,KAAK,0BAA0B,qBAC7C,yBACD;EAED,MAAM,SAAS,KAAK,0BAA0B,aAC5C,KAAK,cAAc,QACnB,QAAQ,QACR,KAAK,cAAc,sBACnB,KAAK,cAAc,mBACpB;EAED,MAAM,iBAAiB,yBAAyB;EAChD,IAAI,UAAU;AAEd,MAAI,CAAC,KAAK,oBAAoB,kBAAkB,eAAe,SAAS,EACtE,WAAU;AAGZ,SAAO,KAAK,YACT,YAAY;GACX,GAAG,KAAK,cAAc;GACtB;GACD,CAAC,CACD,OAAO,SAAS,EAAE,WAAW,YAAY,SAAS,YAAY,EAAE,CAAC;;;;;;;;;;;CAYtE,OAAO,QACL,SAEuB;EACvB,MAAM,EACJ,2BACA,oBACA,kBACA,KACA,kBACA,eACA,UACA,aACA,GAAG,SACD;EACJ,MAAM,mBAAmBC,uCAAAA,6BAA6B;GACpD;GACA;GACA;GACA;GACA,oBACE,sBAAsB,0BAA0B;GAClD,kBACE,oBAAoB,0BAA0B;GACjD,CAAC;AACF,SAAO,IAAI,mBAAsB;GAC/B,GAAG;GACH;GACA;GACA;GACD,CAAC"}
+{"version":3,"file":"index.cjs","names":["BaseRetriever","loadQueryConstructorRunnable"],"sources":["../../../src/retrievers/self_query/index.ts"],"sourcesContent":["import { RunnableInterface } from \"@langchain/core/runnables\";\nimport {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { VectorStore } from \"@langchain/core/vectorstores\";\nimport {\n  BaseTranslator,\n  StructuredQuery,\n} from \"@langchain/core/structured_query\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  loadQueryConstructorRunnable,\n  QueryConstructorRunnableOptions,\n} from \"../../chains/query_constructor/index.js\";\n\nexport { BaseTranslator } from \"@langchain/core/structured_query\";\nexport {\n  BasicTranslator,\n  FunctionalTranslator,\n} from \"@langchain/core/structured_query\";\n\n/**\n * Interface for the arguments required to create a SelfQueryRetriever\n * instance. It extends the BaseRetrieverInput interface.\n */\nexport interface SelfQueryRetrieverArgs<\n  T extends VectorStore,\n> extends BaseRetrieverInput {\n  vectorStore: T;\n  structuredQueryTranslator: BaseTranslator<T>;\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n  verbose?: boolean;\n  useOriginalQuery?: boolean;\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  };\n}\n\n/**\n * Class for question answering over an index. It retrieves relevant\n * documents based on a query. It extends the BaseRetriever class and\n * implements the SelfQueryRetrieverArgs interface.\n * @example\n * ```typescript\n * const selfQueryRetriever = SelfQueryRetriever.fromLLM({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),\n *   documentContents: \"Brief summary of a movie\",\n *   attributeInfo: attributeInfo,\n *   structuredQueryTranslator: new FunctionalTranslator(),\n * });\n * const relevantDocuments = await selfQueryRetriever.invoke(\n *   \"Which movies are directed by Greta Gerwig?\",\n * );\n * ```\n */\nexport class SelfQueryRetriever<T extends VectorStore>\n  extends BaseRetriever\n  implements SelfQueryRetrieverArgs<T>\n{\n  static lc_name() {\n    return \"SelfQueryRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"self_query\"];\n  }\n\n  vectorStore: T;\n\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n\n  verbose?: boolean;\n\n  structuredQueryTranslator: BaseTranslator<T>;\n\n  useOriginalQuery = false;\n\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  } = { k: 4, forceDefaultFilter: false };\n\n  constructor(options: SelfQueryRetrieverArgs<T>) {\n    super(options);\n    this.vectorStore = options.vectorStore;\n    this.queryConstructor = options.queryConstructor;\n    this.verbose = options.verbose ?? false;\n    this.searchParams = options.searchParams ?? this.searchParams;\n    this.useOriginalQuery = options.useOriginalQuery ?? this.useOriginalQuery;\n    this.structuredQueryTranslator = options.structuredQueryTranslator;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document<Record<string, unknown>>[]> {\n    const generatedStructuredQuery = await this.queryConstructor.invoke(\n      { query },\n      {\n        callbacks: runManager?.getChild(\"query_constructor\"),\n        runName: \"query_constructor\",\n      }\n    );\n\n    const nextArg = this.structuredQueryTranslator.visitStructuredQuery(\n      generatedStructuredQuery\n    );\n\n    const filter = this.structuredQueryTranslator.mergeFilters(\n      this.searchParams?.filter,\n      nextArg.filter,\n      this.searchParams?.mergeFiltersOperator,\n      this.searchParams?.forceDefaultFilter\n    );\n\n    const generatedQuery = generatedStructuredQuery.query;\n    let myQuery = query;\n\n    if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) {\n      myQuery = generatedQuery;\n    }\n\n    return this.vectorStore\n      .asRetriever({\n        k: this.searchParams?.k,\n        filter,\n      })\n      .invoke(myQuery, { callbacks: runManager?.getChild(\"retriever\") });\n  }\n\n  /**\n   * Static method to create a new SelfQueryRetriever instance from a\n   * BaseLanguageModel and a VectorStore. It first loads a query constructor\n   * chain using the loadQueryConstructorChain function, then creates a new\n   * SelfQueryRetriever instance with the loaded chain and the provided\n   * options.\n   * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.\n   * @returns A new instance of SelfQueryRetriever.\n   */\n  static fromLLM<T extends VectorStore>(\n    options: QueryConstructorRunnableOptions &\n      Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">\n  ): SelfQueryRetriever<T> {\n    const {\n      structuredQueryTranslator,\n      allowedComparators,\n      allowedOperators,\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      vectorStore,\n      ...rest\n    } = options;\n    const queryConstructor = loadQueryConstructorRunnable({\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      allowedComparators:\n        allowedComparators ?? structuredQueryTranslator.allowedComparators,\n      allowedOperators:\n        allowedOperators ?? structuredQueryTranslator.allowedOperators,\n    });\n    return new SelfQueryRetriever<T>({\n      ...rest,\n      queryConstructor,\n      vectorStore,\n      structuredQueryTranslator,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6DA,IAAa,qBAAb,MAAa,2BACHA,2BAAAA,cAEV;CACE,OAAO,UAAU;EACf,OAAO;CACT;CAEA,IAAI,eAAe;EACjB,OAAO;GAAC;GAAa;GAAc;EAAY;CACjD;CAEA;CAEA;CAEA;CAEA;CAEA,mBAAmB;CAEnB,eAKI;EAAE,GAAG;EAAG,oBAAoB;CAAM;CAEtC,YAAY,SAAoC;EAC9C,MAAM,OAAO;EACb,KAAK,cAAc,QAAQ;EAC3B,KAAK,mBAAmB,QAAQ;EAChC,KAAK,UAAU,QAAQ,WAAW;EAClC,KAAK,eAAe,QAAQ,gBAAgB,KAAK;EACjD,KAAK,mBAAmB,QAAQ,oBAAoB,KAAK;EACzD,KAAK,4BAA4B,QAAQ;CAC3C;CAEA,MAAM,sBACJ,OACA,YAC8C;EAC9C,MAAM,2BAA2B,MAAM,KAAK,iBAAiB,OAC3D,EAAE,MAAM,GACR;GACE,WAAW,YAAY,SAAS,mBAAmB;GACnD,SAAS;EACX,CACF;EAEA,MAAM,UAAU,KAAK,0BAA0B,qBAC7C,wBACF;EAEA,MAAM,SAAS,KAAK,0BAA0B,aAC5C,KAAK,cAAc,QACnB,QAAQ,QACR,KAAK,cAAc,sBACnB,KAAK,cAAc,kBACrB;EAEA,MAAM,iBAAiB,yBAAyB;EAChD,IAAI,UAAU;EAEd,IAAI,CAAC,KAAK,oBAAoB,kBAAkB,eAAe,SAAS,GACtE,UAAU;EAGZ,OAAO,KAAK,YACT,YAAY;GACX,GAAG,KAAK,cAAc;GACtB;EACF,CAAC,CAAC,CACD,OAAO,SAAS,EAAE,WAAW,YAAY,SAAS,WAAW,EAAE,CAAC;CACrE;;;;;;;;;;CAWA,OAAO,QACL,SAEuB;EACvB,MAAM,EACJ,2BACA,oBACA,kBACA,KACA,kBACA,eACA,UACA,aACA,GAAG,SACD;EACJ,MAAM,mBAAmBC,uCAAAA,6BAA6B;GACpD;GACA;GACA;GACA;GACA,oBACE,sBAAsB,0BAA0B;GAClD,kBACE,oBAAoB,0BAA0B;EAClD,CAAC;EACD,OAAO,IAAI,mBAAsB;GAC/B,GAAG;GACH;GACA;GACA;EACF,CAAC;CACH;AACF"}

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

@@ -5,7 +5,6 @@ import { VectorStore } from "@langchain/core/vectorstores";
 import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
 import { Document } from "@langchain/core/documents";
 import { BaseTranslator, BaseTranslator as BaseTranslator$1, BasicTranslator, FunctionalTranslator, StructuredQuery } from "@langchain/core/structured_query";
-
 //#region src/retrievers/self_query/index.d.ts
 /**
  * Interface for the arguments required to create a SelfQueryRetriever

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../../../src/retrievers/self_query/index.ts"],"mappings":";;;;;;;;;AA2BA;;;;AAAA,UAAiB,sBAAA,WACL,WAAA,UACF,kBAAA;EACR,WAAA,EAAa,CAAA;EACb,yBAAA,EAA2B,gBAAA,CAAe,CAAA;EAC1C,gBAAA,EAAkB,iBAAA;IAAoB,KAAA;EAAA,GAAiB,eAAA;EACvD,OAAA;EACA,gBAAA;EACA,YAAA;IACE,CAAA;IACA,MAAA,GAAS,CAAA;IACT,oBAAA;IACA,kBAAA;EAAA;AAAA;;;;;;;;;;;;;;;;;AAsBJ;;cAAa,kBAAA,WAA6B,WAAA,UAChC,aAAA,YACG,sBAAA,CAAuB,CAAA;EAAA,OAE3B,OAAA,CAAA;EAAA,IAIH,YAAA,CAAA;EAIJ,WAAA,EAAa,CAAA;EAEb,gBAAA,EAAkB,iBAAA;IAAoB,KAAA;EAAA,GAAiB,eAAA;EAEvD,OAAA;EAEA,yBAAA,EAA2B,gBAAA,CAAe,CAAA;EAE1C,gBAAA;EAEA,YAAA;IACE,CAAA;IACA,MAAA,GAAS,CAAA;IACT,oBAAA;IACA,kBAAA;EAAA;EAGF,WAAA,CAAY,OAAA,EAAS,sBAAA,CAAuB,CAAA;EAUtC,qBAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GACZ,OAAA,CAAQ,QAAA,CAAS,MAAA;EA8CX;;;;;;;;;EAAA,OAFF,OAAA,WAAkB,WAAA,CAAA,CACvB,OAAA,EAAS,+BAAA,GACP,IAAA,CAAK,sBAAA,CAAuB,CAAA,yBAC7B,kBAAA,CAAmB,CAAA;AAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../../../src/retrievers/self_query/index.ts"],"mappings":";;;;;;;;;;;;UA2BiB,uBACf,UAAU,qBACF;EACR,aAAa;EACb,2BAA2B,iBAAe;EAC1C,kBAAkB;IAAoB;KAAiB;EACvD;EACA;EACA;IACE;IACA,SAAS;IACT;IACA;;;;;;;;;;;;;;;;;;;;;cAsBS,mBAAmB,UAAU,qBAChC,yBACG,uBAAuB;SAE3B;MAIH;EAIJ,aAAa;EAEb,kBAAkB;IAAoB;KAAiB;EAEvD;EAEA,2BAA2B,iBAAe;EAE1C;EAEA;IACE;IACA,SAAS;IACT;IACA;;EAGF,YAAY,SAAS,uBAAuB;EAUtC,sBACJ,eACA,aAAa,iCACZ,QAAQ,SAAS;;;;;;;;;;SA4Cb,QAAQ,UAAU,aACvB,SAAS,kCACP,KAAK,uBAAuB,0BAC7B,mBAAmB"}

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

@@ -5,7 +5,6 @@ import { BaseTranslator, BaseTranslator as BaseTranslator$1, BasicTranslator, Fu
 import { Document } from "@langchain/core/documents";
 import { BaseRetriever, BaseRetrieverInput } from "@langchain/core/retrievers";
 import { VectorStore } from "@langchain/core/vectorstores";
-
 //#region src/retrievers/self_query/index.d.ts
 /**
  * Interface for the arguments required to create a SelfQueryRetriever

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

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/retrievers/self_query/index.ts"],"mappings":";;;;;;;;;AA2BA;;;;AAAA,UAAiB,sBAAA,WACL,WAAA,UACF,kBAAA;EACR,WAAA,EAAa,CAAA;EACb,yBAAA,EAA2B,gBAAA,CAAe,CAAA;EAC1C,gBAAA,EAAkB,iBAAA;IAAoB,KAAA;EAAA,GAAiB,eAAA;EACvD,OAAA;EACA,gBAAA;EACA,YAAA;IACE,CAAA;IACA,MAAA,GAAS,CAAA;IACT,oBAAA;IACA,kBAAA;EAAA;AAAA;;;;;;;;;;;;;;;;;AAsBJ;;cAAa,kBAAA,WAA6B,WAAA,UAChC,aAAA,YACG,sBAAA,CAAuB,CAAA;EAAA,OAE3B,OAAA,CAAA;EAAA,IAIH,YAAA,CAAA;EAIJ,WAAA,EAAa,CAAA;EAEb,gBAAA,EAAkB,iBAAA;IAAoB,KAAA;EAAA,GAAiB,eAAA;EAEvD,OAAA;EAEA,yBAAA,EAA2B,gBAAA,CAAe,CAAA;EAE1C,gBAAA;EAEA,YAAA;IACE,CAAA;IACA,MAAA,GAAS,CAAA;IACT,oBAAA;IACA,kBAAA;EAAA;EAGF,WAAA,CAAY,OAAA,EAAS,sBAAA,CAAuB,CAAA;EAUtC,qBAAA,CACJ,KAAA,UACA,UAAA,GAAa,8BAAA,GACZ,OAAA,CAAQ,QAAA,CAAS,MAAA;EA8CX;;;;;;;;;EAAA,OAFF,OAAA,WAAkB,WAAA,CAAA,CACvB,OAAA,EAAS,+BAAA,GACP,IAAA,CAAK,sBAAA,CAAuB,CAAA,yBAC7B,kBAAA,CAAmB,CAAA;AAAA"}
+{"version":3,"file":"index.d.ts","names":[],"sources":["../../../src/retrievers/self_query/index.ts"],"mappings":";;;;;;;;;;;;UA2BiB,uBACf,UAAU,qBACF;EACR,aAAa;EACb,2BAA2B,iBAAe;EAC1C,kBAAkB;IAAoB;KAAiB;EACvD;EACA;EACA;IACE;IACA,SAAS;IACT;IACA;;;;;;;;;;;;;;;;;;;;;cAsBS,mBAAmB,UAAU,qBAChC,yBACG,uBAAuB;SAE3B;MAIH;EAIJ,aAAa;EAEb,kBAAkB;IAAoB;KAAiB;EAEvD;EAEA,2BAA2B,iBAAe;EAE1C;EAEA;IACE;IACA,SAAS;IACT;IACA;;EAGF,YAAY,SAAS,uBAAuB;EAUtC,sBACJ,eACA,aAAa,iCACZ,QAAQ,SAAS;;;;;;;;;;SA4Cb,QAAQ,UAAU,aACvB,SAAS,kCACP,KAAK,uBAAuB,0BAC7B,mBAAmB"}

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

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../../src/retrievers/self_query/index.ts"],"sourcesContent":["import { RunnableInterface } from \"@langchain/core/runnables\";\nimport {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { VectorStore } from \"@langchain/core/vectorstores\";\nimport {\n  BaseTranslator,\n  StructuredQuery,\n} from \"@langchain/core/structured_query\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  loadQueryConstructorRunnable,\n  QueryConstructorRunnableOptions,\n} from \"../../chains/query_constructor/index.js\";\n\nexport { BaseTranslator } from \"@langchain/core/structured_query\";\nexport {\n  BasicTranslator,\n  FunctionalTranslator,\n} from \"@langchain/core/structured_query\";\n\n/**\n * Interface for the arguments required to create a SelfQueryRetriever\n * instance. It extends the BaseRetrieverInput interface.\n */\nexport interface SelfQueryRetrieverArgs<\n  T extends VectorStore,\n> extends BaseRetrieverInput {\n  vectorStore: T;\n  structuredQueryTranslator: BaseTranslator<T>;\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n  verbose?: boolean;\n  useOriginalQuery?: boolean;\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  };\n}\n\n/**\n * Class for question answering over an index. It retrieves relevant\n * documents based on a query. It extends the BaseRetriever class and\n * implements the SelfQueryRetrieverArgs interface.\n * @example\n * ```typescript\n * const selfQueryRetriever = SelfQueryRetriever.fromLLM({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),\n *   documentContents: \"Brief summary of a movie\",\n *   attributeInfo: attributeInfo,\n *   structuredQueryTranslator: new FunctionalTranslator(),\n * });\n * const relevantDocuments = await selfQueryRetriever.invoke(\n *   \"Which movies are directed by Greta Gerwig?\",\n * );\n * ```\n */\nexport class SelfQueryRetriever<T extends VectorStore>\n  extends BaseRetriever\n  implements SelfQueryRetrieverArgs<T>\n{\n  static lc_name() {\n    return \"SelfQueryRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"self_query\"];\n  }\n\n  vectorStore: T;\n\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n\n  verbose?: boolean;\n\n  structuredQueryTranslator: BaseTranslator<T>;\n\n  useOriginalQuery = false;\n\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  } = { k: 4, forceDefaultFilter: false };\n\n  constructor(options: SelfQueryRetrieverArgs<T>) {\n    super(options);\n    this.vectorStore = options.vectorStore;\n    this.queryConstructor = options.queryConstructor;\n    this.verbose = options.verbose ?? false;\n    this.searchParams = options.searchParams ?? this.searchParams;\n    this.useOriginalQuery = options.useOriginalQuery ?? this.useOriginalQuery;\n    this.structuredQueryTranslator = options.structuredQueryTranslator;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document<Record<string, unknown>>[]> {\n    const generatedStructuredQuery = await this.queryConstructor.invoke(\n      { query },\n      {\n        callbacks: runManager?.getChild(\"query_constructor\"),\n        runName: \"query_constructor\",\n      }\n    );\n\n    const nextArg = this.structuredQueryTranslator.visitStructuredQuery(\n      generatedStructuredQuery\n    );\n\n    const filter = this.structuredQueryTranslator.mergeFilters(\n      this.searchParams?.filter,\n      nextArg.filter,\n      this.searchParams?.mergeFiltersOperator,\n      this.searchParams?.forceDefaultFilter\n    );\n\n    const generatedQuery = generatedStructuredQuery.query;\n    let myQuery = query;\n\n    if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) {\n      myQuery = generatedQuery;\n    }\n\n    return this.vectorStore\n      .asRetriever({\n        k: this.searchParams?.k,\n        filter,\n      })\n      .invoke(myQuery, { callbacks: runManager?.getChild(\"retriever\") });\n  }\n\n  /**\n   * Static method to create a new SelfQueryRetriever instance from a\n   * BaseLanguageModel and a VectorStore. It first loads a query constructor\n   * chain using the loadQueryConstructorChain function, then creates a new\n   * SelfQueryRetriever instance with the loaded chain and the provided\n   * options.\n   * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.\n   * @returns A new instance of SelfQueryRetriever.\n   */\n  static fromLLM<T extends VectorStore>(\n    options: QueryConstructorRunnableOptions &\n      Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">\n  ): SelfQueryRetriever<T> {\n    const {\n      structuredQueryTranslator,\n      allowedComparators,\n      allowedOperators,\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      vectorStore,\n      ...rest\n    } = options;\n    const queryConstructor = loadQueryConstructorRunnable({\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      allowedComparators:\n        allowedComparators ?? structuredQueryTranslator.allowedComparators,\n      allowedOperators:\n        allowedOperators ?? structuredQueryTranslator.allowedOperators,\n    });\n    return new SelfQueryRetriever<T>({\n      ...rest,\n      queryConstructor,\n      vectorStore,\n      structuredQueryTranslator,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6DA,IAAa,qBAAb,MAAa,2BACH,cAEV;CACE,OAAO,UAAU;AACf,SAAO;;CAGT,IAAI,eAAe;AACjB,SAAO;GAAC;GAAa;GAAc;GAAa;;CAGlD;CAEA;CAEA;CAEA;CAEA,mBAAmB;CAEnB,eAKI;EAAE,GAAG;EAAG,oBAAoB;EAAO;CAEvC,YAAY,SAAoC;AAC9C,QAAM,QAAQ;AACd,OAAK,cAAc,QAAQ;AAC3B,OAAK,mBAAmB,QAAQ;AAChC,OAAK,UAAU,QAAQ,WAAW;AAClC,OAAK,eAAe,QAAQ,gBAAgB,KAAK;AACjD,OAAK,mBAAmB,QAAQ,oBAAoB,KAAK;AACzD,OAAK,4BAA4B,QAAQ;;CAG3C,MAAM,sBACJ,OACA,YAC8C;EAC9C,MAAM,2BAA2B,MAAM,KAAK,iBAAiB,OAC3D,EAAE,OAAO,EACT;GACE,WAAW,YAAY,SAAS,oBAAoB;GACpD,SAAS;GACV,CACF;EAED,MAAM,UAAU,KAAK,0BAA0B,qBAC7C,yBACD;EAED,MAAM,SAAS,KAAK,0BAA0B,aAC5C,KAAK,cAAc,QACnB,QAAQ,QACR,KAAK,cAAc,sBACnB,KAAK,cAAc,mBACpB;EAED,MAAM,iBAAiB,yBAAyB;EAChD,IAAI,UAAU;AAEd,MAAI,CAAC,KAAK,oBAAoB,kBAAkB,eAAe,SAAS,EACtE,WAAU;AAGZ,SAAO,KAAK,YACT,YAAY;GACX,GAAG,KAAK,cAAc;GACtB;GACD,CAAC,CACD,OAAO,SAAS,EAAE,WAAW,YAAY,SAAS,YAAY,EAAE,CAAC;;;;;;;;;;;CAYtE,OAAO,QACL,SAEuB;EACvB,MAAM,EACJ,2BACA,oBACA,kBACA,KACA,kBACA,eACA,UACA,aACA,GAAG,SACD;EACJ,MAAM,mBAAmB,6BAA6B;GACpD;GACA;GACA;GACA;GACA,oBACE,sBAAsB,0BAA0B;GAClD,kBACE,oBAAoB,0BAA0B;GACjD,CAAC;AACF,SAAO,IAAI,mBAAsB;GAC/B,GAAG;GACH;GACA;GACA;GACD,CAAC"}
+{"version":3,"file":"index.js","names":[],"sources":["../../../src/retrievers/self_query/index.ts"],"sourcesContent":["import { RunnableInterface } from \"@langchain/core/runnables\";\nimport {\n  BaseRetriever,\n  type BaseRetrieverInput,\n} from \"@langchain/core/retrievers\";\nimport { Document } from \"@langchain/core/documents\";\nimport { VectorStore } from \"@langchain/core/vectorstores\";\nimport {\n  BaseTranslator,\n  StructuredQuery,\n} from \"@langchain/core/structured_query\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  loadQueryConstructorRunnable,\n  QueryConstructorRunnableOptions,\n} from \"../../chains/query_constructor/index.js\";\n\nexport { BaseTranslator } from \"@langchain/core/structured_query\";\nexport {\n  BasicTranslator,\n  FunctionalTranslator,\n} from \"@langchain/core/structured_query\";\n\n/**\n * Interface for the arguments required to create a SelfQueryRetriever\n * instance. It extends the BaseRetrieverInput interface.\n */\nexport interface SelfQueryRetrieverArgs<\n  T extends VectorStore,\n> extends BaseRetrieverInput {\n  vectorStore: T;\n  structuredQueryTranslator: BaseTranslator<T>;\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n  verbose?: boolean;\n  useOriginalQuery?: boolean;\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  };\n}\n\n/**\n * Class for question answering over an index. It retrieves relevant\n * documents based on a query. It extends the BaseRetriever class and\n * implements the SelfQueryRetrieverArgs interface.\n * @example\n * ```typescript\n * const selfQueryRetriever = SelfQueryRetriever.fromLLM({\n *   llm: new ChatOpenAI({ model: \"gpt-4o-mini\" }),\n *   vectorStore: await HNSWLib.fromDocuments(docs, new OpenAIEmbeddings()),\n *   documentContents: \"Brief summary of a movie\",\n *   attributeInfo: attributeInfo,\n *   structuredQueryTranslator: new FunctionalTranslator(),\n * });\n * const relevantDocuments = await selfQueryRetriever.invoke(\n *   \"Which movies are directed by Greta Gerwig?\",\n * );\n * ```\n */\nexport class SelfQueryRetriever<T extends VectorStore>\n  extends BaseRetriever\n  implements SelfQueryRetrieverArgs<T>\n{\n  static lc_name() {\n    return \"SelfQueryRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"self_query\"];\n  }\n\n  vectorStore: T;\n\n  queryConstructor: RunnableInterface<{ query: string }, StructuredQuery>;\n\n  verbose?: boolean;\n\n  structuredQueryTranslator: BaseTranslator<T>;\n\n  useOriginalQuery = false;\n\n  searchParams?: {\n    k?: number;\n    filter?: T[\"FilterType\"];\n    mergeFiltersOperator?: \"or\" | \"and\" | \"replace\";\n    forceDefaultFilter?: boolean;\n  } = { k: 4, forceDefaultFilter: false };\n\n  constructor(options: SelfQueryRetrieverArgs<T>) {\n    super(options);\n    this.vectorStore = options.vectorStore;\n    this.queryConstructor = options.queryConstructor;\n    this.verbose = options.verbose ?? false;\n    this.searchParams = options.searchParams ?? this.searchParams;\n    this.useOriginalQuery = options.useOriginalQuery ?? this.useOriginalQuery;\n    this.structuredQueryTranslator = options.structuredQueryTranslator;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Document<Record<string, unknown>>[]> {\n    const generatedStructuredQuery = await this.queryConstructor.invoke(\n      { query },\n      {\n        callbacks: runManager?.getChild(\"query_constructor\"),\n        runName: \"query_constructor\",\n      }\n    );\n\n    const nextArg = this.structuredQueryTranslator.visitStructuredQuery(\n      generatedStructuredQuery\n    );\n\n    const filter = this.structuredQueryTranslator.mergeFilters(\n      this.searchParams?.filter,\n      nextArg.filter,\n      this.searchParams?.mergeFiltersOperator,\n      this.searchParams?.forceDefaultFilter\n    );\n\n    const generatedQuery = generatedStructuredQuery.query;\n    let myQuery = query;\n\n    if (!this.useOriginalQuery && generatedQuery && generatedQuery.length > 0) {\n      myQuery = generatedQuery;\n    }\n\n    return this.vectorStore\n      .asRetriever({\n        k: this.searchParams?.k,\n        filter,\n      })\n      .invoke(myQuery, { callbacks: runManager?.getChild(\"retriever\") });\n  }\n\n  /**\n   * Static method to create a new SelfQueryRetriever instance from a\n   * BaseLanguageModel and a VectorStore. It first loads a query constructor\n   * chain using the loadQueryConstructorChain function, then creates a new\n   * SelfQueryRetriever instance with the loaded chain and the provided\n   * options.\n   * @param options The options used to create the SelfQueryRetriever instance. It includes the QueryConstructorChainOptions and all the SelfQueryRetrieverArgs except 'llmChain'.\n   * @returns A new instance of SelfQueryRetriever.\n   */\n  static fromLLM<T extends VectorStore>(\n    options: QueryConstructorRunnableOptions &\n      Omit<SelfQueryRetrieverArgs<T>, \"queryConstructor\">\n  ): SelfQueryRetriever<T> {\n    const {\n      structuredQueryTranslator,\n      allowedComparators,\n      allowedOperators,\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      vectorStore,\n      ...rest\n    } = options;\n    const queryConstructor = loadQueryConstructorRunnable({\n      llm,\n      documentContents,\n      attributeInfo,\n      examples,\n      allowedComparators:\n        allowedComparators ?? structuredQueryTranslator.allowedComparators,\n      allowedOperators:\n        allowedOperators ?? structuredQueryTranslator.allowedOperators,\n    });\n    return new SelfQueryRetriever<T>({\n      ...rest,\n      queryConstructor,\n      vectorStore,\n      structuredQueryTranslator,\n    });\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA6DA,IAAa,qBAAb,MAAa,2BACH,cAEV;CACE,OAAO,UAAU;EACf,OAAO;CACT;CAEA,IAAI,eAAe;EACjB,OAAO;GAAC;GAAa;GAAc;EAAY;CACjD;CAEA;CAEA;CAEA;CAEA;CAEA,mBAAmB;CAEnB,eAKI;EAAE,GAAG;EAAG,oBAAoB;CAAM;CAEtC,YAAY,SAAoC;EAC9C,MAAM,OAAO;EACb,KAAK,cAAc,QAAQ;EAC3B,KAAK,mBAAmB,QAAQ;EAChC,KAAK,UAAU,QAAQ,WAAW;EAClC,KAAK,eAAe,QAAQ,gBAAgB,KAAK;EACjD,KAAK,mBAAmB,QAAQ,oBAAoB,KAAK;EACzD,KAAK,4BAA4B,QAAQ;CAC3C;CAEA,MAAM,sBACJ,OACA,YAC8C;EAC9C,MAAM,2BAA2B,MAAM,KAAK,iBAAiB,OAC3D,EAAE,MAAM,GACR;GACE,WAAW,YAAY,SAAS,mBAAmB;GACnD,SAAS;EACX,CACF;EAEA,MAAM,UAAU,KAAK,0BAA0B,qBAC7C,wBACF;EAEA,MAAM,SAAS,KAAK,0BAA0B,aAC5C,KAAK,cAAc,QACnB,QAAQ,QACR,KAAK,cAAc,sBACnB,KAAK,cAAc,kBACrB;EAEA,MAAM,iBAAiB,yBAAyB;EAChD,IAAI,UAAU;EAEd,IAAI,CAAC,KAAK,oBAAoB,kBAAkB,eAAe,SAAS,GACtE,UAAU;EAGZ,OAAO,KAAK,YACT,YAAY;GACX,GAAG,KAAK,cAAc;GACtB;EACF,CAAC,CAAC,CACD,OAAO,SAAS,EAAE,WAAW,YAAY,SAAS,WAAW,EAAE,CAAC;CACrE;;;;;;;;;;CAWA,OAAO,QACL,SAEuB;EACvB,MAAM,EACJ,2BACA,oBACA,kBACA,KACA,kBACA,eACA,UACA,aACA,GAAG,SACD;EACJ,MAAM,mBAAmB,6BAA6B;GACpD;GACA;GACA;GACA;GACA,oBACE,sBAAsB,0BAA0B;GAClD,kBACE,oBAAoB,0BAA0B;EAClD,CAAC;EACD,OAAO,IAAI,mBAAsB;GAC/B,GAAG;GACH;GACA;GACA;EACF,CAAC;CACH;AACF"}

package/dist/retrievers/time_weighted.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"time_weighted.cjs","names":["BaseRetriever"],"sources":["../../src/retrievers/time_weighted.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\n/**\n * Interface for the fields required to initialize a\n * TimeWeightedVectorStoreRetriever instance.\n */\nexport interface TimeWeightedVectorStoreRetrieverFields extends BaseRetrieverInput {\n  vectorStore: VectorStoreInterface;\n  searchKwargs?: number;\n  memoryStream?: DocumentInterface[];\n  decayRate?: number;\n  k?: number;\n  otherScoreKeys?: string[];\n  defaultSalience?: number;\n}\n\nexport const LAST_ACCESSED_AT_KEY = \"last_accessed_at\";\nexport const BUFFER_IDX = \"buffer_idx\";\n\n/**\n * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.\n * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py\n * @example\n * ```typescript\n * const retriever = new TimeWeightedVectorStoreRetriever({\n *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   memoryStream: [],\n *   searchKwargs: 2,\n * });\n * await retriever.addDocuments([\n *   { pageContent: \"My name is John.\", metadata: {} },\n *   { pageContent: \"My favourite food is pizza.\", metadata: {} },\n *\n * ]);\n * const results = await retriever.invoke(\n *   \"What is my favourite food?\",\n * );\n * ```\n */\nexport class TimeWeightedVectorStoreRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"TimeWeightedVectorStoreRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"time_weighted\"];\n  }\n\n  /**\n   * The vectorstore to store documents and determine salience.\n   */\n  private vectorStore: VectorStoreInterface;\n\n  /**\n   * The number of top K most relevant documents to consider when searching.\n   */\n  private searchKwargs: number;\n\n  /**\n   * The memory_stream of documents to search through.\n   */\n  private memoryStream: DocumentInterface[];\n\n  /**\n   * The exponential decay factor used as (1.0-decay_rate)**(hrs_passed).\n   */\n  private decayRate: number;\n\n  /**\n   * The maximum number of documents to retrieve in a given call.\n   */\n  private k: number;\n\n  /**\n   * Other keys in the metadata to factor into the score, e.g. 'importance'.\n   */\n  private otherScoreKeys: string[];\n\n  /**\n   * The salience to assign memories not retrieved from the vector store.\n   */\n  private defaultSalience: number | null;\n\n  /**\n   * Constructor to initialize the required fields\n   * @param fields - The fields required for initializing the TimeWeightedVectorStoreRetriever\n   */\n  constructor(fields: TimeWeightedVectorStoreRetrieverFields) {\n    super(fields);\n    this.vectorStore = fields.vectorStore;\n    this.searchKwargs = fields.searchKwargs ?? 100;\n    this.memoryStream = fields.memoryStream ?? [];\n    this.decayRate = fields.decayRate ?? 0.01;\n    this.k = fields.k ?? 4;\n    this.otherScoreKeys = fields.otherScoreKeys ?? [];\n    this.defaultSalience = fields.defaultSalience ?? null;\n  }\n\n  /**\n   * Get the memory stream of documents.\n   * @returns The memory stream of documents.\n   */\n  getMemoryStream(): DocumentInterface[] {\n    return this.memoryStream;\n  }\n\n  /**\n   * Set the memory stream of documents.\n   * @param memoryStream The new memory stream of documents.\n   */\n  setMemoryStream(memoryStream: DocumentInterface[]) {\n    this.memoryStream = memoryStream;\n  }\n\n  /**\n   * Get relevant documents based on time-weighted relevance\n   * @param query - The query to search for\n   * @returns The relevant documents\n   */\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<DocumentInterface[]> {\n    const now = Math.floor(Date.now() / 1000);\n    const memoryDocsAndScores = this.getMemoryDocsAndScores();\n\n    const salientDocsAndScores = await this.getSalientDocuments(\n      query,\n      runManager\n    );\n    const docsAndScores = { ...memoryDocsAndScores, ...salientDocsAndScores };\n\n    return this.computeResults(docsAndScores, now);\n  }\n\n  /**\n   * NOTE: When adding documents to a vector store, use addDocuments\n   * via retriever instead of directly to the vector store.\n   * This is because it is necessary to process the document\n   * in prepareDocuments.\n   *\n   * @param docs - The documents to add to vector store in the retriever\n   */\n  async addDocuments(docs: DocumentInterface[]): Promise<void> {\n    const now = Math.floor(Date.now() / 1000);\n    const savedDocs = this.prepareDocuments(docs, now);\n\n    this.memoryStream.push(...savedDocs);\n    await this.vectorStore.addDocuments(savedDocs);\n  }\n\n  /**\n   * Get memory documents and their scores\n   * @returns An object containing memory documents and their scores\n   */\n  private getMemoryDocsAndScores(): Record<\n    number,\n    { doc: DocumentInterface; score: number }\n  > {\n    const memoryDocsAndScores: Record<\n      number,\n      { doc: DocumentInterface; score: number }\n    > = {};\n    for (const doc of this.memoryStream.slice(-this.k)) {\n      const bufferIdx = doc.metadata[BUFFER_IDX];\n      if (bufferIdx === undefined) {\n        throw new Error(\n          `Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the \"addDocuments\" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`\n        );\n      }\n      memoryDocsAndScores[bufferIdx] = {\n        doc,\n        score: this.defaultSalience ?? 0,\n      };\n    }\n    return memoryDocsAndScores;\n  }\n\n  /**\n   * Get salient documents and their scores based on the query\n   * @param query - The query to search for\n   * @returns An object containing salient documents and their scores\n   */\n  private async getSalientDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Record<number, { doc: DocumentInterface; score: number }>> {\n    const docAndScores: [DocumentInterface, number][] =\n      await this.vectorStore.similaritySearchWithScore(\n        query,\n        this.searchKwargs,\n        undefined,\n        runManager?.getChild()\n      );\n    const results: Record<number, { doc: DocumentInterface; score: number }> =\n      {};\n    for (const [fetchedDoc, score] of docAndScores) {\n      const bufferIdx = fetchedDoc.metadata[BUFFER_IDX];\n      if (bufferIdx === undefined) {\n        throw new Error(\n          `Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the \"addDocuments\" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`\n        );\n      }\n      const doc = this.memoryStream[bufferIdx];\n      results[bufferIdx] = { doc, score };\n    }\n    return results;\n  }\n\n  /**\n   * Compute the final result set of documents based on the combined scores\n   * @param docsAndScores - An object containing documents and their scores\n   * @param now - The current timestamp\n   * @returns The final set of documents\n   */\n  private computeResults(\n    docsAndScores: Record<number, { doc: DocumentInterface; score: number }>,\n    now: number\n  ): DocumentInterface[] {\n    const recordedDocs = Object.values(docsAndScores)\n      .map(({ doc, score }) => ({\n        doc,\n        score: this.getCombinedScore(doc, score, now),\n      }))\n      .sort((a, b) => b.score - a.score);\n\n    const results: DocumentInterface[] = [];\n    for (const { doc } of recordedDocs) {\n      const bufferedDoc = this.memoryStream[doc.metadata[BUFFER_IDX]];\n      bufferedDoc.metadata[LAST_ACCESSED_AT_KEY] = now;\n      results.push(bufferedDoc);\n      if (results.length > this.k) {\n        break;\n      }\n    }\n    return results;\n  }\n\n  /**\n   * Prepare documents with necessary metadata before saving\n   * @param docs - The documents to prepare\n   * @param now - The current timestamp\n   * @returns The prepared documents\n   */\n  private prepareDocuments(\n    docs: DocumentInterface[],\n    now: number\n  ): DocumentInterface[] {\n    return docs.map((doc, i) => ({\n      ...doc,\n      metadata: {\n        ...doc.metadata,\n        [LAST_ACCESSED_AT_KEY]: doc.metadata[LAST_ACCESSED_AT_KEY] ?? now,\n        created_at: doc.metadata.created_at ?? now,\n        [BUFFER_IDX]: this.memoryStream.length + i,\n      },\n    }));\n  }\n\n  /**\n   * Calculate the combined score based on vector relevance and other factors\n   * @param doc - The document to calculate the score for\n   * @param vectorRelevance - The relevance score from the vector store\n   * @param nowMsec - The current timestamp in milliseconds\n   * @returns The combined score for the document\n   */\n  private getCombinedScore(\n    doc: DocumentInterface,\n    vectorRelevance: number | null,\n    nowMsec: number\n  ): number {\n    const hoursPassed = this.getHoursPassed(\n      nowMsec,\n      doc.metadata[LAST_ACCESSED_AT_KEY]\n    );\n    let score = (1.0 - this.decayRate) ** hoursPassed;\n    for (const key of this.otherScoreKeys) {\n      score += doc.metadata[key];\n    }\n    if (vectorRelevance !== null) {\n      score += vectorRelevance;\n    }\n    return score;\n  }\n\n  /**\n   * Calculate the hours passed between two time points\n   * @param time - The current time in seconds\n   * @param refTime - The reference time in seconds\n   * @returns The number of hours passed between the two time points\n   */\n  private getHoursPassed(time: number, refTime: number): number {\n    return (time - refTime) / 3600;\n  }\n}\n"],"mappings":";;;;;;;;;AAmBA,MAAa,uBAAuB;AACpC,MAAa,aAAa;;;;;;;;;;;;;;;;;;;;;AAsB1B,IAAa,mCAAb,cAAsDA,2BAAAA,cAAc;CAClE,OAAO,UAAU;AACf,SAAO;;CAGT,IAAI,eAAe;AACjB,SAAO;GAAC;GAAa;GAAc;GAAgB;;;;;CAMrD;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;;CAMA,YAAY,QAAgD;AAC1D,QAAM,OAAO;AACb,OAAK,cAAc,OAAO;AAC1B,OAAK,eAAe,OAAO,gBAAgB;AAC3C,OAAK,eAAe,OAAO,gBAAgB,EAAE;AAC7C,OAAK,YAAY,OAAO,aAAa;AACrC,OAAK,IAAI,OAAO,KAAK;AACrB,OAAK,iBAAiB,OAAO,kBAAkB,EAAE;AACjD,OAAK,kBAAkB,OAAO,mBAAmB;;;;;;CAOnD,kBAAuC;AACrC,SAAO,KAAK;;;;;;CAOd,gBAAgB,cAAmC;AACjD,OAAK,eAAe;;;;;;;CAQtB,MAAM,sBACJ,OACA,YAC8B;EAC9B,MAAM,MAAM,KAAK,MAAM,KAAK,KAAK,GAAG,IAAK;EACzC,MAAM,sBAAsB,KAAK,wBAAwB;EAEzD,MAAM,uBAAuB,MAAM,KAAK,oBACtC,OACA,WACD;EACD,MAAM,gBAAgB;GAAE,GAAG;GAAqB,GAAG;GAAsB;AAEzE,SAAO,KAAK,eAAe,eAAe,IAAI;;;;;;;;;;CAWhD,MAAM,aAAa,MAA0C;EAC3D,MAAM,MAAM,KAAK,MAAM,KAAK,KAAK,GAAG,IAAK;EACzC,MAAM,YAAY,KAAK,iBAAiB,MAAM,IAAI;AAElD,OAAK,aAAa,KAAK,GAAG,UAAU;AACpC,QAAM,KAAK,YAAY,aAAa,UAAU;;;;;;CAOhD,yBAGE;EACA,MAAM,sBAGF,EAAE;AACN,OAAK,MAAM,OAAO,KAAK,aAAa,MAAM,CAAC,KAAK,EAAE,EAAE;GAClD,MAAM,YAAY,IAAI,SAAS;AAC/B,OAAI,cAAc,KAAA,EAChB,OAAM,IAAI,MACR,8RACD;AAEH,uBAAoB,aAAa;IAC/B;IACA,OAAO,KAAK,mBAAmB;IAChC;;AAEH,SAAO;;;;;;;CAQT,MAAc,oBACZ,OACA,YACoE;EACpE,MAAM,eACJ,MAAM,KAAK,YAAY,0BACrB,OACA,KAAK,cACL,KAAA,GACA,YAAY,UAAU,CACvB;EACH,MAAM,UACJ,EAAE;AACJ,OAAK,MAAM,CAAC,YAAY,UAAU,cAAc;GAC9C,MAAM,YAAY,WAAW,SAAS;AACtC,OAAI,cAAc,KAAA,EAChB,OAAM,IAAI,MACR,8RACD;AAGH,WAAQ,aAAa;IAAE,KADX,KAAK,aAAa;IACF;IAAO;;AAErC,SAAO;;;;;;;;CAST,eACE,eACA,KACqB;EACrB,MAAM,eAAe,OAAO,OAAO,cAAc,CAC9C,KAAK,EAAE,KAAK,aAAa;GACxB;GACA,OAAO,KAAK,iBAAiB,KAAK,OAAO,IAAI;GAC9C,EAAE,CACF,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,MAAM;EAEpC,MAAM,UAA+B,EAAE;AACvC,OAAK,MAAM,EAAE,SAAS,cAAc;GAClC,MAAM,cAAc,KAAK,aAAa,IAAI,SAAS;AACnD,eAAY,SAAS,wBAAwB;AAC7C,WAAQ,KAAK,YAAY;AACzB,OAAI,QAAQ,SAAS,KAAK,EACxB;;AAGJ,SAAO;;;;;;;;CAST,iBACE,MACA,KACqB;AACrB,SAAO,KAAK,KAAK,KAAK,OAAO;GAC3B,GAAG;GACH,UAAU;IACR,GAAG,IAAI;KACN,uBAAuB,IAAI,SAAA,uBAAkC;IAC9D,YAAY,IAAI,SAAS,cAAc;KACtC,aAAa,KAAK,aAAa,SAAS;IAC1C;GACF,EAAE;;;;;;;;;CAUL,iBACE,KACA,iBACA,SACQ;EACR,MAAM,cAAc,KAAK,eACvB,SACA,IAAI,SAAS,sBACd;EACD,IAAI,SAAS,IAAM,KAAK,cAAc;AACtC,OAAK,MAAM,OAAO,KAAK,eACrB,UAAS,IAAI,SAAS;AAExB,MAAI,oBAAoB,KACtB,UAAS;AAEX,SAAO;;;;;;;;CAST,eAAuB,MAAc,SAAyB;AAC5D,UAAQ,OAAO,WAAW"}
+{"version":3,"file":"time_weighted.cjs","names":["BaseRetriever"],"sources":["../../src/retrievers/time_weighted.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport type { VectorStoreInterface } from \"@langchain/core/vectorstores\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\n/**\n * Interface for the fields required to initialize a\n * TimeWeightedVectorStoreRetriever instance.\n */\nexport interface TimeWeightedVectorStoreRetrieverFields extends BaseRetrieverInput {\n  vectorStore: VectorStoreInterface;\n  searchKwargs?: number;\n  memoryStream?: DocumentInterface[];\n  decayRate?: number;\n  k?: number;\n  otherScoreKeys?: string[];\n  defaultSalience?: number;\n}\n\nexport const LAST_ACCESSED_AT_KEY = \"last_accessed_at\";\nexport const BUFFER_IDX = \"buffer_idx\";\n\n/**\n * TimeWeightedVectorStoreRetriever retrieves documents based on their time-weighted relevance.\n * ref: https://github.com/langchain-ai/langchain/blob/master/libs/langchain/langchain/retrievers/time_weighted_retriever.py\n * @example\n * ```typescript\n * const retriever = new TimeWeightedVectorStoreRetriever({\n *   vectorStore: new MemoryVectorStore(new OpenAIEmbeddings()),\n *   memoryStream: [],\n *   searchKwargs: 2,\n * });\n * await retriever.addDocuments([\n *   { pageContent: \"My name is John.\", metadata: {} },\n *   { pageContent: \"My favourite food is pizza.\", metadata: {} },\n *\n * ]);\n * const results = await retriever.invoke(\n *   \"What is my favourite food?\",\n * );\n * ```\n */\nexport class TimeWeightedVectorStoreRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"TimeWeightedVectorStoreRetriever\";\n  }\n\n  get lc_namespace() {\n    return [\"langchain\", \"retrievers\", \"time_weighted\"];\n  }\n\n  /**\n   * The vectorstore to store documents and determine salience.\n   */\n  private vectorStore: VectorStoreInterface;\n\n  /**\n   * The number of top K most relevant documents to consider when searching.\n   */\n  private searchKwargs: number;\n\n  /**\n   * The memory_stream of documents to search through.\n   */\n  private memoryStream: DocumentInterface[];\n\n  /**\n   * The exponential decay factor used as (1.0-decay_rate)**(hrs_passed).\n   */\n  private decayRate: number;\n\n  /**\n   * The maximum number of documents to retrieve in a given call.\n   */\n  private k: number;\n\n  /**\n   * Other keys in the metadata to factor into the score, e.g. 'importance'.\n   */\n  private otherScoreKeys: string[];\n\n  /**\n   * The salience to assign memories not retrieved from the vector store.\n   */\n  private defaultSalience: number | null;\n\n  /**\n   * Constructor to initialize the required fields\n   * @param fields - The fields required for initializing the TimeWeightedVectorStoreRetriever\n   */\n  constructor(fields: TimeWeightedVectorStoreRetrieverFields) {\n    super(fields);\n    this.vectorStore = fields.vectorStore;\n    this.searchKwargs = fields.searchKwargs ?? 100;\n    this.memoryStream = fields.memoryStream ?? [];\n    this.decayRate = fields.decayRate ?? 0.01;\n    this.k = fields.k ?? 4;\n    this.otherScoreKeys = fields.otherScoreKeys ?? [];\n    this.defaultSalience = fields.defaultSalience ?? null;\n  }\n\n  /**\n   * Get the memory stream of documents.\n   * @returns The memory stream of documents.\n   */\n  getMemoryStream(): DocumentInterface[] {\n    return this.memoryStream;\n  }\n\n  /**\n   * Set the memory stream of documents.\n   * @param memoryStream The new memory stream of documents.\n   */\n  setMemoryStream(memoryStream: DocumentInterface[]) {\n    this.memoryStream = memoryStream;\n  }\n\n  /**\n   * Get relevant documents based on time-weighted relevance\n   * @param query - The query to search for\n   * @returns The relevant documents\n   */\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<DocumentInterface[]> {\n    const now = Math.floor(Date.now() / 1000);\n    const memoryDocsAndScores = this.getMemoryDocsAndScores();\n\n    const salientDocsAndScores = await this.getSalientDocuments(\n      query,\n      runManager\n    );\n    const docsAndScores = { ...memoryDocsAndScores, ...salientDocsAndScores };\n\n    return this.computeResults(docsAndScores, now);\n  }\n\n  /**\n   * NOTE: When adding documents to a vector store, use addDocuments\n   * via retriever instead of directly to the vector store.\n   * This is because it is necessary to process the document\n   * in prepareDocuments.\n   *\n   * @param docs - The documents to add to vector store in the retriever\n   */\n  async addDocuments(docs: DocumentInterface[]): Promise<void> {\n    const now = Math.floor(Date.now() / 1000);\n    const savedDocs = this.prepareDocuments(docs, now);\n\n    this.memoryStream.push(...savedDocs);\n    await this.vectorStore.addDocuments(savedDocs);\n  }\n\n  /**\n   * Get memory documents and their scores\n   * @returns An object containing memory documents and their scores\n   */\n  private getMemoryDocsAndScores(): Record<\n    number,\n    { doc: DocumentInterface; score: number }\n  > {\n    const memoryDocsAndScores: Record<\n      number,\n      { doc: DocumentInterface; score: number }\n    > = {};\n    for (const doc of this.memoryStream.slice(-this.k)) {\n      const bufferIdx = doc.metadata[BUFFER_IDX];\n      if (bufferIdx === undefined) {\n        throw new Error(\n          `Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the \"addDocuments\" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`\n        );\n      }\n      memoryDocsAndScores[bufferIdx] = {\n        doc,\n        score: this.defaultSalience ?? 0,\n      };\n    }\n    return memoryDocsAndScores;\n  }\n\n  /**\n   * Get salient documents and their scores based on the query\n   * @param query - The query to search for\n   * @returns An object containing salient documents and their scores\n   */\n  private async getSalientDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<Record<number, { doc: DocumentInterface; score: number }>> {\n    const docAndScores: [DocumentInterface, number][] =\n      await this.vectorStore.similaritySearchWithScore(\n        query,\n        this.searchKwargs,\n        undefined,\n        runManager?.getChild()\n      );\n    const results: Record<number, { doc: DocumentInterface; score: number }> =\n      {};\n    for (const [fetchedDoc, score] of docAndScores) {\n      const bufferIdx = fetchedDoc.metadata[BUFFER_IDX];\n      if (bufferIdx === undefined) {\n        throw new Error(\n          `Found a document in the vector store that is missing required metadata. This retriever only supports vector stores with documents that have been added through the \"addDocuments\" method on a TimeWeightedVectorStoreRetriever, not directly added or loaded into the backing vector store.`\n        );\n      }\n      const doc = this.memoryStream[bufferIdx];\n      results[bufferIdx] = { doc, score };\n    }\n    return results;\n  }\n\n  /**\n   * Compute the final result set of documents based on the combined scores\n   * @param docsAndScores - An object containing documents and their scores\n   * @param now - The current timestamp\n   * @returns The final set of documents\n   */\n  private computeResults(\n    docsAndScores: Record<number, { doc: DocumentInterface; score: number }>,\n    now: number\n  ): DocumentInterface[] {\n    const recordedDocs = Object.values(docsAndScores)\n      .map(({ doc, score }) => ({\n        doc,\n        score: this.getCombinedScore(doc, score, now),\n      }))\n      .sort((a, b) => b.score - a.score);\n\n    const results: DocumentInterface[] = [];\n    for (const { doc } of recordedDocs) {\n      const bufferedDoc = this.memoryStream[doc.metadata[BUFFER_IDX]];\n      bufferedDoc.metadata[LAST_ACCESSED_AT_KEY] = now;\n      results.push(bufferedDoc);\n      if (results.length > this.k) {\n        break;\n      }\n    }\n    return results;\n  }\n\n  /**\n   * Prepare documents with necessary metadata before saving\n   * @param docs - The documents to prepare\n   * @param now - The current timestamp\n   * @returns The prepared documents\n   */\n  private prepareDocuments(\n    docs: DocumentInterface[],\n    now: number\n  ): DocumentInterface[] {\n    return docs.map((doc, i) => ({\n      ...doc,\n      metadata: {\n        ...doc.metadata,\n        [LAST_ACCESSED_AT_KEY]: doc.metadata[LAST_ACCESSED_AT_KEY] ?? now,\n        created_at: doc.metadata.created_at ?? now,\n        [BUFFER_IDX]: this.memoryStream.length + i,\n      },\n    }));\n  }\n\n  /**\n   * Calculate the combined score based on vector relevance and other factors\n   * @param doc - The document to calculate the score for\n   * @param vectorRelevance - The relevance score from the vector store\n   * @param nowMsec - The current timestamp in milliseconds\n   * @returns The combined score for the document\n   */\n  private getCombinedScore(\n    doc: DocumentInterface,\n    vectorRelevance: number | null,\n    nowMsec: number\n  ): number {\n    const hoursPassed = this.getHoursPassed(\n      nowMsec,\n      doc.metadata[LAST_ACCESSED_AT_KEY]\n    );\n    let score = (1.0 - this.decayRate) ** hoursPassed;\n    for (const key of this.otherScoreKeys) {\n      score += doc.metadata[key];\n    }\n    if (vectorRelevance !== null) {\n      score += vectorRelevance;\n    }\n    return score;\n  }\n\n  /**\n   * Calculate the hours passed between two time points\n   * @param time - The current time in seconds\n   * @param refTime - The reference time in seconds\n   * @returns The number of hours passed between the two time points\n   */\n  private getHoursPassed(time: number, refTime: number): number {\n    return (time - refTime) / 3600;\n  }\n}\n"],"mappings":";;;;;;;;;AAmBA,MAAa,uBAAuB;AACpC,MAAa,aAAa;;;;;;;;;;;;;;;;;;;;;AAsB1B,IAAa,mCAAb,cAAsDA,2BAAAA,cAAc;CAClE,OAAO,UAAU;EACf,OAAO;CACT;CAEA,IAAI,eAAe;EACjB,OAAO;GAAC;GAAa;GAAc;EAAe;CACpD;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;CAKA;;;;;CAMA,YAAY,QAAgD;EAC1D,MAAM,MAAM;EACZ,KAAK,cAAc,OAAO;EAC1B,KAAK,eAAe,OAAO,gBAAgB;EAC3C,KAAK,eAAe,OAAO,gBAAgB,CAAC;EAC5C,KAAK,YAAY,OAAO,aAAa;EACrC,KAAK,IAAI,OAAO,KAAK;EACrB,KAAK,iBAAiB,OAAO,kBAAkB,CAAC;EAChD,KAAK,kBAAkB,OAAO,mBAAmB;CACnD;;;;;CAMA,kBAAuC;EACrC,OAAO,KAAK;CACd;;;;;CAMA,gBAAgB,cAAmC;EACjD,KAAK,eAAe;CACtB;;;;;;CAOA,MAAM,sBACJ,OACA,YAC8B;EAC9B,MAAM,MAAM,KAAK,MAAM,KAAK,IAAI,IAAI,GAAI;EACxC,MAAM,sBAAsB,KAAK,uBAAuB;EAExD,MAAM,uBAAuB,MAAM,KAAK,oBACtC,OACA,UACF;EACA,MAAM,gBAAgB;GAAE,GAAG;GAAqB,GAAG;EAAqB;EAExE,OAAO,KAAK,eAAe,eAAe,GAAG;CAC/C;;;;;;;;;CAUA,MAAM,aAAa,MAA0C;EAC3D,MAAM,MAAM,KAAK,MAAM,KAAK,IAAI,IAAI,GAAI;EACxC,MAAM,YAAY,KAAK,iBAAiB,MAAM,GAAG;EAEjD,KAAK,aAAa,KAAK,GAAG,SAAS;EACnC,MAAM,KAAK,YAAY,aAAa,SAAS;CAC/C;;;;;CAMA,yBAGE;EACA,MAAM,sBAGF,CAAC;EACL,KAAK,MAAM,OAAO,KAAK,aAAa,MAAM,CAAC,KAAK,CAAC,GAAG;GAClD,MAAM,YAAY,IAAI,SAAS;GAC/B,IAAI,cAAc,KAAA,GAChB,MAAM,IAAI,MACR,6RACF;GAEF,oBAAoB,aAAa;IAC/B;IACA,OAAO,KAAK,mBAAmB;GACjC;EACF;EACA,OAAO;CACT;;;;;;CAOA,MAAc,oBACZ,OACA,YACoE;EACpE,MAAM,eACJ,MAAM,KAAK,YAAY,0BACrB,OACA,KAAK,cACL,KAAA,GACA,YAAY,SAAS,CACvB;EACF,MAAM,UACJ,CAAC;EACH,KAAK,MAAM,CAAC,YAAY,UAAU,cAAc;GAC9C,MAAM,YAAY,WAAW,SAAS;GACtC,IAAI,cAAc,KAAA,GAChB,MAAM,IAAI,MACR,6RACF;GAGF,QAAQ,aAAa;IAAE,KADX,KAAK,aAAa;IACF;GAAM;EACpC;EACA,OAAO;CACT;;;;;;;CAQA,eACE,eACA,KACqB;EACrB,MAAM,eAAe,OAAO,OAAO,aAAa,CAAC,CAC9C,KAAK,EAAE,KAAK,aAAa;GACxB;GACA,OAAO,KAAK,iBAAiB,KAAK,OAAO,GAAG;EAC9C,EAAE,CAAC,CACF,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,KAAK;EAEnC,MAAM,UAA+B,CAAC;EACtC,KAAK,MAAM,EAAE,SAAS,cAAc;GAClC,MAAM,cAAc,KAAK,aAAa,IAAI,SAAS;GACnD,YAAY,SAAS,wBAAwB;GAC7C,QAAQ,KAAK,WAAW;GACxB,IAAI,QAAQ,SAAS,KAAK,GACxB;EAEJ;EACA,OAAO;CACT;;;;;;;CAQA,iBACE,MACA,KACqB;EACrB,OAAO,KAAK,KAAK,KAAK,OAAO;GAC3B,GAAG;GACH,UAAU;IACR,GAAG,IAAI;KACN,uBAAuB,IAAI,SAAA,uBAAkC;IAC9D,YAAY,IAAI,SAAS,cAAc;KACtC,aAAa,KAAK,aAAa,SAAS;GAC3C;EACF,EAAE;CACJ;;;;;;;;CASA,iBACE,KACA,iBACA,SACQ;EACR,MAAM,cAAc,KAAK,eACvB,SACA,IAAI,SAAS,qBACf;EACA,IAAI,SAAS,IAAM,KAAK,cAAc;EACtC,KAAK,MAAM,OAAO,KAAK,gBACrB,SAAS,IAAI,SAAS;EAExB,IAAI,oBAAoB,MACtB,SAAS;EAEX,OAAO;CACT;;;;;;;CAQA,eAAuB,MAAc,SAAyB;EAC5D,QAAQ,OAAO,WAAW;CAC5B;AACF"}