Skip to content

Recipe

The Recipe resource functions as a linker or pedagogical “assembly recipe”. It links workflow engine configurations (such as whether a score should be calculated or a report issued) with Layer 0 pedagogical components (rubrics and objectives) and exercise types.

A Recipe tells the system what elements to combine to generate or evaluate an exam.

Schema

Metadata (metadata)

FieldTypeRequiredDescription
idstringYesUnique identifier for the recipe (e.g., global.c1.ib...).
titlestringYesDescriptive title of the assessment recipe.
versionstringYesSemantic version of the resource (e.g., 1.0.0).

Workflow Configuration (workflow_parameters)

FieldTypeRequiredDescription
scoringbooleanNoIndicates whether the engine should assign a quantitative score to the assessment.
report_formatstringNoExpected format for the final report (e.g., PDF).

Pedagogical Assembly (pedagogical_assembly)

FieldTypeRequiredDescription
rubricobjectNoContains the rubric layers (C0) to be applied.
rubric.layersarrayNoList of rubric layers. Each layer includes level (e.g., C0), block_id (reference to the rubric), and status (e.g., ACTIVE).

Assembly Specification (spec.assembly)

The main block where references to be injected into the LLM prompt are consolidated.

FieldTypeDescription
param_refsstring[]List of ExerciseType IDs (base parameters for the exercise format).
rubric_refsstring[]List of Rubric resource IDs to apply evaluative criteria.
directive_refsstring[]List of Directive resource IDs (hard instructions for the AI).

Usage Example

Below is an example of a Recipe for an IB Literature assessment:

apiVersion: colabedu.ai/v1beta1
kind: Recipe
metadata:
id: global.c1.ib.spanish_a.literature.hl.2026.v1.v1.cf8880
title: Recipe for IB 2026 - Spanish A Literature HL - Assessment Outline
version: 1.0.0
workflow_parameters:
scoring: true
report_format: PDF
pedagogical_assembly:
rubric:
layers:
- level: C0
block_id: global.c0.ap.spanish_literature.essay.text_comparison.v1.v1.6a4ae1
status: ACTIVE
spec:
assembly:
param_refs:
- global.exercise_type.free_text.v1
rubric_refs:
- global.c0.ap.spanish_literature.essay.text_comparison.v1.v1.6a4ae1
directive_refs: []