langchain.memory.chat_message_histories.rocksetdb
.RocksetChatMessageHistory¶
- class langchain.memory.chat_message_histories.rocksetdb.RocksetChatMessageHistory(session_id: str, client: ~typing.Any, collection: str, workspace: str = 'commons', messages_key: str = 'messages', sync: bool = False, message_uuid_method: ~typing.Callable[[], ~typing.Union[str, int]] = <function RocksetChatMessageHistory.<lambda>>)[source]¶
Uses Rockset to store chat messages.
To use, ensure that the rockset python package installed.
Example
from langchain.memory.chat_message_histories import ( RocksetChatMessageHistory ) from rockset import RocksetClient history = RocksetChatMessageHistory( session_id="MySession", client=RocksetClient(), collection="langchain_demo", sync=True ) history.add_user_message("hi!") history.add_ai_message("whats up?") print(history.messages)
Constructs a new RocksetChatMessageHistory.
- Parameters
session_id (-) – The ID of the chat session
client (-) – The RocksetClient object to use to query
collection (-) – The name of the collection to use to store chat messages. If a collection with the given name does not exist in the workspace, it is created.
workspace (-) – The workspace containing collection. Defaults to “commons”
messages_key (-) – The DB column containing message history. Defaults to “messages”
sync (-) – Whether to wait for messages to be added. Defaults to False. NOTE: setting this to True will slow down performance.
message_uuid_method (-) – The method that generates message IDs. If set, all messages will have an id field within the additional_kwargs property. If this param is not set and sync is False, message IDs will not be created. If this param is not set and sync is True, the uuid.uuid4 method will be used to create message IDs.
Attributes
ADD_TIMEOUT_MS
CREATE_TIMEOUT_MS
SLEEP_INTERVAL_MS
messages
Messages in this chat history.
Methods
__init__
(session_id, client, collection[, ...])Constructs a new RocksetChatMessageHistory.
add_ai_message
(message)Convenience method for adding an AI message string to the store.
add_message
(message)Add a Message object to the history.
add_user_message
(message)Convenience method for adding a human message string to the store.
clear
()Removes all messages from the chat history
- __init__(session_id: str, client: ~typing.Any, collection: str, workspace: str = 'commons', messages_key: str = 'messages', sync: bool = False, message_uuid_method: ~typing.Callable[[], ~typing.Union[str, int]] = <function RocksetChatMessageHistory.<lambda>>) None [source]¶
Constructs a new RocksetChatMessageHistory.
- Parameters
session_id (-) – The ID of the chat session
client (-) – The RocksetClient object to use to query
collection (-) – The name of the collection to use to store chat messages. If a collection with the given name does not exist in the workspace, it is created.
workspace (-) – The workspace containing collection. Defaults to “commons”
messages_key (-) – The DB column containing message history. Defaults to “messages”
sync (-) – Whether to wait for messages to be added. Defaults to False. NOTE: setting this to True will slow down performance.
message_uuid_method (-) – The method that generates message IDs. If set, all messages will have an id field within the additional_kwargs property. If this param is not set and sync is False, message IDs will not be created. If this param is not set and sync is True, the uuid.uuid4 method will be used to create message IDs.
- 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 Message object to the history.
- Parameters
message – A BaseMessage object to 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.