For AI agents: The documentation index is at https://docs.digitalocean.com/llms.txt. Markdown versions of pages use the same URL with index.html.md in place of the HTML page (for example, append index.html.md to the directory path instead of opening the HTML document).

Usage

client.genai.run_evaluation_test_case(
    body={
        "agent_deployment_names": [...],
        "agent_uuids": [...],
        "run_name": "Evaluation Run Name",
        ...,
    },
)

Description

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

Parameters

agent_deployment_names array of strings optional

Example: ['example string']

Agent deployment names to run the test case against (ADK agent workspaces).

agent_uuids array of strings optional

Example: ['example string']

Agent UUIDs to run the test case against (legacy agents).

run_name string optional

Example: Evaluation Run Name

The name of the run.

test_case_uuid string optional

Example: "12345678-1234-1234-1234-123456789012"

Test-case UUID to run

Request Sample

import os
from pydo import Client

client = Client(token=os.environ.get("DIGITALOCEAN_TOKEN"))

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

resp = client.genai.run_evaluation_test_case(body=req)

Response Example

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

More Information

See /v2/gen-ai/evaluation_runs in the API reference for additional detail on responses, headers, parameters, and more.