Class CloudflareD1MessageHistory

Deprecated

Install and import from "@langchain/cloudflare" instead.

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

  • BaseListChatMessageHistory
    • CloudflareD1MessageHistory

Constructors

constructor

Properties

database

Methods

addAIChatMessage addAIMessage addMessage addMessages addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

Properties

database

database: D1Database

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 Cloudflare D1 database for the current session.

    Parameters

    • message: BaseMessage

      The BaseMessage object to be added to the database.

    Returns Promise<void>

    Promise that resolves to void.

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

  • getMessages(): Promise<BaseMessage[]>

  • Method to retrieve all messages from the Cloudflare D1 database for the current session.

    Returns Promise<BaseMessage[]>

    Promise that resolves to an array of BaseMessage objects.

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

Settings

Member Visibility

On This Page

Constructors
Properties
Methods