@getzep/zep-cloud 3.15.0 → 3.17.0

package/reference.md

@@ -730,7 +730,7 @@ await client.graph.add({
 <dl>
 <dd>
 
-Add data to the graph in batch mode, processing episodes concurrently. Use only for data that is insensitive to processing order.
+Add data to the graph in batch mode. Episodes are processed sequentially in the order provided.
 
 </dd>
 </dl>
@@ -1013,6 +1013,8 @@ Returns all graphs. In order to list users, use user.list_ordered instead
 await client.graph.listAll({
     pageNumber: 1,
     pageSize: 1,
+    orderBy: "order_by",
+    asc: true,
 });
 ```
 
@@ -1048,6 +1050,70 @@ await client.graph.listAll({
 </dl>
 </details>
 
+<details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">detectPatterns</a>({ ...params }) -> Zep.DetectPatternsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Detects structural patterns in a knowledge graph including relationship frequencies,
+multi-hop paths, co-occurrences, hubs, and clusters.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.graph.detectPatterns();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Zep.DetectPatternsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Graph.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">search</a>({ ...params }) -> Zep.GraphSearchResults</code></summary>
 <dl>
 <dd>
@@ -1660,9 +1726,7 @@ Returns most relevant context from the user graph (including memory from any/all
 
 ```typescript
 await client.thread.getUserContext("threadId", {
-    minRating: 1.1,
     templateId: "template_id",
-    mode: "basic",
 });
 ```
 
@@ -2233,6 +2297,9 @@ Returns all users.
 await client.user.listOrdered({
     pageNumber: 1,
     pageSize: 1,
+    search: "search",
+    orderBy: "order_by",
+    asc: true,
 });
 ```
 
@@ -2924,6 +2991,77 @@ await client.graph.edge.delete("uuid");
 </dl>
 </details>
 
+<details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">update</a>(uuid, { ...params }) -> Zep.EntityEdge</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates an entity edge by UUID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.graph.edge.update("uuid");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**uuid:** `string` — Edge UUID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Zep.graph.UpdateEdgeRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Edge.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Graph Episode
 
 <details><summary><code>client.graph.episode.<a href="/src/api/resources/graph/resources/episode/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.EpisodeResponse</code></summary>
@@ -3657,6 +3795,77 @@ await client.graph.node.delete("uuid");
 </dl>
 </details>
 
+<details><summary><code>client.graph.node.<a href="/src/api/resources/graph/resources/node/client/Client.ts">update</a>(uuid, { ...params }) -> Zep.EntityNode</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates an entity node by UUID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.graph.node.update("uuid");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**uuid:** `string` — Node UUID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Zep.graph.UpdateNodeRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Node.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Thread Message
 
 <details><summary><code>client.thread.message.<a href="/src/api/resources/thread/resources/message/client/Client.ts">update</a>(messageUuid, { ...params }) -> Zep.Message</code></summary>

package/dist/cjs/api/resources/thread/types/ThreadGetUserContextRequestMode.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ThreadGetUserContextRequestMode = "basic" | "summary";
-export declare const ThreadGetUserContextRequestMode: {
-    readonly Basic: "basic";
-    readonly Summary: "summary";
-};

package/dist/cjs/api/resources/thread/types/ThreadGetUserContextRequestMode.js

@@ -1,10 +0,0 @@
-"use strict";
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ThreadGetUserContextRequestMode = void 0;
-exports.ThreadGetUserContextRequestMode = {
-    Basic: "basic",
-    Summary: "summary",
-};

package/dist/cjs/api/resources/thread/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./ThreadGetUserContextRequestMode.js";

package/dist/cjs/api/resources/thread/types/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ThreadGetUserContextRequestMode.js"), exports);

package/dist/cjs/api/types/FactRatingExamples.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface FactRatingExamples {
-    high?: string;
-    low?: string;
-    medium?: string;
-}

package/dist/cjs/api/types/FactRatingInstruction.d.ts

@@ -1,21 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Zep from "../index.js";
-export interface FactRatingInstruction {
-    /**
-     * Examples is a list of examples that demonstrate how facts might be rated based on your instruction. You should provide
-     * an example of a highly rated example, a low rated example, and a medium (or in between example). For example, if you are rating
-     * based on relevance to a trip planning application, your examples might be:
-     * High: "Joe's dream vacation is Bali"
-     * Medium: "Joe has a fear of flying",
-     * Low: "Joe's favorite food is Japanese",
-     */
-    examples?: Zep.FactRatingExamples;
-    /**
-     * A string describing how to rate facts as they apply to your application. A trip planning application may
-     * use something like "relevancy to planning a trip, the user's preferences when traveling,
-     * or the user's travel history."
-     */
-    instruction?: string;
-}

package/dist/cjs/api/types/ModelsFactRatingExamples.d.ts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ModelsFactRatingExamples {
-    high?: string;
-    low?: string;
-    medium?: string;
-}

package/dist/cjs/api/types/ModelsFactRatingInstruction.d.ts

@@ -1,21 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Zep from "../index.js";
-export interface ModelsFactRatingInstruction {
-    /**
-     * Examples is a list of examples that demonstrate how facts might be rated based on your instruction. You should provide
-     * an example of a highly rated example, a low rated example, and a medium (or in between example). For example, if you are rating
-     * based on relevance to a trip planning application, your examples might be:
-     * High: "Joe's dream vacation is Bali"
-     * Medium: "Joe has a fear of flying",
-     * Low: "Joe's favorite food is Japanese",
-     */
-    examples?: Zep.ModelsFactRatingExamples;
-    /**
-     * A string describing how to rate facts as they apply to your application. A trip planning application may
-     * use something like "relevancy to planning a trip, the user's preferences when traveling,
-     * or the user's travel history."
-     */
-    instruction?: string;
-}

package/dist/cjs/serialization/resources/thread/types/ThreadGetUserContextRequestMode.d.ts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../index.js";
-import * as Zep from "../../../../api/index.js";
-import * as core from "../../../../core/index.js";
-export declare const ThreadGetUserContextRequestMode: core.serialization.Schema<serializers.ThreadGetUserContextRequestMode.Raw, Zep.ThreadGetUserContextRequestMode>;
-export declare namespace ThreadGetUserContextRequestMode {
-    type Raw = "basic" | "summary";
-}

package/dist/cjs/serialization/resources/thread/types/index.d.ts

@@ -1 +0,0 @@
-export * from "./ThreadGetUserContextRequestMode.js";

package/dist/cjs/serialization/resources/thread/types/index.js

@@ -1,17 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ThreadGetUserContextRequestMode.js"), exports);

package/dist/cjs/serialization/types/FactRatingExamples.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index.js";
-import * as Zep from "../../api/index.js";
-import * as core from "../../core/index.js";
-export declare const FactRatingExamples: core.serialization.ObjectSchema<serializers.FactRatingExamples.Raw, Zep.FactRatingExamples>;
-export declare namespace FactRatingExamples {
-    interface Raw {
-        high?: string | null;
-        low?: string | null;
-        medium?: string | null;
-    }
-}

package/dist/cjs/serialization/types/FactRatingInstruction.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index.js";
-import * as Zep from "../../api/index.js";
-import * as core from "../../core/index.js";
-import { FactRatingExamples } from "./FactRatingExamples.js";
-export declare const FactRatingInstruction: core.serialization.ObjectSchema<serializers.FactRatingInstruction.Raw, Zep.FactRatingInstruction>;
-export declare namespace FactRatingInstruction {
-    interface Raw {
-        examples?: FactRatingExamples.Raw | null;
-        instruction?: string | null;
-    }
-}

package/dist/cjs/serialization/types/ModelsFactRatingExamples.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index.js";
-import * as Zep from "../../api/index.js";
-import * as core from "../../core/index.js";
-export declare const ModelsFactRatingExamples: core.serialization.ObjectSchema<serializers.ModelsFactRatingExamples.Raw, Zep.ModelsFactRatingExamples>;
-export declare namespace ModelsFactRatingExamples {
-    interface Raw {
-        high?: string | null;
-        low?: string | null;
-        medium?: string | null;
-    }
-}

package/dist/cjs/serialization/types/ModelsFactRatingInstruction.d.ts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index.js";
-import * as Zep from "../../api/index.js";
-import * as core from "../../core/index.js";
-import { ModelsFactRatingExamples } from "./ModelsFactRatingExamples.js";
-export declare const ModelsFactRatingInstruction: core.serialization.ObjectSchema<serializers.ModelsFactRatingInstruction.Raw, Zep.ModelsFactRatingInstruction>;
-export declare namespace ModelsFactRatingInstruction {
-    interface Raw {
-        examples?: ModelsFactRatingExamples.Raw | null;
-        instruction?: string | null;
-    }
-}

package/dist/esm/api/resources/thread/types/ThreadGetUserContextRequestMode.d.mts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export type ThreadGetUserContextRequestMode = "basic" | "summary";
-export declare const ThreadGetUserContextRequestMode: {
-    readonly Basic: "basic";
-    readonly Summary: "summary";
-};

package/dist/esm/api/resources/thread/types/ThreadGetUserContextRequestMode.mjs

@@ -1,7 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export const ThreadGetUserContextRequestMode = {
-    Basic: "basic",
-    Summary: "summary",
-};

package/dist/esm/api/resources/thread/types/index.d.mts

@@ -1 +0,0 @@
-export * from "./ThreadGetUserContextRequestMode.mjs";

package/dist/esm/api/resources/thread/types/index.mjs

@@ -1 +0,0 @@
-export * from "./ThreadGetUserContextRequestMode.mjs";

package/dist/esm/api/types/FactRatingExamples.d.mts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface FactRatingExamples {
-    high?: string;
-    low?: string;
-    medium?: string;
-}

package/dist/esm/api/types/FactRatingInstruction.d.mts

@@ -1,21 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Zep from "../index.mjs";
-export interface FactRatingInstruction {
-    /**
-     * Examples is a list of examples that demonstrate how facts might be rated based on your instruction. You should provide
-     * an example of a highly rated example, a low rated example, and a medium (or in between example). For example, if you are rating
-     * based on relevance to a trip planning application, your examples might be:
-     * High: "Joe's dream vacation is Bali"
-     * Medium: "Joe has a fear of flying",
-     * Low: "Joe's favorite food is Japanese",
-     */
-    examples?: Zep.FactRatingExamples;
-    /**
-     * A string describing how to rate facts as they apply to your application. A trip planning application may
-     * use something like "relevancy to planning a trip, the user's preferences when traveling,
-     * or the user's travel history."
-     */
-    instruction?: string;
-}

package/dist/esm/api/types/ModelsFactRatingExamples.d.mts

@@ -1,8 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-export interface ModelsFactRatingExamples {
-    high?: string;
-    low?: string;
-    medium?: string;
-}

package/dist/esm/api/types/ModelsFactRatingInstruction.d.mts

@@ -1,21 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as Zep from "../index.mjs";
-export interface ModelsFactRatingInstruction {
-    /**
-     * Examples is a list of examples that demonstrate how facts might be rated based on your instruction. You should provide
-     * an example of a highly rated example, a low rated example, and a medium (or in between example). For example, if you are rating
-     * based on relevance to a trip planning application, your examples might be:
-     * High: "Joe's dream vacation is Bali"
-     * Medium: "Joe has a fear of flying",
-     * Low: "Joe's favorite food is Japanese",
-     */
-    examples?: Zep.ModelsFactRatingExamples;
-    /**
-     * A string describing how to rate facts as they apply to your application. A trip planning application may
-     * use something like "relevancy to planning a trip, the user's preferences when traveling,
-     * or the user's travel history."
-     */
-    instruction?: string;
-}

package/dist/esm/serialization/resources/thread/types/ThreadGetUserContextRequestMode.d.mts

@@ -1,10 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../../../index.mjs";
-import * as Zep from "../../../../api/index.mjs";
-import * as core from "../../../../core/index.mjs";
-export declare const ThreadGetUserContextRequestMode: core.serialization.Schema<serializers.ThreadGetUserContextRequestMode.Raw, Zep.ThreadGetUserContextRequestMode>;
-export declare namespace ThreadGetUserContextRequestMode {
-    type Raw = "basic" | "summary";
-}

package/dist/esm/serialization/resources/thread/types/ThreadGetUserContextRequestMode.mjs

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as core from "../../../../core/index.mjs";
-export const ThreadGetUserContextRequestMode = core.serialization.enum_(["basic", "summary"]);

package/dist/esm/serialization/resources/thread/types/index.d.mts

@@ -1 +0,0 @@
-export * from "./ThreadGetUserContextRequestMode.mjs";

package/dist/esm/serialization/resources/thread/types/index.mjs

@@ -1 +0,0 @@
-export * from "./ThreadGetUserContextRequestMode.mjs";

package/dist/esm/serialization/types/FactRatingExamples.d.mts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index.mjs";
-import * as Zep from "../../api/index.mjs";
-import * as core from "../../core/index.mjs";
-export declare const FactRatingExamples: core.serialization.ObjectSchema<serializers.FactRatingExamples.Raw, Zep.FactRatingExamples>;
-export declare namespace FactRatingExamples {
-    interface Raw {
-        high?: string | null;
-        low?: string | null;
-        medium?: string | null;
-    }
-}

package/dist/esm/serialization/types/FactRatingExamples.mjs

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as core from "../../core/index.mjs";
-export const FactRatingExamples = core.serialization.object({
-    high: core.serialization.string().optional(),
-    low: core.serialization.string().optional(),
-    medium: core.serialization.string().optional(),
-});

package/dist/esm/serialization/types/FactRatingInstruction.d.mts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index.mjs";
-import * as Zep from "../../api/index.mjs";
-import * as core from "../../core/index.mjs";
-import { FactRatingExamples } from "./FactRatingExamples.mjs";
-export declare const FactRatingInstruction: core.serialization.ObjectSchema<serializers.FactRatingInstruction.Raw, Zep.FactRatingInstruction>;
-export declare namespace FactRatingInstruction {
-    interface Raw {
-        examples?: FactRatingExamples.Raw | null;
-        instruction?: string | null;
-    }
-}

package/dist/esm/serialization/types/FactRatingInstruction.mjs

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as core from "../../core/index.mjs";
-import { FactRatingExamples } from "./FactRatingExamples.mjs";
-export const FactRatingInstruction = core.serialization.object({
-    examples: FactRatingExamples.optional(),
-    instruction: core.serialization.string().optional(),
-});

package/dist/esm/serialization/types/ModelsFactRatingExamples.d.mts

@@ -1,14 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as serializers from "../index.mjs";
-import * as Zep from "../../api/index.mjs";
-import * as core from "../../core/index.mjs";
-export declare const ModelsFactRatingExamples: core.serialization.ObjectSchema<serializers.ModelsFactRatingExamples.Raw, Zep.ModelsFactRatingExamples>;
-export declare namespace ModelsFactRatingExamples {
-    interface Raw {
-        high?: string | null;
-        low?: string | null;
-        medium?: string | null;
-    }
-}

package/dist/esm/serialization/types/ModelsFactRatingExamples.mjs

@@ -1,9 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as core from "../../core/index.mjs";
-export const ModelsFactRatingExamples = core.serialization.object({
-    high: core.serialization.string().optional(),
-    low: core.serialization.string().optional(),
-    medium: core.serialization.string().optional(),
-});