Adding Data to the Graph

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 Session’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 either a user graph by providing a user_id, or to a group graph by specifying a group_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 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 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,
12
    type="json",
13
    data=json_string,
14
)

Adding Custom Fact/Node Triplets

You can also add manually specified fact/node triplets to the graph. You need only specify the fact, the target node name, and the source node name. Zep will then create a new corresponding edge and nodes, or use an existing edge/nodes if they exist and seem to represent the same nodes or edge you send as input. And if this new fact invalidates an existing fact, it will mark the existing fact as invalid and add the new fact triplet.

1
from zep_cloud.client import Zep
2
3
client = Zep(
4
    api_key=API_KEY,
5
)
6
7
client.graph.add_fact_triple(
8
    user_id=user_id,
9
    fact="Paul met Eric",
10
    fact_name="MET",
11
    target_node_name="Eric Clapton",
12
    source_node_name="Paul",
13
)

You can also specify the node summaries, edge temporal data, and UUIDs. See the associated SDK reference.

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.