/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments.js"; import * as core from "../../../../core/index.js"; import * as Zep from "../../../index.js"; import { Edge } from "../resources/edge/client/Client.js"; import { Episode } from "../resources/episode/client/Client.js"; import { Node } from "../resources/node/client/Client.js"; export declare namespace Graph { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; apiKey?: core.Supplier; /** Additional headers to include in requests. */ headers?: Record | 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 | 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; /** * Lists all custom instructions for a project, user, or graph. * * @param {Zep.GraphListCustomInstructionsRequest} request * @param {Graph.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.graph.listCustomInstructions({ * userId: "user_id", * graphId: "graph_id" * }) */ listCustomInstructions(request?: Zep.GraphListCustomInstructionsRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; private __listCustomInstructions; /** * Adds new custom instructions for graphs without removing existing ones. If user_ids or graph_ids is empty, adds to project-wide default instructions. * * @param {Zep.AddCustomInstructionsRequest} request * @param {Graph.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.graph.addCustomInstructions({ * instructions: [{ * name: "name", * text: "text" * }] * }) */ addCustomInstructions(request: Zep.AddCustomInstructionsRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; private __addCustomInstructions; /** * Deletes custom instructions for graphs or project wide defaults. * * @param {Zep.DeleteCustomInstructionsRequest} request * @param {Graph.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.graph.deleteCustomInstructions() */ deleteCustomInstructions(request?: Zep.DeleteCustomInstructionsRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; private __deleteCustomInstructions; /** * Returns all entity types for a project, user, or graph. * * @param {Zep.GraphListEntityTypesRequest} request * @param {Graph.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.graph.listEntityTypes({ * userId: "user_id", * graphId: "graph_id" * }) */ listEntityTypes(request?: Zep.GraphListEntityTypesRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; private __listEntityTypes; /** * Sets the entity types for multiple users and graphs, replacing any existing ones. * * @param {Zep.EntityTypeRequest} request * @param {Graph.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.graph.setEntityTypesInternal() */ setEntityTypesInternal(request?: Zep.EntityTypeRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; 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; private __add; /** * Add data to the graph in batch mode. Episodes are processed sequentially in the order provided. * * @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; 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" * }) */ addFactTriple(request: Zep.AddTripleRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; 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; private __clone; /** * 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; private __create; /** * Returns all graphs. In order to list users, use user.list_ordered instead * * @param {Zep.GraphListAllRequest} request * @param {Graph.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.InternalServerError} * * @example * await client.graph.listAll({ * pageNumber: 1, * pageSize: 1, * orderBy: "order_by", * asc: true * }) */ listAll(request?: Zep.GraphListAllRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; private __listAll; /** * Detects structural patterns in a knowledge graph including relationship frequencies, * multi-hop paths, co-occurrences, hubs, and clusters. * When a query is provided, uses hybrid search to discover seed nodes, * detects triple-frequency patterns, and returns resolved edges ranked by relevance. * * @param {Zep.DetectPatternsRequest} request * @param {Graph.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.ForbiddenError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await client.graph.detectPatterns() */ detectPatterns(request?: Zep.DetectPatternsRequest, requestOptions?: Graph.RequestOptions): core.HttpResponsePromise; private __detectPatterns; /** * 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; private __search; /** * 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; 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; 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; private __update; protected _getCustomAuthorizationHeaders(): Promise<{ Authorization: string; }>; }