Skip to main content
POST
Runs the evaluator to check if a task was completed successfully. Compares the current VM state against the expected outcome defined in the task configuration and produces a score from 0.0 to 1.0.
Explore live examples of evaluator configurations at gym.scale.com.

Request Body

string
required
VM identifier
object
required
Task configuration with evaluator definition

Evaluator Configuration

The evaluator object within task_config defines how to verify task completion.

Core Fields

string
required
Evaluation function to use (e.g., compare_table, file_check, exact_match)
object
required
Expected/gold standard file configuration
object
required
Result file from the VM to compare
array
Actions to run before evaluation (e.g., save file, activate app)
object
Evaluation options and rules

Expected/Result File Types

Postconfig Actions

Actions to prepare the VM state before evaluation:

Evaluation Rules

Rules define how files are compared:

Response

string
Result status (success)
string
Evaluation result message (describes pass/fail reason)
string
VM identifier
string
Task identifier
number
Score from 0.0 to 1.0 (1.0 = fully completed)
Response structure may be simplified to {"score": number, "message": string} in future versions.

Example: Excel Pivot Table Verification

This example verifies that a pivot table was correctly created in Excel:

Evaluator Functions

Over 100 functions available. Common ones: See Desktop Verifiers for the complete list.

Best Practices

Many applications don’t auto-save. Use postconfig to trigger save before evaluation:
Use sleep actions between commands to allow the UI to settle:
For spreadsheets, define which aspects to compare: