Class PostgresChatMessageHistory

Class for managing chat message history using a Postgres Database as a storage backend. Extends the BaseListChatMessageHistory class.

Example

const chatHistory = new PostgresChatMessageHistory({
   tableName: "langchain_chat_histories",
   sessionId: "lc-example",
   pool: new pg.Pool({
     host: "127.0.0.1",
     port: 5432,
     user: "myuser",
     password: "ChangeMe",
     database: "api",
   }),
});

Hierarchy

  • BaseListChatMessageHistory
    • PostgresChatMessageHistory

Constructors

constructor

Properties

pool sessionId tableName

Methods

addAIChatMessage addAIMessage addMessage addMessages addUserMessage clear end getMessages toJSON toJSONNotImplemented

Constructors

constructor

Properties

pool

pool: Pool

sessionId

sessionId: string

tableName

tableName: string = "langchain_chat_histories"

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

end

getMessages

toJSON

  • toJSON(): Serialized

  • Returns Serialized

toJSONNotImplemented

Settings

Member Visibility

On This Page

Constructors
Properties
Methods