Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

List Evaluation Test Cases

API Reference
Agents
Evaluation Metrics
Workspaces
List Evaluation Test Cases by Workspace
get/v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases

To list all evaluation test cases by a workspace, send a GET request to /v2/gen-ai/workspaces/{workspace_uuid}/evaluation_test_cases.

Path ParametersExpand Collapse
workspace_uuid: string
ReturnsExpand Collapse
evaluation_test_cases: optional array of APIEvaluationTestCase { archived_at, created_at, created_by_user_email, 15 more }
archived_at: optional string
created_at: optional string
created_by_user_email: optional string
created_by_user_id: optional string
dataset: optional object { created_at, dataset_name, dataset_uuid, 3 more }
created_at: optional string

Time created at.

formatdate-time
dataset_name: optional string

Name of the dataset.

dataset_uuid: optional string

UUID of the dataset.

file_size: optional string

The size of the dataset uploaded file in bytes.

formatuint64
has_ground_truth: optional boolean

Does the dataset have a ground truth column?

row_count: optional number

Number of rows in the dataset.

formatint64
dataset_name: optional string
dataset_uuid: optional string
description: optional string
latest_version_number_of_runs: optional number
metrics: optional array of APIEvaluationMetric { description, inverted, metric_name, 5 more }
description: optional string
inverted: optional boolean

If true, the metric is inverted, meaning that a lower value is better.

metric_name: optional string
metric_type: optional "METRIC_TYPE_UNSPECIFIED" or "METRIC_TYPE_GENERAL_QUALITY" or "METRIC_TYPE_RAG_AND_TOOL"
Accepts one of the following:
"METRIC_TYPE_UNSPECIFIED"
"METRIC_TYPE_GENERAL_QUALITY"
"METRIC_TYPE_RAG_AND_TOOL"
metric_uuid: optional string
metric_value_type: optional "METRIC_VALUE_TYPE_UNSPECIFIED" or "METRIC_VALUE_TYPE_NUMBER" or "METRIC_VALUE_TYPE_STRING" or "METRIC_VALUE_TYPE_PERCENTAGE"
Accepts one of the following:
"METRIC_VALUE_TYPE_UNSPECIFIED"
"METRIC_VALUE_TYPE_NUMBER"
"METRIC_VALUE_TYPE_STRING"
"METRIC_VALUE_TYPE_PERCENTAGE"
range_max: optional number

The maximum value for the metric.

formatfloat
range_min: optional number

The minimum value for the metric.

formatfloat
name: optional string
star_metric: optional APIStarMetric { metric_uuid, name, success_threshold, success_threshold_pct }
metric_uuid: optional string
name: optional string
success_threshold: optional number

The success threshold for the star metric. This is a value that the metric must reach to be considered successful.

formatfloat
success_threshold_pct: optional number

The success threshold for the star metric. This is a percentage value between 0 and 100.

formatint32
test_case_uuid: optional string
total_runs: optional number
updated_at: optional string
updated_by_user_email: optional string
updated_by_user_id: optional string
version: optional number
List Evaluation Test Cases by Workspace
  • http
  • typescript
  • python
curl https://api.digitalocean.com/v2/gen-ai/workspaces/$WORKSPACE_UUID/evaluation_test_cases \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"
{
  "evaluation_test_cases": [
    {
      "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
    }
  ]
}
Returns Examples
{
  "evaluation_test_cases": [
    {
      "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
    }
  ]
}