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.

formatint64

Returns

evaluation_test_casearchived_atstringcreated_atstringcreated_by_user_emailstringcreated_by_user_idstringdataset_namestringdataset_uuidstringdescriptionstringlatest_version_number_of_runsnumbermetricsarray of APIEvaluationMetricnamestringstar_metricAPIStarMetrictest_case_uuidstringtotal_runsnumberupdated_atstringupdated_by_user_emailstringupdated_by_user_idstringversionnumberAPIEvaluationTestCase

optional

Request example cURL

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": "2019-12-27T18:11:19.117Z",
    "created_at": "2019-12-27T18:11:19.117Z",
    "created_by_user_email": "created_by_user_email",
    "created_by_user_id": "created_by_user_id",
    "dataset_name": "dataset_name",
    "dataset_uuid": "dataset_uuid",
    "description": "description",
    "latest_version_number_of_runs": 0,
    "metrics": [
      {
        "description": "description",
        "metric_name": "metric_name",
        "metric_type": "METRIC_TYPE_UNSPECIFIED",
        "metric_uuid": "metric_uuid",
        "metric_value_type": "METRIC_VALUE_TYPE_UNSPECIFIED"
      }
    ],
    "name": "name",
    "star_metric": {
      "metric_uuid": "metric_uuid",
      "name": "name",
      "success_threshold_pct": 0
    },
    "test_case_uuid": "test_case_uuid",
    "total_runs": 0,
    "updated_at": "2019-12-27T18:11:19.117Z",
    "updated_by_user_email": "updated_by_user_email",
    "updated_by_user_id": "updated_by_user_id",
    "version": 0
  }
}