Sign in
DigitalOcean-public.v2-new_GradientAI Platform

Run an Evaluation Test Case

To run an evaluation test case, send a POST request to /v2/gen-ai/evaluation_runs.

post/v2/gen-ai/evaluation_runs

Request body

agent_uuidsstring[]

Agent UUIDs to run the test case against.

run_namestring

The name of the run.

test_case_uuidstring

Test-case UUID to run

Example request

{
  "agent_uuids": [
    "example string"
  ],
  "run_name": "Evaluation Run Name",
  "test_case_uuid": "\"12345678-1234-1234-1234-123456789012\""
}

Response

A successful response.

evaluation_run_uuidsstring[]

Example response

{
  "evaluation_run_uuids": [
    "example string"
  ]
}

Changes

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

  • 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

  • f8e8c290636c9See the full diff
    • ○

      api operation id run_evaluation_test_case removed and replaced with genai_run_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

    • ○

      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

  • 5fc9af728e82138See 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

    • ○

      api operation id genai_run_evaluation_test_case removed and replaced with run_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

  • f8e8c290636c9See the full diff
    • ○

      api operation id run_evaluation_test_case removed and replaced with genai_run_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

    • ○

      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

  • e8b3cbc80e1822See the full diff
    • ●

      removed the request property agent_uuid

      request-property-removed

    • ●

      removed the optional property evaluation_run_uuid from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional request property agent_uuids

      new-optional-request-property

    • ○

      added the optional property evaluation_run_uuids to the response with the 200 status

      response-optional-property-added