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

Changes

Changed in 5 of the 8 revisions of this API.11040

    • 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

  • f8e8c290636c114See the full diff
    • added the new METRIC_VALUE_TYPE_PERCENTAGE enum value to the /// response property for the response status

      response-property-enum-value-added

    • api operation id get_evaluation_test_case removed and replaced with genai_get_evaluation_test_case

      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

    • for the query request parameter evaluation_test_case_version, the format was generalized from int64 to no format

      request-parameter-type-generalized

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the 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

  • 5fc9af728e82189See the full diff
    • for the query request parameter evaluation_test_case_version, the format changed from no format to int64

      request-parameter-type-changed

    • 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 / from the response with the status

      response-optional-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    • removed the optional property /// from the response with the status

      response-optional-property-removed

    • removed the optional property // from the response with the status

      response-optional-property-removed

    • api operation id genai_get_evaluation_test_case removed and replaced with get_evaluation_test_case

      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

      response-non-success-status-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • removed the non-success response with the status

      response-non-success-status-removed

    • removed the METRIC_VALUE_TYPE_PERCENTAGE enum value from the /// response property for the response status

      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

  • f8e8c290636c114See the full diff
    • added the new METRIC_VALUE_TYPE_PERCENTAGE enum value to the /// response property for the response status

      response-property-enum-value-added

    • api operation id get_evaluation_test_case removed and replaced with genai_get_evaluation_test_case

      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

    • for the query request parameter evaluation_test_case_version, the format was generalized from int64 to no format

      request-parameter-type-generalized

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the non-success response with the status

      response-non-success-status-added

    • added the optional property / to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property /// to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the 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

    • added the new optional query request parameter evaluation_test_case_version

      new-optional-request-parameter