ElasticsearchChatMessageHistory#

class langchain_community.chat_message_histories.elasticsearch.ElasticsearchChatMessageHistory(index: str, session_id: str, *, es_connection: Elasticsearch | None = None, es_url: str | None = None, es_cloud_id: str | None = None, es_user: str | None = None, es_api_key: str | None = None, es_password: str | None = None, ensure_ascii: bool | None = True)[source]#

Deprecated since version 0.0.27: Use Use langchain-elasticsearch package instead.

Chat message history that stores history in Elasticsearch.

Parameters:

  • es_url (str | None) – URL of the Elasticsearch instance to connect to.

  • es_cloud_id (str | None) – Cloud ID of the Elasticsearch instance to connect to.

  • es_user (str | None) – Username to use when connecting to Elasticsearch.

  • es_password (str | None) – Password to use when connecting to Elasticsearch.

  • es_api_key (str | None) – API key to use when connecting to Elasticsearch.

  • es_connection (Elasticsearch | None) – Optional pre-existing Elasticsearch connection.

  • ensure_ascii (bool | None) – Used to escape ASCII symbols in json.dumps. Defaults to True.

  • index (str) – Name of the index to use.

  • session_id (str) – Arbitrary key that is used to store the messages of a single chat session.

Attributes

messages

Retrieve the messages from Elasticsearch

Methods

__init__(index, session_id, *[, ...])

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)

Add a message to the chat session in Elasticsearch

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

Clear session memory in Elasticsearch

connect_to_elasticsearch(*[, es_url, ...])

get_user_agent()

__init__(index: str, session_id: str, *, es_connection: Elasticsearch | None = None, es_url: str | None = None, es_cloud_id: str | None = None, es_user: str | None = None, es_api_key: str | None = None, es_password: str | None = None, ensure_ascii: bool | None = True)[source]#
Parameters:

  • index (str) –

  • session_id (str) –

  • es_connection (Elasticsearch | None) –

  • es_url (str | None) –

  • es_cloud_id (str | None) –

  • es_user (str | None) –

  • es_api_key (str | None) –

  • es_password (str | None) –

  • ensure_ascii (bool | 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: 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 (AIMessage | str) – The AI message to add.

Return type:

None

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

Add a message to the chat session in Elasticsearch

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: 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 (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]#

Clear session memory in Elasticsearch

Return type:

None

static connect_to_elasticsearch(*, es_url: str | None = None, cloud_id: str | None = None, api_key: str | None = None, username: str | None = None, password: str | None = None) → Elasticsearch[source]#
Parameters:

  • es_url (str | None) –

  • cloud_id (str | None) –

  • api_key (str | None) –

  • username (str | None) –

  • password (str | None) –

Return type:

Elasticsearch

static get_user_agent() → str[source]#
Return type:

str

Examples using ElasticsearchChatMessageHistory

On this page