langchain 0.0.131 → 0.0.132

package/dist/output_parsers/router.cjs

@@ -3,6 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.RouterOutputParser = void 0;
 const structured_js_1 = require("./structured.cjs");
 const output_parser_js_1 = require("../schema/output_parser.cjs");
+/**
+ * A type of output parser that extends the
+ * JsonMarkdownStructuredOutputParser. It is used to parse the output of a
+ * router in LangChain. The class takes a schema and an optional
+ * RouterOutputParserInput object as parameters.
+ */
 class RouterOutputParser extends structured_js_1.JsonMarkdownStructuredOutputParser {
     constructor(schema, options) {
         super(schema);
@@ -15,6 +21,15 @@ class RouterOutputParser extends structured_js_1.JsonMarkdownStructuredOutputPar
         this.defaultDestination =
             options?.defaultDestination ?? this.defaultDestination;
     }
+    /**
+     * Overrides the parse method from JsonMarkdownStructuredOutputParser.
+     * This method takes a string as input, attempts to parse it, and returns
+     * the parsed text. If the destination of the parsed text matches the
+     * defaultDestination, the destination is set to null. If the parsing
+     * fails, an OutputParserException is thrown.
+     * @param text The text to be parsed.
+     * @returns The parsed text as a Promise.
+     */
     async parse(text) {
         try {
             const parsedText = await super.parse(text);

package/dist/output_parsers/router.d.ts

@@ -1,11 +1,30 @@
 import { z } from "zod";
 import { JsonMarkdownStructuredOutputParser } from "./structured.js";
+/**
+ * Defines the input parameters for the RouterOutputParser class. It can
+ * include a default destination and an interpolation depth.
+ */
 export type RouterOutputParserInput = {
     defaultDestination?: string;
     interpolationDepth?: number;
 };
+/**
+ * A type of output parser that extends the
+ * JsonMarkdownStructuredOutputParser. It is used to parse the output of a
+ * router in LangChain. The class takes a schema and an optional
+ * RouterOutputParserInput object as parameters.
+ */
 export declare class RouterOutputParser<Y extends z.ZodTypeAny> extends JsonMarkdownStructuredOutputParser<Y> {
     defaultDestination: string;
     constructor(schema: Y, options?: RouterOutputParserInput);
+    /**
+     * Overrides the parse method from JsonMarkdownStructuredOutputParser.
+     * This method takes a string as input, attempts to parse it, and returns
+     * the parsed text. If the destination of the parsed text matches the
+     * defaultDestination, the destination is set to null. If the parsing
+     * fails, an OutputParserException is thrown.
+     * @param text The text to be parsed.
+     * @returns The parsed text as a Promise.
+     */
     parse(text: string): Promise<z.infer<Y>>;
 }

package/dist/output_parsers/router.js

@@ -1,5 +1,11 @@
 import { JsonMarkdownStructuredOutputParser } from "./structured.js";
 import { OutputParserException } from "../schema/output_parser.js";
+/**
+ * A type of output parser that extends the
+ * JsonMarkdownStructuredOutputParser. It is used to parse the output of a
+ * router in LangChain. The class takes a schema and an optional
+ * RouterOutputParserInput object as parameters.
+ */
 export class RouterOutputParser extends JsonMarkdownStructuredOutputParser {
     constructor(schema, options) {
         super(schema);
@@ -12,6 +18,15 @@ export class RouterOutputParser extends JsonMarkdownStructuredOutputParser {
         this.defaultDestination =
             options?.defaultDestination ?? this.defaultDestination;
     }
+    /**
+     * Overrides the parse method from JsonMarkdownStructuredOutputParser.
+     * This method takes a string as input, attempts to parse it, and returns
+     * the parsed text. If the destination of the parsed text matches the
+     * defaultDestination, the destination is set to null. If the parsing
+     * fails, an OutputParserException is thrown.
+     * @param text The text to be parsed.
+     * @returns The parsed text as a Promise.
+     */
     async parse(text) {
         try {
             const parsedText = await super.parse(text);

package/dist/output_parsers/structured.cjs

@@ -26,13 +26,30 @@ class StructuredOutputParser extends output_parser_js_1.BaseOutputParser {
             value: ["langchain", "output_parsers", "structured"]
         });
     }
+    /**
+     * Creates a new StructuredOutputParser from a Zod schema.
+     * @param schema The Zod schema which the output should match
+     * @returns A new instance of StructuredOutputParser.
+     */
     static fromZodSchema(schema) {
         return new this(schema);
     }
+    /**
+     * Creates a new StructuredOutputParser from a set of names and
+     * descriptions.
+     * @param schemas An object where each key is a name and each value is a description
+     * @returns A new instance of StructuredOutputParser.
+     */
     static fromNamesAndDescriptions(schemas) {
         const zodSchema = zod_1.z.object(Object.fromEntries(Object.entries(schemas).map(([name, description]) => [name, zod_1.z.string().describe(description)])));
         return new this(zodSchema);
     }
+    /**
+     * Returns a markdown code snippet with a JSON object formatted according
+     * to the schema.
+     * @param options Optional. The options for formatting the instructions
+     * @returns A markdown code snippet with a JSON object formatted according to the schema.
+     */
     getFormatInstructions() {
         return `You must format your output as a JSON value that adheres to a given "JSON Schema" instance.
 
@@ -50,6 +67,11 @@ ${JSON.stringify((0, zod_to_json_schema_1.zodToJsonSchema)(this.schema))}
 \`\`\`
 `;
     }
+    /**
+     * Parses the given text according to the schema.
+     * @param text The text to parse
+     * @returns The parsed output.
+     */
     async parse(text) {
         try {
             const json = text.includes("```")
@@ -63,6 +85,10 @@ ${JSON.stringify((0, zod_to_json_schema_1.zodToJsonSchema)(this.schema))}
     }
 }
 exports.StructuredOutputParser = StructuredOutputParser;
+/**
+ * A specific type of `StructuredOutputParser` that parses JSON data
+ * formatted as a markdown code snippet.
+ */
 class JsonMarkdownStructuredOutputParser extends StructuredOutputParser {
     static lc_name() {
         return "JsonMarkdownStructuredOutputParser";
@@ -132,6 +158,10 @@ class JsonMarkdownStructuredOutputParser extends StructuredOutputParser {
     }
 }
 exports.JsonMarkdownStructuredOutputParser = JsonMarkdownStructuredOutputParser;
+/**
+ * A type of `StructuredOutputParser` that handles asymmetric input and
+ * output schemas.
+ */
 class AsymmetricStructuredOutputParser extends output_parser_js_1.BaseOutputParser {
     constructor({ inputSchema }) {
         super(...arguments);

package/dist/output_parsers/structured.d.ts

@@ -12,7 +12,18 @@ export declare class StructuredOutputParser<T extends z.ZodTypeAny> extends Base
     lc_namespace: string[];
     toJSON(): import("../load/serializable.js").SerializedNotImplemented;
     constructor(schema: T);
+    /**
+     * Creates a new StructuredOutputParser from a Zod schema.
+     * @param schema The Zod schema which the output should match
+     * @returns A new instance of StructuredOutputParser.
+     */
     static fromZodSchema<T extends z.ZodTypeAny>(schema: T): StructuredOutputParser<T>;
+    /**
+     * Creates a new StructuredOutputParser from a set of names and
+     * descriptions.
+     * @param schemas An object where each key is a name and each value is a description
+     * @returns A new instance of StructuredOutputParser.
+     */
     static fromNamesAndDescriptions<S extends {
         [key: string]: string;
     }>(schemas: S): StructuredOutputParser<z.ZodObject<{
@@ -22,9 +33,24 @@ export declare class StructuredOutputParser<T extends z.ZodTypeAny> extends Base
     }, {
         [x: string]: string;
     }>>;
+    /**
+     * Returns a markdown code snippet with a JSON object formatted according
+     * to the schema.
+     * @param options Optional. The options for formatting the instructions
+     * @returns A markdown code snippet with a JSON object formatted according to the schema.
+     */
     getFormatInstructions(): string;
+    /**
+     * Parses the given text according to the schema.
+     * @param text The text to parse
+     * @returns The parsed output.
+     */
     parse(text: string): Promise<z.infer<T>>;
 }
+/**
+ * A specific type of `StructuredOutputParser` that parses JSON data
+ * formatted as a markdown code snippet.
+ */
 export declare class JsonMarkdownStructuredOutputParser<T extends z.ZodTypeAny> extends StructuredOutputParser<T> {
     static lc_name(): string;
     getFormatInstructions(options?: JsonMarkdownFormatInstructionsOptions): string;
@@ -43,9 +69,19 @@ export declare class JsonMarkdownStructuredOutputParser<T extends z.ZodTypeAny>
 export interface AsymmetricStructuredOutputParserFields<T extends z.ZodTypeAny> {
     inputSchema: T;
 }
+/**
+ * A type of `StructuredOutputParser` that handles asymmetric input and
+ * output schemas.
+ */
 export declare abstract class AsymmetricStructuredOutputParser<T extends z.ZodTypeAny, Y = unknown> extends BaseOutputParser<Y> {
     private structuredInputParser;
     constructor({ inputSchema }: AsymmetricStructuredOutputParserFields<T>);
+    /**
+     * Processes the parsed input into the desired output format. Must be
+     * implemented by subclasses.
+     * @param input The parsed input
+     * @returns The processed output.
+     */
     abstract outputProcessor(input: z.infer<T>): Promise<Y>;
     parse(text: string): Promise<Y>;
     getFormatInstructions(): string;

package/dist/output_parsers/structured.js

@@ -23,13 +23,30 @@ export class StructuredOutputParser extends BaseOutputParser {
             value: ["langchain", "output_parsers", "structured"]
         });
     }
+    /**
+     * Creates a new StructuredOutputParser from a Zod schema.
+     * @param schema The Zod schema which the output should match
+     * @returns A new instance of StructuredOutputParser.
+     */
     static fromZodSchema(schema) {
         return new this(schema);
     }
+    /**
+     * Creates a new StructuredOutputParser from a set of names and
+     * descriptions.
+     * @param schemas An object where each key is a name and each value is a description
+     * @returns A new instance of StructuredOutputParser.
+     */
     static fromNamesAndDescriptions(schemas) {
         const zodSchema = z.object(Object.fromEntries(Object.entries(schemas).map(([name, description]) => [name, z.string().describe(description)])));
         return new this(zodSchema);
     }
+    /**
+     * Returns a markdown code snippet with a JSON object formatted according
+     * to the schema.
+     * @param options Optional. The options for formatting the instructions
+     * @returns A markdown code snippet with a JSON object formatted according to the schema.
+     */
     getFormatInstructions() {
         return `You must format your output as a JSON value that adheres to a given "JSON Schema" instance.
 
@@ -47,6 +64,11 @@ ${JSON.stringify(zodToJsonSchema(this.schema))}
 \`\`\`
 `;
     }
+    /**
+     * Parses the given text according to the schema.
+     * @param text The text to parse
+     * @returns The parsed output.
+     */
     async parse(text) {
         try {
             const json = text.includes("```")
@@ -59,6 +81,10 @@ ${JSON.stringify(zodToJsonSchema(this.schema))}
         }
     }
 }
+/**
+ * A specific type of `StructuredOutputParser` that parses JSON data
+ * formatted as a markdown code snippet.
+ */
 export class JsonMarkdownStructuredOutputParser extends StructuredOutputParser {
     static lc_name() {
         return "JsonMarkdownStructuredOutputParser";
@@ -127,6 +153,10 @@ export class JsonMarkdownStructuredOutputParser extends StructuredOutputParser {
         return new this(zodSchema);
     }
 }
+/**
+ * A type of `StructuredOutputParser` that handles asymmetric input and
+ * output schemas.
+ */
 export class AsymmetricStructuredOutputParser extends BaseOutputParser {
     constructor({ inputSchema }) {
         super(...arguments);

package/dist/prompts/base.cjs

@@ -6,6 +6,10 @@ exports.BaseExampleSelector = exports.BaseStringPromptTemplate = exports.BasePro
 const index_js_1 = require("../schema/index.cjs");
 const serializable_js_1 = require("../load/serializable.cjs");
 const runnable_js_1 = require("../schema/runnable.cjs");
+/**
+ * Represents a prompt value as a string. It extends the BasePromptValue
+ * class and overrides the toString and toChatMessages methods.
+ */
 class StringPromptValue extends index_js_1.BasePromptValue {
     constructor(value) {
         super(...arguments);
@@ -79,6 +83,11 @@ class BasePromptTemplate extends runnable_js_1.Runnable {
         }
         Object.assign(this, input);
     }
+    /**
+     * Merges partial variables and user variables.
+     * @param userVariables The user variables to merge with the partial variables.
+     * @returns A Promise that resolves to an object containing the merged variables.
+     */
     async mergePartialAndUserVariables(userVariables) {
         const partialVariables = this.partialVariables ?? {};
         const partialValues = {};
@@ -96,6 +105,12 @@ class BasePromptTemplate extends runnable_js_1.Runnable {
         };
         return allKwargs;
     }
+    /**
+     * Invokes the prompt template with the given input and options.
+     * @param input The input to invoke the prompt template with.
+     * @param options Optional configuration for the callback.
+     * @returns A Promise that resolves to the output of the prompt template.
+     */
     async invoke(input, options) {
         return this._callWithConfig((input) => this.formatPromptValue(input), input, { ...options, runType: "prompt" });
     }
@@ -135,7 +150,18 @@ class BasePromptTemplate extends runnable_js_1.Runnable {
     }
 }
 exports.BasePromptTemplate = BasePromptTemplate;
+/**
+ * Base class for string prompt templates. It extends the
+ * BasePromptTemplate class and overrides the formatPromptValue method to
+ * return a StringPromptValue.
+ */
 class BaseStringPromptTemplate extends BasePromptTemplate {
+    /**
+     * Formats the prompt given the input values and returns a formatted
+     * prompt value.
+     * @param values The input values to format the prompt.
+     * @returns A Promise that resolves to a formatted prompt value.
+     */
     async formatPromptValue(values) {
         const formattedPrompt = await this.format(values);
         return new StringPromptValue(formattedPrompt);

package/dist/prompts/base.d.ts

@@ -6,6 +6,10 @@ import { SerializedFields } from "../load/map_keys.js";
 import { Runnable } from "../schema/runnable.js";
 import { BaseCallbackConfig } from "../callbacks/manager.js";
 export type TypedPromptInputValues<RunInput> = InputValues<Extract<keyof RunInput, string> | (string & Record<never, never>)>;
+/**
+ * Represents a prompt value as a string. It extends the BasePromptValue
+ * class and overrides the toString and toChatMessages methods.
+ */
 export declare class StringPromptValue extends BasePromptValue {
     lc_namespace: string[];
     value: string;
@@ -42,7 +46,18 @@ export declare abstract class BasePromptTemplate<RunInput extends InputValues =
     partialVariables: PartialValues<PartialVariableName>;
     constructor(input: BasePromptTemplateInput);
     abstract partial(values: PartialValues): Promise<BasePromptTemplate<RunInput, RunOutput, PartialVariableName>>;
+    /**
+     * Merges partial variables and user variables.
+     * @param userVariables The user variables to merge with the partial variables.
+     * @returns A Promise that resolves to an object containing the merged variables.
+     */
     mergePartialAndUserVariables(userVariables: TypedPromptInputValues<RunInput>): Promise<InputValues<Extract<keyof RunInput, string> | PartialVariableName>>;
+    /**
+     * Invokes the prompt template with the given input and options.
+     * @param input The input to invoke the prompt template with.
+     * @param options Optional configuration for the callback.
+     * @returns A Promise that resolves to the output of the prompt template.
+     */
     invoke(input: RunInput, options?: BaseCallbackConfig): Promise<RunOutput>;
     /**
      * Format the prompt given the input values.
@@ -82,7 +97,18 @@ export declare abstract class BasePromptTemplate<RunInput extends InputValues =
      */
     static deserialize(data: SerializedBasePromptTemplate): Promise<BasePromptTemplate<InputValues, BasePromptValue, string>>;
 }
+/**
+ * Base class for string prompt templates. It extends the
+ * BasePromptTemplate class and overrides the formatPromptValue method to
+ * return a StringPromptValue.
+ */
 export declare abstract class BaseStringPromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BasePromptTemplate<RunInput, StringPromptValue, PartialVariableName> {
+    /**
+     * Formats the prompt given the input values and returns a formatted
+     * prompt value.
+     * @param values The input values to format the prompt.
+     * @returns A Promise that resolves to a formatted prompt value.
+     */
     formatPromptValue(values: TypedPromptInputValues<RunInput>): Promise<StringPromptValue>;
 }
 /**
@@ -90,6 +116,16 @@ export declare abstract class BaseStringPromptTemplate<RunInput extends InputVal
  */
 export declare abstract class BaseExampleSelector extends Serializable {
     lc_namespace: string[];
+    /**
+     * Adds an example to the example selector.
+     * @param example The example to add to the example selector.
+     * @returns A Promise that resolves to void or a string.
+     */
     abstract addExample(example: Example): Promise<void | string>;
+    /**
+     * Selects examples from the example selector given the input variables.
+     * @param input_variables The input variables to select examples with.
+     * @returns A Promise that resolves to an array of selected examples.
+     */
     abstract selectExamples(input_variables: Example): Promise<Example[]>;
 }

package/dist/prompts/base.js

@@ -3,6 +3,10 @@
 import { BasePromptValue, HumanMessage, } from "../schema/index.js";
 import { Serializable } from "../load/serializable.js";
 import { Runnable } from "../schema/runnable.js";
+/**
+ * Represents a prompt value as a string. It extends the BasePromptValue
+ * class and overrides the toString and toChatMessages methods.
+ */
 export class StringPromptValue extends BasePromptValue {
     constructor(value) {
         super(...arguments);
@@ -75,6 +79,11 @@ export class BasePromptTemplate extends Runnable {
         }
         Object.assign(this, input);
     }
+    /**
+     * Merges partial variables and user variables.
+     * @param userVariables The user variables to merge with the partial variables.
+     * @returns A Promise that resolves to an object containing the merged variables.
+     */
     async mergePartialAndUserVariables(userVariables) {
         const partialVariables = this.partialVariables ?? {};
         const partialValues = {};
@@ -92,6 +101,12 @@ export class BasePromptTemplate extends Runnable {
         };
         return allKwargs;
     }
+    /**
+     * Invokes the prompt template with the given input and options.
+     * @param input The input to invoke the prompt template with.
+     * @param options Optional configuration for the callback.
+     * @returns A Promise that resolves to the output of the prompt template.
+     */
     async invoke(input, options) {
         return this._callWithConfig((input) => this.formatPromptValue(input), input, { ...options, runType: "prompt" });
     }
@@ -130,7 +145,18 @@ export class BasePromptTemplate extends Runnable {
         }
     }
 }
+/**
+ * Base class for string prompt templates. It extends the
+ * BasePromptTemplate class and overrides the formatPromptValue method to
+ * return a StringPromptValue.
+ */
 export class BaseStringPromptTemplate extends BasePromptTemplate {
+    /**
+     * Formats the prompt given the input values and returns a formatted
+     * prompt value.
+     * @param values The input values to format the prompt.
+     * @returns A Promise that resolves to a formatted prompt value.
+     */
     async formatPromptValue(values) {
         const formattedPrompt = await this.format(values);
         return new StringPromptValue(formattedPrompt);

package/dist/prompts/chat.cjs

@@ -7,6 +7,11 @@ const index_js_1 = require("../schema/index.cjs");
 const runnable_js_1 = require("../schema/runnable.cjs");
 const base_js_1 = require("./base.cjs");
 const prompt_js_1 = require("./prompt.cjs");
+/**
+ * Abstract class that serves as a base for creating message prompt
+ * templates. It defines how to format messages for different roles in a
+ * conversation.
+ */
 class BaseMessagePromptTemplate extends runnable_js_1.Runnable {
     constructor() {
         super(...arguments);
@@ -23,11 +28,21 @@ class BaseMessagePromptTemplate extends runnable_js_1.Runnable {
             value: true
         });
     }
+    /**
+     * Calls the formatMessages method with the provided input and options.
+     * @param input Input for the formatMessages method
+     * @param options Optional BaseCallbackConfig
+     * @returns Formatted output messages
+     */
     async invoke(input, options) {
         return this._callWithConfig((input) => this.formatMessages(input), input, { ...options, runType: "prompt" });
     }
 }
 exports.BaseMessagePromptTemplate = BaseMessagePromptTemplate;
+/**
+ * Class that represents a chat prompt value. It extends the
+ * BasePromptValue and includes an array of BaseMessage instances.
+ */
 class ChatPromptValue extends index_js_1.BasePromptValue {
     static lc_name() {
         return "ChatPromptValue";
@@ -66,6 +81,10 @@ class ChatPromptValue extends index_js_1.BasePromptValue {
     }
 }
 exports.ChatPromptValue = ChatPromptValue;
+/**
+ * Class that represents a placeholder for messages in a chat prompt. It
+ * extends the BaseMessagePromptTemplate.
+ */
 class MessagesPlaceholder extends BaseMessagePromptTemplate {
     static lc_name() {
         return "MessagesPlaceholder";
@@ -92,6 +111,10 @@ class MessagesPlaceholder extends BaseMessagePromptTemplate {
     }
 }
 exports.MessagesPlaceholder = MessagesPlaceholder;
+/**
+ * Abstract class that serves as a base for creating message string prompt
+ * templates. It extends the BaseMessagePromptTemplate.
+ */
 class BaseMessageStringPromptTemplate extends BaseMessagePromptTemplate {
     constructor(fields) {
         if (!("prompt" in fields)) {
@@ -115,6 +138,10 @@ class BaseMessageStringPromptTemplate extends BaseMessagePromptTemplate {
     }
 }
 exports.BaseMessageStringPromptTemplate = BaseMessageStringPromptTemplate;
+/**
+ * Abstract class that serves as a base for creating chat prompt
+ * templates. It extends the BasePromptTemplate.
+ */
 class BaseChatPromptTemplate extends base_js_1.BasePromptTemplate {
     constructor(input) {
         super(input);
@@ -128,6 +155,10 @@ class BaseChatPromptTemplate extends base_js_1.BasePromptTemplate {
     }
 }
 exports.BaseChatPromptTemplate = BaseChatPromptTemplate;
+/**
+ * Class that represents a chat message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 class ChatMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
         return "ChatMessagePromptTemplate";
@@ -154,6 +185,10 @@ class ChatMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     }
 }
 exports.ChatMessagePromptTemplate = ChatMessagePromptTemplate;
+/**
+ * Class that represents a human message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 class HumanMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
         return "HumanMessagePromptTemplate";
@@ -166,6 +201,10 @@ class HumanMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     }
 }
 exports.HumanMessagePromptTemplate = HumanMessagePromptTemplate;
+/**
+ * Class that represents an AI message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 class AIMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
         return "AIMessagePromptTemplate";
@@ -178,6 +217,10 @@ class AIMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     }
 }
 exports.AIMessagePromptTemplate = AIMessagePromptTemplate;
+/**
+ * Class that represents a system message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 class SystemMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     static lc_name() {
         return "SystemMessagePromptTemplate";
@@ -190,6 +233,11 @@ class SystemMessagePromptTemplate extends BaseMessageStringPromptTemplate {
     }
 }
 exports.SystemMessagePromptTemplate = SystemMessagePromptTemplate;
+/**
+ * Class that represents a chat prompt. It extends the
+ * BaseChatPromptTemplate and uses an array of BaseMessagePromptTemplate
+ * instances to format a series of messages for a conversation.
+ */
 class ChatPromptTemplate extends BaseChatPromptTemplate {
     static lc_name() {
         return "ChatPromptTemplate";