experiment

Create Experiment

Changed on

Create a new experiment for a project.

post/projects/{project_id}/experiments

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/projects/{project_id}/experiments
  • Auth
    • API key in header Splunk-AO-API-Key
    • or API key in header Galileo-API-Key
    • or OAuth 2
      Password
      Token URL: https://api.galileo.ai/login
    • or HTTP basic

Path parameters

project_idstring uuid4 required

Request body

namestring required
playground_idstring uuid4 nullable
prompt_template_version_idstring uuid4 nullable
playground_prompt_idstring uuid4 nullable
triggerboolean
experiment_group_idstring uuid4 nullable
experiment_group_namestring nullable

Example request

{
  "scorers": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ]
}

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 | 19 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

  • 0b20eade6391Revision changes
    • breaking

      removed the enum value vegas_gateway of the request property ////

    • info

      added subschema #2 to the // request property anyOf list

    • info

      added subschema #2 to the ////// request property anyOf list

  • 0897291b6ee2Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //