Class InMemoryStore<T>

In-memory implementation of the BaseStore using a dictionary. Used for storing key-value pairs in memory.

Type Parameters

  • T = any

Hierarchy

Constructors

constructor

Properties

lc_kwargs lc_namespace lc_serializable store

Accessors

lc_aliases lc_attributes lc_id lc_secrets

Methods

mdelete mget mset toJSON toJSONNotImplemented yieldKeys lc_name

Constructors

constructor

Properties

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

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

lc_serializable: boolean = false

Protected store

store: Record<string, T> = {}

Accessors

lc_aliases

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

lc_attributes

  • 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

lc_id

lc_secrets

  • 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

mdelete

  • Deletes the given keys and their associated values from the store.

    Parameters

    • keys: string[]

      Keys to delete from the store.

    Returns Promise<void>

    Promise that resolves when all keys have been deleted.

mget

  • Retrieves the values associated with the given keys from the store.

    Parameters

    • keys: string[]

      Keys to retrieve values for.

    Returns Promise<T[]>

    Array of values associated with the given keys.

mset

  • Sets the values for the given keys in the store.

    Parameters

    • keyValuePairs: [string, T][]

      Array of key-value pairs to set in the store.

    Returns Promise<void>

    Promise that resolves when all key-value pairs have been set.

toJSON

toJSONNotImplemented

yieldKeys

  • Asynchronous generator that yields keys from the store. If a prefix is provided, it only yields keys that start with the prefix.

    Parameters

    • Optional prefix: string

      Optional prefix to filter keys.

    Returns AsyncGenerator<string, any, unknown>

    AsyncGenerator that yields keys from the store.

Static lc_name

  • 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

Theme

On This Page

Generated using TypeDoc