Quickstart

1
import os
2
from zep_cloud.client import Zep
3
4
API_KEY = os.environ.get('ZEP_API_KEY')
5
6
client = Zep(
7
    api_key=API_KEY,
8
)

1
# Create a new user
2
user_id = "user123"
3
new_user = client.user.add(
4
    user_id=user_id,
5
    email="[email protected]",
6
    first_name="Jane",
7
    last_name="Smith",
8
)

1
import uuid
2
3
# Generate a unique session ID
4
session_id = uuid.uuid4().hex
5
6
# Create a new session for the user
7
client.memory.add_session(
8
    session_id=session_id,
9
    user_id=user_id,
10
)

1
# Define messages to add
2
from zep_cloud.types import Message
3
4
messages = [
5
    Message(
6
        role="Jane",
7
        content="Hi, my name is Jane Smith and I work at Acme Corp.",
8
        role_type="user",
9
    ),
10
    Message(
11
        role="AI Assistant",
12
        content="Hello Jane! Nice to meet you. How can I help you with Acme Corp today?",
13
        role_type="assistant",
14
    )
15
]
16
17
# Add messages to the session
18
client.memory.add(session_id, messages=messages)

1
# Get memory for the session
2
memory = client.memory.get(session_id=session_id)
3
4
# Access the context string (for use in prompts)
5
context_string = memory.context
6
print(context_string)
7
8
# Access recent messages
9
recent_messages = memory.messages
10
for msg in recent_messages:
11
    print(f"{msg.role}: {msg.content}")

1
# Add text data to a user's graph
2
new_episode = client.graph.add(
3
    user_id=user_id,
4
    type="text",
5
    data="Jane Smith is a senior software engineer who has been with Acme Corp for 5 years."
6
)
7
print("New episode created:", new_episode)
8
# Add JSON data to a user's graph
9
import json
10
json_data = {
11
    "employee": {
12
        "name": "Jane Smith",
13
        "position": "Senior Software Engineer",
14
        "department": "Engineering",
15
        "projects": ["Project Alpha", "Project Beta"]
16
    }
17
}
18
client.graph.add(
19
    user_id=user_id,
20
    type="json",
21
    data=json.dumps(json_data)
22
)
23
24
# Add data to a group graph (shared across users)
25
group_id = "engineering_team"
26
client.graph.add(
27
    group_id=group_id,
28
    type="text",
29
    data="The engineering team is working on Project Alpha and Project Beta."
30
)

1
# Search for edges in a user's graph
2
edge_results = client.graph.search(
3
    user_id=user_id,
4
    query="What projects is Jane working on?",
5
    scope="edges",  # Default is "edges"
6
    limit=5
7
)
8
9
# Search for nodes in a user's graph
10
node_results = client.graph.search(
11
    user_id=user_id,
12
    query="Jane Smith",
13
    scope="nodes",
14
    limit=5
15
)
16
17
# Search in a group graph
18
group_results = client.graph.search(
19
    group_id=group_id,
20
    query="Project Alpha",
21
    scope="edges",
22
    limit=5
23
)