@getzep/zep-cloud 3.0.2 → 3.0.3

package/errors/ZepError.d.ts

@@ -0,0 +1,15 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as core from "../core/index.js";
+export declare class ZepError extends Error {
+    readonly statusCode?: number;
+    readonly body?: unknown;
+    readonly rawResponse?: core.RawResponse;
+    constructor({ message, statusCode, body, rawResponse, }: {
+        message?: string;
+        statusCode?: number;
+        body?: unknown;
+        rawResponse?: core.RawResponse;
+    });
+}

package/errors/ZepError.js

@@ -0,0 +1,30 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZepError = void 0;
+const json_js_1 = require("../core/json.js");
+class ZepError extends Error {
+    constructor({ message, statusCode, body, rawResponse, }) {
+        super(buildMessage({ message, statusCode, body }));
+        Object.setPrototypeOf(this, ZepError.prototype);
+        this.statusCode = statusCode;
+        this.body = body;
+        this.rawResponse = rawResponse;
+    }
+}
+exports.ZepError = ZepError;
+function buildMessage({ message, statusCode, body, }) {
+    let lines = [];
+    if (message != null) {
+        lines.push(message);
+    }
+    if (statusCode != null) {
+        lines.push(`Status code: ${statusCode.toString()}`);
+    }
+    if (body != null) {
+        lines.push(`Body: ${(0, json_js_1.toJson)(body, undefined, 2)}`);
+    }
+    return lines.join("\n");
+}

package/errors/ZepTimeoutError.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZepTimeoutError = void 0;
+class ZepTimeoutError extends Error {
+    constructor(message) {
+        super(message);
+        Object.setPrototypeOf(this, ZepTimeoutError.prototype);
+    }
+}
+exports.ZepTimeoutError = ZepTimeoutError;

package/errors/index.d.ts

@@ -0,0 +1,2 @@
+export { ZepError } from "./ZepError.js";
+export { ZepTimeoutError } from "./ZepTimeoutError.js";

package/errors/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZepTimeoutError = exports.ZepError = void 0;
+var ZepError_js_1 = require("./ZepError.js");
+Object.defineProperty(exports, "ZepError", { enumerable: true, get: function () { return ZepError_js_1.ZepError; } });
+var ZepTimeoutError_js_1 = require("./ZepTimeoutError.js");
+Object.defineProperty(exports, "ZepTimeoutError", { enumerable: true, get: function () { return ZepTimeoutError_js_1.ZepTimeoutError; } });

package/examples/graph/conversations.ts

@@ -0,0 +1,297 @@
+import { RoleType } from "../../src/api/";
+
+export const history: {
+    name: string;
+    role: RoleType;
+    content: string;
+}[][] = [
+        // Conversation 1: Japan
+        [
+            {
+                name: "Paul",
+                role: "user",
+                content: "Hi, I'm planning a vacation to Japan. Can you give me some advice?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Of course! Japan is a fascinating destination. Are you more interested in modern cities like Tokyo, or historical sites like Kyoto?",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "I think I'd like to experience both. Can you suggest an itinerary?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Certainly! You could start with 3 days in Tokyo, then take the bullet train to Kyoto for 3 days. This way, you'll experience both the modern and traditional aspects of Japan.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "That sounds perfect! What are some must-visit places in Tokyo?",
+            },
+        ],
+        // Conversation 2: Italy
+        [
+            {
+                name: "Paul",
+                role: "user",
+                content: "I'm thinking about visiting Italy next summer. Any recommendations?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Italy is a wonderful choice! Are you more interested in art and history, or would you prefer to focus on food and wine experiences?",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "I love both, but I think I'm leaning towards the food and wine experiences.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Great! In that case, you might want to consider regions like Tuscany or Emilia-Romagna. Would you like more information about these areas?",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "Yes, please tell me more about Tuscany. What are some must-try dishes and wines there?",
+            },
+        ],
+        [
+            {
+                name: "Paul",
+                role: "user",
+                content: "Apples are my favorite fruit",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "now bananas are my favorite fruit",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "Eric Clapton is my favorite guitarist",
+            },
+        ],
+        // Conversation 3: US Road Trip
+        [
+            {
+                name: "Paul",
+                role: "user",
+                content: "I'm thinking about taking a road trip across the United States. Any suggestions?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "That sounds exciting! A cross-country road trip can be an amazing experience. Do you have any specific regions or landmarks you'd like to see?",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "I'd love to see some national parks and maybe hit a few major cities. I'm starting from New York.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Great! How about a route that takes you through some major cities and national parks? We could plan a route from New York to California, hitting spots like Chicago, Yellowstone, and the Grand Canyon along the way.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "That sounds perfect! How long do you think a trip like that would take?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "A trip like that could take anywhere from 2-4 weeks, depending on how much time you want to spend at each location. Would you prefer a faster-paced trip or a more leisurely one?",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "I think I'd prefer a more leisurely pace. Let's aim for about 3 weeks. Can you break down a potential itinerary?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Certainly! Here's a rough 3-week itinerary: Days 1-2: New York to Chicago, Days 3-4: Chicago, Days 5-7: Drive to and explore Yellowstone, Days 8-10: Drive to and explore Grand Canyon, Days 11-13: Las Vegas and Death Valley, Days 14-16: Drive to and explore Yosemite, Days 17-19: San Francisco, Days 20-21: Drive down the Pacific Coast Highway to Los Angeles.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "That sounds amazing! What kind of vehicle would you recommend for a trip like this?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "For a long road trip like this, comfort and reliability are key. A mid-size SUV could be a good choice. It offers space for luggage, comfort for long drives, and can handle various road conditions you might encounter in national parks.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "Good idea. Are there any specific preparations I should make for the national parks?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Absolutely! For national parks, it's a good idea to get an America the Beautiful Pass, which covers entrance fees to all national parks for a year. Also, make reservations for campsites or lodges well in advance, especially for popular parks like Yellowstone and Yosemite.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "Great tip about the pass! What about food? Should I plan to cook or eat out mostly?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "A mix of both can be good. In cities, you'll want to try local cuisines. For national parks, having some cooking equipment can save money and be convenient. Maybe plan to cook simple meals while camping and eat out in cities or when you want to treat yourself.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "That makes sense. Are there any must-try foods in the cities we'll be visiting?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Absolutely! In Chicago, try deep-dish pizza and a Chicago-style hot dog. In San Francisco, don't miss the clam chowder in a sourdough bread bowl at Fisherman's Wharf. Las Vegas has world-class restaurants from celebrity chefs. And in Los Angeles, try some authentic tacos or Korean BBQ.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "Yum! Now, what about budgeting? How much should I expect to spend on a trip like this?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Budget can vary widely, but for a 3-week trip, you might budget around $4000-$6000 for one person. This would cover gas, accommodations, food, and some activities. You can save by camping in national parks and cooking some meals, or spend more for hotels and restaurants.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "That's helpful, thanks. Last question: what are some essential items I shouldn't forget to pack?",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Great question! Don't forget: a good map or GPS, first-aid kit, flashlight, multi-tool, reusable water bottles, sunscreen, insect repellent, comfortable hiking shoes, and layers of clothing for various climates. Also, a camera to capture memories, and portable chargers for your devices.",
+            },
+            {
+                name: "Paul",
+                role: "user",
+                content: "Perfect, I think I'm all set to start planning in detail. Thanks for all your help!",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "You're welcome, Paul! Enjoy your epic road trip across the US. Don't hesitate to ask if you need any more advice as you plan. Safe travels!",
+            },
+        ],
+        // Conversation 4: Alex's personal information
+        [
+            {
+                name: "Alex",
+                role: "user",
+                content: "Hi there! I thought I'd share some facts about myself today.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "That's great, Alex! I'd love to learn more about you. Please, go ahead and share whatever you're comfortable with.",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "Well, I'm 28 years old and I work as a software engineer at a tech startup.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "That's interesting! Software engineering is a dynamic field. How long have you been working in this role?",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "I've been in this role for about 3 years now. Before that, I studied Computer Science at UCLA.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "UCLA is a great school! Do you have any hobbies or interests outside of work?",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "Yes, I'm really into rock climbing. I try to go to the climbing gym at least twice a week, and I love outdoor climbing trips when I can manage them.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Rock climbing sounds exciting! It's a great way to stay active and challenge yourself. Have you been on any memorable climbing trips recently?",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "Actually, yes! I just got back from a trip to Joshua Tree National Park. The rock formations there are amazing for bouldering.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Joshua Tree is beautiful! It's wonderful that you can combine your love for the outdoors with your hobby. Do you have any other interests or things you're passionate about?",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "I'm also really into cooking. I love trying out new recipes, especially dishes from different cultures. Last week, I attempted to make sushi for the first time!",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Cooking is a great skill to have! How did your sushi-making attempt go? It can be quite challenging for beginners.",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "It was definitely a learning experience! The rolls weren't as tight as I'd like, but the flavor was good. I'm determined to keep practicing.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "That's a great attitude! Practice makes perfect. Is there anything else you'd like to share about yourself?",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "Well, I'm originally from Boston, but I moved to San Francisco for work about 5 years ago. I love the tech scene here, but I do miss the changing seasons back east.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Moving across the country is a big change! San Francisco and Boston are quite different. Do you get to visit your hometown often?",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "I try to go back for the holidays each year. Oh, and I should mention, I have a rescue dog named Pixel. She's a mix of who-knows-what, but she's the best companion I could ask for.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "Pixel sounds lovely! Rescue dogs often make the most loyal companions. Does she join you on any of your outdoor adventures?",
+            },
+            {
+                name: "Alex",
+                role: "user",
+                content: "She does! Pixel loves hiking, and she's even been camping with me a few times. She's not much for rock climbing though - she prefers to watch from the ground.",
+            },
+            {
+                name: "assistant",
+                role: "assistant",
+                content: "It's great that you and Pixel can share outdoor experiences together. Thank you for sharing all these interesting facts about yourself, Alex. You seem to lead a rich and varied life!",
+            },
+        ],
+    ];

