Update

API Reference

Agents

Evaluation Test Cases

Update an Evaluation Test Case.

agents.evaluation_test_cases.update(strpath_test_case_uuid, EvaluationTestCaseUpdateParams**kwargs) -> EvaluationTestCaseUpdateResponse

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

ParametersExpand Collapse

test_case_uuid: str

dataset_uuid: Optional[str]

Dataset against which the test‑case is executed.

description: Optional[str]

Description of the test case.

metrics: Optional[Metrics]

metric_uuids: Optional[SequenceNotStr[str]]

name: Optional[str]

Name of the test case.

star_metric: Optional[APIStarMetricParam]

metric_uuid: Optional[str]

name: Optional[str]

success_threshold: Optional[float]

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

formatfloat

success_threshold_pct: Optional[int]

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

formatint32

test_case_uuid: str

ReturnsExpand Collapse

class EvaluationTestCaseUpdateResponse: …

test_case_uuid: Optional[str]

version: Optional[int]

The new verson of the test case.

formatint32

Update an Evaluation Test Case.

python

• http
• typescript
• python

from gradient import Gradient

client = Gradient(
    access_token="My Access Token",
)
evaluation_test_case = client.agents.evaluation_test_cases.update(
    path_test_case_uuid="\"123e4567-e89b-12d3-a456-426614174000\"",
)
print(evaluation_test_case.test_case_uuid)

200 example

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

Returns Examples

200 example

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