langchain_community.chat_message_histories.tidb.TiDBChatMessageHistory¶

class langchain_community.chat_message_histories.tidb.TiDBChatMessageHistory(session_id: str, connection_string: str, table_name: str = 'langchain_message_store', earliest_time: Optional[datetime] = None)[source]¶

Represents a chat message history stored in a TiDB database.

Initializes a new instance of the TiDBChatMessageHistory class.

Parameters

  • session_id (str) – The ID of the chat session.

  • connection_string (str) – The connection string for the TiDB database. format: mysql+pymysql://<host>:<PASSWORD>@<host>:4000/<db>?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true

  • table_name (str, optional) – the table name to store the chat messages. Defaults to “langchain_message_store”.

  • earliest_time (Optional[datetime], optional) – The earliest time to retrieve messages from. Defaults to None.

Attributes

messages

returns all messages

Methods

__init__(session_id, connection_string[, ...])

Initializes a new instance of the TiDBChatMessageHistory class.

add_ai_message(message)

Convenience method for adding an AI message string to the store.

add_message(message)

adds a message to the database and cache

add_user_message(message)

Convenience method for adding a human message string to the store.

clear()

clears all messages

reload_cache()

reloads messages from database to cache
__init__(session_id: str, connection_string: str, table_name: str = 'langchain_message_store', earliest_time: Optional[datetime] = None)[source]¶

Initializes a new instance of the TiDBChatMessageHistory class.

Parameters

  • session_id (str) – The ID of the chat session.

  • connection_string (str) – The connection string for the TiDB database. format: mysql+pymysql://<host>:<PASSWORD>@<host>:4000/<db>?ssl_ca=/etc/ssl/cert.pem&ssl_verify_cert=true&ssl_verify_identity=true

  • table_name (str, optional) – the table name to store the chat messages. Defaults to “langchain_message_store”.

  • earliest_time (Optional[datetime], optional) – The earliest time to retrieve messages from. Defaults to None.

add_ai_message(message: Union[AIMessage, str]) → None¶

Convenience method for adding an AI message string to the store.

Parameters

message – The AI message to add.

add_message(message: BaseMessage) → None[source]¶

adds a message to the database and cache

add_user_message(message: Union[HumanMessage, str]) → None¶

Convenience method for adding a human message string to the store.

Parameters

message – The human message to add

clear() → None[source]¶

clears all messages

reload_cache() → None[source]¶

reloads messages from database to cache