@langchain/core 0.3.72 → 1.0.0-alpha.2

package/dist/example_selectors/length_based.js

@@ -1,146 +1,123 @@
 import { BaseExampleSelector } from "./base.js";
+
+//#region src/example_selectors/length_based.ts
 /**
- * Calculates the length of a text based on the number of words and lines.
- */
+* Calculates the length of a text based on the number of words and lines.
+*/
 function getLengthBased(text) {
-    return text.split(/\n| /).length;
+	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;
-    }
-}
+* 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",
+*   }),
+* );
+* ```
+*/
+var LengthBasedExampleSelector = class LengthBasedExampleSelector extends BaseExampleSelector {
+	examples = [];
+	examplePrompt;
+	getTextLength = getLengthBased;
+	maxLength = 2048;
+	exampleTextLengths = [];
+	constructor(data) {
+		super(data);
+		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;
+	}
+};
+
+//#endregion
+export { LengthBasedExampleSelector };
+//# sourceMappingURL=length_based.js.map

package/dist/example_selectors/length_based.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"length_based.js","names":["text: string","data: LengthBasedExampleSelectorInput","example: Example","v: number[]","values: LengthBasedExampleSelector","eg: Example","eg: string","inputVariables: Example","examples: Example[]","args: LengthBasedExampleSelectorInput"],"sources":["../../src/example_selectors/length_based.ts"],"sourcesContent":["import { Example } from \"../prompts/base.js\";\nimport { BaseExampleSelector } from \"./base.js\";\nimport { PromptTemplate } from \"../prompts/prompt.js\";\n\n/**\n * Calculates the length of a text based on the number of words and lines.\n */\nfunction getLengthBased(text: string): number {\n  return text.split(/\\n| /).length;\n}\n\n/**\n * Interface for the input parameters of the LengthBasedExampleSelector\n * class.\n */\nexport interface LengthBasedExampleSelectorInput {\n  examplePrompt: PromptTemplate;\n  maxLength?: number;\n  getTextLength?: (text: string) => number;\n}\n\n/**\n * A specialized example selector that selects examples based on their\n * length, ensuring that the total length of the selected examples does\n * not exceed a specified maximum length.\n * @example\n * ```typescript\n * const exampleSelector = new LengthBasedExampleSelector(\n *   [\n *     { input: \"happy\", output: \"sad\" },\n *     { input: \"tall\", output: \"short\" },\n *     { input: \"energetic\", output: \"lethargic\" },\n *     { input: \"sunny\", output: \"gloomy\" },\n *     { input: \"windy\", output: \"calm\" },\n *   ],\n *   {\n *     examplePrompt: new PromptTemplate({\n *       inputVariables: [\"input\", \"output\"],\n *       template: \"Input: {input}\\nOutput: {output}\",\n *     }),\n *     maxLength: 25,\n *   },\n * );\n * const dynamicPrompt = new FewShotPromptTemplate({\n *   exampleSelector,\n *   examplePrompt: new PromptTemplate({\n *     inputVariables: [\"input\", \"output\"],\n *     template: \"Input: {input}\\nOutput: {output}\",\n *   }),\n *   prefix: \"Give the antonym of every input\",\n *   suffix: \"Input: {adjective}\\nOutput:\",\n *   inputVariables: [\"adjective\"],\n * });\n * console.log(dynamicPrompt.format({ adjective: \"big\" }));\n * console.log(\n *   dynamicPrompt.format({\n *     adjective:\n *       \"big and huge and massive and large and gigantic and tall and much much much much much bigger than everything else\",\n *   }),\n * );\n * ```\n */\nexport class LengthBasedExampleSelector extends BaseExampleSelector {\n  protected examples: Example[] = [];\n\n  examplePrompt!: PromptTemplate;\n\n  getTextLength: (text: string) => number = getLengthBased;\n\n  maxLength = 2048;\n\n  exampleTextLengths: number[] = [];\n\n  constructor(data: LengthBasedExampleSelectorInput) {\n    super(data);\n    this.examplePrompt = data.examplePrompt;\n    this.maxLength = data.maxLength ?? 2048;\n    this.getTextLength = data.getTextLength ?? getLengthBased;\n  }\n\n  /**\n   * Adds an example to the list of examples and calculates its length.\n   * @param example The example to be added.\n   * @returns Promise that resolves when the example has been added and its length calculated.\n   */\n  async addExample(example: Example): Promise<void> {\n    this.examples.push(example);\n    const stringExample = await this.examplePrompt.format(example);\n    this.exampleTextLengths.push(this.getTextLength(stringExample));\n  }\n\n  /**\n   * Calculates the lengths of the examples.\n   * @param v Array of lengths of the examples.\n   * @param values Instance of LengthBasedExampleSelector.\n   * @returns Promise that resolves with an array of lengths of the examples.\n   */\n  async calculateExampleTextLengths(\n    v: number[],\n    values: LengthBasedExampleSelector\n  ): Promise<number[]> {\n    if (v.length > 0) {\n      return v;\n    }\n\n    const { examples, examplePrompt } = values;\n    const stringExamples = await Promise.all(\n      examples.map((eg: Example) => examplePrompt.format(eg))\n    );\n    return stringExamples.map((eg: string) => this.getTextLength(eg));\n  }\n\n  /**\n   * Selects examples until the total length of the selected examples\n   * reaches the maxLength.\n   * @param inputVariables The input variables for the examples.\n   * @returns Promise that resolves with an array of selected examples.\n   */\n  async selectExamples(inputVariables: Example): Promise<Example[]> {\n    const inputs = Object.values(inputVariables).join(\" \");\n    let remainingLength = this.maxLength - this.getTextLength(inputs);\n    let i = 0;\n    const examples: Example[] = [];\n\n    while (remainingLength > 0 && i < this.examples.length) {\n      const newLength = remainingLength - this.exampleTextLengths[i];\n      if (newLength < 0) {\n        break;\n      } else {\n        examples.push(this.examples[i]);\n        remainingLength = newLength;\n      }\n      i += 1;\n    }\n\n    return examples;\n  }\n\n  /**\n   * Creates a new instance of LengthBasedExampleSelector and adds a list of\n   * examples to it.\n   * @param examples Array of examples to be added.\n   * @param args Input parameters for the LengthBasedExampleSelector.\n   * @returns Promise that resolves with a new instance of LengthBasedExampleSelector with the examples added.\n   */\n  static async fromExamples(\n    examples: Example[],\n    args: LengthBasedExampleSelectorInput\n  ) {\n    const selector = new LengthBasedExampleSelector(args);\n    await Promise.all(examples.map((eg) => selector.addExample(eg)));\n    return selector;\n  }\n}\n"],"mappings":";;;;;;AAOA,SAAS,eAAeA,MAAsB;AAC5C,QAAO,KAAK,MAAM,OAAO,CAAC;AAC3B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAqDD,IAAa,6BAAb,MAAa,mCAAmC,oBAAoB;CAClE,AAAU,WAAsB,CAAE;CAElC;CAEA,gBAA0C;CAE1C,YAAY;CAEZ,qBAA+B,CAAE;CAEjC,YAAYC,MAAuC;EACjD,MAAM,KAAK;EACX,KAAK,gBAAgB,KAAK;EAC1B,KAAK,YAAY,KAAK,aAAa;EACnC,KAAK,gBAAgB,KAAK,iBAAiB;CAC5C;;;;;;CAOD,MAAM,WAAWC,SAAiC;EAChD,KAAK,SAAS,KAAK,QAAQ;EAC3B,MAAM,gBAAgB,MAAM,KAAK,cAAc,OAAO,QAAQ;EAC9D,KAAK,mBAAmB,KAAK,KAAK,cAAc,cAAc,CAAC;CAChE;;;;;;;CAQD,MAAM,4BACJC,GACAC,QACmB;AACnB,MAAI,EAAE,SAAS,EACb,QAAO;EAGT,MAAM,EAAE,UAAU,eAAe,GAAG;EACpC,MAAM,iBAAiB,MAAM,QAAQ,IACnC,SAAS,IAAI,CAACC,OAAgB,cAAc,OAAO,GAAG,CAAC,CACxD;AACD,SAAO,eAAe,IAAI,CAACC,OAAe,KAAK,cAAc,GAAG,CAAC;CAClE;;;;;;;CAQD,MAAM,eAAeC,gBAA6C;EAChE,MAAM,SAAS,OAAO,OAAO,eAAe,CAAC,KAAK,IAAI;EACtD,IAAI,kBAAkB,KAAK,YAAY,KAAK,cAAc,OAAO;EACjE,IAAI,IAAI;EACR,MAAMC,WAAsB,CAAE;AAE9B,SAAO,kBAAkB,KAAK,IAAI,KAAK,SAAS,QAAQ;GACtD,MAAM,YAAY,kBAAkB,KAAK,mBAAmB;AAC5D,OAAI,YAAY,EACd;QACK;IACL,SAAS,KAAK,KAAK,SAAS,GAAG;IAC/B,kBAAkB;GACnB;GACD,KAAK;EACN;AAED,SAAO;CACR;;;;;;;;CASD,aAAa,aACXA,UACAC,MACA;EACA,MAAM,WAAW,IAAI,2BAA2B;EAChD,MAAM,QAAQ,IAAI,SAAS,IAAI,CAAC,OAAO,SAAS,WAAW,GAAG,CAAC,CAAC;AAChE,SAAO;CACR;AACF"}

package/dist/example_selectors/semantic_similarity.cjs

@@ -1,139 +1,122 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.SemanticSimilarityExampleSelector = void 0;
-const document_js_1 = require("../documents/document.cjs");
-const base_js_1 = require("./base.cjs");
+const require_document = require('../documents/document.cjs');
+const require_base = require('./base.cjs');
+
+//#region src/example_selectors/semantic_similarity.ts
 function sortedValues(values) {
-    return Object.keys(values)
-        .sort()
-        .map((key) => values[key]);
+	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;
-    }
-    /**
-     * 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,
-        });
-    }
-}
+* 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" }));
+* ```
+*/
+var SemanticSimilarityExampleSelector = class SemanticSimilarityExampleSelector extends require_base.BaseExampleSelector {
+	vectorStoreRetriever;
+	exampleKeys;
+	inputKeys;
+	constructor(data) {
+		super(data);
+		this.exampleKeys = data.exampleKeys;
+		this.inputKeys = data.inputKeys;
+		if (data.vectorStore !== void 0) 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 require_document.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) 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, embeddings, options);
+		return new SemanticSimilarityExampleSelector({
+			vectorStore,
+			k: options.k ?? 4,
+			exampleKeys: options.exampleKeys,
+			inputKeys: options.inputKeys
+		});
+	}
+};
+
+//#endregion
 exports.SemanticSimilarityExampleSelector = SemanticSimilarityExampleSelector;
