PUT /v2/gen-ai/evaluation_test_cases/{test_case_uuid}

To update an evaluation test-case send a PUT request to /v2/gen-ai/evaluation_test_cases/{test_case_uuid}.

Servers

Path parameters

Name Type Required Description
test_case_uuid String Yes

Test-case UUID to update

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
metrics Object No
metrics.metric_uuids[] Array No
test_case_uuid String No

Test-case UUID to update

name String No

Name of the test case.

description String No

Description of the test case.

dataset_uuid String No

Dataset against which the test‑case is executed.

star_metric Object No
star_metric.success_threshold Number No

The success threshold for the star metric. This is a value that the metric must reach to be considered successful.

star_metric.name String No
star_metric.success_threshold_pct Integer No

The success threshold for the star metric. This is a percentage value between 0 and 100.

star_metric.metric_uuid String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.