List Evaluation Runs

List Evaluation Runs by Test Case

get/v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs

To list all evaluation runs by test case, send a GET request to /v2/gen-ai/evaluation_test_cases/{evaluation_test_case_uuid}/evaluation_runs.

Path Parameters

evaluation_test_case_uuidstring

Query Parameters

evaluation_test_case_versionnumber

optional

Version of the test case.

formatint64

Returns

evaluation_runsarray of agent_deletedbooleanagent_namestringagent_uuidstringagent_version_hashstringagent_workspace_uuidstringcreated_by_user_emailstringcreated_by_user_idstringerror_descriptionstringevaluation_run_uuidstringfinished_atstringpass_statusbooleanrun_level_metric_resultsarray of APIEvaluationMetricResultrun_namestringstar_metric_resultAPIEvaluationMetricResultstarted_atstringstatusenumtest_case_uuidstringtest_case_versionnumberAPIEvaluationRun

optional

List of evaluation runs.

Request example cURL

curl https://api.digitalocean.com//v2/gen-ai/evaluation_test_cases/$EVALUATION_TEST_CASE_UUID/evaluation_runs \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"

200 Example

{
  "evaluation_runs": [
    {
      "agent_deleted": true,
      "agent_name": "agent_name",
      "agent_uuid": "agent_uuid",
      "agent_version_hash": "agent_version_hash",
      "agent_workspace_uuid": "agent_workspace_uuid",
      "created_by_user_email": "created_by_user_email",
      "created_by_user_id": "created_by_user_id",
      "error_description": "error_description",
      "evaluation_run_uuid": "evaluation_run_uuid",
      "finished_at": "2019-12-27T18:11:19.117Z",
      "pass_status": true,
      "run_level_metric_results": [
        {
          "metric_name": "metric_name",
          "number_value": 0,
          "string_value": "string_value"
        }
      ],
      "run_name": "run_name",
      "star_metric_result": {
        "metric_name": "metric_name",
        "number_value": 0,
        "string_value": "string_value"
      },
      "started_at": "2019-12-27T18:11:19.117Z",
      "status": "EVALUATION_RUN_STATUS_UNSPECIFIED",
      "test_case_uuid": "test_case_uuid",
      "test_case_version": 0
    }
  ]
}