Create

API Reference

Agents

Evaluation Runs

Run an Evaluation Test Case

agents.evaluation_runs.create(EvaluationRunCreateParams**kwargs) -> EvaluationRunCreateResponse

post/v2/gen-ai/evaluation_runs

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

ParametersExpand Collapse

agent_uuids: Optional[SequenceNotStr[str]]

Agent UUIDs to run the test case against.

run_name: Optional[str]

The name of the run.

test_case_uuid: Optional[str]

Test-case UUID to run

ReturnsExpand Collapse

class EvaluationRunCreateResponse: …

evaluation_run_uuids: Optional[List[str]]

Run an Evaluation Test Case

python

• http
• typescript
• python

from gradient import Gradient

client = Gradient(
    access_token="My Access Token",
)
evaluation_run = client.agents.evaluation_runs.create()
print(evaluation_run.evaluation_run_uuids)

200 example

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

Returns Examples

200 example

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