XML u Markdown fl-API
F'din il-paġna
L-istrutturar tal-istruzzjonijiet tiegħek għall-mudell
Sakemm il-prompt jidħol fi tliet sentenzi, it-test sempliċi jaħdem tajjeb. Il-problemi jibdew meta jikber: blokok multipli ta’ kuntest, regoli kondizzjonali, dejta tal-utent biex tiġi pproċessata, skema ta’ output. Kollox jitħallat flimkien, il-mudell jibħxes bejn x’jaqra u x’japplika, u t-tim tiegħek jitlif il-kont ta’ liema linja għandu jimmodifika. It-tags XML u s-sintassi Markdown jindirizzaw din il-ħtieġa doppja: leġibbli għall-mudell, u faċli biex tinżamm għall-bnedmin. Mistral jirrakkomanda b’mod espliċitu l-użu tagħhom fil-prompts tal-produzzjoni.
L-effettività tagħhom tinżel għal raġuni sempliċi. Il-mudelli tal-lingwa ġew imħarrġa fuq biljuni ta’ dokumenti li fihom HTML, XML u Markdown; dawn il-formati huma familjari għax jidhru b’mod massiv fid-dejta tat-taħriġ. Il-mudell jidentifika b’mod ċar is-sezzjonijiet u r-rwoli tagħhom, filwaqt li int tikseb prompt li kollega jista’ jivverifika f’daqqa t’għajn.
Tags XML biex jiddelimraw is-sezzjonijiet
L-aktar użu kost-effettiv tat-tags XML huwa li jiżola d-dejta mill-istruzzjonijiet. Fl-eżempju li ġej, il-prompt tas-sistema jġorr ir-regoli u l-iskema mistennija; il-messaġġ tal-utent jgħatti d-dokument f’tag <document>, u jipprevjeni lill-mudell milli jħawwad il-kontenut tar-rapport ma’ istruzzjoni.
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)
Fil-produzzjoni, vokabolarju żgħir ta’ tags jerġa’ jidher kontinwament u jibbenefika mill-istandardizzazzjoni fil-bażi tal-prompts tiegħek:
<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 għal istruzzjonijiet leġibbli
Markdown jindirizza ħtieġa oħra: il-ġerarkija tar-regoli. Fejn XML jaqsam il-prompt f’żoni, l-intestaturi, il-listi u t-test bil-grass ta’ Markdown jorganizzaw il-kontenut fi ħdan żona. Dan il-prompt tal-kitba teknika għalhekk ipoġġi rwol, regoli tal-kitba, struttura numerata obbligatorja, u lista ta’ projbizzjonijiet fuq l-istess pjan viżiv—kitieb uman jista’ jaħdem b’dan, li hija t-test it-tajjeb.
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"""
Il-kombinazzjoni taż-żewġ formati
Għal prompts kumplessi, l-aktar prattika effettiva hija t-tbejjit (nesting) taż-żewġ formati: XML jiddelimita ż-żoni ewlenin, filwaqt li Markdown jistruttura l-intern ta’ kull waħda. L-aġent ta’ appoġġ multilingwu hawn taħt juża <persona> għall-identità u <rules> għall-imġiba—b’żewġ sottosezzjonijiet Markdown ġewwa, inkluża regola ta’ eskalazzjoni kondizzjonali—u <knowledge_base> għal fatti li jistgħu jsiru qodma, li jsiru l-unika parti li trid tiġi aġġornata meta tinbidel il-verżjoni tas-softwer.
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>"""
Mudell ta’ prompt li jista’ jerġa’ jintuża
Il-pass li jmiss huwa li tieqaf tikteb il-prompts manwalment u tibdi tibnihom. Il-funzjoni hawn taħt tieħu dokument u lista ta’ mistoqsijiet, imbagħad toħroġ il-messaġġi sħaħ. Żewġ dettalji jistħoqqilhom attenzjoni: l-istruzzjonijiet jeħtieġu ċitazzjoni li tiġġustifika għal kull tweġiba u frażi espliċita ta’ ripjieg meta l-informazzjoni tkun nieqsa, li tonqos b’mod qawwi l-alluċinazzjonijiet fuq dokumenti kuntrattwali; u t-temperature f’0.1 tħalli biżżejjed flessibbiltà għall-formulazzjoni mingħajr ma tippermetti interpretazzjoni.
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
)
Xi drawwiet jagħmlu dawn il-prompts durabbli. Semmi t-tags tiegħek b’mod deskrittiv—<document> jgħid x’fih, <data> ma jgħid xejn u se titlef ħames minuti f’kull reviżjoni. Agħlaqhom sistematikament: tag miftuħ mingħajr tag magħluq iċajjar il-fruntiera bejn żewġ sezzjonijiet, u l-mudell jista’ mbagħad jaqra l-istruzzjonijiet tiegħek bħala kontenut li għandu jiġi analizzat. Fl-aħħar nett, uża l-indentazzjoni għal-leġibbiltà umana; il-mudell ikun tajjeb mingħajrha, iżda l-persuna li se tieħu l-prompt f’sitt xhur mhux se tkun.
Punti Ewlenin
- It-tags XML jiżolaw id-dejta mill-istruzzjonijiet fil-prompt
- Markdown jistruttura r-regoli u l-listi għal-leġibbiltà
- Għaqqad iż-żewġ formati għal prompts kumplessi tal-produzzjoni
- Semmi t-tags tiegħek b’mod deskrittiv u agħlaqhom sistematikament
- Il-prompts strutturati huma aktar faċli biex jinżammu, jiġu ttestjati u jiġu vverżjonati