Skip to main content

Zep stores, manages, enriches, indexes, and searches long-term memory for conversational AI applications. This is the Python client for the Zep service.

Project description

Tests lint Release to PyPI GitHub

Zep: A long-term memory store for conversational AI applications

This is the Python client package for the Zep service. For more information about Zep, see https://github.com/getzep/zep.

Zep documentation: https://getzep.github.io

Installation

pip install zep-python

or

poetry add zep-python

Quick Start

Ensure that you have a Zep server running. See https://github.com/getzep/zep.

import asyncio

from zep_python import Memory, Message, SearchPayload, ZepClient

base_url = "http://localhost:8000"  # TODO: Replace with Zep API URL
session_id = "2a2a2a" # an identifier for your user's session.

async with ZepClient(base_url) as client:

    role = "user"
    content = "who was the first man to go to space?"
    message = Message(role=role, content=content)
    memory = Memory()
    memory.messages = [message]
    # Add a memory
    result = await client.aadd_memory(session_id, memory)

    # Long chat histories will automatically be summarized.
    # A summary and chat history are returned with a `get_memory`
    memory = await client.aget_memory(session_id)
    for message in memory.messages:
         print(message.to_dict())

    # Search memory
    # Messages uploaded to Zep are automatically embedded and made available
    # for vector-based similarity search.
    search_payload = SearchPayload("Who is Yuri Gagarin?")
    search_results = await client.asearch_memory(session_id, search_payload)
    for search_result in search_results:
        # Access the 'content' field within the 'message' object.
        message_content = search_result.message
        print(message_content)

Server Installation and SDK Documentation

Server installation documentation and more available here: https://getzep.github.io

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

zep_python-0.3.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

zep_python-0.3.0-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file zep_python-0.3.0.tar.gz.

File metadata

  • Download URL: zep_python-0.3.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for zep_python-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3440a761fa856b2666eef0f2eaa8a70ea040028b848a48f95d672ebbc4d2d120
MD5 42b5113b8874888a5b640ea4994a367f
BLAKE2b-256 f458d2df906a039e7b6cf6fca95207e01857ac113c734325b5b95b53193a6d11

See more details on using hashes here.

File details

Details for the file zep_python-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: zep_python-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/4.0.1 CPython/3.11.3

File hashes

Hashes for zep_python-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e2993c55594d37b05014ca7a54d3a7b7a62244acf44f6c30ade749e140170a28
MD5 fe799cb999fac4f1d3d527266e368a39
BLAKE2b-256 924515244b49c2a9eb5033ea8d34991dd720bfa7fed1dac59d8e638de4427fae

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page