XML och Markdown i API:t
På denna sida
Strukturera dina instruktioner för modellen
Så länge en prompt får plats i tre meningar fungerar vanlig text utmärkt. Problemen uppstår när den växer: flera kontextblock, villkorliga regler, användardata som ska bearbetas, ett utdataschema. Allt flyter samman, modellen förväxlar vad den ska läsa med vad den ska tillämpa, och ditt team tappar överblicken över vilken rad som ska ändras. XML-taggar och Markdown-syntax löser detta dubbla behov: läsbart för modellen, underhållsbart för människor. Mistral rekommenderar uttryckligen deras användning i produktionspromptar.
Deras effektivitet beror på en enkel anledning. Språkmodeller har tränats på miljarder dokument som innehåller HTML, XML och Markdown; dessa format är bekanta eftersom de förekommer massivt i träningsdata. Modellen identifierar tydligt sektioner och deras roller, medan du får en prompt som en kollega kan granska vid en första anblick.
XML-taggar för att avgränsa sektioner
Den mest kostnadseffektiva användningen av XML-taggar är att isolera data från instruktioner. I följande exempel innehåller systemprompten reglerna och det förväntade schemat; användarmeddelandet omsluter dokumentet i en <document>-tagg, vilket förhindrar att modellen misstar rapportinnehållet för en instruktion.
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)
I produktion återkommer ett litet ordförråd av taggar ständigt och gynnas av standardisering över hela din promptbas:
<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 för läsbara instruktioner
Markdown tillgodoser ett annat behov: hierarkisering av regler. Där XML skär prompten i zoner, organiserar Markdown-rubriker, listor och fet text innehållet inom en zon. Denna prompt för tekniskt skrivande placerar således en roll, skrivregler, en obligatorisk numrerad struktur och en lista över förbud på samma visuella plan – en mänsklig skribent skulle kunna arbeta med detta, vilket är rätt test.
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"""
Kombinera båda formaten
För komplexa promptar är den mest effektiva metoden att nästla de två: XML avgränsar de stora zonerna, medan Markdown strukturerar innehållet i varje zon. Supportagenten för flera språk nedan använder <persona> för identitet och <rules> för beteende – med två Markdown-undersektioner inuti, inklusive en villkorlig eskaleringsregel – och <knowledge_base> för förgängliga fakta, som blir den enda delen som behöver uppdateras när mjukvaruversionen ändras.
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>"""
En återanvändbar promptmall
Nästa steg är att sluta skriva promptar manuellt och börja bygga dem. Funktionen nedan tar ett dokument och en lista med frågor och producerar sedan de kompletta meddelandena. Två detaljer förtjänar din uppmärksamhet: instruktionerna kräver ett motiverande citat för varje svar och en explicit reservfras när information saknas, vilket kraftigt minskar hallucinationer på kontraktsdokument; och temperature på 0,1 lämnar precis tillräckligt med flexibilitet för formulering utan att tillåta tolkning.
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
)
Några vanor gör dessa promptar hållbara. Namnge dina taggar beskrivande – <document> säger vad det innehåller, <data> säger ingenting och du kommer att slösa fem minuter på varje granskning. Stäng dem systematiskt: en öppen tagg utan en stängande tagg suddar ut gränsen mellan två sektioner, och modellen kan då läsa dina instruktioner som innehåll som ska analyseras. Använd slutligen indrag för mänsklig läsbarhet; modellen klarar sig utan det, men personen som plockar upp prompten om sex månader gör det inte.
Viktiga punkter
- XML-taggar isolerar data från instruktioner i prompten
- Markdown strukturerar regler och listor för läsbarhet
- Kombinera båda för komplexa produktionspromptar
- Namnge dina taggar beskrivande och stäng dem systematiskt
- Strukturerade promptar är lättare att underhålla, testa och versionshantera