@langchain/classic 1.0.23 → 1.0.24-dev-1773698445534

package/dist/output_parsers/structured.cjs

@@ -1,9 +1,8 @@
-const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+require("../_virtual/_rolldown/runtime.cjs");
 let _langchain_core_output_parsers = require("@langchain/core/output_parsers");
 let _langchain_core_utils_types = require("@langchain/core/utils/types");
 let _langchain_core_utils_json_schema = require("@langchain/core/utils/json_schema");
 let zod_v3 = require("zod/v3");
-
 //#region src/output_parsers/structured.ts
 var StructuredOutputParser = class extends _langchain_core_output_parsers.BaseOutputParser {
 	static lc_name() {
@@ -155,9 +154,9 @@ var AsymmetricStructuredOutputParser = class extends _langchain_core_output_pars
 		return this.structuredInputParser.getFormatInstructions();
 	}
 };
-
 //#endregion
 exports.AsymmetricStructuredOutputParser = AsymmetricStructuredOutputParser;
 exports.JsonMarkdownStructuredOutputParser = JsonMarkdownStructuredOutputParser;
 exports.StructuredOutputParser = StructuredOutputParser;
+
 //# sourceMappingURL=structured.cjs.map

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,gDAA2C;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAkB;EAAa;CAE5D,SAAS;AACP,SAAO,KAAK,sBAAsB;;CAGpC,YAAY,AAAO,QAAW;AAC5B,QAAM,OAAO;EADI;;;;;;;CASnB,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAK,OAAO;;;;;;;;CASzB,OAAO,yBACL,SACA;EACA,MAAM,YAAYC,SAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,SAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAK,UAAU;;;;;;;;CAS5B,wBAAgC;AAC9B,SAAO;;;;;;;;;;;;EAYT,KAAK,8DAAuB,KAAK,OAAO,CAAC,CAAC;;;;;;;;;CAU1C,MAAM,MAAM,MAAiD;AAC3D,MAAI;GACF,MAAM,OAAO,KAAK,SAAS,MAAM,GAC7B,KAAK,MAAM,CAAC,MAAM,eAAe,CAAC,KAClC,KAAK,MAAM;AACf,UAAO,yDAAwB,KAAK,QAAQ,KAAK,MAAM,KAAK,CAAC;UACvD;AACN,OAAI;AACF,WAAO,yDAAwB,KAAK,QAAQ,KAAK,MAAM,KAAK,MAAM,CAAC,CAAC;YAC7D,IAAI;AACX,UAAM,IAAIC,qDACR,2BAA2B,KAAK,YAAY,MAC5C,KACD;;;;;;;;;AAUT,IAAa,qCAAb,cAEU,uBAA0B;CAClC,OAAO,UAAU;AACf,SAAO;;CAGT,sBACE,SACQ;EACR,MAAM,qBAAqB,SAAS,sBAAsB;AAC1D,MAAI,qBAAqB,EACvB,OAAM,IAAI,MAAM,kDAAkD;AAGpE,SAAO,0FAA0F,KAAK,yEACvF,KAAK,OAAO,CAC1B,CACE,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAC/C,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAAC;;CAGrD,AAAQ,qBACN,aACA,SAAS,GACD;EACR,MAAM,SAAS;AASf,MAAI,UAAU,QAAQ;GACpB,IAAI,WAAW;GACf,IAAI;AACJ,OAAI,MAAM,QAAQ,OAAO,KAAK,EAAE;IAC9B,MAAM,UAAU,OAAO,KAAK,WAAW,SAAS,SAAS,OAAO;AAChE,QAAI,YAAY,IAAI;AAClB,gBAAW;AACX,YAAO,KAAK,OAAO,SAAS,EAAE;;AAEhC,WAAO,OAAO,KAAK,KAAK,MAAM;SAE9B,QAAO,OAAO;AAGhB,OAAI,OAAO,SAAS,YAAY,OAAO,YAAY;IACjD,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AAYJ,WAAO,MAXY,OAAO,QAAQ,OAAO,WAAW,CACjD,KAAK,CAAC,KAAK,WAAW;KACrB,MAAM,aAAa,OAAO,UAAU,SAAS,IAAI,GAC7C,KACA;AACJ,YAAO,GAAG,IAAI,OAAO,OAAO,CAAC,GAAG,IAAI,KAAK,KAAK,qBAC5C,OACA,SAAS,EACV,GAAG;MACJ,CACD,KAAK,KAAK,CACW,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,GAAG;;AAExD,OAAI,OAAO,SAAS,WAAW,OAAO,OAAO;IAC3C,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AACJ,WAAO,WAAW,IAAI,OAAO,OAAO,GAAG,KAAK,qBAC1C,OAAO,OACP,SAAS,EACV,CAAC,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,IAAI;;GAEnC,MAAM,aAAa,WAAW,gBAAgB;GAC9C,MAAM,cAAc,OAAO,cAAc,OAAO,OAAO,gBAAgB;AACvE,UAAO,GAAG,OAAO,cAAc;;AAGjC,MAAI,WAAW,OACb,QAAO,OAAO,MACX,KAAK,MAAM,KAAK,qBAAqB,GAAG,OAAO,CAAC,CAChD,KAAK,KAAK,IAAI,OAAO,SAAS,EAAE,GAAG;AAGxC,QAAM,IAAI,MAAM,0BAA0B;;CAG5C,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAQ,OAAO;;CAG5B,OAAO,yBACL,SACA;EACA,MAAM,YAAYD,SAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,SAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAuB,UAAU;;;;;;;AAchD,IAAsB,mCAAtB,cAGUD,gDAAoB;CAC5B,AAAQ;CAER,YAAY,EAAE,eAA0D;AACtE,QAAM,GAAG,UAAU;AACnB,OAAK,wBAAwB,IAAI,mCAC/B,YACD;;CAWH,MAAM,MAAM,MAA0B;EACpC,IAAI;AACJ,MAAI;AACF,iBAAc,MAAM,KAAK,sBAAsB,MAAM,KAAK;WACnD,GAAG;AACV,SAAM,IAAIE,qDACR,2BAA2B,KAAK,YAAY,KAC5C,KACD;;AAGH,SAAO,KAAK,gBAAgB,YAAY;;CAG1C,wBAAgC;AAC9B,SAAO,KAAK,sBAAsB,uBAAuB"}
+{"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;CACnD,OAAO,UAAU;AACf,SAAO;;CAGT,eAAe;EAAC;EAAa;EAAkB;EAAa;CAE5D,SAAS;AACP,SAAO,KAAK,sBAAsB;;CAGpC,YAAY,QAAkB;AAC5B,QAAM,OAAO;AADI,OAAA,SAAA;;;;;;;CASnB,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAK,OAAO;;;;;;;;CASzB,OAAO,yBACL,SACA;EACA,MAAM,YAAYC,OAAAA,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,OAAAA,EAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAK,UAAU;;;;;;;;CAS5B,wBAAgC;AAC9B,SAAO;;;;;;;;;;;;EAYT,KAAK,WAAA,GAAA,kCAAA,cAAuB,KAAK,OAAO,CAAC,CAAC;;;;;;;;;CAU1C,MAAM,MAAM,MAAiD;AAC3D,MAAI;GACF,MAAM,OAAO,KAAK,SAAS,MAAM,GAC7B,KAAK,MAAM,CAAC,MAAM,eAAe,CAAC,KAClC,KAAK,MAAM;AACf,UAAO,OAAA,GAAA,4BAAA,mBAAwB,KAAK,QAAQ,KAAK,MAAM,KAAK,CAAC;UACvD;AACN,OAAI;AACF,WAAO,OAAA,GAAA,4BAAA,mBAAwB,KAAK,QAAQ,KAAK,MAAM,KAAK,MAAM,CAAC,CAAC;YAC7D,IAAI;AACX,UAAM,IAAIC,+BAAAA,sBACR,2BAA2B,KAAK,YAAY,MAC5C,KACD;;;;;;;;;AAUT,IAAa,qCAAb,cAEU,uBAA0B;CAClC,OAAO,UAAU;AACf,SAAO;;CAGT,sBACE,SACQ;EACR,MAAM,qBAAqB,SAAS,sBAAsB;AAC1D,MAAI,qBAAqB,EACvB,OAAM,IAAI,MAAM,kDAAkD;AAGpE,SAAO,0FAA0F,KAAK,sBAAA,GAAA,kCAAA,cACvF,KAAK,OAAO,CAC1B,CACE,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAC/C,WAAW,KAAK,IAAI,OAAO,mBAAmB,CAAC,CAAC;;CAGrD,qBACE,aACA,SAAS,GACD;EACR,MAAM,SAAS;AASf,MAAI,UAAU,QAAQ;GACpB,IAAI,WAAW;GACf,IAAI;AACJ,OAAI,MAAM,QAAQ,OAAO,KAAK,EAAE;IAC9B,MAAM,UAAU,OAAO,KAAK,WAAW,SAAS,SAAS,OAAO;AAChE,QAAI,YAAY,IAAI;AAClB,gBAAW;AACX,YAAO,KAAK,OAAO,SAAS,EAAE;;AAEhC,WAAO,OAAO,KAAK,KAAK,MAAM;SAE9B,QAAO,OAAO;AAGhB,OAAI,OAAO,SAAS,YAAY,OAAO,YAAY;IACjD,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AAYJ,WAAO,MAXY,OAAO,QAAQ,OAAO,WAAW,CACjD,KAAK,CAAC,KAAK,WAAW;KACrB,MAAM,aAAa,OAAO,UAAU,SAAS,IAAI,GAC7C,KACA;AACJ,YAAO,GAAG,IAAI,OAAO,OAAO,CAAC,GAAG,IAAI,KAAK,KAAK,qBAC5C,OACA,SAAS,EACV,GAAG;MACJ,CACD,KAAK,KAAK,CACW,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,GAAG;;AAExD,OAAI,OAAO,SAAS,WAAW,OAAO,OAAO;IAC3C,MAAM,cAAc,OAAO,cACvB,OAAO,OAAO,gBACd;AACJ,WAAO,WAAW,IAAI,OAAO,OAAO,GAAG,KAAK,qBAC1C,OAAO,OACP,SAAS,EACV,CAAC,IAAI,IAAI,OAAO,SAAS,EAAE,CAAC,IAAI;;GAEnC,MAAM,aAAa,WAAW,gBAAgB;GAC9C,MAAM,cAAc,OAAO,cAAc,OAAO,OAAO,gBAAgB;AACvE,UAAO,GAAG,OAAO,cAAc;;AAGjC,MAAI,WAAW,OACb,QAAO,OAAO,MACX,KAAK,MAAM,KAAK,qBAAqB,GAAG,OAAO,CAAC,CAChD,KAAK,KAAK,IAAI,OAAO,SAAS,EAAE,GAAG;AAGxC,QAAM,IAAI,MAAM,0BAA0B;;CAG5C,OAAO,cAAwC,QAAW;AACxD,SAAO,IAAI,KAAQ,OAAO;;CAG5B,OAAO,yBACL,SACA;EACA,MAAM,YAAYD,OAAAA,EAAE,OAClB,OAAO,YACL,OAAO,QAAQ,QAAQ,CAAC,KACrB,CAAC,MAAM,iBACN,CAAC,MAAMA,OAAAA,EAAE,QAAQ,CAAC,SAAS,YAAY,CAAC,CAC3C,CACF,CACF;AAED,SAAO,IAAI,KAAuB,UAAU;;;;;;;AAchD,IAAsB,mCAAtB,cAGUD,+BAAAA,iBAAoB;CAC5B;CAEA,YAAY,EAAE,eAA0D;AACtE,QAAM,GAAG,UAAU;AACnB,OAAK,wBAAwB,IAAI,mCAC/B,YACD;;CAWH,MAAM,MAAM,MAA0B;EACpC,IAAI;AACJ,MAAI;AACF,iBAAc,MAAM,KAAK,sBAAsB,MAAM,KAAK;WACnD,GAAG;AACV,SAAM,IAAIE,+BAAAA,sBACR,2BAA2B,KAAK,YAAY,KAC5C,KACD;;AAGH,SAAO,KAAK,gBAAgB,YAAY;;CAG1C,wBAAgC;AAC9B,SAAO,KAAK,sBAAsB,uBAAuB"}

package/dist/output_parsers/structured.js

@@ -2,7 +2,6 @@ import { BaseOutputParser, OutputParserException } from "@langchain/core/output_
 import { interopParseAsync } from "@langchain/core/utils/types";
 import { toJsonSchema } from "@langchain/core/utils/json_schema";
 import { z } from "zod/v3";
-
 //#region src/output_parsers/structured.ts
 var StructuredOutputParser = class extends BaseOutputParser {
 	static lc_name() {
@@ -154,7 +153,7 @@ var AsymmetricStructuredOutputParser = class extends BaseOutputParser {
 		return this.structuredInputParser.getFormatInstructions();
 	}
 };
-
 //#endregion
 export { AsymmetricStructuredOutputParser, JsonMarkdownStructuredOutputParser, StructuredOutputParser };
+
 //# sourceMappingURL=structured.js.map

package/dist/output_parsers/structured.js.map

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

package/dist/retrievers/contextual_compression.cjs

@@ -1,7 +1,6 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('../_virtual/_rolldown/runtime.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_runtime = require("../_virtual/_rolldown/runtime.cjs");
 let _langchain_core_retrievers = require("@langchain/core/retrievers");
-
 //#region src/retrievers/contextual_compression.ts
 var contextual_compression_exports = /* @__PURE__ */ require_runtime.__exportAll({ ContextualCompressionRetriever: () => ContextualCompressionRetriever });
 /**
@@ -40,13 +39,13 @@ var ContextualCompressionRetriever = class extends _langchain_core_retrievers.Ba
 		return await this.baseCompressor.compressDocuments(docs, query, runManager?.getChild("base_compressor"));
 	}
 };
-
 //#endregion
 exports.ContextualCompressionRetriever = ContextualCompressionRetriever;
-Object.defineProperty(exports, 'contextual_compression_exports', {
-  enumerable: true,
-  get: function () {
-    return contextual_compression_exports;
-  }
+Object.defineProperty(exports, "contextual_compression_exports", {
+	enumerable: true,
+	get: function() {
+		return contextual_compression_exports;
+	}
 });
+
 //# sourceMappingURL=contextual_compression.cjs.map

package/dist/retrievers/contextual_compression.cjs.map

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

package/dist/retrievers/contextual_compression.js

@@ -1,6 +1,5 @@
 import { __exportAll } from "../_virtual/_rolldown/runtime.js";
 import { BaseRetriever } from "@langchain/core/retrievers";
-
 //#region src/retrievers/contextual_compression.ts
 var contextual_compression_exports = /* @__PURE__ */ __exportAll({ ContextualCompressionRetriever: () => ContextualCompressionRetriever });
 /**
@@ -39,7 +38,7 @@ var ContextualCompressionRetriever = class extends BaseRetriever {
 		return await this.baseCompressor.compressDocuments(docs, query, runManager?.getChild("base_compressor"));
 	}
 };
-
 //#endregion
 export { ContextualCompressionRetriever, contextual_compression_exports };
+
 //# sourceMappingURL=contextual_compression.js.map

package/dist/retrievers/contextual_compression.js.map

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

package/dist/retrievers/document_compressors/chain_extract.cjs

@@ -1,12 +1,11 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('../../_virtual/_rolldown/runtime.cjs');
-const require_llm_chain = require('../../chains/llm_chain.cjs');
-const require_retrievers_document_compressors_index = require('./index.cjs');
-const require_chain_extract_prompt = require('./chain_extract_prompt.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_runtime = require("../../_virtual/_rolldown/runtime.cjs");
+const require_llm_chain = require("../../chains/llm_chain.cjs");
+const require_retrievers_document_compressors_index = require("./index.cjs");
+const require_chain_extract_prompt = require("./chain_extract_prompt.cjs");
 let _langchain_core_prompts = require("@langchain/core/prompts");
 let _langchain_core_output_parsers = require("@langchain/core/output_parsers");
 let _langchain_core_documents = require("@langchain/core/documents");
-
 //#region src/retrievers/document_compressors/chain_extract.ts
 var chain_extract_exports = /* @__PURE__ */ require_runtime.__exportAll({ LLMChainExtractor: () => LLMChainExtractor });
 function defaultGetInput(query, doc) {
@@ -88,13 +87,13 @@ var LLMChainExtractor = class LLMChainExtractor extends require_retrievers_docum
 		});
 	}
 };
-
 //#endregion
 exports.LLMChainExtractor = LLMChainExtractor;
-Object.defineProperty(exports, 'chain_extract_exports', {
-  enumerable: true,
-  get: function () {
-    return chain_extract_exports;
-  }
+Object.defineProperty(exports, "chain_extract_exports", {
+	enumerable: true,
+	get: function() {
+		return chain_extract_exports;
+	}
 });
+
 //# sourceMappingURL=chain_extract.cjs.map

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

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

package/dist/retrievers/document_compressors/chain_extract.js

@@ -5,7 +5,6 @@ import { PROMPT_TEMPLATE } from "./chain_extract_prompt.js";
 import { PromptTemplate } from "@langchain/core/prompts";
 import { BaseOutputParser } from "@langchain/core/output_parsers";
 import { Document } from "@langchain/core/documents";
-
 //#region src/retrievers/document_compressors/chain_extract.ts
 var chain_extract_exports = /* @__PURE__ */ __exportAll({ LLMChainExtractor: () => LLMChainExtractor });
 function defaultGetInput(query, doc) {
@@ -87,7 +86,7 @@ var LLMChainExtractor = class LLMChainExtractor extends BaseDocumentCompressor {
 		});
 	}
 };
-
 //#endregion
 export { LLMChainExtractor, chain_extract_exports };
