Get experiment by name | Opik Documentation

1 curl -X POST http://localhost:5173/api/v1/private/experiments/retrieve \ 2 -H "Content-Type: application/json" \ 3 -d '{ 4 "name": "name" 5 }'

1 { 2 "dataset_name": "dataset_name", 3 "id": "id", 4 "dataset_id": "dataset_id", 5 "name": "name", 6 "metadata": { 7 "key": "value" 8 }, 9 "feedback_scores": [ 10 { 11 "name": "name", 12 "value": 1.1 13 } 14 ], 15 "comments": [ 16 { 17 "text": "text", 18 "id": "id", 19 "created_at": "2024-01-15T09:30:00Z", 20 "last_updated_at": "2024-01-15T09:30:00Z", 21 "created_by": "created_by", 22 "last_updated_by": "last_updated_by" 23 } 24 ], 25 "trace_count": 1000000, 26 "created_at": "2024-01-15T09:30:00Z", 27 "last_updated_at": "2024-01-15T09:30:00Z", 28 "created_by": "created_by", 29 "last_updated_by": "last_updated_by", 30 "prompt_version": { 31 "id": "id", 32 "commit": "commit", 33 "prompt_id": "prompt_id" 34 }, 35 "prompt_versions": [ 36 { 37 "id": "id", 38 "commit": "commit", 39 "prompt_id": "prompt_id" 40 } 41 ] 42 }

Get experiment by name

Request

This endpoint expects an object.

namestringRequired

Response

Experiments resource

dataset_namestring

idstringOptionalformat: "uuid"

dataset_idstringOptionalformat: "uuid"

namestringOptional

metadatamap from strings to anyOptional

feedback_scoreslist of objectsOptional

commentslist of objectsOptional

trace_countlongOptional

created_atdatetimeOptional

last_updated_atdatetimeOptional

created_bystringOptional

last_updated_bystringOptional

prompt_versionobjectOptional

prompt_versionslist of objectsOptional

Request

Response

Errors