Class MongoDBChatMessageHistory

Example

const chatHistory = new MongoDBChatMessageHistory({
  collection: myCollection,
  sessionId: 'unique-session-id',
});
const messages = await chatHistory.getMessages();
await chatHistory.clear();

Hierarchy

  • BaseListChatMessageHistory
    • MongoDBChatMessageHistory

Constructors

constructor

Methods

addAIChatMessage addAIMessage addMessage addMessages addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

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

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

getMessages

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

Settings

Member Visibility

On This Page

Constructors
Methods