Is your feature request related to a problem?
The assessment architecture docs under docs/architecture/assessment/ describe an outdated batch contract. This leads to confusion and misinformation for readers due to the changes made in the config/input reshape.
Describe the solution you'd like
Update the following documentation to reflect the new contract:
docs/architecture/assessment/README.md
docs/architecture/assessment/api-contract.md
docs/architecture/assessment/configuration-and-versioning.md
docs/architecture/kaapi-ai-assessment-ARCHITECTURE.md
Key contract changes to include:
- Remove
query from request input; BATCH input format is now { "data": [...] }. RESPONSE input contains only attachments.
- Move prompt template to config as
submission, mandatory on assessment.params.submission.
- Elevate
input_schema to the config_blob level, making it mandatory and non-empty.
- Eliminate the
duplicate_detection pre-filter completely.
- Implement placeholder validation at config-save, requiring
{column} in submission to resolve against input_schema.
Original issue
Problem
The assessment architecture docs under docs/architecture/assessment/ still describe the OLD BATCH contract (request query template, input_schema nested under assessment.params, a duplicate_detection pre-filter). After the config/input reshape (#1154, #1153) these are stale and mislead readers.
Scope
Update the following to the new contract — prose, JSON examples, and tables. Do not touch the .png assets.
docs/architecture/assessment/README.md
docs/architecture/assessment/api-contract.md
docs/architecture/assessment/configuration-and-versioning.md
docs/architecture/kaapi-ai-assessment-ARCHITECTURE.md
Contract changes to reflect
query removed from the request input. BATCH input = { "data": [...] } (detected by the data key). RESPONSE input carries only attachments and still returns 501.
- Prompt template moves into the config as
submission — mandatory on assessment.params.submission, optional per pre-filter's params.submission. Interpolated server-side per row.
input_schema hoisted to the config_blob top level (sibling of pre_filters/assessment), mandatory and non-empty — no longer under assessment.params.
duplicate_detection pre-filter removed entirely (incl. knowledge_base_id and the output.pre_filter.duplicate_detection result field). Only topic_relevance remains.
- Placeholder validation now at config-save (every
{column} in a submission must resolve against the top-level input_schema); runtime validates only the structured data rows.
Acceptance criteria
Related: #1153, #1154.
Is your feature request related to a problem?
The assessment architecture docs under
docs/architecture/assessment/describe an outdated batch contract. This leads to confusion and misinformation for readers due to the changes made in the config/input reshape.Describe the solution you'd like
Update the following documentation to reflect the new contract:
docs/architecture/assessment/README.mddocs/architecture/assessment/api-contract.mddocs/architecture/assessment/configuration-and-versioning.mddocs/architecture/kaapi-ai-assessment-ARCHITECTURE.mdKey contract changes to include:
queryfrom request input; BATCH input format is now{ "data": [...] }. RESPONSE input contains onlyattachments.submission, mandatory onassessment.params.submission.input_schemato theconfig_bloblevel, making it mandatory and non-empty.duplicate_detectionpre-filter completely.{column}insubmissionto resolve againstinput_schema.Original issue
Problem
The assessment architecture docs under
docs/architecture/assessment/still describe the OLD BATCH contract (requestquerytemplate,input_schemanested underassessment.params, aduplicate_detectionpre-filter). After the config/input reshape (#1154, #1153) these are stale and mislead readers.Scope
Update the following to the new contract — prose, JSON examples, and tables. Do not touch the
.pngassets.docs/architecture/assessment/README.mddocs/architecture/assessment/api-contract.mddocs/architecture/assessment/configuration-and-versioning.mddocs/architecture/kaapi-ai-assessment-ARCHITECTURE.mdContract changes to reflect
queryremoved from the requestinput. BATCHinput={ "data": [...] }(detected by thedatakey). RESPONSE input carries onlyattachmentsand still returns 501.submission— mandatory onassessment.params.submission, optional per pre-filter'sparams.submission. Interpolated server-side per row.input_schemahoisted to theconfig_blobtop level (sibling ofpre_filters/assessment), mandatory and non-empty — no longer underassessment.params.duplicate_detectionpre-filter removed entirely (incl.knowledge_base_idand theoutput.pre_filter.duplicate_detectionresult field). Onlytopic_relevanceremains.{column}in asubmissionmust resolve against the top-levelinput_schema); runtime validates only the structureddatarows.Acceptance criteria
queryfield or aduplicate_detectionpre-filter.input_schema,submissionin the config, anddata-only request input..pngassets untouched.Related: #1153, #1154.