Retrieve Information About an Existing Evaluation Test Case
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
The test case uuid to retrieve.
Query parameters
Version of the test case.
Response
A successful response.
Example response
{
"evaluation_test_case": {
"archived_at": "2023-01-01T00:00:00Z",
"created_at": "2023-01-01T00:00:00Z",
"created_by_user_email": "example@example.com",
"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": "example@example.com",
"updated_by_user_id": "12345",
"version": 123
}
}Changes
Changed in 5 of the 8 revisions of this API.11040
- ○
api tag
DigitalOcean-public.v2-new_GradientAI Platformaddedapi-tag-added
- ○
api tag
GradientAI Platformremovedapi-tag-removed
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○
- ●
added the new
METRIC_VALUE_TYPE_PERCENTAGEenum value to the///response property for the response statusresponse-property-enum-value-added
- ○
api operation id
get_evaluation_test_caseremoved and replaced withgenai_get_evaluation_test_caseapi-operation-id-removed
- ○
the endpoint scheme security
bearer_authwas added to the APIapi-security-added
- ○
api tag
GradientAI Platformaddedapi-tag-added
- ○
api tag
GenAIAPIremovedapi-tag-removed
- ○
for the
queryrequest parameterevaluation_test_case_version, the format was generalized fromint64to no formatrequest-parameter-type-generalized
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ▲
for the
queryrequest parameterevaluation_test_case_version, the format changed from no format toint64request-parameter-type-changed
- ●
the optional response header
ratelimit-limitremoved for the status200optional-response-header-removed
- ●
the optional response header
ratelimit-remainingremoved for the status200optional-response-header-removed
- ●
the optional response header
ratelimit-resetremoved for the status200optional-response-header-removed
- ●
removed the optional property
/from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
///from the response with the statusresponse-optional-property-removed
- ●
removed the optional property
//from the response with the statusresponse-optional-property-removed
- ○
api operation id
genai_get_evaluation_test_caseremoved and replaced withget_evaluation_test_caseapi-operation-id-removed
- ○
the endpoint scheme security
bearer_authwas removed from the APIapi-security-removed
- ○
api tag
GenAIAPIaddedapi-tag-added
- ○
api tag
GradientAI Platformremovedapi-tag-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
removed the non-success response with the status
response-non-success-status-removed
- ○
removed the
METRIC_VALUE_TYPE_PERCENTAGEenum value from the///response property for the response statusresponse-property-enum-value-removed
This revision also has 436 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ●
added the new
METRIC_VALUE_TYPE_PERCENTAGEenum value to the///response property for the response statusresponse-property-enum-value-added
- ○
api operation id
get_evaluation_test_caseremoved and replaced withgenai_get_evaluation_test_caseapi-operation-id-removed
- ○
the endpoint scheme security
bearer_authwas added to the APIapi-security-added
- ○
api tag
GradientAI Platformaddedapi-tag-added
- ○
api tag
GenAIAPIremovedapi-tag-removed
- ○
for the
queryrequest parameterevaluation_test_case_version, the format was generalized fromint64to no formatrequest-parameter-type-generalized
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the non-success response with the status
response-non-success-status-added
- ○
added the optional property
/to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
///to the response with the statusresponse-optional-property-added
- ○
added the optional property
//to the response with the statusresponse-optional-property-added
This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ●
- ○
added the new optional
queryrequest parameterevaluation_test_case_versionnew-optional-request-parameter
- ○