Class RedisChatMessageHistory

Class for storing chat message history using Redis. Extends the BaseListChatMessageHistory class.

Hierarchy

BaseListChatMessageHistory
- RedisChatMessageHistory

Index

Constructors

constructor

new RedisChatMessageHistory(fields): RedisChatMessageHistory
Parameters
- fields: RedisChatMessageHistoryInput
Returns RedisChatMessageHistory
Overrides BaseListChatMessageHistory.constructor
- Defined in langchain/src/stores/message/redis.ts:49

Properties

client

client: RedisClientType<RedisModules, RedisFunctions, RedisScripts>

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

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;
}
Inherited from BaseListChatMessageHistory.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

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
Inherited from BaseListChatMessageHistory.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from BaseListChatMessageHistory.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): {
    config.password: string;
    config.url: string;
    config.username: 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 {
    config.password: string;
    config.url: string;
    config.username: string;
}
- config.password: string
- config.url: string
- config.username: string
Overrides BaseListChatMessageHistory.lc_secrets
- Defined in langchain/src/stores/message/redis.ts:35

Methods

addAIChatMessage

addAIChatMessage(message): Promise<void>
Parameters
- message: string
Returns Promise<void>
Inherited from BaseListChatMessageHistory.addAIChatMessage
- Defined in langchain/src/schema/index.ts:714

addMessage

addMessage(message): Promise<void>
Adds a new chat message to the Redis database for the current session.
Parameters
- message: BaseMessage
  
  The BaseMessage instance to add.
Returns Promise<void>
Promise resolving when the message has been added.
Overrides BaseListChatMessageHistory.addMessage
- Defined in langchain/src/stores/message/redis.ts:93

addUserMessage

addUserMessage(message): Promise<void>
Parameters
- message: string
Returns Promise<void>
Inherited from BaseListChatMessageHistory.addUserMessage
- Defined in langchain/src/schema/index.ts:710

clear

clear(): Promise<void>
Deletes all chat messages from the Redis database for the current session.

Returns Promise<void>
Promise resolving when the messages have been deleted.
- Defined in langchain/src/stores/message/redis.ts:107

ensureReadiness

ensureReadiness(): Promise<boolean>
Ensures the Redis client is ready to perform operations. If the client is not ready, it attempts to connect to the Redis database.

Returns Promise<boolean>
Promise resolving to true when the client is ready.
- Defined in langchain/src/stores/message/redis.ts:67

getMessages

getMessages(): Promise<BaseMessage[]>
Retrieves all chat messages from the Redis database for the current session.

Returns Promise<BaseMessage[]>
Promise resolving to an array of BaseMessage instances.
- Defined in langchain/src/stores/message/redis.ts:79

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseListChatMessageHistory.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseListChatMessageHistory.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

`Static` lc_name

lc_name(): string
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
Inherited from BaseListChatMessageHistory.lc_name
- Defined in langchain/src/load/serializable.ts:93

Class RedisChatMessageHistory

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

fields: RedisChatMessageHistoryInput

Returns RedisChatMessageHistory

Properties

client

lc_kwargs

lc_namespace

lc_serializable

Accessors

lc_aliases

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

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns { config.password: string; config.url: string; config.username: string; }

config.password: string

config.url: string

config.username: string

Methods

addAIChatMessage

Parameters

message: string

Returns Promise<void>

addMessage

Parameters

message: BaseMessage

Returns Promise<void>

addUserMessage

Parameters

message: string

Returns Promise<void>

clear

Returns Promise<void>

ensureReadiness

Returns Promise<boolean>

getMessages

Returns Promise<BaseMessage[]>

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

Static lc_name

Returns string

Settings

Member Visibility

Theme

On This Page

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

Returns {
config.password: string;
config.url: string;
config.username: string;
}

`Static` lc_name