List

API Reference

Agents

Evaluation Test Cases

List Evaluation Test Cases

get/v2/gen-ai/evaluation_test_cases

To list all evaluation test cases, send a GET request to /v2/gen-ai/evaluation_test_cases.

ReturnsExpand Collapse

evaluation_test_cases: optional array of APIEvaluationTestCase

Alternative way of authentication for internal usage only - should not be exposed to public api

HTTPPython

curl https://api.digitalocean.com/v2/gen-ai/evaluation_test_cases \
    -H "Authorization: Bearer $DIGITALOCEAN_ACCESS_TOKEN"

200 example

{
  "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

200 example

{
  "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
    }
  ]
}