Class PlanetScaleChatMessageHistory

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

Example

const chatHistory = new PlanetScaleChatMessageHistory({
  tableName: "stored_message",
  sessionId: "lc-example",
  config: {
    url: "ADD_YOURS_HERE",
  },
});
const chain = new ConversationChain({
  llm: new ChatOpenAI(),
  memory: chatHistory,
});
const response = await chain.invoke({
  input: "What did I just say my name was?",
});
console.log({ response });

Hierarchy

Constructors

constructor

Properties

client

Methods

addAIChatMessage addMessage addUserMessage clear getMessages toJSON toJSONNotImplemented

Constructors

constructor

Properties

client

client: Client

Methods

addAIChatMessage

addMessage

  • Method to add a new message to the PlanetScale 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.

addUserMessage

  • Parameters

    • message: string

    Returns Promise<void>

clear

  • Method to delete all messages from the PlanetScale database for the current session.

    Returns Promise<void>

    Promise that resolves to void.

getMessages

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

    Returns Promise<BaseMessage[]>

    Promise that resolves to an array of BaseMessage objects.

toJSON

toJSONNotImplemented

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc