langchain_community.chat_message_histories.sql.SQLChatMessageHistory

class langchain_community.chat_message_histories.sql.SQLChatMessageHistory(session_id: str, connection_string: Optional[str] = None, table_name: str = 'message_store', session_id_field_name: str = 'session_id', custom_message_converter: Optional[BaseMessageConverter] = None, connection: Union[None, AsyncEngine, Engine, str] = None, engine_args: Optional[Dict[str, Any]] = None, async_mode: Optional[bool] = None)[source]

Chat message history stored in an SQL database.

Attributes

Session

[Deprecated]

messages

Retrieve all messages from db

Methods

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

aadd_message(message)

Add a Message object to the store.

aadd_messages(messages)

Add a list of messages.

aclear()

Clear session memory from db

add_ai_message(message)

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

add_message(message)

Append the message to the record in db

add_messages(messages)

Add a list of messages.

add_user_message(message)

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

aget_messages()

Retrieve all messages from db

clear()

Clear session memory from db

get_messages()

Parameters
  • session_id (str) –

  • connection_string (Optional[str]) –

  • table_name (str) –

  • session_id_field_name (str) –

  • custom_message_converter (Optional[BaseMessageConverter]) –

  • connection (Union[None, AsyncEngine, Engine, str]) –

  • engine_args (Optional[Dict[str, Any]]) –

  • async_mode (Optional[bool]) –

__init__(session_id: str, connection_string: Optional[str] = None, table_name: str = 'message_store', session_id_field_name: str = 'session_id', custom_message_converter: Optional[BaseMessageConverter] = None, connection: Union[None, AsyncEngine, Engine, str] = None, engine_args: Optional[Dict[str, Any]] = None, async_mode: Optional[bool] = None)[source]
Parameters
  • session_id (str) –

  • connection_string (Optional[str]) –

  • table_name (str) –

  • session_id_field_name (str) –

  • custom_message_converter (Optional[BaseMessageConverter]) –

  • connection (Union[None, AsyncEngine, Engine, str]) –

  • engine_args (Optional[Dict[str, Any]]) –

  • async_mode (Optional[bool]) –

async aadd_message(message: BaseMessage) None[source]

Add a Message object to the store.

Parameters

message (BaseMessage) – A BaseMessage object to store.

Return type

None

async aadd_messages(messages: Sequence[BaseMessage]) None[source]

Add a list of messages.

Parameters

messages (Sequence[BaseMessage]) – A list of BaseMessage objects to store.

Return type

None

async aclear() None[source]

Clear session memory from db

Return type

None

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

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

Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.

This method may be deprecated in a future release.

Parameters

message (Union[AIMessage, str]) – The AI message to add.

Return type

None

add_message(message: BaseMessage) None[source]

Append the message to the record in db

Parameters

message (BaseMessage) –

Return type

None

add_messages(messages: Sequence[BaseMessage]) None[source]

Add a list of messages.

Implementations should over-ride this method to handle bulk addition of messages in an efficient manner to avoid unnecessary round-trips to the underlying store.

Parameters

messages (Sequence[BaseMessage]) – A list of BaseMessage objects to store.

Return type

None

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

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

Please note that this is a convenience method. Code should favor the bulk add_messages interface instead to save on round-trips to the underlying persistence layer.

This method may be deprecated in a future release.

Parameters

message (Union[HumanMessage, str]) – The human message to add

Return type

None

async aget_messages() List[BaseMessage][source]

Retrieve all messages from db

Return type

List[BaseMessage]

clear() None[source]

Clear session memory from db

Return type

None

get_messages() List[BaseMessage][source]
Return type

List[BaseMessage]

Examples using SQLChatMessageHistory