langchain 0.0.130 → 0.0.132

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,12 +28,25 @@ 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";
+    }
     constructor(fields) {
         if (Array.isArray(fields)) {
             // eslint-disable-next-line no-param-reassign
@@ -63,7 +81,14 @@ 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";
+    }
     constructor(fields) {
         if (typeof fields === "string") {
             // eslint-disable-next-line no-param-reassign
@@ -86,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)) {
@@ -109,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);
@@ -122,7 +155,14 @@ 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";
+    }
     constructor(fields, role) {
         if (!("prompt" in fields)) {
             // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-non-null-assertion
@@ -145,7 +185,14 @@ 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";
+    }
     async format(values) {
         return new index_js_1.HumanMessage(await this.prompt.format(values));
     }
@@ -154,7 +201,14 @@ 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";
+    }
     async format(values) {
         return new index_js_1.AIMessage(await this.prompt.format(values));
     }
@@ -163,7 +217,14 @@ 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";
+    }
     async format(values) {
         return new index_js_1.SystemMessage(await this.prompt.format(values));
     }
@@ -172,7 +233,15 @@ 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";
+    }
     get lc_aliases() {
         return {
             promptMessages: "messages",

package/dist/prompts/chat.d.ts

@@ -2,38 +2,78 @@ import { BaseCallbackConfig } from "../callbacks/manager.js";
 import { BaseMessage, BasePromptValue, InputValues, PartialValues } from "../schema/index.js";
 import { Runnable } from "../schema/runnable.js";
 import { BasePromptTemplate, BasePromptTemplateInput, BaseStringPromptTemplate, TypedPromptInputValues } from "./base.js";
+/**
+ * Abstract class that serves as a base for creating message prompt
+ * templates. It defines how to format messages for different roles in a
+ * conversation.
+ */
 export declare abstract class BaseMessagePromptTemplate<RunInput extends InputValues = any, RunOutput extends BaseMessage[] = BaseMessage[]> extends Runnable<RunInput, RunOutput> {
     lc_namespace: string[];
     lc_serializable: boolean;
     abstract inputVariables: Array<Extract<keyof RunInput, string>>;
+    /**
+     * Method that takes an object of TypedPromptInputValues and returns a
+     * promise that resolves to an array of BaseMessage instances.
+     * @param values Object of TypedPromptInputValues
+     * @returns Formatted array of BaseMessages
+     */
     abstract formatMessages(values: TypedPromptInputValues<RunInput>): Promise<RunOutput>;
+    /**
+     * 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
+     */
     invoke(input: RunInput, options?: BaseCallbackConfig): Promise<RunOutput>;
 }
+/**
+ * Interface for the fields of a ChatPromptValue.
+ */
 export interface ChatPromptValueFields {
     messages: BaseMessage[];
 }
+/**
+ * Class that represents a chat prompt value. It extends the
+ * BasePromptValue and includes an array of BaseMessage instances.
+ */
 export declare class ChatPromptValue extends BasePromptValue {
     lc_namespace: string[];
     lc_serializable: boolean;
+    static lc_name(): string;
     messages: BaseMessage[];
     constructor(messages: BaseMessage[]);
     constructor(fields: ChatPromptValueFields);
     toString(): string;
     toChatMessages(): BaseMessage[];
 }
+/**
+ * Interface for the fields of a MessagePlaceholder.
+ */
 export interface MessagePlaceholderFields<T extends string> {
     variableName: T;
 }
+/**
+ * Class that represents a placeholder for messages in a chat prompt. It
+ * extends the BaseMessagePromptTemplate.
+ */
 export declare class MessagesPlaceholder<RunInput extends InputValues = any> extends BaseMessagePromptTemplate<RunInput> {
+    static lc_name(): string;
     variableName: Extract<keyof RunInput, string>;
     constructor(variableName: Extract<keyof RunInput, string>);
     constructor(fields: MessagePlaceholderFields<Extract<keyof RunInput, string>>);
     get inputVariables(): Extract<keyof RunInput, string>[];
     formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
 }
+/**
+ * Interface for the fields of a MessageStringPromptTemplate.
+ */
 export interface MessageStringPromptTemplateFields<T extends InputValues = any> {
     prompt: BaseStringPromptTemplate<T, string>;
 }
+/**
+ * Abstract class that serves as a base for creating message string prompt
+ * templates. It extends the BaseMessagePromptTemplate.
+ */
 export declare abstract class BaseMessageStringPromptTemplate<RunInput extends InputValues = any> extends BaseMessagePromptTemplate<RunInput> {
     prompt: BaseStringPromptTemplate<InputValues<Extract<keyof RunInput, string>>, string>;
     constructor(prompt: BaseStringPromptTemplate<InputValues<Extract<keyof RunInput, string>>>);
@@ -42,34 +82,64 @@ export declare abstract class BaseMessageStringPromptTemplate<RunInput extends I
     abstract format(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage>;
     formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
 }
+/**
+ * Abstract class that serves as a base for creating chat prompt
+ * templates. It extends the BasePromptTemplate.
+ */
 export declare abstract class BaseChatPromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BasePromptTemplate<RunInput, ChatPromptValue, PartialVariableName> {
     constructor(input: BasePromptTemplateInput<RunInput, PartialVariableName>);
     abstract formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
     format(values: TypedPromptInputValues<RunInput>): Promise<string>;
     formatPromptValue(values: TypedPromptInputValues<RunInput>): Promise<ChatPromptValue>;
 }
+/**
+ * Interface for the fields of a ChatMessagePromptTemplate.
+ */
 export interface ChatMessagePromptTemplateFields<T extends InputValues = any> extends MessageStringPromptTemplateFields<T> {
     role: string;
 }
+/**
+ * Class that represents a chat message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export declare class ChatMessagePromptTemplate<RunInput extends InputValues = any> extends BaseMessageStringPromptTemplate<RunInput> {
+    static lc_name(): string;
     role: string;
     constructor(prompt: BaseStringPromptTemplate<InputValues<Extract<keyof RunInput, string>>>, role: string);
     constructor(fields: ChatMessagePromptTemplateFields<InputValues<Extract<keyof RunInput, string>>>);
     format(values: RunInput): Promise<BaseMessage>;
     static fromTemplate(template: string, role: string): ChatMessagePromptTemplate<any>;
 }
+/**
+ * Class that represents a human message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export declare class HumanMessagePromptTemplate<RunInput extends InputValues = any> extends BaseMessageStringPromptTemplate<RunInput> {
+    static lc_name(): string;
     format(values: RunInput): Promise<BaseMessage>;
     static fromTemplate(template: string): HumanMessagePromptTemplate<any>;
 }
+/**
+ * Class that represents an AI message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export declare class AIMessagePromptTemplate<RunInput extends InputValues = any> extends BaseMessageStringPromptTemplate<RunInput> {
+    static lc_name(): string;
     format(values: RunInput): Promise<BaseMessage>;
     static fromTemplate(template: string): AIMessagePromptTemplate<any>;
 }
+/**
+ * Class that represents a system message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export declare class SystemMessagePromptTemplate<RunInput extends InputValues = any> extends BaseMessageStringPromptTemplate<RunInput> {
+    static lc_name(): string;
     format(values: RunInput): Promise<BaseMessage>;
     static fromTemplate(template: string): SystemMessagePromptTemplate<any>;
 }
+/**
+ * Interface for the input of a ChatPromptTemplate.
+ */
 export interface ChatPromptTemplateInput<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BasePromptTemplateInput<RunInput, PartialVariableName> {
     /**
      * The prompt messages
@@ -82,7 +152,13 @@ export interface ChatPromptTemplateInput<RunInput extends InputValues = any, Par
      */
     validateTemplate?: boolean;
 }
+/**
+ * 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.
+ */
 export declare class ChatPromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BaseChatPromptTemplate<RunInput, PartialVariableName> implements ChatPromptTemplateInput<RunInput, PartialVariableName> {
+    static lc_name(): string;
     get lc_aliases(): {
         promptMessages: string;
     };

package/dist/prompts/chat.js

@@ -4,6 +4,11 @@ import { AIMessage, BasePromptValue, ChatMessage, HumanMessage, SystemMessage, }
 import { Runnable } from "../schema/runnable.js";
 import { BasePromptTemplate, } from "./base.js";
 import { PromptTemplate } from "./prompt.js";
+/**
+ * Abstract class that serves as a base for creating message prompt
+ * templates. It defines how to format messages for different roles in a
+ * conversation.
+ */
 export class BaseMessagePromptTemplate extends Runnable {
     constructor() {
         super(...arguments);
@@ -20,11 +25,24 @@ export class BaseMessagePromptTemplate extends 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" });
     }
 }
+/**
+ * Class that represents a chat prompt value. It extends the
+ * BasePromptValue and includes an array of BaseMessage instances.
+ */
 export class ChatPromptValue extends BasePromptValue {
+    static lc_name() {
+        return "ChatPromptValue";
+    }
     constructor(fields) {
         if (Array.isArray(fields)) {
             // eslint-disable-next-line no-param-reassign
@@ -58,7 +76,14 @@ export class ChatPromptValue extends BasePromptValue {
         return this.messages;
     }
 }
+/**
+ * Class that represents a placeholder for messages in a chat prompt. It
+ * extends the BaseMessagePromptTemplate.
+ */
 export class MessagesPlaceholder extends BaseMessagePromptTemplate {
+    static lc_name() {
+        return "MessagesPlaceholder";
+    }
     constructor(fields) {
         if (typeof fields === "string") {
             // eslint-disable-next-line no-param-reassign
@@ -80,6 +105,10 @@ export class MessagesPlaceholder extends BaseMessagePromptTemplate {
         return Promise.resolve(values[this.variableName]);
     }
 }
+/**
+ * Abstract class that serves as a base for creating message string prompt
+ * templates. It extends the BaseMessagePromptTemplate.
+ */
 export class BaseMessageStringPromptTemplate extends BaseMessagePromptTemplate {
     constructor(fields) {
         if (!("prompt" in fields)) {
@@ -102,6 +131,10 @@ export class BaseMessageStringPromptTemplate extends BaseMessagePromptTemplate {
         return [await this.format(values)];
     }
 }
+/**
+ * Abstract class that serves as a base for creating chat prompt
+ * templates. It extends the BasePromptTemplate.
+ */
 export class BaseChatPromptTemplate extends BasePromptTemplate {
     constructor(input) {
         super(input);
@@ -114,7 +147,14 @@ export class BaseChatPromptTemplate extends BasePromptTemplate {
         return new ChatPromptValue(resultMessages);
     }
 }
+/**
+ * Class that represents a chat message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export class ChatMessagePromptTemplate extends BaseMessageStringPromptTemplate {
+    static lc_name() {
+        return "ChatMessagePromptTemplate";
+    }
     constructor(fields, role) {
         if (!("prompt" in fields)) {
             // eslint-disable-next-line no-param-reassign, @typescript-eslint/no-non-null-assertion
@@ -136,7 +176,14 @@ export class ChatMessagePromptTemplate extends BaseMessageStringPromptTemplate {
         return new this(PromptTemplate.fromTemplate(template), role);
     }
 }
+/**
+ * Class that represents a human message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export class HumanMessagePromptTemplate extends BaseMessageStringPromptTemplate {
+    static lc_name() {
+        return "HumanMessagePromptTemplate";
+    }
     async format(values) {
         return new HumanMessage(await this.prompt.format(values));
     }
@@ -144,7 +191,14 @@ export class HumanMessagePromptTemplate extends BaseMessageStringPromptTemplate
         return new this(PromptTemplate.fromTemplate(template));
     }
 }
+/**
+ * Class that represents an AI message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export class AIMessagePromptTemplate extends BaseMessageStringPromptTemplate {
+    static lc_name() {
+        return "AIMessagePromptTemplate";
+    }
     async format(values) {
         return new AIMessage(await this.prompt.format(values));
     }
@@ -152,7 +206,14 @@ export class AIMessagePromptTemplate extends BaseMessageStringPromptTemplate {
         return new this(PromptTemplate.fromTemplate(template));
     }
 }
+/**
+ * Class that represents a system message prompt template. It extends the
+ * BaseMessageStringPromptTemplate.
+ */
 export class SystemMessagePromptTemplate extends BaseMessageStringPromptTemplate {
+    static lc_name() {
+        return "SystemMessagePromptTemplate";
+    }
     async format(values) {
         return new SystemMessage(await this.prompt.format(values));
     }
@@ -160,7 +221,15 @@ export class SystemMessagePromptTemplate extends BaseMessageStringPromptTemplate
         return new this(PromptTemplate.fromTemplate(template));
     }
 }
+/**
+ * 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.
+ */
 export class ChatPromptTemplate extends BaseChatPromptTemplate {
+    static lc_name() {
+        return "ChatPromptTemplate";
+    }
     get lc_aliases() {
         return {
             promptMessages: "messages",

package/dist/prompts/few_shot.cjs

@@ -106,6 +106,11 @@ class FewShotPromptTemplate extends base_js_1.BaseStringPromptTemplate {
         };
         return new FewShotPromptTemplate(promptDict);
     }
+    /**
+     * Formats the prompt with the given values.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
     async format(values) {
         const allValues = await this.mergePartialAndUserVariables(values);
         const examples = await this.getExamples(allValues);

package/dist/prompts/few_shot.d.ts

@@ -62,6 +62,11 @@ export declare class FewShotPromptTemplate extends BaseStringPromptTemplate impl
     _getPromptType(): "few_shot";
     private getExamples;
     partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<FewShotPromptTemplate>;
+    /**
+     * Formats the prompt with the given values.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
     format(values: InputValues): Promise<string>;
     serialize(): SerializedFewShotTemplate;
     static deserialize(data: SerializedFewShotTemplate): Promise<FewShotPromptTemplate>;

package/dist/prompts/few_shot.js

@@ -103,6 +103,11 @@ export class FewShotPromptTemplate extends BaseStringPromptTemplate {
         };
         return new FewShotPromptTemplate(promptDict);
     }
+    /**
+     * Formats the prompt with the given values.
+     * @param values The values to format the prompt with.
+     * @returns A promise that resolves to a string representing the formatted prompt.
+     */
     async format(values) {
         const allValues = await this.mergePartialAndUserVariables(values);
         const examples = await this.getExamples(allValues);

package/dist/prompts/pipeline.cjs

@@ -3,7 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.PipelinePromptTemplate = void 0;
 const base_js_1 = require("./base.cjs");
 const chat_js_1 = require("./chat.cjs");
+/**
+ * Class that handles a sequence of prompts, each of which may require
+ * different input variables. Includes methods for formatting these
+ * prompts, extracting required input values, and handling partial
+ * prompts.
+ */
 class PipelinePromptTemplate extends base_js_1.BasePromptTemplate {
+    static lc_name() {
+        return "PipelinePromptTemplate";
+    }
     constructor(input) {
         super({ ...input, inputVariables: [] });
         Object.defineProperty(this, "pipelinePrompts", {
@@ -22,6 +31,10 @@ class PipelinePromptTemplate extends base_js_1.BasePromptTemplate {
         this.finalPrompt = input.finalPrompt;
         this.inputVariables = this.computeInputValues();
     }
+    /**
+     * Computes the input values required by the pipeline prompts.
+     * @returns Array of input values required by the pipeline prompts.
+     */
     computeInputValues() {
         const intermediateValues = this.pipelinePrompts.map((pipelinePrompt) => pipelinePrompt.name);
         const inputValues = this.pipelinePrompts
@@ -36,6 +49,11 @@ class PipelinePromptTemplate extends base_js_1.BasePromptTemplate {
             return requiredValues;
         }, {});
     }
+    /**
+     * Formats the pipeline prompts based on the provided input values.
+     * @param values Input values to format the pipeline prompts.
+     * @returns Promise that resolves with the formatted input values.
+     */
     async formatPipelinePrompts(values) {
         const allValues = await this.mergePartialAndUserVariables(values);
         for (const { name: pipelinePromptName, prompt: pipelinePrompt } of this
@@ -51,12 +69,23 @@ class PipelinePromptTemplate extends base_js_1.BasePromptTemplate {
         }
         return PipelinePromptTemplate.extractRequiredInputValues(allValues, this.finalPrompt.inputVariables);
     }
+    /**
+     * Formats the final prompt value based on the provided input values.
+     * @param values Input values to format the final prompt value.
+     * @returns Promise that resolves with the formatted final prompt value.
+     */
     async formatPromptValue(values) {
         return this.finalPrompt.formatPromptValue(await this.formatPipelinePrompts(values));
     }
     async format(values) {
         return this.finalPrompt.format(await this.formatPipelinePrompts(values));
     }
+    /**
+     * Handles partial prompts, which are prompts that have been partially
+     * filled with input values.
+     * @param values Partial input values.
+     * @returns Promise that resolves with a new PipelinePromptTemplate instance with updated input variables.
+     */
     async partial(values) {
         const promptDict = { ...this };
         promptDict.inputVariables = this.inputVariables.filter((iv) => !(iv in values));

package/dist/prompts/pipeline.d.ts

@@ -1,23 +1,58 @@
 import { InputValues, PartialValues } from "../schema/index.js";
 import { BasePromptTemplate, BasePromptTemplateInput } from "./base.js";
 import { SerializedBasePromptTemplate } from "./serde.js";
+/**
+ * Type that includes the name of the prompt and the prompt itself.
+ */
 export type PipelinePromptParams<PromptTemplateType extends BasePromptTemplate> = {
     name: string;
     prompt: PromptTemplateType;
 };
+/**
+ * Type that extends the BasePromptTemplateInput type, excluding the
+ * inputVariables property. It includes an array of pipelinePrompts and a
+ * finalPrompt.
+ */
 export type PipelinePromptTemplateInput<PromptTemplateType extends BasePromptTemplate> = Omit<BasePromptTemplateInput, "inputVariables"> & {
     pipelinePrompts: PipelinePromptParams<PromptTemplateType>[];
     finalPrompt: PromptTemplateType;
 };
+/**
+ * Class that handles a sequence of prompts, each of which may require
+ * different input variables. Includes methods for formatting these
+ * prompts, extracting required input values, and handling partial
+ * prompts.
+ */
 export declare class PipelinePromptTemplate<PromptTemplateType extends BasePromptTemplate> extends BasePromptTemplate {
+    static lc_name(): string;
     pipelinePrompts: PipelinePromptParams<PromptTemplateType>[];
     finalPrompt: PromptTemplateType;
     constructor(input: PipelinePromptTemplateInput<PromptTemplateType>);
+    /**
+     * Computes the input values required by the pipeline prompts.
+     * @returns Array of input values required by the pipeline prompts.
+     */
     protected computeInputValues(): string[];
     protected static extractRequiredInputValues(allValues: InputValues, requiredValueNames: string[]): InputValues;
+    /**
+     * Formats the pipeline prompts based on the provided input values.
+     * @param values Input values to format the pipeline prompts.
+     * @returns Promise that resolves with the formatted input values.
+     */
     protected formatPipelinePrompts(values: InputValues): Promise<InputValues>;
+    /**
+     * Formats the final prompt value based on the provided input values.
+     * @param values Input values to format the final prompt value.
+     * @returns Promise that resolves with the formatted final prompt value.
+     */
     formatPromptValue(values: InputValues): Promise<PromptTemplateType["PromptValueReturnType"]>;
     format(values: InputValues): Promise<string>;
+    /**
+     * Handles partial prompts, which are prompts that have been partially
+     * filled with input values.
+     * @param values Partial input values.
+     * @returns Promise that resolves with a new PipelinePromptTemplate instance with updated input variables.
+     */
     partial(values: PartialValues): Promise<PipelinePromptTemplate<PromptTemplateType>>;
     serialize(): SerializedBasePromptTemplate;
     _getPromptType(): string;

package/dist/prompts/pipeline.js

@@ -1,6 +1,15 @@
 import { BasePromptTemplate } from "./base.js";
 import { ChatPromptTemplate } from "./chat.js";
+/**
+ * Class that handles a sequence of prompts, each of which may require
+ * different input variables. Includes methods for formatting these
+ * prompts, extracting required input values, and handling partial
+ * prompts.
+ */
 export class PipelinePromptTemplate extends BasePromptTemplate {
+    static lc_name() {
+        return "PipelinePromptTemplate";
+    }
     constructor(input) {
         super({ ...input, inputVariables: [] });
         Object.defineProperty(this, "pipelinePrompts", {
@@ -19,6 +28,10 @@ export class PipelinePromptTemplate extends BasePromptTemplate {
         this.finalPrompt = input.finalPrompt;
         this.inputVariables = this.computeInputValues();
     }
+    /**
+     * Computes the input values required by the pipeline prompts.
+     * @returns Array of input values required by the pipeline prompts.
+     */
     computeInputValues() {
         const intermediateValues = this.pipelinePrompts.map((pipelinePrompt) => pipelinePrompt.name);
         const inputValues = this.pipelinePrompts
@@ -33,6 +46,11 @@ export class PipelinePromptTemplate extends BasePromptTemplate {
             return requiredValues;
         }, {});
     }
+    /**
+     * Formats the pipeline prompts based on the provided input values.
+     * @param values Input values to format the pipeline prompts.
+     * @returns Promise that resolves with the formatted input values.
+     */
     async formatPipelinePrompts(values) {
         const allValues = await this.mergePartialAndUserVariables(values);
         for (const { name: pipelinePromptName, prompt: pipelinePrompt } of this
@@ -48,12 +66,23 @@ export class PipelinePromptTemplate extends BasePromptTemplate {
         }
         return PipelinePromptTemplate.extractRequiredInputValues(allValues, this.finalPrompt.inputVariables);
     }
+    /**
+     * Formats the final prompt value based on the provided input values.
+     * @param values Input values to format the final prompt value.
+     * @returns Promise that resolves with the formatted final prompt value.
+     */
     async formatPromptValue(values) {
         return this.finalPrompt.formatPromptValue(await this.formatPipelinePrompts(values));
     }
     async format(values) {
         return this.finalPrompt.format(await this.formatPipelinePrompts(values));
     }
+    /**
+     * Handles partial prompts, which are prompts that have been partially
+     * filled with input values.
+     * @param values Partial input values.
+     * @returns Promise that resolves with a new PipelinePromptTemplate instance with updated input variables.
+     */
     async partial(values) {
         const promptDict = { ...this };
         promptDict.inputVariables = this.inputVariables.filter((iv) => !(iv in values));