Experiments Methods

compareRunEvents

compareRunEvents(request: GetExperimentCompareEventsRequest): Promise<GetExperimentCompareEventsResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Compare events between two experiment runs Retrieve and compare events between two experiment runs for detailed analysis

compareRuns

compareRuns(request: GetExperimentComparisonRequest): Promise<GetExperimentComparisonResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Retrieve experiment comparison Compare metrics and results between two experiment runs in the project.

createRun

createRun(request: CreateRunRequest): Promise<CreateRunResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Create a new evaluation run Create a new experiment run to track an evaluation against a dataset.

deleteRun

deleteRun(request: DeleteRunRequest): Promise<DeleteRunResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Delete an evaluation run Permanently delete an experiment run by its run ID.

getRun

getRun(request: GetRunRequest): Promise<GetRunResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Get details of an evaluation run Retrieve the full details of a single experiment run by its run ID.

getRunMetrics

getRunMetrics(request: GetExperimentRunMetricsRequest): Promise<GetExperimentRunMetricsResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Get event metrics for an experiment run Retrieve event metrics from ClickHouse for a specific experiment run

getRunSchema

getRunSchema(request: GetRunSchemaRequest): Promise<GetRunSchemaResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Get events schema for a single experiment run Retrieve the events schema (fields, datasets, mappings) for a single experiment run.

getRunsSchema

getRunsSchema(request?: GetRunsSchemaRequest): Promise<GetRunsSchemaResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Get events schema across all experiment runs in a project Retrieve the aggregated events schema (fields, datasets, mappings) across all experiment runs in the project.

getSummary

getSummary(request: GetExperimentSummaryRequest): Promise<GetExperimentSummaryResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Retrieve experiment summary Compute evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.

listRuns

listRuns(request?: GetRunsRequest): Promise<GetRunsResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Get a list of evaluation runs List experiment runs with optional filtering by dataset, status, name, date range, and specific run IDs. Results are paginated and sortable.

updateRun

updateRun(request: UpdateRunRequest): Promise<UpdateRunResponse>

Accepted keys: Data plane fine-grained API key with project_id; Project API key without project_id (deprecated) Update an evaluation run Update fields on an existing experiment run such as name, status, metadata, or results.