Run Test
run_testSubmit a quality test to evaluate a model's performance against a scenario using specified checks, and get a test run ID to retrieve scores later.
Instructions
Submit a quality test that evaluates a model against a scenario using checks.
Returns promptly so the call never times out on long runs. Short runs return
``status: "finished"`` with results ready; longer runs return
``status: "running"`` with the ``test_run_id`` and ``app_link`` — the run
continues to completion on its own. In both cases, poll get_test_run_results
with the returned test_run_id to retrieve scores.
Args:
scenario_name: Name of the scenario to evaluate against.
model_name: Name of the registered model to evaluate.
checks: List of check names to apply (e.g., ["coherence", "relevance"]).
Use list_checks to discover available checks and pick from the
category matching the task and modality — do not use
voice-specific checks for text evaluations (or vice versa);
checks outside voice-specific categories suit both.
name: Optional human-readable name for this test run.
type: Type of evaluation. Defaults to NL_GENERATION. Valid values:
NL_GENERATION, INFORMATION_RETRIEVAL, MULTI_CLASS_CLASSIFICATION,
INVARIANT, MULTI_TURN, AGENT_EVAL.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | ||
| type | No | NL_GENERATION | |
| checks | Yes | ||
| model_name | Yes | ||
| scenario_name | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |