langchain_community.chat_message_histories.xata.XataChatMessageHistory¶

class langchain_community.chat_message_histories.xata.XataChatMessageHistory(session_id: str, db_url: str, api_key: str, branch_name: str = 'main', table_name: str = 'messages', create_table: bool = True)[source]¶

Chat message history stored in a Xata database.

Initialize with Xata client.

Attributes

messages

Methods

__init__(session_id, db_url, api_key[, ...])

Initialize with Xata client.

aadd_messages(messages)

Async add a list of messages.

aclear()

Async remove all messages from the store

add_ai_message(message)

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

add_message(message)

Append the message to the Xata table

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()

Async version of getting messages.

clear()

Delete session from Xata table.
Parameters

  • session_id (str) –

  • db_url (str) –

  • api_key (str) –

  • branch_name (str) –

  • table_name (str) –

  • create_table (bool) –

__init__(session_id: str, db_url: str, api_key: str, branch_name: str = 'main', table_name: str = 'messages', create_table: bool = True) → None[source]¶

Initialize with Xata client.

Parameters

  • session_id (str) –

  • db_url (str) –

  • api_key (str) –

  • branch_name (str) –

  • table_name (str) –

  • create_table (bool) –

Return type

None

async aadd_messages(messages: Sequence[BaseMessage]) → None¶

Async add a list of messages.

Parameters

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

Return type

None

async aclear() → None¶

Async remove all messages from the store

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 Xata table

Parameters

message (BaseMessage) –

Return type

None

add_messages(messages: Sequence[BaseMessage]) → None¶

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 sequence 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 to the store.

Return type

None

async aget_messages() → List[BaseMessage]¶

Async version of getting messages.

Can over-ride this method to provide an efficient async implementation.

In general, fetching messages may involve IO to the underlying persistence layer.

Return type

List[BaseMessage]

clear() → None[source]¶

Delete session from Xata table.

Return type

None

Examples using XataChatMessageHistory¶