@getzep/zep-cloud 3.0.0 → 3.0.2

package/dist/cjs/api/types/GraphNodesRequest.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface GraphSearchResults {
+    edges?: Zep.EntityEdge[];
+    episodes?: Zep.Episode[];
+    nodes?: Zep.EntityNode[];
+}

package/dist/cjs/api/types/GraphSearchResults.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type GraphSearchScope = "edges" | "nodes" | "episodes";
+export declare const GraphSearchScope: {
+    readonly Edges: "edges";
+    readonly Nodes: "nodes";
+    readonly Episodes: "episodes";
+};

package/dist/cjs/api/types/GraphSearchScope.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GraphSearchScope = void 0;
+exports.GraphSearchScope = {
+    Edges: "edges",
+    Nodes: "nodes",
+    Episodes: "episodes",
+};

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

@@ -0,0 +1,18 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface Message {
+    /** The content of the message. */
+    content: string;
+    /** The timestamp of when the message was created. */
+    createdAt?: string;
+    /** Customizable name of the sender of the message (e.g., "john", "sales_agent"). */
+    name?: string;
+    /** Whether the message has been processed. */
+    processed?: boolean;
+    /** The role of message sender (e.g., "user", "system"). */
+    role: Zep.RoleType;
+    /** The unique identifier of the message. */
+    uuid?: string;
+}

package/dist/cjs/api/types/Message.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface MessageListResponse {
+    /** A list of message objects. */
+    messages?: Zep.Message[];
+    /** The number of messages returned. */
+    rowCount?: number;
+    /** The total number of messages. */
+    totalCount?: number;
+}

package/dist/cjs/api/types/MessageListResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface ModelsFactRatingExamples {
+    high?: string;
+    low?: string;
+    medium?: string;
+}

package/dist/cjs/api/types/ModelsFactRatingExamples.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface ModelsFactRatingInstruction {
+    /**
+     * Examples is a list of examples that demonstrate how facts might be rated based on your instruction. You should provide
+     * an example of a highly rated example, a low rated example, and a medium (or in between example). For example, if you are rating
+     * based on relevance to a trip planning application, your examples might be:
+     * High: "Joe's dream vacation is Bali"
+     * Medium: "Joe has a fear of flying",
+     * Low: "Joe's favorite food is Japanese",
+     */
+    examples?: Zep.ModelsFactRatingExamples;
+    /**
+     * A string describing how to rate facts as they apply to your application. A trip planning application may
+     * use something like "relevancy to planning a trip, the user's preferences when traveling,
+     * or the user's travel history."
+     */
+    instruction?: string;
+}

package/dist/cjs/api/types/ModelsFactRatingInstruction.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type Reranker = "rrf" | "mmr" | "node_distance" | "episode_mentions" | "cross_encoder";
+export declare const Reranker: {
+    readonly Rrf: "rrf";
+    readonly Mmr: "mmr";
+    readonly NodeDistance: "node_distance";
+    readonly EpisodeMentions: "episode_mentions";
+    readonly CrossEncoder: "cross_encoder";
+};

package/dist/cjs/api/types/Reranker.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Reranker = void 0;
+exports.Reranker = {
+    Rrf: "rrf",
+    Mmr: "mmr",
+    NodeDistance: "node_distance",
+    EpisodeMentions: "episode_mentions",
+    CrossEncoder: "cross_encoder",
+};

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

@@ -0,0 +1,12 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export type RoleType = "norole" | "system" | "assistant" | "user" | "function" | "tool";
+export declare const RoleType: {
+    readonly NoRole: "norole";
+    readonly SystemRole: "system";
+    readonly AssistantRole: "assistant";
+    readonly UserRole: "user";
+    readonly FunctionRole: "function";
+    readonly ToolRole: "tool";
+};

package/dist/cjs/api/types/RoleType.js

@@ -0,0 +1,14 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoleType = void 0;
+exports.RoleType = {
+    NoRole: "norole",
+    SystemRole: "system",
+    AssistantRole: "assistant",
+    UserRole: "user",
+    FunctionRole: "function",
+    ToolRole: "tool",
+};

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

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface SearchFilters {
+    /**
+     * 2D array of date filters for the created_at field.
+     * The outer array elements are combined with OR logic.
+     * The inner array elements are combined with AND logic.
+     * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
+     * This translates to: (created_at > date1 AND created_at < date2) OR (created_at = date3)
+     */
+    createdAt?: Zep.DateFilter[][];
+    /** List of edge types to filter on */
+    edgeTypes?: string[];
+    /**
+     * 2D array of date filters for the expired_at field.
+     * The outer array elements are combined with OR logic.
+     * The inner array elements are combined with AND logic.
+     * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
+     * This translates to: (expired_at > date1 AND expired_at < date2) OR (expired_at = date3)
+     */
+    expiredAt?: Zep.DateFilter[][];
+    /**
+     * 2D array of date filters for the invalid_at field.
+     * The outer array elements are combined with OR logic.
+     * The inner array elements are combined with AND logic.
+     * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
+     * This translates to: (invalid_at > date1 AND invalid_at < date2) OR (invalid_at = date3)
+     */
+    invalidAt?: Zep.DateFilter[][];
+    /** List of node labels to filter on */
+    nodeLabels?: string[];
+    /**
+     * 2D array of date filters for the valid_at field.
+     * The outer array elements are combined with OR logic.
+     * The inner array elements are combined with AND logic.
+     * Example: [[{">", date1}, {"<", date2}], [{"=", date3}]]
+     * This translates to: (valid_at > date1 AND valid_at < date2) OR (valid_at = date3)
+     */
+    validAt?: Zep.DateFilter[][];
+}

package/dist/cjs/api/types/SearchFilters.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,6 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface SuccessResponse {
+    message?: string;
+}

package/dist/cjs/api/types/SuccessResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export interface Thread {
+    createdAt?: string;
+    projectUuid?: string;
+    threadId?: string;
+    userId?: string;
+    uuid?: string;
+}

package/dist/cjs/api/types/Thread.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+/**
+ * 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?: string;
+}

package/dist/cjs/api/types/ThreadContextResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface ThreadListResponse {
+    responseCount?: number;
+    threads?: Zep.Thread[];
+    totalCount?: number;
+}

package/dist/cjs/api/types/ThreadListResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface User {
+    createdAt?: string;
+    deletedAt?: string;
+    email?: string;
+    factRatingInstruction?: Zep.ModelsFactRatingInstruction;
+    firstName?: string;
+    id?: number;
+    lastName?: string;
+    /** Deprecated */
+    metadata?: Record<string, unknown>;
+    projectUuid?: string;
+    /** Deprecated */
+    sessionCount?: number;
+    /** Deprecated */
+    updatedAt?: string;
+    userId?: string;
+    uuid?: string;
+}

package/dist/cjs/api/types/User.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface UserListResponse {
+    rowCount?: number;
+    totalCount?: number;
+    users?: Zep.User[];
+}

package/dist/cjs/api/types/UserListResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,7 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.js";
+export interface UserNodeResponse {
+    node?: Zep.EntityNode;
+}

package/dist/cjs/api/types/UserNodeResponse.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -0,0 +1,41 @@
+export * from "./ApiError.js";
+export * from "./AddThreadMessagesResponse.js";
+export * from "./CloneGraphResponse.js";
+export * from "./EdgeType.js";
+export * from "./EntityEdgeSourceTarget.js";
+export * from "./EntityProperty.js";
+export * from "./EntityType.js";
+export * from "./EntityTypeResponse.js";
+export * from "./EpisodeData.js";
+export * from "./EpisodeMentions.js";
+export * from "./FactRatingExamples.js";
+export * from "./FactRatingInstruction.js";
+export * from "./Graph.js";
+export * from "./GraphEdgesRequest.js";
+export * from "./Episode.js";
+export * from "./EpisodeResponse.js";
+export * from "./GraphListResponse.js";
+export * from "./GraphNodesRequest.js";
+export * from "./GraphSearchResults.js";
+export * from "./RoleType.js";
+export * from "./SuccessResponse.js";
+export * from "./Thread.js";
+export * from "./ThreadContextResponse.js";
+export * from "./ThreadListResponse.js";
+export * from "./Message.js";
+export * from "./MessageListResponse.js";
+export * from "./User.js";
+export * from "./UserListResponse.js";
+export * from "./UserNodeResponse.js";
+export * from "./AddTripleResponse.js";
+export * from "./ComparisonOperator.js";
+export * from "./DateFilter.js";
+export * from "./EntityEdge.js";
+export * from "./EntityNode.js";
+export * from "./GraphSearchScope.js";
+export * from "./Reranker.js";
+export * from "./SearchFilters.js";
+export * from "./EntityPropertyType.js";
+export * from "./ModelsFactRatingExamples.js";
+export * from "./ModelsFactRatingInstruction.js";
+export * from "./GraphDataType.js";

