RedisEntityStore#

class langchain.memory.entity.RedisEntityStore[source]#

Bases: BaseEntityStore

Deprecated since version 0.3.1: Please see the migration guide at: https://python.langchain.com/docs/versions/migrating_memory/ It will not be removed until langchain==1.0.0.

Redis-backed Entity store.

Entities get a TTL of 1 day by default, and that TTL is extended by 3 days every time the entity is read back.

Initializes the RedisEntityStore.

Parameters:

  • session_id – Unique identifier for the session.

  • url – URL of the Redis server.

  • key_prefix – Prefix for keys in the Redis store.

  • ttl – Time-to-live for keys in seconds (default 1 day).

  • recall_ttl – Time-to-live extension for keys when recalled (default 3 days).

param key_prefix: str = 'memory_store'#
param recall_ttl: int | None = 259200#
param redis_client: Any [Required]#
param session_id: str = 'default'#
param ttl: int | None = 86400#
clear() → None[source]#

Delete all entities from store.

Return type:

None

delete(key: str) → None[source]#

Delete entity value from store.

Parameters:

key (str)

Return type:

None

exists(key: str) → bool[source]#

Check if entity exists in store.

Parameters:

key (str)

Return type:

bool

get(
key: str,
default: str | None = None,
) → str | None[source]#

Get entity value from store.

Parameters:

  • key (str)

  • default (str | None)

Return type:

str | None

set(key: str, value: str | None) → None[source]#

Set entity value in store.

Parameters:

  • key (str)

  • value (str | None)

Return type:

None

property full_key_prefix: str#

Returns the full key prefix with session ID.