Sign in
experiment

Update Experiment

Update a specific experiment.

put/v2/projects/{project_id}/experiments/{experiment_id}

Path parameters

experiment_idstring uuid4 required
project_idstring uuid4 required

Request body

namestring required
experiment_group_idstring uuid4 nullable
experiment_group_namestring nullable

Response

Successful Response

idstring uuid4 required

Galileo ID of the experiment

created_atstring date-time

Timestamp of the experiment's creation

updated_atstring date-time nullable

Timestamp of the trace or span's last update

namestring

Name of the experiment

project_idstring uuid4 required

Galileo ID of the project associated with this experiment

created_bystring uuid4 nullable
num_spansinteger nullable
num_tracesinteger nullable
num_sessionsinteger nullable
task_type13 | 15 | 16 | 17 | 18 required

Valid task types for modeling.

We store these as ints instead of strings because we will be looking this up in the database frequently.

aggregate_metricsobject
structured_aggregate_metricsobject nullable

Structured aggregate metrics with full statistical aggregates (avg, min, max, sum, count). Keys are scorer UUIDs for scorer-backed metrics (matching available_columns column IDs after stripping the 'metrics/' prefix) and raw strings for system metrics (e.g. 'duration_ns', 'cost'). Present only when use_clickhouse_run_aggregates flag is enabled.

aggregate_feedbackobject

Aggregate feedback information related to the experiment (traces only)

rating_aggregatesobject

Annotation aggregates keyed by template ID and root type

ranking_scorenumber nullable
rankinteger nullable
winnerboolean nullable
playground_idstring uuid4 nullable
prompt_modelstring nullable
tagsobject
experiment_group_idstring uuid4 nullable
experiment_group_namestring nullable
experiment_group_is_systemboolean nullable

Changes

Changed in 2 of the 14 revisions of this API.4

  • 933e8c8e63663See the full diff
    • ○

      removed the 12.00 enum value from the task_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the 7.00 enum value from the task_type response property for the response status 200

      response-property-enum-value-removed

    • ○

      removed the 9.00 enum value from the task_type response property for the response status 200

      response-property-enum-value-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 05003e7835a21See the full diff
    • ○

      the endpoint scheme security ClassicAPIKeyHeader was added to the API

      api-security-added

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog