Package to manage chat history using PostgreSQL.
Project description
Sinapsis Chat History
Package with templates to store in sql databases the history of AI agents: store, retrieve, and manage context across conversations.
🐍 Installation • 🚀 Features • 📚 Usage example • 📙 Documentation • 🔍 License
The sinapsis-chat-history module functionality to handle history and context, saving conversations in sql-databases.
🐍 Installation
Install using your package manager of choice. We encourage the use of uv
Example with uv:
uv pip install sinapsis-chat-history --extra-index-url https://pypi.sinapsis.tech
or with raw pip:
pip install sinapsis-chat-history --extra-index-url https://pypi.sinapsis.tech
[!IMPORTANT] Templates may require extra dependencies. For development, we recommend installing the package with all the optional dependencies:
with uv:
uv pip install sinapsis-chat-history[all] --extra-index-url https://pypi.sinapsis.tech
or with raw pip:
pip install sinapsis-chat-history[all] --extra-index-url https://pypi.sinapsis.tech
🚀 Features
Templates Supported
- ChatHistoryFetcher: Template for retrieving chat histories from a storage backend.
- ChatHistoryRemover: Template for deleting chat history records based on filters.
- ChatHistoryReset: Performs complete reset of chat history by dropping and recreating the table.
- ChatHistorySaver: Template for saving chat messages into the database.
[!TIP] Use CLI command
sinapsis info --all-template-namesto show a list with all the available Template names installed with Sinapsis Mem0.
[!TIP] Use CLI command
sinapsis info --example-template-config TEMPLATE_NAMEto produce an example Agent config for the Template specified in TEMPLATE_NAME.
For example, for Mem0Search use sinapsis info --example-template-config Mem0Search to produce the following example config:
agent:
name: my_test_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: TextInput
class_name: TextInput
template_input: InputTemplate
attributes:
text: "this is a test message"
id: "sinapsis-user"
source: "1"
- template_name : ChatHistorySaver
class_name: ChatHistorySaver
template_input: TextInput
attributes:
db_config:
db_name: "test"
table: "chat_messages2"
📚 Usage example
The following agent retrieves all entries in the database for the given user_id and session_id
Config
agent:
name: my_test_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: ChatHistoryRemover
class_name: ChatHistoryRemover
template_input: InputTemplate
attributes:
provider: postgres
db_config:
db_name: "test"
table: "chat_messages"
last_n: 10
filters:
user_id: Chatbot user
session_id: 3aa8d1a4-c8a7-4367-8b20-168351f76ab9
📙 Documentation
Documentation for this and other sinapsis packages is available on the sinapsis website
Tutorials for different projects within sinapsis are available at sinapsis tutorials page
🔍 License
This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.
For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file sinapsis_chat_history-0.1.6.tar.gz.
File metadata
- Download URL: sinapsis_chat_history-0.1.6.tar.gz
- Upload date:
- Size: 24.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52afd4e7b6ca95567a5800991aac35082f0ff4a32bc3033fa40a0c9ef72f50f4
|
|
| MD5 |
b5ac5cde9b2237a932b25398139b5eaf
|
|
| BLAKE2b-256 |
ec116ed82479b29afc99bc086ff83c991775e97b8aa2b9a872f40922d1a9497c
|
File details
Details for the file sinapsis_chat_history-0.1.6-py3-none-any.whl.
File metadata
- Download URL: sinapsis_chat_history-0.1.6-py3-none-any.whl
- Upload date:
- Size: 26.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.16
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52472f7e348a82cd73a20603f71a3e98f2dc9d8de41ff21bd43507aca77ba694
|
|
| MD5 |
d56a8f9104b5b880f41eebabc7eab54d
|
|
| BLAKE2b-256 |
63122e2784936a39303d67d5dffb417db2f667be5bb751e67bda5239410b3e8a
|