+
 //# sourceMappingURL=chain_extract.js.map

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

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

package/dist/retrievers/document_compressors/chain_extract_prompt.cjs

@@ -1,4 +1,3 @@
-
 //#region src/retrievers/document_compressors/chain_extract_prompt.ts
 const PROMPT_TEMPLATE = (noOutputStr) => `Given the following question and context, extract any part of the context *AS IS* that is relevant to answer the question. If none of the context is relevant return ${noOutputStr}.
 
@@ -10,7 +9,7 @@ Remember, *DO NOT* edit the extracted parts of the context.
 {context}
 >>>
 Extracted relevant parts:`;
-
 //#endregion
 exports.PROMPT_TEMPLATE = PROMPT_TEMPLATE;
+
 //# sourceMappingURL=chain_extract_prompt.cjs.map

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

@@ -1 +1 @@
-{"version":3,"file":"chain_extract_prompt.cjs","names":[],"sources":["../../../src/retrievers/document_compressors/chain_extract_prompt.ts"],"sourcesContent":["export const PROMPT_TEMPLATE = (\n  noOutputStr: string\n) => `Given the following question and context, extract any part of the context *AS IS* that is relevant to answer the question. If none of the context is relevant return ${noOutputStr}.\n\nRemember, *DO NOT* edit the extracted parts of the context.\n\n> Question: {question}\n> Context:\n>>>\n{context}\n>>>\nExtracted relevant parts:`;\n"],"mappings":";;AAAA,MAAa,mBACX,gBACG,wKAAwK,YAAY"}
+{"version":3,"file":"chain_extract_prompt.cjs","names":[],"sources":["../../../src/retrievers/document_compressors/chain_extract_prompt.ts"],"sourcesContent":["export const PROMPT_TEMPLATE = (\n  noOutputStr: string\n) => `Given the following question and context, extract any part of the context *AS IS* that is relevant to answer the question. If none of the context is relevant return ${noOutputStr}.\n\nRemember, *DO NOT* edit the extracted parts of the context.\n\n> Question: {question}\n> Context:\n>>>\n{context}\n>>>\nExtracted relevant parts:`;\n"],"mappings":";AAAA,MAAa,mBACX,gBACG,wKAAwK,YAAY"}

