diff --git a/backend/app/api/docs/assessment/create.md b/backend/app/api/docs/assessment/create.md index d8c140205..c5fe02421 100644 --- a/backend/app/api/docs/assessment/create.md +++ b/backend/app/api/docs/assessment/create.md @@ -5,8 +5,8 @@ pre-filters (topic relevance / duplicate detection). The run mode is **inferred shape** — you do not pass a mode flag. **Key Features:** -* Method inferred from the input: a `data` list ⇒ **BATCH**, a single `query` (+ optional - `attachments`) ⇒ **RESPONSE**. +* Method inferred from the input: a `data` list (or `submission_doc_id`) ⇒ **BATCH**, a single + row object in `data` ⇒ **RESPONSE**. * Pins to a saved config **version** (`config.id` + `config.version`); the config must be tagged `ASSESSMENT` (see the config-create docs for the `config_blob` assessment shape). * Optional pre-filters run before the grading call and can gate it per item. @@ -14,8 +14,8 @@ shape** — you do not pass a mode flag. `callback_url` to have the finished result POSTed to you on completion. * `request_metadata` is echoed back unchanged in the callback for correlation. -> **RESPONSE mode is not wired yet** — a single-object input currently returns `501 Not Implemented`. -> Only BATCH (a `data` list) is processed today. +> **RESPONSE** answers one row and delivers the result only by webhook, so `callback_url` is +> **required** for it (a RESPONSE without one fails with `422`). BATCH can still be polled. --- @@ -25,7 +25,6 @@ shape** — you do not pass a mode flag. { "config": { "id": "3f9b2c10-0000-4a11-8c22-1a2b3c4d5e6f", "version": 1 }, "input": { - "query": "Grade the answer sheet for roll number {roll_number}, student {student_name}.", "data": [ { "roll_number": "1", @@ -50,8 +49,7 @@ shape** — you do not pass a mode flag. * `id` (UUID, required) — the config id. * `version` (int ≥ 1, required) — the config version. Must reference a config tagged `ASSESSMENT`. * `input` (required) — one of two shapes; the shape selects the method: - * **BATCH** — `{ "query": "