@langchain/classic 1.0.33 → 1.0.35

package/dist/output_parsers/structured.js.map

@@ -1 +1 @@
-{"version":3,"file":"structured.js","names":[],"sources":["../../src/output_parsers/structured.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport {\n  toJsonSchema,\n  type JsonSchema7Type,\n  type JsonSchema7ArrayType,\n  type JsonSchema7ObjectType,\n  type JsonSchema7StringType,\n  type JsonSchema7NumberType,\n  type JsonSchema7NullableType,\n} from \"@langchain/core/utils/json_schema\";\nimport {\n  BaseOutputParser,\n  FormatInstructionsOptions,\n  OutputParserException,\n} from \"@langchain/core/output_parsers\";\nimport {\n  interopParseAsync,\n  type InferInteropZodOutput,\n  type InteropZodType,\n} from \"@langchain/core/utils/types\";\n\nexport type JsonMarkdownStructuredOutputParserInput = {\n  interpolationDepth?: number;\n};\n\nexport interface JsonMarkdownFormatInstructionsOptions extends FormatInstructionsOptions {\n  interpolationDepth?: number;\n}\n\nexport class StructuredOutputParser<\n  T extends InteropZodType,\n> extends BaseOutputParser<InferInteropZodOutput<T>> {\n  static lc_name() {\n    return \"StructuredOutputParser\";\n  }\n\n  lc_namespace = [\"langchain\", \"output_parsers\", \"structured\"];\n\n  toJSON() {\n    return this.toJSONNotImplemented();\n  }\n\n  constructor(public schema: T) {\n    super(schema);\n  }\n\n  /**\n   * Creates a new StructuredOutputParser from a Zod schema.\n   * @param schema The Zod schema which the output should match\n   * @returns A new instance of StructuredOutputParser.\n   */\n  static fromZodSchema<T extends InteropZodType>(schema: T) {\n    return new this(schema);\n  }\n\n  /**\n   * Creates a new StructuredOutputParser from a set of names and\n   * descriptions.\n   * @param schemas An object where each key is a name and each value is a description\n   * @returns A new instance of StructuredOutputParser.\n   */\n  static fromNamesAndDescriptions<S extends { [key: string]: string }>(\n    schemas: S\n  ) {\n    const zodSchema = z.object(\n      Object.fromEntries(\n        Object.entries(schemas).map(\n          ([name, description]) =>\n            [name, z.string().describe(description)] as const\n        )\n      )\n    );\n\n    return new this(zodSchema);\n  }\n\n  /**\n   * Returns a markdown code snippet with a JSON object formatted according\n   * to the schema.\n   * @param options Optional. The options for formatting the instructions\n   * @returns A markdown code snippet with a JSON object formatted according to the schema.\n   */\n  getFormatInstructions(): string {\n    return `You must format your output as a JSON value that adheres to a given \"JSON Schema\" instance.\n\n\"JSON Schema\" is a declarative language that allows you to annotate and validate JSON documents.\n\nFor example, the example \"JSON Schema\" instance {{\"properties\": {{\"foo\": {{\"description\": \"a list of test words\", \"type\": \"array\", \"items\": {{\"type\": \"string\"}}}}}}, \"required\": [\"foo\"]}}}}\nwould match an object with one required property, \"foo\". The \"type\" property specifies \"foo\" must be an \"array\", and the \"description\" property semantically describes it as \"a list of test words\". The items within \"foo\" must be strings.\nThus, the object {{\"foo\": [\"bar\", \"baz\"]}} is a well-formatted instance of this example \"JSON Schema\". The object {{\"properties\": {{\"foo\": [\"bar\", \"baz\"]}}}} is not well-formatted.\n\nYour output will be parsed and type-checked according to the provided schema instance, so make sure all fields in your output match the schema exactly and there are no trailing commas!\n\nHere is the JSON Schema instance your output must adhere to. Include the enclosing markdown codeblock:\n\\`\\`\\`json\n${JSON.stringify(toJsonSchema(this.schema))}\n\\`\\`\\`\n`;\n  }\n\n  /**\n   * Parses the given text according to the schema.\n   * @param text The text to parse\n   * @returns The parsed output.\n   */\n  async parse(text: string): Promise<InferInteropZodOutput<T>> {\n    try {\n      const json = text.includes(\"```\")\n        ? text.trim().split(/```(?:json)?/)[1]\n        : text.trim();\n      return await interopParseAsync(this.schema, JSON.parse(json));\n    } catch {\n      try {\n        return await interopParseAsync(this.schema, JSON.parse(text.trim()));\n      } catch (e2) {\n        throw new OutputParserException(\n          `Failed to parse. Text: \"${text}\". Error: ${e2}`,\n          text\n        );\n      }\n    }\n  }\n}\n\n/**\n * A specific type of `StructuredOutputParser` that parses JSON data\n * formatted as a markdown code snippet.\n */\nexport class JsonMarkdownStructuredOutputParser<\n  T extends InteropZodType,\n> extends StructuredOutputParser<T> {\n  static lc_name() {\n    return \"JsonMarkdownStructuredOutputParser\";\n  }\n\n  getFormatInstructions(\n    options?: JsonMarkdownFormatInstructionsOptions\n  ): string {\n    const interpolationDepth = options?.interpolationDepth ?? 1;\n    if (interpolationDepth < 1) {\n      throw new Error(\"f string interpolation depth must be at least 1\");\n    }\n\n    return `Return a markdown code snippet with a JSON object formatted to look like:\\n\\`\\`\\`json\\n${this._schemaToInstruction(\n      toJsonSchema(this.schema)\n    )\n      .replaceAll(\"{\", \"{\".repeat(interpolationDepth))\n      .replaceAll(\"}\", \"}\".repeat(interpolationDepth))}\\n\\`\\`\\``;\n  }\n\n  private _schemaToInstruction(\n    schemaInput: JsonSchema7Type,\n    indent = 2\n  ): string {\n    const schema = schemaInput as Extract<\n      JsonSchema7Type,\n      | JsonSchema7ObjectType\n      | JsonSchema7ArrayType\n      | JsonSchema7StringType\n      | JsonSchema7NumberType\n      | JsonSchema7NullableType\n    >;\n\n    if (\"type\" in schema) {\n      let nullable = false;\n      let type: string;\n      if (Array.isArray(schema.type)) {\n        const nullIdx = schema.type.findIndex((type) => type === \"null\");\n        if (nullIdx !== -1) {\n          nullable = true;\n          schema.type.splice(nullIdx, 1);\n        }\n        type = schema.type.join(\" | \") as string;\n      } else {\n        type = schema.type;\n      }\n\n      if (schema.type === \"object\" && schema.properties) {\n        const description = schema.description\n          ? ` // ${schema.description}`\n          : \"\";\n        const properties = Object.entries(schema.properties)\n          .map(([key, value]) => {\n            const isOptional = schema.required?.includes(key)\n              ? \"\"\n              : \" (optional)\";\n            return `${\" \".repeat(indent)}\"${key}\": ${this._schemaToInstruction(\n              value,\n              indent + 2\n            )}${isOptional}`;\n          })\n          .join(\"\\n\");\n        return `{\\n${properties}\\n${\" \".repeat(indent - 2)}}${description}`;\n      }\n      if (schema.type === \"array\" && schema.items) {\n        const description = schema.description\n          ? ` // ${schema.description}`\n          : \"\";\n        return `array[\\n${\" \".repeat(indent)}${this._schemaToInstruction(\n          schema.items,\n          indent + 2\n        )}\\n${\" \".repeat(indent - 2)}] ${description}`;\n      }\n      const isNullable = nullable ? \" (nullable)\" : \"\";\n      const description = schema.description ? ` // ${schema.description}` : \"\";\n      return `${type}${description}${isNullable}`;\n    }\n\n    if (\"anyOf\" in schema) {\n      return schema.anyOf\n        .map((s) => this._schemaToInstruction(s, indent))\n        .join(`\\n${\" \".repeat(indent - 2)}`);\n    }\n\n    throw new Error(\"unsupported schema type\");\n  }\n\n  static fromZodSchema<T extends InteropZodType>(schema: T) {\n    return new this<T>(schema);\n  }\n\n  static fromNamesAndDescriptions<S extends { [key: string]: string }>(\n    schemas: S\n  ) {\n    const zodSchema = z.object(\n      Object.fromEntries(\n        Object.entries(schemas).map(\n          ([name, description]) =>\n            [name, z.string().describe(description)] as const\n        )\n      )\n    );\n\n    return new this<typeof zodSchema>(zodSchema);\n  }\n}\n\nexport interface AsymmetricStructuredOutputParserFields<\n  T extends InteropZodType,\n> {\n  inputSchema: T;\n}\n\n/**\n * A type of `StructuredOutputParser` that handles asymmetric input and\n * output schemas.\n */\nexport abstract class AsymmetricStructuredOutputParser<\n  T extends InteropZodType,\n  Y = unknown,\n> extends BaseOutputParser<Y> {\n  private structuredInputParser: JsonMarkdownStructuredOutputParser<T>;\n\n  constructor({ inputSchema }: AsymmetricStructuredOutputParserFields<T>) {\n    super(...arguments);\n    this.structuredInputParser = new JsonMarkdownStructuredOutputParser(\n      inputSchema\n    );\n  }\n\n  /**\n   * Processes the parsed input into the desired output format. Must be\n   * implemented by subclasses.\n   * @param input The parsed input\n   * @returns The processed output.\n   */\n  abstract outputProcessor(input: InferInteropZodOutput<T>): Promise<Y>;\n\n  async parse(text: string): Promise<Y> {\n    let parsedInput;\n    try {\n      parsedInput = await this.structuredInputParser.parse(text);\n    } catch (e) {\n      throw new OutputParserException(\n        `Failed to parse. Text: \"${text}\". Error: ${e}`,\n        text\n      );\n    }\n\n    return this.outputProcessor(parsedInput);\n  }\n\n  getFormatInstructions(): string {\n    return this.structuredInputParser.getFormatInstructions();\n  }\n}\n"],"mappings":";;;;;AA6BA,IAAa,yBAAb,cAEU,iBAA2C;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAkB;EAAa;CAE5D,SAAS;AACP,SAAO,KAAK,sBAAsB;;CAGpC,YAAY,QAAkB;AAC5B,QAAM,OAAO;AADI,OAAA,SAAA;;;;;;;CASnB,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAK,OAAO;;;;;;;;CASzB,OAAO,yBACL,SACA;EACA,MAAM,YAAY,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAK,UAAU;;;;;;;;CAS5B,wBAAgC;AAC9B,SAAO;;;;;;;;;;;;EAYT,KAAK,UAAU,aAAa,KAAK,OAAO,CAAC,CAAC;;;;;;;;;CAU1C,MAAM,MAAM,MAAiD;AAC3D,MAAI;GACF,MAAM,OAAO,KAAK,SAAS,MAAM,GAC7B,KAAK,MAAM,CAAC,MAAM,eAAe,CAAC,KAClC,KAAK,MAAM;AACf,UAAO,MAAM,kBAAkB,KAAK,QAAQ,KAAK,MAAM,KAAK,CAAC;UACvD;AACN,OAAI;AACF,WAAO,MAAM,kBAAkB,KAAK,QAAQ,KAAK,MAAM,KAAK,MAAM,CAAC,CAAC;YAC7D,IAAI;AACX,UAAM,IAAI,sBACR,2BAA2B,KAAK,YAAY,MAC5C,KACD;;;;;;;;;AAUT,IAAa,qCAAb,cAEU,uBAA0B;CAClC,OAAO,UAAU;AACf,SAAO;;CAGT,sBACE,SACQ;EACR,MAAM,qBAAqB,SAAS,sBAAsB;AAC1D,MAAI,qBAAqB,EACvB,OAAM,IAAI,MAAM,kDAAkD;AAGpE,SAAO,0FAA0F,KAAK,qBACpG,aAAa,KAAK,OAAO,CAC1B,CACE,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAC/C,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAAC;;CAGrD,qBACE,aACA,SAAS,GACD;EACR,MAAM,SAAS;AASf,MAAI,UAAU,QAAQ;GACpB,IAAI,WAAW;GACf,IAAI;AACJ,OAAI,MAAM,QAAQ,OAAO,KAAK,EAAE;IAC9B,MAAM,UAAU,OAAO,KAAK,WAAW,SAAS,SAAS,OAAO;AAChE,QAAI,YAAY,IAAI;AAClB,gBAAW;AACX,YAAO,KAAK,OAAO,SAAS,EAAE;;AAEhC,WAAO,OAAO,KAAK,KAAK,MAAM;SAE9B,QAAO,OAAO;AAGhB,OAAI,OAAO,SAAS,YAAY,OAAO,YAAY;IACjD,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AAYJ,WAAO,MAXY,OAAO,QAAQ,OAAO,WAAW,CACjD,KAAK,CAAC,KAAK,WAAW;KACrB,MAAM,aAAa,OAAO,UAAU,SAAS,IAAI,GAC7C,KACA;AACJ,YAAO,GAAG,IAAI,OAAO,OAAO,CAAC,GAAG,IAAI,KAAK,KAAK,qBAC5C,OACA,SAAS,EACV,GAAG;MACJ,CACD,KAAK,KAAK,CACW,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,GAAG;;AAExD,OAAI,OAAO,SAAS,WAAW,OAAO,OAAO;IAC3C,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AACJ,WAAO,WAAW,IAAI,OAAO,OAAO,GAAG,KAAK,qBAC1C,OAAO,OACP,SAAS,EACV,CAAC,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,IAAI;;GAEnC,MAAM,aAAa,WAAW,gBAAgB;GAC9C,MAAM,cAAc,OAAO,cAAc,OAAO,OAAO,gBAAgB;AACvE,UAAO,GAAG,OAAO,cAAc;;AAGjC,MAAI,WAAW,OACb,QAAO,OAAO,MACX,KAAK,MAAM,KAAK,qBAAqB,GAAG,OAAO,CAAC,CAChD,KAAK,KAAK,IAAI,OAAO,SAAS,EAAE,GAAG;AAGxC,QAAM,IAAI,MAAM,0BAA0B;;CAG5C,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAQ,OAAO;;CAG5B,OAAO,yBACL,SACA;EACA,MAAM,YAAY,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAuB,UAAU;;;;;;;AAchD,IAAsB,mCAAtB,cAGU,iBAAoB;CAC5B;CAEA,YAAY,EAAE,eAA0D;AACtE,QAAM,GAAG,UAAU;AACnB,OAAK,wBAAwB,IAAI,mCAC/B,YACD;;CAWH,MAAM,MAAM,MAA0B;EACpC,IAAI;AACJ,MAAI;AACF,iBAAc,MAAM,KAAK,sBAAsB,MAAM,KAAK;WACnD,GAAG;AACV,SAAM,IAAI,sBACR,2BAA2B,KAAK,YAAY,KAC5C,KACD;;AAGH,SAAO,KAAK,gBAAgB,YAAY;;CAG1C,wBAAgC;AAC9B,SAAO,KAAK,sBAAsB,uBAAuB"}
+{"version":3,"file":"structured.js","names":[],"sources":["../../src/output_parsers/structured.ts"],"sourcesContent":["import { z } from \"zod/v3\";\nimport {\n  toJsonSchema,\n  type JsonSchema7Type,\n  type JsonSchema7ArrayType,\n  type JsonSchema7ObjectType,\n  type JsonSchema7StringType,\n  type JsonSchema7NumberType,\n  type JsonSchema7NullableType,\n} from \"@langchain/core/utils/json_schema\";\nimport {\n  BaseOutputParser,\n  FormatInstructionsOptions,\n  OutputParserException,\n} from \"@langchain/core/output_parsers\";\nimport {\n  interopParseAsync,\n  type InferInteropZodOutput,\n  type InteropZodType,\n} from \"@langchain/core/utils/types\";\n\nexport type JsonMarkdownStructuredOutputParserInput = {\n  interpolationDepth?: number;\n};\n\nexport interface JsonMarkdownFormatInstructionsOptions extends FormatInstructionsOptions {\n  interpolationDepth?: number;\n}\n\nexport class StructuredOutputParser<\n  T extends InteropZodType,\n> extends BaseOutputParser<InferInteropZodOutput<T>> {\n  static lc_name() {\n    return \"StructuredOutputParser\";\n  }\n\n  lc_namespace = [\"langchain\", \"output_parsers\", \"structured\"];\n\n  toJSON() {\n    return this.toJSONNotImplemented();\n  }\n\n  constructor(public schema: T) {\n    super(schema);\n  }\n\n  /**\n   * Creates a new StructuredOutputParser from a Zod schema.\n   * @param schema The Zod schema which the output should match\n   * @returns A new instance of StructuredOutputParser.\n   */\n  static fromZodSchema<T extends InteropZodType>(schema: T) {\n    return new this(schema);\n  }\n\n  /**\n   * Creates a new StructuredOutputParser from a set of names and\n   * descriptions.\n   * @param schemas An object where each key is a name and each value is a description\n   * @returns A new instance of StructuredOutputParser.\n   */\n  static fromNamesAndDescriptions<S extends { [key: string]: string }>(\n    schemas: S\n  ) {\n    const zodSchema = z.object(\n      Object.fromEntries(\n        Object.entries(schemas).map(\n          ([name, description]) =>\n            [name, z.string().describe(description)] as const\n        )\n      )\n    );\n\n    return new this(zodSchema);\n  }\n\n  /**\n   * Returns a markdown code snippet with a JSON object formatted according\n   * to the schema.\n   * @param options Optional. The options for formatting the instructions\n   * @returns A markdown code snippet with a JSON object formatted according to the schema.\n   */\n  getFormatInstructions(): string {\n    return `You must format your output as a JSON value that adheres to a given \"JSON Schema\" instance.\n\n\"JSON Schema\" is a declarative language that allows you to annotate and validate JSON documents.\n\nFor example, the example \"JSON Schema\" instance {{\"properties\": {{\"foo\": {{\"description\": \"a list of test words\", \"type\": \"array\", \"items\": {{\"type\": \"string\"}}}}}}, \"required\": [\"foo\"]}}}}\nwould match an object with one required property, \"foo\". The \"type\" property specifies \"foo\" must be an \"array\", and the \"description\" property semantically describes it as \"a list of test words\". The items within \"foo\" must be strings.\nThus, the object {{\"foo\": [\"bar\", \"baz\"]}} is a well-formatted instance of this example \"JSON Schema\". The object {{\"properties\": {{\"foo\": [\"bar\", \"baz\"]}}}} is not well-formatted.\n\nYour output will be parsed and type-checked according to the provided schema instance, so make sure all fields in your output match the schema exactly and there are no trailing commas!\n\nHere is the JSON Schema instance your output must adhere to. Include the enclosing markdown codeblock:\n\\`\\`\\`json\n${JSON.stringify(toJsonSchema(this.schema))}\n\\`\\`\\`\n`;\n  }\n\n  /**\n   * Parses the given text according to the schema.\n   * @param text The text to parse\n   * @returns The parsed output.\n   */\n  async parse(text: string): Promise<InferInteropZodOutput<T>> {\n    try {\n      const json = text.includes(\"```\")\n        ? text.trim().split(/```(?:json)?/)[1]\n        : text.trim();\n      return await interopParseAsync(this.schema, JSON.parse(json));\n    } catch {\n      try {\n        return await interopParseAsync(this.schema, JSON.parse(text.trim()));\n      } catch (e2) {\n        throw new OutputParserException(\n          `Failed to parse. Text: \"${text}\". Error: ${e2}`,\n          text\n        );\n      }\n    }\n  }\n}\n\n/**\n * A specific type of `StructuredOutputParser` that parses JSON data\n * formatted as a markdown code snippet.\n */\nexport class JsonMarkdownStructuredOutputParser<\n  T extends InteropZodType,\n> extends StructuredOutputParser<T> {\n  static lc_name() {\n    return \"JsonMarkdownStructuredOutputParser\";\n  }\n\n  getFormatInstructions(\n    options?: JsonMarkdownFormatInstructionsOptions\n  ): string {\n    const interpolationDepth = options?.interpolationDepth ?? 1;\n    if (interpolationDepth < 1) {\n      throw new Error(\"f string interpolation depth must be at least 1\");\n    }\n\n    return `Return a markdown code snippet with a JSON object formatted to look like:\\n\\`\\`\\`json\\n${this._schemaToInstruction(\n      toJsonSchema(this.schema)\n    )\n      .replaceAll(\"{\", \"{\".repeat(interpolationDepth))\n      .replaceAll(\"}\", \"}\".repeat(interpolationDepth))}\\n\\`\\`\\``;\n  }\n\n  private _schemaToInstruction(\n    schemaInput: JsonSchema7Type,\n    indent = 2\n  ): string {\n    const schema = schemaInput as Extract<\n      JsonSchema7Type,\n      | JsonSchema7ObjectType\n      | JsonSchema7ArrayType\n      | JsonSchema7StringType\n      | JsonSchema7NumberType\n      | JsonSchema7NullableType\n    >;\n\n    if (\"type\" in schema) {\n      let nullable = false;\n      let type: string;\n      if (Array.isArray(schema.type)) {\n        const nullIdx = schema.type.findIndex((type) => type === \"null\");\n        if (nullIdx !== -1) {\n          nullable = true;\n          schema.type.splice(nullIdx, 1);\n        }\n        type = schema.type.join(\" | \") as string;\n      } else {\n        type = schema.type;\n      }\n\n      if (schema.type === \"object\" && schema.properties) {\n        const description = schema.description\n          ? ` // ${schema.description}`\n          : \"\";\n        const properties = Object.entries(schema.properties)\n          .map(([key, value]) => {\n            const isOptional = schema.required?.includes(key)\n              ? \"\"\n              : \" (optional)\";\n            return `${\" \".repeat(indent)}\"${key}\": ${this._schemaToInstruction(\n              value,\n              indent + 2\n            )}${isOptional}`;\n          })\n          .join(\"\\n\");\n        return `{\\n${properties}\\n${\" \".repeat(indent - 2)}}${description}`;\n      }\n      if (schema.type === \"array\" && schema.items) {\n        const description = schema.description\n          ? ` // ${schema.description}`\n          : \"\";\n        return `array[\\n${\" \".repeat(indent)}${this._schemaToInstruction(\n          schema.items,\n          indent + 2\n        )}\\n${\" \".repeat(indent - 2)}] ${description}`;\n      }\n      const isNullable = nullable ? \" (nullable)\" : \"\";\n      const description = schema.description ? ` // ${schema.description}` : \"\";\n      return `${type}${description}${isNullable}`;\n    }\n\n    if (\"anyOf\" in schema) {\n      return schema.anyOf\n        .map((s) => this._schemaToInstruction(s, indent))\n        .join(`\\n${\" \".repeat(indent - 2)}`);\n    }\n\n    throw new Error(\"unsupported schema type\");\n  }\n\n  static fromZodSchema<T extends InteropZodType>(schema: T) {\n    return new this<T>(schema);\n  }\n\n  static fromNamesAndDescriptions<S extends { [key: string]: string }>(\n    schemas: S\n  ) {\n    const zodSchema = z.object(\n      Object.fromEntries(\n        Object.entries(schemas).map(\n          ([name, description]) =>\n            [name, z.string().describe(description)] as const\n        )\n      )\n    );\n\n    return new this<typeof zodSchema>(zodSchema);\n  }\n}\n\nexport interface AsymmetricStructuredOutputParserFields<\n  T extends InteropZodType,\n> {\n  inputSchema: T;\n}\n\n/**\n * A type of `StructuredOutputParser` that handles asymmetric input and\n * output schemas.\n */\nexport abstract class AsymmetricStructuredOutputParser<\n  T extends InteropZodType,\n  Y = unknown,\n> extends BaseOutputParser<Y> {\n  private structuredInputParser: JsonMarkdownStructuredOutputParser<T>;\n\n  constructor({ inputSchema }: AsymmetricStructuredOutputParserFields<T>) {\n    super(...arguments);\n    this.structuredInputParser = new JsonMarkdownStructuredOutputParser(\n      inputSchema\n    );\n  }\n\n  /**\n   * Processes the parsed input into the desired output format. Must be\n   * implemented by subclasses.\n   * @param input The parsed input\n   * @returns The processed output.\n   */\n  abstract outputProcessor(input: InferInteropZodOutput<T>): Promise<Y>;\n\n  async parse(text: string): Promise<Y> {\n    let parsedInput;\n    try {\n      parsedInput = await this.structuredInputParser.parse(text);\n    } catch (e) {\n      throw new OutputParserException(\n        `Failed to parse. Text: \"${text}\". Error: ${e}`,\n        text\n      );\n    }\n\n    return this.outputProcessor(parsedInput);\n  }\n\n  getFormatInstructions(): string {\n    return this.structuredInputParser.getFormatInstructions();\n  }\n}\n"],"mappings":";;;;;AA6BA,IAAa,yBAAb,cAEU,iBAA2C;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAkB;EAAa;CAE5D,SAAS;AACP,SAAO,KAAK,sBAAsB;;CAGpC,YAAY,QAAkB;AAC5B,QAAM,OAAO;AADI,OAAA,SAAA;;;;;;;CASnB,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAK,OAAO;;;;;;;;CASzB,OAAO,yBACL,SACA;EACA,MAAM,YAAY,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAK,UAAU;;;;;;;;CAS5B,wBAAgC;AAC9B,SAAO;;;;;;;;;;;;EAYT,KAAK,UAAU,aAAa,KAAK,OAAO,CAAC,CAAC;;;;;;;;;CAU1C,MAAM,MAAM,MAAiD;AAC3D,MAAI;GACF,MAAM,OAAO,KAAK,SAAS,MAAM,GAC7B,KAAK,MAAM,CAAC,MAAM,eAAe,CAAC,KAClC,KAAK,MAAM;AACf,UAAO,MAAM,kBAAkB,KAAK,QAAQ,KAAK,MAAM,KAAK,CAAC;UACvD;AACN,OAAI;AACF,WAAO,MAAM,kBAAkB,KAAK,QAAQ,KAAK,MAAM,KAAK,MAAM,CAAC,CAAC;YAC7D,IAAI;AACX,UAAM,IAAI,sBACR,2BAA2B,KAAK,YAAY,MAC5C,KACD;;;;;;;;;AAUT,IAAa,qCAAb,cAEU,uBAA0B;CAClC,OAAO,UAAU;AACf,SAAO;;CAGT,sBACE,SACQ;EACR,MAAM,qBAAqB,SAAS,sBAAsB;AAC1D,MAAI,qBAAqB,EACvB,OAAM,IAAI,MAAM,kDAAkD;AAGpE,SAAO,0FAA0F,KAAK,qBACpG,aAAa,KAAK,OAAO,CAC1B,CACE,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAC/C,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAAC;;CAGrD,qBACE,aACA,SAAS,GACD;EACR,MAAM,SAAS;AASf,MAAI,UAAU,QAAQ;GACpB,IAAI,WAAW;GACf,IAAI;AACJ,OAAI,MAAM,QAAQ,OAAO,KAAK,EAAE;IAC9B,MAAM,UAAU,OAAO,KAAK,WAAW,SAAS,SAAS,OAAO;AAChE,QAAI,YAAY,IAAI;AAClB,gBAAW;AACX,YAAO,KAAK,OAAO,SAAS,EAAE;;AAEhC,WAAO,OAAO,KAAK,KAAK,MAAM;SAE9B,QAAO,OAAO;AAGhB,OAAI,OAAO,SAAS,YAAY,OAAO,YAAY;IACjD,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AAYJ,WAAO,MAXY,OAAO,QAAQ,OAAO,WAAW,CACjD,KAAK,CAAC,KAAK,WAAW;KACrB,MAAM,aAAa,OAAO,UAAU,SAAS,IAAI,GAC7C,KACA;AACJ,YAAO,GAAG,IAAI,OAAO,OAAO,CAAC,GAAG,IAAI,KAAK,KAAK,qBAC5C,OACA,SAAS,EACV,GAAG;MACJ,CACD,KAAK,KACe,CAAC,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,GAAG;;AAExD,OAAI,OAAO,SAAS,WAAW,OAAO,OAAO;IAC3C,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AACJ,WAAO,WAAW,IAAI,OAAO,OAAO,GAAG,KAAK,qBAC1C,OAAO,OACP,SAAS,EACV,CAAC,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,IAAI;;GAEnC,MAAM,aAAa,WAAW,gBAAgB;GAC9C,MAAM,cAAc,OAAO,cAAc,OAAO,OAAO,gBAAgB;AACvE,UAAO,GAAG,OAAO,cAAc;;AAGjC,MAAI,WAAW,OACb,QAAO,OAAO,MACX,KAAK,MAAM,KAAK,qBAAqB,GAAG,OAAO,CAAC,CAChD,KAAK,KAAK,IAAI,OAAO,SAAS,EAAE,GAAG;AAGxC,QAAM,IAAI,MAAM,0BAA0B;;CAG5C,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAQ,OAAO;;CAG5B,OAAO,yBACL,SACA;EACA,MAAM,YAAY,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAM,EAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAuB,UAAU;;;;;;;AAchD,IAAsB,mCAAtB,cAGU,iBAAoB;CAC5B;CAEA,YAAY,EAAE,eAA0D;AACtE,QAAM,GAAG,UAAU;AACnB,OAAK,wBAAwB,IAAI,mCAC/B,YACD;;CAWH,MAAM,MAAM,MAA0B;EACpC,IAAI;AACJ,MAAI;AACF,iBAAc,MAAM,KAAK,sBAAsB,MAAM,KAAK;WACnD,GAAG;AACV,SAAM,IAAI,sBACR,2BAA2B,KAAK,YAAY,KAC5C,KACD;;AAGH,SAAO,KAAK,gBAAgB,YAAY;;CAG1C,wBAAgC;AAC9B,SAAO,KAAK,sBAAsB,uBAAuB"}

package/dist/retrievers/contextual_compression.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"contextual_compression.cjs","names":["BaseRetriever"],"sources":["../../src/retrievers/contextual_compression.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n  type BaseRetrieverInterface,\n} from \"@langchain/core/retrievers\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseDocumentCompressor } from \"./document_compressors/index.js\";\n\n/**\n * Interface for the arguments required to construct a\n * ContextualCompressionRetriever. It extends the BaseRetrieverInput\n * interface with two additional fields: baseCompressor and baseRetriever.\n */\nexport interface ContextualCompressionRetrieverArgs extends BaseRetrieverInput {\n  baseCompressor: BaseDocumentCompressor;\n  baseRetriever: BaseRetrieverInterface;\n}\n\n/**\n * A retriever that wraps a base retriever and compresses the results. It\n * retrieves relevant documents based on a given query and then compresses\n * these documents using a specified document compressor.\n * @example\n * ```typescript\n * const retriever = new ContextualCompressionRetriever({\n *   baseCompressor: new LLMChainExtractor(),\n *   baseRetriever: new HNSWLib().asRetriever(),\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What did the speaker say about Justice Breyer?\",\n * );\n * ```\n */\nexport class ContextualCompressionRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"ContextualCompressionRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"contextual_compression\"];\n\n  baseCompressor: BaseDocumentCompressor;\n\n  baseRetriever: BaseRetrieverInterface;\n\n  constructor(fields: ContextualCompressionRetrieverArgs) {\n    super(fields);\n\n    this.baseCompressor = fields.baseCompressor;\n    this.baseRetriever = fields.baseRetriever;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<DocumentInterface[]> {\n    const docs = await this.baseRetriever.invoke(\n      query,\n      runManager?.getChild(\"base_retriever\")\n    );\n    const compressedDocs = await this.baseCompressor.compressDocuments(\n      docs,\n      query,\n      runManager?.getChild(\"base_compressor\")\n    );\n    return compressedDocs;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAkCA,IAAa,iCAAb,cAAoDA,2BAAAA,cAAc;CAChE,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAyB;CAEpE;CAEA;CAEA,YAAY,QAA4C;AACtD,QAAM,OAAO;AAEb,OAAK,iBAAiB,OAAO;AAC7B,OAAK,gBAAgB,OAAO;;CAG9B,MAAM,sBACJ,OACA,YAC8B;EAC9B,MAAM,OAAO,MAAM,KAAK,cAAc,OACpC,OACA,YAAY,SAAS,iBAAiB,CACvC;AAMD,SALuB,MAAM,KAAK,eAAe,kBAC/C,MACA,OACA,YAAY,SAAS,kBAAkB,CACxC"}
+{"version":3,"file":"contextual_compression.cjs","names":["BaseRetriever"],"sources":["../../src/retrievers/contextual_compression.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n  type BaseRetrieverInterface,\n} from \"@langchain/core/retrievers\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseDocumentCompressor } from \"./document_compressors/index.js\";\n\n/**\n * Interface for the arguments required to construct a\n * ContextualCompressionRetriever. It extends the BaseRetrieverInput\n * interface with two additional fields: baseCompressor and baseRetriever.\n */\nexport interface ContextualCompressionRetrieverArgs extends BaseRetrieverInput {\n  baseCompressor: BaseDocumentCompressor;\n  baseRetriever: BaseRetrieverInterface;\n}\n\n/**\n * A retriever that wraps a base retriever and compresses the results. It\n * retrieves relevant documents based on a given query and then compresses\n * these documents using a specified document compressor.\n * @example\n * ```typescript\n * const retriever = new ContextualCompressionRetriever({\n *   baseCompressor: new LLMChainExtractor(),\n *   baseRetriever: new HNSWLib().asRetriever(),\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What did the speaker say about Justice Breyer?\",\n * );\n * ```\n */\nexport class ContextualCompressionRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"ContextualCompressionRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"contextual_compression\"];\n\n  baseCompressor: BaseDocumentCompressor;\n\n  baseRetriever: BaseRetrieverInterface;\n\n  constructor(fields: ContextualCompressionRetrieverArgs) {\n    super(fields);\n\n    this.baseCompressor = fields.baseCompressor;\n    this.baseRetriever = fields.baseRetriever;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<DocumentInterface[]> {\n    const docs = await this.baseRetriever.invoke(\n      query,\n      runManager?.getChild(\"base_retriever\")\n    );\n    const compressedDocs = await this.baseCompressor.compressDocuments(\n      docs,\n      query,\n      runManager?.getChild(\"base_compressor\")\n    );\n    return compressedDocs;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAkCA,IAAa,iCAAb,cAAoDA,2BAAAA,cAAc;CAChE,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAyB;CAEpE;CAEA;CAEA,YAAY,QAA4C;AACtD,QAAM,OAAO;AAEb,OAAK,iBAAiB,OAAO;AAC7B,OAAK,gBAAgB,OAAO;;CAG9B,MAAM,sBACJ,OACA,YAC8B;EAC9B,MAAM,OAAO,MAAM,KAAK,cAAc,OACpC,OACA,YAAY,SAAS,iBAAiB,CACvC;AAMD,SAAO,MALsB,KAAK,eAAe,kBAC/C,MACA,OACA,YAAY,SAAS,kBAAkB,CACxC"}

package/dist/retrievers/contextual_compression.js.map

@@ -1 +1 @@
-{"version":3,"file":"contextual_compression.js","names":[],"sources":["../../src/retrievers/contextual_compression.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n  type BaseRetrieverInterface,\n} from \"@langchain/core/retrievers\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseDocumentCompressor } from \"./document_compressors/index.js\";\n\n/**\n * Interface for the arguments required to construct a\n * ContextualCompressionRetriever. It extends the BaseRetrieverInput\n * interface with two additional fields: baseCompressor and baseRetriever.\n */\nexport interface ContextualCompressionRetrieverArgs extends BaseRetrieverInput {\n  baseCompressor: BaseDocumentCompressor;\n  baseRetriever: BaseRetrieverInterface;\n}\n\n/**\n * A retriever that wraps a base retriever and compresses the results. It\n * retrieves relevant documents based on a given query and then compresses\n * these documents using a specified document compressor.\n * @example\n * ```typescript\n * const retriever = new ContextualCompressionRetriever({\n *   baseCompressor: new LLMChainExtractor(),\n *   baseRetriever: new HNSWLib().asRetriever(),\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What did the speaker say about Justice Breyer?\",\n * );\n * ```\n */\nexport class ContextualCompressionRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"ContextualCompressionRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"contextual_compression\"];\n\n  baseCompressor: BaseDocumentCompressor;\n\n  baseRetriever: BaseRetrieverInterface;\n\n  constructor(fields: ContextualCompressionRetrieverArgs) {\n    super(fields);\n\n    this.baseCompressor = fields.baseCompressor;\n    this.baseRetriever = fields.baseRetriever;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<DocumentInterface[]> {\n    const docs = await this.baseRetriever.invoke(\n      query,\n      runManager?.getChild(\"base_retriever\")\n    );\n    const compressedDocs = await this.baseCompressor.compressDocuments(\n      docs,\n      query,\n      runManager?.getChild(\"base_compressor\")\n    );\n    return compressedDocs;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAkCA,IAAa,iCAAb,cAAoD,cAAc;CAChE,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAyB;CAEpE;CAEA;CAEA,YAAY,QAA4C;AACtD,QAAM,OAAO;AAEb,OAAK,iBAAiB,OAAO;AAC7B,OAAK,gBAAgB,OAAO;;CAG9B,MAAM,sBACJ,OACA,YAC8B;EAC9B,MAAM,OAAO,MAAM,KAAK,cAAc,OACpC,OACA,YAAY,SAAS,iBAAiB,CACvC;AAMD,SALuB,MAAM,KAAK,eAAe,kBAC/C,MACA,OACA,YAAY,SAAS,kBAAkB,CACxC"}
+{"version":3,"file":"contextual_compression.js","names":[],"sources":["../../src/retrievers/contextual_compression.ts"],"sourcesContent":["import {\n  BaseRetriever,\n  type BaseRetrieverInput,\n  type BaseRetrieverInterface,\n} from \"@langchain/core/retrievers\";\nimport type { DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\nimport { BaseDocumentCompressor } from \"./document_compressors/index.js\";\n\n/**\n * Interface for the arguments required to construct a\n * ContextualCompressionRetriever. It extends the BaseRetrieverInput\n * interface with two additional fields: baseCompressor and baseRetriever.\n */\nexport interface ContextualCompressionRetrieverArgs extends BaseRetrieverInput {\n  baseCompressor: BaseDocumentCompressor;\n  baseRetriever: BaseRetrieverInterface;\n}\n\n/**\n * A retriever that wraps a base retriever and compresses the results. It\n * retrieves relevant documents based on a given query and then compresses\n * these documents using a specified document compressor.\n * @example\n * ```typescript\n * const retriever = new ContextualCompressionRetriever({\n *   baseCompressor: new LLMChainExtractor(),\n *   baseRetriever: new HNSWLib().asRetriever(),\n * });\n * const retrievedDocs = await retriever.invoke(\n *   \"What did the speaker say about Justice Breyer?\",\n * );\n * ```\n */\nexport class ContextualCompressionRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"ContextualCompressionRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"contextual_compression\"];\n\n  baseCompressor: BaseDocumentCompressor;\n\n  baseRetriever: BaseRetrieverInterface;\n\n  constructor(fields: ContextualCompressionRetrieverArgs) {\n    super(fields);\n\n    this.baseCompressor = fields.baseCompressor;\n    this.baseRetriever = fields.baseRetriever;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ): Promise<DocumentInterface[]> {\n    const docs = await this.baseRetriever.invoke(\n      query,\n      runManager?.getChild(\"base_retriever\")\n    );\n    const compressedDocs = await this.baseCompressor.compressDocuments(\n      docs,\n      query,\n      runManager?.getChild(\"base_compressor\")\n    );\n    return compressedDocs;\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAkCA,IAAa,iCAAb,cAAoD,cAAc;CAChE,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAyB;CAEpE;CAEA;CAEA,YAAY,QAA4C;AACtD,QAAM,OAAO;AAEb,OAAK,iBAAiB,OAAO;AAC7B,OAAK,gBAAgB,OAAO;;CAG9B,MAAM,sBACJ,OACA,YAC8B;EAC9B,MAAM,OAAO,MAAM,KAAK,cAAc,OACpC,OACA,YAAY,SAAS,iBAAiB,CACvC;AAMD,SAAO,MALsB,KAAK,eAAe,kBAC/C,MACA,OACA,YAAY,SAAS,kBAAkB,CACxC"}

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

@@ -1 +1 @@
-{"version":3,"file":"chain_extract.cjs","names":["BaseOutputParser","PromptTemplate","PROMPT_TEMPLATE","BaseDocumentCompressor","Document","LLMChain"],"sources":["../../../src/retrievers/document_compressors/chain_extract.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { type DocumentInterface, Document } from \"@langchain/core/documents\";\nimport { PromptTemplate } from \"@langchain/core/prompts\";\nimport { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport { LLMChain } from \"../../chains/llm_chain.js\";\nimport { BaseDocumentCompressor } from \"./index.js\";\nimport { PROMPT_TEMPLATE } from \"./chain_extract_prompt.js\";\n\nfunction defaultGetInput(\n  query: string,\n  doc: DocumentInterface\n): Record<string, unknown> {\n  return { question: query, context: doc.pageContent };\n}\n\nclass NoOutputParser extends BaseOutputParser<string> {\n  lc_namespace = [\n    \"langchain\",\n    \"retrievers\",\n    \"document_compressors\",\n    \"chain_extract\",\n  ];\n\n  noOutputStr = \"NO_OUTPUT\";\n\n  parse(text: string): Promise<string> {\n    const cleanedText = text.trim();\n    if (cleanedText === this.noOutputStr) {\n      return Promise.resolve(\"\");\n    }\n    return Promise.resolve(cleanedText);\n  }\n\n  getFormatInstructions(): string {\n    throw new Error(\"Method not implemented.\");\n  }\n}\n\nfunction getDefaultChainPrompt(): PromptTemplate {\n  const outputParser = new NoOutputParser();\n  const template = PROMPT_TEMPLATE(outputParser.noOutputStr);\n  return new PromptTemplate({\n    template,\n    inputVariables: [\"question\", \"context\"],\n    outputParser,\n  });\n}\n\n/**\n * Interface for the arguments required to create an instance of\n * LLMChainExtractor.\n */\nexport interface LLMChainExtractorArgs {\n  llmChain: LLMChain;\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown>;\n}\n\n/**\n * A class that uses an LLM chain to extract relevant parts of documents.\n * It extends the BaseDocumentCompressor class.\n */\nexport class LLMChainExtractor extends BaseDocumentCompressor {\n  llmChain: LLMChain;\n\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown> =\n    defaultGetInput;\n\n  constructor({ llmChain, getInput }: LLMChainExtractorArgs) {\n    super();\n    this.llmChain = llmChain;\n    this.getInput = getInput;\n  }\n\n  /**\n   * Compresses a list of documents based on the output of an LLM chain.\n   * @param documents The list of documents to be compressed.\n   * @param query The query to be used for document compression.\n   * @returns A list of compressed documents.\n   */\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const compressedDocs = await Promise.all(\n      documents.map(async (doc) => {\n        const input = this.getInput(query, doc);\n        const output = await this.llmChain.predict(input);\n        return output.length > 0\n          ? new Document({\n              pageContent: output,\n              metadata: doc.metadata,\n            })\n          : undefined;\n      })\n    );\n    return compressedDocs.filter((doc): doc is Document => doc !== undefined);\n  }\n\n  /**\n   * Creates a new instance of LLMChainExtractor from a given LLM, prompt\n   * template, and getInput function.\n   * @param llm The BaseLanguageModel instance used for document extraction.\n   * @param prompt The PromptTemplate instance used for document extraction.\n   * @param getInput A function used for constructing the chain input from the query and a Document.\n   * @returns A new instance of LLMChainExtractor.\n   */\n  static fromLLM(\n    llm: BaseLanguageModelInterface,\n    prompt?: PromptTemplate,\n    getInput?: (\n      query: string,\n      doc: DocumentInterface\n    ) => Record<string, unknown>\n  ): LLMChainExtractor {\n    const _prompt = prompt || getDefaultChainPrompt();\n    const _getInput = getInput || defaultGetInput;\n    const llmChain = new LLMChain({ llm, prompt: _prompt });\n    return new LLMChainExtractor({ llmChain, getInput: _getInput });\n  }\n}\n"],"mappings":";;;;;;;;;;AAQA,SAAS,gBACP,OACA,KACyB;AACzB,QAAO;EAAE,UAAU;EAAO,SAAS,IAAI;EAAa;;AAGtD,IAAM,iBAAN,cAA6BA,+BAAAA,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;EACD;CAED,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,MAAM;AAC/B,MAAI,gBAAgB,KAAK,YACvB,QAAO,QAAQ,QAAQ,GAAG;AAE5B,SAAO,QAAQ,QAAQ,YAAY;;CAGrC,wBAAgC;AAC9B,QAAM,IAAI,MAAM,0BAA0B;;;AAI9C,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,gBAAgB;AAEzC,QAAO,IAAIC,wBAAAA,eAAe;EACxB,UAFeC,6BAAAA,gBAAgB,aAAa,YAAY;EAGxD,gBAAgB,CAAC,YAAY,UAAU;EACvC;EACD,CAAC;;;;;;AAgBJ,IAAa,oBAAb,MAAa,0BAA0BC,8CAAAA,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;AACzD,SAAO;AACP,OAAK,WAAW;AAChB,OAAK,WAAW;;;;;;;;CASlB,MAAM,kBACJ,WACA,OAC8B;AAa9B,UAZuB,MAAM,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,IAAI;GACvC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,MAAM;AACjD,UAAO,OAAO,SAAS,IACnB,IAAIC,0BAAAA,SAAS;IACX,aAAa;IACb,UAAU,IAAI;IACf,CAAC,GACF,KAAA;IACJ,CACH,EACqB,QAAQ,QAAyB,QAAQ,KAAA,EAAU;;;;;;;;;;CAW3E,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,uBAAuB;EACjD,MAAM,YAAY,YAAY;AAE9B,SAAO,IAAI,kBAAkB;GAAE,UADd,IAAIC,kBAAAA,SAAS;IAAE;IAAK,QAAQ;IAAS,CAAC;GACd,UAAU;GAAW,CAAC"}
+{"version":3,"file":"chain_extract.cjs","names":["BaseOutputParser","PromptTemplate","PROMPT_TEMPLATE","BaseDocumentCompressor","Document","LLMChain"],"sources":["../../../src/retrievers/document_compressors/chain_extract.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { type DocumentInterface, Document } from \"@langchain/core/documents\";\nimport { PromptTemplate } from \"@langchain/core/prompts\";\nimport { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport { LLMChain } from \"../../chains/llm_chain.js\";\nimport { BaseDocumentCompressor } from \"./index.js\";\nimport { PROMPT_TEMPLATE } from \"./chain_extract_prompt.js\";\n\nfunction defaultGetInput(\n  query: string,\n  doc: DocumentInterface\n): Record<string, unknown> {\n  return { question: query, context: doc.pageContent };\n}\n\nclass NoOutputParser extends BaseOutputParser<string> {\n  lc_namespace = [\n    \"langchain\",\n    \"retrievers\",\n    \"document_compressors\",\n    \"chain_extract\",\n  ];\n\n  noOutputStr = \"NO_OUTPUT\";\n\n  parse(text: string): Promise<string> {\n    const cleanedText = text.trim();\n    if (cleanedText === this.noOutputStr) {\n      return Promise.resolve(\"\");\n    }\n    return Promise.resolve(cleanedText);\n  }\n\n  getFormatInstructions(): string {\n    throw new Error(\"Method not implemented.\");\n  }\n}\n\nfunction getDefaultChainPrompt(): PromptTemplate {\n  const outputParser = new NoOutputParser();\n  const template = PROMPT_TEMPLATE(outputParser.noOutputStr);\n  return new PromptTemplate({\n    template,\n    inputVariables: [\"question\", \"context\"],\n    outputParser,\n  });\n}\n\n/**\n * Interface for the arguments required to create an instance of\n * LLMChainExtractor.\n */\nexport interface LLMChainExtractorArgs {\n  llmChain: LLMChain;\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown>;\n}\n\n/**\n * A class that uses an LLM chain to extract relevant parts of documents.\n * It extends the BaseDocumentCompressor class.\n */\nexport class LLMChainExtractor extends BaseDocumentCompressor {\n  llmChain: LLMChain;\n\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown> =\n    defaultGetInput;\n\n  constructor({ llmChain, getInput }: LLMChainExtractorArgs) {\n    super();\n    this.llmChain = llmChain;\n    this.getInput = getInput;\n  }\n\n  /**\n   * Compresses a list of documents based on the output of an LLM chain.\n   * @param documents The list of documents to be compressed.\n   * @param query The query to be used for document compression.\n   * @returns A list of compressed documents.\n   */\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const compressedDocs = await Promise.all(\n      documents.map(async (doc) => {\n        const input = this.getInput(query, doc);\n        const output = await this.llmChain.predict(input);\n        return output.length > 0\n          ? new Document({\n              pageContent: output,\n              metadata: doc.metadata,\n            })\n          : undefined;\n      })\n    );\n    return compressedDocs.filter((doc): doc is Document => doc !== undefined);\n  }\n\n  /**\n   * Creates a new instance of LLMChainExtractor from a given LLM, prompt\n   * template, and getInput function.\n   * @param llm The BaseLanguageModel instance used for document extraction.\n   * @param prompt The PromptTemplate instance used for document extraction.\n   * @param getInput A function used for constructing the chain input from the query and a Document.\n   * @returns A new instance of LLMChainExtractor.\n   */\n  static fromLLM(\n    llm: BaseLanguageModelInterface,\n    prompt?: PromptTemplate,\n    getInput?: (\n      query: string,\n      doc: DocumentInterface\n    ) => Record<string, unknown>\n  ): LLMChainExtractor {\n    const _prompt = prompt || getDefaultChainPrompt();\n    const _getInput = getInput || defaultGetInput;\n    const llmChain = new LLMChain({ llm, prompt: _prompt });\n    return new LLMChainExtractor({ llmChain, getInput: _getInput });\n  }\n}\n"],"mappings":";;;;;;;;;;AAQA,SAAS,gBACP,OACA,KACyB;AACzB,QAAO;EAAE,UAAU;EAAO,SAAS,IAAI;EAAa;;AAGtD,IAAM,iBAAN,cAA6BA,+BAAAA,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;EACD;CAED,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,MAAM;AAC/B,MAAI,gBAAgB,KAAK,YACvB,QAAO,QAAQ,QAAQ,GAAG;AAE5B,SAAO,QAAQ,QAAQ,YAAY;;CAGrC,wBAAgC;AAC9B,QAAM,IAAI,MAAM,0BAA0B;;;AAI9C,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,gBAAgB;AAEzC,QAAO,IAAIC,wBAAAA,eAAe;EACxB,UAFeC,6BAAAA,gBAAgB,aAAa,YAEpC;EACR,gBAAgB,CAAC,YAAY,UAAU;EACvC;EACD,CAAC;;;;;;AAgBJ,IAAa,oBAAb,MAAa,0BAA0BC,8CAAAA,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;AACzD,SAAO;AACP,OAAK,WAAW;AAChB,OAAK,WAAW;;;;;;;;CASlB,MAAM,kBACJ,WACA,OAC8B;AAa9B,UAAO,MAZsB,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,IAAI;GACvC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,MAAM;AACjD,UAAO,OAAO,SAAS,IACnB,IAAIC,0BAAAA,SAAS;IACX,aAAa;IACb,UAAU,IAAI;IACf,CAAC,GACF,KAAA;IACJ,CACH,EACqB,QAAQ,QAAyB,QAAQ,KAAA,EAAU;;;;;;;;;;CAW3E,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,uBAAuB;EACjD,MAAM,YAAY,YAAY;AAE9B,SAAO,IAAI,kBAAkB;GAAE,UAAA,IADVC,kBAAAA,SAAS;IAAE;IAAK,QAAQ;IAAS,CACf;GAAE,UAAU;GAAW,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"chain_extract.js","names":[],"sources":["../../../src/retrievers/document_compressors/chain_extract.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { type DocumentInterface, Document } from \"@langchain/core/documents\";\nimport { PromptTemplate } from \"@langchain/core/prompts\";\nimport { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport { LLMChain } from \"../../chains/llm_chain.js\";\nimport { BaseDocumentCompressor } from \"./index.js\";\nimport { PROMPT_TEMPLATE } from \"./chain_extract_prompt.js\";\n\nfunction defaultGetInput(\n  query: string,\n  doc: DocumentInterface\n): Record<string, unknown> {\n  return { question: query, context: doc.pageContent };\n}\n\nclass NoOutputParser extends BaseOutputParser<string> {\n  lc_namespace = [\n    \"langchain\",\n    \"retrievers\",\n    \"document_compressors\",\n    \"chain_extract\",\n  ];\n\n  noOutputStr = \"NO_OUTPUT\";\n\n  parse(text: string): Promise<string> {\n    const cleanedText = text.trim();\n    if (cleanedText === this.noOutputStr) {\n      return Promise.resolve(\"\");\n    }\n    return Promise.resolve(cleanedText);\n  }\n\n  getFormatInstructions(): string {\n    throw new Error(\"Method not implemented.\");\n  }\n}\n\nfunction getDefaultChainPrompt(): PromptTemplate {\n  const outputParser = new NoOutputParser();\n  const template = PROMPT_TEMPLATE(outputParser.noOutputStr);\n  return new PromptTemplate({\n    template,\n    inputVariables: [\"question\", \"context\"],\n    outputParser,\n  });\n}\n\n/**\n * Interface for the arguments required to create an instance of\n * LLMChainExtractor.\n */\nexport interface LLMChainExtractorArgs {\n  llmChain: LLMChain;\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown>;\n}\n\n/**\n * A class that uses an LLM chain to extract relevant parts of documents.\n * It extends the BaseDocumentCompressor class.\n */\nexport class LLMChainExtractor extends BaseDocumentCompressor {\n  llmChain: LLMChain;\n\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown> =\n    defaultGetInput;\n\n  constructor({ llmChain, getInput }: LLMChainExtractorArgs) {\n    super();\n    this.llmChain = llmChain;\n    this.getInput = getInput;\n  }\n\n  /**\n   * Compresses a list of documents based on the output of an LLM chain.\n   * @param documents The list of documents to be compressed.\n   * @param query The query to be used for document compression.\n   * @returns A list of compressed documents.\n   */\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const compressedDocs = await Promise.all(\n      documents.map(async (doc) => {\n        const input = this.getInput(query, doc);\n        const output = await this.llmChain.predict(input);\n        return output.length > 0\n          ? new Document({\n              pageContent: output,\n              metadata: doc.metadata,\n            })\n          : undefined;\n      })\n    );\n    return compressedDocs.filter((doc): doc is Document => doc !== undefined);\n  }\n\n  /**\n   * Creates a new instance of LLMChainExtractor from a given LLM, prompt\n   * template, and getInput function.\n   * @param llm The BaseLanguageModel instance used for document extraction.\n   * @param prompt The PromptTemplate instance used for document extraction.\n   * @param getInput A function used for constructing the chain input from the query and a Document.\n   * @returns A new instance of LLMChainExtractor.\n   */\n  static fromLLM(\n    llm: BaseLanguageModelInterface,\n    prompt?: PromptTemplate,\n    getInput?: (\n      query: string,\n      doc: DocumentInterface\n    ) => Record<string, unknown>\n  ): LLMChainExtractor {\n    const _prompt = prompt || getDefaultChainPrompt();\n    const _getInput = getInput || defaultGetInput;\n    const llmChain = new LLMChain({ llm, prompt: _prompt });\n    return new LLMChainExtractor({ llmChain, getInput: _getInput });\n  }\n}\n"],"mappings":";;;;;;;;;AAQA,SAAS,gBACP,OACA,KACyB;AACzB,QAAO;EAAE,UAAU;EAAO,SAAS,IAAI;EAAa;;AAGtD,IAAM,iBAAN,cAA6B,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;EACD;CAED,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,MAAM;AAC/B,MAAI,gBAAgB,KAAK,YACvB,QAAO,QAAQ,QAAQ,GAAG;AAE5B,SAAO,QAAQ,QAAQ,YAAY;;CAGrC,wBAAgC;AAC9B,QAAM,IAAI,MAAM,0BAA0B;;;AAI9C,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,gBAAgB;AAEzC,QAAO,IAAI,eAAe;EACxB,UAFe,gBAAgB,aAAa,YAAY;EAGxD,gBAAgB,CAAC,YAAY,UAAU;EACvC;EACD,CAAC;;;;;;AAgBJ,IAAa,oBAAb,MAAa,0BAA0B,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;AACzD,SAAO;AACP,OAAK,WAAW;AAChB,OAAK,WAAW;;;;;;;;CASlB,MAAM,kBACJ,WACA,OAC8B;AAa9B,UAZuB,MAAM,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,IAAI;GACvC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,MAAM;AACjD,UAAO,OAAO,SAAS,IACnB,IAAI,SAAS;IACX,aAAa;IACb,UAAU,IAAI;IACf,CAAC,GACF,KAAA;IACJ,CACH,EACqB,QAAQ,QAAyB,QAAQ,KAAA,EAAU;;;;;;;;;;CAW3E,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,uBAAuB;EACjD,MAAM,YAAY,YAAY;AAE9B,SAAO,IAAI,kBAAkB;GAAE,UADd,IAAI,SAAS;IAAE;IAAK,QAAQ;IAAS,CAAC;GACd,UAAU;GAAW,CAAC"}
+{"version":3,"file":"chain_extract.js","names":[],"sources":["../../../src/retrievers/document_compressors/chain_extract.ts"],"sourcesContent":["import type { BaseLanguageModelInterface } from \"@langchain/core/language_models/base\";\nimport { type DocumentInterface, Document } from \"@langchain/core/documents\";\nimport { PromptTemplate } from \"@langchain/core/prompts\";\nimport { BaseOutputParser } from \"@langchain/core/output_parsers\";\nimport { LLMChain } from \"../../chains/llm_chain.js\";\nimport { BaseDocumentCompressor } from \"./index.js\";\nimport { PROMPT_TEMPLATE } from \"./chain_extract_prompt.js\";\n\nfunction defaultGetInput(\n  query: string,\n  doc: DocumentInterface\n): Record<string, unknown> {\n  return { question: query, context: doc.pageContent };\n}\n\nclass NoOutputParser extends BaseOutputParser<string> {\n  lc_namespace = [\n    \"langchain\",\n    \"retrievers\",\n    \"document_compressors\",\n    \"chain_extract\",\n  ];\n\n  noOutputStr = \"NO_OUTPUT\";\n\n  parse(text: string): Promise<string> {\n    const cleanedText = text.trim();\n    if (cleanedText === this.noOutputStr) {\n      return Promise.resolve(\"\");\n    }\n    return Promise.resolve(cleanedText);\n  }\n\n  getFormatInstructions(): string {\n    throw new Error(\"Method not implemented.\");\n  }\n}\n\nfunction getDefaultChainPrompt(): PromptTemplate {\n  const outputParser = new NoOutputParser();\n  const template = PROMPT_TEMPLATE(outputParser.noOutputStr);\n  return new PromptTemplate({\n    template,\n    inputVariables: [\"question\", \"context\"],\n    outputParser,\n  });\n}\n\n/**\n * Interface for the arguments required to create an instance of\n * LLMChainExtractor.\n */\nexport interface LLMChainExtractorArgs {\n  llmChain: LLMChain;\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown>;\n}\n\n/**\n * A class that uses an LLM chain to extract relevant parts of documents.\n * It extends the BaseDocumentCompressor class.\n */\nexport class LLMChainExtractor extends BaseDocumentCompressor {\n  llmChain: LLMChain;\n\n  getInput: (query: string, doc: DocumentInterface) => Record<string, unknown> =\n    defaultGetInput;\n\n  constructor({ llmChain, getInput }: LLMChainExtractorArgs) {\n    super();\n    this.llmChain = llmChain;\n    this.getInput = getInput;\n  }\n\n  /**\n   * Compresses a list of documents based on the output of an LLM chain.\n   * @param documents The list of documents to be compressed.\n   * @param query The query to be used for document compression.\n   * @returns A list of compressed documents.\n   */\n  async compressDocuments(\n    documents: DocumentInterface[],\n    query: string\n  ): Promise<DocumentInterface[]> {\n    const compressedDocs = await Promise.all(\n      documents.map(async (doc) => {\n        const input = this.getInput(query, doc);\n        const output = await this.llmChain.predict(input);\n        return output.length > 0\n          ? new Document({\n              pageContent: output,\n              metadata: doc.metadata,\n            })\n          : undefined;\n      })\n    );\n    return compressedDocs.filter((doc): doc is Document => doc !== undefined);\n  }\n\n  /**\n   * Creates a new instance of LLMChainExtractor from a given LLM, prompt\n   * template, and getInput function.\n   * @param llm The BaseLanguageModel instance used for document extraction.\n   * @param prompt The PromptTemplate instance used for document extraction.\n   * @param getInput A function used for constructing the chain input from the query and a Document.\n   * @returns A new instance of LLMChainExtractor.\n   */\n  static fromLLM(\n    llm: BaseLanguageModelInterface,\n    prompt?: PromptTemplate,\n    getInput?: (\n      query: string,\n      doc: DocumentInterface\n    ) => Record<string, unknown>\n  ): LLMChainExtractor {\n    const _prompt = prompt || getDefaultChainPrompt();\n    const _getInput = getInput || defaultGetInput;\n    const llmChain = new LLMChain({ llm, prompt: _prompt });\n    return new LLMChainExtractor({ llmChain, getInput: _getInput });\n  }\n}\n"],"mappings":";;;;;;;;;AAQA,SAAS,gBACP,OACA,KACyB;AACzB,QAAO;EAAE,UAAU;EAAO,SAAS,IAAI;EAAa;;AAGtD,IAAM,iBAAN,cAA6B,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;EACD;CAED,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,MAAM;AAC/B,MAAI,gBAAgB,KAAK,YACvB,QAAO,QAAQ,QAAQ,GAAG;AAE5B,SAAO,QAAQ,QAAQ,YAAY;;CAGrC,wBAAgC;AAC9B,QAAM,IAAI,MAAM,0BAA0B;;;AAI9C,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,gBAAgB;AAEzC,QAAO,IAAI,eAAe;EACxB,UAFe,gBAAgB,aAAa,YAEpC;EACR,gBAAgB,CAAC,YAAY,UAAU;EACvC;EACD,CAAC;;;;;;AAgBJ,IAAa,oBAAb,MAAa,0BAA0B,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;AACzD,SAAO;AACP,OAAK,WAAW;AAChB,OAAK,WAAW;;;;;;;;CASlB,MAAM,kBACJ,WACA,OAC8B;AAa9B,UAAO,MAZsB,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,IAAI;GACvC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,MAAM;AACjD,UAAO,OAAO,SAAS,IACnB,IAAI,SAAS;IACX,aAAa;IACb,UAAU,IAAI;IACf,CAAC,GACF,KAAA;IACJ,CACH,EACqB,QAAQ,QAAyB,QAAQ,KAAA,EAAU;;;;;;;;;;CAW3E,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,uBAAuB;EACjD,MAAM,YAAY,YAAY;AAE9B,SAAO,IAAI,kBAAkB;GAAE,UAAA,IADV,SAAS;IAAE;IAAK,QAAQ;IAAS,CACf;GAAE,UAAU;GAAW,CAAC"}

package/dist/retrievers/ensemble.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"ensemble.cjs","names":["BaseRetriever"],"sources":["../../src/retrievers/ensemble.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n  /** A list of retrievers to ensemble. */\n  retrievers: BaseRetriever[];\n  /**\n   * A list of weights corresponding to the retrievers. Defaults to equal\n   * weighting for all retrievers.\n   */\n  weights?: number[];\n  /**\n   * A constant added to the rank, controlling the balance between the importance\n   * of high-ranked items and the consideration given to lower-ranked items.\n   * Default is 60.\n   */\n  c?: number;\n}\n\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport class EnsembleRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"EnsembleRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"ensemble_retriever\"];\n\n  retrievers: BaseRetriever[];\n\n  weights: number[];\n\n  c = 60;\n\n  constructor(args: EnsembleRetrieverInput) {\n    super(args);\n    this.retrievers = args.retrievers;\n    this.weights =\n      args.weights ||\n      new Array(args.retrievers.length).fill(1 / args.retrievers.length);\n    this.c = args.c || 60;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    return this._rankFusion(query, runManager);\n  }\n\n  async _rankFusion(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    const retrieverDocs = await Promise.all(\n      this.retrievers.map((retriever, i) =>\n        retriever.invoke(query, {\n          callbacks: runManager?.getChild(`retriever_${i + 1}`),\n        })\n      )\n    );\n\n    const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);\n    return fusedDocs;\n  }\n\n  async _weightedReciprocalRank(docList: DocumentInterface[][]) {\n    if (docList.length !== this.weights.length) {\n      throw new Error(\n        \"Number of retrieved document lists must be equal to the number of weights.\"\n      );\n    }\n\n    const rrfScoreDict = docList.reduce(\n      (rffScore: Record<string, number>, retrieverDoc, idx) => {\n        let rank = 1;\n        const weight = this.weights[idx];\n        while (rank <= retrieverDoc.length) {\n          const { pageContent } = retrieverDoc[rank - 1];\n          if (!rffScore[pageContent]) {\n            rffScore[pageContent] = 0;\n          }\n          rffScore[pageContent] += weight / (rank + this.c);\n          rank += 1;\n        }\n\n        return rffScore;\n      },\n      {}\n    );\n\n    const uniqueDocs = this._uniqueUnion(docList.flat());\n    const sortedDocs = Array.from(uniqueDocs).sort(\n      (a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]\n    );\n\n    return sortedDocs;\n  }\n\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const documentSet = new Set();\n    const result = [];\n\n    for (const doc of documents) {\n      const key = doc.pageContent;\n      if (!documentSet.has(key)) {\n        documentSet.add(key);\n        result.push(doc);\n      }\n    }\n\n    return result;\n  }\n}\n"],"mappings":";;;;;;;;;AAwBA,IAAa,oBAAb,cAAuCA,2BAAAA,cAAc;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;AACxC,QAAM,KAAK;AACX,OAAK,aAAa,KAAK;AACvB,OAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,OAAO,CAAC,KAAK,IAAI,KAAK,WAAW,OAAO;AACpE,OAAK,IAAI,KAAK,KAAK;;CAGrB,MAAM,sBACJ,OACA,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;;CAG5C,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,IAAI,EACtD,CAAC,CACH,CACF;AAGD,SADkB,MAAM,KAAK,wBAAwB,cAAc;;CAIrE,MAAM,wBAAwB,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR,6EACD;EAGH,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,aACZ,UAAS,eAAe;AAE1B,aAAS,gBAAgB,UAAU,OAAO,KAAK;AAC/C,YAAQ;;AAGV,UAAO;KAET,EAAE,CACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;AAKpD,SAJmB,MAAM,KAAK,WAAW,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aACxD;;CAKH,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,KAAK;EAC7B,MAAM,SAAS,EAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;AACzB,gBAAY,IAAI,IAAI;AACpB,WAAO,KAAK,IAAI;;;AAIpB,SAAO"}
+{"version":3,"file":"ensemble.cjs","names":["BaseRetriever"],"sources":["../../src/retrievers/ensemble.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n  /** A list of retrievers to ensemble. */\n  retrievers: BaseRetriever[];\n  /**\n   * A list of weights corresponding to the retrievers. Defaults to equal\n   * weighting for all retrievers.\n   */\n  weights?: number[];\n  /**\n   * A constant added to the rank, controlling the balance between the importance\n   * of high-ranked items and the consideration given to lower-ranked items.\n   * Default is 60.\n   */\n  c?: number;\n}\n\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport class EnsembleRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"EnsembleRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"ensemble_retriever\"];\n\n  retrievers: BaseRetriever[];\n\n  weights: number[];\n\n  c = 60;\n\n  constructor(args: EnsembleRetrieverInput) {\n    super(args);\n    this.retrievers = args.retrievers;\n    this.weights =\n      args.weights ||\n      new Array(args.retrievers.length).fill(1 / args.retrievers.length);\n    this.c = args.c || 60;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    return this._rankFusion(query, runManager);\n  }\n\n  async _rankFusion(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    const retrieverDocs = await Promise.all(\n      this.retrievers.map((retriever, i) =>\n        retriever.invoke(query, {\n          callbacks: runManager?.getChild(`retriever_${i + 1}`),\n        })\n      )\n    );\n\n    const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);\n    return fusedDocs;\n  }\n\n  async _weightedReciprocalRank(docList: DocumentInterface[][]) {\n    if (docList.length !== this.weights.length) {\n      throw new Error(\n        \"Number of retrieved document lists must be equal to the number of weights.\"\n      );\n    }\n\n    const rrfScoreDict = docList.reduce(\n      (rffScore: Record<string, number>, retrieverDoc, idx) => {\n        let rank = 1;\n        const weight = this.weights[idx];\n        while (rank <= retrieverDoc.length) {\n          const { pageContent } = retrieverDoc[rank - 1];\n          if (!rffScore[pageContent]) {\n            rffScore[pageContent] = 0;\n          }\n          rffScore[pageContent] += weight / (rank + this.c);\n          rank += 1;\n        }\n\n        return rffScore;\n      },\n      {}\n    );\n\n    const uniqueDocs = this._uniqueUnion(docList.flat());\n    const sortedDocs = Array.from(uniqueDocs).sort(\n      (a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]\n    );\n\n    return sortedDocs;\n  }\n\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const documentSet = new Set();\n    const result = [];\n\n    for (const doc of documents) {\n      const key = doc.pageContent;\n      if (!documentSet.has(key)) {\n        documentSet.add(key);\n        result.push(doc);\n      }\n    }\n\n    return result;\n  }\n}\n"],"mappings":";;;;;;;;;AAwBA,IAAa,oBAAb,cAAuCA,2BAAAA,cAAc;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;AACxC,QAAM,KAAK;AACX,OAAK,aAAa,KAAK;AACvB,OAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,OAAO,CAAC,KAAK,IAAI,KAAK,WAAW,OAAO;AACpE,OAAK,IAAI,KAAK,KAAK;;CAGrB,MAAM,sBACJ,OACA,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;;CAG5C,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,IAAI,EACtD,CAAC,CACH,CACF;AAGD,SAAO,MADiB,KAAK,wBAAwB,cAAc;;CAIrE,MAAM,wBAAwB,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR,6EACD;EAGH,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,aACZ,UAAS,eAAe;AAE1B,aAAS,gBAAgB,UAAU,OAAO,KAAK;AAC/C,YAAQ;;AAGV,UAAO;KAET,EAAE,CACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;AAKpD,SAJmB,MAAM,KAAK,WAAW,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aAGxC;;CAGnB,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,KAAK;EAC7B,MAAM,SAAS,EAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;AACzB,gBAAY,IAAI,IAAI;AACpB,WAAO,KAAK,IAAI;;;AAIpB,SAAO"}

package/dist/retrievers/ensemble.js.map

@@ -1 +1 @@
-{"version":3,"file":"ensemble.js","names":[],"sources":["../../src/retrievers/ensemble.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n  /** A list of retrievers to ensemble. */\n  retrievers: BaseRetriever[];\n  /**\n   * A list of weights corresponding to the retrievers. Defaults to equal\n   * weighting for all retrievers.\n   */\n  weights?: number[];\n  /**\n   * A constant added to the rank, controlling the balance between the importance\n   * of high-ranked items and the consideration given to lower-ranked items.\n   * Default is 60.\n   */\n  c?: number;\n}\n\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport class EnsembleRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"EnsembleRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"ensemble_retriever\"];\n\n  retrievers: BaseRetriever[];\n\n  weights: number[];\n\n  c = 60;\n\n  constructor(args: EnsembleRetrieverInput) {\n    super(args);\n    this.retrievers = args.retrievers;\n    this.weights =\n      args.weights ||\n      new Array(args.retrievers.length).fill(1 / args.retrievers.length);\n    this.c = args.c || 60;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    return this._rankFusion(query, runManager);\n  }\n\n  async _rankFusion(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    const retrieverDocs = await Promise.all(\n      this.retrievers.map((retriever, i) =>\n        retriever.invoke(query, {\n          callbacks: runManager?.getChild(`retriever_${i + 1}`),\n        })\n      )\n    );\n\n    const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);\n    return fusedDocs;\n  }\n\n  async _weightedReciprocalRank(docList: DocumentInterface[][]) {\n    if (docList.length !== this.weights.length) {\n      throw new Error(\n        \"Number of retrieved document lists must be equal to the number of weights.\"\n      );\n    }\n\n    const rrfScoreDict = docList.reduce(\n      (rffScore: Record<string, number>, retrieverDoc, idx) => {\n        let rank = 1;\n        const weight = this.weights[idx];\n        while (rank <= retrieverDoc.length) {\n          const { pageContent } = retrieverDoc[rank - 1];\n          if (!rffScore[pageContent]) {\n            rffScore[pageContent] = 0;\n          }\n          rffScore[pageContent] += weight / (rank + this.c);\n          rank += 1;\n        }\n\n        return rffScore;\n      },\n      {}\n    );\n\n    const uniqueDocs = this._uniqueUnion(docList.flat());\n    const sortedDocs = Array.from(uniqueDocs).sort(\n      (a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]\n    );\n\n    return sortedDocs;\n  }\n\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const documentSet = new Set();\n    const result = [];\n\n    for (const doc of documents) {\n      const key = doc.pageContent;\n      if (!documentSet.has(key)) {\n        documentSet.add(key);\n        result.push(doc);\n      }\n    }\n\n    return result;\n  }\n}\n"],"mappings":";;;;;;;;AAwBA,IAAa,oBAAb,cAAuC,cAAc;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;AACxC,QAAM,KAAK;AACX,OAAK,aAAa,KAAK;AACvB,OAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,OAAO,CAAC,KAAK,IAAI,KAAK,WAAW,OAAO;AACpE,OAAK,IAAI,KAAK,KAAK;;CAGrB,MAAM,sBACJ,OACA,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;;CAG5C,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,IAAI,EACtD,CAAC,CACH,CACF;AAGD,SADkB,MAAM,KAAK,wBAAwB,cAAc;;CAIrE,MAAM,wBAAwB,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR,6EACD;EAGH,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,aACZ,UAAS,eAAe;AAE1B,aAAS,gBAAgB,UAAU,OAAO,KAAK;AAC/C,YAAQ;;AAGV,UAAO;KAET,EAAE,CACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;AAKpD,SAJmB,MAAM,KAAK,WAAW,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aACxD;;CAKH,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,KAAK;EAC7B,MAAM,SAAS,EAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;AACzB,gBAAY,IAAI,IAAI;AACpB,WAAO,KAAK,IAAI;;;AAIpB,SAAO"}
+{"version":3,"file":"ensemble.js","names":[],"sources":["../../src/retrievers/ensemble.ts"],"sourcesContent":["import { BaseRetriever, BaseRetrieverInput } from \"@langchain/core/retrievers\";\nimport { Document, DocumentInterface } from \"@langchain/core/documents\";\nimport { CallbackManagerForRetrieverRun } from \"@langchain/core/callbacks/manager\";\n\nexport interface EnsembleRetrieverInput extends BaseRetrieverInput {\n  /** A list of retrievers to ensemble. */\n  retrievers: BaseRetriever[];\n  /**\n   * A list of weights corresponding to the retrievers. Defaults to equal\n   * weighting for all retrievers.\n   */\n  weights?: number[];\n  /**\n   * A constant added to the rank, controlling the balance between the importance\n   * of high-ranked items and the consideration given to lower-ranked items.\n   * Default is 60.\n   */\n  c?: number;\n}\n\n/**\n * Ensemble retriever that aggregates and orders the results of\n * multiple retrievers by using weighted Reciprocal Rank Fusion.\n */\nexport class EnsembleRetriever extends BaseRetriever {\n  static lc_name() {\n    return \"EnsembleRetriever\";\n  }\n\n  lc_namespace = [\"langchain\", \"retrievers\", \"ensemble_retriever\"];\n\n  retrievers: BaseRetriever[];\n\n  weights: number[];\n\n  c = 60;\n\n  constructor(args: EnsembleRetrieverInput) {\n    super(args);\n    this.retrievers = args.retrievers;\n    this.weights =\n      args.weights ||\n      new Array(args.retrievers.length).fill(1 / args.retrievers.length);\n    this.c = args.c || 60;\n  }\n\n  async _getRelevantDocuments(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    return this._rankFusion(query, runManager);\n  }\n\n  async _rankFusion(\n    query: string,\n    runManager?: CallbackManagerForRetrieverRun\n  ) {\n    const retrieverDocs = await Promise.all(\n      this.retrievers.map((retriever, i) =>\n        retriever.invoke(query, {\n          callbacks: runManager?.getChild(`retriever_${i + 1}`),\n        })\n      )\n    );\n\n    const fusedDocs = await this._weightedReciprocalRank(retrieverDocs);\n    return fusedDocs;\n  }\n\n  async _weightedReciprocalRank(docList: DocumentInterface[][]) {\n    if (docList.length !== this.weights.length) {\n      throw new Error(\n        \"Number of retrieved document lists must be equal to the number of weights.\"\n      );\n    }\n\n    const rrfScoreDict = docList.reduce(\n      (rffScore: Record<string, number>, retrieverDoc, idx) => {\n        let rank = 1;\n        const weight = this.weights[idx];\n        while (rank <= retrieverDoc.length) {\n          const { pageContent } = retrieverDoc[rank - 1];\n          if (!rffScore[pageContent]) {\n            rffScore[pageContent] = 0;\n          }\n          rffScore[pageContent] += weight / (rank + this.c);\n          rank += 1;\n        }\n\n        return rffScore;\n      },\n      {}\n    );\n\n    const uniqueDocs = this._uniqueUnion(docList.flat());\n    const sortedDocs = Array.from(uniqueDocs).sort(\n      (a, b) => rrfScoreDict[b.pageContent] - rrfScoreDict[a.pageContent]\n    );\n\n    return sortedDocs;\n  }\n\n  private _uniqueUnion(documents: Document[]): Document[] {\n    const documentSet = new Set();\n    const result = [];\n\n    for (const doc of documents) {\n      const key = doc.pageContent;\n      if (!documentSet.has(key)) {\n        documentSet.add(key);\n        result.push(doc);\n      }\n    }\n\n    return result;\n  }\n}\n"],"mappings":";;;;;;;;AAwBA,IAAa,oBAAb,cAAuC,cAAc;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAc;EAAqB;CAEhE;CAEA;CAEA,IAAI;CAEJ,YAAY,MAA8B;AACxC,QAAM,KAAK;AACX,OAAK,aAAa,KAAK;AACvB,OAAK,UACH,KAAK,WACL,IAAI,MAAM,KAAK,WAAW,OAAO,CAAC,KAAK,IAAI,KAAK,WAAW,OAAO;AACpE,OAAK,IAAI,KAAK,KAAK;;CAGrB,MAAM,sBACJ,OACA,YACA;AACA,SAAO,KAAK,YAAY,OAAO,WAAW;;CAG5C,MAAM,YACJ,OACA,YACA;EACA,MAAM,gBAAgB,MAAM,QAAQ,IAClC,KAAK,WAAW,KAAK,WAAW,MAC9B,UAAU,OAAO,OAAO,EACtB,WAAW,YAAY,SAAS,aAAa,IAAI,IAAI,EACtD,CAAC,CACH,CACF;AAGD,SAAO,MADiB,KAAK,wBAAwB,cAAc;;CAIrE,MAAM,wBAAwB,SAAgC;AAC5D,MAAI,QAAQ,WAAW,KAAK,QAAQ,OAClC,OAAM,IAAI,MACR,6EACD;EAGH,MAAM,eAAe,QAAQ,QAC1B,UAAkC,cAAc,QAAQ;GACvD,IAAI,OAAO;GACX,MAAM,SAAS,KAAK,QAAQ;AAC5B,UAAO,QAAQ,aAAa,QAAQ;IAClC,MAAM,EAAE,gBAAgB,aAAa,OAAO;AAC5C,QAAI,CAAC,SAAS,aACZ,UAAS,eAAe;AAE1B,aAAS,gBAAgB,UAAU,OAAO,KAAK;AAC/C,YAAQ;;AAGV,UAAO;KAET,EAAE,CACH;EAED,MAAM,aAAa,KAAK,aAAa,QAAQ,MAAM,CAAC;AAKpD,SAJmB,MAAM,KAAK,WAAW,CAAC,MACvC,GAAG,MAAM,aAAa,EAAE,eAAe,aAAa,EAAE,aAGxC;;CAGnB,aAAqB,WAAmC;EACtD,MAAM,8BAAc,IAAI,KAAK;EAC7B,MAAM,SAAS,EAAE;AAEjB,OAAK,MAAM,OAAO,WAAW;GAC3B,MAAM,MAAM,IAAI;AAChB,OAAI,CAAC,YAAY,IAAI,IAAI,EAAE;AACzB,gBAAY,IAAI,IAAI;AACpB,WAAO,KAAK,IAAI;;;AAIpB,SAAO"}

package/dist/retrievers/hyde.cjs.map

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

package/dist/retrievers/hyde.js.map

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

package/dist/retrievers/multi_query.cjs.map

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

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,GAAG,EACvB;;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,cADxB,IAAI,sBAAsB;GACY,CAAC;AAC5D,SAAO,IAAI,KAAK;GAAE;GAAW;GAAU;GAAY;GAAW,GAAG;GAAM,CAAC;;CAI1E,MAAc,iBACZ,UACA,YACmB;EAKnB,MAAM,SAJW,MAAM,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,oBAAoB;;CAI5D,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;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"}

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,UADa,MAAM,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;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"}

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,UADa,MAAM,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;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"}

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,iBADmB,MAAM,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,iBAJU,MAAM,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;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"}

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,iBADmB,MAAM,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,iBAJU,MAAM,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;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"}

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,sBALgB,MAAM,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;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"}

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,sBALgB,MAAM,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;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"}