@getzep/zep-cloud 3.10.0 → 3.13.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>
@@ -295,6 +620,7 @@ Add a fact triple for a user or group
 await client.graph.addFactTriple({
     fact: "fact",
     factName: "fact_name",
+    sourceNodeName: "source_node_name",
     targetNodeName: "target_node_name",
 });
 ```
@@ -487,7 +813,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>
@@ -841,6 +1170,71 @@ await client.project.get();
 </dl>
 </details>
 
+## Task
+
+<details><summary><code>client.task.<a href="/src/api/resources/task/client/Client.ts">get</a>(taskId) -> Zep.GetTaskResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets a task by its ID
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.task.get("task_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**taskId:** `string` — Task ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `Task.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Thread
 
 <details><summary><code>client.thread.<a href="/src/api/resources/thread/client/Client.ts">listAll</a>({ ...params }) -> Zep.ThreadListResponse</code></summary>
@@ -871,7 +1265,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 +1462,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 +1537,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>
@@ -1363,7 +1770,9 @@ Lists all user summary instructions for a project, user.
 <dd>
 
 ```typescript
-await client.user.listUserSummaryInstructions();
+await client.user.listUserSummaryInstructions({
+    userId: "user_id",
+});
 ```
 
 </dd>
@@ -1624,7 +2033,10 @@ Returns all users.
 <dd>
 
 ```typescript
-await client.user.listOrdered();
+await client.user.listOrdered({
+    pageNumber: 1,
+    pageSize: 1,
+});
 ```
 
 </dd>
@@ -2345,7 +2757,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>
@@ -2416,7 +2830,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>