/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments"; import * as core from "../../../../core"; import * as Zep from "../../../index"; export declare namespace Memory { interface Options { environment?: core.Supplier; apiKey?: core.Supplier; fetcher?: core.FetchFunction; } interface RequestOptions { timeoutInSeconds?: number; maxRetries?: number; abortSignal?: AbortSignal; } } export declare class Memory { protected readonly _options: Memory.Options; constructor(_options?: Memory.Options); /** * get fact by uuid * * @param {string} factUuid - Fact UUID * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.getFact("factUUID") */ getFact(factUuid: string, requestOptions?: Memory.RequestOptions): Promise; /** * delete a fact * * @param {string} factUuid - Fact UUID * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.deleteFact("factUUID") */ deleteFact(factUuid: string, requestOptions?: Memory.RequestOptions): Promise; /** * Create New Session * * @param {Zep.CreateSessionRequest} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.addSession({ * sessionId: "session_id" * }) */ addSession(request: Zep.CreateSessionRequest, requestOptions?: Memory.RequestOptions): Promise; /** * Get all sessions with optional page number, page size, order by field and order direction for pagination. * * @param {Zep.MemoryListSessionsRequest} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.listSessions() */ listSessions(request?: Zep.MemoryListSessionsRequest, requestOptions?: Memory.RequestOptions): Promise; /** * Search sessions for the specified query. * * @param {Zep.SessionSearchQuery} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.searchSessions() */ searchSessions(request?: Zep.SessionSearchQuery, requestOptions?: Memory.RequestOptions): Promise; /** * get session by id * * @param {string} sessionId - Session ID * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.getSession("sessionId") */ getSession(sessionId: string, requestOptions?: Memory.RequestOptions): Promise; /** * Update Session Metadata * * @param {string} sessionId - Session ID * @param {Zep.UpdateSessionRequest} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.BadRequestError} * @throws {@link Zep.NotFoundError} * @throws {@link Zep.ConflictError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.updateSession("sessionId", { * metadata: { * "key": "value" * } * }) */ updateSession(sessionId: string, request: Zep.UpdateSessionRequest, requestOptions?: Memory.RequestOptions): Promise; /** * Returns a memory (latest summary, list of messages and facts) for a given session * * @param {string} sessionId - The ID of the session for which to retrieve memory. * @param {Zep.MemoryGetRequest} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.get("sessionId") */ get(sessionId: string, request?: Zep.MemoryGetRequest, requestOptions?: Memory.RequestOptions): Promise; /** * Add memory to the specified session. * * @param {string} sessionId - The ID of the session to which memory should be added. * @param {Zep.ApidataAddMemoryRequest} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.add("sessionId", { * messages: [{}] * }) */ add(sessionId: string, request: Zep.ApidataAddMemoryRequest, requestOptions?: Memory.RequestOptions): Promise; /** * delete memory messages by session id * * @param {string} sessionId - The ID of the session for which memory should be deleted. * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.delete("sessionId") */ delete(sessionId: string, requestOptions?: Memory.RequestOptions): Promise; /** * Lists messages for a session, specified by limit and cursor. * * @param {string} sessionId - Session ID * @param {Zep.MemoryGetSessionMessagesRequest} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.getSessionMessages("sessionId") */ getSessionMessages(sessionId: string, request?: Zep.MemoryGetSessionMessagesRequest, requestOptions?: Memory.RequestOptions): Promise; /** * Gets a specific message from a session * * @param {string} sessionId - The ID of the session. * @param {string} messageUuid - The UUID of the message. * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.getSessionMessage("sessionId", "messageUUID") */ getSessionMessage(sessionId: string, messageUuid: string, requestOptions?: Memory.RequestOptions): Promise; /** * Updates the metadata of a message. * * @param {string} sessionId - The ID of the session. * @param {string} messageUuid - The UUID of the message. * @param {Zep.ModelsMessageMetadataUpdate} request * @param {Memory.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Zep.NotFoundError} * @throws {@link Zep.InternalServerError} * * @example * await zep.memory.updateMessageMetadata("sessionId", "messageUUID", { * metadata: { * "key": "value" * } * }) */ updateMessageMetadata(sessionId: string, messageUuid: string, request: Zep.ModelsMessageMetadataUpdate, requestOptions?: Memory.RequestOptions): Promise; protected _getCustomAuthorizationHeaders(): Promise<{ Authorization: string; }>; }