langchain 0.0.195 → 0.0.197-rc.0

package/dist/prompts/selectors/LengthBasedExampleSelector.d.ts

@@ -1,89 +1 @@
-import { Example } from "../../schema/index.js";
-import { BaseExampleSelector } from "../base.js";
-import { PromptTemplate } from "../prompt.js";
-/**
- * Interface for the input parameters of the LengthBasedExampleSelector
- * class.
- */
-export interface LengthBasedExampleSelectorInput {
-    examplePrompt: PromptTemplate;
-    maxLength?: number;
-    getTextLength?: (text: string) => number;
-}
-/**
- * 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.
- * @example
- * ```typescript
- * const exampleSelector = new LengthBasedExampleSelector(
- *   [
- *     { input: "happy", output: "sad" },
- *     { input: "tall", output: "short" },
- *     { input: "energetic", output: "lethargic" },
- *     { input: "sunny", output: "gloomy" },
- *     { input: "windy", output: "calm" },
- *   ],
- *   {
- *     examplePrompt: new PromptTemplate({
- *       inputVariables: ["input", "output"],
- *       template: "Input: {input}\nOutput: {output}",
- *     }),
- *     maxLength: 25,
- *   },
- * );
- * const dynamicPrompt = new FewShotPromptTemplate({
- *   exampleSelector,
- *   examplePrompt: new PromptTemplate({
- *     inputVariables: ["input", "output"],
- *     template: "Input: {input}\nOutput: {output}",
- *   }),
- *   prefix: "Give the antonym of every input",
- *   suffix: "Input: {adjective}\nOutput:",
- *   inputVariables: ["adjective"],
- * });
- * console.log(dynamicPrompt.format({ adjective: "big" }));
- * console.log(
- *   dynamicPrompt.format({
- *     adjective:
- *       "big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else",
- *   }),
- * );
- * ```
- */
-export declare class LengthBasedExampleSelector extends BaseExampleSelector {
-    protected examples: Example[];
-    examplePrompt: PromptTemplate;
-    getTextLength: (text: string) => number;
-    maxLength: number;
-    exampleTextLengths: number[];
-    constructor(data: LengthBasedExampleSelectorInput);
-    /**
-     * 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.
-     */
-    addExample(example: Example): Promise<void>;
-    /**
-     * 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.
-     */
-    calculateExampleTextLengths(v: number[], values: LengthBasedExampleSelector): Promise<number[]>;
-    /**
-     * 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.
-     */
-    selectExamples(inputVariables: Example): Promise<Example[]>;
-    /**
-     * 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 fromExamples(examples: Example[], args: LengthBasedExampleSelectorInput): Promise<LengthBasedExampleSelector>;
-}
+export { type LengthBasedExampleSelectorInput, LengthBasedExampleSelector, } from "langchain-core/example_selectors";

package/dist/prompts/selectors/LengthBasedExampleSelector.js

@@ -1,146 +1 @@
-import { BaseExampleSelector } from "../base.js";
-/**
- * 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.
- * @example
- * ```typescript
- * const exampleSelector = new LengthBasedExampleSelector(
- *   [
- *     { input: "happy", output: "sad" },
- *     { input: "tall", output: "short" },
- *     { input: "energetic", output: "lethargic" },
- *     { input: "sunny", output: "gloomy" },
- *     { input: "windy", output: "calm" },
- *   ],
- *   {
- *     examplePrompt: new PromptTemplate({
- *       inputVariables: ["input", "output"],
- *       template: "Input: {input}\nOutput: {output}",
- *     }),
- *     maxLength: 25,
- *   },
- * );
- * const dynamicPrompt = new FewShotPromptTemplate({
- *   exampleSelector,
- *   examplePrompt: new PromptTemplate({
- *     inputVariables: ["input", "output"],
- *     template: "Input: {input}\nOutput: {output}",
- *   }),
- *   prefix: "Give the antonym of every input",
- *   suffix: "Input: {adjective}\nOutput:",
- *   inputVariables: ["adjective"],
- * });
- * console.log(dynamicPrompt.format({ adjective: "big" }));
- * console.log(
- *   dynamicPrompt.format({
- *     adjective:
- *       "big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else",
- *   }),
- * );
- * ```
- */
-export class LengthBasedExampleSelector extends BaseExampleSelector {
-    constructor(data) {
-        super(data);
-        Object.defineProperty(this, "examples", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-        Object.defineProperty(this, "examplePrompt", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "getTextLength", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: getLengthBased
-        });
-        Object.defineProperty(this, "maxLength", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: 2048
-        });
-        Object.defineProperty(this, "exampleTextLengths", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-        this.examplePrompt = data.examplePrompt;
-        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;
-        }
-        const { examples, examplePrompt } = values;
-        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);
-        let i = 0;
-        const examples = [];
-        while (remainingLength > 0 && i < this.examples.length) {
-            const newLength = remainingLength - this.exampleTextLengths[i];
-            if (newLength < 0) {
-                break;
-            }
-            else {
-                examples.push(this.examples[i]);
-                remainingLength = newLength;
-            }
-            i += 1;
-        }
-        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)));
-        return selector;
-    }
-}
+export { LengthBasedExampleSelector, } from "langchain-core/example_selectors";

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.cjs

@@ -1,139 +1,17 @@
 "use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SemanticSimilarityExampleSelector = void 0;
-const document_js_1 = require("../../document.cjs");
-const base_js_1 = require("../base.cjs");
-function sortedValues(values) {
-    return Object.keys(values)
-        .sort()
-        .map((key) => values[key]);
-}
-/**
- * Class that selects examples based on semantic similarity. It extends
- * the BaseExampleSelector class.
- * @example
- * ```typescript
- * 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: PromptTemplate.fromTemplate(
- *     "Input: {input}\nOutput: {output}",
- *   ),
- *   prefix: "Give the antonym of every input",
- *   suffix: "Input: {adjective}\nOutput:",
- *   inputVariables: ["adjective"],
- * });
- * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
- * ```
- */
-class SemanticSimilarityExampleSelector extends base_js_1.BaseExampleSelector {
-    constructor(data) {
-        super(data);
-        Object.defineProperty(this, "vectorStoreRetriever", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "exampleKeys", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "inputKeys", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.exampleKeys = data.exampleKeys;
-        this.inputKeys = data.inputKeys;
-        if (data.vectorStore !== undefined) {
-            this.vectorStoreRetriever = data.vectorStore.asRetriever({
-                k: data.k ?? 4,
-                filter: data.filter,
-            });
-        }
-        else if (data.vectorStoreRetriever) {
-            this.vectorStoreRetriever = data.vectorStoreRetriever;
-        }
-        else {
-            throw new Error(`You must specify one of "vectorStore" and "vectorStoreRetriever".`);
-        }
-    }
-    /**
-     * Method that adds a new example to the vectorStore. The example is
-     * converted to a string and added to the vectorStore as a document.
-     * @param example The example to be added to the vectorStore.
-     * @returns Promise that resolves when the example has been added to the vectorStore.
-     */
-    async addExample(example) {
-        const inputKeys = this.inputKeys ?? Object.keys(example);
-        const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
-        await this.vectorStoreRetriever.addDocuments([
-            new document_js_1.Document({
-                pageContent: stringExample,
-                metadata: example,
-            }),
-        ]);
-    }
-    /**
-     * Method that selects which examples to use based on semantic similarity.
-     * It performs a similarity search in the vectorStore using the input
-     * variables and returns the examples with the highest similarity.
-     * @param inputVariables The input variables used for the similarity search.
-     * @returns Promise that resolves with an array of the selected examples.
-     */
-    async selectExamples(inputVariables) {
-        const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
-        const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
-        const exampleDocs = await this.vectorStoreRetriever.invoke(query);
-        const examples = exampleDocs.map((doc) => doc.metadata);
-        if (this.exampleKeys) {
-            // If example keys are provided, filter examples to those keys.
-            return examples.map((example) => this.exampleKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {}));
-        }
-        return examples;
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
     }
-    /**
-     * Static method that creates a new instance of
-     * SemanticSimilarityExampleSelector. It takes a list of examples, an
-     * instance of Embeddings, a VectorStore class, and an options object as
-     * parameters. It converts the examples to strings, creates a VectorStore
-     * from the strings and the embeddings, and returns a new
-     * SemanticSimilarityExampleSelector with the created VectorStore and the
-     * options provided.
-     * @param examples The list of examples to be used.
-     * @param embeddings The instance of Embeddings to be used.
-     * @param vectorStoreCls The VectorStore class to be used.
-     * @param options The options object for the SemanticSimilarityExampleSelector.
-     * @returns Promise that resolves with a new instance of SemanticSimilarityExampleSelector.
-     */
-    static async fromExamples(examples, embeddings, vectorStoreCls, options = {}) {
-        const inputKeys = options.inputKeys ?? null;
-        const stringExamples = examples.map((example) => sortedValues(inputKeys
-            ? inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})
-            : example).join(" "));
-        const vectorStore = await vectorStoreCls.fromTexts(stringExamples, examples, // metadatas
-        embeddings, options);
-        return new SemanticSimilarityExampleSelector({
-            vectorStore,
-            k: options.k ?? 4,
-            exampleKeys: options.exampleKeys,
-            inputKeys: options.inputKeys,
-        });
-    }
-}
-exports.SemanticSimilarityExampleSelector = SemanticSimilarityExampleSelector;
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("langchain-core/example_selectors"), exports);

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.d.ts

