@getzep/zep-cloud 3.0.3 → 3.0.4

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

@@ -0,0 +1,229 @@
+/**
+ * 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";
+import { Edge } from "../resources/edge/client/Client.mjs";
+import { Episode } from "../resources/episode/client/Client.mjs";
+import { Node } from "../resources/node/client/Client.mjs";
+export declare namespace Graph {
+    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 Graph {
+    protected readonly _options: Graph.Options;
+    protected _edge: Edge | undefined;
+    protected _episode: Episode | undefined;
+    protected _node: Node | undefined;
+    constructor(_options?: Graph.Options);
+    get edge(): Edge;
+    get episode(): Episode;
+    get node(): Node;
+    /**
+     * Returns all entity types for a project.
+     *
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.listEntityTypes()
+     */
+    listEntityTypes(requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.EntityTypeResponse>;
+    private __listEntityTypes;
+    /**
+     * Sets the entity types for a project, replacing any existing ones.
+     *
+     * @param {Zep.EntityTypeRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.setEntityTypesInternal()
+     */
+    setEntityTypesInternal(request?: Zep.EntityTypeRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.SuccessResponse>;
+    private __setEntityTypesInternal;
+    /**
+     * Add data to the graph.
+     *
+     * @param {Zep.AddDataRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.add({
+     *         data: "data",
+     *         type: "text"
+     *     })
+     */
+    add(request: Zep.AddDataRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.Episode>;
+    private __add;
+    /**
+     * Add data to the graph in batch mode, processing episodes concurrently. Use only for data that is insensitive to processing order.
+     *
+     * @param {Zep.AddDataBatchRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.addBatch({
+     *         episodes: [{
+     *                 data: "data",
+     *                 type: "text"
+     *             }]
+     *     })
+     */
+    addBatch(request: Zep.AddDataBatchRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.Episode[]>;
+    private __addBatch;
+    /**
+     * Add a fact triple for a user or group
+     *
+     * @param {Zep.AddTripleRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.addFactTriple({
+     *         fact: "fact",
+     *         factName: "fact_name",
+     *         targetNodeName: "target_node_name"
+     *     })
+     */
+    addFactTriple(request: Zep.AddTripleRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.AddTripleResponse>;
+    private __addFactTriple;
+    /**
+     * Clone a user or group graph.
+     *
+     * @param {Zep.CloneGraphRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.clone()
+     */
+    clone(request?: Zep.CloneGraphRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.CloneGraphResponse>;
+    private __clone;
+    /**
+     * Perform a graph search query.
+     *
+     * @param {Zep.GraphSearchQuery} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.search({
+     *         query: "query"
+     *     })
+     */
+    search(request: Zep.GraphSearchQuery, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.GraphSearchResults>;
+    private __search;
+    /**
+     * Creates a new graph.
+     *
+     * @param {Zep.CreateGraphRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.create({
+     *         graphId: "graph_id"
+     *     })
+     */
+    create(request: Zep.CreateGraphRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.Graph>;
+    private __create;
+    /**
+     * Returns all graphs.
+     *
+     * @param {Zep.GraphListAllRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.listAll()
+     */
+    listAll(request?: Zep.GraphListAllRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.GraphListResponse>;
+    private __listAll;
+    /**
+     * Returns a graph.
+     *
+     * @param {string} graphId - The graph_id of the graph to get.
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.get("graphId")
+     */
+    get(graphId: string, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.Graph>;
+    private __get;
+    /**
+     * Deletes a graph. If you would like to delete a user graph, make sure to use user.delete instead.
+     *
+     * @param {string} graphId - Graph ID
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.delete("graphId")
+     */
+    delete(graphId: string, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.SuccessResponse>;
+    private __delete;
+    /**
+     * Updates information about a graph.
+     *
+     * @param {string} graphId - Graph ID
+     * @param {Zep.UpdateGraphRequest} request
+     * @param {Graph.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link Zep.BadRequestError}
+     * @throws {@link Zep.NotFoundError}
+     * @throws {@link Zep.InternalServerError}
+     *
+     * @example
+     *     await client.graph.update("graphId")
+     */
+    update(graphId: string, request?: Zep.UpdateGraphRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise<Zep.Graph>;
+    private __update;
+    protected _getCustomAuthorizationHeaders(): Promise<{
+        Authorization: string;
+    }>;
+}