Download OpenAPI specification:
The Evaluation Function API provides a comprehensive solution for educational assessment systems, using an RPC-like approach via HTTP with commands specified in request headers.
This API enables automated feedback and validation of student responses against educator-defined answers, with support for custom evaluation parameters and real-time preview functionality.
The primary endpoint for grading student responses. It compares a student's submission against the correct answer and returns:
is_correct)A lightweight validation endpoint that normalizes and validates student responses without performing full evaluation. Useful for:
Monitors the operational status of the evaluation function by running internal tests. Returns detailed diagnostics including:
tests_passed)| command | string Default: eval Value: "eval" |
| response required | any Student response |
| answer required | any Educator answer |
| params | object (EvaluationParams) Parameters for an evaluation or preview request. |
Correct evaluation request
{- "response": "Hello, World!",
- "answer": "Hello, World!"
}Successful evaluation response
{- "command": "eval",
- "result": {
- "is_correct": true,
- "feedback": "Good job!"
}
}| command required | string Default: preview Value: "preview" |
| response required | any Student response |
| params | object (EvaluationParams) Parameters for an evaluation or preview request. |
{- "response": "Hello, World!"
}Successful preview response
{- "command": "preview",
- "result": {
- "preview": "Hello, World!"
}
}| command required | string Default: healthcheck Value: "healthcheck" |
| property name* additional property | any |
{ }Successful health check
{- "command": "healthcheck",
- "result": {
- "tests_passed": true,
- "successes": [
- "Test 1 passed",
- "Test 2 passed"
], - "failures": [ ],
- "errors": [ ]
}
}