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

Properties

client: Client

Methods

  • 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.

  • 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>

  • 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>

  • 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>

Generated using TypeDoc