@getzep/zep-cloud 1.0.4 → 1.0.5

package/serialization/resources/memory/client/requests/ExtractDataRequest.js

@@ -0,0 +1,36 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractDataRequest = void 0;
+const core = __importStar(require("../../../../../core"));
+exports.ExtractDataRequest = core.serialization.object({
+    currentDateTime: core.serialization.property("current_date_time", core.serialization.string().optional()),
+    lastN: core.serialization.property("last_n", core.serialization.number()),
+    modelSchema: core.serialization.property("model_schema", core.serialization.string()),
+    validate: core.serialization.boolean().optional(),
+});

package/serialization/resources/memory/client/requests/index.d.ts

@@ -3,6 +3,7 @@ export { EndSessionsRequest } from "./EndSessionsRequest";
 export { SessionSearchQuery } from "./SessionSearchQuery";
 export { UpdateSessionRequest } from "./UpdateSessionRequest";
 export { EndSessionRequest } from "./EndSessionRequest";
+export { ExtractDataRequest } from "./ExtractDataRequest";
 export { AddMemoryRequest } from "./AddMemoryRequest";
 export { ModelsMessageMetadataUpdate } from "./ModelsMessageMetadataUpdate";
 export { MemorySearchPayload } from "./MemorySearchPayload";

package/serialization/resources/memory/client/requests/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MemorySearchPayload = exports.ModelsMessageMetadataUpdate = exports.AddMemoryRequest = exports.EndSessionRequest = exports.UpdateSessionRequest = exports.SessionSearchQuery = exports.EndSessionsRequest = exports.CreateSessionRequest = void 0;
+exports.MemorySearchPayload = exports.ModelsMessageMetadataUpdate = exports.AddMemoryRequest = exports.ExtractDataRequest = exports.EndSessionRequest = exports.UpdateSessionRequest = exports.SessionSearchQuery = exports.EndSessionsRequest = exports.CreateSessionRequest = void 0;
 var CreateSessionRequest_1 = require("./CreateSessionRequest");
 Object.defineProperty(exports, "CreateSessionRequest", { enumerable: true, get: function () { return CreateSessionRequest_1.CreateSessionRequest; } });
 var EndSessionsRequest_1 = require("./EndSessionsRequest");
@@ -11,6 +11,8 @@ var UpdateSessionRequest_1 = require("./UpdateSessionRequest");
 Object.defineProperty(exports, "UpdateSessionRequest", { enumerable: true, get: function () { return UpdateSessionRequest_1.UpdateSessionRequest; } });
 var EndSessionRequest_1 = require("./EndSessionRequest");
 Object.defineProperty(exports, "EndSessionRequest", { enumerable: true, get: function () { return EndSessionRequest_1.EndSessionRequest; } });
+var ExtractDataRequest_1 = require("./ExtractDataRequest");
+Object.defineProperty(exports, "ExtractDataRequest", { enumerable: true, get: function () { return ExtractDataRequest_1.ExtractDataRequest; } });
 var AddMemoryRequest_1 = require("./AddMemoryRequest");
 Object.defineProperty(exports, "AddMemoryRequest", { enumerable: true, get: function () { return AddMemoryRequest_1.AddMemoryRequest; } });
 var ModelsMessageMetadataUpdate_1 = require("./ModelsMessageMetadataUpdate");

package/serialization/types/Fact.d.ts

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

package/serialization/types/Fact.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Fact = void 0;
+const core = __importStar(require("../../core"));
+exports.Fact = core.serialization.object({
+    createdAt: core.serialization.property("created_at", core.serialization.string().optional()),
+    fact: core.serialization.string().optional(),
+    uuid: core.serialization.string().optional(),
+});

package/serialization/types/SearchScope.d.ts

@@ -6,5 +6,5 @@ import * as Zep from "../../api/index";
 import * as core from "../../core";
 export declare const SearchScope: core.serialization.Schema<serializers.SearchScope.Raw, Zep.SearchScope>;
 export declare namespace SearchScope {
-    type Raw = "messages" | "summary";
+    type Raw = "messages" | "summary" | "facts";
 }

package/serialization/types/SearchScope.js

@@ -28,4 +28,4 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SearchScope = void 0;
 const core = __importStar(require("../../core"));
-exports.SearchScope = core.serialization.enum_(["messages", "summary"]);
+exports.SearchScope = core.serialization.enum_(["messages", "summary", "facts"]);

package/serialization/types/Session.d.ts

@@ -11,6 +11,7 @@ export declare namespace Session {
         created_at?: string | null;
         deleted_at?: string | null;
         ended_at?: string | null;
+        fact_version_uuid?: string | null;
         facts?: string[] | null;
         id?: number | null;
         metadata?: Record<string, unknown> | null;

package/serialization/types/Session.js

@@ -33,6 +33,7 @@ exports.Session = core.serialization.object({
     createdAt: core.serialization.property("created_at", core.serialization.string().optional()),
     deletedAt: core.serialization.property("deleted_at", core.serialization.string().optional()),
     endedAt: core.serialization.property("ended_at", core.serialization.string().optional()),
+    factVersionUuid: core.serialization.property("fact_version_uuid", core.serialization.string().optional()),
     facts: core.serialization.list(core.serialization.string()).optional(),
     id: core.serialization.number().optional(),
     metadata: core.serialization.record(core.serialization.string(), core.serialization.unknown()).optional(),

package/serialization/types/SessionSearchResult.d.ts

@@ -4,11 +4,13 @@
 import * as serializers from "../index";
 import * as Zep from "../../api/index";
 import * as core from "../../core";
+import { Fact } from "./Fact";
 import { Message } from "./Message";
 import { Summary } from "./Summary";
 export declare const SessionSearchResult: core.serialization.ObjectSchema<serializers.SessionSearchResult.Raw, Zep.SessionSearchResult>;
 export declare namespace SessionSearchResult {
     interface Raw {
+        fact?: Fact.Raw | null;
         message?: Message.Raw | null;
         score?: number | null;
         session_id?: string | null;

package/serialization/types/SessionSearchResult.js

@@ -28,9 +28,11 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SessionSearchResult = void 0;
 const core = __importStar(require("../../core"));
+const Fact_1 = require("./Fact");
 const Message_1 = require("./Message");
 const Summary_1 = require("./Summary");
 exports.SessionSearchResult = core.serialization.object({
+    fact: Fact_1.Fact.optional(),
     message: Message_1.Message.optional(),
     score: core.serialization.number().optional(),
     sessionId: core.serialization.property("session_id", core.serialization.string().optional()),

package/serialization/types/index.d.ts

@@ -8,6 +8,7 @@ export * from "./DocumentSearchResult";
 export * from "./DocumentSearchResultPage";
 export * from "./EndSessionResponse";
 export * from "./EndSessionsResponse";
+export * from "./Fact";
 export * from "./Memory";
 export * from "./MemorySearchResult";
 export * from "./Message";

package/serialization/types/index.js

@@ -24,6 +24,7 @@ __exportStar(require("./DocumentSearchResult"), exports);
 __exportStar(require("./DocumentSearchResultPage"), exports);
 __exportStar(require("./EndSessionResponse"), exports);
 __exportStar(require("./EndSessionsResponse"), exports);
+__exportStar(require("./Fact"), exports);
 __exportStar(require("./Memory"), exports);
 __exportStar(require("./MemorySearchResult"), exports);
 __exportStar(require("./Message"), exports);

package/wrapper/index.d.ts

@@ -1,3 +1,5 @@
 import { ZepClient as BaseClient } from "../Client";
+import { Memory } from "./memory";
 export declare class ZepClient extends BaseClient {
+    get memory(): Memory;
 }

package/wrapper/index.js

@@ -2,6 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZepClient = void 0;
 const Client_1 = require("../Client");
+const memory_1 = require("./memory");
 class ZepClient extends Client_1.ZepClient {
+    get memory() {
+        return new memory_1.Memory(this._options);
+    }
 }
 exports.ZepClient = ZepClient;

package/wrapper/memory.d.ts

@@ -0,0 +1,35 @@
+import { Memory as BaseMemory } from "../api/resources/memory/client/Client";
+import { ExtractDataRequest } from "../api";
+import { schemas, SupportedZepField } from "../extractor";
+export declare class Memory extends BaseMemory {
+    /**
+     * Extracts data based on a given schema and session details, transforms it according to the defined Zod schemas, and returns the transformed results.
+     *
+     * This method parses the provided schema against defined Zod validation rules, sends a request to extract data, and then transforms
+     * the extracted data according to the schema's specified ZepDataType.
+     *
+     * @template T - A record type where each key corresponds to a field name and its value is an object specifying `zep_type` and `description`.
+     * @param {string} sessionId - The session identifier for which data needs to be extracted.
+     * @param {T} schema - An object mapping each field to its corresponding ZepDataType and description. Each field should use one of the predefined methods from `zepFields` to ensure it conforms to the expected data type and structure.
+     * @param {Omit<ExtractDataRequest, "modelSchema">} params - Additional parameters for the extraction request excluding the model schema.
+     * @param {BaseMemory.RequestOptions} [requestOptions] - Optional additional request options.
+     * @returns {Promise<Record<string, any>>} A promise that resolves to an object where each key corresponds to the original schema's keys and their parsed values from the extraction.
+     *
+     * @example
+     * const result = await client.memory.extract(
+     *     session_id,
+     *     {
+     *         shoeSize: zepFields.number("The Customer's shoe size"),
+     *         budget: zepFields.number("The Customer's budget for shoe purchase"),
+     *         favoriteBrand: zepFields.text("The Customer's favorite shoe brand. Just one brand, please!"),
+     *         conversationDate: zepFields.date("The date of the conversation. Use current date if not present"),
+     *         conversationDateTime: zepFields.dateTime("The date time of the conversation."),
+     *         formattedPrice: zepFields.regex("The formatted price of the shoe", /\$\d+\.\d{2}/),
+     *     },
+     *     { lastN: 20, validate: false, currentDateTime: new Date().toISOString() }
+     * );
+     */
+    extract<T extends Record<string, SupportedZepField>>(sessionId: string, schema: T, params: Omit<ExtractDataRequest, "modelSchema">, requestOptions?: BaseMemory.RequestOptions): Promise<{
+        [K in keyof T]: ReturnType<typeof schemas[T[K]["zep_type"]]["parse"]>["value"];
+    }>;
+}

package/wrapper/memory.js

@@ -0,0 +1,59 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Memory = void 0;
+const Client_1 = require("../api/resources/memory/client/Client");
+const extractor_1 = require("../extractor");
+class Memory extends Client_1.Memory {
+    /**
+     * Extracts data based on a given schema and session details, transforms it according to the defined Zod schemas, and returns the transformed results.
+     *
+     * This method parses the provided schema against defined Zod validation rules, sends a request to extract data, and then transforms
+     * the extracted data according to the schema's specified ZepDataType.
+     *
+     * @template T - A record type where each key corresponds to a field name and its value is an object specifying `zep_type` and `description`.
+     * @param {string} sessionId - The session identifier for which data needs to be extracted.
+     * @param {T} schema - An object mapping each field to its corresponding ZepDataType and description. Each field should use one of the predefined methods from `zepFields` to ensure it conforms to the expected data type and structure.
+     * @param {Omit<ExtractDataRequest, "modelSchema">} params - Additional parameters for the extraction request excluding the model schema.
+     * @param {BaseMemory.RequestOptions} [requestOptions] - Optional additional request options.
+     * @returns {Promise<Record<string, any>>} A promise that resolves to an object where each key corresponds to the original schema's keys and their parsed values from the extraction.
+     *
+     * @example
+     * const result = await client.memory.extract(
+     *     session_id,
+     *     {
+     *         shoeSize: zepFields.number("The Customer's shoe size"),
+     *         budget: zepFields.number("The Customer's budget for shoe purchase"),
+     *         favoriteBrand: zepFields.text("The Customer's favorite shoe brand. Just one brand, please!"),
+     *         conversationDate: zepFields.date("The date of the conversation. Use current date if not present"),
+     *         conversationDateTime: zepFields.dateTime("The date time of the conversation."),
+     *         formattedPrice: zepFields.regex("The formatted price of the shoe", /\$\d+\.\d{2}/),
+     *     },
+     *     { lastN: 20, validate: false, currentDateTime: new Date().toISOString() }
+     * );
+     */
+    extract(sessionId, schema, params, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const validatedData = extractor_1.DataExtractorFields.parse(schema);
+            const result = yield this.extractData(sessionId, Object.assign(Object.assign({}, params), { modelSchema: JSON.stringify({ properties: validatedData }) }), requestOptions);
+            const transformedResult = {};
+            for (const key in schema) {
+                const schemaItem = extractor_1.schemas[schema[key].zep_type];
+                if (!schemaItem) {
+                    throw new Error(`Unsupported zep_type: ${schema[key].zep_type}`);
+                }
+                transformedResult[key] = schemaItem.parse(Object.assign(Object.assign({}, schema[key]), { value: result[key] })).value;
+            }
+            return transformedResult;
+        });
+    }
+}
+exports.Memory = Memory;