@langchain/core 0.3.72 → 1.0.0-alpha.2

package/dist/example_selectors/semantic_similarity.d.cts

@@ -0,0 +1,97 @@
+import { Embeddings } from "../embeddings.cjs";
+import { Example } from "../prompts/base.cjs";
+import { BaseExampleSelector } from "./base.cjs";
+import { VectorStore, VectorStoreInterface, VectorStoreRetrieverInterface } from "../vectorstores.cjs";
+
+//#region src/example_selectors/semantic_similarity.d.ts
+
+/**
+ * Interface for the input data of the SemanticSimilarityExampleSelector
+ * class.
+ */
+type SemanticSimilarityExampleSelectorInput<V extends VectorStoreInterface = VectorStoreInterface> = {
+  vectorStore: V;
+  k?: number;
+  filter?: V["FilterType"];
+  exampleKeys?: string[];
+  inputKeys?: string[];
+  vectorStoreRetriever?: never;
+} | {
+  vectorStoreRetriever: VectorStoreRetrieverInterface<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" }));
+ * ```
+ */
+declare class SemanticSimilarityExampleSelector<V extends VectorStoreInterface = VectorStoreInterface> extends BaseExampleSelector {
+  vectorStoreRetriever: VectorStoreRetrieverInterface<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>;
+}
+//#endregion
+export { SemanticSimilarityExampleSelector, SemanticSimilarityExampleSelectorInput };
+//# sourceMappingURL=semantic_similarity.d.cts.map

package/dist/example_selectors/semantic_similarity.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic_similarity.d.cts","names":["Embeddings","VectorStoreInterface","VectorStoreRetrieverInterface","VectorStore","Example","BaseExampleSelector","SemanticSimilarityExampleSelectorInput","V","SemanticSimilarityExampleSelector","Promise","T","Record","C","Parameters"],"sources":["../../src/example_selectors/semantic_similarity.d.ts"],"sourcesContent":["import type { Embeddings } from \"../embeddings.js\";\nimport type { VectorStoreInterface, VectorStoreRetrieverInterface, VectorStore } from \"../vectorstores.js\";\nimport type { Example } from \"../prompts/base.js\";\nimport { BaseExampleSelector } from \"./base.js\";\n/**\n * Interface for the input data of the SemanticSimilarityExampleSelector\n * class.\n */\nexport type SemanticSimilarityExampleSelectorInput<V extends VectorStoreInterface = VectorStoreInterface> = {\n    vectorStore: V;\n    k?: number;\n    filter?: V[\"FilterType\"];\n    exampleKeys?: string[];\n    inputKeys?: string[];\n    vectorStoreRetriever?: never;\n} | {\n    vectorStoreRetriever: VectorStoreRetrieverInterface<V>;\n    exampleKeys?: string[];\n    inputKeys?: string[];\n    vectorStore?: never;\n    k?: never;\n    filter?: never;\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 declare class SemanticSimilarityExampleSelector<V extends VectorStoreInterface = VectorStoreInterface> extends BaseExampleSelector {\n    vectorStoreRetriever: VectorStoreRetrieverInterface<V>;\n    exampleKeys?: string[];\n    inputKeys?: string[];\n    constructor(data: SemanticSimilarityExampleSelectorInput<V>);\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    addExample(example: Example): Promise<void>;\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    selectExamples<T>(inputVariables: Record<string, T>): Promise<Example[]>;\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 fromExamples<C extends typeof VectorStore>(examples: Record<string, string>[], embeddings: Embeddings, vectorStoreCls: C, options?: {\n        k?: number;\n        inputKeys?: string[];\n    } & Parameters<C[\"fromTexts\"]>[3]): Promise<SemanticSimilarityExampleSelector>;\n}\n"],"mappings":";;;;;;;;;AAQA;;AAA6DC,KAAjDK,sCAAiDL,CAAAA,UAAAA,oBAAAA,GAAuBA,oBAAvBA,CAAAA,GAAAA;EAAoB,WAAGA,EACnEM,CADmEN;EAAoB,CAAA,CAAA,EACvFM,MAAAA;EAAC,MAELA,CAAAA,EAAAA,CAAAA,CAAAA,YAAAA,CAAAA;EAAC,WAK0CA,CAAAA,EAAAA,MAAAA,EAAAA;EAAC,SAA/BL,CAAAA,EAAAA,MAAAA,EAAAA;EAA6B,oBAAA,CAAA,EAAA,KAAA;AAoCvD,CAAA,GAAqBM;EAAiC,oBAAA,EApC5BN,6BAoC4B,CApCEK,CAoCF,CAAA;EAAA,WAAWN,CAAAA,EAAAA,MAAAA,EAAAA;EAAoB,SAAGA,CAAAA,EAAAA,MAAAA,EAAAA;EAAoB,WACpDM,CAAAA,EAAAA,KAAAA;EAAC,CAAA,CAAA,EAA/BL,KAAAA;EAA6B,MAGMK,CAAAA,EAAAA,KAAAA;CAAC;;;;;;;;;;;;;;;;AAJ2E;;;;;;;;;;;;;;cAApHC,4CAA4CP,uBAAuBA,8BAA8BI,mBAAAA;wBAC5FH,8BAA8BK;;;oBAGlCD,uCAAuCC;;;;;;;sBAOrCH,UAAUK;;;;;;;;oCAQIE,eAAeD,KAAKD,QAAQL;;;;;;;;;;;;;;;uCAezBD,uBAAuBQ,sCAAsCX,4BAA4BY;;;MAG1HC,WAAWD,qBAAqBH,QAAQD"}

package/dist/example_selectors/semantic_similarity.d.ts

@@ -1,25 +1,28 @@
-import type { Embeddings } from "../embeddings.js";
-import type { VectorStoreInterface, VectorStoreRetrieverInterface, VectorStore } from "../vectorstores.js";
-import type { Example } from "../prompts/base.js";
+import { Embeddings } from "../embeddings.js";
+import { Example } from "../prompts/base.js";
 import { BaseExampleSelector } from "./base.js";
+import { VectorStore, VectorStoreInterface, VectorStoreRetrieverInterface } from "../vectorstores.js";
+
+//#region src/example_selectors/semantic_similarity.d.ts
+
 /**
  * Interface for the input data of the SemanticSimilarityExampleSelector
  * class.
  */
-export type SemanticSimilarityExampleSelectorInput<V extends VectorStoreInterface = VectorStoreInterface> = {
-    vectorStore: V;
-    k?: number;
-    filter?: V["FilterType"];
-    exampleKeys?: string[];
-    inputKeys?: string[];
-    vectorStoreRetriever?: never;
+type SemanticSimilarityExampleSelectorInput<V extends VectorStoreInterface = VectorStoreInterface> = {
+  vectorStore: V;
+  k?: number;
+  filter?: V["FilterType"];
+  exampleKeys?: string[];
+  inputKeys?: string[];
+  vectorStoreRetriever?: never;
 } | {
-    vectorStoreRetriever: VectorStoreRetrieverInterface<V>;
-    exampleKeys?: string[];
-    inputKeys?: string[];
-    vectorStore?: never;
-    k?: never;
-    filter?: never;
+  vectorStoreRetriever: VectorStoreRetrieverInterface<V>;
+  exampleKeys?: string[];
+  inputKeys?: string[];
+  vectorStore?: never;
+  k?: never;
+  filter?: never;
 };
 /**
  * Class that selects examples based on semantic similarity. It extends
@@ -50,42 +53,45 @@ export type SemanticSimilarityExampleSelectorInput<V extends VectorStoreInterfac
  * console.log(await dynamicPrompt.format({ adjective: "rainy" }));
  * ```
  */
-export declare class SemanticSimilarityExampleSelector<V extends VectorStoreInterface = VectorStoreInterface> extends BaseExampleSelector {
-    vectorStoreRetriever: VectorStoreRetrieverInterface<V>;
-    exampleKeys?: string[];
+declare class SemanticSimilarityExampleSelector<V extends VectorStoreInterface = VectorStoreInterface> extends BaseExampleSelector {
+  vectorStoreRetriever: VectorStoreRetrieverInterface<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[];
-    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>;
+  } & Parameters<C["fromTexts"]>[3]): Promise<SemanticSimilarityExampleSelector>;
 }
+//#endregion
+export { SemanticSimilarityExampleSelector, SemanticSimilarityExampleSelectorInput };
+//# sourceMappingURL=semantic_similarity.d.ts.map

package/dist/example_selectors/semantic_similarity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic_similarity.d.ts","names":["Embeddings","VectorStoreInterface","VectorStoreRetrieverInterface","VectorStore","Example","BaseExampleSelector","SemanticSimilarityExampleSelectorInput","V","SemanticSimilarityExampleSelector","Promise","T","Record","C","Parameters"],"sources":["../../src/example_selectors/semantic_similarity.d.ts"],"sourcesContent":["import type { Embeddings } from \"../embeddings.js\";\nimport type { VectorStoreInterface, VectorStoreRetrieverInterface, VectorStore } from \"../vectorstores.js\";\nimport type { Example } from \"../prompts/base.js\";\nimport { BaseExampleSelector } from \"./base.js\";\n/**\n * Interface for the input data of the SemanticSimilarityExampleSelector\n * class.\n */\nexport type SemanticSimilarityExampleSelectorInput<V extends VectorStoreInterface = VectorStoreInterface> = {\n    vectorStore: V;\n    k?: number;\n    filter?: V[\"FilterType\"];\n    exampleKeys?: string[];\n    inputKeys?: string[];\n    vectorStoreRetriever?: never;\n} | {\n    vectorStoreRetriever: VectorStoreRetrieverInterface<V>;\n    exampleKeys?: string[];\n    inputKeys?: string[];\n    vectorStore?: never;\n    k?: never;\n    filter?: never;\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 declare class SemanticSimilarityExampleSelector<V extends VectorStoreInterface = VectorStoreInterface> extends BaseExampleSelector {\n    vectorStoreRetriever: VectorStoreRetrieverInterface<V>;\n    exampleKeys?: string[];\n    inputKeys?: string[];\n    constructor(data: SemanticSimilarityExampleSelectorInput<V>);\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    addExample(example: Example): Promise<void>;\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    selectExamples<T>(inputVariables: Record<string, T>): Promise<Example[]>;\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 fromExamples<C extends typeof VectorStore>(examples: Record<string, string>[], embeddings: Embeddings, vectorStoreCls: C, options?: {\n        k?: number;\n        inputKeys?: string[];\n    } & Parameters<C[\"fromTexts\"]>[3]): Promise<SemanticSimilarityExampleSelector>;\n}\n"],"mappings":";;;;;;;;;AAQA;;AAA6DC,KAAjDK,sCAAiDL,CAAAA,UAAAA,oBAAAA,GAAuBA,oBAAvBA,CAAAA,GAAAA;EAAoB,WAAGA,EACnEM,CADmEN;EAAoB,CAAA,CAAA,EACvFM,MAAAA;EAAC,MAELA,CAAAA,EAAAA,CAAAA,CAAAA,YAAAA,CAAAA;EAAC,WAK0CA,CAAAA,EAAAA,MAAAA,EAAAA;EAAC,SAA/BL,CAAAA,EAAAA,MAAAA,EAAAA;EAA6B,oBAAA,CAAA,EAAA,KAAA;AAoCvD,CAAA,GAAqBM;EAAiC,oBAAA,EApC5BN,6BAoC4B,CApCEK,CAoCF,CAAA;EAAA,WAAWN,CAAAA,EAAAA,MAAAA,EAAAA;EAAoB,SAAGA,CAAAA,EAAAA,MAAAA,EAAAA;EAAoB,WACpDM,CAAAA,EAAAA,KAAAA;EAAC,CAAA,CAAA,EAA/BL,KAAAA;EAA6B,MAGMK,CAAAA,EAAAA,KAAAA;CAAC;;;;;;;;;;;;;;;;AAJ2E;;;;;;;;;;;;;;cAApHC,4CAA4CP,uBAAuBA,8BAA8BI,mBAAAA;wBAC5FH,8BAA8BK;;;oBAGlCD,uCAAuCC;;;;;;;sBAOrCH,UAAUK;;;;;;;;oCAQIE,eAAeD,KAAKD,QAAQL;;;;;;;;;;;;;;;uCAezBD,uBAAuBQ,sCAAsCX,4BAA4BY;;;MAG1HC,WAAWD,qBAAqBH,QAAQD"}

package/dist/example_selectors/semantic_similarity.js

@@ -1,135 +1,122 @@
 import { Document } from "../documents/document.js";
 import { BaseExampleSelector } from "./base.js";
+
+//#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" }));
- * ```
- */
-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,
-        });
-    }
-}
+* 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 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 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
+export { SemanticSimilarityExampleSelector };
+//# sourceMappingURL=semantic_similarity.js.map

package/dist/example_selectors/semantic_similarity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"semantic_similarity.js","names":["values: Record<string, T>","data: SemanticSimilarityExampleSelectorInput<V>","example: Example","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,0CAEH,oBAAoB;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,IAAI,SAAS;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"}

package/dist/index.cjs

@@ -0,0 +1,12 @@
+
+//#region src/index.ts
+var src_exports = {};
+
+//#endregion
+Object.defineProperty(exports, 'src_exports', {
+  enumerable: true,
+  get: function () {
+    return src_exports;
+  }
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["export {};\n"],"mappings":""}

package/dist/index.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/index.d.ts

@@ -0,0 +1 @@
+export { };

package/dist/index.js

@@ -0,0 +1,6 @@
+//#region src/index.ts
+var src_exports = {};
+
+//#endregion
+export { src_exports };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["export {};\n"],"mappings":""}