@arizeai/phoenix-client/dist/src/experiments/deleteExperiment.d.ts

A client for the Phoenix API

import type { ClientFn } from "../types/core";
/**
 * Parameters to delete an experiment
 */
export interface DeleteExperimentParams extends ClientFn {
    /**
     * The ID of the experiment to delete
     */
    experimentId: string;
    /**
     * If true, also delete the project associated with the experiment.
     * Defaults to false.
     */
    deleteProject?: boolean;
}
/**
 * Delete an experiment by ID.
 *
 * **Important**: This operation permanently deletes the experiment and all its associated
 * runs, evaluations, and annotations.
 *
 * Behavior:
 * - Deletes the experiment and all its data
 * - Returns successfully if experiment is found and deleted
 * - Throws error if experiment is not found (404) or other errors occur
 *
 * @param params - The parameters to delete an experiment
 * @returns Promise that resolves when the experiment is successfully deleted
 * @throws Error if the experiment is not found or deletion fails
 *
 * @example
 * ```ts
 * import { deleteExperiment } from "@arizeai/phoenix-client/experiments";
 *
 * await deleteExperiment({
 *   experimentId: "exp_123",
 *   deleteProject: true,
 * });
 * ```
 */
export declare function deleteExperiment({ client: _client, experimentId, deleteProject, }: DeleteExperimentParams): Promise<void>;
//# sourceMappingURL=deleteExperiment.d.ts.map