Get optimization by id | Opik Documentation

curl http://localhost:5173/api/v1/private/optimizations/id \
     -H "Content-Type: application/json"

{
  "dataset_name": "CIFAR-10",
  "objective_name": "accuracy",
  "status": "running",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "Image Classification Optimization",
  "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
  "metadata": {
    "notes": "Initial run with default parameters",
    "tags": [
      "baseline",
      "image-classification"
    ]
  },
  "studio_config": {
    "dataset_name": "CIFAR-10",
    "prompt": {
      "messages": [
        {
          "role": "system",
          "content": "Optimize model hyperparameters for best accuracy on CIFAR-10 dataset."
        }
      ]
    },
    "llm_model": {
      "model": "gpt-4-opik",
      "parameters": {
        "temperature": 0.7,
        "max_tokens": 512
      }
    },
    "evaluation": {
      "metrics": [
        {
          "type": "accuracy",
          "parameters": {
            "top_k": 1
          }
        }
      ]
    },
    "optimizer": {
      "type": "bayesian",
      "parameters": {
        "initial_points": 5,
        "n_iter": 25
      }
    }
  },
  "dataset_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "num_trials": 30,
  "feedback_scores": [
    {
      "name": "user_satisfaction",
      "value": 4.5
    }
  ],
  "experiment_scores": [
    {
      "name": "validation_accuracy",
      "value": 0.87
    }
  ],
  "created_at": "2024-01-15T09:30:00Z",
  "created_by": "alice@example.com",
  "last_updated_at": "2024-01-20T15:45:00Z",
  "last_updated_by": "bob@example.com",
  "baseline_objective_score": 0.75,
  "best_objective_score": 0.89,
  "baseline_duration": 3600,
  "best_duration": 4200,
  "baseline_cost": 50,
  "best_cost": 65,
  "total_optimization_cost": 115
}

Get optimization by id

Path parameters

idstringRequiredformat: "uuid"

Response

Optimization resource

dataset_namestring>=1 character

objective_namestring>=1 character

statusenum

Allowed values:

idstringformat: "uuid"

namestring

project_idstringformat: "uuid"

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

metadatamap from strings to any or list of objects or string

studio_configobject

dataset_idstringRead-onlyformat: "uuid"

num_trialslongRead-only

feedback_scoreslist of objectsRead-only

experiment_scoreslist of objectsRead-only

created_atdatetimeRead-only

created_bystringRead-only

last_updated_atdatetime

last_updated_bystringRead-only

baseline_objective_scoredoubleRead-only

best_objective_scoredoubleRead-only

baseline_durationdoubleRead-only

best_durationdoubleRead-only

baseline_costdoubleRead-only

best_costdoubleRead-only

total_optimization_costdoubleRead-only

Errors

404

Not Found Error