引导模型的字段描述
记录每个字段,确保人工智能正确填写。
引导模型的字段描述 是 CoddyKit 上的免费 MCP Academy 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 MCP Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 MCP Academy 课程共包含 4 节课。
模型会读取您的字段
每个字段的名称和描述都会展示给 AI。好的描述可以准确告诉模型应当在该字段中填写什么。
添加描述
将描述传递给字段,即可附加一条随模式一路传递到客户端的人类可读语句。
city: str = Field(description="City name, e.g. Paris")展示,而不只是告知
在描述中加入具体的示例,例如日期样例或格式,比抽象的措辞更能指导模型。
date: str = Field(description="ISO date, e.g. 2026-01-31")说明单位
如果数字有单位,请明确写出。告诉模型温度使用摄氏度,可以避免它悄悄生成错误的华氏度数值。
明确含糊的名称
名为 id 的字段含义模糊。像“订单的唯一 ID”这样的描述,可以消除您究竟指哪个 id 的疑问。
明确写出格式
如果字符串遵循某种形式,请将其描述清楚。说明电话号码采用 E.164 格式,例如加号加数字,可以保持格式一致。
说明哪些内容是可选的
对于可选字段,请说明何时可以省略。告诉模型留空即可使用默认值,可以减少不必要的值。
保持简洁
一句清晰的话胜过一整段文字。重点明确的描述更容易让模型遵循,也更节省令牌。
也描述模型
模型类上的简短文档字符串可以描述整个输入,为 AI 提供位于各个字段之上的有用上下文。
class Weather(BaseModel):
"""Inputs for a weather lookup."""
city: str描述驱动模式
每条描述都会进入客户端发送给模型的 JSON模式,因此高质量地编写描述会直接影响工具调用。
反复改进措辞
如果模型总是错误地填写某个字段,通常应当修改描述:不断打磨措辞,直到调用结果正确为止。
快速检查
字段描述最终会出现在哪里?为什么这很重要?
回顾
编写简洁的字段描述,并加入示例、单位和格式。它们会通过模式传递给模型,引导模型进行正确调用。✅
用 AI 导师学习 Python — 免费
在浏览器中编写并运行真实代码,获得全天候 AI 导师的即时帮助,并在网页或应用中继续学习。
- 课程
- 30
- 课程
- 120
常见问题解答
「引导模型的字段描述」课时是免费的吗?
是的 — 「引导模型的字段描述」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 MCP Academy 课程的其余内容,请升级到 CoddyKit PRO。 MCP Academy 课程共包含 4 节课。
「引导模型的字段描述」这节课中我会学到什么?
记录每个字段,确保人工智能正确填写。 你通过在浏览器中直接运行的动手代码来练习 MCP Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 MCP Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 MCP Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。
「引导模型的字段描述」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 MCP Academy 课中编写并运行代码吗?
能。每节 MCP Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。