Descriptions de champs qui guident le modèle
Documentez chaque champ afin que l’IA le remplisse correctement.
Descriptions de champs qui guident le modèle est une leçon MCP Academy gratuite sur CoddyKit. Ceci est la leçon 4 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage MCP Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours MCP Academy comprend 4 leçons au total.
Certaines parties de cette leçon n'ont pas encore été traduites et s'affichent en anglais.
The Model Reads Your Fields
Each field's name and description are shown to the AI. A good description is your chance to tell the model exactly what to put there.
Add a Description
Pass description to Field to attach a human sentence that travels with the schema all the way to the client.
city: str = Field(description="City name, e.g. Paris")Show, Don't Just Tell
Concrete examples inside a description, like a sample date or format, guide the model far better than abstract wording.
date: str = Field(description="ISO date, e.g. 2026-01-31")State the Units
If a number has units, say so. Telling the model temperature is in Celsius prevents quietly wrong Fahrenheit values.
Clarify Ambiguous Names
A field called id is vague. A description like the order's unique ID removes guesswork about which id you mean.
Spell Out the Format
When a string follows a shape, describe it. Saying phone in E.164 like plus and digits keeps the format consistent.
Note What's Optional
For optional fields, mention when to skip them. Telling the model leave blank to use the default reduces needless values.
Keep It Tight
One clear sentence beats a paragraph. A focused description is easier for the model to follow and cheaper in tokens.
Describe the Model Too
A short docstring on the model class describes the whole input, giving the AI useful context above the individual fields.
class Weather(BaseModel):
"""Inputs for a weather lookup."""
city: strDescriptions Power the Schema
Every description lands in the JSON schema the client sends to the model, so writing them well directly shapes tool calls.
Iterate on Wording
If the model keeps filling a field wrong, the fix is usually the description: sharpen the words until calls come out right.
Quick Check
Where does a Field description end up, and why does it matter?
Recap
Write tight field descriptions with examples, units, and formats. They reach the model in the schema and steer it toward correct calls. ✅
Questions Fréquemment Posées
La leçon « Descriptions de champs qui guident le modèle » est-elle gratuite ?
Oui — le texte complet de « Descriptions de champs qui guident le modèle » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours MCP Academy, passe à CoddyKit PRO. Le cours MCP Academy comprend 4 leçons au total.
Qu'est-ce que j'apprendrai dans « Descriptions de champs qui guident le modèle » ?
Documentez chaque champ afin que l’IA le remplisse correctement. Tu pratiques MCP Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.
Dois-je avoir de l'expérience pour commencer MCP Academy ?
Aucune expérience préalable n'est requise. MCP Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 4 sur 4.
Combien de temps prend la leçon « Descriptions de champs qui guident le modèle » ?
La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.
Peux-tu écrire et exécuter du code dans cette leçon MCP Academy ?
Oui. Chaque leçon MCP Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.
Toutes les leçons de ce cours
- Pourquoi les schémas valent mieux que des arguments libres
- Entrées du modèle avec Pydantic
- Contraintes, valeurs par défaut et énumérations
- Descriptions de champs qui guident le modèle