Class CloudflareD1MessageHistory

Class for storing and retrieving chat message history from a Cloudflare D1 database. Extends the BaseListChatMessageHistory class.

Example

const memory = new BufferMemory({
  returnMessages: true,
  chatHistory: new CloudflareD1MessageHistory({
    tableName: "stored_message",
    sessionId: "example",
    database: env.DB,
  }),
});

const chainInput = { input };

const res = await memory.chatHistory.invoke(chainInput);
await memory.saveContext(chainInput, {
  output: res,
});

Hierarchy

Constructors

constructor

Properties

database

Methods

addAIChatMessage addAIMessage addMessage addMessages addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

Properties

database

database: D1Database

Methods

addAIChatMessage

  • Parameters

    • message: string

    Returns Promise<void>

    ⚠️ Deprecated ⚠️

    Use addAIMessage instead

    This feature is deprecated and will be removed in the future.

    It is not recommended for use.

addAIMessage

  • 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

  • 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

  • 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

toJSONNotImplemented

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc