@langchain/classic 1.0.45 → 1.0.47-rc.0

package/dist/output_parsers/structured.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"structured.cjs","names":["BaseOutputParser","z","OutputParserException"],"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,cAEUA,+BAAAA,iBAA2C;CAWhC;CAVnB,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAkB;CAAY;CAE3D,SAAS;EACP,OAAO,KAAK,qBAAqB;CACnC;CAEA,YAAY,QAAkB;EAC5B,MAAM,MAAM;EADK,KAAA,SAAA;CAEnB;;;;;;CAOA,OAAO,cAAwC,QAAW;EACxD,OAAO,IAAI,KAAK,MAAM;CACxB;;;;;;;CAQA,OAAO,yBACL,SACA;EACA,MAAM,YAAYC,OAAAA,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,OAAO,CAAC,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,OAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,WAAW,CAAC,CAC3C,CACF,CACF;EAEA,OAAO,IAAI,KAAK,SAAS;CAC3B;;;;;;;CAQA,wBAAgC;EAC9B,OAAO;;;;;;;;;;;;EAYT,KAAK,WAAA,GAAA,kCAAA,aAAA,CAAuB,KAAK,MAAM,CAAC,EAAE;;;CAG1C;;;;;;CAOA,MAAM,MAAM,MAAiD;EAC3D,IAAI;GACF,MAAM,OAAO,KAAK,SAAS,KAAK,IAC5B,KAAK,KAAK,CAAC,CAAC,MAAM,cAAc,CAAC,CAAC,KAClC,KAAK,KAAK;GACd,OAAO,OAAA,GAAA,4BAAA,kBAAA,CAAwB,KAAK,QAAQ,KAAK,MAAM,IAAI,CAAC;EAC9D,QAAQ;GACN,IAAI;IACF,OAAO,OAAA,GAAA,4BAAA,kBAAA,CAAwB,KAAK,QAAQ,KAAK,MAAM,KAAK,KAAK,CAAC,CAAC;GACrE,SAAS,IAAI;IACX,MAAM,IAAIC,+BAAAA,sBACR,2BAA2B,KAAK,YAAY,MAC5C,IACF;GACF;EACF;CACF;AACF;;;;;AAMA,IAAa,qCAAb,cAEU,uBAA0B;CAClC,OAAO,UAAU;EACf,OAAO;CACT;CAEA,sBACE,SACQ;EACR,MAAM,qBAAqB,SAAS,sBAAsB;EAC1D,IAAI,qBAAqB,GACvB,MAAM,IAAI,MAAM,iDAAiD;EAGnE,OAAO,0FAA0F,KAAK,sBAAA,GAAA,kCAAA,aAAA,CACvF,KAAK,MAAM,CAC1B,CAAC,CACE,WAAW,KAAK,IAAI,OAAO,kBAAkB,CAAC,CAAC,CAC/C,WAAW,KAAK,IAAI,OAAO,kBAAkB,CAAC,EAAE;CACrD;CAEA,qBACE,aACA,SAAS,GACD;EACR,MAAM,SAAS;EASf,IAAI,UAAU,QAAQ;GACpB,IAAI,WAAW;GACf,IAAI;GACJ,IAAI,MAAM,QAAQ,OAAO,IAAI,GAAG;IAC9B,MAAM,UAAU,OAAO,KAAK,WAAW,SAAS,SAAS,MAAM;IAC/D,IAAI,YAAY,IAAI;KAClB,WAAW;KACX,OAAO,KAAK,OAAO,SAAS,CAAC;IAC/B;IACA,OAAO,OAAO,KAAK,KAAK,KAAK;GAC/B,OACE,OAAO,OAAO;GAGhB,IAAI,OAAO,SAAS,YAAY,OAAO,YAAY;IACjD,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;IAYJ,OAAO,MAXY,OAAO,QAAQ,OAAO,UAAU,CAAC,CACjD,KAAK,CAAC,KAAK,WAAW;KACrB,MAAM,aAAa,OAAO,UAAU,SAAS,GAAG,IAC5C,KACA;KACJ,OAAO,GAAG,IAAI,OAAO,MAAM,EAAE,GAAG,IAAI,KAAK,KAAK,qBAC5C,OACA,SAAS,CACX,IAAI;IACN,CAAC,CAAC,CACD,KAAK,IACc,EAAE,IAAI,IAAI,OAAO,SAAS,CAAC,EAAE,GAAG;GACxD;GACA,IAAI,OAAO,SAAS,WAAW,OAAO,OAAO;IAC3C,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;IACJ,OAAO,WAAW,IAAI,OAAO,MAAM,IAAI,KAAK,qBAC1C,OAAO,OACP,SAAS,CACX,EAAE,IAAI,IAAI,OAAO,SAAS,CAAC,EAAE,IAAI;GACnC;GACA,MAAM,aAAa,WAAW,gBAAgB;GAC9C,MAAM,cAAc,OAAO,cAAc,OAAO,OAAO,gBAAgB;GACvE,OAAO,GAAG,OAAO,cAAc;EACjC;EAEA,IAAI,WAAW,QACb,OAAO,OAAO,MACX,KAAK,MAAM,KAAK,qBAAqB,GAAG,MAAM,CAAC,CAAC,CAChD,KAAK,KAAK,IAAI,OAAO,SAAS,CAAC,GAAG;EAGvC,MAAM,IAAI,MAAM,yBAAyB;CAC3C;CAEA,OAAO,cAAwC,QAAW;EACxD,OAAO,IAAI,KAAQ,MAAM;CAC3B;CAEA,OAAO,yBACL,SACA;EACA,MAAM,YAAYD,OAAAA,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,OAAO,CAAC,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,OAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,WAAW,CAAC,CAC3C,CACF,CACF;EAEA,OAAO,IAAI,KAAuB,SAAS;CAC7C;AACF;;;;;AAYA,IAAsB,mCAAtB,cAGUD,+BAAAA,iBAAoB;CAC5B;CAEA,YAAY,EAAE,eAA0D;EACtE,MAAM,GAAG,SAAS;EAClB,KAAK,wBAAwB,IAAI,mCAC/B,WACF;CACF;CAUA,MAAM,MAAM,MAA0B;EACpC,IAAI;EACJ,IAAI;GACF,cAAc,MAAM,KAAK,sBAAsB,MAAM,IAAI;EAC3D,SAAS,GAAG;GACV,MAAM,IAAIE,+BAAAA,sBACR,2BAA2B,KAAK,YAAY,KAC5C,IACF;EACF;EAEA,OAAO,KAAK,gBAAgB,WAAW;CACzC;CAEA,wBAAgC;EAC9B,OAAO,KAAK,sBAAsB,sBAAsB;CAC1D;AACF"}
+{"version":3,"file":"structured.cjs","names":["BaseOutputParser","z","toJsonSchema","interopParseAsync","OutputParserException"],"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,cAEUA,+BAAAA,iBAA2C;CAWhC;CAVnB,OAAO,UAAU;EACf,OAAO;CACT;CAEA,eAAe;EAAC;EAAa;EAAkB;CAAY;CAE3D,SAAS;EACP,OAAO,KAAK,qBAAqB;CACnC;CAEA,YAAY,QAAkB;EAC5B,MAAM,MAAM;EADK,KAAA,SAAA;CAEnB;;;;;;CAOA,OAAO,cAAwC,QAAW;EACxD,OAAO,IAAI,KAAK,MAAM;CACxB;;;;;;;CAQA,OAAO,yBACL,SACA;EACA,MAAM,YAAYC,OAAAA,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,OAAO,CAAC,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,OAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,WAAW,CAAC,CAC3C,CACF,CACF;EAEA,OAAO,IAAI,KAAK,SAAS;CAC3B;;;;;;;CAQA,wBAAgC;EAC9B,OAAO;;;;;;;;;;;;EAYT,KAAK,WAAA,GAAUC,kCAAAA,aAAAA,CAAa,KAAK,MAAM,CAAC,EAAE;;;CAG1C;;;;;;CAOA,MAAM,MAAM,MAAiD;EAC3D,IAAI;GACF,MAAM,OAAO,KAAK,SAAS,KAAK,IAC5B,KAAK,KAAK,CAAC,CAAC,MAAM,cAAc,CAAC,CAAC,KAClC,KAAK,KAAK;GACd,OAAO,OAAA,GAAMC,4BAAAA,kBAAAA,CAAkB,KAAK,QAAQ,KAAK,MAAM,IAAI,CAAC;EAC9D,QAAQ;GACN,IAAI;IACF,OAAO,OAAA,GAAMA,4BAAAA,kBAAAA,CAAkB,KAAK,QAAQ,KAAK,MAAM,KAAK,KAAK,CAAC,CAAC;GACrE,SAAS,IAAI;IACX,MAAM,IAAIC,+BAAAA,sBACR,2BAA2B,KAAK,YAAY,MAC5C,IACF;GACF;EACF;CACF;AACF;;;;;AAMA,IAAa,qCAAb,cAEU,uBAA0B;CAClC,OAAO,UAAU;EACf,OAAO;CACT;CAEA,sBACE,SACQ;EACR,MAAM,qBAAqB,SAAS,sBAAsB;EAC1D,IAAI,qBAAqB,GACvB,MAAM,IAAI,MAAM,iDAAiD;EAGnE,OAAO,0FAA0F,KAAK,sBAAA,GACpGF,kCAAAA,aAAAA,CAAa,KAAK,MAAM,CAC1B,CAAC,CACE,WAAW,KAAK,IAAI,OAAO,kBAAkB,CAAC,CAAC,CAC/C,WAAW,KAAK,IAAI,OAAO,kBAAkB,CAAC,EAAE;CACrD;CAEA,qBACE,aACA,SAAS,GACD;EACR,MAAM,SAAS;EASf,IAAI,UAAU,QAAQ;GACpB,IAAI,WAAW;GACf,IAAI;GACJ,IAAI,MAAM,QAAQ,OAAO,IAAI,GAAG;IAC9B,MAAM,UAAU,OAAO,KAAK,WAAW,SAAS,SAAS,MAAM;IAC/D,IAAI,YAAY,IAAI;KAClB,WAAW;KACX,OAAO,KAAK,OAAO,SAAS,CAAC;IAC/B;IACA,OAAO,OAAO,KAAK,KAAK,KAAK;GAC/B,OACE,OAAO,OAAO;GAGhB,IAAI,OAAO,SAAS,YAAY,OAAO,YAAY;IACjD,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;IAYJ,OAAO,MAXY,OAAO,QAAQ,OAAO,UAAU,CAAC,CACjD,KAAK,CAAC,KAAK,WAAW;KACrB,MAAM,aAAa,OAAO,UAAU,SAAS,GAAG,IAC5C,KACA;KACJ,OAAO,GAAG,IAAI,OAAO,MAAM,EAAE,GAAG,IAAI,KAAK,KAAK,qBAC5C,OACA,SAAS,CACX,IAAI;IACN,CAAC,CAAC,CACD,KAAK,IACc,EAAE,IAAI,IAAI,OAAO,SAAS,CAAC,EAAE,GAAG;GACxD;GACA,IAAI,OAAO,SAAS,WAAW,OAAO,OAAO;IAC3C,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;IACJ,OAAO,WAAW,IAAI,OAAO,MAAM,IAAI,KAAK,qBAC1C,OAAO,OACP,SAAS,CACX,EAAE,IAAI,IAAI,OAAO,SAAS,CAAC,EAAE,IAAI;GACnC;GACA,MAAM,aAAa,WAAW,gBAAgB;GAC9C,MAAM,cAAc,OAAO,cAAc,OAAO,OAAO,gBAAgB;GACvE,OAAO,GAAG,OAAO,cAAc;EACjC;EAEA,IAAI,WAAW,QACb,OAAO,OAAO,MACX,KAAK,MAAM,KAAK,qBAAqB,GAAG,MAAM,CAAC,CAAC,CAChD,KAAK,KAAK,IAAI,OAAO,SAAS,CAAC,GAAG;EAGvC,MAAM,IAAI,MAAM,yBAAyB;CAC3C;CAEA,OAAO,cAAwC,QAAW;EACxD,OAAO,IAAI,KAAQ,MAAM;CAC3B;CAEA,OAAO,yBACL,SACA;EACA,MAAM,YAAYD,OAAAA,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,OAAO,CAAC,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,OAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,WAAW,CAAC,CAC3C,CACF,CACF;EAEA,OAAO,IAAI,KAAuB,SAAS;CAC7C;AACF;;;;;AAYA,IAAsB,mCAAtB,cAGUD,+BAAAA,iBAAoB;CAC5B;CAEA,YAAY,EAAE,eAA0D;EACtE,MAAM,GAAG,SAAS;EAClB,KAAK,wBAAwB,IAAI,mCAC/B,WACF;CACF;CAUA,MAAM,MAAM,MAA0B;EACpC,IAAI;EACJ,IAAI;GACF,cAAc,MAAM,KAAK,sBAAsB,MAAM,IAAI;EAC3D,SAAS,GAAG;GACV,MAAM,IAAII,+BAAAA,sBACR,2BAA2B,KAAK,YAAY,KAC5C,IACF;EACF;EAEA,OAAO,KAAK,gBAAgB,WAAW;CACzC;CAEA,wBAAgC;EAC9B,OAAO,KAAK,sBAAsB,sBAAsB;CAC1D;AACF"}

package/dist/retrievers/document_compressors/chain_extract.cjs