package/examples/graph/entity_type_example.ts

@@ -0,0 +1,44 @@
+import { ZepClient } from "../../src";
+import { EntityData, entityFields, EntityType, EdgeType } from "../../src/wrapper/ontology";
+
+const API_KEY = process.env.ZEP_API_KEY;
+
+async function main() {
+    const client = new ZepClient({
+        apiKey: API_KEY,
+    });
+
+    const travelDestinationSchema: EntityType = {
+        description: "A travel destination entity",
+        fields: {
+            destination_name: entityFields.text("The name of travel destination"),
+        },
+    };
+
+    type TravelDestination = EntityData<typeof travelDestinationSchema>;
+
+    const isTravelingTo: EdgeType = {
+        description: "An edge representing a traveler going to a destination.",
+        fields: {
+            travel_date: entityFields.text("The date of the travel"),
+            purpose: entityFields.text("The purpose of the travel"),
+        },
+        sourceTargets: [
+            {
+                source: "User",
+                target: "TravelDestination",
+            }
+        ]
+    }
+
+    await client.graph.setEntityTypes({
+        TravelDestination: travelDestinationSchema,
+    }, {
+        IS_TRAVELING_TO: isTravelingTo,
+    });
+
+    const customTypes = await client.graph.listEntityTypes();
+    console.log(JSON.stringify(customTypes, null, 2));
+}
+
+main().catch(console.error);

package/examples/graph/graph_example.ts

@@ -0,0 +1,61 @@
+import { v4 as uuidv4 } from 'uuid';
+import { ZepClient } from '../../src';
+
+const API_KEY = process.env.ZEP_API_KEY;
+
+async function main() {
+    const client = new ZepClient({
+        apiKey: API_KEY,
+    });
+
+    const graphId = uuidv4();
+    console.log(`Creating graph ${graphId}...`);
+    const graph = await client.graph.create({
+        graphId: graphId,
+        name: "My graph",
+        description: "This is my graph",
+    });
+    console.log(`graph ${graphId} created`, graph);
+
+    console.log(`Adding episode to graph ${graphId}...`);
+    await client.graph.add({
+        graphId: graphId,
+        type: "text",
+        data: "This is a test episode",
+    });
+
+    console.log(`Adding more meaningful episode to graph ${graphId}...`);
+    await client.graph.add({
+        graphId: graphId,
+        type: "text",
+        data: "Eric Clapton is a rock star",
+    });
+
+    console.log(`Adding a JSON episode to graph ${graphId}...`);
+    const jsonString = '{"name": "Eric Clapton", "age": 78, "genre": "Rock"}';
+    await client.graph.add({
+        graphId: graphId,
+        type: "json",
+        data: jsonString,
+    });
+
+    console.log("Waiting for the graph to be updated...");
+    await new Promise(resolve => setTimeout(resolve, 10000));
+
+    console.log(`Getting nodes from graph ${graphId}...`);
+    const nodes = await client.graph.node.getByGraphId(graphId, {limit: 10});
+    console.log(`Nodes from graph ${graphId}`, nodes);
+
+    console.log(`Getting edges from graph ${graphId}...`);
+    const edges = await client.graph.edge.getByGraphId(graphId, {limit: 10});
+    console.log(`Edges from graph ${graphId}`, edges);
+
+    console.log(`Searching graph ${graphId}...`);
+    const searchResults = await client.graph.search({
+        graphId: graphId,
+        query: "Eric Clapton",
+    });
+    console.log(`Search results from graph ${graphId}`, searchResults);
+}
+
+main().catch(console.error);

package/examples/graph/user_graph_example.ts

@@ -0,0 +1,160 @@
+import { v4 as uuidv4 } from 'uuid';
+import { ZepClient } from '../../src';
+import { CreateUserRequest } from '../../src/api';
+
+// @ts-ignore
+import { history } from './conversations';
+
+const API_KEY = process.env.ZEP_API_KEY
+
+async function main() {
+    const client = new ZepClient({
+        apiKey: API_KEY,
+    });
+
+    const userId = uuidv4();
+    const threadId = uuidv4();
+
+    // Create a user
+    const userRequest: CreateUserRequest = {
+        userId: userId,
+        firstName: 'Paul',
+    };
+    await client.user.add(userRequest);
+    console.log(`User ${userId} created`);
+
+    // Create a thread
+    await client.thread.create({
+        threadId: threadId,
+        userId: userId,
+    });
+    console.log(`thread ${threadId} created`);
+
+    // Add messages to the thread
+    for (const message of history[2]) {
+        await client.thread.addMessages(threadId, {
+            messages: [
+                {
+                    role: message.role,
+                    name: message.name,
+                    content: message.content,
+                },
+            ],
+        });
+    }
+
+    console.log("Waiting for the graph to be updated...");
+    await new Promise(resolve => setTimeout(resolve, 10000));
+
+    console.log("Getting memory for thread");
+    const threadMemory = await client.thread.getUserContext(threadId);
+    console.log(threadMemory);
+
+    console.log("Getting episodes for user");
+    const episodeResult = await client.graph.episode.getByUserId(userId, { lastn: 3 });
+    const episodes = episodeResult.episodes;
+    console.log(`Episodes for user ${userId}:`);
+    console.log(episodes);
+
+    if (episodes && episodes.length > 0) {
+        const episode = await client.graph.episode.get(episodes[0].uuid!);
+        console.log(episode);
+    }
+
+    const edges = await client.graph.edge.getByUserId(userId, { limit: 10 });
+    console.log(`Edges for user ${userId}:`);
+    console.log(edges);
+
+    if (edges && edges.length > 0) {
+        const edge = await client.graph.edge.get(edges[0].uuid);
+        console.log(edge);
+    }
+
+    const nodes = await client.graph.node.getByUserId(userId, { limit: 10 });
+    console.log(`Nodes for user ${userId}:`);
+    console.log(nodes);
+
+    if (nodes && nodes.length > 0) {
+        const node = await client.graph.node.get(nodes[0].uuid);
+        console.log(node);
+    }
+
+    console.log("Searching user graph memory...");
+    const graphSearchResults = await client.graph.search({
+        userId: userId,
+        query: "What is the weather in San Francisco?",
+    });
+    console.log(graphSearchResults.edges);
+
+    console.log("Adding a new text episode to the graph...");
+    await client.graph.add({
+        userId: userId,
+        type: "text",
+        data: "The user is an avid fan of Eric Clapton",
+    });
+    console.log("Text episode added");
+
+    console.log("Adding a new JSON episode to the graph...");
+    const jsonString = '{"name": "Eric Clapton", "age": 78, "genre": "Rock"}';
+    await client.graph.add({
+        userId: userId,
+        type: "json",
+        data: jsonString,
+    });
+    console.log("JSON episode added");
+
+    console.log("Adding a new message episode to the graph...");
+    const message = "Paul (user): I went to Eric Clapton concert last night";
+    await client.graph.add({
+        userId: userId,
+        type: "message",
+        data: message,
+    });
+    console.log("Message episode added");
+
+    console.log("Waiting for the graph to be updated...");
+    await new Promise(resolve => setTimeout(resolve, 30000));
+
+    console.log("Getting nodes from the graph...");
+    const updatedNodes = await client.graph.node.getByUserId(userId, { limit: 10 });
+    console.log(updatedNodes);
+
+    console.log("Finding Eric Clapton in the graph...");
+    const claptonNode = updatedNodes.find(node => node.name === "Eric Clapton");
+    console.log(claptonNode);
+
+    if (claptonNode) {
+        console.log("Performing Eric Clapton centered edge search...");
+        const edgeSearchResults = await client.graph.search({
+            userId: userId,
+            query: "Eric Clapton",
+            centerNodeUuid: claptonNode.uuid,
+            scope: "edges",
+        });
+        console.log(edgeSearchResults.edges);
+
+        console.log("Performing Eric Clapton centered node search...");
+        const nodeSearchResults = await client.graph.search({
+            userId: userId,
+            query: "Eric Clapton",
+            centerNodeUuid: claptonNode.uuid,
+            scope: "nodes",
+        });
+        console.log(nodeSearchResults.nodes);
+    }
+
+    const {node: userNode} = await client.user.getNode(userId)
+    if (userNode) {
+        console.log("User node: ", userNode)
+        const userCenteredSearch = await client.graph.search({
+            userId,
+            query: "User preferences",
+            centerNodeUuid: userNode.uuid,
+            reranker: "node_distance",
+        })
+        console.log("User centered search results", userCenteredSearch.edges)
+    }
+
+}
+
+main().catch(console.error);

package/examples/langgraph/.env.example

@@ -0,0 +1,7 @@
+# OpenAI API key for the language model
+OPENAI_API_KEY=your_openai_api_key_here
+
+# Tavily API key for web search functionality
+TAVILY_API_KEY=your_tavily_api_key_here
+# Zep API key for memory persistence
+ZEP_API_KEY=your_zep_api_key_here