langchain.js
    Preparing search index...

    Class SemanticSimilarityExampleSelector<V>

    Class that selects examples based on semantic similarity. It extends the BaseExampleSelector class.

    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" }));

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    exampleKeys? inputKeys? lc_kwargs lc_namespace lc_serializable vectorStoreRetriever

    Accessors

    lc_aliases lc_attributes lc_id lc_secrets lc_serializable_keys

    Methods

    addExample selectExamples toJSON toJSONNotImplemented fromExamples lc_name

    Constructors

    Properties

    exampleKeys?: string[]
    inputKeys?: string[]
    lc_kwargs: SerializedFields
    lc_namespace: string[] = ...

    A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

    lc_serializable: boolean = false
    vectorStoreRetriever: VectorStoreRetrieverInterface<V>

    Accessors

    • get lc_aliases(): undefined | { [key: string]: string }

      A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

      Returns undefined | { [key: string]: string }

    • get lc_attributes(): undefined | SerializedFields

      A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

      Returns undefined | SerializedFields

    • get lc_id(): string[]

      The final serialized identifier for the module.

      Returns string[]

    • get lc_secrets(): undefined | { [key: string]: string }

      A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

      Returns undefined | { [key: string]: string }

    • get lc_serializable_keys(): undefined | string[]

      A manual list of keys that should be serialized. If not overridden, all fields passed into the constructor will be serialized.

      Returns undefined | string[]

    Methods

    • Method that adds a new example to the vectorStore. The example is converted to a string and added to the vectorStore as a document.

      Parameters

      • example: Example

        The example to be added to the vectorStore.

      Returns Promise<void>

      Promise that resolves when the example has been added to the vectorStore.

    • 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.

      Type Parameters

      • T

      Parameters

      • inputVariables: Record<string, T>

        The input variables used for the similarity search.

      Returns Promise<Example[]>

      Promise that resolves with an array of the selected 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.

      Type Parameters

      Parameters

      • examples: Record<string, string>[]

        The list of examples to be used.

      • embeddings: Embeddings

        The instance of Embeddings to be used.

      • vectorStoreCls: C

        The VectorStore class to be used.

      • options: { inputKeys?: string[]; k?: number } & Parameters<C["fromTexts"]>[3] = {}

        The options object for the SemanticSimilarityExampleSelector.

      Returns Promise<SemanticSimilarityExampleSelector<VectorStoreInterface>>

      Promise that resolves with a new instance of SemanticSimilarityExampleSelector.

    • The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

      Implemented as a static method to support loading logic.

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods