Neo4jChatMessageHistory#

class langchain_neo4j.chat_message_histories.neo4j.Neo4jChatMessageHistory(session_id: str | int, url: str | None = None, username: str | None = None, password: str | None = None, database: str = 'neo4j', node_label: str = 'Session', window: int = 3, *, graph: Neo4jGraph | None = None)[source]#

Chat message history stored in a Neo4j database.

Attributes

messages

Retrieve the messages from Neo4j

Methods

__init__(session_id[, url, username, ...])

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 record in Neo4j

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 from Neo4j
Parameters:

  • session_id (str | int)

  • url (str | None)

  • username (str | None)

  • password (str | None)

  • database (str)

  • node_label (str)

  • window (int)

  • graph (Neo4jGraph | None)

__init__(session_id: str | int, url: str | None = None, username: str | None = None, password: str | None = None, database: str = 'neo4j', node_label: str = 'Session', window: int = 3, *, graph: Neo4jGraph | None = None)[source]#
Parameters:

  • session_id (str | int)

  • url (str | None)

  • username (str | None)

  • password (str | None)

  • database (str)

  • node_label (str)

  • window (int)

  • graph (Neo4jGraph | 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]#

Append the message to the record in Neo4j

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 from Neo4j

Return type:

None

Examples using Neo4jChatMessageHistory