Sessions
Represent a conversation in Zep's Memory Store
You are viewing the Zep Open Source v0.x documentation. This version is no longer supported, and documentation is provided as a reference only.
The current documentation for Zep Community Edition is available here.
Sessions
represent a conversation. Sessions can be associated with Users
in a 1:M relationship.
Chat messages are added to sessions in the form of Memories
. Each session can have many messages associated with it.
The SessionID
is a string key that accepts arbitrary identifiers. Related data you’d like to store can be persisted as metadata.
Adding a Session
SessionIDs are arbitrary identifiers that you can map to relevant business objects in your app, such as users or a conversation a user might have with your app
Note: Sessions don’t need to be explicitly created. Sessions are created automatically when adding Memories. If the SessionID already exists, then the Memory is upserted into the Session. Manually creating a session can be useful if you want to associate it with a user or add metadata.
Python
TypeScript
Looking to associate a
Session
with aUser
? Check out our User Management docs.
Updating Session Metadata
You can update a session’s metadata by providing a Session object with new metadata. Note that metadata is merged, so any existing metadata will be preserved.
Python
TypeScript
Getting a Session
Python
TypeScript
Deleting a Session
Deleting a Session soft-deletes the Session and all associated Memories. The Session and Memories are still available in the database, but are marked as deleted and will not be returned in search results.
They will be purged on the next run of the Zep Purge Process.
If you persist memory to a deleted Session, it will be undeleted. Deleted Memories will, however, remain deleted.
Python
TypeScript
Listing Sessions
You can list all Sessions in the Zep Memory Store with optional limit and cursor parameters for pagination. We also provide a helper generator function making it simple to iterate over all Sessions.