+//# sourceMappingURL=semantic_similarity.cjs.map

package/dist/example_selectors/semantic_similarity.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic_similarity.cjs","names":["values: Record<string, T>","BaseExampleSelector","data: SemanticSimilarityExampleSelectorInput<V>","example: Example","Document","inputVariables: Record<string, T>","examples: Record<string, string>[]","embeddings: Embeddings","vectorStoreCls: C","options: {\n      k?: number;\n      inputKeys?: string[];\n    } & Parameters<C[\"fromTexts\"]>[3]"],"sources":["../../src/example_selectors/semantic_similarity.ts"],"sourcesContent":["import type { Embeddings } from \"../embeddings.js\";\nimport type {\n  VectorStoreInterface,\n  VectorStoreRetrieverInterface,\n  VectorStore,\n} from \"../vectorstores.js\";\nimport type { Example } from \"../prompts/base.js\";\nimport { Document } from \"../documents/document.js\";\nimport { BaseExampleSelector } from \"./base.js\";\n\nfunction sortedValues<T>(values: Record<string, T>): T[] {\n  return Object.keys(values)\n    .sort()\n    .map((key) => values[key]);\n}\n\n/**\n * Interface for the input data of the SemanticSimilarityExampleSelector\n * class.\n */\nexport type SemanticSimilarityExampleSelectorInput<\n  V extends VectorStoreInterface = VectorStoreInterface\n> =\n  | {\n      vectorStore: V;\n      k?: number;\n      filter?: V[\"FilterType\"];\n      exampleKeys?: string[];\n      inputKeys?: string[];\n      vectorStoreRetriever?: never;\n    }\n  | {\n      vectorStoreRetriever: VectorStoreRetrieverInterface<V>;\n      exampleKeys?: string[];\n      inputKeys?: string[];\n      vectorStore?: never;\n      k?: never;\n      filter?: never;\n    };\n\n/**\n * Class that selects examples based on semantic similarity. It extends\n * the BaseExampleSelector class.\n * @example\n * ```typescript\n * const exampleSelector = await SemanticSimilarityExampleSelector.fromExamples(\n *   [\n *     { input: \"happy\", output: \"sad\" },\n *     { input: \"tall\", output: \"short\" },\n *     { input: \"energetic\", output: \"lethargic\" },\n *     { input: \"sunny\", output: \"gloomy\" },\n *     { input: \"windy\", output: \"calm\" },\n *   ],\n *   new OpenAIEmbeddings(),\n *   HNSWLib,\n *   { k: 1 },\n * );\n * const dynamicPrompt = new FewShotPromptTemplate({\n *   exampleSelector,\n *   examplePrompt: PromptTemplate.fromTemplate(\n *     \"Input: {input}\\nOutput: {output}\",\n *   ),\n *   prefix: \"Give the antonym of every input\",\n *   suffix: \"Input: {adjective}\\nOutput:\",\n *   inputVariables: [\"adjective\"],\n * });\n * console.log(await dynamicPrompt.format({ adjective: \"rainy\" }));\n * ```\n */\nexport class SemanticSimilarityExampleSelector<\n  V extends VectorStoreInterface = VectorStoreInterface\n> extends BaseExampleSelector {\n  vectorStoreRetriever: VectorStoreRetrieverInterface<V>;\n\n  exampleKeys?: string[];\n\n  inputKeys?: string[];\n\n  constructor(data: SemanticSimilarityExampleSelectorInput<V>) {\n    super(data);\n    this.exampleKeys = data.exampleKeys;\n    this.inputKeys = data.inputKeys;\n    if (data.vectorStore !== undefined) {\n      this.vectorStoreRetriever = data.vectorStore.asRetriever({\n        k: data.k ?? 4,\n        filter: data.filter,\n      });\n    } else if (data.vectorStoreRetriever) {\n      this.vectorStoreRetriever = data.vectorStoreRetriever;\n    } else {\n      throw new Error(\n        `You must specify one of \"vectorStore\" and \"vectorStoreRetriever\".`\n      );\n    }\n  }\n\n  /**\n   * Method that adds a new example to the vectorStore. The example is\n   * converted to a string and added to the vectorStore as a document.\n   * @param example The example to be added to the vectorStore.\n   * @returns Promise that resolves when the example has been added to the vectorStore.\n   */\n  async addExample(example: Example): Promise<void> {\n    const inputKeys = this.inputKeys ?? Object.keys(example);\n    const stringExample = sortedValues(\n      inputKeys.reduce(\n        (acc, key) => ({ ...acc, [key]: example[key] }),\n        {} as Example\n      )\n    ).join(\" \");\n\n    await this.vectorStoreRetriever.addDocuments([\n      new Document({\n        pageContent: stringExample,\n        metadata: example,\n      }),\n    ]);\n  }\n\n  /**\n   * Method that selects which examples to use based on semantic similarity.\n   * It performs a similarity search in the vectorStore using the input\n   * variables and returns the examples with the highest similarity.\n   * @param inputVariables The input variables used for the similarity search.\n   * @returns Promise that resolves with an array of the selected examples.\n   */\n  async selectExamples<T>(\n    inputVariables: Record<string, T>\n  ): Promise<Example[]> {\n    const inputKeys = this.inputKeys ?? Object.keys(inputVariables);\n    const query = sortedValues(\n      inputKeys.reduce(\n        (acc, key) => ({ ...acc, [key]: inputVariables[key] }),\n        {} as Record<string, T>\n      )\n    ).join(\" \");\n\n    const exampleDocs = await this.vectorStoreRetriever.invoke(query);\n\n    const examples = exampleDocs.map((doc) => doc.metadata);\n    if (this.exampleKeys) {\n      // If example keys are provided, filter examples to those keys.\n      return examples.map((example) =>\n        (this.exampleKeys as string[]).reduce(\n          (acc, key) => ({ ...acc, [key]: example[key] }),\n          {}\n        )\n      );\n    }\n    return examples;\n  }\n\n  /**\n   * Static method that creates a new instance of\n   * SemanticSimilarityExampleSelector. It takes a list of examples, an\n   * instance of Embeddings, a VectorStore class, and an options object as\n   * parameters. It converts the examples to strings, creates a VectorStore\n   * from the strings and the embeddings, and returns a new\n   * SemanticSimilarityExampleSelector with the created VectorStore and the\n   * options provided.\n   * @param examples The list of examples to be used.\n   * @param embeddings The instance of Embeddings to be used.\n   * @param vectorStoreCls The VectorStore class to be used.\n   * @param options The options object for the SemanticSimilarityExampleSelector.\n   * @returns Promise that resolves with a new instance of SemanticSimilarityExampleSelector.\n   */\n  static async fromExamples<C extends typeof VectorStore>(\n    examples: Record<string, string>[],\n    embeddings: Embeddings,\n    vectorStoreCls: C,\n    options: {\n      k?: number;\n      inputKeys?: string[];\n    } & Parameters<C[\"fromTexts\"]>[3] = {}\n  ): Promise<SemanticSimilarityExampleSelector> {\n    const inputKeys = options.inputKeys ?? null;\n    const stringExamples = examples.map((example) =>\n      sortedValues(\n        inputKeys\n          ? inputKeys.reduce(\n              (acc, key) => ({ ...acc, [key]: example[key] }),\n              {} as Record<string, string>\n            )\n          : example\n      ).join(\" \")\n    );\n\n    const vectorStore = await vectorStoreCls.fromTexts(\n      stringExamples,\n      examples, // metadatas\n      embeddings,\n      options\n    );\n\n    return new SemanticSimilarityExampleSelector({\n      vectorStore,\n      k: options.k ?? 4,\n      exampleKeys: options.exampleKeys,\n      inputKeys: options.inputKeys,\n    });\n  }\n}\n"],"mappings":";;;;AAUA,SAAS,aAAgBA,QAAgC;AACvD,QAAO,OAAO,KAAK,OAAO,CACvB,MAAM,CACN,IAAI,CAAC,QAAQ,OAAO,KAAK;AAC7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAuDD,IAAa,oCAAb,MAAa,0CAEHC,iCAAoB;CAC5B;CAEA;CAEA;CAEA,YAAYC,MAAiD;EAC3D,MAAM,KAAK;EACX,KAAK,cAAc,KAAK;EACxB,KAAK,YAAY,KAAK;AACtB,MAAI,KAAK,gBAAgB,QACvB,KAAK,uBAAuB,KAAK,YAAY,YAAY;GACvD,GAAG,KAAK,KAAK;GACb,QAAQ,KAAK;EACd,EAAC;WACO,KAAK,sBACd,KAAK,uBAAuB,KAAK;MAEjC,OAAM,IAAI,MACR,CAAC,iEAAiE,CAAC;CAGxE;;;;;;;CAQD,MAAM,WAAWC,SAAiC;EAChD,MAAM,YAAY,KAAK,aAAa,OAAO,KAAK,QAAQ;EACxD,MAAM,gBAAgB,aACpB,UAAU,OACR,CAAC,KAAK,SAAS;GAAE,GAAG;IAAM,MAAM,QAAQ;EAAM,IAC9C,CAAE,EACH,CACF,CAAC,KAAK,IAAI;EAEX,MAAM,KAAK,qBAAqB,aAAa,CAC3C,IAAIC,0BAAS;GACX,aAAa;GACb,UAAU;EACX,EACF,EAAC;CACH;;;;;;;;CASD,MAAM,eACJC,gBACoB;EACpB,MAAM,YAAY,KAAK,aAAa,OAAO,KAAK,eAAe;EAC/D,MAAM,QAAQ,aACZ,UAAU,OACR,CAAC,KAAK,SAAS;GAAE,GAAG;IAAM,MAAM,eAAe;EAAM,IACrD,CAAE,EACH,CACF,CAAC,KAAK,IAAI;EAEX,MAAM,cAAc,MAAM,KAAK,qBAAqB,OAAO,MAAM;EAEjE,MAAM,WAAW,YAAY,IAAI,CAAC,QAAQ,IAAI,SAAS;AACvD,MAAI,KAAK,YAEP,QAAO,SAAS,IAAI,CAAC,YAClB,KAAK,YAAyB,OAC7B,CAAC,KAAK,SAAS;GAAE,GAAG;IAAM,MAAM,QAAQ;EAAM,IAC9C,CAAE,EACH,CACF;AAEH,SAAO;CACR;;;;;;;;;;;;;;;CAgBD,aAAa,aACXC,UACAC,YACAC,gBACAC,UAGoC,CAAE,GACM;EAC5C,MAAM,YAAY,QAAQ,aAAa;EACvC,MAAM,iBAAiB,SAAS,IAAI,CAAC,YACnC,aACE,YACI,UAAU,OACR,CAAC,KAAK,SAAS;GAAE,GAAG;IAAM,MAAM,QAAQ;EAAM,IAC9C,CAAE,EACH,GACD,QACL,CAAC,KAAK,IAAI,CACZ;EAED,MAAM,cAAc,MAAM,eAAe,UACvC,gBACA,UACA,YACA,QACD;AAED,SAAO,IAAI,kCAAkC;GAC3C;GACA,GAAG,QAAQ,KAAK;GAChB,aAAa,QAAQ;GACrB,WAAW,QAAQ;EACpB;CACF;AACF"}