Class RedisChatMessageHistory

Class used to store chat message history in Redis. It provides methods to add, retrieve, and clear messages from the chat history.

Example

const chatHistory = new RedisChatMessageHistory({
  sessionId: new Date().toISOString(),
  sessionTTL: 300,
  url: "redis:
});

const chain = new ConversationChain({
  llm: new ChatOpenAI({ temperature: 0 }),
  memory: { chatHistory },
});

const response = await chain.invoke({
  input: "What did I just say my name was?",
});
console.log({ response });

Hierarchy

Constructors

constructor

Properties

client

Methods

addAIChatMessage addMessage addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

Properties

client

client: Redis

Methods

addAIChatMessage

addMessage

  • Adds a message to the chat history.

    Parameters

    • message: BaseMessage

      The message to add to the chat history.

    Returns Promise<void>

    Promise that resolves when the message has been added.

addUserMessage

  • Parameters

    • message: string

    Returns Promise<void>

clear

  • Clears all messages from the chat history.

    Returns Promise<void>

    Promise that resolves when the chat history has been cleared.

getMessages

  • Retrieves all messages from the chat history.

    Returns Promise<BaseMessage[]>

    Promise that resolves with an array of BaseMessage instances.

toJSON

toJSONNotImplemented

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc