Retrieve
Retrieve Information About an Existing Evaluation Test Case
get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}
To retrive information about an existing evaluation test case, send a GET request to /v2/gen-ai/evaluation_test_case/{test_case_uuid}.
Path Parameters
test_case_uuidstring
Query Parameters
evaluation_test_case_versionnumber
optional
Version of the test case.
Returns
evaluation_test_casearchived_atstringcreated_atstringcreated_by_user_emailstringcreated_by_user_idstringdatasetobjectdataset_namestringdataset_uuidstringdescriptionstringlatest_version_number_of_runsnumbermetricsarray of APIEvaluationMetricnamestringstar_metricAPIStarMetrictest_case_uuidstringtotal_runsnumberupdated_atstringupdated_by_user_emailstringupdated_by_user_idstringversionnumberAPIEvaluationTestCase
optional
curl https://api.digitalocean.com//v2/gen-ai/evaluation_test_cases/$TEST_CASE_UUID \
-H "Authorization: Bearer $GRADIENTAI_API_KEY"200 Example
{
"evaluation_test_case": {
"archived_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"created_by_user_email": "[email protected]",
"created_by_user_id": "\"12345\"",
"dataset": {
"created_at": "2023-01-01T00:00:00Z",
"dataset_name": "\"example name\"",
"dataset_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"file_size": "\"12345\"",
"has_ground_truth": true,
"row_count": 123
},
"dataset_name": "\"example name\"",
"dataset_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"description": "\"example string\"",
"latest_version_number_of_runs": 123,
"metrics": [
{
"description": "\"example string\"",
"inverted": true,
"metric_name": "\"example name\"",
"metric_type": "METRIC_TYPE_UNSPECIFIED",
"metric_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED",
"range_max": 123,
"range_min": 123
}
],
"name": "\"example name\"",
"star_metric": {
"metric_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"name": "\"example name\"",
"success_threshold": 123,
"success_threshold_pct": 123
},
"test_case_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
"total_runs": 123,
"updated_at": "2023-01-01T00:00:00Z",
"updated_by_user_email": "[email protected]",
"updated_by_user_id": "\"12345\"",
"version": 123
}
}