@getzep/zep-cloud 3.4.0 → 3.5.0

package/dist/cjs/Client.js

@@ -47,8 +47,8 @@ class ZepClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_js_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "zep-cloud",
-                "X-Fern-SDK-Version": "3.4.0",
-                "User-Agent": "zep-cloud/3.4.0",
+                "X-Fern-SDK-Version": "3.5.0",
+                "User-Agent": "zep-cloud/3.5.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/cjs/api/resources/thread/client/Client.d.ts

@@ -74,9 +74,9 @@ export declare class Thread {
     delete(threadId: string, requestOptions?: Thread.RequestOptions): core.HttpResponsePromise<Zep.SuccessResponse>;
     private __delete;
     /**
-     * Returns most relevant context for a given thread.
+     * Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
      *
-     * @param {string} threadId - The ID of the thread for which to retrieve context.
+     * @param {string} threadId - The ID of the current thread (for which context is being retrieved).
      * @param {Zep.ThreadGetUserContextRequest} request
      * @param {Thread.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/thread/client/Client.js

@@ -324,9 +324,9 @@ class Thread {
         });
     }
     /**
-     * Returns most relevant context for a given thread.
+     * Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
      *
-     * @param {string} threadId - The ID of the thread for which to retrieve context.
+     * @param {string} threadId - The ID of the current thread (for which context is being retrieved).
      * @param {Zep.ThreadGetUserContextRequest} request
      * @param {Thread.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/cjs/api/resources/user/client/Client.d.ts

@@ -129,6 +129,20 @@ export declare class User {
      */
     getThreads(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Zep.Thread[]>;
     private __getThreads;
+    /**
+     * Hints Zep to warm a user's graph for low-latency search
+     *
+     * @param {string} userId - User ID
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.user.warm("userId")
+     */
+    warm(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Zep.SuccessResponse>;
+    private __warm;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string;
     }>;

package/dist/cjs/api/resources/user/client/Client.js

@@ -647,6 +647,87 @@ class User {
             }
         });
     }
+    /**
+     * Hints Zep to warm a user's graph for low-latency search
+     *
+     * @param {string} userId - User ID
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.user.warm("userId")
+     */
+    warm(userId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__warm(userId, requestOptions));
+    }
+    __warm(userId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ZepEnvironment.Default, `users/${encodeURIComponent(userId)}/warm`),
+                method: "GET",
+                headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.SuccessResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.ZepError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ZepError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ZepTimeoutError("Timeout exceeded when calling GET /users/{userId}/warm.");
+                case "unknown":
+                    throw new errors.ZepError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;

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

@@ -11,6 +11,6 @@ export interface AddThreadMessagesRequest {
     ignoreRoles?: Zep.RoleType[];
     /** A list of message objects, where each message contains a role and content. */
     messages: Zep.Message[];
-    /** Optionally return memory context relevant to the most recent messages. */
+    /** Optionally return context block relevant to the most recent messages. */
     returnContext?: boolean;
 }

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

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ThreadContextResponse {
-    /** Memory context containing relevant facts and entities for the session. Can be put into the prompt directly. */
+    /** Context block containing relevant facts, entities, and messages/episodes from the user graph. Meant to be replaced in the system prompt on every chat turn. */
     context?: string;
 }

package/dist/cjs/version.d.ts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.4.0";
+export declare const SDK_VERSION = "3.5.0";

package/dist/cjs/version.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SDK_VERSION = void 0;
-exports.SDK_VERSION = "3.4.0";
+exports.SDK_VERSION = "3.5.0";

package/dist/esm/Client.mjs

@@ -11,8 +11,8 @@ export class ZepClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: mergeHeaders({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "zep-cloud",
-                "X-Fern-SDK-Version": "3.4.0",
-                "User-Agent": "zep-cloud/3.4.0",
+                "X-Fern-SDK-Version": "3.5.0",
+                "User-Agent": "zep-cloud/3.5.0",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/esm/api/resources/thread/client/Client.d.mts

@@ -74,9 +74,9 @@ export declare class Thread {
     delete(threadId: string, requestOptions?: Thread.RequestOptions): core.HttpResponsePromise<Zep.SuccessResponse>;
     private __delete;
     /**
-     * Returns most relevant context for a given thread.
+     * Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
      *
-     * @param {string} threadId - The ID of the thread for which to retrieve context.
+     * @param {string} threadId - The ID of the current thread (for which context is being retrieved).
      * @param {Zep.ThreadGetUserContextRequest} request
      * @param {Thread.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/esm/api/resources/thread/client/Client.mjs

@@ -288,9 +288,9 @@ export class Thread {
         });
     }
     /**
-     * Returns most relevant context for a given thread.
+     * Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
      *
-     * @param {string} threadId - The ID of the thread for which to retrieve context.
+     * @param {string} threadId - The ID of the current thread (for which context is being retrieved).
      * @param {Zep.ThreadGetUserContextRequest} request
      * @param {Thread.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/esm/api/resources/user/client/Client.d.mts

@@ -129,6 +129,20 @@ export declare class User {
      */
     getThreads(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Zep.Thread[]>;
     private __getThreads;
+    /**
+     * Hints Zep to warm a user's graph for low-latency search
+     *
+     * @param {string} userId - User ID
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.user.warm("userId")
+     */
+    warm(userId: string, requestOptions?: User.RequestOptions): core.HttpResponsePromise<Zep.SuccessResponse>;
+    private __warm;
     protected _getCustomAuthorizationHeaders(): Promise<{
         Authorization: string;
     }>;

package/dist/esm/api/resources/user/client/Client.mjs

@@ -611,6 +611,87 @@ export class User {
             }
         });
     }
+    /**
+     * Hints Zep to warm a user's graph for low-latency search
+     *
+     * @param {string} userId - User ID
+     * @param {User.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.user.warm("userId")
+     */
+    warm(userId, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__warm(userId, requestOptions));
+    }
+    __warm(userId, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a, _b, _c, _d;
+            const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ZepEnvironment.Default, `users/${encodeURIComponent(userId)}/warm`),
+                method: "GET",
+                headers: mergeHeaders((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, mergeOnlyDefinedHeaders(Object.assign({}, (yield this._getCustomAuthorizationHeaders()))), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
+                timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
+                maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
+                abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
+            });
+            if (_response.ok) {
+                return {
+                    data: serializers.SuccessResponse.parseOrThrow(_response.body, {
+                        unrecognizedObjectKeys: "passthrough",
+                        allowUnrecognizedUnionMembers: true,
+                        allowUnrecognizedEnumValues: true,
+                        skipValidation: true,
+                        breadcrumbsPrefix: ["response"],
+                    }),
+                    rawResponse: _response.rawResponse,
+                };
+            }
+            if (_response.error.reason === "status-code") {
+                switch (_response.error.statusCode) {
+                    case 404:
+                        throw new Zep.NotFoundError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    case 500:
+                        throw new Zep.InternalServerError(serializers.ApiError.parseOrThrow(_response.error.body, {
+                            unrecognizedObjectKeys: "passthrough",
+                            allowUnrecognizedUnionMembers: true,
+                            allowUnrecognizedEnumValues: true,
+                            skipValidation: true,
+                            breadcrumbsPrefix: ["response"],
+                        }), _response.rawResponse);
+                    default:
+                        throw new errors.ZepError({
+                            statusCode: _response.error.statusCode,
+                            body: _response.error.body,
+                            rawResponse: _response.rawResponse,
+                        });
+                }
+            }
+            switch (_response.error.reason) {
+                case "non-json":
+                    throw new errors.ZepError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.rawBody,
+                        rawResponse: _response.rawResponse,
+                    });
+                case "timeout":
+                    throw new errors.ZepTimeoutError("Timeout exceeded when calling GET /users/{userId}/warm.");
+                case "unknown":
+                    throw new errors.ZepError({
+                        message: _response.error.errorMessage,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        });
+    }
     _getCustomAuthorizationHeaders() {
         return __awaiter(this, void 0, void 0, function* () {
             var _a;

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

@@ -11,6 +11,6 @@ export interface AddThreadMessagesRequest {
     ignoreRoles?: Zep.RoleType[];
     /** A list of message objects, where each message contains a role and content. */
     messages: Zep.Message[];
-    /** Optionally return memory context relevant to the most recent messages. */
+    /** Optionally return context block relevant to the most recent messages. */
     returnContext?: boolean;
 }

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

@@ -2,6 +2,6 @@
  * This file was auto-generated by Fern from our API Definition.
  */
 export interface ThreadContextResponse {
-    /** Memory context containing relevant facts and entities for the session. Can be put into the prompt directly. */
+    /** Context block containing relevant facts, entities, and messages/episodes from the user graph. Meant to be replaced in the system prompt on every chat turn. */
     context?: string;
 }

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "3.4.0";
+export declare const SDK_VERSION = "3.5.0";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "3.4.0";
+export const SDK_VERSION = "3.5.0";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@getzep/zep-cloud",
-    "version": "3.4.0",
+    "version": "3.5.0",
     "private": false,
     "repository": "https://github.com/getzep/zep-js",
     "description": "Zep: Fast, scalable building blocks for production LLM apps",

package/reference.md

@@ -990,7 +990,7 @@ await client.thread.delete("threadId");
 <dl>
 <dd>
 
-Returns most relevant context for a given thread.
+Returns most relevant context from the user graph (including memory from any/all past threads) based on the content of the past few messages of the given thread.
 
 </dd>
 </dl>
@@ -1022,7 +1022,7 @@ await client.thread.getUserContext("threadId");
 <dl>
 <dd>
 
-**threadId:** `string` — The ID of the thread for which to retrieve context.
+**threadId:** `string` — The ID of the current thread (for which context is being retrieved).
 
 </dd>
 </dl>
@@ -1729,6 +1729,69 @@ await client.user.getThreads("userId");
 </dl>
 </details>
 
+<details><summary><code>client.user.<a href="/src/api/resources/user/client/Client.ts">warm</a>(userId) -> Zep.SuccessResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Hints Zep to warm a user's graph for low-latency search
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.user.warm("userId");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**userId:** `string` — User ID
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `User.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Graph Edge
 
 <details><summary><code>client.graph.edge.<a href="/src/api/resources/graph/resources/edge/client/Client.ts">getByGraphId</a>(graphId, { ...params }) -> Zep.EntityEdge[]</code></summary>