Create

API Reference

Agents

Evaluation Test Cases

Create Evaluation Test Case.

agents.evaluation_test_cases.create(EvaluationTestCaseCreateParams**kwargs) -> EvaluationTestCaseCreateResponse

post/v2/gen-ai/evaluation_test_cases

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

ParametersExpand Collapse

dataset_uuid: Optional[str]

Dataset against which the test‑case is executed.

description: Optional[str]

Description of the test case.

metrics: Optional[SequenceNotStr[str]]

Full metric list to use for evaluation test case.

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

workspace_uuid: Optional[str]

The workspace uuid.

ReturnsExpand Collapse

class EvaluationTestCaseCreateResponse: …

test_case_uuid: Optional[str]

Test‑case UUID.

Create 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.create()
print(evaluation_test_case.test_case_uuid)

200 example

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

Returns Examples

200 example

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