langchain 0.0.195 → 0.0.197-rc.0

package/dist/prompts/few_shot.cjs

@@ -1,355 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FewShotChatMessagePromptTemplate = exports.FewShotPromptTemplate = void 0;
-const base_js_1 = require("./base.cjs");
-const template_js_1 = require("./template.cjs");
-const prompt_js_1 = require("./prompt.cjs");
-const chat_js_1 = require("./chat.cjs");
-/**
- * Prompt template that contains few-shot examples.
- * @augments BasePromptTemplate
- * @augments FewShotPromptTemplateInput
- * @example
- * ```typescript
- * const examplePrompt = PromptTemplate.fromTemplate(
- *   "Input: {input}\nOutput: {output}",
- * );
- *
- * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
- *   [
- *     { input: "happy", output: "sad" },
- *     { input: "tall", output: "short" },
- *     { input: "energetic", output: "lethargic" },
- *     { input: "sunny", output: "gloomy" },
- *     { input: "windy", output: "calm" },
- *   ],
- *   new OpenAIEmbeddings(),
- *   HNSWLib,
- *   { k: 1 },
- * );
- *
- * const dynamicPrompt = new FewShotPromptTemplate({
- *   exampleSelector,
- *   examplePrompt,
- *   prefix: "Give the antonym of every input",
- *   suffix: "Input: {adjective}\nOutput:",
- *   inputVariables: ["adjective"],
- * });
- *
- * // Format the dynamic prompt with the input 'rainy'
- * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
- *
- * ```
- */
-class FewShotPromptTemplate extends base_js_1.BaseStringPromptTemplate {
-    constructor(input) {
-        super(input);
-        Object.defineProperty(this, "lc_serializable", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
-        Object.defineProperty(this, "examples", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "exampleSelector", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "examplePrompt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "suffix", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ""
-        });
-        Object.defineProperty(this, "exampleSeparator", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "\n\n"
-        });
-        Object.defineProperty(this, "prefix", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ""
-        });
-        Object.defineProperty(this, "templateFormat", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "f-string"
-        });
-        Object.defineProperty(this, "validateTemplate", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: true
-        });
-        Object.assign(this, input);
-        if (this.examples !== undefined && this.exampleSelector !== undefined) {
-            throw new Error("Only one of 'examples' and 'example_selector' should be provided");
-        }
-        if (this.examples === undefined && this.exampleSelector === undefined) {
-            throw new Error("One of 'examples' and 'example_selector' should be provided");
-        }
-        if (this.validateTemplate) {
-            let totalInputVariables = this.inputVariables;
-            if (this.partialVariables) {
-                totalInputVariables = totalInputVariables.concat(Object.keys(this.partialVariables));
-            }
-            (0, template_js_1.checkValidTemplate)(this.prefix + this.suffix, this.templateFormat, totalInputVariables);
-        }
-    }
-    _getPromptType() {
-        return "few_shot";
-    }
-    static lc_name() {
-        return "FewShotPromptTemplate";
-    }
-    async getExamples(inputVariables) {
-        if (this.examples !== undefined) {
-            return this.examples;
-        }
-        if (this.exampleSelector !== undefined) {
-            return this.exampleSelector.selectExamples(inputVariables);
-        }
-        throw new Error("One of 'examples' and 'example_selector' should be provided");
-    }
-    async partial(values) {
-        const newInputVariables = this.inputVariables.filter((iv) => !(iv in values));
-        const newPartialVariables = {
-            ...(this.partialVariables ?? {}),
-            ...values,
-        };
-        const promptDict = {
-            ...this,
-            inputVariables: newInputVariables,
-            partialVariables: newPartialVariables,
-        };
-        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);
-        const exampleStrings = await Promise.all(examples.map((example) => this.examplePrompt.format(example)));
-        const template = [this.prefix, ...exampleStrings, this.suffix].join(this.exampleSeparator);
-        return (0, template_js_1.renderTemplate)(template, this.templateFormat, allValues);
-    }
-    serialize() {
-        if (this.exampleSelector || !this.examples) {
-            throw new Error("Serializing an example selector is not currently supported");
-        }
-        if (this.outputParser !== undefined) {
-            throw new Error("Serializing an output parser is not currently supported");
-        }
-        return {
-            _type: this._getPromptType(),
-            input_variables: this.inputVariables,
-            example_prompt: this.examplePrompt.serialize(),
-            example_separator: this.exampleSeparator,
-            suffix: this.suffix,
-            prefix: this.prefix,
-            template_format: this.templateFormat,
-            examples: this.examples,
-        };
-    }
-    static async deserialize(data) {
-        const { example_prompt } = data;
-        if (!example_prompt) {
-            throw new Error("Missing example prompt");
-        }
-        const examplePrompt = await prompt_js_1.PromptTemplate.deserialize(example_prompt);
-        let examples;
-        if (Array.isArray(data.examples)) {
-            examples = data.examples;
-        }
-        else {
-            throw new Error("Invalid examples format. Only list or string are supported.");
-        }
-        return new FewShotPromptTemplate({
-            inputVariables: data.input_variables,
-            examplePrompt,
-            examples,
-            exampleSeparator: data.example_separator,
-            prefix: data.prefix,
-            suffix: data.suffix,
-            templateFormat: data.template_format,
-        });
-    }
-}
-exports.FewShotPromptTemplate = FewShotPromptTemplate;
-/**
- * Chat prompt template that contains few-shot examples.
- * @augments BasePromptTemplateInput
- * @augments FewShotChatMessagePromptTemplateInput
- */
-class FewShotChatMessagePromptTemplate extends chat_js_1.BaseChatPromptTemplate {
-    _getPromptType() {
-        return "few_shot_chat";
-    }
-    static lc_name() {
-        return "FewShotChatMessagePromptTemplate";
-    }
-    constructor(fields) {
-        super(fields);
-        Object.defineProperty(this, "lc_serializable", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: true
-        });
-        Object.defineProperty(this, "examples", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "exampleSelector", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "examplePrompt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "suffix", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ""
-        });
-        Object.defineProperty(this, "exampleSeparator", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "\n\n"
-        });
-        Object.defineProperty(this, "prefix", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: ""
-        });
-        Object.defineProperty(this, "templateFormat", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: "f-string"
-        });
-        Object.defineProperty(this, "validateTemplate", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: true
-        });
-        this.examples = fields.examples;
-        this.examplePrompt = fields.examplePrompt;
-        this.exampleSeparator = fields.exampleSeparator ?? "\n\n";
-        this.exampleSelector = fields.exampleSelector;
-        this.prefix = fields.prefix ?? "";
-        this.suffix = fields.suffix ?? "";
-        this.templateFormat = fields.templateFormat ?? "f-string";
-        this.validateTemplate = fields.validateTemplate ?? true;
-        if (this.examples !== undefined && this.exampleSelector !== undefined) {
-            throw new Error("Only one of 'examples' and 'example_selector' should be provided");
-        }
-        if (this.examples === undefined && this.exampleSelector === undefined) {
-            throw new Error("One of 'examples' and 'example_selector' should be provided");
-        }
-        if (this.validateTemplate) {
-            let totalInputVariables = this.inputVariables;
-            if (this.partialVariables) {
-                totalInputVariables = totalInputVariables.concat(Object.keys(this.partialVariables));
-            }
-            (0, template_js_1.checkValidTemplate)(this.prefix + this.suffix, this.templateFormat, totalInputVariables);
-        }
-    }
-    async getExamples(inputVariables) {
-        if (this.examples !== undefined) {
-            return this.examples;
-        }
-        if (this.exampleSelector !== undefined) {
-            return this.exampleSelector.selectExamples(inputVariables);
-        }
-        throw new Error("One of 'examples' and 'example_selector' should be provided");
-    }
-    /**
-     * Formats the list of values and returns a list of formatted messages.
-     * @param values The values to format the prompt with.
-     * @returns A promise that resolves to a string representing the formatted prompt.
-     */
-    async formatMessages(values) {
-        const allValues = await this.mergePartialAndUserVariables(values);
-        let examples = await this.getExamples(allValues);
-        examples = examples.map((example) => {
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            const result = {};
-            this.examplePrompt.inputVariables.forEach((inputVariable) => {
-                result[inputVariable] = example[inputVariable];
-            });
-            return result;
-        });
-        const messages = [];
-        for (const example of examples) {
-            const exampleMessages = await this.examplePrompt.formatMessages(example);
-            messages.push(...exampleMessages);
-        }
-        return messages;
-    }
-    /**
-     * 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);
-        const exampleMessages = await Promise.all(examples.map((example) => this.examplePrompt.formatMessages(example)));
-        const exampleStrings = exampleMessages
-            .flat()
-            .map((message) => message.content);
-        const template = [this.prefix, ...exampleStrings, this.suffix].join(this.exampleSeparator);
-        return (0, template_js_1.renderTemplate)(template, this.templateFormat, allValues);
-    }
-    /**
-     * Partially formats the prompt with the given values.
-     * @param values The values to partially format the prompt with.
-     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
-     */
-    async partial(values) {
-        const newInputVariables = this.inputVariables.filter((variable) => !(variable in values));
-        const newPartialVariables = {
-            ...(this.partialVariables ?? {}),
-            ...values,
-        };
-        const promptDict = {
-            ...this,
-            inputVariables: newInputVariables,
-            partialVariables: newPartialVariables,
-        };
-        return new FewShotChatMessagePromptTemplate(promptDict);
-    }
-}
-exports.FewShotChatMessagePromptTemplate = FewShotChatMessagePromptTemplate;
+var prompts_1 = require("langchain-core/prompts");
+Object.defineProperty(exports, "FewShotPromptTemplate", { enumerable: true, get: function () { return prompts_1.FewShotPromptTemplate; } });
+Object.defineProperty(exports, "FewShotChatMessagePromptTemplate", { enumerable: true, get: function () { return prompts_1.FewShotChatMessagePromptTemplate; } });

