@arizeai/phoenix-client/dist/src/sessions/deleteSessions.d.ts

A client for the Phoenix API

import type { ClientFn } from "../types/core";
/**
 * Parameters to bulk delete sessions
 */
export interface DeleteSessionsParams extends ClientFn {
    /**
     * List of session identifiers to delete. Each can be either:
     * - A user-provided session ID string
     * - A Phoenix Global ID (base64-encoded)
     *
     * All identifiers must be the same type (no mixing).
     */
    sessionIds: string[];
}
/**
 * Delete multiple sessions by their identifiers.
 *
 * All identifiers must be the same type: either all GlobalIDs or all
 * user-provided session_id strings. Non-existent IDs are silently skipped.
 * All associated traces, spans, and annotations are cascade deleted.
 *
 * @experimental this function is experimental and may change in the future
 *
 * @param params - The parameters to bulk delete sessions
 * @returns Promise that resolves when the sessions are successfully deleted
 * @throws Error if identifiers are mixed types or deletion fails
 *
 * @requires Phoenix server >= 13.13.0
 *
 * @example
 * ```ts
 * // Delete by user-provided session IDs
 * await deleteSessions({
 *   client,
 *   sessionIds: ["session-1", "session-2", "session-3"]
 * });
 *
 * // Delete by Phoenix Global IDs
 * await deleteSessions({
 *   client,
 *   sessionIds: ["UHJvamVjdFNlc3Npb246MQ==", "UHJvamVjdFNlc3Npb246Mg=="]
 * });
 * ```
 */
export declare function deleteSessions({ client: _client, sessionIds, }: DeleteSessionsParams): Promise<void>;
//# sourceMappingURL=deleteSessions.d.ts.map