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

A client for the Phoenix API

import { ClientFn } from "../types/core";
import { ExperimentInfo } from "../types/experiments";
export type CreateExperimentParams = ClientFn & {
    /**
     * The dataset ID to create the experiment for
     */
    datasetId: string;
    /**
     * The dataset version ID (if omitted, the latest version will be used)
     */
    datasetVersionId?: string;
    /**
     * The name of the experiment (if omitted, a random name will be generated)
     */
    experimentName?: string;
    /**
     * An optional description of the experiment
     */
    experimentDescription?: string;
    /**
     * Metadata for the experiment
     */
    experimentMetadata?: Record<string, unknown>;
    /**
     * List of dataset split identifiers (GlobalIDs or names) to filter by
     */
    splits?: readonly string[];
    /**
     * Number of times the experiment should be repeated for each example
     * @default 1
     */
    repetitions?: number;
};
/**
 * Create a new experiment without running it.
 * This creates an experiment record that can later be executed using resumeExperiment.
 */
export declare function createExperiment({ client: _client, datasetId, datasetVersionId, experimentName, experimentDescription, experimentMetadata, splits, repetitions, }: CreateExperimentParams): Promise<ExperimentInfo>;
//# sourceMappingURL=createExperiment.d.ts.map