package/dist/prompts/few_shot.d.ts

@@ -1,192 +1 @@
-import { BaseStringPromptTemplate, BasePromptTemplateInput, BaseExampleSelector, TypedPromptInputValues } from "./base.js";
-import { TemplateFormat } from "./template.js";
-import { PromptTemplate } from "./prompt.js";
-import { SerializedFewShotTemplate } from "./serde.js";
-import { BaseMessage, Example, InputValues, PartialValues } from "../schema/index.js";
-import { BaseChatPromptTemplate, BaseMessagePromptTemplate } from "./chat.js";
-export interface FewShotPromptTemplateInput extends BasePromptTemplateInput<InputValues> {
-    /**
-     * Examples to format into the prompt. Exactly one of this or
-     * {@link exampleSelector} must be
-     * provided.
-     */
-    examples?: Example[];
-    /**
-     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
-     * {@link examples} must be
-     * provided.
-     */
-    exampleSelector?: BaseExampleSelector;
-    /**
-     * An {@link PromptTemplate} used to format a single example.
-     */
-    examplePrompt: PromptTemplate;
-    /**
-     * String separator used to join the prefix, the examples, and suffix.
-     */
-    exampleSeparator?: string;
-    /**
-     * A prompt template string to put before the examples.
-     *
-     * @defaultValue `""`
-     */
-    prefix?: string;
-    /**
-     * A prompt template string to put after the examples.
-     */
-    suffix?: string;
-    /**
-     * The format of the prompt template. Options are: 'f-string'
-     */
-    templateFormat?: TemplateFormat;
-    /**
-     * Whether or not to try validating the template on initialization.
-     */
-    validateTemplate?: boolean;
-}
-/**
- * Prompt template that contains few-shot examples.
- * @augments BasePromptTemplate
- * @augments FewShotPromptTemplateInput
- * @example
- * ```typescript
- * const examplePrompt = PromptTemplate.fromTemplate(
- *   "Input: {input}\nOutput: {output}",
- * );
- *
- * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(
- *   [
- *     { input: "happy", output: "sad" },
- *     { input: "tall", output: "short" },
- *     { input: "energetic", output: "lethargic" },
- *     { input: "sunny", output: "gloomy" },
- *     { input: "windy", output: "calm" },
- *   ],
- *   new OpenAIEmbeddings(),
- *   HNSWLib,
- *   { k: 1 },
- * );
- *
- * const dynamicPrompt = new FewShotPromptTemplate({
- *   exampleSelector,
- *   examplePrompt,
- *   prefix: "Give the antonym of every input",
- *   suffix: "Input: {adjective}\nOutput:",
- *   inputVariables: ["adjective"],
- * });
- *
- * // Format the dynamic prompt with the input 'rainy'
- * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
- *
- * ```
- */
-export declare class FewShotPromptTemplate extends BaseStringPromptTemplate implements FewShotPromptTemplateInput {
-    lc_serializable: boolean;
-    examples?: InputValues[];
-    exampleSelector?: BaseExampleSelector | undefined;
-    examplePrompt: PromptTemplate;
-    suffix: string;
-    exampleSeparator: string;
-    prefix: string;
-    templateFormat: TemplateFormat;
-    validateTemplate: boolean;
-    constructor(input: FewShotPromptTemplateInput);
-    _getPromptType(): "few_shot";
-    static lc_name(): string;
-    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>;
-}
-export interface FewShotChatMessagePromptTemplateInput extends BasePromptTemplateInput<InputValues> {
-    /**
-     * Examples to format into the prompt. Exactly one of this or
-     * {@link exampleSelector} must be
-     * provided.
-     */
-    examples?: Example[];
-    /**
-     * An {@link BaseMessagePromptTemplate} | {@link BaseChatPromptTemplate} used to format a single example.
-     */
-    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
-    /**
-     * String separator used to join the prefix, the examples, and suffix.
-     *
-     * @defaultValue `"\n\n"`
-     */
-    exampleSeparator?: string;
-    /**
-     * An {@link BaseExampleSelector} Examples to format into the prompt. Exactly one of this or
-     * {@link examples} must be
-     * provided.
-     */
-    exampleSelector?: BaseExampleSelector | undefined;
-    /**
-     * A prompt template string to put before the examples.
-     *
-     * @defaultValue `""`
-     */
-    prefix?: string;
-    /**
-     * A prompt template string to put after the examples.
-     *
-     * @defaultValue `""`
-     */
-    suffix?: string;
-    /**
-     * The format of the prompt template. Options are: 'f-string'
-     *
-     * @defaultValue `f-string`
-     */
-    templateFormat?: TemplateFormat;
-    /**
-     * Whether or not to try validating the template on initialization.
-     *
-     * @defaultValue `true`
-     */
-    validateTemplate?: boolean;
-}
-/**
- * Chat prompt template that contains few-shot examples.
- * @augments BasePromptTemplateInput
- * @augments FewShotChatMessagePromptTemplateInput
- */
-export declare class FewShotChatMessagePromptTemplate<RunInput extends InputValues = any, PartialVariableName extends string = any> extends BaseChatPromptTemplate implements FewShotChatMessagePromptTemplateInput {
-    lc_serializable: boolean;
-    examples?: InputValues[];
-    exampleSelector?: BaseExampleSelector | undefined;
-    examplePrompt: BaseMessagePromptTemplate | BaseChatPromptTemplate;
-    suffix: string;
-    exampleSeparator: string;
-    prefix: string;
-    templateFormat: TemplateFormat;
-    validateTemplate: boolean;
-    _getPromptType(): "few_shot_chat";
-    static lc_name(): string;
-    constructor(fields: FewShotChatMessagePromptTemplateInput);
-    private getExamples;
-    /**
-     * Formats the list of values and returns a list of formatted messages.
-     * @param values The values to format the prompt with.
-     * @returns A promise that resolves to a string representing the formatted prompt.
-     */
-    formatMessages(values: TypedPromptInputValues<RunInput>): Promise<BaseMessage[]>;
-    /**
-     * 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: TypedPromptInputValues<RunInput>): Promise<string>;
-    /**
-     * Partially formats the prompt with the given values.
-     * @param values The values to partially format the prompt with.
-     * @returns A promise that resolves to an instance of `FewShotChatMessagePromptTemplate` with the given values partially formatted.
-     */
-    partial(values: PartialValues<PartialVariableName>): Promise<FewShotChatMessagePromptTemplate<RunInput, PartialVariableName>>;
-}
+export { type FewShotPromptTemplateInput, FewShotPromptTemplate, type FewShotChatMessagePromptTemplateInput, FewShotChatMessagePromptTemplate, } from "langchain-core/prompts";