Retrieve
Retrieve Information About an Existing Evaluation Run
get/v2/gen-ai/evaluation_runs/{evaluation_run_uuid}
To retrive information about an existing evaluation run, send a GET request to /v2/gen-ai/evaluation_runs/{evaluation_run_uuid}.
Path Parameters
evaluation_run_uuidstring
Returns
evaluation_runagent_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
curl https://api.digitalocean.com//v2/gen-ai/evaluation_runs/$EVALUATION_RUN_UUID \
-H "Authorization: Bearer $GRADIENTAI_API_KEY"200 Example
{
"evaluation_run": {
"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
}
}