package/dist/cjs/api/types/index.js

@@ -0,0 +1,57 @@
+"use strict";
+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 __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./ApiError.js"), exports);
+__exportStar(require("./AddThreadMessagesResponse.js"), exports);
+__exportStar(require("./CloneGraphResponse.js"), exports);
+__exportStar(require("./EdgeType.js"), exports);
+__exportStar(require("./EntityEdgeSourceTarget.js"), exports);
+__exportStar(require("./EntityProperty.js"), exports);
+__exportStar(require("./EntityType.js"), exports);
+__exportStar(require("./EntityTypeResponse.js"), exports);
+__exportStar(require("./EpisodeData.js"), exports);
+__exportStar(require("./EpisodeMentions.js"), exports);
+__exportStar(require("./FactRatingExamples.js"), exports);
+__exportStar(require("./FactRatingInstruction.js"), exports);
+__exportStar(require("./Graph.js"), exports);
+__exportStar(require("./GraphEdgesRequest.js"), exports);
+__exportStar(require("./Episode.js"), exports);
+__exportStar(require("./EpisodeResponse.js"), exports);
+__exportStar(require("./GraphListResponse.js"), exports);
+__exportStar(require("./GraphNodesRequest.js"), exports);
+__exportStar(require("./GraphSearchResults.js"), exports);
+__exportStar(require("./RoleType.js"), exports);
+__exportStar(require("./SuccessResponse.js"), exports);
+__exportStar(require("./Thread.js"), exports);
+__exportStar(require("./ThreadContextResponse.js"), exports);
+__exportStar(require("./ThreadListResponse.js"), exports);
+__exportStar(require("./Message.js"), exports);
+__exportStar(require("./MessageListResponse.js"), exports);
+__exportStar(require("./User.js"), exports);
+__exportStar(require("./UserListResponse.js"), exports);
+__exportStar(require("./UserNodeResponse.js"), exports);
+__exportStar(require("./AddTripleResponse.js"), exports);
+__exportStar(require("./ComparisonOperator.js"), exports);
+__exportStar(require("./DateFilter.js"), exports);
+__exportStar(require("./EntityEdge.js"), exports);
+__exportStar(require("./EntityNode.js"), exports);
+__exportStar(require("./GraphSearchScope.js"), exports);
+__exportStar(require("./Reranker.js"), exports);
+__exportStar(require("./SearchFilters.js"), exports);
+__exportStar(require("./EntityPropertyType.js"), exports);
+__exportStar(require("./ModelsFactRatingExamples.js"), exports);
+__exportStar(require("./ModelsFactRatingInstruction.js"), exports);
+__exportStar(require("./GraphDataType.js"), exports);

package/dist/cjs/contextString.d.ts

@@ -0,0 +1,16 @@
+import { EntityEdge, EntityNode } from "./api";
+/**
+ * Format the date range of an entity edge.
+ *
+ * @param edge - The entity edge to format.
+ * @returns A string representation of the date range.
+ */
+export declare function formatEdgeDateRange(edge: EntityEdge): string;
+/**
+ * Compose a search context from entity edges and nodes.
+ *
+ * @param edges - List of entity edges.
+ * @param nodes - List of entity nodes.
+ * @returns A formatted string containing facts and entities.
+ */
+export declare function composeContextString(edges: EntityEdge[], nodes: EntityNode[]): string;

package/dist/cjs/contextString.js

@@ -0,0 +1,75 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.formatEdgeDateRange = formatEdgeDateRange;
+exports.composeContextString = composeContextString;
+const TEMPLATE_STRING = `
+FACTS and ENTITIES represent relevant context to the current conversation.
+
+# These are the most relevant facts and their valid date ranges
+# format: FACT (Date range: from - to)
+<FACTS>
+%facts%
+</FACTS>
+
+# These are the most relevant entities
+# ENTITY_NAME: entity summary
+<ENTITIES>
+%entities%
+</ENTITIES>
+`;
+/**
+ * Format the date range of an entity edge.
+ *
+ * @param edge - The entity edge to format.
+ * @returns A string representation of the date range.
+ */
+function formatEdgeDateRange(edge) {
+    let validAt = "date unknown";
+    let invalidAt = "present";
+    if (edge.validAt) {
+        validAt = formatDate(new Date(edge.validAt));
+    }
+    if (edge.invalidAt) {
+        invalidAt = formatDate(new Date(edge.invalidAt));
+    }
+    return `${validAt} - ${invalidAt}`;
+}
+/**
+ * Format a date according to the memory context format.
+ *
+ * @param date - The date to format.
+ * @returns A formatted date string.
+ */
+function formatDate(date) {
+    return new Intl.DateTimeFormat("en-US", {
+        year: "numeric",
+        month: "2-digit",
+        day: "2-digit",
+        hour: "2-digit",
+        minute: "2-digit",
+        second: "2-digit",
+        hour12: false,
+    })
+        .format(date)
+        .replace(/\//g, "-")
+        .replace(",", "")
+        .replace(/^(\d{2})-(\d{2})-(\d{4})/, "$3-$1-$2");
+}
+/**
+ * Compose a search context from entity edges and nodes.
+ *
+ * @param edges - List of entity edges.
+ * @param nodes - List of entity nodes.
+ * @returns A formatted string containing facts and entities.
+ */
+function composeContextString(edges, nodes) {
+    const facts = edges.map((edge) => {
+        return `  - ${edge.fact} (${formatEdgeDateRange(edge)})`;
+    });
+    const entities = nodes.map((node) => {
+        return `  - ${node.name}: ${node.summary}`;
+    });
+    const factsStr = facts.join("\n");
+    const entitiesStr = entities.join("\n");
+    return TEMPLATE_STRING.replace("%facts%", factsStr).replace("%entities%", entitiesStr);
+}

package/dist/cjs/core/fetcher/APIResponse.d.ts

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse.js";
+/**
+ * The response of an API call.
+ * It is a successful response or a failed response.
+ */
+export type APIResponse<Success, Failure> = SuccessfulResponse<Success> | FailedResponse<Failure>;
+export interface SuccessfulResponse<T> {
+    ok: true;
+    body: T;
+    /**
+     * @deprecated Use `rawResponse` instead
+     */
+    headers?: Record<string, any>;
+    rawResponse: RawResponse;
+}
+export interface FailedResponse<T> {
+    ok: false;
+    error: T;
+    rawResponse: RawResponse;
+}

package/dist/cjs/core/fetcher/APIResponse.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/cjs/core/fetcher/BinaryResponse.d.ts

@@ -0,0 +1,20 @@
+import { ResponseWithBody } from "./ResponseWithBody.js";
+export type BinaryResponse = {
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bodyUsed) */
+    bodyUsed: boolean;
+    /**
+     * Returns a ReadableStream of the response body.
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/body)
+     */
+    stream: () => ReadableStream<Uint8Array>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/arrayBuffer) */
+    arrayBuffer: () => Promise<ArrayBuffer>;
+    /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/blob) */
+    blob: () => Promise<Blob>;
+    /**
+     * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Request/bytes)
+     * Some versions of the Fetch API may not support this method.
+     */
+    bytes?(): Promise<Uint8Array>;
+};
+export declare function getBinaryResponse(response: ResponseWithBody): BinaryResponse;

package/dist/cjs/core/fetcher/BinaryResponse.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getBinaryResponse = getBinaryResponse;
+function getBinaryResponse(response) {
+    const binaryResponse = {
+        get bodyUsed() {
+            return response.bodyUsed;
+        },
+        stream: () => response.body,
+        arrayBuffer: response.arrayBuffer.bind(response),
+        blob: response.blob.bind(response),
+    };
+    if ("bytes" in response && typeof response.bytes === "function") {
+        binaryResponse.bytes = response.bytes.bind(response);
+    }
+    return binaryResponse;
+}