@getzep/zep-cloud 2.7.0 → 2.9.0

package/dist/wrapper/ontology.d.ts

@@ -0,0 +1,312 @@
+import { z } from "zod";
+import { Zep } from "../index";
+export declare enum EntityPropertyType {
+    Text = "Text",
+    Int = "Int",
+    Float = "Float",
+    Boolean = "Boolean"
+}
+export declare const EntityTypeBaseField: z.ZodObject<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType;
+    description: string;
+}, {
+    type: EntityPropertyType;
+    description: string;
+}>;
+export interface EntityField<V = any> {
+    description: string;
+    value?: V;
+}
+export declare const EntityTypeTextFieldSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Text>;
+    value: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Text;
+    description: string;
+    value?: string | undefined;
+}, {
+    type: EntityPropertyType.Text;
+    description: string;
+    value?: string | undefined;
+}>;
+export type EntityTextField = z.infer<typeof EntityTypeTextFieldSchema>;
+export declare const EntityTypeIntFieldSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Int>;
+    value: z.ZodOptional<z.ZodNumber>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Int;
+    description: string;
+    value?: number | undefined;
+}, {
+    type: EntityPropertyType.Int;
+    description: string;
+    value?: number | undefined;
+}>;
+export type EntityIntField = z.infer<typeof EntityTypeIntFieldSchema>;
+export declare const EntityTypeFloatFieldSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Float>;
+    value: z.ZodOptional<z.ZodNumber>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Float;
+    description: string;
+    value?: number | undefined;
+}, {
+    type: EntityPropertyType.Float;
+    description: string;
+    value?: number | undefined;
+}>;
+export type EntityFloatField = z.infer<typeof EntityTypeFloatFieldSchema>;
+export declare const EntityTypeBooleanFieldSchema: z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Boolean>;
+    value: z.ZodOptional<z.ZodBoolean>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Boolean;
+    description: string;
+    value?: boolean | undefined;
+}, {
+    type: EntityPropertyType.Boolean;
+    description: string;
+    value?: boolean | undefined;
+}>;
+export type EntityBooleanField = z.infer<typeof EntityTypeBooleanFieldSchema>;
+export declare const EntityTypeFieldSchema: z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Text>;
+    value: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Text;
+    description: string;
+    value?: string | undefined;
+}, {
+    type: EntityPropertyType.Text;
+    description: string;
+    value?: string | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Int>;
+    value: z.ZodOptional<z.ZodNumber>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Int;
+    description: string;
+    value?: number | undefined;
+}, {
+    type: EntityPropertyType.Int;
+    description: string;
+    value?: number | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Float>;
+    value: z.ZodOptional<z.ZodNumber>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Float;
+    description: string;
+    value?: number | undefined;
+}, {
+    type: EntityPropertyType.Float;
+    description: string;
+    value?: number | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Boolean>;
+    value: z.ZodOptional<z.ZodBoolean>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Boolean;
+    description: string;
+    value?: boolean | undefined;
+}, {
+    type: EntityPropertyType.Boolean;
+    description: string;
+    value?: boolean | undefined;
+}>]>;
+export type SupportedEntityField = EntityTextField | EntityIntField | EntityFloatField | EntityBooleanField;
+export declare const EntityFields: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Text>;
+    value: z.ZodOptional<z.ZodString>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Text;
+    description: string;
+    value?: string | undefined;
+}, {
+    type: EntityPropertyType.Text;
+    description: string;
+    value?: string | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Int>;
+    value: z.ZodOptional<z.ZodNumber>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Int;
+    description: string;
+    value?: number | undefined;
+}, {
+    type: EntityPropertyType.Int;
+    description: string;
+    value?: number | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Float>;
+    value: z.ZodOptional<z.ZodNumber>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Float;
+    description: string;
+    value?: number | undefined;
+}, {
+    type: EntityPropertyType.Float;
+    description: string;
+    value?: number | undefined;
+}>, z.ZodObject<z.objectUtil.extendShape<{
+    type: z.ZodNativeEnum<typeof EntityPropertyType>;
+    description: z.ZodString;
+}, {
+    type: z.ZodLiteral<EntityPropertyType.Boolean>;
+    value: z.ZodOptional<z.ZodBoolean>;
+}>, "strip", z.ZodTypeAny, {
+    type: EntityPropertyType.Boolean;
+    description: string;
+    value?: boolean | undefined;
+}, {
+    type: EntityPropertyType.Boolean;
+    description: string;
+    value?: boolean | undefined;
+}>]>>;
+export declare const EntityTypeSchema: z.ZodObject<{
+    description: z.ZodDefault<z.ZodString>;
+    fields: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodObject<z.objectUtil.extendShape<{
+        type: z.ZodNativeEnum<typeof EntityPropertyType>;
+        description: z.ZodString;
+    }, {
+        type: z.ZodLiteral<EntityPropertyType.Text>;
+        value: z.ZodOptional<z.ZodString>;
+    }>, "strip", z.ZodTypeAny, {
+        type: EntityPropertyType.Text;
+        description: string;
+        value?: string | undefined;
+    }, {
+        type: EntityPropertyType.Text;
+        description: string;
+        value?: string | undefined;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        type: z.ZodNativeEnum<typeof EntityPropertyType>;
+        description: z.ZodString;
+    }, {
+        type: z.ZodLiteral<EntityPropertyType.Int>;
+        value: z.ZodOptional<z.ZodNumber>;
+    }>, "strip", z.ZodTypeAny, {
+        type: EntityPropertyType.Int;
+        description: string;
+        value?: number | undefined;
+    }, {
+        type: EntityPropertyType.Int;
+        description: string;
+        value?: number | undefined;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        type: z.ZodNativeEnum<typeof EntityPropertyType>;
+        description: z.ZodString;
+    }, {
+        type: z.ZodLiteral<EntityPropertyType.Float>;
+        value: z.ZodOptional<z.ZodNumber>;
+    }>, "strip", z.ZodTypeAny, {
+        type: EntityPropertyType.Float;
+        description: string;
+        value?: number | undefined;
+    }, {
+        type: EntityPropertyType.Float;
+        description: string;
+        value?: number | undefined;
+    }>, z.ZodObject<z.objectUtil.extendShape<{
+        type: z.ZodNativeEnum<typeof EntityPropertyType>;
+        description: z.ZodString;
+    }, {
+        type: z.ZodLiteral<EntityPropertyType.Boolean>;
+        value: z.ZodOptional<z.ZodBoolean>;
+    }>, "strip", z.ZodTypeAny, {
+        type: EntityPropertyType.Boolean;
+        description: string;
+        value?: boolean | undefined;
+    }, {
+        type: EntityPropertyType.Boolean;
+        description: string;
+        value?: boolean | undefined;
+    }>]>>;
+}, "strip", z.ZodTypeAny, {
+    description: string;
+    fields: Record<string, {
+        type: EntityPropertyType.Text;
+        description: string;
+        value?: string | undefined;
+    } | {
+        type: EntityPropertyType.Int;
+        description: string;
+        value?: number | undefined;
+    } | {
+        type: EntityPropertyType.Float;
+        description: string;
+        value?: number | undefined;
+    } | {
+        type: EntityPropertyType.Boolean;
+        description: string;
+        value?: boolean | undefined;
+    }>;
+}, {
+    fields: Record<string, {
+        type: EntityPropertyType.Text;
+        description: string;
+        value?: string | undefined;
+    } | {
+        type: EntityPropertyType.Int;
+        description: string;
+        value?: number | undefined;
+    } | {
+        type: EntityPropertyType.Float;
+        description: string;
+        value?: number | undefined;
+    } | {
+        type: EntityPropertyType.Boolean;
+        description: string;
+        value?: boolean | undefined;
+    }>;
+    description?: string | undefined;
+}>;
+export type EntityType = z.infer<typeof EntityTypeSchema>;
+export type EntityData<T extends EntityType> = {
+    [P in keyof T["fields"]]: T["fields"][P] extends {
+        value?: infer V;
+    } ? V : never;
+};
+export declare const entityFields: {
+    text: (description: string) => EntityTextField;
+    integer: (description: string) => EntityIntField;
+    float: (description: string) => EntityFloatField;
+    boolean: (description: string) => EntityBooleanField;
+};
+export declare function entityModelToAPISchema(entityType: EntityType, name: string): Zep.EntityType;

