v8

latestOpenAPI 3.0.0Apache 2.0raw.githubusercontent.com2025-10-165266542.4 MB
DigitalOcean-public.v2-new_GradientAI Platform

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}.

get/v2/gen-ai/evaluation_test_cases/{test_case_uuid}

Path parameters

test_case_uuidstring required

The test case uuid to retrieve.

Query parameters

evaluation_test_case_versioninteger

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
  }
}