experiment

Experiments Available Columns

Changed on

Procures the column information for experiments.

post/v2/projects/{project_id}/experiments/available_columns

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/v2/projects/{project_id}/experiments/available_columns
  • 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

Response

Successful Response

Example response

{
  "columns": [
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "uuid",
      "description": "Galileo ID of the experiment",
      "filterable": true,
      "group_label": "Standard",
      "id": "id",
      "is_empty": false,
      "is_optional": false,
      "label": "ID",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "timestamp",
      "description": "Timestamp of the experiment's creation",
      "filterable": true,
      "group_label": "Standard",
      "id": "created_at",
      "is_empty": false,
      "is_optional": false,
      "label": "Created",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "timestamp",
      "description": "Timestamp of the trace or span's last update",
      "filterable": true,
      "group_label": "Standard",
      "id": "updated_at",
      "is_empty": false,
      "is_optional": true,
      "label": "Last Updated",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "text",
      "description": "Name of the experiment",
      "filterable": true,
      "group_label": "Standard",
      "id": "name",
      "is_empty": false,
      "is_optional": false,
      "label": "Name",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "uuid",
      "description": "Galileo ID of the project associated with this experiment",
      "filterable": true,
      "group_label": "Standard",
      "id": "project_id",
      "is_empty": false,
      "is_optional": false,
      "label": "Project ID",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "floating_point",
      "filterable": true,
      "group_label": "Standard",
      "id": "ranking_score",
      "is_empty": false,
      "is_optional": true,
      "label": "Ranking Score",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "uuid",
      "filterable": true,
      "group_label": "Standard",
      "id": "playground_id",
      "is_empty": false,
      "is_optional": true,
      "label": "Playground Id",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "uuid",
      "filterable": true,
      "group_label": "Standard",
      "id": "experiment_group_id",
      "is_empty": false,
      "is_optional": true,
      "label": "Experiment Group Id",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "text",
      "filterable": true,
      "group_label": "Standard",
      "id": "experiment_group_name",
      "is_empty": false,
      "is_optional": true,
      "label": "Experiment Group Name",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "standard",
      "data_type": "boolean",
      "filterable": true,
      "group_label": "Standard",
      "id": "experiment_group_is_system",
      "is_empty": false,
      "is_optional": true,
      "label": "Experiment Group Is System",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "metric",
      "data_type": "floating_point",
      "filterable": true,
      "id": "metrics/average_cost",
      "is_empty": false,
      "is_optional": false,
      "label": "Average Cost",
      "multi_valued": false,
      "sortable": true
    },
    {
      "applicable_types": [],
      "category": "metric",
      "data_type": "integer",
      "filterable": true,
      "id": "metrics/total_responses",
      "is_empty": false,
      "is_optional": false,
      "label": "Total Responses",
      "multi_valued": false,
      "sortable": true
    }
  ]
}

Changes

    • warning

      added the new retrieved_chunk_list_boolean enum value to the /// response property for the response status

    • info

      added the optional property // to the response with the status

    • warning

      added the new http enum value to the /// response property for the response status