@getzep/zep-cloud 3.0.0 → 3.0.2

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

@@ -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/esm/api/types/ModelsFactRatingExamples.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,21 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.mjs";
+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/esm/api/types/ModelsFactRatingInstruction.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -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/esm/api/types/Reranker.mjs

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

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

@@ -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/esm/api/types/RoleType.mjs

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

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

@@ -0,0 +1,42 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.mjs";
+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/esm/api/types/SearchFilters.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

package/dist/esm/api/types/SuccessResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -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/esm/api/types/Thread.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -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/esm/api/types/ThreadContextResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

package/dist/esm/api/types/ThreadListResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Zep from "../index.mjs";
+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/esm/api/types/User.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

package/dist/esm/api/types/UserListResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

package/dist/esm/api/types/UserNodeResponse.mjs

@@ -0,0 +1,4 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export {};

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

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

package/dist/esm/api/types/index.mjs

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

package/dist/esm/contextString.d.mts

@@ -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/esm/contextString.mjs

@@ -0,0 +1,71 @@
+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.
+ */
+export 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.
+ */
+export 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/esm/core/fetcher/APIResponse.d.mts

@@ -0,0 +1,20 @@
+import { RawResponse } from "./RawResponse.mjs";
+/**
+ * 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/esm/core/fetcher/APIResponse.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/core/fetcher/BinaryResponse.d.mts

@@ -0,0 +1,20 @@
+import { ResponseWithBody } from "./ResponseWithBody.mjs";
+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/esm/core/fetcher/BinaryResponse.mjs

@@ -0,0 +1,14 @@
+export 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;
+}

package/dist/esm/core/fetcher/Fetcher.d.mts

@@ -0,0 +1,40 @@
+import { APIResponse } from "./APIResponse.mjs";
+import { Supplier } from "./Supplier.mjs";
+export type FetchFunction = <R = unknown>(args: Fetcher.Args) => Promise<APIResponse<R, Fetcher.Error>>;
+export declare namespace Fetcher {
+    interface Args {
+        url: string;
+        method: string;
+        contentType?: string;
+        headers?: Record<string, string | Supplier<string | undefined> | undefined>;
+        queryParameters?: Record<string, string | string[] | object | object[] | null>;
+        body?: unknown;
+        timeoutMs?: number;
+        maxRetries?: number;
+        withCredentials?: boolean;
+        abortSignal?: AbortSignal;
+        requestType?: "json" | "file" | "bytes";
+        responseType?: "json" | "blob" | "sse" | "streaming" | "text" | "arrayBuffer" | "binary-response";
+        duplex?: "half";
+    }
+    type Error = FailedStatusCodeError | NonJsonError | TimeoutError | UnknownError;
+    interface FailedStatusCodeError {
+        reason: "status-code";
+        statusCode: number;
+        body: unknown;
+    }
+    interface NonJsonError {
+        reason: "non-json";
+        statusCode: number;
+        rawBody: string;
+    }
+    interface TimeoutError {
+        reason: "timeout";
+    }
+    interface UnknownError {
+        reason: "unknown";
+        errorMessage: string;
+    }
+}
+export declare function fetcherImpl<R = unknown>(args: Fetcher.Args): Promise<APIResponse<R, Fetcher.Error>>;
+export declare const fetcher: FetchFunction;

package/dist/esm/core/fetcher/Fetcher.mjs

@@ -0,0 +1,116 @@
+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());
+    });
+};
+import { toJson } from "../json.mjs";
+import { abortRawResponse, toRawResponse, unknownRawResponse } from "./RawResponse.mjs";
+import { Supplier } from "./Supplier.mjs";
+import { createRequestUrl } from "./createRequestUrl.mjs";
+import { getErrorResponseBody } from "./getErrorResponseBody.mjs";
+import { getFetchFn } from "./getFetchFn.mjs";
+import { getRequestBody } from "./getRequestBody.mjs";
+import { getResponseBody } from "./getResponseBody.mjs";
+import { makeRequest } from "./makeRequest.mjs";
+import { requestWithRetries } from "./requestWithRetries.mjs";
+function getHeaders(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const newHeaders = {};
+        if (args.body !== undefined && args.contentType != null) {
+            newHeaders["Content-Type"] = args.contentType;
+        }
+        if (args.headers == null) {
+            return newHeaders;
+        }
+        for (const [key, value] of Object.entries(args.headers)) {
+            const result = yield Supplier.get(value);
+            if (typeof result === "string") {
+                newHeaders[key] = result;
+                continue;
+            }
+            if (result == null) {
+                continue;
+            }
+            newHeaders[key] = `${result}`;
+        }
+        return newHeaders;
+    });
+}
+export function fetcherImpl(args) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const url = createRequestUrl(args.url, args.queryParameters);
+        const requestBody = yield getRequestBody({
+            body: args.body,
+            type: args.requestType === "json" ? "json" : "other",
+        });
+        const fetchFn = yield getFetchFn();
+        try {
+            const response = yield requestWithRetries(() => __awaiter(this, void 0, void 0, function* () {
+                return makeRequest(fetchFn, url, args.method, yield getHeaders(args), requestBody, args.timeoutMs, args.abortSignal, args.withCredentials, args.duplex);
+            }), args.maxRetries);
+            if (response.status >= 200 && response.status < 400) {
+                return {
+                    ok: true,
+                    body: (yield getResponseBody(response, args.responseType)),
+                    headers: response.headers,
+                    rawResponse: toRawResponse(response),
+                };
+            }
+            else {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "status-code",
+                        statusCode: response.status,
+                        body: yield getErrorResponseBody(response),
+                    },
+                    rawResponse: toRawResponse(response),
+                };
+            }
+        }
+        catch (error) {
+            if (args.abortSignal != null && args.abortSignal.aborted) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: "The user aborted a request",
+                    },
+                    rawResponse: abortRawResponse,
+                };
+            }
+            else if (error instanceof Error && error.name === "AbortError") {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "timeout",
+                    },
+                    rawResponse: abortRawResponse,
+                };
+            }
+            else if (error instanceof Error) {
+                return {
+                    ok: false,
+                    error: {
+                        reason: "unknown",
+                        errorMessage: error.message,
+                    },
+                    rawResponse: unknownRawResponse,
+                };
+            }
+            return {
+                ok: false,
+                error: {
+                    reason: "unknown",
+                    errorMessage: toJson(error),
+                },
+                rawResponse: unknownRawResponse,
+            };
+        }
+    });
+}
+export const fetcher = fetcherImpl;