Find optimizations | Opik Documentation

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

{
  "page": 1,
  "size": 1,
  "total": 1,
  "content": [
    {
      "dataset_name": "Customer Churn Dataset",
      "objective_name": "Maximize Accuracy",
      "status": "running",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Hyperparameter Tuning Run 2024-06",
      "project_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "metadata": {
        "notes": "Initial tuning phase",
        "tags": [
          "churn",
          "classification",
          "priority-high"
        ]
      },
      "studio_config": {
        "dataset_name": "Customer Churn Dataset",
        "prompt": {
          "messages": [
            {
              "role": "system",
              "content": "Optimize hyperparameters for classification model to maximize accuracy."
            }
          ]
        },
        "llm_model": {
          "model": "gpt-4-opik",
          "parameters": {
            "temperature": 0.7,
            "max_tokens": 512
          }
        },
        "evaluation": {
          "metrics": [
            {
              "type": "accuracy",
              "parameters": {
                "average": "macro"
              }
            }
          ]
        },
        "optimizer": {
          "type": "bayesian",
          "parameters": {
            "init_points": 5,
            "n_iter": 25
          }
        }
      },
      "dataset_id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
      "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-06-10T14:45:00Z",
      "last_updated_by": "bob@example.com",
      "baseline_objective_score": 0.75,
      "best_objective_score": 0.89,
      "baseline_duration": 3600,
      "best_duration": 5400,
      "baseline_cost": 120,
      "best_cost": 180,
      "total_optimization_cost": 300
    }
  ],
  "sortableBy": [
    "created_at",
    "best_objective_score",
    "status"
  ]
}

Find optimizations

Query parameters

pageintegerOptional>=1Defaults to 1

sizeintegerOptional>=1Defaults to 10

dataset_idstringOptionalformat: "uuid"

namestringOptional

dataset_namestringOptional

dataset_deletedbooleanOptional

project_idstringOptionalformat: "uuid"

filtersstringOptional

Response

Optimizations resource

pageinteger

sizeinteger

totallong

contentlist of objects

sortableBylist of strings

Errors

400

Bad Request Error