Prejsť na hlavný obsah
Slovenčina— Vyberte jazyk
Menu

XML a Markdown v API

Lekcia 11 z 16 Aktualizované 2. novembra 2026 Vývojár
Na tejto strane
  1. Štruktúrovanie inštrukcií pre model
  2. XML tagy na ohraničenie sekcií
  3. Markdown na čitateľné inštrukcie
  4. Kombinácia oboch formátov
  5. Opakovane použiteľná šablóna promptu
  6. Kľúčové poznatky

Štruktúrovanie inštrukcií pre model

Pokiaľ sa prompt zmestí do troch viet, obyčajný text stačí. Problémy nastávajú, keď narastá: viacero blokov kontextu, podmienené pravidlá, užívateľské dáta na spracovanie, schéma výstupu. Všetko sa zlieva dohromady, model si mýli, čo má čítať a čo aplikovať, a tvoj tím stráca prehľad, ktorý riadok upraviť. XML tagy a syntax Markdown riešia túto dvojitú potrebu: sú čitateľné pre model a udržiavateľné pre ľudí. Mistral ich použitie v produkčných promptoch explicitne odporúča.

Ich efektivita vychádza z jednoduchého dôvodu. Jazykové modely boli trénované na miliardách dokumentov obsahujúcich HTML, XML a Markdown; tieto formáty sú im známe, pretože sa masívne vyskytujú v trénovacích dátach. Model jasne identifikuje sekcie a ich úlohy, zatiaľ čo ty získavaš prompt, ktorý môže kolega skontrolovať na prvý pohľad.

XML tagy na ohraničenie sekcií

Najefektívnejšie využitie XML tagov spočíva v izolácii dát od inštrukcií. V nasledujúcom príklade systémový prompt nesie pravidlá a očakávanú schému; užívateľská správa obalí dokument do tagu <document>, čím zabráni modelu, aby si obsah správy pomýlil s inštrukciou.

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 produkcii sa neustále opakuje malá slovná zásoba tagov, ktorých štandardizácia v celej tvojej báze promptov prináša úžitok:

<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 na čitateľné inštrukcie

Markdown rieši inú potrebu: hierarchizáciu pravidiel. Kým XML rozdeľuje prompt na zóny, nadpisy, zoznamy a tučné písmo v Markdowne organizujú obsah vnútri zóny. Tento prompt pre technické písanie tak umiestňuje rolu, pravidlá písania, povinnú číslovanú štruktúru a zoznam zákazov na rovnakú vizuálnu úroveň – ľudský pisateľ by s tým dokázal pracovať, čo je správny 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"""

Kombinácia oboch formátov

Pri komplexných promptoch je najúčinnejšou praxou vnorenie oboch formátov: XML ohraničuje hlavné zóny, zatiaľ čo Markdown štruktúruje ich vnútro. Nižšie uvedený viacjazyčný podporný agent používa <persona> pre identitu a <rules> pre správanie – s dvoma podsekciami Markdown vrátane podmieneného pravidla eskalácie – a <knowledge_base> pre pomíjajúce fakty, ktoré sa stávajú jedinou časťou na aktualizáciu pri zmene verzie softvéru.

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

Opakovane použiteľná šablóna promptu

Ďalším krokom je prestať písať prompty ručne a začať ich budovať. Funkcia nižšie prijíma dokument a zoznam otázok, následne vytvorí kompletné správy. Dva detaily si zaslúžia tvoju pozornosť: inštrukcie vyžadujú odôvodňujúcu citáciu ku každej odpovedi a explicitnú náhradnú frázu pri chýbajúcich informáciách, čo výrazne znižuje halucinácie pri zmluvných dokumentoch; a temperature nastavená na 0,1 ponecháva práve dostatok flexibility pre formuláciu, no neumožňuje interpretáciu.

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
)

Niekoľko návykov robí tieto prompty odolnými. Pomenuj svoje tagy opisne – <document> hovorí, čo obsahuje, <data> nehovorí nič a pri každej revízii stratíš päť minút. Systematicky ich uzatváraj: otvorený tag bez uzatváracieho tagu rozmazáva hranicu medzi dvoma sekciami a model si potom môže tvoje inštrukcie prečítať ako obsah na analýzu. Nakoniec, používaj odsadenie pre ľudskú čitateľnosť; model si poradí aj bez neho, ale človek, ktorý bude prompt preberať o šesť mesiacov, už nie.

Kľúčové poznatky

  • XML tagy izolujú dáta od inštrukcií v prompte
  • Markdown štruktúruje pravidlá a zoznamy pre lepšiu čitateľnosť
  • Kombinuj oba formáty pre komplexné produkčné prompty
  • Pomenuj svoje tagy opisne a systematicky ich uzatváraj
  • Štruktúrované prompty sa ľahšie udržiavajú, testujú a verzionujú