Adding Business Data

Overview

In addition to incorporating memory through chat history, Zep offers the capability to add data directly to the graph. Zep supports three distinct data types: message, text, and JSON.

The message type is ideal for adding data in the form of chat messages that are not directly associated with a Zep Thread’s chat history. This encompasses any communication with a designated speaker, such as emails or previous chat logs.

The text type is designed for raw text data without a specific speaker attribution. This category includes content from internal documents, wiki articles, or company handbooks. It’s important to note that Zep does not process text directly from links or files.

The JSON type may be used to add any JSON document to Zep. This may include REST API responses or JSON-formatted business data.

You can add data to a graph by specifying a graph_id, or to a user graph by providing a user_id.

Adding Message Data

Here’s an example demonstrating how to add message data to the graph:

1
from zep_cloud.client import Zep
2
3
client = Zep(
4
    api_key=API_KEY,
5
)
6
7
message = "Paul (user): I went to Eric Clapton concert last night"
8
9
new_episode = client.graph.add(
10
    user_id="user123",    # Optional: You can use graph_id instead of user_id
11
    type="message",       # Specify type as "message"
12
    data=message
13
)

Adding Text Data

Here’s an example demonstrating how to add text data to the graph:

1
from zep_cloud.client import Zep
2
3
client = Zep(
4
    api_key=API_KEY,
5
)
6
7
new_episode = client.graph.add(
8
    user_id="user123",  # Optional: You can use graph_id instead of user_id
9
    type="text",        # Specify type as "text"
10
    data="The user is an avid fan of Eric Clapton"
11
)

Adding JSON Data

Here’s an example demonstrating how to add JSON data to the graph:

1
from zep_cloud.client import Zep
2
import json
3
4
client = Zep(
5
    api_key=API_KEY,
6
)
7
8
json_data = {"name": "Eric Clapton", "age": 78, "genre": "Rock"}
9
json_string = json.dumps(json_data)
10
new_episode = client.graph.add(
11
    user_id=user_id,  # Optional: You can use graph_id instead of user_id
12
    type="json",
13
    data=json_string,
14
)

Data Size Limit and Chunking

The graph.add endpoint has a data size limit of 10,000 characters when adding data to the graph. If you need to add a document which is more than 10,000 characters, we recommend chunking the document as well as using Anthropic’s contextualized retrieval technique. We have an example of this here. This example uses Graphiti, but the same patterns apply to Zep as well.

Additionally, we recommend using relatively small chunk sizes, so that Zep is able to capture all of the entities and relationships within a chunk. Using a larger chunk size may result in some entities and relationships not being captured.

Managing Your Data on the Graph

The graph.add method returns the episode that was created in the graph from adding that data. You can use this to maintain a mapping between your data and its corresponding episode in the graph and to delete specific data from the graph using the delete episode method.