XML en Markdown in de API
Op deze pagina
Uw instructies structureren voor het model
Zolang een prompt in drie zinnen past, volstaat platte tekst. Problemen ontstaan wanneer deze groeit: meerdere contextblokken, conditionele regels, te verwerken gebruikersdata, een uitvoerschema. Alles vloeit in elkaar over, het model verwart wat het moet lezen met wat het moet toepassen, en uw team raakt het overzicht kwijt welke regel aangepast moet worden. XML-tags en Markdown-syntax lossen deze dubbele behoefte op: leesbaar voor het model, onderhoudbaar voor mensen. Mistral raadt het gebruik ervan expliciet aan in productie-prompts.
De effectiviteit hiervan heeft een simpele reden. Taalmodellen zijn getraind op miljarden documenten die HTML, XML en Markdown bevatten; deze formaten zijn vertrouwd omdat ze massaal in de trainingsdata voorkomen. Het model identificeert secties en hun rollen duidelijk, terwijl u een prompt krijgt die een collega in één oogopslag kan controleren.
XML-tags om secties af te bakenen
De meest kosteneffectieve toepassing van XML-tags is het isoleren van data van instructies. In het volgende voorbeeld bevat de systeemprompt de regels en het verwachte schema; het gebruikersbericht verpakt het document in een <document>-tag, waardoor voorkomen wordt dat het model de rapportinhoud aanziet voor een instructie.
from mistralai.client import Mistral
import os
client = Mistral(api_key=os.getenv("MISTRAL_API_KEY"))
system_prompt = """You are a document analysis assistant.
<instructions>
Analyze the provided document and extract the requested information.
Respond only in JSON.
If information is missing, use null.
</instructions>
<output_schema>
{
"title": "string",
"author": "string",
"date": "string (YYYY-MM-DD)",
"summary": "string (max 100 words)",
"keywords": ["string"]
}
</output_schema>"""
user_prompt = """<document>
Q1 2026 Quarterly Report — Mistral AI
Written by Arthur Mensch, CEO
Publication date: April 1, 2026
This report presents the results for the first quarter of 2026. The company experienced significant growth in its API business with a 300% increase in daily requests.
</document>
Extract the metadata from this document."""
response = client.chat.complete(
model="mistral-large-latest",
messages=[
{"role": "system", "content": system_prompt},
{"role": "user", "content": user_prompt}
],
temperature=0.0
)
print(response.choices[0].message.content)
In productie keert een kleine vocabulaire aan tags constant terug en profiteert deze van standaardisatie binnen uw prompt-basis:
<instructions>...</instructions> <!-- Rules for the model -->
<context>...</context> <!-- Background information -->
<document>...</document> <!-- Text to analyze -->
<examples>...</examples> <!-- Few-shot examples -->
<constraints>...</constraints> <!-- Limits and prohibitions -->
<output_format>...</output_format> <!-- Expected output format -->
<user_data>...</user_data> <!-- User data -->
Markdown voor leesbare instructies
Markdown vervult een andere behoefte: het hiërarchiseren van regels. Waar XML de prompt in zones opdeelt, organiseren Markdown-koppen, lijsten en vetgedrukte tekst de inhoud binnen een zone. Deze technische schrijfprompt plaatst zo een rol, schrijfregels, een verplichte genummerde structuur en een lijst met verbodsbepalingen op hetzelfde visuele vlak—een menselijke schrijver zou hiermee kunnen werken, wat de juiste test is.
system_prompt = """# Technical Writing Assistant
## Your role
You write technical documentation for REST APIs.
## Writing rules
- **Use "you"** throughout the text
- Short sentences (max 25 words)
- One concept per paragraph
- Inline code in backticks: `GET /api/v1/users`
## Mandatory structure
1. **Introduction** — Context and objective of the endpoint
2. **Request** — Method, URL, headers, parameters
3. **Response** — HTTP codes, JSON body, examples
4. **Errors** — Possible error codes and resolution
## Prohibitions
- No undefined jargon
- No "simply" or "easily"
- No examples with unrealistic fictional data"""
Beide formaten combineren
Voor complexe prompts is de meest effectieve praktijk het nesten van de twee: XML bakent de grote zones af, terwijl Markdown de binnenkant van elk zone structureert. De onderstaande meertalige supportagent gebruikt <persona> voor identiteit en <rules> voor gedrag—met twee Markdown-subsecties erin, inclusief een conditionele escalatieregel—en <knowledge_base> voor vergankelijke feiten, die het enige onderdeel worden dat bijgewerkt moet worden wanneer de softwareversie verandert.
system_prompt = """# Multilingual Support Agent
<persona>
You are the assistant for DataFlow, an ETL software publisher.
You speak French, English, and Spanish.
</persona>
<rules>
## Behavior rules
- Respond in the user's language
- Identify the problem category: **bug**, **question**, **feature request**
- For bugs: collect software version, OS, exact error message
## Escalation
- If the problem persists after 3 exchanges → propose a support ticket
- If the client mentions data loss → immediate escalation (high priority)
</rules>
<knowledge_base>
- Current version: DataFlow 4.2.1 (April 2026)
- Supported OS: Windows 11, Ubuntu 22.04+, macOS 14+
- Documentation: docs.dataflow.io
</knowledge_base>"""
Een herbruikbaar prompt-sjabloon
De volgende stap is stoppen met het handmatig schrijven van prompts en beginnen met het bouwen ervan. De onderstaande functie neemt een document en een lijst met vragen en produceert vervolgens de volledige berichten. Twee details verdienen uw aandacht: de instructies vereisen een rechtvaardigend citaat voor elk antwoord en een expliciete fallback-zin wanneer informatie ontbreekt, wat hallucinaties bij contractdocumenten sterk reduceert; en de temperature op 0,1 laat net genoeg flexibiliteit voor formulering zonder interpretatie toe te staan.
def build_analysis_prompt(document: str, questions: list[str]) -> list:
"""Builds a structured analysis prompt using XML."""
system = """# Document Analyst
<instructions>
Read the provided document and answer the questions asked.
Every answer must cite the part of the document that justifies it.
If the answer is not in the document, reply "Not mentioned in the document."
</instructions>
<output_format>
For each question, respond in this format:
**Q{n}**: [your answer]
> Citation: "[excerpt from document]"
</output_format>"""
questions_formatted = "\n".join(
f"{i+1}. {q}" for i, q in enumerate(questions)
)
user = f"""<document>
{document}
</document>
<questions>
{questions_formatted}
</questions>"""
return [
{"role": "system", "content": system},
{"role": "user", "content": user}
]
# Usage
messages = build_analysis_prompt(
document="Service agreement contract between...",
questions=[
"What is the contract duration?",
"What are the late payment penalties?",
"Is there a non-compete clause?"
]
)
response = client.chat.complete(
model="mistral-large-latest",
messages=messages,
temperature=0.1
)
Enkele gewoonten maken deze prompts duurzaam. Noem uw tags beschrijvend—<document> zegt wat het bevat, <data> zegt niets en u verspilt vijf minuten aan elke review. Sluit ze systematisch af: een openingstag zonder sluitingstag vervaagt de grens tussen twee secties, en het model kan dan uw instructies lezen als inhoud om te analyseren. Tot slot, inspringen voor menselijke leesbaarheid; het model doet het er prima zonder, maar de persoon die de prompt over zes maanden oppakt niet.
Belangrijkste punten
- XML-tags isoleren data van instructies in de prompt
- Markdown structureert regels en lijsten voor leesbaarheid
- Combineer beide voor complexe productie-prompts
- Noem uw tags beschrijvend en sluit ze systematisch af
- Gestructureerde prompts zijn eenvoudiger te onderhouden, testen en versioneren