langchain.js
    Preparing search index...

    Class RedisChatMessageHistory

    Install and import from the "@langchain/redis" integration package instead. Class for storing chat message history using Redis. Extends the BaseListChatMessageHistory class.

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

    const chain = new ConversationChain({
      llm: new ChatOpenAI({ model: "gpt-3.5-turbo", temperature: 0 }),
      memory: { chatHistory },
    });

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

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    client lc_namespace

    Accessors

    lc_secrets

    Methods

    addMessage clear ensureReadiness getMessages

    Constructors

    Properties

    client: RedisClientType<RedisModules, RedisFunctions, RedisScripts>
    lc_namespace: string[] = ...

    Accessors

    • get lc_secrets(): {
          "config.password": string;
          "config.url": string;
          "config.username": string;
      }

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

    Methods

    • 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.

    • Deletes all chat messages from the Redis database for the current session.

      Returns Promise<void>

      Promise resolving when the messages have been deleted.

    • 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.

    • Retrieves all chat messages from the Redis database for the current session.

      Returns Promise<BaseMessage[]>

      Promise resolving to an array of BaseMessage instances.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods