Class BaseStore<K, V>Abstract

Abstract interface for a key-value store.

Type Parameters

  • K

  • V

Hierarchy

Implements

Constructors

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_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;
    }

Methods

  • Abstract method to get multiple values for a set of keys.

    Parameters

    • keys: K[]

      An array of keys.

    Returns Promise<(undefined | V)[]>

    • A Promise that resolves with array of values or undefined if key not found.
  • Abstract method to set a value for multiple keys.

    Parameters

    • keyValuePairs: [K, V][]

      An array of key-value pairs.

    Returns Promise<void>

    • A Promise that resolves when the operation is complete.
  • Abstract method to yield keys optionally based on a prefix.

    Parameters

    • Optional prefix: string

      Optional prefix to filter keys.

    Returns AsyncGenerator<string | K, any, unknown>

    • An asynchronous generator that yields keys on iteration.
  • 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

Generated using TypeDoc