UNPKG

@arizeai/phoenix-client

Version:

A client for the Phoenix API

29 lines 941 B
import { ClientFn } from "../types/core.js"; import { ExperimentInfo } from "../types/experiments.js"; export type ListExperimentsParams = ClientFn & { /** * The dataset ID to list experiments for */ datasetId: string; }; /** * List all experiments for a dataset with automatic pagination handling. * * This function automatically handles pagination behind the scenes and returns * a simple list of experiments. * * @example * ```ts * import { listExperiments } from "@arizeai/phoenix-client/experiments"; * * const experiments = await listExperiments({ * datasetId: "dataset_123", * }); * * for (const experiment of experiments) { * console.log(`Experiment: ${experiment.id}, Runs: ${experiment.successfulRunCount}`); * } * ``` */ export declare function listExperiments({ client: _client, datasetId, }: ListExperimentsParams): Promise<ExperimentInfo[]>; //# sourceMappingURL=listExperiments.d.ts.map