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.

Returns

evaluation_runsarray of agent_deletedbooleanagent_namestringagent_uuidstringagent_version_hashstringagent_workspace_uuidstringcreated_by_user_emailstringcreated_by_user_idstringerror_descriptionstringevaluation_run_uuidstringevaluation_test_case_workspace_uuidstringfinished_atstringpass_statusbooleanqueued_atstringrun_level_metric_resultsarray of APIEvaluationMetricResultrun_namestringstar_metric_resultAPIEvaluationMetricResultstarted_atstringstatusenumtest_case_descriptionstringtest_case_namestringtest_case_uuidstringtest_case_versionnumberAPIEvaluationRun

optional

List of evaluation runs.

HTTPPython

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": "\"example name\"",
      "agent_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "agent_version_hash": "\"example string\"",
      "agent_workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "created_by_user_email": "[email protected]",
      "created_by_user_id": "\"12345\"",
      "error_description": "\"example string\"",
      "evaluation_run_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "evaluation_test_case_workspace_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "finished_at": "2023-01-01T00:00:00Z",
      "pass_status": true,
      "queued_at": "2023-01-01T00:00:00Z",
      "run_level_metric_results": [
        {
          "error_description": "\"example string\"",
          "metric_name": "\"example name\"",
          "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
          "number_value": 123,
          "reasoning": "\"example string\"",
          "string_value": "\"example string\""
        }
      ],
      "run_name": "\"example name\"",
      "star_metric_result": {
        "error_description": "\"example string\"",
        "metric_name": "\"example name\"",
        "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
        "number_value": 123,
        "reasoning": "\"example string\"",
        "string_value": "\"example string\""
      },
      "started_at": "2023-01-01T00:00:00Z",
      "status": "EVALUATION_RUN_STATUS_UNSPECIFIED",
      "test_case_description": "\"example string\"",
      "test_case_name": "\"example name\"",
      "test_case_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
      "test_case_version": 123
    }
  ]
}