package/dist/retrievers/document_compressors/chain_extract_prompt.js

@@ -9,7 +9,7 @@ Remember, *DO NOT* edit the extracted parts of the context.
 {context}
 >>>
 Extracted relevant parts:`;
-
 //#endregion
 export { PROMPT_TEMPLATE };
+
 //# sourceMappingURL=chain_extract_prompt.js.map

package/dist/retrievers/document_compressors/embeddings_filter.cjs

@@ -1,8 +1,7 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('../../_virtual/_rolldown/runtime.cjs');
-const require_retrievers_document_compressors_index = require('./index.cjs');
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_runtime = require("../../_virtual/_rolldown/runtime.cjs");
+const require_retrievers_document_compressors_index = require("./index.cjs");
 let _langchain_core_utils_math = require("@langchain/core/utils/math");
-
 //#region src/retrievers/document_compressors/embeddings_filter.ts
 var embeddings_filter_exports = /* @__PURE__ */ require_runtime.__exportAll({ EmbeddingsFilter: () => EmbeddingsFilter });
 /**
@@ -62,13 +61,13 @@ var EmbeddingsFilter = class extends require_retrievers_document_compressors_ind
 		return includedIdxs.map((i) => documents[i]);
 	}
 };
-
 //#endregion
 exports.EmbeddingsFilter = EmbeddingsFilter;
-Object.defineProperty(exports, 'embeddings_filter_exports', {
-  enumerable: true,
-  get: function () {
-    return embeddings_filter_exports;
-  }
+Object.defineProperty(exports, "embeddings_filter_exports", {
+	enumerable: true,
+	get: function() {
+		return embeddings_filter_exports;
+	}
 });
+
 //# sourceMappingURL=embeddings_filter.cjs.map

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

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

package/dist/retrievers/document_compressors/embeddings_filter.js

@@ -1,7 +1,6 @@
 import { __exportAll } from "../../_virtual/_rolldown/runtime.js";
 import { BaseDocumentCompressor } from "./index.js";
 import { cosineSimilarity } from "@langchain/core/utils/math";
-
 //#region src/retrievers/document_compressors/embeddings_filter.ts
 var embeddings_filter_exports = /* @__PURE__ */ __exportAll({ EmbeddingsFilter: () => EmbeddingsFilter });
 /**
@@ -61,7 +60,7 @@ var EmbeddingsFilter = class extends BaseDocumentCompressor {
 		return includedIdxs.map((i) => documents[i]);
 	}
 };
-
 //#endregion
 export { EmbeddingsFilter, embeddings_filter_exports };
+
 //# sourceMappingURL=embeddings_filter.js.map

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

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

package/dist/retrievers/document_compressors/index.cjs

@@ -1,8 +1,6 @@
-Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_runtime = require('../../_virtual/_rolldown/runtime.cjs');
-
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/retrievers/document_compressors/index.ts
-var document_compressors_exports = /* @__PURE__ */ require_runtime.__exportAll({
+var document_compressors_exports = /* @__PURE__ */ require("../../_virtual/_rolldown/runtime.cjs").__exportAll({
 	BaseDocumentCompressor: () => BaseDocumentCompressor,
 	DocumentCompressorPipeline: () => DocumentCompressorPipeline
 });
@@ -56,14 +54,14 @@ var DocumentCompressorPipeline = class extends BaseDocumentCompressor {
 		return transformedDocuments;
 	}
 };
-
 //#endregion
 exports.BaseDocumentCompressor = BaseDocumentCompressor;
 exports.DocumentCompressorPipeline = DocumentCompressorPipeline;
-Object.defineProperty(exports, 'document_compressors_exports', {
-  enumerable: true,
-  get: function () {
-    return document_compressors_exports;
-  }
+Object.defineProperty(exports, "document_compressors_exports", {
+	enumerable: true,
+	get: function() {
+		return document_compressors_exports;
+	}
 });
+
 //# sourceMappingURL=index.cjs.map

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

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

package/dist/retrievers/document_compressors/index.js

@@ -1,5 +1,4 @@
 import { __exportAll } from "../../_virtual/_rolldown/runtime.js";
-
 //#region src/retrievers/document_compressors/index.ts
 var document_compressors_exports = /* @__PURE__ */ __exportAll({
 	BaseDocumentCompressor: () => BaseDocumentCompressor,
@@ -55,7 +54,7 @@ var DocumentCompressorPipeline = class extends BaseDocumentCompressor {
 		return transformedDocuments;
 	}
 };
-
 //#endregion
 export { BaseDocumentCompressor, DocumentCompressorPipeline, document_compressors_exports };
+
 //# sourceMappingURL=index.js.map

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

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