Sign in
DigitalOcean-public.v2-new_GradientAI Platform

Create Evaluation Test Case.

To create an evaluation test-case send a POST request to /v2/gen-ai/evaluation_test_cases.

post/v2/gen-ai/evaluation_test_cases

Request body

dataset_uuidstring

Dataset against which the test‑case is executed.

descriptionstring

Description of the test case.

metricsstring[]

Full metric list to use for evaluation test case.

namestring

Name of the test case.

workspace_uuidstring

The workspace uuid.

Example request

{
  "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "example string",
  "metrics": [
    "example string"
  ],
  "name": "example name",
  "star_metric": {
    "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "example name",
    "success_threshold": 123,
    "success_threshold_pct": 123
  },
  "workspace_uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Response

A successful response.

test_case_uuidstring

Test‑case UUID.

Example response

{
  "test_case_uuid": "123e4567-e89b-12d3-a456-426614174000"
}

Changes

Changed in 4 of the 8 revisions of this API.1430

  • 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

  • f8e8c290636c10See the full diff
    • ○

      api operation id create_evaluation_test_case removed and replaced with genai_create_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

    • ○

      added the new optional request property star_metric/success_threshold

      new-optional-request-property

    • ○

      request body became optional

      request-body-became-optional

    • ○

      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

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

  • 5fc9af728e82148See the full diff
    • ▲

      request body became required

      request-body-became-required

    • ●

      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 request property star_metric/success_threshold

      request-property-removed

    • ○

      api operation id genai_create_evaluation_test_case removed and replaced with create_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 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

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

  • f8e8c290636c10See the full diff
    • ○

      api operation id create_evaluation_test_case removed and replaced with genai_create_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

    • ○

      added the new optional request property star_metric/success_threshold

      new-optional-request-property

    • ○

      request body became optional

      request-body-became-optional

    • ○

      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

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