Class ChatMessageHistory

Class for storing chat message history in-memory. It extends the BaseListChatMessageHistory class and provides methods to get, add, and clear messages.

Hierarchy

  • BaseListChatMessageHistory
    • ChatMessageHistory

Constructors

constructor

Methods

addAIChatMessage addAIMessage addMessage addMessages addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

  • new ChatMessageHistory(messages?): ChatMessageHistory

  • Parameters

    • Optionalmessages: BaseMessage[]

    Returns ChatMessageHistory

Methods

addAIChatMessage

  • addAIChatMessage(message): Promise<void>

  • Parameters

    • message: string

    Returns Promise<void>

    Deprecated

    Use addAIMessage instead

addAIMessage

  • addAIMessage(message): Promise<void>

  • This is a convenience method for adding an AI message string to the store. Please note that this is a convenience method. Code should favor the bulk addMessages interface instead to save on round-trips to the underlying persistence layer. This method may be deprecated in a future release.

    Parameters

    • message: string

    Returns Promise<void>

addMessage

  • addMessage(message): Promise<void>

  • Method to add a new message to the ChatMessageHistory instance.

    Parameters

    • message: BaseMessage

      The BaseMessage instance to add.

    Returns Promise<void>

    A promise that resolves when the message has been added.

addMessages

  • addMessages(messages): Promise<void>

  • Add a list of messages.

    Implementations should override this method to handle bulk addition of messages in an efficient manner to avoid unnecessary round-trips to the underlying store.

    Parameters

    • messages: BaseMessage[]

      A list of BaseMessage objects to store.

    Returns Promise<void>

addUserMessage

  • addUserMessage(message): Promise<void>

  • This is a convenience method for adding a human message string to the store. Please note that this is a convenience method. Code should favor the bulk addMessages interface instead to save on round-trips to the underlying persistence layer. This method may be deprecated in a future release.

    Parameters

    • message: string

    Returns Promise<void>

clear

  • clear(): Promise<void>

  • Method to clear all the messages from the ChatMessageHistory instance.

    Returns Promise<void>

    A promise that resolves when all messages have been cleared.

getMessages

  • getMessages(): Promise<BaseMessage[]>

  • Method to get all the messages stored in the ChatMessageHistory instance.

    Returns Promise<BaseMessage[]>

    Array of stored BaseMessage instances.

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

Settings

Member Visibility

On This Page

Constructors
Methods