langchain.js
    Preparing search index...

    Base class for example selectors.

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • Optionalkwargs: SerializedFields
      • ..._args: never[]

      Returns BaseExampleSelector

    Properties

    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

    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

    • Adds an example to the example selector.

      Parameters

      • example: Example

        The example to add to the example selector.

      Returns Promise<string | void>

      A Promise that resolves to void or a string.

    • Selects examples from the example selector given the input variables.

      Parameters

      • input_variables: Example

        The input variables to select examples with.

      Returns Promise<Example[]>

      A Promise that resolves to an array of selected examples.

    • 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