package/dist/wrapper/ontology.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.entityFields = exports.EntityTypeSchema = exports.EntityFields = exports.EntityTypeFieldSchema = exports.EntityTypeBooleanFieldSchema = exports.EntityTypeFloatFieldSchema = exports.EntityTypeIntFieldSchema = exports.EntityTypeTextFieldSchema = exports.EntityTypeBaseField = exports.EntityPropertyType = void 0;
+exports.entityModelToAPISchema = entityModelToAPISchema;
+const zod_1 = require("zod");
+var EntityPropertyType;
+(function (EntityPropertyType) {
+    EntityPropertyType["Text"] = "Text";
+    EntityPropertyType["Int"] = "Int";
+    EntityPropertyType["Float"] = "Float";
+    EntityPropertyType["Boolean"] = "Boolean";
+})(EntityPropertyType || (exports.EntityPropertyType = EntityPropertyType = {}));
+exports.EntityTypeBaseField = zod_1.z.object({
+    type: zod_1.z.nativeEnum(EntityPropertyType),
+    description: zod_1.z.string(),
+});
+exports.EntityTypeTextFieldSchema = exports.EntityTypeBaseField.extend({
+    type: zod_1.z.literal(EntityPropertyType.Text),
+    value: zod_1.z.string().optional(),
+});
+exports.EntityTypeIntFieldSchema = exports.EntityTypeBaseField.extend({
+    type: zod_1.z.literal(EntityPropertyType.Int),
+    value: zod_1.z.number().int().optional(),
+});
+exports.EntityTypeFloatFieldSchema = exports.EntityTypeBaseField.extend({
+    type: zod_1.z.literal(EntityPropertyType.Float),
+    value: zod_1.z.number().optional(),
+});
+exports.EntityTypeBooleanFieldSchema = exports.EntityTypeBaseField.extend({
+    type: zod_1.z.literal(EntityPropertyType.Boolean),
+    value: zod_1.z.boolean().optional(),
+});
+exports.EntityTypeFieldSchema = zod_1.z.union([
+    exports.EntityTypeTextFieldSchema,
+    exports.EntityTypeIntFieldSchema,
+    exports.EntityTypeFloatFieldSchema,
+    exports.EntityTypeBooleanFieldSchema,
+]);
+exports.EntityFields = zod_1.z.record(exports.EntityTypeFieldSchema);
+exports.EntityTypeSchema = zod_1.z.object({
+    description: zod_1.z.string().default(""),
+    fields: zod_1.z.record(exports.EntityTypeFieldSchema),
+});
+exports.entityFields = {
+    text: (description) => {
+        return exports.EntityTypeTextFieldSchema.parse({
+            type: EntityPropertyType.Text,
+            description,
+        });
+    },
+    integer: (description) => {
+        return exports.EntityTypeIntFieldSchema.parse({
+            type: EntityPropertyType.Int,
+            description,
+        });
+    },
+    float: (description) => {
+        return exports.EntityTypeFloatFieldSchema.parse({
+            type: EntityPropertyType.Float,
+            description,
+        });
+    },
+    boolean: (description) => {
+        return exports.EntityTypeBooleanFieldSchema.parse({
+            type: EntityPropertyType.Boolean,
+            description,
+        });
+    },
+};
+function entityModelToAPISchema(entityType, name) {
+    return {
+        name,
+        description: entityType.description,
+        properties: Object.entries(entityType.fields).map(([fieldName, fieldDef]) => ({
+            name: fieldName,
+            type: fieldDef.type,
+            description: fieldDef.description,
+        })),
+    };
+}

package/examples/graph/entity_type_example.ts

@@ -0,0 +1,40 @@
+import { ZepClient } from "../../src";
+import { EntityData, entityFields, EntityType } from "../../src/wrapper/ontology";
+
+const API_KEY = process.env.ZEP_API_KEY;
+
+async function main() {
+    const client = new ZepClient({
+        apiKey: API_KEY,
+    });
+
+    const purchaseSchema: EntityType = {
+        description: "A purchase",
+        fields: {
+            product: entityFields.text("The product purchased"),
+            quantity: entityFields.integer("The quantity purchased"),
+            price: entityFields.float("The price of the product"),
+        },
+    };
+
+    type Purchase = EntityData<typeof purchaseSchema>;
+
+    await client.graph.setEntityTypes({
+        Purchase: purchaseSchema,
+    });
+
+    const { nodes } = await client.graph.search({
+        userId: "<user_id>",
+        scope: "nodes",
+        query: "ticket purchases",
+        searchFilters: {
+            nodeLabels: ["Purchase"],
+        },
+    });
+
+    const purchases: Purchase[] = nodes?.map((node) => node.attributes as Purchase) ?? [];
+
+    console.log(purchases);
+}
+
+main().catch(console.error);

package/package.json

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