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.create_evaluation_test_case(
    body={
        "agent_workspace_name": "example name",
        "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "description": "example string",
        ...,
    },
)

Description

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

Parameters

agent_workspace_name string optional

Example: example name

dataset_uuid string optional

Example: 123e4567-e89b-12d3-a456-426614174000

Dataset against which the test‑case is executed.

description string optional

Example: example string

Description of the test case.

metrics array of strings optional

Example: ['example string']

Full metric list to use for evaluation test case.

name string optional

Example: example name

Name of the test case.

star_metric object optional

Show child properties

metric_uuid string optional

Example: 123e4567-e89b-12d3-a456-426614174000

name string optional

Example: example name

success_threshold number optional

Example: 123

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

success_threshold_pct integer optional

Example: 123

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

workspace_uuid string optional

Example: 123e4567-e89b-12d3-a456-426614174000

The workspace uuid.

Request Sample

import os
from pydo import Client

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

req = {
  "agent_workspace_name": "example name",
  "dataset_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "description": "example string",
  "metrics": [
    "example string"
  ],
  "name": "example name",
  "star_metric": {
    "metric_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "name": "example name",
    "success_threshold": 123,
    "success_threshold_pct": 123
  },
  "workspace_uuid": "123e4567-e89b-12d3-a456-426614174000"
}

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

Response Example

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

More Information

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