@@ -33,8 +33,9 @@ var NoOutputParser = class extends _langchain_core_output_parsers.BaseOutputPars
 };
 function getDefaultChainPrompt() {
 	const outputParser = new NoOutputParser();
+	const template = require_chain_extract_prompt.PROMPT_TEMPLATE(outputParser.noOutputStr);
 	return new _langchain_core_prompts.PromptTemplate({
-		template: require_chain_extract_prompt.PROMPT_TEMPLATE(outputParser.noOutputStr),
+		template,
 		inputVariables: ["question", "context"],
 		outputParser
 	});

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;CACzB,OAAO;EAAE,UAAU;EAAO,SAAS,IAAI;CAAY;AACrD;AAEA,IAAM,iBAAN,cAA6BA,+BAAAA,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;CACF;CAEA,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,KAAK;EAC9B,IAAI,gBAAgB,KAAK,aACvB,OAAO,QAAQ,QAAQ,EAAE;EAE3B,OAAO,QAAQ,QAAQ,WAAW;CACpC;CAEA,wBAAgC;EAC9B,MAAM,IAAI,MAAM,yBAAyB;CAC3C;AACF;AAEA,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,eAAe;CAExC,OAAO,IAAIC,wBAAAA,eAAe;EACxB,UAFeC,6BAAAA,gBAAgB,aAAa,WAErC;EACP,gBAAgB,CAAC,YAAY,SAAS;EACtC;CACF,CAAC;AACH;;;;;AAeA,IAAa,oBAAb,MAAa,0BAA0BC,8CAAAA,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;EACzD,MAAM;EACN,KAAK,WAAW;EAChB,KAAK,WAAW;CAClB;;;;;;;CAQA,MAAM,kBACJ,WACA,OAC8B;EAa9B,QAAO,MAZsB,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,GAAG;GACtC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,KAAK;GAChD,OAAO,OAAO,SAAS,IACnB,IAAIC,0BAAAA,SAAS;IACX,aAAa;IACb,UAAU,IAAI;GAChB,CAAC,IACD,KAAA;EACN,CAAC,CACH,EAAA,CACsB,QAAQ,QAAyB,QAAQ,KAAA,CAAS;CAC1E;;;;;;;;;CAUA,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,sBAAsB;EAChD,MAAM,YAAY,YAAY;EAC9B,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAAE;GAAK,QAAQ;EAAQ,CAAC;EACtD,OAAO,IAAI,kBAAkB;GAAE;GAAU,UAAU;EAAU,CAAC;CAChE;AACF"}
+{"version":3,"file":"chain_extract.cjs","names":["BaseOutputParser","PROMPT_TEMPLATE","PromptTemplate","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;CACzB,OAAO;EAAE,UAAU;EAAO,SAAS,IAAI;CAAY;AACrD;AAEA,IAAM,iBAAN,cAA6BA,+BAAAA,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;CACF;CAEA,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,KAAK;EAC9B,IAAI,gBAAgB,KAAK,aACvB,OAAO,QAAQ,QAAQ,EAAE;EAE3B,OAAO,QAAQ,QAAQ,WAAW;CACpC;CAEA,wBAAgC;EAC9B,MAAM,IAAI,MAAM,yBAAyB;CAC3C;AACF;AAEA,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,eAAe;CACxC,MAAM,WAAWC,6BAAAA,gBAAgB,aAAa,WAAW;CACzD,OAAO,IAAIC,wBAAAA,eAAe;EACxB;EACA,gBAAgB,CAAC,YAAY,SAAS;EACtC;CACF,CAAC;AACH;;;;;AAeA,IAAa,oBAAb,MAAa,0BAA0BC,8CAAAA,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;EACzD,MAAM;EACN,KAAK,WAAW;EAChB,KAAK,WAAW;CAClB;;;;;;;CAQA,MAAM,kBACJ,WACA,OAC8B;EAa9B,QAAO,MAZsB,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,GAAG;GACtC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,KAAK;GAChD,OAAO,OAAO,SAAS,IACnB,IAAIC,0BAAAA,SAAS;IACX,aAAa;IACb,UAAU,IAAI;GAChB,CAAC,IACD,KAAA;EACN,CAAC,CACH,EAAA,CACsB,QAAQ,QAAyB,QAAQ,KAAA,CAAS;CAC1E;;;;;;;;;CAUA,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,sBAAsB;EAChD,MAAM,YAAY,YAAY;EAC9B,MAAM,WAAW,IAAIC,kBAAAA,SAAS;GAAE;GAAK,QAAQ;EAAQ,CAAC;EACtD,OAAO,IAAI,kBAAkB;GAAE;GAAU,UAAU;EAAU,CAAC;CAChE;AACF"}

package/dist/retrievers/document_compressors/chain_extract.js

@@ -32,8 +32,9 @@ var NoOutputParser = class extends BaseOutputParser {
 };
 function getDefaultChainPrompt() {
 	const outputParser = new NoOutputParser();
+	const template = PROMPT_TEMPLATE(outputParser.noOutputStr);
 	return new PromptTemplate({
-		template: PROMPT_TEMPLATE(outputParser.noOutputStr),
+		template,
 		inputVariables: ["question", "context"],
 		outputParser
 	});

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;CACzB,OAAO;EAAE,UAAU;EAAO,SAAS,IAAI;CAAY;AACrD;AAEA,IAAM,iBAAN,cAA6B,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;CACF;CAEA,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,KAAK;EAC9B,IAAI,gBAAgB,KAAK,aACvB,OAAO,QAAQ,QAAQ,EAAE;EAE3B,OAAO,QAAQ,QAAQ,WAAW;CACpC;CAEA,wBAAgC;EAC9B,MAAM,IAAI,MAAM,yBAAyB;CAC3C;AACF;AAEA,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,eAAe;CAExC,OAAO,IAAI,eAAe;EACxB,UAFe,gBAAgB,aAAa,WAErC;EACP,gBAAgB,CAAC,YAAY,SAAS;EACtC;CACF,CAAC;AACH;;;;;AAeA,IAAa,oBAAb,MAAa,0BAA0B,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;EACzD,MAAM;EACN,KAAK,WAAW;EAChB,KAAK,WAAW;CAClB;;;;;;;CAQA,MAAM,kBACJ,WACA,OAC8B;EAa9B,QAAO,MAZsB,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,GAAG;GACtC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,KAAK;GAChD,OAAO,OAAO,SAAS,IACnB,IAAI,SAAS;IACX,aAAa;IACb,UAAU,IAAI;GAChB,CAAC,IACD,KAAA;EACN,CAAC,CACH,EAAA,CACsB,QAAQ,QAAyB,QAAQ,KAAA,CAAS;CAC1E;;;;;;;;;CAUA,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,sBAAsB;EAChD,MAAM,YAAY,YAAY;EAC9B,MAAM,WAAW,IAAI,SAAS;GAAE;GAAK,QAAQ;EAAQ,CAAC;EACtD,OAAO,IAAI,kBAAkB;GAAE;GAAU,UAAU;EAAU,CAAC;CAChE;AACF"}
+{"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;CACzB,OAAO;EAAE,UAAU;EAAO,SAAS,IAAI;CAAY;AACrD;AAEA,IAAM,iBAAN,cAA6B,iBAAyB;CACpD,eAAe;EACb;EACA;EACA;EACA;CACF;CAEA,cAAc;CAEd,MAAM,MAA+B;EACnC,MAAM,cAAc,KAAK,KAAK;EAC9B,IAAI,gBAAgB,KAAK,aACvB,OAAO,QAAQ,QAAQ,EAAE;EAE3B,OAAO,QAAQ,QAAQ,WAAW;CACpC;CAEA,wBAAgC;EAC9B,MAAM,IAAI,MAAM,yBAAyB;CAC3C;AACF;AAEA,SAAS,wBAAwC;CAC/C,MAAM,eAAe,IAAI,eAAe;CACxC,MAAM,WAAW,gBAAgB,aAAa,WAAW;CACzD,OAAO,IAAI,eAAe;EACxB;EACA,gBAAgB,CAAC,YAAY,SAAS;EACtC;CACF,CAAC;AACH;;;;;AAeA,IAAa,oBAAb,MAAa,0BAA0B,uBAAuB;CAC5D;CAEA,WACE;CAEF,YAAY,EAAE,UAAU,YAAmC;EACzD,MAAM;EACN,KAAK,WAAW;EAChB,KAAK,WAAW;CAClB;;;;;;;CAQA,MAAM,kBACJ,WACA,OAC8B;EAa9B,QAAO,MAZsB,QAAQ,IACnC,UAAU,IAAI,OAAO,QAAQ;GAC3B,MAAM,QAAQ,KAAK,SAAS,OAAO,GAAG;GACtC,MAAM,SAAS,MAAM,KAAK,SAAS,QAAQ,KAAK;GAChD,OAAO,OAAO,SAAS,IACnB,IAAI,SAAS;IACX,aAAa;IACb,UAAU,IAAI;GAChB,CAAC,IACD,KAAA;EACN,CAAC,CACH,EAAA,CACsB,QAAQ,QAAyB,QAAQ,KAAA,CAAS;CAC1E;;;;;;;;;CAUA,OAAO,QACL,KACA,QACA,UAImB;EACnB,MAAM,UAAU,UAAU,sBAAsB;EAChD,MAAM,YAAY,YAAY;EAC9B,MAAM,WAAW,IAAI,SAAS;GAAE;GAAK,QAAQ;EAAQ,CAAC;EACtD,OAAO,IAAI,kBAAkB;GAAE;GAAU,UAAU;EAAU,CAAC;CAChE;AACF"}

package/dist/retrievers/matryoshka_retriever.cjs.map

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

package/dist/retrievers/multi_query.cjs

@@ -84,10 +84,11 @@ var MultiQueryRetriever = class extends _langchain_core_retrievers.BaseRetriever
 	}
 	static fromLLM(fields) {
 		const { retriever, llm, prompt = DEFAULT_QUERY_PROMPT, queryCount, parserKey, ...rest } = fields;
+		const outputParser = new LineListOutputParser();
 		const llmChain = new require_llm_chain.LLMChain({
 			llm,
 			prompt,
-			outputParser: new LineListOutputParser()
+			outputParser
 		});
 		return new this({
 			retriever,

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

package/dist/retrievers/multi_query.js

@@ -83,10 +83,11 @@ var MultiQueryRetriever = class extends BaseRetriever {
 	}
 	static fromLLM(fields) {
 		const { retriever, llm, prompt = DEFAULT_QUERY_PROMPT, queryCount, parserKey, ...rest } = fields;
+		const outputParser = new LineListOutputParser();
 		const llmChain = new LLMChain({
 			llm,
 			prompt,
-			outputParser: new LineListOutputParser()
+			outputParser
 		});
 		return new this({
 			retriever,

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

package/dist/smith/runner_utils.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"runner_utils.cjs","names":["BaseTracer","RunnableLambda","LangChainTracer","RunTree","Runnable","loadEvaluator","isCustomEvaluator","isOffTheShelfEvaluator","ProgressBar","AsyncCaller","Client","randomName"],"sources":["../../src/smith/runner_utils.ts"],"sourcesContent":["import { BaseLanguageModel } from \"@langchain/core/language_models/base\";\nimport { Serialized } from \"@langchain/core/load/serializable\";\nimport { mapStoredMessagesToChatMessages } from \"@langchain/core/messages\";\nimport {\n  Runnable,\n  RunnableConfig,\n  RunnableLambda,\n  getCallbackManagerForConfig,\n} from \"@langchain/core/runnables\";\nimport { LangChainTracer } from \"@langchain/core/tracers/tracer_langchain\";\nimport { BaseTracer } from \"@langchain/core/tracers/base\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { AsyncCaller } from \"@langchain/core/utils/async_caller\";\nimport type {\n  CallbackManager,\n  CallbackManagerForChainRun,\n} from \"@langchain/core/callbacks/manager\";\nimport {\n  Client,\n  Example,\n  Feedback,\n  Run,\n  RunTree,\n  RunTreeConfig,\n} from \"langsmith\";\nimport { EvaluationResult, RunEvaluator } from \"langsmith/evaluation\";\nimport { DataType } from \"langsmith/schemas\";\nimport type { TraceableFunction } from \"langsmith/singletons/traceable\";\nimport { LLMStringEvaluator } from \"../evaluation/base.js\";\nimport { loadEvaluator } from \"../evaluation/loader.js\";\nimport { EvaluatorType } from \"../evaluation/types.js\";\nimport {\n  isOffTheShelfEvaluator,\n  type DynamicRunEvaluatorParams,\n  type EvalConfig,\n  type EvaluatorInputFormatter,\n  type RunEvalConfig,\n  type RunEvaluatorLike,\n  isCustomEvaluator,\n} from \"./config.js\";\nimport { randomName } from \"./name_generation.js\";\nimport { ProgressBar } from \"./progress.js\";\n\nexport type ChainOrFactory =\n  | Runnable\n  | (() => Runnable)\n  | AnyTraceableFunction\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  | ((obj: any) => any)\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  | ((obj: any) => Promise<any>)\n  | (() => (obj: unknown) => unknown)\n  | (() => (obj: unknown) => Promise<unknown>);\n\nclass SingleRunIdExtractor {\n  runIdPromiseResolver: (runId: string) => void;\n\n  runIdPromise: Promise<string>;\n\n  constructor() {\n    this.runIdPromise = new Promise<string>((extract) => {\n      this.runIdPromiseResolver = extract;\n    });\n  }\n\n  handleChainStart = (\n    _chain: Serialized,\n    _inputs: ChainValues,\n    runId: string\n  ) => {\n    this.runIdPromiseResolver(runId);\n  };\n\n  async extract(): Promise<string> {\n    return this.runIdPromise;\n  }\n}\n\nclass SingleRunExtractor extends BaseTracer {\n  runPromiseResolver: (run: Run) => void;\n\n  runPromise: Promise<Run>;\n\n  /** The name of the callback handler. */\n  name = \"single_run_extractor\";\n\n  constructor() {\n    super();\n    this.runPromise = new Promise<Run>((extract) => {\n      this.runPromiseResolver = extract;\n    });\n  }\n\n  async persistRun(run: Run) {\n    this.runPromiseResolver(run);\n  }\n\n  async extract(): Promise<Run> {\n    return this.runPromise;\n  }\n}\n\n/**\n * Wraps an evaluator function + implements the RunEvaluator interface.\n */\nclass DynamicRunEvaluator implements RunEvaluator {\n  evaluator: RunnableLambda<DynamicRunEvaluatorParams, EvaluationResult>;\n\n  constructor(evaluator: RunEvaluatorLike) {\n    this.evaluator = new RunnableLambda({ func: evaluator });\n  }\n\n  /**\n   * Evaluates a run with an optional example and returns the evaluation result.\n   * @param run The run to evaluate.\n   * @param example The optional example to use for evaluation.\n   * @returns A promise that extracts to the evaluation result.\n   */\n  async evaluateRun(run: Run, example?: Example): Promise<EvaluationResult> {\n    const extractor = new SingleRunIdExtractor();\n    const tracer = new LangChainTracer({ projectName: \"evaluators\" });\n    const result = await this.evaluator.invoke(\n      {\n        run,\n        example,\n        input: run.inputs,\n        prediction: run.outputs,\n        reference: example?.outputs,\n      },\n      {\n        callbacks: [extractor, tracer],\n      }\n    );\n    const runId = await extractor.extract();\n    return {\n      sourceRunId: runId,\n      ...result,\n    };\n  }\n}\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nfunction isLLMStringEvaluator(evaluator: any): evaluator is LLMStringEvaluator {\n  return evaluator && typeof evaluator.evaluateStrings === \"function\";\n}\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\ntype AnyTraceableFunction = TraceableFunction<(...any: any[]) => any>;\n\n/**\n * Internal implementation of RunTree, which uses the\n * provided callback manager instead of the internal LangSmith client.\n *\n * The goal of this class is to ensure seamless interop when intergrated\n * with other Runnables.\n */\nclass CallbackManagerRunTree extends RunTree {\n  callbackManager: CallbackManager;\n\n  activeCallbackManager: CallbackManagerForChainRun | undefined = undefined;\n\n  constructor(config: RunTreeConfig, callbackManager: CallbackManager) {\n    super(config);\n\n    this.callbackManager = callbackManager;\n  }\n\n  createChild(config: RunTreeConfig): CallbackManagerRunTree {\n    const child = new CallbackManagerRunTree(\n      {\n        ...config,\n        parent_run: this,\n        project_name: this.project_name,\n        client: this.client,\n      },\n      this.activeCallbackManager?.getChild() ?? this.callbackManager\n    );\n    this.child_runs.push(child);\n    return child;\n  }\n\n  async postRun(): Promise<void> {\n    // how it is translated in comparison to basic RunTree?\n    this.activeCallbackManager = await this.callbackManager.handleChainStart(\n      typeof this.serialized !== \"object\" &&\n        this.serialized != null &&\n        \"lc\" in this.serialized\n        ? this.serialized\n        : {\n            id: [\"langchain\", \"smith\", \"CallbackManagerRunTree\"],\n            lc: 1,\n            type: \"not_implemented\",\n          },\n      this.inputs,\n      this.id,\n      this.run_type,\n      undefined,\n      undefined,\n      this.name\n    );\n  }\n\n  async patchRun(): Promise<void> {\n    if (this.error) {\n      await this.activeCallbackManager?.handleChainError(\n        this.error,\n        this.id,\n        this.parent_run?.id,\n        undefined,\n        undefined\n      );\n    } else {\n      await this.activeCallbackManager?.handleChainEnd(\n        this.outputs ?? {},\n        this.id,\n        this.parent_run?.id,\n        undefined,\n        undefined\n      );\n    }\n  }\n}\n\nclass RunnableTraceable<RunInput, RunOutput> extends Runnable<\n  RunInput,\n  RunOutput\n> {\n  lc_serializable = false;\n\n  lc_namespace = [\"langchain_core\", \"runnables\"];\n\n  protected func: AnyTraceableFunction;\n\n  constructor(fields: { func: AnyTraceableFunction }) {\n    super(fields);\n\n    if (!isLangsmithTraceableFunction(fields.func)) {\n      throw new Error(\n        \"RunnableTraceable requires a function that is wrapped in traceable higher-order function\"\n      );\n    }\n\n    this.func = fields.func;\n  }\n\n  async invoke(input: RunInput, options?: Partial<RunnableConfig>) {\n    const [config] = this._getOptionsList(options ?? {}, 1);\n    const callbackManager = await getCallbackManagerForConfig(config);\n\n    const partialConfig =\n      \"langsmith:traceable\" in this.func\n        ? (this.func[\"langsmith:traceable\"] as RunTreeConfig)\n        : { name: \"<lambda>\" };\n\n    if (!callbackManager) throw new Error(\"CallbackManager not found\");\n    const runTree = new CallbackManagerRunTree(\n      {\n        ...partialConfig,\n        parent_run: callbackManager?._parentRunId\n          ? new RunTree({ name: \"<parent>\", id: callbackManager?._parentRunId })\n          : undefined,\n      },\n      callbackManager\n    );\n\n    if (\n      typeof input === \"object\" &&\n      input != null &&\n      Object.keys(input).length === 1\n    ) {\n      if (\"args\" in input && Array.isArray(input)) {\n        return (await this.func(runTree, ...input)) as RunOutput;\n      }\n\n      if (\n        \"input\" in input &&\n        !(\n          typeof input === \"object\" &&\n          input != null &&\n          !Array.isArray(input) &&\n          // oxlint-disable-next-line no-instanceof/no-instanceof\n          !(input instanceof Date)\n        )\n      ) {\n        try {\n          return (await this.func(runTree, input.input)) as RunOutput;\n        } catch {\n          return (await this.func(runTree, input)) as RunOutput;\n        }\n      }\n    }\n\n    return (await this.func(runTree, input)) as RunOutput;\n  }\n}\n\n/**\n * Wraps an off-the-shelf evaluator (loaded using loadEvaluator; of EvaluatorType[T])\n * and composes with a prepareData function so the user can prepare the trace and\n * dataset data for the evaluator.\n */\nclass PreparedRunEvaluator implements RunEvaluator {\n  evaluator: LLMStringEvaluator;\n\n  formatEvaluatorInputs: EvaluatorInputFormatter;\n\n  isStringEvaluator: boolean;\n\n  evaluationName: string;\n\n  constructor(\n    evaluator: LLMStringEvaluator,\n    evaluationName: string,\n    formatEvaluatorInputs: EvaluatorInputFormatter\n  ) {\n    this.evaluator = evaluator;\n    this.isStringEvaluator = typeof evaluator?.evaluateStrings === \"function\";\n    this.evaluationName = evaluationName;\n    this.formatEvaluatorInputs = formatEvaluatorInputs;\n  }\n\n  static async fromEvalConfig(\n    config: EvalConfig | keyof EvaluatorType\n  ): Promise<PreparedRunEvaluator> {\n    const evaluatorType =\n      typeof config === \"string\" ? config : config.evaluatorType;\n    const evalConfig = typeof config === \"string\" ? ({} as EvalConfig) : config;\n    const evaluator = await loadEvaluator(evaluatorType, evalConfig);\n    const feedbackKey = evalConfig?.feedbackKey ?? evaluator?.evaluationName;\n    if (!isLLMStringEvaluator(evaluator)) {\n      throw new Error(\n        `Evaluator of type ${evaluatorType} not yet supported. ` +\n          \"Please use a string evaluator, or implement your \" +\n          \"evaluation logic as a custom evaluator.\"\n      );\n    }\n    if (!feedbackKey) {\n      throw new Error(\n        `Evaluator of type ${evaluatorType} must have an evaluationName` +\n          ` or feedbackKey. Please manually provide a feedbackKey in the EvalConfig.`\n      );\n    }\n    return new PreparedRunEvaluator(\n      evaluator as LLMStringEvaluator,\n      feedbackKey,\n      evalConfig?.formatEvaluatorInputs\n    );\n  }\n\n  /**\n   * Evaluates a run with an optional example and returns the evaluation result.\n   * @param run The run to evaluate.\n   * @param example The optional example to use for evaluation.\n   * @returns A promise that extracts to the evaluation result.\n   */\n  async evaluateRun(run: Run, example?: Example): Promise<EvaluationResult> {\n    const { prediction, input, reference } = this.formatEvaluatorInputs({\n      rawInput: run.inputs,\n      rawPrediction: run.outputs,\n      rawReferenceOutput: example?.outputs,\n      run,\n    });\n    const extractor = new SingleRunIdExtractor();\n    const tracer = new LangChainTracer({ projectName: \"evaluators\" });\n    if (this.isStringEvaluator) {\n      const evalResult = await this.evaluator.evaluateStrings(\n        {\n          prediction: prediction as string,\n          reference: reference as string,\n          input: input as string,\n        },\n        {\n          callbacks: [extractor, tracer],\n        }\n      );\n      const runId = await extractor.extract();\n      return {\n        key: this.evaluationName,\n        comment: evalResult?.reasoning,\n        sourceRunId: runId,\n        ...evalResult,\n      };\n    }\n    throw new Error(\n      \"Evaluator not yet supported. \" +\n        \"Please use a string evaluator, or implement your \" +\n        \"evaluation logic as a custom evaluator.\"\n    );\n  }\n}\n\nclass LoadedEvalConfig {\n  constructor(public evaluators: (RunEvaluator | DynamicRunEvaluator)[]) {}\n\n  static async fromRunEvalConfig(\n    config: RunEvalConfig<keyof EvaluatorType>\n  ): Promise<LoadedEvalConfig> {\n    // Custom evaluators are applied \"as-is\"\n    const customEvaluators = (\n      config?.customEvaluators ?? config.evaluators?.filter(isCustomEvaluator)\n    )?.map((evaluator) => {\n      if (typeof evaluator === \"function\") {\n        return new DynamicRunEvaluator(evaluator);\n      } else {\n        return evaluator;\n      }\n    });\n\n    const offTheShelfEvaluators = await Promise.all(\n      config?.evaluators\n        ?.filter(isOffTheShelfEvaluator)\n        ?.map(\n          async (evaluator) =>\n            await PreparedRunEvaluator.fromEvalConfig(evaluator)\n        ) ?? []\n    );\n    return new LoadedEvalConfig(\n      (customEvaluators ?? []).concat(offTheShelfEvaluators ?? [])\n    );\n  }\n}\n\nexport interface RunOnDatasetParams extends Omit<\n  RunEvalConfig,\n  \"customEvaluators\"\n> {\n  /**\n   * Name of the project for logging and tracking.\n   */\n  projectName?: string;\n\n  /**\n   * Additional metadata for the project.\n   */\n  projectMetadata?: Record<string, unknown>;\n\n  /**\n   * Client instance for LangSmith service interaction.\n   */\n  client?: Client;\n\n  /**\n   * Maximum concurrency level for dataset processing.\n   */\n  maxConcurrency?: number;\n\n  /**\n   * @deprecated Pass keys directly to the RunOnDatasetParams instead\n   */\n  evaluationConfig?: RunEvalConfig;\n}\n\n/**\n * Internals expect a constructor () -> Runnable. This function wraps/coerces\n * the provided LangChain object, custom function, or factory function into\n * a constructor of a runnable.\n * @param modelOrFactory The model or factory to create a wrapped model from.\n * @returns A function that returns the wrapped model.\n * @throws Error if the modelOrFactory is invalid.\n */\nconst createWrappedModel = async (modelOrFactory: ChainOrFactory) => {\n  if (Runnable.isRunnable(modelOrFactory)) {\n    return () => modelOrFactory;\n  }\n  if (typeof modelOrFactory === \"function\") {\n    if (isLangsmithTraceableFunction(modelOrFactory)) {\n      const wrappedModel = new RunnableTraceable({ func: modelOrFactory });\n      return () => wrappedModel;\n    }\n\n    try {\n      // If it works with no arguments, assume it's a factory\n      let res = (modelOrFactory as () => Runnable)();\n      if (\n        res &&\n        typeof (res as unknown as Promise<Runnable>).then === \"function\"\n      ) {\n        res = await res;\n      }\n      return modelOrFactory as () => Runnable;\n    } catch {\n      // Otherwise, it's a custom UDF, and we'll wrap\n      // the function in a lambda\n      const wrappedModel = new RunnableLambda({ func: modelOrFactory });\n      return () => wrappedModel;\n    }\n  }\n  throw new Error(\"Invalid modelOrFactory\");\n};\n\nconst loadExamples = async ({\n  datasetName,\n  client,\n  projectName,\n}: {\n  datasetName: string;\n  client: Client;\n  projectName: string;\n  maxConcurrency: number;\n}) => {\n  const exampleIterator = client.listExamples({ datasetName });\n  const configs: RunnableConfig[] = [];\n  const runExtractors = [];\n  const examples = [];\n  for await (const example of exampleIterator) {\n    const runExtractor = new SingleRunExtractor();\n    configs.push({\n      callbacks: [\n        new LangChainTracer({ exampleId: example.id, projectName }),\n        runExtractor,\n      ],\n    });\n    examples.push(example);\n    runExtractors.push(runExtractor);\n  }\n  return {\n    configs,\n    examples,\n    runExtractors,\n  };\n};\n\nconst applyEvaluators = async ({\n  evaluation,\n  runs,\n  examples,\n  client,\n  maxConcurrency,\n}: {\n  evaluation: LoadedEvalConfig;\n  runs: Run[];\n  examples: Example[];\n  client: Client;\n  maxConcurrency: number;\n}): Promise<{\n  [key: string]: {\n    execution_time?: number;\n    run_id: string;\n    feedback: Feedback[];\n  };\n}> => {\n  // TODO: Parallelize and/or put in callbacks to speed up evals.\n  const { evaluators } = evaluation;\n  const progress = new ProgressBar({\n    total: examples.length,\n    format: \"Running Evaluators: {bar} {percentage}% | {value}/{total}\\n\",\n  });\n  const caller = new AsyncCaller({\n    maxConcurrency,\n  });\n  const requests = runs.map(\n    async (\n      run,\n      i\n    ): Promise<{\n      run_id: string;\n      execution_time?: number;\n      feedback: Feedback[];\n    }> =>\n      caller.call(async () => {\n        const evaluatorResults = await Promise.allSettled(\n          evaluators.map((evaluator) =>\n            client.evaluateRun(run, evaluator, {\n              referenceExample: examples[i],\n              loadChildRuns: false,\n            })\n          )\n        );\n        progress.increment();\n        return {\n          execution_time:\n            run?.end_time && run.start_time\n              ? new Date(run.end_time).getTime() -\n                new Date(run.start_time).getTime()\n              : undefined,\n          feedback: evaluatorResults.map((evalResult) =>\n            evalResult.status === \"fulfilled\"\n              ? evalResult.value\n              : evalResult.reason\n          ),\n          run_id: run.id,\n        };\n      })\n  );\n  const results = await Promise.all(requests);\n\n  return results.reduce(\n    (acc, result, i) => ({\n      ...acc,\n      [examples[i].id]: result,\n    }),\n    {}\n  );\n};\n\nexport type EvalResults = {\n  projectName: string;\n  results: {\n    [key: string]: {\n      execution_time?: number;\n      run_id: string;\n      feedback: Feedback[];\n    };\n  };\n};\n\nconst getExamplesInputs = (\n  examples: Example[],\n  chainOrFactory: ChainOrFactory,\n  dataType?: DataType\n) => {\n  if (dataType === \"chat\") {\n    // For some batty reason, we store the chat dataset differently.\n    // { type: \"system\", data: { content: inputs.input } },\n    // But we need to create AIMesage, SystemMessage, etc.\n    return examples.map(({ inputs }) =>\n      mapStoredMessagesToChatMessages(inputs.input)\n    );\n  }\n  // If it's a language model and ALL example inputs have a single value,\n  // then we can be friendly and flatten the inputs to a list of strings.\n  const isLanguageModel =\n    typeof chainOrFactory === \"object\" &&\n    typeof (chainOrFactory as BaseLanguageModel)._llmType === \"function\";\n  if (\n    isLanguageModel &&\n    examples.every(({ inputs }) => Object.keys(inputs).length === 1)\n  ) {\n    return examples.map(({ inputs }) => Object.values(inputs)[0]);\n  }\n  return examples.map(({ inputs }) => inputs);\n};\n\n/**\n * Evaluates a given model or chain against a specified LangSmith dataset.\n *\n * This function fetches example records from the specified dataset,\n * runs the model or chain against each example, and returns the evaluation\n * results.\n *\n * @param chainOrFactory - A model or factory/constructor function to be evaluated. It can be a\n * Runnable instance, a factory function that returns a Runnable, or a user-defined\n * function or factory.\n *\n * @param datasetName - The name of the dataset against which the evaluation will be\n * performed. This dataset should already be defined and contain the relevant data\n * for evaluation.\n *\n * @param options - (Optional) Additional parameters for the evaluation process:\n *   - `evaluators` (RunEvalType[]): Evaluators to apply to a dataset run.\n *   - `formatEvaluatorInputs` (EvaluatorInputFormatter): Convert the evaluation data into formats that can be used by the evaluator.\n *   - `projectName` (string): Name of the project for logging and tracking.\n *   - `projectMetadata` (Record<string, unknown>): Additional metadata for the project.\n *   - `client` (Client): Client instance for LangSmith service interaction.\n *   - `maxConcurrency` (number): Maximum concurrency level for dataset processing.\n *\n * @returns A promise that resolves to an `EvalResults` object. This object includes\n * detailed results of the evaluation, such as execution time, run IDs, and feedback\n * for each entry in the dataset.\n *\n * @example\n * ```typescript\n * // Example usage for evaluating a model on a dataset\n * async function evaluateModel() {\n *   const chain = /* ...create your model or chain...*\\//\n *   const datasetName = 'example-dataset';\n *   const client = new Client(/* ...config... *\\//);\n *\n *   const results = await runOnDataset(chain, datasetName, {\n *     evaluators: [/* ...evaluators... *\\//],\n *     client,\n *   });\n *\n *   console.log('Evaluation Results:', results);\n * }\n *\n * evaluateModel();\n * ```\n * In this example, `runOnDataset` is used to evaluate a language model (or a chain of models) against\n * a dataset named 'example-dataset'. The evaluation process is configured using `RunOnDatasetParams[\"evaluators\"]`, which can\n * include both standard and custom evaluators. The `Client` instance is used to interact with LangChain services.\n * The function returns the evaluation results, which can be logged or further processed as needed.\n */\n\nexport async function runOnDataset(\n  chainOrFactory: ChainOrFactory,\n  datasetName: string,\n  options?: RunOnDatasetParams\n) {\n  const {\n    projectName,\n    projectMetadata,\n    client,\n    maxConcurrency,\n  }: RunOnDatasetParams = options ?? {};\n\n  const evaluationConfig: RunEvalConfig | undefined =\n    options?.evaluationConfig ??\n    (options?.evaluators != null\n      ? {\n          evaluators: options.evaluators,\n          formatEvaluatorInputs: options.formatEvaluatorInputs,\n        }\n      : undefined);\n\n  const wrappedModel = await createWrappedModel(chainOrFactory);\n  const testClient = client ?? new Client();\n  const testProjectName = projectName ?? randomName();\n  const dataset = await testClient.readDataset({ datasetName });\n  const datasetId = dataset.id;\n  const testConcurrency = maxConcurrency ?? 5;\n  const { configs, examples, runExtractors } = await loadExamples({\n    datasetName,\n    client: testClient,\n    projectName: testProjectName,\n    maxConcurrency: testConcurrency,\n  });\n\n  await testClient.createProject({\n    projectName: testProjectName,\n    referenceDatasetId: datasetId,\n    projectExtra: { metadata: { ...projectMetadata } },\n  });\n  const wrappedRunnable: Runnable = new RunnableLambda({\n    func: wrappedModel,\n  }).withConfig({ runName: \"evaluationRun\" });\n  const runInputs = getExamplesInputs(\n    examples,\n    chainOrFactory,\n    dataset.data_type\n  );\n  const progress = new ProgressBar({\n    total: runInputs.length,\n    format: \"Predicting: {bar} {percentage}% | {value}/{total}\",\n  });\n  // TODO: Collect the runs as well.\n  await wrappedRunnable\n    .withListeners({\n      onEnd: () => progress.increment(),\n    })\n    // TODO: Insert evaluation inline for immediate feedback.\n    .batch(runInputs, configs, {\n      maxConcurrency,\n      returnExceptions: true,\n    });\n\n  progress.complete();\n  const runs: Run[] = [];\n  for (let i = 0; i < examples.length; i += 1) {\n    runs.push(await runExtractors[i].extract());\n  }\n  let evalResults: Record<\n    string,\n    { run_id: string; execution_time?: number; feedback: Feedback[] }\n  > = {};\n  if (evaluationConfig) {\n    const loadedEvalConfig =\n      await LoadedEvalConfig.fromRunEvalConfig(evaluationConfig);\n    evalResults = await applyEvaluators({\n      evaluation: loadedEvalConfig,\n      runs,\n      examples,\n      client: testClient,\n      maxConcurrency: testConcurrency,\n    });\n  }\n  const results: EvalResults = {\n    projectName: testProjectName,\n    results: evalResults ?? {},\n  };\n  return results;\n}\n\nfunction isLangsmithTraceableFunction(x: unknown): x is AnyTraceableFunction {\n  return typeof x === \"function\" && \"langsmith:traceable\" in x;\n}\n"],"mappings":";;;;;;;;;;;AAsDA,IAAM,uBAAN,MAA2B;CACzB;CAEA;CAEA,cAAc;EACZ,KAAK,eAAe,IAAI,SAAiB,YAAY;GACnD,KAAK,uBAAuB;EAC9B,CAAC;CACH;CAEA,oBACE,QACA,SACA,UACG;EACH,KAAK,qBAAqB,KAAK;CACjC;CAEA,MAAM,UAA2B;EAC/B,OAAO,KAAK;CACd;AACF;AAEA,IAAM,qBAAN,cAAiCA,6BAAAA,WAAW;CAC1C;CAEA;;CAGA,OAAO;CAEP,cAAc;EACZ,MAAM;EACN,KAAK,aAAa,IAAI,SAAc,YAAY;GAC9C,KAAK,qBAAqB;EAC5B,CAAC;CACH;CAEA,MAAM,WAAW,KAAU;EACzB,KAAK,mBAAmB,GAAG;CAC7B;CAEA,MAAM,UAAwB;EAC5B,OAAO,KAAK;CACd;AACF;;;;AAKA,IAAM,sBAAN,MAAkD;CAChD;CAEA,YAAY,WAA6B;EACvC,KAAK,YAAY,IAAIC,0BAAAA,eAAe,EAAE,MAAM,UAAU,CAAC;CACzD;;;;;;;CAQA,MAAM,YAAY,KAAU,SAA8C;EACxE,MAAM,YAAY,IAAI,qBAAqB;EAC3C,MAAM,SAAS,IAAIC,yCAAAA,gBAAgB,EAAE,aAAa,aAAa,CAAC;EAChE,MAAM,SAAS,MAAM,KAAK,UAAU,OAClC;GACE;GACA;GACA,OAAO,IAAI;GACX,YAAY,IAAI;GAChB,WAAW,SAAS;EACtB,GACA,EACE,WAAW,CAAC,WAAW,MAAM,EAC/B,CACF;EAEA,OAAO;GACL,aAAa,MAFK,UAAU,QAAQ;GAGpC,GAAG;EACL;CACF;AACF;AAGA,SAAS,qBAAqB,WAAiD;CAC7E,OAAO,aAAa,OAAO,UAAU,oBAAoB;AAC3D;;;;;;;;AAYA,IAAM,yBAAN,MAAM,+BAA+BC,UAAAA,QAAQ;CAC3C;CAEA,wBAAgE,KAAA;CAEhE,YAAY,QAAuB,iBAAkC;EACnE,MAAM,MAAM;EAEZ,KAAK,kBAAkB;CACzB;CAEA,YAAY,QAA+C;EACzD,MAAM,QAAQ,IAAI,uBAChB;GACE,GAAG;GACH,YAAY;GACZ,cAAc,KAAK;GACnB,QAAQ,KAAK;EACf,GACA,KAAK,uBAAuB,SAAS,KAAK,KAAK,eACjD;EACA,KAAK,WAAW,KAAK,KAAK;EAC1B,OAAO;CACT;CAEA,MAAM,UAAyB;EAE7B,KAAK,wBAAwB,MAAM,KAAK,gBAAgB,iBACtD,OAAO,KAAK,eAAe,YACzB,KAAK,cAAc,QACnB,QAAQ,KAAK,aACX,KAAK,aACL;GACE,IAAI;IAAC;IAAa;IAAS;GAAwB;GACnD,IAAI;GACJ,MAAM;EACR,GACJ,KAAK,QACL,KAAK,IACL,KAAK,UACL,KAAA,GACA,KAAA,GACA,KAAK,IACP;CACF;CAEA,MAAM,WAA0B;EAC9B,IAAI,KAAK,OACP,MAAM,KAAK,uBAAuB,iBAChC,KAAK,OACL,KAAK,IACL,KAAK,YAAY,IACjB,KAAA,GACA,KAAA,CACF;OAEA,MAAM,KAAK,uBAAuB,eAChC,KAAK,WAAW,CAAC,GACjB,KAAK,IACL,KAAK,YAAY,IACjB,KAAA,GACA,KAAA,CACF;CAEJ;AACF;AAEA,IAAM,oBAAN,cAAqDC,0BAAAA,SAGnD;CACA,kBAAkB;CAElB,eAAe,CAAC,kBAAkB,WAAW;CAE7C;CAEA,YAAY,QAAwC;EAClD,MAAM,MAAM;EAEZ,IAAI,CAAC,6BAA6B,OAAO,IAAI,GAC3C,MAAM,IAAI,MACR,0FACF;EAGF,KAAK,OAAO,OAAO;CACrB;CAEA,MAAM,OAAO,OAAiB,SAAmC;EAC/D,MAAM,CAAC,UAAU,KAAK,gBAAgB,WAAW,CAAC,GAAG,CAAC;EACtD,MAAM,kBAAkB,OAAA,GAAA,0BAAA,4BAAA,CAAkC,MAAM;EAEhE,MAAM,gBACJ,yBAAyB,KAAK,OACzB,KAAK,KAAK,yBACX,EAAE,MAAM,WAAW;EAEzB,IAAI,CAAC,iBAAiB,MAAM,IAAI,MAAM,2BAA2B;EACjE,MAAM,UAAU,IAAI,uBAClB;GACE,GAAG;GACH,YAAY,iBAAiB,eACzB,IAAID,UAAAA,QAAQ;IAAE,MAAM;IAAY,IAAI,iBAAiB;GAAa,CAAC,IACnE,KAAA;EACN,GACA,eACF;EAEA,IACE,OAAO,UAAU,YACjB,SAAS,QACT,OAAO,KAAK,KAAK,CAAC,CAAC,WAAW,GAC9B;GACA,IAAI,UAAU,SAAS,MAAM,QAAQ,KAAK,GACxC,OAAQ,MAAM,KAAK,KAAK,SAAS,GAAG,KAAK;GAG3C,IACE,WAAW,SACX,EACE,OAAO,UAAU,YACjB,SAAS,QACT,CAAC,MAAM,QAAQ,KAAK,KAEpB,EAAE,iBAAiB,QAGrB,IAAI;IACF,OAAQ,MAAM,KAAK,KAAK,SAAS,MAAM,KAAK;GAC9C,QAAQ;IACN,OAAQ,MAAM,KAAK,KAAK,SAAS,KAAK;GACxC;EAEJ;EAEA,OAAQ,MAAM,KAAK,KAAK,SAAS,KAAK;CACxC;AACF;;;;;;AAOA,IAAM,uBAAN,MAAM,qBAA6C;CACjD;CAEA;CAEA;CAEA;CAEA,YACE,WACA,gBACA,uBACA;EACA,KAAK,YAAY;EACjB,KAAK,oBAAoB,OAAO,WAAW,oBAAoB;EAC/D,KAAK,iBAAiB;EACtB,KAAK,wBAAwB;CAC/B;CAEA,aAAa,eACX,QAC+B;EAC/B,MAAM,gBACJ,OAAO,WAAW,WAAW,SAAS,OAAO;EAC/C,MAAM,aAAa,OAAO,WAAW,WAAY,CAAC,IAAmB;EACrE,MAAM,YAAY,MAAME,eAAAA,cAAc,eAAe,UAAU;EAC/D,MAAM,cAAc,YAAY,eAAe,WAAW;EAC1D,IAAI,CAAC,qBAAqB,SAAS,GACjC,MAAM,IAAI,MACR,qBAAqB,cAAc,6GAGrC;EAEF,IAAI,CAAC,aACH,MAAM,IAAI,MACR,qBAAqB,cAAc,sGAErC;EAEF,OAAO,IAAI,qBACT,WACA,aACA,YAAY,qBACd;CACF;;;;;;;CAQA,MAAM,YAAY,KAAU,SAA8C;EACxE,MAAM,EAAE,YAAY,OAAO,cAAc,KAAK,sBAAsB;GAClE,UAAU,IAAI;GACd,eAAe,IAAI;GACnB,oBAAoB,SAAS;GAC7B;EACF,CAAC;EACD,MAAM,YAAY,IAAI,qBAAqB;EAC3C,MAAM,SAAS,IAAIH,yCAAAA,gBAAgB,EAAE,aAAa,aAAa,CAAC;EAChE,IAAI,KAAK,mBAAmB;GAC1B,MAAM,aAAa,MAAM,KAAK,UAAU,gBACtC;IACc;IACD;IACJ;GACT,GACA,EACE,WAAW,CAAC,WAAW,MAAM,EAC/B,CACF;GACA,MAAM,QAAQ,MAAM,UAAU,QAAQ;GACtC,OAAO;IACL,KAAK,KAAK;IACV,SAAS,YAAY;IACrB,aAAa;IACb,GAAG;GACL;EACF;EACA,MAAM,IAAI,MACR,uHAGF;CACF;AACF;AAEA,IAAM,mBAAN,MAAM,iBAAiB;CACF;CAAnB,YAAY,YAA2D;EAApD,KAAA,aAAA;CAAqD;CAExE,aAAa,kBACX,QAC2B;EAE3B,MAAM,oBACJ,QAAQ,oBAAoB,OAAO,YAAY,OAAOI,eAAAA,iBAAiB,EAAA,EACtE,KAAK,cAAc;GACpB,IAAI,OAAO,cAAc,YACvB,OAAO,IAAI,oBAAoB,SAAS;QAExC,OAAO;EAEX,CAAC;EAED,MAAM,wBAAwB,MAAM,QAAQ,IAC1C,QAAQ,YACJ,OAAOC,eAAAA,sBAAsB,CAAC,EAC9B,IACA,OAAO,cACL,MAAM,qBAAqB,eAAe,SAAS,CACvD,KAAK,CAAC,CACV;EACA,OAAO,IAAI,kBACR,oBAAoB,CAAC,EAAA,CAAG,OAAO,yBAAyB,CAAC,CAAC,CAC7D;CACF;AACF;;;;;;;;;AAwCA,MAAM,qBAAqB,OAAO,mBAAmC;CACnE,IAAIH,0BAAAA,SAAS,WAAW,cAAc,GACpC,aAAa;CAEf,IAAI,OAAO,mBAAmB,YAAY;EACxC,IAAI,6BAA6B,cAAc,GAAG;GAChD,MAAM,eAAe,IAAI,kBAAkB,EAAE,MAAM,eAAe,CAAC;GACnE,aAAa;EACf;EAEA,IAAI;GAEF,IAAI,MAAO,eAAkC;GAC7C,IACE,OACA,OAAQ,IAAqC,SAAS,YAEtD,MAAM,MAAM;GAEd,OAAO;EACT,QAAQ;GAGN,MAAM,eAAe,IAAIH,0BAAAA,eAAe,EAAE,MAAM,eAAe,CAAC;GAChE,aAAa;EACf;CACF;CACA,MAAM,IAAI,MAAM,wBAAwB;AAC1C;AAEA,MAAM,eAAe,OAAO,EAC1B,aACA,QACA,kBAMI;CACJ,MAAM,kBAAkB,OAAO,aAAa,EAAE,YAAY,CAAC;CAC3D,MAAM,UAA4B,CAAC;CACnC,MAAM,gBAAgB,CAAC;CACvB,MAAM,WAAW,CAAC;CAClB,WAAW,MAAM,WAAW,iBAAiB;EAC3C,MAAM,eAAe,IAAI,mBAAmB;EAC5C,QAAQ,KAAK,EACX,WAAW,CACT,IAAIC,yCAAAA,gBAAgB;GAAE,WAAW,QAAQ;GAAI;EAAY,CAAC,GAC1D,YACF,EACF,CAAC;EACD,SAAS,KAAK,OAAO;EACrB,cAAc,KAAK,YAAY;CACjC;CACA,OAAO;EACL;EACA;EACA;CACF;AACF;AAEA,MAAM,kBAAkB,OAAO,EAC7B,YACA,MACA,UACA,QACA,qBAaI;CAEJ,MAAM,EAAE,eAAe;CACvB,MAAM,WAAW,IAAIM,iBAAAA,YAAY;EAC/B,OAAO,SAAS;EAChB,QAAQ;CACV,CAAC;CACD,MAAM,SAAS,IAAIC,mCAAAA,YAAY,EAC7B,eACF,CAAC;CACD,MAAM,WAAW,KAAK,IACpB,OACE,KACA,MAMA,OAAO,KAAK,YAAY;EACtB,MAAM,mBAAmB,MAAM,QAAQ,WACrC,WAAW,KAAK,cACd,OAAO,YAAY,KAAK,WAAW;GACjC,kBAAkB,SAAS;GAC3B,eAAe;EACjB,CAAC,CACH,CACF;EACA,SAAS,UAAU;EACnB,OAAO;GACL,gBACE,KAAK,YAAY,IAAI,aACjB,IAAI,KAAK,IAAI,QAAQ,CAAC,CAAC,QAAQ,IAC/B,IAAI,KAAK,IAAI,UAAU,CAAC,CAAC,QAAQ,IACjC,KAAA;GACN,UAAU,iBAAiB,KAAK,eAC9B,WAAW,WAAW,cAClB,WAAW,QACX,WAAW,MACjB;GACA,QAAQ,IAAI;EACd;CACF,CAAC,CACL;CAGA,QAAO,MAFe,QAAQ,IAAI,QAAQ,EAAA,CAE3B,QACZ,KAAK,QAAQ,OAAO;EACnB,GAAG;GACF,SAAS,EAAE,CAAC,KAAK;CACpB,IACA,CAAC,CACH;AACF;AAaA,MAAM,qBACJ,UACA,gBACA,aACG;CACH,IAAI,aAAa,QAIf,OAAO,SAAS,KAAK,EAAE,cAAA,GAAA,yBAAA,gCAAA,CACW,OAAO,KAAK,CAC9C;CAOF,IAFE,OAAO,mBAAmB,YAC1B,OAAQ,eAAqC,aAAa,cAG1D,SAAS,OAAO,EAAE,aAAa,OAAO,KAAK,MAAM,CAAC,CAAC,WAAW,CAAC,GAE/D,OAAO,SAAS,KAAK,EAAE,aAAa,OAAO,OAAO,MAAM,CAAC,CAAC,EAAE;CAE9D,OAAO,SAAS,KAAK,EAAE,aAAa,MAAM;AAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqDA,eAAsB,aACpB,gBACA,aACA,SACA;CACA,MAAM,EACJ,aACA,iBACA,QACA,mBACsB,WAAW,CAAC;CAEpC,MAAM,mBACJ,SAAS,qBACR,SAAS,cAAc,OACpB;EACE,YAAY,QAAQ;EACpB,uBAAuB,QAAQ;CACjC,IACA,KAAA;CAEN,MAAM,eAAe,MAAM,mBAAmB,cAAc;CAC5D,MAAM,aAAa,UAAU,IAAIC,UAAAA,OAAO;CACxC,MAAM,kBAAkB,eAAeC,wBAAAA,WAAW;CAClD,MAAM,UAAU,MAAM,WAAW,YAAY,EAAE,YAAY,CAAC;CAC5D,MAAM,YAAY,QAAQ;CAC1B,MAAM,kBAAkB,kBAAkB;CAC1C,MAAM,EAAE,SAAS,UAAU,kBAAkB,MAAM,aAAa;EAC9D;EACA,QAAQ;EACR,aAAa;EACb,gBAAgB;CAClB,CAAC;CAED,MAAM,WAAW,cAAc;EAC7B,aAAa;EACb,oBAAoB;EACpB,cAAc,EAAE,UAAU,EAAE,GAAG,gBAAgB,EAAE;CACnD,CAAC;CACD,MAAM,kBAA4B,IAAIV,0BAAAA,eAAe,EACnD,MAAM,aACR,CAAC,CAAC,CAAC,WAAW,EAAE,SAAS,gBAAgB,CAAC;CAC1C,MAAM,YAAY,kBAChB,UACA,gBACA,QAAQ,SACV;CACA,MAAM,WAAW,IAAIO,iBAAAA,YAAY;EAC/B,OAAO,UAAU;EACjB,QAAQ;CACV,CAAC;CAED,MAAM,gBACH,cAAc,EACb,aAAa,SAAS,UAAU,EAClC,CAAC,CAAC,CAED,MAAM,WAAW,SAAS;EACzB;EACA,kBAAkB;CACpB,CAAC;CAEH,SAAS,SAAS;CAClB,MAAM,OAAc,CAAC;CACrB,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK,GACxC,KAAK,KAAK,MAAM,cAAc,EAAE,CAAC,QAAQ,CAAC;CAE5C,IAAI,cAGA,CAAC;CACL,IAAI,kBAAkB;EACpB,MAAM,mBACJ,MAAM,iBAAiB,kBAAkB,gBAAgB;EAC3D,cAAc,MAAM,gBAAgB;GAClC,YAAY;GACZ;GACA;GACA,QAAQ;GACR,gBAAgB;EAClB,CAAC;CACH;CAKA,OAAO;EAHL,aAAa;EACb,SAAS,eAAe,CAAC;CAEd;AACf;AAEA,SAAS,6BAA6B,GAAuC;CAC3E,OAAO,OAAO,MAAM,cAAc,yBAAyB;AAC7D"}
+{"version":3,"file":"runner_utils.cjs","names":["BaseTracer","RunnableLambda","LangChainTracer","RunTree","Runnable","getCallbackManagerForConfig","loadEvaluator","isCustomEvaluator","isOffTheShelfEvaluator","ProgressBar","AsyncCaller","mapStoredMessagesToChatMessages","Client","randomName"],"sources":["../../src/smith/runner_utils.ts"],"sourcesContent":["import { BaseLanguageModel } from \"@langchain/core/language_models/base\";\nimport { Serialized } from \"@langchain/core/load/serializable\";\nimport { mapStoredMessagesToChatMessages } from \"@langchain/core/messages\";\nimport {\n  Runnable,\n  RunnableConfig,\n  RunnableLambda,\n  getCallbackManagerForConfig,\n} from \"@langchain/core/runnables\";\nimport { LangChainTracer } from \"@langchain/core/tracers/tracer_langchain\";\nimport { BaseTracer } from \"@langchain/core/tracers/base\";\nimport { ChainValues } from \"@langchain/core/utils/types\";\nimport { AsyncCaller } from \"@langchain/core/utils/async_caller\";\nimport type {\n  CallbackManager,\n  CallbackManagerForChainRun,\n} from \"@langchain/core/callbacks/manager\";\nimport {\n  Client,\n  Example,\n  Feedback,\n  Run,\n  RunTree,\n  RunTreeConfig,\n} from \"langsmith\";\nimport { EvaluationResult, RunEvaluator } from \"langsmith/evaluation\";\nimport { DataType } from \"langsmith/schemas\";\nimport type { TraceableFunction } from \"langsmith/singletons/traceable\";\nimport { LLMStringEvaluator } from \"../evaluation/base.js\";\nimport { loadEvaluator } from \"../evaluation/loader.js\";\nimport { EvaluatorType } from \"../evaluation/types.js\";\nimport {\n  isOffTheShelfEvaluator,\n  type DynamicRunEvaluatorParams,\n  type EvalConfig,\n  type EvaluatorInputFormatter,\n  type RunEvalConfig,\n  type RunEvaluatorLike,\n  isCustomEvaluator,\n} from \"./config.js\";\nimport { randomName } from \"./name_generation.js\";\nimport { ProgressBar } from \"./progress.js\";\n\nexport type ChainOrFactory =\n  | Runnable\n  | (() => Runnable)\n  | AnyTraceableFunction\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  | ((obj: any) => any)\n  // oxlint-disable-next-line @typescript-eslint/no-explicit-any\n  | ((obj: any) => Promise<any>)\n  | (() => (obj: unknown) => unknown)\n  | (() => (obj: unknown) => Promise<unknown>);\n\nclass SingleRunIdExtractor {\n  runIdPromiseResolver: (runId: string) => void;\n\n  runIdPromise: Promise<string>;\n\n  constructor() {\n    this.runIdPromise = new Promise<string>((extract) => {\n      this.runIdPromiseResolver = extract;\n    });\n  }\n\n  handleChainStart = (\n    _chain: Serialized,\n    _inputs: ChainValues,\n    runId: string\n  ) => {\n    this.runIdPromiseResolver(runId);\n  };\n\n  async extract(): Promise<string> {\n    return this.runIdPromise;\n  }\n}\n\nclass SingleRunExtractor extends BaseTracer {\n  runPromiseResolver: (run: Run) => void;\n\n  runPromise: Promise<Run>;\n\n  /** The name of the callback handler. */\n  name = \"single_run_extractor\";\n\n  constructor() {\n    super();\n    this.runPromise = new Promise<Run>((extract) => {\n      this.runPromiseResolver = extract;\n    });\n  }\n\n  async persistRun(run: Run) {\n    this.runPromiseResolver(run);\n  }\n\n  async extract(): Promise<Run> {\n    return this.runPromise;\n  }\n}\n\n/**\n * Wraps an evaluator function + implements the RunEvaluator interface.\n */\nclass DynamicRunEvaluator implements RunEvaluator {\n  evaluator: RunnableLambda<DynamicRunEvaluatorParams, EvaluationResult>;\n\n  constructor(evaluator: RunEvaluatorLike) {\n    this.evaluator = new RunnableLambda({ func: evaluator });\n  }\n\n  /**\n   * Evaluates a run with an optional example and returns the evaluation result.\n   * @param run The run to evaluate.\n   * @param example The optional example to use for evaluation.\n   * @returns A promise that extracts to the evaluation result.\n   */\n  async evaluateRun(run: Run, example?: Example): Promise<EvaluationResult> {\n    const extractor = new SingleRunIdExtractor();\n    const tracer = new LangChainTracer({ projectName: \"evaluators\" });\n    const result = await this.evaluator.invoke(\n      {\n        run,\n        example,\n        input: run.inputs,\n        prediction: run.outputs,\n        reference: example?.outputs,\n      },\n      {\n        callbacks: [extractor, tracer],\n      }\n    );\n    const runId = await extractor.extract();\n    return {\n      sourceRunId: runId,\n      ...result,\n    };\n  }\n}\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\nfunction isLLMStringEvaluator(evaluator: any): evaluator is LLMStringEvaluator {\n  return evaluator && typeof evaluator.evaluateStrings === \"function\";\n}\n\n// oxlint-disable-next-line @typescript-eslint/no-explicit-any\ntype AnyTraceableFunction = TraceableFunction<(...any: any[]) => any>;\n\n/**\n * Internal implementation of RunTree, which uses the\n * provided callback manager instead of the internal LangSmith client.\n *\n * The goal of this class is to ensure seamless interop when intergrated\n * with other Runnables.\n */\nclass CallbackManagerRunTree extends RunTree {\n  callbackManager: CallbackManager;\n\n  activeCallbackManager: CallbackManagerForChainRun | undefined = undefined;\n\n  constructor(config: RunTreeConfig, callbackManager: CallbackManager) {\n    super(config);\n\n    this.callbackManager = callbackManager;\n  }\n\n  createChild(config: RunTreeConfig): CallbackManagerRunTree {\n    const child = new CallbackManagerRunTree(\n      {\n        ...config,\n        parent_run: this,\n        project_name: this.project_name,\n        client: this.client,\n      },\n      this.activeCallbackManager?.getChild() ?? this.callbackManager\n    );\n    this.child_runs.push(child);\n    return child;\n  }\n\n  async postRun(): Promise<void> {\n    // how it is translated in comparison to basic RunTree?\n    this.activeCallbackManager = await this.callbackManager.handleChainStart(\n      typeof this.serialized !== \"object\" &&\n        this.serialized != null &&\n        \"lc\" in this.serialized\n        ? this.serialized\n        : {\n            id: [\"langchain\", \"smith\", \"CallbackManagerRunTree\"],\n            lc: 1,\n            type: \"not_implemented\",\n          },\n      this.inputs,\n      this.id,\n      this.run_type,\n      undefined,\n      undefined,\n      this.name\n    );\n  }\n\n  async patchRun(): Promise<void> {\n    if (this.error) {\n      await this.activeCallbackManager?.handleChainError(\n        this.error,\n        this.id,\n        this.parent_run?.id,\n        undefined,\n        undefined\n      );\n    } else {\n      await this.activeCallbackManager?.handleChainEnd(\n        this.outputs ?? {},\n        this.id,\n        this.parent_run?.id,\n        undefined,\n        undefined\n      );\n    }\n  }\n}\n\nclass RunnableTraceable<RunInput, RunOutput> extends Runnable<\n  RunInput,\n  RunOutput\n> {\n  lc_serializable = false;\n\n  lc_namespace = [\"langchain_core\", \"runnables\"];\n\n  protected func: AnyTraceableFunction;\n\n  constructor(fields: { func: AnyTraceableFunction }) {\n    super(fields);\n\n    if (!isLangsmithTraceableFunction(fields.func)) {\n      throw new Error(\n        \"RunnableTraceable requires a function that is wrapped in traceable higher-order function\"\n      );\n    }\n\n    this.func = fields.func;\n  }\n\n  async invoke(input: RunInput, options?: Partial<RunnableConfig>) {\n    const [config] = this._getOptionsList(options ?? {}, 1);\n    const callbackManager = await getCallbackManagerForConfig(config);\n\n    const partialConfig =\n      \"langsmith:traceable\" in this.func\n        ? (this.func[\"langsmith:traceable\"] as RunTreeConfig)\n        : { name: \"<lambda>\" };\n\n    if (!callbackManager) throw new Error(\"CallbackManager not found\");\n    const runTree = new CallbackManagerRunTree(\n      {\n        ...partialConfig,\n        parent_run: callbackManager?._parentRunId\n          ? new RunTree({ name: \"<parent>\", id: callbackManager?._parentRunId })\n          : undefined,\n      },\n      callbackManager\n    );\n\n    if (\n      typeof input === \"object\" &&\n      input != null &&\n      Object.keys(input).length === 1\n    ) {\n      if (\"args\" in input && Array.isArray(input)) {\n        return (await this.func(runTree, ...input)) as RunOutput;\n      }\n\n      if (\n        \"input\" in input &&\n        !(\n          typeof input === \"object\" &&\n          input != null &&\n          !Array.isArray(input) &&\n          // oxlint-disable-next-line no-instanceof/no-instanceof\n          !(input instanceof Date)\n        )\n      ) {\n        try {\n          return (await this.func(runTree, input.input)) as RunOutput;\n        } catch {\n          return (await this.func(runTree, input)) as RunOutput;\n        }\n      }\n    }\n\n    return (await this.func(runTree, input)) as RunOutput;\n  }\n}\n\n/**\n * Wraps an off-the-shelf evaluator (loaded using loadEvaluator; of EvaluatorType[T])\n * and composes with a prepareData function so the user can prepare the trace and\n * dataset data for the evaluator.\n */\nclass PreparedRunEvaluator implements RunEvaluator {\n  evaluator: LLMStringEvaluator;\n\n  formatEvaluatorInputs: EvaluatorInputFormatter;\n\n  isStringEvaluator: boolean;\n\n  evaluationName: string;\n\n  constructor(\n    evaluator: LLMStringEvaluator,\n    evaluationName: string,\n    formatEvaluatorInputs: EvaluatorInputFormatter\n  ) {\n    this.evaluator = evaluator;\n    this.isStringEvaluator = typeof evaluator?.evaluateStrings === \"function\";\n    this.evaluationName = evaluationName;\n    this.formatEvaluatorInputs = formatEvaluatorInputs;\n  }\n\n  static async fromEvalConfig(\n    config: EvalConfig | keyof EvaluatorType\n  ): Promise<PreparedRunEvaluator> {\n    const evaluatorType =\n      typeof config === \"string\" ? config : config.evaluatorType;\n    const evalConfig = typeof config === \"string\" ? ({} as EvalConfig) : config;\n    const evaluator = await loadEvaluator(evaluatorType, evalConfig);\n    const feedbackKey = evalConfig?.feedbackKey ?? evaluator?.evaluationName;\n    if (!isLLMStringEvaluator(evaluator)) {\n      throw new Error(\n        `Evaluator of type ${evaluatorType} not yet supported. ` +\n          \"Please use a string evaluator, or implement your \" +\n          \"evaluation logic as a custom evaluator.\"\n      );\n    }\n    if (!feedbackKey) {\n      throw new Error(\n        `Evaluator of type ${evaluatorType} must have an evaluationName` +\n          ` or feedbackKey. Please manually provide a feedbackKey in the EvalConfig.`\n      );\n    }\n    return new PreparedRunEvaluator(\n      evaluator as LLMStringEvaluator,\n      feedbackKey,\n      evalConfig?.formatEvaluatorInputs\n    );\n  }\n\n  /**\n   * Evaluates a run with an optional example and returns the evaluation result.\n   * @param run The run to evaluate.\n   * @param example The optional example to use for evaluation.\n   * @returns A promise that extracts to the evaluation result.\n   */\n  async evaluateRun(run: Run, example?: Example): Promise<EvaluationResult> {\n    const { prediction, input, reference } = this.formatEvaluatorInputs({\n      rawInput: run.inputs,\n      rawPrediction: run.outputs,\n      rawReferenceOutput: example?.outputs,\n      run,\n    });\n    const extractor = new SingleRunIdExtractor();\n    const tracer = new LangChainTracer({ projectName: \"evaluators\" });\n    if (this.isStringEvaluator) {\n      const evalResult = await this.evaluator.evaluateStrings(\n        {\n          prediction: prediction as string,\n          reference: reference as string,\n          input: input as string,\n        },\n        {\n          callbacks: [extractor, tracer],\n        }\n      );\n      const runId = await extractor.extract();\n      return {\n        key: this.evaluationName,\n        comment: evalResult?.reasoning,\n        sourceRunId: runId,\n        ...evalResult,\n      };\n    }\n    throw new Error(\n      \"Evaluator not yet supported. \" +\n        \"Please use a string evaluator, or implement your \" +\n        \"evaluation logic as a custom evaluator.\"\n    );\n  }\n}\n\nclass LoadedEvalConfig {\n  constructor(public evaluators: (RunEvaluator | DynamicRunEvaluator)[]) {}\n\n  static async fromRunEvalConfig(\n    config: RunEvalConfig<keyof EvaluatorType>\n  ): Promise<LoadedEvalConfig> {\n    // Custom evaluators are applied \"as-is\"\n    const customEvaluators = (\n      config?.customEvaluators ?? config.evaluators?.filter(isCustomEvaluator)\n    )?.map((evaluator) => {\n      if (typeof evaluator === \"function\") {\n        return new DynamicRunEvaluator(evaluator);\n      } else {\n        return evaluator;\n      }\n    });\n\n    const offTheShelfEvaluators = await Promise.all(\n      config?.evaluators\n        ?.filter(isOffTheShelfEvaluator)\n        ?.map(\n          async (evaluator) =>\n            await PreparedRunEvaluator.fromEvalConfig(evaluator)\n        ) ?? []\n    );\n    return new LoadedEvalConfig(\n      (customEvaluators ?? []).concat(offTheShelfEvaluators ?? [])\n    );\n  }\n}\n\nexport interface RunOnDatasetParams extends Omit<\n  RunEvalConfig,\n  \"customEvaluators\"\n> {\n  /**\n   * Name of the project for logging and tracking.\n   */\n  projectName?: string;\n\n  /**\n   * Additional metadata for the project.\n   */\n  projectMetadata?: Record<string, unknown>;\n\n  /**\n   * Client instance for LangSmith service interaction.\n   */\n  client?: Client;\n\n  /**\n   * Maximum concurrency level for dataset processing.\n   */\n  maxConcurrency?: number;\n\n  /**\n   * @deprecated Pass keys directly to the RunOnDatasetParams instead\n   */\n  evaluationConfig?: RunEvalConfig;\n}\n\n/**\n * Internals expect a constructor () -> Runnable. This function wraps/coerces\n * the provided LangChain object, custom function, or factory function into\n * a constructor of a runnable.\n * @param modelOrFactory The model or factory to create a wrapped model from.\n * @returns A function that returns the wrapped model.\n * @throws Error if the modelOrFactory is invalid.\n */\nconst createWrappedModel = async (modelOrFactory: ChainOrFactory) => {\n  if (Runnable.isRunnable(modelOrFactory)) {\n    return () => modelOrFactory;\n  }\n  if (typeof modelOrFactory === \"function\") {\n    if (isLangsmithTraceableFunction(modelOrFactory)) {\n      const wrappedModel = new RunnableTraceable({ func: modelOrFactory });\n      return () => wrappedModel;\n    }\n\n    try {\n      // If it works with no arguments, assume it's a factory\n      let res = (modelOrFactory as () => Runnable)();\n      if (\n        res &&\n        typeof (res as unknown as Promise<Runnable>).then === \"function\"\n      ) {\n        res = await res;\n      }\n      return modelOrFactory as () => Runnable;\n    } catch {\n      // Otherwise, it's a custom UDF, and we'll wrap\n      // the function in a lambda\n      const wrappedModel = new RunnableLambda({ func: modelOrFactory });\n      return () => wrappedModel;\n    }\n  }\n  throw new Error(\"Invalid modelOrFactory\");\n};\n\nconst loadExamples = async ({\n  datasetName,\n  client,\n  projectName,\n}: {\n  datasetName: string;\n  client: Client;\n  projectName: string;\n  maxConcurrency: number;\n}) => {\n  const exampleIterator = client.listExamples({ datasetName });\n  const configs: RunnableConfig[] = [];\n  const runExtractors = [];\n  const examples = [];\n  for await (const example of exampleIterator) {\n    const runExtractor = new SingleRunExtractor();\n    configs.push({\n      callbacks: [\n        new LangChainTracer({ exampleId: example.id, projectName }),\n        runExtractor,\n      ],\n    });\n    examples.push(example);\n    runExtractors.push(runExtractor);\n  }\n  return {\n    configs,\n    examples,\n    runExtractors,\n  };\n};\n\nconst applyEvaluators = async ({\n  evaluation,\n  runs,\n  examples,\n  client,\n  maxConcurrency,\n}: {\n  evaluation: LoadedEvalConfig;\n  runs: Run[];\n  examples: Example[];\n  client: Client;\n  maxConcurrency: number;\n}): Promise<{\n  [key: string]: {\n    execution_time?: number;\n    run_id: string;\n    feedback: Feedback[];\n  };\n}> => {\n  // TODO: Parallelize and/or put in callbacks to speed up evals.\n  const { evaluators } = evaluation;\n  const progress = new ProgressBar({\n    total: examples.length,\n    format: \"Running Evaluators: {bar} {percentage}% | {value}/{total}\\n\",\n  });\n  const caller = new AsyncCaller({\n    maxConcurrency,\n  });\n  const requests = runs.map(\n    async (\n      run,\n      i\n    ): Promise<{\n      run_id: string;\n      execution_time?: number;\n      feedback: Feedback[];\n    }> =>\n      caller.call(async () => {\n        const evaluatorResults = await Promise.allSettled(\n          evaluators.map((evaluator) =>\n            client.evaluateRun(run, evaluator, {\n              referenceExample: examples[i],\n              loadChildRuns: false,\n            })\n          )\n        );\n        progress.increment();\n        return {\n          execution_time:\n            run?.end_time && run.start_time\n              ? new Date(run.end_time).getTime() -\n                new Date(run.start_time).getTime()\n              : undefined,\n          feedback: evaluatorResults.map((evalResult) =>\n            evalResult.status === \"fulfilled\"\n              ? evalResult.value\n              : evalResult.reason\n          ),\n          run_id: run.id,\n        };\n      })\n  );\n  const results = await Promise.all(requests);\n\n  return results.reduce(\n    (acc, result, i) => ({\n      ...acc,\n      [examples[i].id]: result,\n    }),\n    {}\n  );\n};\n\nexport type EvalResults = {\n  projectName: string;\n  results: {\n    [key: string]: {\n      execution_time?: number;\n      run_id: string;\n      feedback: Feedback[];\n    };\n  };\n};\n\nconst getExamplesInputs = (\n  examples: Example[],\n  chainOrFactory: ChainOrFactory,\n  dataType?: DataType\n) => {\n  if (dataType === \"chat\") {\n    // For some batty reason, we store the chat dataset differently.\n    // { type: \"system\", data: { content: inputs.input } },\n    // But we need to create AIMesage, SystemMessage, etc.\n    return examples.map(({ inputs }) =>\n      mapStoredMessagesToChatMessages(inputs.input)\n    );\n  }\n  // If it's a language model and ALL example inputs have a single value,\n  // then we can be friendly and flatten the inputs to a list of strings.\n  const isLanguageModel =\n    typeof chainOrFactory === \"object\" &&\n    typeof (chainOrFactory as BaseLanguageModel)._llmType === \"function\";\n  if (\n    isLanguageModel &&\n    examples.every(({ inputs }) => Object.keys(inputs).length === 1)\n  ) {\n    return examples.map(({ inputs }) => Object.values(inputs)[0]);\n  }\n  return examples.map(({ inputs }) => inputs);\n};\n\n/**\n * Evaluates a given model or chain against a specified LangSmith dataset.\n *\n * This function fetches example records from the specified dataset,\n * runs the model or chain against each example, and returns the evaluation\n * results.\n *\n * @param chainOrFactory - A model or factory/constructor function to be evaluated. It can be a\n * Runnable instance, a factory function that returns a Runnable, or a user-defined\n * function or factory.\n *\n * @param datasetName - The name of the dataset against which the evaluation will be\n * performed. This dataset should already be defined and contain the relevant data\n * for evaluation.\n *\n * @param options - (Optional) Additional parameters for the evaluation process:\n *   - `evaluators` (RunEvalType[]): Evaluators to apply to a dataset run.\n *   - `formatEvaluatorInputs` (EvaluatorInputFormatter): Convert the evaluation data into formats that can be used by the evaluator.\n *   - `projectName` (string): Name of the project for logging and tracking.\n *   - `projectMetadata` (Record<string, unknown>): Additional metadata for the project.\n *   - `client` (Client): Client instance for LangSmith service interaction.\n *   - `maxConcurrency` (number): Maximum concurrency level for dataset processing.\n *\n * @returns A promise that resolves to an `EvalResults` object. This object includes\n * detailed results of the evaluation, such as execution time, run IDs, and feedback\n * for each entry in the dataset.\n *\n * @example\n * ```typescript\n * // Example usage for evaluating a model on a dataset\n * async function evaluateModel() {\n *   const chain = /* ...create your model or chain...*\\//\n *   const datasetName = 'example-dataset';\n *   const client = new Client(/* ...config... *\\//);\n *\n *   const results = await runOnDataset(chain, datasetName, {\n *     evaluators: [/* ...evaluators... *\\//],\n *     client,\n *   });\n *\n *   console.log('Evaluation Results:', results);\n * }\n *\n * evaluateModel();\n * ```\n * In this example, `runOnDataset` is used to evaluate a language model (or a chain of models) against\n * a dataset named 'example-dataset'. The evaluation process is configured using `RunOnDatasetParams[\"evaluators\"]`, which can\n * include both standard and custom evaluators. The `Client` instance is used to interact with LangChain services.\n * The function returns the evaluation results, which can be logged or further processed as needed.\n */\n\nexport async function runOnDataset(\n  chainOrFactory: ChainOrFactory,\n  datasetName: string,\n  options?: RunOnDatasetParams\n) {\n  const {\n    projectName,\n    projectMetadata,\n    client,\n    maxConcurrency,\n  }: RunOnDatasetParams = options ?? {};\n\n  const evaluationConfig: RunEvalConfig | undefined =\n    options?.evaluationConfig ??\n    (options?.evaluators != null\n      ? {\n          evaluators: options.evaluators,\n          formatEvaluatorInputs: options.formatEvaluatorInputs,\n        }\n      : undefined);\n\n  const wrappedModel = await createWrappedModel(chainOrFactory);\n  const testClient = client ?? new Client();\n  const testProjectName = projectName ?? randomName();\n  const dataset = await testClient.readDataset({ datasetName });\n  const datasetId = dataset.id;\n  const testConcurrency = maxConcurrency ?? 5;\n  const { configs, examples, runExtractors } = await loadExamples({\n    datasetName,\n    client: testClient,\n    projectName: testProjectName,\n    maxConcurrency: testConcurrency,\n  });\n\n  await testClient.createProject({\n    projectName: testProjectName,\n    referenceDatasetId: datasetId,\n    projectExtra: { metadata: { ...projectMetadata } },\n  });\n  const wrappedRunnable: Runnable = new RunnableLambda({\n    func: wrappedModel,\n  }).withConfig({ runName: \"evaluationRun\" });\n  const runInputs = getExamplesInputs(\n    examples,\n    chainOrFactory,\n    dataset.data_type\n  );\n  const progress = new ProgressBar({\n    total: runInputs.length,\n    format: \"Predicting: {bar} {percentage}% | {value}/{total}\",\n  });\n  // TODO: Collect the runs as well.\n  await wrappedRunnable\n    .withListeners({\n      onEnd: () => progress.increment(),\n    })\n    // TODO: Insert evaluation inline for immediate feedback.\n    .batch(runInputs, configs, {\n      maxConcurrency,\n      returnExceptions: true,\n    });\n\n  progress.complete();\n  const runs: Run[] = [];\n  for (let i = 0; i < examples.length; i += 1) {\n    runs.push(await runExtractors[i].extract());\n  }\n  let evalResults: Record<\n    string,\n    { run_id: string; execution_time?: number; feedback: Feedback[] }\n  > = {};\n  if (evaluationConfig) {\n    const loadedEvalConfig =\n      await LoadedEvalConfig.fromRunEvalConfig(evaluationConfig);\n    evalResults = await applyEvaluators({\n      evaluation: loadedEvalConfig,\n      runs,\n      examples,\n      client: testClient,\n      maxConcurrency: testConcurrency,\n    });\n  }\n  const results: EvalResults = {\n    projectName: testProjectName,\n    results: evalResults ?? {},\n  };\n  return results;\n}\n\nfunction isLangsmithTraceableFunction(x: unknown): x is AnyTraceableFunction {\n  return typeof x === \"function\" && \"langsmith:traceable\" in x;\n}\n"],"mappings":";;;;;;;;;;;AAsDA,IAAM,uBAAN,MAA2B;CACzB;CAEA;CAEA,cAAc;EACZ,KAAK,eAAe,IAAI,SAAiB,YAAY;GACnD,KAAK,uBAAuB;EAC9B,CAAC;CACH;CAEA,oBACE,QACA,SACA,UACG;EACH,KAAK,qBAAqB,KAAK;CACjC;CAEA,MAAM,UAA2B;EAC/B,OAAO,KAAK;CACd;AACF;AAEA,IAAM,qBAAN,cAAiCA,6BAAAA,WAAW;CAC1C;CAEA;;CAGA,OAAO;CAEP,cAAc;EACZ,MAAM;EACN,KAAK,aAAa,IAAI,SAAc,YAAY;GAC9C,KAAK,qBAAqB;EAC5B,CAAC;CACH;CAEA,MAAM,WAAW,KAAU;EACzB,KAAK,mBAAmB,GAAG;CAC7B;CAEA,MAAM,UAAwB;EAC5B,OAAO,KAAK;CACd;AACF;;;;AAKA,IAAM,sBAAN,MAAkD;CAChD;CAEA,YAAY,WAA6B;EACvC,KAAK,YAAY,IAAIC,0BAAAA,eAAe,EAAE,MAAM,UAAU,CAAC;CACzD;;;;;;;CAQA,MAAM,YAAY,KAAU,SAA8C;EACxE,MAAM,YAAY,IAAI,qBAAqB;EAC3C,MAAM,SAAS,IAAIC,yCAAAA,gBAAgB,EAAE,aAAa,aAAa,CAAC;EAChE,MAAM,SAAS,MAAM,KAAK,UAAU,OAClC;GACE;GACA;GACA,OAAO,IAAI;GACX,YAAY,IAAI;GAChB,WAAW,SAAS;EACtB,GACA,EACE,WAAW,CAAC,WAAW,MAAM,EAC/B,CACF;EAEA,OAAO;GACL,aAAa,MAFK,UAAU,QAAQ;GAGpC,GAAG;EACL;CACF;AACF;AAGA,SAAS,qBAAqB,WAAiD;CAC7E,OAAO,aAAa,OAAO,UAAU,oBAAoB;AAC3D;;;;;;;;AAYA,IAAM,yBAAN,MAAM,+BAA+BC,UAAAA,QAAQ;CAC3C;CAEA,wBAAgE,KAAA;CAEhE,YAAY,QAAuB,iBAAkC;EACnE,MAAM,MAAM;EAEZ,KAAK,kBAAkB;CACzB;CAEA,YAAY,QAA+C;EACzD,MAAM,QAAQ,IAAI,uBAChB;GACE,GAAG;GACH,YAAY;GACZ,cAAc,KAAK;GACnB,QAAQ,KAAK;EACf,GACA,KAAK,uBAAuB,SAAS,KAAK,KAAK,eACjD;EACA,KAAK,WAAW,KAAK,KAAK;EAC1B,OAAO;CACT;CAEA,MAAM,UAAyB;EAE7B,KAAK,wBAAwB,MAAM,KAAK,gBAAgB,iBACtD,OAAO,KAAK,eAAe,YACzB,KAAK,cAAc,QACnB,QAAQ,KAAK,aACX,KAAK,aACL;GACE,IAAI;IAAC;IAAa;IAAS;GAAwB;GACnD,IAAI;GACJ,MAAM;EACR,GACJ,KAAK,QACL,KAAK,IACL,KAAK,UACL,KAAA,GACA,KAAA,GACA,KAAK,IACP;CACF;CAEA,MAAM,WAA0B;EAC9B,IAAI,KAAK,OACP,MAAM,KAAK,uBAAuB,iBAChC,KAAK,OACL,KAAK,IACL,KAAK,YAAY,IACjB,KAAA,GACA,KAAA,CACF;OAEA,MAAM,KAAK,uBAAuB,eAChC,KAAK,WAAW,CAAC,GACjB,KAAK,IACL,KAAK,YAAY,IACjB,KAAA,GACA,KAAA,CACF;CAEJ;AACF;AAEA,IAAM,oBAAN,cAAqDC,0BAAAA,SAGnD;CACA,kBAAkB;CAElB,eAAe,CAAC,kBAAkB,WAAW;CAE7C;CAEA,YAAY,QAAwC;EAClD,MAAM,MAAM;EAEZ,IAAI,CAAC,6BAA6B,OAAO,IAAI,GAC3C,MAAM,IAAI,MACR,0FACF;EAGF,KAAK,OAAO,OAAO;CACrB;CAEA,MAAM,OAAO,OAAiB,SAAmC;EAC/D,MAAM,CAAC,UAAU,KAAK,gBAAgB,WAAW,CAAC,GAAG,CAAC;EACtD,MAAM,kBAAkB,OAAA,GAAMC,0BAAAA,4BAAAA,CAA4B,MAAM;EAEhE,MAAM,gBACJ,yBAAyB,KAAK,OACzB,KAAK,KAAK,yBACX,EAAE,MAAM,WAAW;EAEzB,IAAI,CAAC,iBAAiB,MAAM,IAAI,MAAM,2BAA2B;EACjE,MAAM,UAAU,IAAI,uBAClB;GACE,GAAG;GACH,YAAY,iBAAiB,eACzB,IAAIF,UAAAA,QAAQ;IAAE,MAAM;IAAY,IAAI,iBAAiB;GAAa,CAAC,IACnE,KAAA;EACN,GACA,eACF;EAEA,IACE,OAAO,UAAU,YACjB,SAAS,QACT,OAAO,KAAK,KAAK,CAAC,CAAC,WAAW,GAC9B;GACA,IAAI,UAAU,SAAS,MAAM,QAAQ,KAAK,GACxC,OAAQ,MAAM,KAAK,KAAK,SAAS,GAAG,KAAK;GAG3C,IACE,WAAW,SACX,EACE,OAAO,UAAU,YACjB,SAAS,QACT,CAAC,MAAM,QAAQ,KAAK,KAEpB,EAAE,iBAAiB,QAGrB,IAAI;IACF,OAAQ,MAAM,KAAK,KAAK,SAAS,MAAM,KAAK;GAC9C,QAAQ;IACN,OAAQ,MAAM,KAAK,KAAK,SAAS,KAAK;GACxC;EAEJ;EAEA,OAAQ,MAAM,KAAK,KAAK,SAAS,KAAK;CACxC;AACF;;;;;;AAOA,IAAM,uBAAN,MAAM,qBAA6C;CACjD;CAEA;CAEA;CAEA;CAEA,YACE,WACA,gBACA,uBACA;EACA,KAAK,YAAY;EACjB,KAAK,oBAAoB,OAAO,WAAW,oBAAoB;EAC/D,KAAK,iBAAiB;EACtB,KAAK,wBAAwB;CAC/B;CAEA,aAAa,eACX,QAC+B;EAC/B,MAAM,gBACJ,OAAO,WAAW,WAAW,SAAS,OAAO;EAC/C,MAAM,aAAa,OAAO,WAAW,WAAY,CAAC,IAAmB;EACrE,MAAM,YAAY,MAAMG,eAAAA,cAAc,eAAe,UAAU;EAC/D,MAAM,cAAc,YAAY,eAAe,WAAW;EAC1D,IAAI,CAAC,qBAAqB,SAAS,GACjC,MAAM,IAAI,MACR,qBAAqB,cAAc,6GAGrC;EAEF,IAAI,CAAC,aACH,MAAM,IAAI,MACR,qBAAqB,cAAc,sGAErC;EAEF,OAAO,IAAI,qBACT,WACA,aACA,YAAY,qBACd;CACF;;;;;;;CAQA,MAAM,YAAY,KAAU,SAA8C;EACxE,MAAM,EAAE,YAAY,OAAO,cAAc,KAAK,sBAAsB;GAClE,UAAU,IAAI;GACd,eAAe,IAAI;GACnB,oBAAoB,SAAS;GAC7B;EACF,CAAC;EACD,MAAM,YAAY,IAAI,qBAAqB;EAC3C,MAAM,SAAS,IAAIJ,yCAAAA,gBAAgB,EAAE,aAAa,aAAa,CAAC;EAChE,IAAI,KAAK,mBAAmB;GAC1B,MAAM,aAAa,MAAM,KAAK,UAAU,gBACtC;IACc;IACD;IACJ;GACT,GACA,EACE,WAAW,CAAC,WAAW,MAAM,EAC/B,CACF;GACA,MAAM,QAAQ,MAAM,UAAU,QAAQ;GACtC,OAAO;IACL,KAAK,KAAK;IACV,SAAS,YAAY;IACrB,aAAa;IACb,GAAG;GACL;EACF;EACA,MAAM,IAAI,MACR,uHAGF;CACF;AACF;AAEA,IAAM,mBAAN,MAAM,iBAAiB;CACF;CAAnB,YAAY,YAA2D;EAApD,KAAA,aAAA;CAAqD;CAExE,aAAa,kBACX,QAC2B;EAE3B,MAAM,oBACJ,QAAQ,oBAAoB,OAAO,YAAY,OAAOK,eAAAA,iBAAiB,EAAA,EACtE,KAAK,cAAc;GACpB,IAAI,OAAO,cAAc,YACvB,OAAO,IAAI,oBAAoB,SAAS;QAExC,OAAO;EAEX,CAAC;EAED,MAAM,wBAAwB,MAAM,QAAQ,IAC1C,QAAQ,YACJ,OAAOC,eAAAA,sBAAsB,CAAC,EAC9B,IACA,OAAO,cACL,MAAM,qBAAqB,eAAe,SAAS,CACvD,KAAK,CAAC,CACV;EACA,OAAO,IAAI,kBACR,oBAAoB,CAAC,EAAA,CAAG,OAAO,yBAAyB,CAAC,CAAC,CAC7D;CACF;AACF;;;;;;;;;AAwCA,MAAM,qBAAqB,OAAO,mBAAmC;CACnE,IAAIJ,0BAAAA,SAAS,WAAW,cAAc,GACpC,aAAa;CAEf,IAAI,OAAO,mBAAmB,YAAY;EACxC,IAAI,6BAA6B,cAAc,GAAG;GAChD,MAAM,eAAe,IAAI,kBAAkB,EAAE,MAAM,eAAe,CAAC;GACnE,aAAa;EACf;EAEA,IAAI;GAEF,IAAI,MAAO,eAAkC;GAC7C,IACE,OACA,OAAQ,IAAqC,SAAS,YAEtD,MAAM,MAAM;GAEd,OAAO;EACT,QAAQ;GAGN,MAAM,eAAe,IAAIH,0BAAAA,eAAe,EAAE,MAAM,eAAe,CAAC;GAChE,aAAa;EACf;CACF;CACA,MAAM,IAAI,MAAM,wBAAwB;AAC1C;AAEA,MAAM,eAAe,OAAO,EAC1B,aACA,QACA,kBAMI;CACJ,MAAM,kBAAkB,OAAO,aAAa,EAAE,YAAY,CAAC;CAC3D,MAAM,UAA4B,CAAC;CACnC,MAAM,gBAAgB,CAAC;CACvB,MAAM,WAAW,CAAC;CAClB,WAAW,MAAM,WAAW,iBAAiB;EAC3C,MAAM,eAAe,IAAI,mBAAmB;EAC5C,QAAQ,KAAK,EACX,WAAW,CACT,IAAIC,yCAAAA,gBAAgB;GAAE,WAAW,QAAQ;GAAI;EAAY,CAAC,GAC1D,YACF,EACF,CAAC;EACD,SAAS,KAAK,OAAO;EACrB,cAAc,KAAK,YAAY;CACjC;CACA,OAAO;EACL;EACA;EACA;CACF;AACF;AAEA,MAAM,kBAAkB,OAAO,EAC7B,YACA,MACA,UACA,QACA,qBAaI;CAEJ,MAAM,EAAE,eAAe;CACvB,MAAM,WAAW,IAAIO,iBAAAA,YAAY;EAC/B,OAAO,SAAS;EAChB,QAAQ;CACV,CAAC;CACD,MAAM,SAAS,IAAIC,mCAAAA,YAAY,EAC7B,eACF,CAAC;CACD,MAAM,WAAW,KAAK,IACpB,OACE,KACA,MAMA,OAAO,KAAK,YAAY;EACtB,MAAM,mBAAmB,MAAM,QAAQ,WACrC,WAAW,KAAK,cACd,OAAO,YAAY,KAAK,WAAW;GACjC,kBAAkB,SAAS;GAC3B,eAAe;EACjB,CAAC,CACH,CACF;EACA,SAAS,UAAU;EACnB,OAAO;GACL,gBACE,KAAK,YAAY,IAAI,aACjB,IAAI,KAAK,IAAI,QAAQ,CAAC,CAAC,QAAQ,IAC/B,IAAI,KAAK,IAAI,UAAU,CAAC,CAAC,QAAQ,IACjC,KAAA;GACN,UAAU,iBAAiB,KAAK,eAC9B,WAAW,WAAW,cAClB,WAAW,QACX,WAAW,MACjB;GACA,QAAQ,IAAI;EACd;CACF,CAAC,CACL;CAGA,QAAO,MAFe,QAAQ,IAAI,QAAQ,EAAA,CAE3B,QACZ,KAAK,QAAQ,OAAO;EACnB,GAAG;GACF,SAAS,EAAE,CAAC,KAAK;CACpB,IACA,CAAC,CACH;AACF;AAaA,MAAM,qBACJ,UACA,gBACA,aACG;CACH,IAAI,aAAa,QAIf,OAAO,SAAS,KAAK,EAAE,cAAA,GACrBC,yBAAAA,gCAAAA,CAAgC,OAAO,KAAK,CAC9C;CAOF,IAFE,OAAO,mBAAmB,YAC1B,OAAQ,eAAqC,aAAa,cAG1D,SAAS,OAAO,EAAE,aAAa,OAAO,KAAK,MAAM,CAAC,CAAC,WAAW,CAAC,GAE/D,OAAO,SAAS,KAAK,EAAE,aAAa,OAAO,OAAO,MAAM,CAAC,CAAC,EAAE;CAE9D,OAAO,SAAS,KAAK,EAAE,aAAa,MAAM;AAC5C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqDA,eAAsB,aACpB,gBACA,aACA,SACA;CACA,MAAM,EACJ,aACA,iBACA,QACA,mBACsB,WAAW,CAAC;CAEpC,MAAM,mBACJ,SAAS,qBACR,SAAS,cAAc,OACpB;EACE,YAAY,QAAQ;EACpB,uBAAuB,QAAQ;CACjC,IACA,KAAA;CAEN,MAAM,eAAe,MAAM,mBAAmB,cAAc;CAC5D,MAAM,aAAa,UAAU,IAAIC,UAAAA,OAAO;CACxC,MAAM,kBAAkB,eAAeC,wBAAAA,WAAW;CAClD,MAAM,UAAU,MAAM,WAAW,YAAY,EAAE,YAAY,CAAC;CAC5D,MAAM,YAAY,QAAQ;CAC1B,MAAM,kBAAkB,kBAAkB;CAC1C,MAAM,EAAE,SAAS,UAAU,kBAAkB,MAAM,aAAa;EAC9D;EACA,QAAQ;EACR,aAAa;EACb,gBAAgB;CAClB,CAAC;CAED,MAAM,WAAW,cAAc;EAC7B,aAAa;EACb,oBAAoB;EACpB,cAAc,EAAE,UAAU,EAAE,GAAG,gBAAgB,EAAE;CACnD,CAAC;CACD,MAAM,kBAA4B,IAAIZ,0BAAAA,eAAe,EACnD,MAAM,aACR,CAAC,CAAC,CAAC,WAAW,EAAE,SAAS,gBAAgB,CAAC;CAC1C,MAAM,YAAY,kBAChB,UACA,gBACA,QAAQ,SACV;CACA,MAAM,WAAW,IAAIQ,iBAAAA,YAAY;EAC/B,OAAO,UAAU;EACjB,QAAQ;CACV,CAAC;CAED,MAAM,gBACH,cAAc,EACb,aAAa,SAAS,UAAU,EAClC,CAAC,CAAC,CAED,MAAM,WAAW,SAAS;EACzB;EACA,kBAAkB;CACpB,CAAC;CAEH,SAAS,SAAS;CAClB,MAAM,OAAc,CAAC;CACrB,KAAK,IAAI,IAAI,GAAG,IAAI,SAAS,QAAQ,KAAK,GACxC,KAAK,KAAK,MAAM,cAAc,EAAE,CAAC,QAAQ,CAAC;CAE5C,IAAI,cAGA,CAAC;CACL,IAAI,kBAAkB;EACpB,MAAM,mBACJ,MAAM,iBAAiB,kBAAkB,gBAAgB;EAC3D,cAAc,MAAM,gBAAgB;GAClC,YAAY;GACZ;GACA;GACA,QAAQ;GACR,gBAAgB;EAClB,CAAC;CACH;CAKA,OAAO;EAHL,aAAa;EACb,SAAS,eAAe,CAAC;CAEd;AACf;AAEA,SAAS,6BAA6B,GAAuC;CAC3E,OAAO,OAAO,MAAM,cAAc,yBAAyB;AAC7D"}

package/dist/stores/file/node.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"node.cjs","names":["BaseFileStore","fs"],"sources":["../../../src/stores/file/node.ts"],"sourcesContent":["import * as fs from \"node:fs/promises\";\nimport { mkdtempSync } from \"node:fs\";\nimport { join } from \"node:path\";\n\nimport { BaseFileStore } from \"./base.js\";\n\n/**\n * Specific implementation of the `BaseFileStore` class for Node.js.\n * Provides methods to read and write files in a specific base path.\n */\nexport class NodeFileStore extends BaseFileStore {\n  lc_namespace = [\"langchain\", \"stores\", \"file\", \"node\"];\n\n  constructor(public basePath: string = mkdtempSync(\"langchain-\")) {\n    super();\n  }\n\n  /**\n   * Reads the contents of a file at the given path.\n   * @param path Path of the file to read.\n   * @returns The contents of the file as a string.\n   */\n  async readFile(path: string): Promise<string> {\n    return await fs.readFile(join(this.basePath, path), \"utf8\");\n  }\n\n  /**\n   * Writes the given contents to a file at the specified path.\n   * @param path Path of the file to write to.\n   * @param contents Contents to write to the file.\n   * @returns Promise that resolves when the file has been written.\n   */\n  async writeFile(path: string, contents: string): Promise<void> {\n    await fs.writeFile(join(this.basePath, path), contents, \"utf8\");\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAUA,IAAa,gBAAb,cAAmCA,aAAAA,cAAc;CAG5B;CAFnB,eAAe;EAAC;EAAa;EAAU;EAAQ;CAAM;CAErD,YAAY,YAAO,GAAA,QAAA,YAAA,CAA+B,YAAY,GAAG;EAC/D,MAAM;EADW,KAAA,WAAA;CAEnB;;;;;;CAOA,MAAM,SAAS,MAA+B;EAC5C,OAAO,MAAMC,iBAAG,UAAA,GAAA,UAAA,KAAA,CAAc,KAAK,UAAU,IAAI,GAAG,MAAM;CAC5D;;;;;;;CAQA,MAAM,UAAU,MAAc,UAAiC;EAC7D,MAAMA,iBAAG,WAAA,GAAA,UAAA,KAAA,CAAe,KAAK,UAAU,IAAI,GAAG,UAAU,MAAM;CAChE;AACF"}
+{"version":3,"file":"node.cjs","names":["BaseFileStore","mkdtempSync","fs","join"],"sources":["../../../src/stores/file/node.ts"],"sourcesContent":["import * as fs from \"node:fs/promises\";\nimport { mkdtempSync } from \"node:fs\";\nimport { join } from \"node:path\";\n\nimport { BaseFileStore } from \"./base.js\";\n\n/**\n * Specific implementation of the `BaseFileStore` class for Node.js.\n * Provides methods to read and write files in a specific base path.\n */\nexport class NodeFileStore extends BaseFileStore {\n  lc_namespace = [\"langchain\", \"stores\", \"file\", \"node\"];\n\n  constructor(public basePath: string = mkdtempSync(\"langchain-\")) {\n    super();\n  }\n\n  /**\n   * Reads the contents of a file at the given path.\n   * @param path Path of the file to read.\n   * @returns The contents of the file as a string.\n   */\n  async readFile(path: string): Promise<string> {\n    return await fs.readFile(join(this.basePath, path), \"utf8\");\n  }\n\n  /**\n   * Writes the given contents to a file at the specified path.\n   * @param path Path of the file to write to.\n   * @param contents Contents to write to the file.\n   * @returns Promise that resolves when the file has been written.\n   */\n  async writeFile(path: string, contents: string): Promise<void> {\n    await fs.writeFile(join(this.basePath, path), contents, \"utf8\");\n  }\n}\n"],"mappings":";;;;;;;;;;;;;AAUA,IAAa,gBAAb,cAAmCA,aAAAA,cAAc;CAG5B;CAFnB,eAAe;EAAC;EAAa;EAAU;EAAQ;CAAM;CAErD,YAAY,YAAO,GAAmBC,QAAAA,YAAAA,CAAY,YAAY,GAAG;EAC/D,MAAM;EADW,KAAA,WAAA;CAEnB;;;;;;CAOA,MAAM,SAAS,MAA+B;EAC5C,OAAO,MAAMC,iBAAG,UAAA,GAASC,UAAAA,KAAAA,CAAK,KAAK,UAAU,IAAI,GAAG,MAAM;CAC5D;;;;;;;CAQA,MAAM,UAAU,MAAc,UAAiC;EAC7D,MAAMD,iBAAG,WAAA,GAAUC,UAAAA,KAAAA,CAAK,KAAK,UAAU,IAAI,GAAG,UAAU,MAAM;CAChE;AACF"}

package/dist/tools/render.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"render.cjs","names":["isOpenAITool"],"sources":["../../src/tools/render.ts"],"sourcesContent":["import { StructuredToolInterface } from \"@langchain/core/tools\";\nimport {\n  ToolDefinition,\n  isOpenAITool,\n} from \"@langchain/core/language_models/base\";\nimport {\n  toJsonSchema,\n  type JsonSchema7Type,\n} from \"@langchain/core/utils/json_schema\";\nimport { isInteropZodSchema } from \"@langchain/core/utils/types\";\n\n/**\n * Render the tool name and description in plain text.\n *\n * Output will be in the format of:\n * ```\n * search: This tool is used for search\n * calculator: This tool is used for math\n * ```\n * @param tools\n * @returns a string of all tools and their descriptions\n */\nexport function renderTextDescription(\n  tools: StructuredToolInterface[] | ToolDefinition[]\n): string {\n  if ((tools as unknown[]).every(isOpenAITool)) {\n    return (tools as ToolDefinition[])\n      .map(\n        (tool) =>\n          `${tool.function.name}${\n            tool.function.description ? `: ${tool.function.description}` : \"\"\n          }`\n      )\n      .join(\"\\n\");\n  }\n  return (tools as StructuredToolInterface[])\n    .map((tool) => `${tool.name}: ${tool.description}`)\n    .join(\"\\n\");\n}\n\n/**\n * Render the tool name, description, and args in plain text.\n * Output will be in the format of:'\n * ```\n * search: This tool is used for search, args: {\"query\": {\"type\": \"string\"}}\n * calculator: This tool is used for math,\n * args: {\"expression\": {\"type\": \"string\"}}\n * ```\n * @param tools\n * @returns a string of all tools, their descriptions and a stringified version of their schemas\n */\nexport function renderTextDescriptionAndArgs(\n  tools: StructuredToolInterface[] | ToolDefinition[]\n): string {\n  if ((tools as unknown[]).every(isOpenAITool)) {\n    return (tools as ToolDefinition[])\n      .map(\n        (tool) =>\n          `${tool.function.name}${\n            tool.function.description ? `: ${tool.function.description}` : \"\"\n          }, args: ${JSON.stringify(tool.function.parameters)}`\n      )\n      .join(\"\\n\");\n  }\n  return (tools as StructuredToolInterface[])\n    .map((tool) => {\n      const jsonSchema = (\n        isInteropZodSchema(tool.schema)\n          ? toJsonSchema(tool.schema)\n          : tool.schema\n      ) as { properties?: Record<string, JsonSchema7Type> } | undefined;\n      return `${tool.name}: ${tool.description}, args: ${JSON.stringify(\n        jsonSchema?.properties\n      )}`;\n    })\n    .join(\"\\n\");\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,sBACd,OACQ;CACR,IAAK,MAAoB,MAAMA,qCAAAA,YAAY,GACzC,OAAQ,MACL,KACE,SACC,GAAG,KAAK,SAAS,OACf,KAAK,SAAS,cAAc,KAAK,KAAK,SAAS,gBAAgB,IAErE,CAAC,CACA,KAAK,IAAI;CAEd,OAAQ,MACL,KAAK,SAAS,GAAG,KAAK,KAAK,IAAI,KAAK,aAAa,CAAC,CAClD,KAAK,IAAI;AACd;;;;;;;;;;;;AAaA,SAAgB,6BACd,OACQ;CACR,IAAK,MAAoB,MAAMA,qCAAAA,YAAY,GACzC,OAAQ,MACL,KACE,SACC,GAAG,KAAK,SAAS,OACf,KAAK,SAAS,cAAc,KAAK,KAAK,SAAS,gBAAgB,GAChE,UAAU,KAAK,UAAU,KAAK,SAAS,UAAU,GACtD,CAAC,CACA,KAAK,IAAI;CAEd,OAAQ,MACL,KAAK,SAAS;EACb,MAAM,cAAA,GAAA,4BAAA,mBAAA,CACe,KAAK,MAAM,KAAA,GAAA,kCAAA,aAAA,CACb,KAAK,MAAM,IACxB,KAAK;EAEX,OAAO,GAAG,KAAK,KAAK,IAAI,KAAK,YAAY,UAAU,KAAK,UACtD,YAAY,UACd;CACF,CAAC,CAAC,CACD,KAAK,IAAI;AACd"}
+{"version":3,"file":"render.cjs","names":["isOpenAITool","isInteropZodSchema","toJsonSchema"],"sources":["../../src/tools/render.ts"],"sourcesContent":["import { StructuredToolInterface } from \"@langchain/core/tools\";\nimport {\n  ToolDefinition,\n  isOpenAITool,\n} from \"@langchain/core/language_models/base\";\nimport {\n  toJsonSchema,\n  type JsonSchema7Type,\n} from \"@langchain/core/utils/json_schema\";\nimport { isInteropZodSchema } from \"@langchain/core/utils/types\";\n\n/**\n * Render the tool name and description in plain text.\n *\n * Output will be in the format of:\n * ```\n * search: This tool is used for search\n * calculator: This tool is used for math\n * ```\n * @param tools\n * @returns a string of all tools and their descriptions\n */\nexport function renderTextDescription(\n  tools: StructuredToolInterface[] | ToolDefinition[]\n): string {\n  if ((tools as unknown[]).every(isOpenAITool)) {\n    return (tools as ToolDefinition[])\n      .map(\n        (tool) =>\n          `${tool.function.name}${\n            tool.function.description ? `: ${tool.function.description}` : \"\"\n          }`\n      )\n      .join(\"\\n\");\n  }\n  return (tools as StructuredToolInterface[])\n    .map((tool) => `${tool.name}: ${tool.description}`)\n    .join(\"\\n\");\n}\n\n/**\n * Render the tool name, description, and args in plain text.\n * Output will be in the format of:'\n * ```\n * search: This tool is used for search, args: {\"query\": {\"type\": \"string\"}}\n * calculator: This tool is used for math,\n * args: {\"expression\": {\"type\": \"string\"}}\n * ```\n * @param tools\n * @returns a string of all tools, their descriptions and a stringified version of their schemas\n */\nexport function renderTextDescriptionAndArgs(\n  tools: StructuredToolInterface[] | ToolDefinition[]\n): string {\n  if ((tools as unknown[]).every(isOpenAITool)) {\n    return (tools as ToolDefinition[])\n      .map(\n        (tool) =>\n          `${tool.function.name}${\n            tool.function.description ? `: ${tool.function.description}` : \"\"\n          }, args: ${JSON.stringify(tool.function.parameters)}`\n      )\n      .join(\"\\n\");\n  }\n  return (tools as StructuredToolInterface[])\n    .map((tool) => {\n      const jsonSchema = (\n        isInteropZodSchema(tool.schema)\n          ? toJsonSchema(tool.schema)\n          : tool.schema\n      ) as { properties?: Record<string, JsonSchema7Type> } | undefined;\n      return `${tool.name}: ${tool.description}, args: ${JSON.stringify(\n        jsonSchema?.properties\n      )}`;\n    })\n    .join(\"\\n\");\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,sBACd,OACQ;CACR,IAAK,MAAoB,MAAMA,qCAAAA,YAAY,GACzC,OAAQ,MACL,KACE,SACC,GAAG,KAAK,SAAS,OACf,KAAK,SAAS,cAAc,KAAK,KAAK,SAAS,gBAAgB,IAErE,CAAC,CACA,KAAK,IAAI;CAEd,OAAQ,MACL,KAAK,SAAS,GAAG,KAAK,KAAK,IAAI,KAAK,aAAa,CAAC,CAClD,KAAK,IAAI;AACd;;;;;;;;;;;;AAaA,SAAgB,6BACd,OACQ;CACR,IAAK,MAAoB,MAAMA,qCAAAA,YAAY,GACzC,OAAQ,MACL,KACE,SACC,GAAG,KAAK,SAAS,OACf,KAAK,SAAS,cAAc,KAAK,KAAK,SAAS,gBAAgB,GAChE,UAAU,KAAK,UAAU,KAAK,SAAS,UAAU,GACtD,CAAC,CACA,KAAK,IAAI;CAEd,OAAQ,MACL,KAAK,SAAS;EACb,MAAM,cAAA,GACJC,4BAAAA,mBAAAA,CAAmB,KAAK,MAAM,KAAA,GAC1BC,kCAAAA,aAAAA,CAAa,KAAK,MAAM,IACxB,KAAK;EAEX,OAAO,GAAG,KAAK,KAAK,IAAI,KAAK,YAAY,UAAU,KAAK,UACtD,YAAY,UACd;CACF,CAAC,CAAC,CACD,KAAK,IAAI;AACd"}

package/dist/tools/retriever.cjs

@@ -7,7 +7,8 @@ let zod_v3 = require("zod/v3");
 var retriever_exports = /* @__PURE__ */ require_runtime.__exportAll({ createRetrieverTool: () => createRetrieverTool });
 function createRetrieverTool(retriever, input) {
 	const func = async ({ query }, runManager) => {
-		return require_util_document.formatDocumentsAsString(await retriever.invoke(query, runManager?.getChild("retriever")));
+		const docs = await retriever.invoke(query, runManager?.getChild("retriever"));
+		return require_util_document.formatDocumentsAsString(docs);
 	};
 	const schema = zod_v3.z.object({ query: zod_v3.z.string().describe("query to look up in retriever") });
 	return new _langchain_core_tools.DynamicStructuredTool({

package/dist/tools/retriever.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"retriever.cjs","names":["formatDocumentsAsString","z","DynamicStructuredTool"],"sources":["../../src/tools/retriever.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { z } from \"zod/v3\";\nimport { CallbackManagerForToolRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  DynamicStructuredTool,\n  type DynamicStructuredToolInput,\n} from \"@langchain/core/tools\";\nimport { formatDocumentsAsString } from \"../util/document.js\";\n\nexport function createRetrieverTool(\n  retriever: BaseRetrieverInterface,\n  input: Omit<DynamicStructuredToolInput, \"func\" | \"schema\">\n) {\n  const func = async (\n    { query }: { query: string },\n    runManager?: CallbackManagerForToolRun\n  ) => {\n    const docs = await retriever.invoke(\n      query,\n      runManager?.getChild(\"retriever\")\n    );\n    return formatDocumentsAsString(docs);\n  };\n  const schema = z.object({\n    query: z.string().describe(\"query to look up in retriever\"),\n  });\n  return new DynamicStructuredTool({ ...input, func, schema });\n}\n"],"mappings":";;;;;;;AASA,SAAgB,oBACd,WACA,OACA;CACA,MAAM,OAAO,OACX,EAAE,SACF,eACG;EAKH,OAAOA,sBAAAA,wBAAwB,MAJZ,UAAU,OAC3B,OACA,YAAY,SAAS,WAAW,CAClC,CACmC;CACrC;CACA,MAAM,SAASC,OAAAA,EAAE,OAAO,EACtB,OAAOA,OAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,+BAA+B,EAC5D,CAAC;CACD,OAAO,IAAIC,sBAAAA,sBAAsB;EAAE,GAAG;EAAO;EAAM;CAAO,CAAC;AAC7D"}
+{"version":3,"file":"retriever.cjs","names":["formatDocumentsAsString","z","DynamicStructuredTool"],"sources":["../../src/tools/retriever.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { z } from \"zod/v3\";\nimport { CallbackManagerForToolRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  DynamicStructuredTool,\n  type DynamicStructuredToolInput,\n} from \"@langchain/core/tools\";\nimport { formatDocumentsAsString } from \"../util/document.js\";\n\nexport function createRetrieverTool(\n  retriever: BaseRetrieverInterface,\n  input: Omit<DynamicStructuredToolInput, \"func\" | \"schema\">\n) {\n  const func = async (\n    { query }: { query: string },\n    runManager?: CallbackManagerForToolRun\n  ) => {\n    const docs = await retriever.invoke(\n      query,\n      runManager?.getChild(\"retriever\")\n    );\n    return formatDocumentsAsString(docs);\n  };\n  const schema = z.object({\n    query: z.string().describe(\"query to look up in retriever\"),\n  });\n  return new DynamicStructuredTool({ ...input, func, schema });\n}\n"],"mappings":";;;;;;;AASA,SAAgB,oBACd,WACA,OACA;CACA,MAAM,OAAO,OACX,EAAE,SACF,eACG;EACH,MAAM,OAAO,MAAM,UAAU,OAC3B,OACA,YAAY,SAAS,WAAW,CAClC;EACA,OAAOA,sBAAAA,wBAAwB,IAAI;CACrC;CACA,MAAM,SAASC,OAAAA,EAAE,OAAO,EACtB,OAAOA,OAAAA,EAAE,OAAO,CAAC,CAAC,SAAS,+BAA+B,EAC5D,CAAC;CACD,OAAO,IAAIC,sBAAAA,sBAAsB;EAAE,GAAG;EAAO;EAAM;CAAO,CAAC;AAC7D"}

package/dist/tools/retriever.js

@@ -6,7 +6,8 @@ import { z } from "zod/v3";
 var retriever_exports = /* @__PURE__ */ __exportAll({ createRetrieverTool: () => createRetrieverTool });
 function createRetrieverTool(retriever, input) {
 	const func = async ({ query }, runManager) => {
-		return formatDocumentsAsString(await retriever.invoke(query, runManager?.getChild("retriever")));
+		const docs = await retriever.invoke(query, runManager?.getChild("retriever"));
+		return formatDocumentsAsString(docs);
 	};
 	const schema = z.object({ query: z.string().describe("query to look up in retriever") });
 	return new DynamicStructuredTool({

package/dist/tools/retriever.js.map

@@ -1 +1 @@
-{"version":3,"file":"retriever.js","names":[],"sources":["../../src/tools/retriever.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { z } from \"zod/v3\";\nimport { CallbackManagerForToolRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  DynamicStructuredTool,\n  type DynamicStructuredToolInput,\n} from \"@langchain/core/tools\";\nimport { formatDocumentsAsString } from \"../util/document.js\";\n\nexport function createRetrieverTool(\n  retriever: BaseRetrieverInterface,\n  input: Omit<DynamicStructuredToolInput, \"func\" | \"schema\">\n) {\n  const func = async (\n    { query }: { query: string },\n    runManager?: CallbackManagerForToolRun\n  ) => {\n    const docs = await retriever.invoke(\n      query,\n      runManager?.getChild(\"retriever\")\n    );\n    return formatDocumentsAsString(docs);\n  };\n  const schema = z.object({\n    query: z.string().describe(\"query to look up in retriever\"),\n  });\n  return new DynamicStructuredTool({ ...input, func, schema });\n}\n"],"mappings":";;;;;;AASA,SAAgB,oBACd,WACA,OACA;CACA,MAAM,OAAO,OACX,EAAE,SACF,eACG;EAKH,OAAO,wBAAwB,MAJZ,UAAU,OAC3B,OACA,YAAY,SAAS,WAAW,CAClC,CACmC;CACrC;CACA,MAAM,SAAS,EAAE,OAAO,EACtB,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS,+BAA+B,EAC5D,CAAC;CACD,OAAO,IAAI,sBAAsB;EAAE,GAAG;EAAO;EAAM;CAAO,CAAC;AAC7D"}
+{"version":3,"file":"retriever.js","names":[],"sources":["../../src/tools/retriever.ts"],"sourcesContent":["import type { BaseRetrieverInterface } from \"@langchain/core/retrievers\";\nimport { z } from \"zod/v3\";\nimport { CallbackManagerForToolRun } from \"@langchain/core/callbacks/manager\";\nimport {\n  DynamicStructuredTool,\n  type DynamicStructuredToolInput,\n} from \"@langchain/core/tools\";\nimport { formatDocumentsAsString } from \"../util/document.js\";\n\nexport function createRetrieverTool(\n  retriever: BaseRetrieverInterface,\n  input: Omit<DynamicStructuredToolInput, \"func\" | \"schema\">\n) {\n  const func = async (\n    { query }: { query: string },\n    runManager?: CallbackManagerForToolRun\n  ) => {\n    const docs = await retriever.invoke(\n      query,\n      runManager?.getChild(\"retriever\")\n    );\n    return formatDocumentsAsString(docs);\n  };\n  const schema = z.object({\n    query: z.string().describe(\"query to look up in retriever\"),\n  });\n  return new DynamicStructuredTool({ ...input, func, schema });\n}\n"],"mappings":";;;;;;AASA,SAAgB,oBACd,WACA,OACA;CACA,MAAM,OAAO,OACX,EAAE,SACF,eACG;EACH,MAAM,OAAO,MAAM,UAAU,OAC3B,OACA,YAAY,SAAS,WAAW,CAClC;EACA,OAAO,wBAAwB,IAAI;CACrC;CACA,MAAM,SAAS,EAAE,OAAO,EACtB,OAAO,EAAE,OAAO,CAAC,CAAC,SAAS,+BAA+B,EAC5D,CAAC;CACD,OAAO,IAAI,sBAAsB;EAAE,GAAG;EAAO;EAAM;CAAO,CAAC;AAC7D"}

package/dist/tools/webbrowser.cjs

@@ -149,7 +149,8 @@ var WebBrowser = class extends _langchain_core_tools.Tool {
 				pageContent,
 				metadata: []
 			}));
-			context = require_util_document.formatDocumentsAsString(await (await require_vectorstores_memory.MemoryVectorStore.fromDocuments(docs, this.embeddings)).similaritySearch(task, 4, void 0, runManager?.getChild("vectorstore")));
+			const results = await (await require_vectorstores_memory.MemoryVectorStore.fromDocuments(docs, this.embeddings)).similaritySearch(task, 4, void 0, runManager?.getChild("vectorstore"));
+			context = require_util_document.formatDocumentsAsString(results);
 		}
 		const input = `Text:${context}\n\nI need ${doSummary ? "a summary" : task} from the above text, also provide up to 5 markdown links from within that would be of interest (always including URL and text). Links should be provided, if present, in markdown syntax as a list under the heading "Relevant Links:".`;
 		return _langchain_core_runnables.RunnableSequence.from([this.model, new _langchain_core_output_parsers.StringOutputParser()]).invoke(input, runManager?.getChild());