The change form can offer two AI aids: Assisted writing (description and rollback plan) and Suggest the risk. The AI assistant instructions screen (menu Changes › AI assistant instructions, or the button of the same name on the Change types screen) sets the instructions Portail ZAPP sends to the AI provider for these aids. It is reserved for administrators.
The instructions
The screen shows one card per instruction:
- Risk suggestion: used by Suggest the risk. Available variable:
{languageCode}; - Assisted writing (description, rollback plan): used by both Assisted writing buttons. Available variables:
{languageCode},{section}.
{languageCode} is replaced by the user's language (or else the instance's): the assistant answers in that language. {section} is replaced by the part to write, the description or the rollback plan.
Change an instruction
- Type your text in the card. When the field is empty, the default instruction applies; it is shown greyed out in the field (it is written in English).
- Click Save: Instruction saved.
- To drop your text, click Restore the default instruction (the button only appears when a custom instruction is saved): Default instruction restored.
The change applies from the next request, without a restart.
Good to know
- Keep the response format of the risk suggestion. The default instruction asks for a structured answer (impact and probability from 1 to 5, risk level, justification). If your instruction no longer asks for it, every suggestion fails with The AI assistant returned an unusable answer: try again or add more details. The safest way is to start from the default text and change only its substance.
- The assistant never changes a change on its own: each proposal is shown for review, with Apply and Dismiss.
- When AI is disabled (provider None (AI disabled) in the AI configuration), the Assisted writing and Suggest the risk buttons do not appear in the form, which remains fully usable. The instructions screen stays available: what you save there is kept and will be used as soon as AI is turned back on.
See also
- "Request and follow a change": AI assistance in the form.
- "Set up change types": categories, approval flows and suggested texts.
- "Configure AI": choose the AI provider or turn AI off.