langchain.memory.chat_message_histories.cosmos_db.CosmosDBChatMessageHistory¶

class langchain.memory.chat_message_histories.cosmos_db.CosmosDBChatMessageHistory(cosmos_endpoint: str, cosmos_database: str, cosmos_container: str, session_id: str, user_id: str, credential: Any = None, connection_string: Optional[str] = None, ttl: Optional[int] = None, cosmos_client_kwargs: Optional[dict] = None)[source]¶

Chat message history backed by Azure CosmosDB.

Initializes a new instance of the CosmosDBChatMessageHistory class.

Make sure to call prepare_cosmos or use the context manager to make sure your database is ready.

Either a credential or a connection string must be provided.

Parameters

  • cosmos_endpoint – The connection endpoint for the Azure Cosmos DB account.

  • cosmos_database – The name of the database to use.

  • cosmos_container – The name of the container to use.

  • session_id – The session ID to use, can be overwritten while loading.

  • user_id – The user ID to use, can be overwritten while loading.

  • credential – The credential to use to authenticate to Azure Cosmos DB.

  • connection_string – The connection string to use to authenticate.

  • ttl – The time to live (in seconds) to use for documents in the container.

  • cosmos_client_kwargs – Additional kwargs to pass to the CosmosClient.

Attributes

messages

A list of Messages stored in-memory.

Methods

__init__(cosmos_endpoint, cosmos_database, ...)

Initializes a new instance of the CosmosDBChatMessageHistory class.

add_ai_message(message)

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

add_message(message)

Add a self-created message to the store

add_user_message(message)

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

clear()

Clear session memory from this memory and cosmos.

load_messages()

Retrieve the messages from Cosmos

prepare_cosmos()

Prepare the CosmosDB client.

upsert_messages()

Update the cosmosdb item.
__init__(cosmos_endpoint: str, cosmos_database: str, cosmos_container: str, session_id: str, user_id: str, credential: Any = None, connection_string: Optional[str] = None, ttl: Optional[int] = None, cosmos_client_kwargs: Optional[dict] = None)[source]¶

Initializes a new instance of the CosmosDBChatMessageHistory class.

Make sure to call prepare_cosmos or use the context manager to make sure your database is ready.

Either a credential or a connection string must be provided.

Parameters

  • cosmos_endpoint – The connection endpoint for the Azure Cosmos DB account.

  • cosmos_database – The name of the database to use.

  • cosmos_container – The name of the container to use.

  • session_id – The session ID to use, can be overwritten while loading.

  • user_id – The user ID to use, can be overwritten while loading.

  • credential – The credential to use to authenticate to Azure Cosmos DB.

  • connection_string – The connection string to use to authenticate.

  • ttl – The time to live (in seconds) to use for documents in the container.

  • cosmos_client_kwargs – Additional kwargs to pass to the CosmosClient.

add_ai_message(message: str) → None¶

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

Parameters

message – The string contents of an AI message.

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

Add a self-created message to the store

add_user_message(message: str) → None¶

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

Parameters

message – The string contents of a human message.

clear() → None[source]¶

Clear session memory from this memory and cosmos.

load_messages() → None[source]¶

Retrieve the messages from Cosmos

prepare_cosmos() → None[source]¶

Prepare the CosmosDB client.

Use this function or the context manager to make sure your database is ready.

upsert_messages() → None[source]¶

Update the cosmosdb item.