Get experiment by id | Opik Documentation

1	curl http://localhost:5173/api/v1/private/experiments/id

{
  "dataset_name": "string",
  "id": "string",
  "dataset_id": "string",
  "project_id": "string",
  "project_name": "string",
  "name": "string",
  "metadata": {},
  "tags": [
    "string"
  ],
  "type": "regular",
  "evaluation_method": "dataset",
  "optimization_id": "string",
  "feedback_scores": [
    {
      "name": "string",
      "value": 1.1
    }
  ],
  "comments": [
    {
      "text": "string",
      "id": "string",
      "created_at": "2024-01-15T09:30:00Z",
      "last_updated_at": "2024-01-15T09:30:00Z",
      "created_by": "string",
      "last_updated_by": "string"
    }
  ],
  "trace_count": 1,
  "dataset_item_count": 1,
  "created_at": "2024-01-15T09:30:00Z",
  "duration": {
    "p50": 1.1,
    "p90": 1.1,
    "p99": 1.1
  },
  "total_estimated_cost": 1.1,
  "total_estimated_cost_avg": 1.1,
  "usage": {},
  "last_updated_at": "2024-01-15T09:30:00Z",
  "created_by": "string",
  "last_updated_by": "string",
  "status": "running",
  "experiment_scores": [
    {
      "name": "string",
      "value": 1.1
    }
  ],
  "prompt_version": {
    "prompt_version_id": "string",
    "commit": "string",
    "prompt_id": "string",
    "prompt_name": "string"
  },
  "prompt_versions": [
    {
      "prompt_version_id": "string",
      "commit": "string",
      "prompt_id": "string",
      "prompt_name": "string"
    }
  ],
  "dataset_version_id": "string",
  "dataset_version_summary": {
    "id": "string",
    "version_hash": "string",
    "version_name": "string",
    "change_description": "string",
    "tags": [
      "string"
    ]
  },
  "pass_rate": 1.1,
  "passed_count": 1,
  "total_count": 1,
  "assertion_scores": [
    {
      "name": "string",
      "value": 1.1
    }
  ]
}

Get experiment by id

Path parameters

idstringRequiredformat: "uuid"

Response

Experiment resource

dataset_namestring or null>=1 character

idstringformat: "uuid"

dataset_idstringRead-onlyformat: "uuid"

project_idstringformat: "uuid"

Project ID. Takes precedence over project_name when both are provided.

project_namestringformat: "(?s)^\s*(\S.*\S|\S)\s*$"

Project name. Creates project if it doesn’t exist. Ignored when project_id is provided.

namestring

metadatamap from strings to any or list of objects or string

tagslist of strings

typeenum

Allowed values:

evaluation_methodenum

Allowed values:

optimization_idstringformat: "uuid"

feedback_scoreslist of objectsRead-only

commentslist of objectsRead-only

trace_countlongRead-only

dataset_item_countlongRead-only

created_atdatetimeRead-only

durationobject

total_estimated_costdoubleRead-only

total_estimated_cost_avgdoubleRead-only

usagemap from strings to doublesRead-only

last_updated_atdatetimeRead-only

created_bystringRead-only

last_updated_bystringRead-only

statusenum

Allowed values:

experiment_scoreslist of objects

prompt_versionobject

prompt_versionslist of objects

dataset_version_idstringformat: "uuid"

ID of the dataset version this experiment is linked to. If not provided at creation, experiment will be automatically linked to the latest version.

dataset_version_summaryobjectRead-only

Summary of the latest dataset version

pass_ratedoubleRead-only

Pass rate for test suite experiments (0.0-1.0). Null for regular experiments.

passed_countlongRead-only

Number of items that passed for test suite experiments. Null for regular experiments.

total_countlongRead-only

Total number of items for test suite experiments. Null for regular experiments.

assertion_scoreslist of objectsRead-only

Per-assertion average pass rates for test suite experiments. Null for regular experiments.

Errors

404

Not Found Error