@@ -1,91 +1 @@
-import { Embeddings } from "../../embeddings/base.js";
-import { VectorStore, VectorStoreRetriever } from "../../vectorstores/base.js";
-import { Example } from "../../schema/index.js";
-import { BaseExampleSelector } from "../base.js";
-/**
- * Interface for the input data of the SemanticSimilarityExampleSelector
- * class.
- */
-export type SemanticSimilarityExampleSelectorInput<V extends VectorStore = VectorStore> = {
-    vectorStore: V;
-    k?: number;
-    filter?: V["FilterType"];
-    exampleKeys?: string[];
-    inputKeys?: string[];
-    vectorStoreRetriever?: never;
-} | {
-    vectorStoreRetriever: VectorStoreRetriever<V>;
-    exampleKeys?: string[];
-    inputKeys?: string[];
-    vectorStore?: never;
-    k?: never;
-    filter?: never;
-};
-/**
- * Class that selects examples based on semantic similarity. It extends
- * the BaseExampleSelector class.
- * @example
- * ```typescript
- * 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: PromptTemplate.fromTemplate(
- *     "Input: {input}\nOutput: {output}",
- *   ),
- *   prefix: "Give the antonym of every input",
- *   suffix: "Input: {adjective}\nOutput:",
- *   inputVariables: ["adjective"],
- * });
- * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
- * ```
- */
-export declare class SemanticSimilarityExampleSelector<V extends VectorStore = VectorStore> extends BaseExampleSelector {
-    vectorStoreRetriever: VectorStoreRetriever<V>;
-    exampleKeys?: string[];
-    inputKeys?: string[];
-    constructor(data: SemanticSimilarityExampleSelectorInput<V>);
-    /**
-     * Method that adds a new example to the vectorStore. The example is
-     * converted to a string and added to the vectorStore as a document.
-     * @param example The example to be added to the vectorStore.
-     * @returns Promise that resolves when the example has been added to the vectorStore.
-     */
-    addExample(example: Example): Promise<void>;
-    /**
-     * Method that selects which examples to use based on semantic similarity.
-     * It performs a similarity search in the vectorStore using the input
-     * variables and returns the examples with the highest similarity.
-     * @param inputVariables The input variables used for the similarity search.
-     * @returns Promise that resolves with an array of the selected examples.
-     */
-    selectExamples<T>(inputVariables: Record<string, T>): Promise<Example[]>;
-    /**
-     * Static method that creates a new instance of
-     * SemanticSimilarityExampleSelector. It takes a list of examples, an
-     * instance of Embeddings, a VectorStore class, and an options object as
-     * parameters. It converts the examples to strings, creates a VectorStore
-     * from the strings and the embeddings, and returns a new
-     * SemanticSimilarityExampleSelector with the created VectorStore and the
-     * options provided.
-     * @param examples The list of examples to be used.
-     * @param embeddings The instance of Embeddings to be used.
-     * @param vectorStoreCls The VectorStore class to be used.
-     * @param options The options object for the SemanticSimilarityExampleSelector.
-     * @returns Promise that resolves with a new instance of SemanticSimilarityExampleSelector.
-     */
-    static fromExamples<C extends typeof VectorStore>(examples: Record<string, string>[], embeddings: Embeddings, vectorStoreCls: C, options?: {
-        k?: number;
-        inputKeys?: string[];
-    } & Parameters<C["fromTexts"]>[3]): Promise<SemanticSimilarityExampleSelector>;
-}
+export * from "langchain-core/example_selectors";

package/dist/prompts/selectors/SemanticSimilarityExampleSelector.js

@@ -1,135 +1 @@
-import { Document } from "../../document.js";
-import { BaseExampleSelector } from "../base.js";
-function sortedValues(values) {
-    return Object.keys(values)
-        .sort()
-        .map((key) => values[key]);
-}
-/**
- * Class that selects examples based on semantic similarity. It extends
- * the BaseExampleSelector class.
- * @example
- * ```typescript
- * 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: PromptTemplate.fromTemplate(
- *     "Input: {input}\nOutput: {output}",
- *   ),
- *   prefix: "Give the antonym of every input",
- *   suffix: "Input: {adjective}\nOutput:",
- *   inputVariables: ["adjective"],
- * });
- * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
- * ```
- */
-export class SemanticSimilarityExampleSelector extends BaseExampleSelector {
-    constructor(data) {
-        super(data);
-        Object.defineProperty(this, "vectorStoreRetriever", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "exampleKeys", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "inputKeys", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.exampleKeys = data.exampleKeys;
-        this.inputKeys = data.inputKeys;
-        if (data.vectorStore !== undefined) {
-            this.vectorStoreRetriever = data.vectorStore.asRetriever({
-                k: data.k ?? 4,
-                filter: data.filter,
-            });
-        }
-        else if (data.vectorStoreRetriever) {
-            this.vectorStoreRetriever = data.vectorStoreRetriever;
-        }
-        else {
-            throw new Error(`You must specify one of "vectorStore" and "vectorStoreRetriever".`);
-        }
-    }
-    /**
-     * Method that adds a new example to the vectorStore. The example is
-     * converted to a string and added to the vectorStore as a document.
-     * @param example The example to be added to the vectorStore.
-     * @returns Promise that resolves when the example has been added to the vectorStore.
-     */
-    async addExample(example) {
-        const inputKeys = this.inputKeys ?? Object.keys(example);
-        const stringExample = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})).join(" ");
-        await this.vectorStoreRetriever.addDocuments([
-            new Document({
-                pageContent: stringExample,
-                metadata: example,
-            }),
-        ]);
-    }
-    /**
-     * Method that selects which examples to use based on semantic similarity.
-     * It performs a similarity search in the vectorStore using the input
-     * variables and returns the examples with the highest similarity.
-     * @param inputVariables The input variables used for the similarity search.
-     * @returns Promise that resolves with an array of the selected examples.
-     */
-    async selectExamples(inputVariables) {
-        const inputKeys = this.inputKeys ?? Object.keys(inputVariables);
-        const query = sortedValues(inputKeys.reduce((acc, key) => ({ ...acc, [key]: inputVariables[key] }), {})).join(" ");
-        const exampleDocs = await this.vectorStoreRetriever.invoke(query);
-        const examples = exampleDocs.map((doc) => doc.metadata);
-        if (this.exampleKeys) {
-            // If example keys are provided, filter examples to those keys.
-            return examples.map((example) => this.exampleKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {}));
-        }
-        return examples;
-    }
-    /**
-     * Static method that creates a new instance of
-     * SemanticSimilarityExampleSelector. It takes a list of examples, an
-     * instance of Embeddings, a VectorStore class, and an options object as
-     * parameters. It converts the examples to strings, creates a VectorStore
-     * from the strings and the embeddings, and returns a new
-     * SemanticSimilarityExampleSelector with the created VectorStore and the
-     * options provided.
-     * @param examples The list of examples to be used.
-     * @param embeddings The instance of Embeddings to be used.
-     * @param vectorStoreCls The VectorStore class to be used.
-     * @param options The options object for the SemanticSimilarityExampleSelector.
-     * @returns Promise that resolves with a new instance of SemanticSimilarityExampleSelector.
-     */
-    static async fromExamples(examples, embeddings, vectorStoreCls, options = {}) {
-        const inputKeys = options.inputKeys ?? null;
-        const stringExamples = examples.map((example) => sortedValues(inputKeys
-            ? inputKeys.reduce((acc, key) => ({ ...acc, [key]: example[key] }), {})
-            : example).join(" "));
-        const vectorStore = await vectorStoreCls.fromTexts(stringExamples, examples, // metadatas
-        embeddings, options);
-        return new SemanticSimilarityExampleSelector({
-            vectorStore,
-            k: options.k ?? 4,
-            exampleKeys: options.exampleKeys,
-            inputKeys: options.inputKeys,
-        });
-    }
-}
+export * from "langchain-core/example_selectors";