Sign in
DigitalOcean-public.v2-new_GradientAI Platform

List Evaluation Test Cases

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

get/v2/gen-ai/evaluation_test_cases

Response

A successful response.

Example response

{
  "evaluation_test_cases": [
    {
      "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 4 of the 8 revisions of this API.1037

  • cb3bf9b214592See the full diff
    • ○

      api tag DigitalOcean-public.v2-new_GradientAI Platform added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f8e8c290636c113See the full diff
    • ●

      added the new METRIC_VALUE_TYPE_PERCENTAGE enum value to the evaluation_test_cases/items/metrics/items/metric_value_type response property for the response status 200

      response-property-enum-value-added

    • ○

      api operation id list_evaluation_test_cases removed and replaced with genai_list_evaluation_test_cases

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      added the optional property evaluation_test_cases/items/dataset to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/metrics/items/inverted to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/metrics/items/range_max to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/metrics/items/range_min to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/star_metric/success_threshold to the response with the 200 status

      response-optional-property-added

    This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 5fc9af728e8289See the full diff
    • ●

      the optional response header ratelimit-limit removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-remaining removed for the status 200

      optional-response-header-removed

    • ●

      the optional response header ratelimit-reset removed for the status 200

      optional-response-header-removed

    • ●

      removed the optional property evaluation_test_cases/items/dataset from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property evaluation_test_cases/items/metrics/items/inverted from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property evaluation_test_cases/items/metrics/items/range_max from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property evaluation_test_cases/items/metrics/items/range_min from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property evaluation_test_cases/items/star_metric/success_threshold from the response with the 200 status

      response-optional-property-removed

    • ○

      api operation id genai_list_evaluation_test_cases removed and replaced with list_evaluation_test_cases

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was removed from the API

      api-security-removed

    • ○

      api tag GenAIAPI added

      api-tag-added

    • ○

      api tag GradientAI Platform removed

      api-tag-removed

    • ○

      removed the non-success response with the status 401

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 404

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 429

      response-non-success-status-removed

    • ○

      removed the non-success response with the status 500

      response-non-success-status-removed

    • ○

      removed the METRIC_VALUE_TYPE_PERCENTAGE enum value from the evaluation_test_cases/items/metrics/items/metric_value_type response property for the response status 200

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

  • f8e8c290636c113See the full diff
    • ●

      added the new METRIC_VALUE_TYPE_PERCENTAGE enum value to the evaluation_test_cases/items/metrics/items/metric_value_type response property for the response status 200

      response-property-enum-value-added

    • ○

      api operation id list_evaluation_test_cases removed and replaced with genai_list_evaluation_test_cases

      api-operation-id-removed

    • ○

      the endpoint scheme security bearer_auth was added to the API

      api-security-added

    • ○

      api tag GradientAI Platform added

      api-tag-added

    • ○

      api tag GenAIAPI removed

      api-tag-removed

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

    • ○

      added the optional property evaluation_test_cases/items/dataset to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/metrics/items/inverted to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/metrics/items/range_max to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/metrics/items/range_min to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property evaluation_test_cases/items/star_metric/success_threshold to the response with the 200 status

      response-optional-property-added

    This revision also has 70 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog