@getzep/zep-cloud 3.18.0 → 3.22.0

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

@@ -0,0 +1,161 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments.mjs";
+import * as core from "../../../../core/index.mjs";
+import * as Zep from "../../../index.mjs";
+export declare namespace Batch {
+    interface Options {
+        environment?: core.Supplier<environments.ZepEnvironment | string>;
+        /** Specify a custom URL to connect the client to. */
+        baseUrl?: core.Supplier<string>;
+        apiKey?: core.Supplier<string | undefined>;
+        /** Additional headers to include in requests. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+        fetcher?: core.FetchFunction;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+        /** Additional headers to include in the request. */
+        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
+    }
+}
+export declare class Batch {
+    protected readonly _options: Batch.Options;
+    constructor(_options?: Batch.Options);
+    /**
+     * List batches for the current project, optionally filtered by batch status.
+     *
+     * @param {Zep.BatchListRequest} request
+     * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.ForbiddenError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.batch.list({
+     *         limit: 1,
+     *         cursor: 1,
+     *         status: "status"
+     *     })
+     */
+    list(request?: Zep.BatchListRequest, requestOptions?: Batch.RequestOptions): core.HttpResponsePromise<Zep.BatchListResponse>;
+    private __list;
+    /**
+     * Create a draft batch that can be filled with graph episodes and thread messages.
+     *
+     * @param {Zep.ApidataCreateBatchRequest} request
+     * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.ForbiddenError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.batch.create()
+     */
+    create(request?: Zep.ApidataCreateBatchRequest, requestOptions?: Batch.RequestOptions): core.HttpResponsePromise<Zep.BatchSummary>;
+    private __create;
+    /**
+     * Get a batch summary, including runtime progress when the batch has been processed.
+     *
+     * @param {string} batchId - The batch ID.
+     * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.ForbiddenError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.batch.get("batchId")
+     */
+    get(batchId: string, requestOptions?: Batch.RequestOptions): core.HttpResponsePromise<Zep.BatchSummary>;
+    private __get;
+    /**
+     * Delete a draft or invalid unprocessed batch. Processed batches cannot be deleted.
+     *
+     * @param {string} batchId - The batch ID.
+     * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.ForbiddenError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.ConflictError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.batch.delete("batchId")
+     */
+    delete(batchId: string, requestOptions?: Batch.RequestOptions): core.HttpResponsePromise<Zep.SuccessResponse>;
+    private __delete;
+    /**
+     * List items in a batch, including derived runtime status when the batch has been processed.
+     *
+     * @param {string} batchId - The batch ID.
+     * @param {Zep.BatchListItemsRequest} request
+     * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.ForbiddenError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.batch.listItems("batchId", {
+     *         limit: 1,
+     *         cursor: 1,
+     *         status: "status"
+     *     })
+     */
+    listItems(batchId: string, request?: Zep.BatchListItemsRequest, requestOptions?: Batch.RequestOptions): core.HttpResponsePromise<Zep.BatchItemListResponse>;
+    private __listItems;
+    /**
+     * Add graph episodes and thread messages to a draft batch. Items are appended in request order.
+     *
+     * @param {string} batchId - The batch ID.
+     * @param {Zep.ApidataAddBatchItemsRequest} request
+     * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.ForbiddenError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.ConflictError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.batch.add("batchId", {
+     *         items: [{
+     *                 type: "graph_episode"
+     *             }]
+     *     })
+     */
+    add(batchId: string, request: Zep.ApidataAddBatchItemsRequest, requestOptions?: Batch.RequestOptions): core.HttpResponsePromise<Zep.BatchItemDetail[]>;
+    private __add;
+    /**
+     * Start processing a filled batch. Repeated calls return the existing batch run.
+     *
+     * @param {string} batchId - The batch ID.
+     * @param {Batch.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.ForbiddenError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.ConflictError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.batch.process("batchId")
+     */
+    process(batchId: string, requestOptions?: Batch.RequestOptions): core.HttpResponsePromise<Zep.BatchSummary>;
+    private __process;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string;
+    }>;
+}