langchain 0.0.131 → 0.0.132

package/dist/prompts/chat.d.ts

@@ -2,16 +2,40 @@ 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;
@@ -22,9 +46,16 @@ export declare class ChatPromptValue extends BasePromptValue {
     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>;
@@ -33,9 +64,16 @@ export declare class MessagesPlaceholder<RunInput extends InputValues = any> ext
     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>>>);
@@ -44,15 +82,26 @@ 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;
@@ -61,21 +110,36 @@ export declare class ChatMessagePromptTemplate<RunInput extends InputValues = an
     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
@@ -88,6 +152,11 @@ 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(): {

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,10 +25,20 @@ 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";
@@ -61,6 +76,10 @@ 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";
@@ -86,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)) {
@@ -108,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);
@@ -120,6 +147,10 @@ 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";
@@ -145,6 +176,10 @@ 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";
@@ -156,6 +191,10 @@ 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";
@@ -167,6 +206,10 @@ 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";
@@ -178,6 +221,11 @@ 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";

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,6 +3,12 @@ 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";
@@ -25,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
@@ -39,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
@@ -54,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,24 +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,5 +1,11 @@
 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";
@@ -22,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
@@ -36,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
@@ -51,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));

package/dist/prompts/prompt.cjs

@@ -56,6 +56,11 @@ class PromptTemplate extends base_js_1.BaseStringPromptTemplate {
     _getPromptType() {
         return "prompt";
     }
+    /**
+     * Formats the prompt template with the provided values.
+     * @param values The values to be used to format the prompt template.
+     * @returns A promise that resolves to a string which is the formatted prompt.
+     */
     async format(values) {
         const allValues = await this.mergePartialAndUserVariables(values);
         return (0, template_js_1.renderTemplate)(this.template, this.templateFormat, allValues);
@@ -98,6 +103,11 @@ class PromptTemplate extends base_js_1.BaseStringPromptTemplate {
             ...rest,
         });
     }
+    /**
+     * Partially applies values to the prompt template.
+     * @param values The values to be partially applied to the prompt template.
+     * @returns A new instance of PromptTemplate with the partially applied values.
+     */
     async partial(values) {
         const newInputVariables = this.inputVariables.filter((iv) => !(iv in values));
         const newPartialVariables = {

package/dist/prompts/prompt.d.ts

@@ -46,6 +46,11 @@ export declare class PromptTemplate<RunInput extends InputValues = any, PartialV
     validateTemplate: boolean;
     constructor(input: PromptTemplateInput<RunInput, PartialVariableName>);
     _getPromptType(): "prompt";
+    /**
+     * Formats the prompt template with the provided values.
+     * @param values The values to be used to format the prompt template.
+     * @returns A promise that resolves to a string which is the formatted prompt.
+     */
     format(values: TypedPromptInputValues<RunInput>): Promise<string>;
     /**
      * Take examples in list format with prefix and suffix to create a prompt.
@@ -65,6 +70,11 @@ export declare class PromptTemplate<RunInput extends InputValues = any, PartialV
      * Load prompt template from a template f-string
      */
     static fromTemplate<RunInput extends InputValues = any>(template: string, { templateFormat, ...rest }?: Omit<PromptTemplateInput, "template" | "inputVariables">): PromptTemplate<RunInput, any>;
+    /**
+     * Partially applies values to the prompt template.
+     * @param values The values to be partially applied to the prompt template.
+     * @returns A new instance of PromptTemplate with the partially applied values.
+     */
     partial<NewPartialVariableName extends string>(values: PartialValues<NewPartialVariableName>): Promise<PromptTemplate<InputValues<Exclude<Extract<keyof RunInput, string>, NewPartialVariableName>>, any>>;
     serialize(): SerializedPromptTemplate;
     static deserialize(data: SerializedPromptTemplate): Promise<PromptTemplate>;

package/dist/prompts/prompt.js

@@ -53,6 +53,11 @@ export class PromptTemplate extends BaseStringPromptTemplate {
     _getPromptType() {
         return "prompt";
     }
+    /**
+     * Formats the prompt template with the provided values.
+     * @param values The values to be used to format the prompt template.
+     * @returns A promise that resolves to a string which is the formatted prompt.
+     */
     async format(values) {
         const allValues = await this.mergePartialAndUserVariables(values);
         return renderTemplate(this.template, this.templateFormat, allValues);
@@ -95,6 +100,11 @@ export class PromptTemplate extends BaseStringPromptTemplate {
             ...rest,
         });
     }
+    /**
+     * Partially applies values to the prompt template.
+     * @param values The values to be partially applied to the prompt template.
+     * @returns A new instance of PromptTemplate with the partially applied values.
+     */
     async partial(values) {
         const newInputVariables = this.inputVariables.filter((iv) => !(iv in values));
         const newPartialVariables = {

package/dist/prompts/selectors/LengthBasedExampleSelector.cjs

@@ -2,9 +2,17 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.LengthBasedExampleSelector = void 0;
 const base_js_1 = require("../base.cjs");
+/**
+ * Calculates the length of a text based on the number of words and lines.
+ */
 function getLengthBased(text) {
     return text.split(/\n| /).length;
 }
+/**
+ * A specialized example selector that selects examples based on their
+ * length, ensuring that the total length of the selected examples does
+ * not exceed a specified maximum length.
+ */
 class LengthBasedExampleSelector extends base_js_1.BaseExampleSelector {
     constructor(data) {
         super(data);
@@ -42,11 +50,22 @@ class LengthBasedExampleSelector extends base_js_1.BaseExampleSelector {
         this.maxLength = data.maxLength ?? 2048;
         this.getTextLength = data.getTextLength ?? getLengthBased;
     }
+    /**
+     * Adds an example to the list of examples and calculates its length.
+     * @param example The example to be added.
+     * @returns Promise that resolves when the example has been added and its length calculated.
+     */
     async addExample(example) {
         this.examples.push(example);
         const stringExample = await this.examplePrompt.format(example);
         this.exampleTextLengths.push(this.getTextLength(stringExample));
     }
+    /**
+     * Calculates the lengths of the examples.
+     * @param v Array of lengths of the examples.
+     * @param values Instance of LengthBasedExampleSelector.
+     * @returns Promise that resolves with an array of lengths of the examples.
+     */
     async calculateExampleTextLengths(v, values) {
         if (v.length > 0) {
             return v;
@@ -55,6 +74,12 @@ class LengthBasedExampleSelector extends base_js_1.BaseExampleSelector {
         const stringExamples = await Promise.all(examples.map((eg) => examplePrompt.format(eg)));
         return stringExamples.map((eg) => this.getTextLength(eg));
     }
+    /**
+     * Selects examples until the total length of the selected examples
+     * reaches the maxLength.
+     * @param inputVariables The input variables for the examples.
+     * @returns Promise that resolves with an array of selected examples.
+     */
     async selectExamples(inputVariables) {
         const inputs = Object.values(inputVariables).join(" ");
         let remainingLength = this.maxLength - this.getTextLength(inputs);
@@ -73,6 +98,13 @@ class LengthBasedExampleSelector extends base_js_1.BaseExampleSelector {
         }
         return examples;
     }
+    /**
+     * Creates a new instance of LengthBasedExampleSelector and adds a list of
+     * examples to it.
+     * @param examples Array of examples to be added.
+     * @param args Input parameters for the LengthBasedExampleSelector.
+     * @returns Promise that resolves with a new instance of LengthBasedExampleSelector with the examples added.
+     */
     static async fromExamples(examples, args) {
         const selector = new LengthBasedExampleSelector(args);
         await Promise.all(examples.map((eg) => selector.addExample(eg)));