Přejít na hlavní obsah
Čeština— Vyberte jazyk
Menu

XML a Markdown v API

Lekce 11 z 16 Aktualizováno 2. listopadu 2026 Vývojář
Na této stránce
  1. Strukturování pokynů pro model
  2. Značky XML pro vymezení sekcí
  3. Markdown pro čitelné pokyny
  4. Kombinace obou formátů
  5. Opakovaně použitelná šablona promptu
  6. Klíčové poznatky

Strukturování pokynů pro model

Dokud se prompt vejde do tří vět, obyčejný text funguje dobře. Problémy nastávají, když roste: více bloků kontextu, podmíněná pravidla, uživatelská data ke zpracování, schéma výstupu. Všechno se slije dohromady, model si plete, co má číst a co aplikovat, a tvůj tým ztrácí přehled o tom, který řádek upravit. Značky XML a syntaxe Markdown řeší tuto dvojí potřebu: jsou čitelné pro model a udržovatelné pro lidi. Mistral jejich použití v produkčních promptech výslovně doporučuje.

Jejich účinnost vychází z prostého důvodu. Jazykové modely byly trénovány na miliardách dokumentů obsahujících HTML, XML a Markdown; tyto formáty jsou jim známé, protože se masivně vyskytují v trénovacích datech. Model jasně identifikuje sekce a jejich role, zatímco ty získáš prompt, který může kolega zkontrolovat na první pohled.

Značky XML pro vymezení sekcí

Nejnákladově efektivnější využití značek XML spočívá v oddělení dat od pokynů. V následujícím příkladu systémový prompt nese pravidla a očekávané schéma; zpráva uživatele obaluje dokument značkou <document>, čímž zabraňuje modelu, aby si obsah zprávy spletl s instrukcí.

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)

V produkci se neustále opakuje malá slovní zásoba značek, kterou vyplatí se standardizovat napříč vaší základnou promptů:

<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 pro čitelné pokyny

Markdown řeší jinou potřebu: hierarchizaci pravidel. Zatímco XML rozděluje prompt na zóny, nadpisy, seznamy a tučné texty v Markdownu organizují obsah uvnitř zóny. Tento prompt pro technické psaní tak umisťuje roli, pravidla psaní, povinnou číslovanou strukturu a seznam zákazů na stejnou vizuální úroveň – s tímto by mohl pracovat lidský spisovatel, což je správný 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"""

Kombinace obou formátů

U složitých promptů je nejefektivnější praxí vnoření obou formátů: XML vymezuje hlavní zóny, zatímco Markdown strukturuje jejich vnitřek. Níže uvedený vícejazyčný podpůrný agent používá <persona> pro identitu a <rules> pro chování – s dvěma podsekcemi Markdown uvnitř, včetně pravidla pro podmíněnou eskalaci – a <knowledge_base> pro pomíjivá fakta, která se stávají jedinou částí k aktualizaci při změně verze softwaru.

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>"""

Opakovaně použitelná šablona promptu

Dalším krokem je přestat s ručním psaním promptů a začít je budovat. Níže uvedená funkce přijímá dokument a seznam otázek, poté vytvoří kompletní zprávy. Dva detaily si zaslouží tvou pozornost: pokyny vyžadují pro každou odpověď odůvodňující citaci a explicitní náhradní frázi, když informace chybí, což prudce snižuje halucinace u smluvních dokumentů; a temperature nastavená na 0,1 ponechává právě dostatek flexibility pro formulaci, aniž by umožňovala interpretaci.

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ěkolik návyků činí tyto prompty odolnými. Pojmenovávej své značky popisně – <document> říká, co obsahuje, <data> neříká nic a při každé revizi ztratíš pět minut. Systematicky je uzavírej: otevřená značka bez uzavírací značky rozmazává hranici mezi dvěma sekcemi a model si pak může přečíst tvé pokyny jako obsah k analýze. Nakonec používej odsazení pro lidskou čitelnost; model si poradí i bez něj, ale člověk, který bude prompt přebírat za šest měsíců, už ne.

Klíčové poznatky

  • Značky XML izolují data od pokynů v promptu
  • Markdown strukturuje pravidla a seznamy pro lepší čitelnost
  • Pro složité produkční prompty kombinuj oba formáty
  • Pojmenovávej značky popisně a systematicky je uzavírej
  • Strukturované prompty se snadněji udržují, testují a verzují