@getzep/zep-cloud 3.9.0 → 3.12.0

package/reference.md

@@ -1,5 +1,327 @@
 # Reference
 
+## Context
+
+<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">listContextTemplates</a>() -> Zep.ListContextTemplatesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists all context templates.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.context.listContextTemplates();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `Context.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">createContextTemplate</a>({ ...params }) -> Zep.ContextTemplateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new context template.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.context.createContextTemplate({
+    template: "template",
+    templateId: "template_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Zep.CreateContextTemplateRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Context.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">getContextTemplate</a>(templateId) -> Zep.ContextTemplateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Retrieves a context template by template_id.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.context.getContextTemplate("template_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**templateId:** `string` — Template ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Context.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">updateContextTemplate</a>(templateId, { ...params }) -> Zep.ContextTemplateResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates an existing context template by template_id.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.context.updateContextTemplate("template_id", {
+    template: "template",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**templateId:** `string` — Template ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Zep.UpdateContextTemplateRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Context.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.context.<a href="/src/api/resources/context/client/Client.ts">deleteContextTemplate</a>(templateId) -> Zep.SuccessResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes a context template by template_id.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.context.deleteContextTemplate("template_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**templateId:** `string` — Template ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Context.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Graph
 
 <details><summary><code>client.graph.<a href="/src/api/resources/graph/client/Client.ts">listEntityTypes</a>({ ...params }) -> Zep.EntityTypeResponse</code></summary>
@@ -30,7 +352,10 @@ Returns all entity types for a project, user, or graph.
 <dd>
 
 ```typescript
-await client.graph.listEntityTypes();
+await client.graph.listEntityTypes({
+    userId: "user_id",
+    graphId: "graph_id",
+});
 ```
 
 </dd>
@@ -487,7 +812,10 @@ Returns all graphs. In order to list users, use user.list_ordered instead
 <dd>
 
 ```typescript
-await client.graph.listAll();
+await client.graph.listAll({
+    pageNumber: 1,
+    pageSize: 1,
+});
 ```
 
 </dd>
@@ -871,7 +1199,12 @@ Returns all threads.
 <dd>
 
 ```typescript
-await client.thread.listAll();
+await client.thread.listAll({
+    pageNumber: 1,
+    pageSize: 1,
+    orderBy: "order_by",
+    asc: true,
+});
 ```
 
 </dd>
@@ -1063,7 +1396,11 @@ Returns most relevant context from the user graph (including memory from any/all
 <dd>
 
 ```typescript
-await client.thread.getUserContext("threadId");
+await client.thread.getUserContext("threadId", {
+    minRating: 1.1,
+    templateId: "template_id",
+    mode: "basic",
+});
 ```
 
 </dd>
@@ -1134,7 +1471,11 @@ Returns messages for a thread.
 <dd>
 
 ```typescript
-await client.thread.get("threadId");
+await client.thread.get("threadId", {
+    limit: 1,
+    cursor: 1,
+    lastn: 1,
+});
 ```
 
 </dd>
@@ -1335,6 +1676,204 @@ await client.thread.addMessagesBatch("threadId", {
 
 ## User
 
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">listUserSummaryInstructions</a>({ ...params }) -> Zep.ListUserInstructionsResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Lists all user summary instructions for a project, user.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.user.listUserSummaryInstructions({
+    userId: "user_id",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Zep.UserListUserSummaryInstructionsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `User.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">addUserSummaryInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds new summary instructions for users graphs without removing existing ones. If user_ids is empty, adds to project-wide default instructions.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.user.addUserSummaryInstructions({
+    instructions: [
+        {
+            name: "name",
+            text: "text",
+        },
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Zep.AddUserInstructionsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `User.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">deleteUserSummaryInstructions</a>({ ...params }) -> Zep.SuccessResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Deletes user summary/instructions for users or project wide defaults.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.user.deleteUserSummaryInstructions();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Zep.DeleteUserInstructionsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `User.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">add</a>({ ...params }) -> Zep.User</code></summary>
 <dl>
 <dd>
@@ -1428,7 +1967,10 @@ Returns all users.
 <dd>
 
 ```typescript
-await client.user.listOrdered();
+await client.user.listOrdered({
+    pageNumber: 1,
+    pageSize: 1,
+});
 ```
 
 </dd>
@@ -2149,7 +2691,9 @@ Returns episodes by graph id.
 <dd>
 
 ```typescript
-await client.graph.episode.getByGraphId("graph_id");
+await client.graph.episode.getByGraphId("graph_id", {
+    lastn: 1,
+});
 ```
 
 </dd>
@@ -2220,7 +2764,9 @@ Returns episodes by user id.
 <dd>
 
 ```typescript
-await client.graph.episode.getByUserId("user_id");
+await client.graph.episode.getByUserId("user_id", {
+    lastn: 1,
+});
 ```
 
 </dd>