在构建大语言模型应用时,为不同业务场景反复构建和调整结构相似的 Prompt 耗时且难以维护。通过使用 Prompt 模板,可将 Prompt 的固定结构与动态变量分离,创建可复用的模板,以实现Prompt的统一管理和优化,高效生成Prompt。
本文档仅适用于中国大陆版(北京地域)。
工作流程
-
创建模板:在阿里云百炼控制台或通过 API 创建并保存模板,获取唯一模板 ID。
-
获取模板:通过 API 和模板 ID 拉取模板内容。
-
生成Prompt:将业务数据填入模板变量,生成最终的Prompt。
-
使用模板:将生成好的Prompt发送给目标模型以获取结果。
模板类型
Prompt模板分为预置Prompt模板和自定义Prompt模板。
|
维度 |
预置Prompt模板 |
自定义Prompt模板 |
|
来源 |
由阿里云百炼提供,涵盖了多个不同的业务场景。 |
|
|
效果 |
已经过优化,效果稳定。 |
用户自己设计和测试,效果取决于设计质量。 |
|
易用性 |
无需额外开发,直接通过控制台或API调用即可。
|
在实际使用中,可能需要多次迭代优化。因此,用户需要掌握Prompt设计原则及优化方法(如清晰指令、示例引导、格式约束),具备一定的开发和技术能力。 |
|
适用场景 |
|
|
|
是否支持修改 |
不支持。 |
根据实际需求修改。 |
预置Prompt模板
1. 查看
访问提示词页面,可查看和使用阿里云百炼提供的针对不同场景的预置Prompt模板。
每个 Prompt 模板以卡片形式展示,包含模板内容摘要和模板 ID。卡片底部提供 查看详情、复制 prompt 和更多操作(···)按钮。
2. 查看与管理
查看:单击模板卡片上的查看详情,查看模板的名称、内容、变量、ID等信息。
管理:
-
单击,可以复制模板内容。
-
单击,模板内容将自动填充到智能体应用的提示词编辑框中。可直接使用或基于业务场景修改。
填充后的提示词中包含自定义变量
${number}和${content},用于生成小红书风格文案。 -
单击,可查看模板调用的代码示例。此处仅为核心代码示例,不能直接运行。完整的代码示例,请参见GetPromptTemplate - 获取Prompt模板中的SDK示例。
-
单击,会在提示词页面创建一个自定义Prompt模板:“预置Prompt模板名称_副本_时间戳”。
复制后的模板卡片展示模板内容预览和模板 ID(可单击右侧图标复制),底部提供编辑、复制 prompt及更多操作按钮。
自定义Prompt模板
1. 创建
您可以通过控制台或 API 两种方式创建自定义Prompt模板。
控制台
-
基于预置Prompt模板修改
在预置Prompt模板卡片上,单击,将会创建一个自定义Prompt模板副本:“预置Prompt模板名称_副本_时间戳”。
-
基于业务需求创建
在提示词页面,单击创建提示词,完成相关配置后,单击保存即可完成模板创建。更多创建详情请参阅自定义Prompt模板。在Prompt模板管理页面,可通过类型筛选(全部、文本生成、图片生成)和搜索框查找已有模板。单击右上角+ 创建提示词按钮新建Prompt模板。已创建的模板以卡片形式展示,包含模板标题、内容预览和模板ID,支持编辑和复制prompt操作。
API
-
获取业务空间ID:获取APP ID 和 Workspace ID。
-
创建自定义Prompt模板:使用CreatePromptTemplate - 创建Prompt模板接口。
2. 查看与管理
查看:自定义Prompt模板创建完成后,可在提示词页面查看。
管理:
-
单击模板卡片上的编辑,可修改模板内容。
-
单击,可以复制模板内容。
-
单击,模板内容将自动填充到智能体应用的提示词编辑框中。可直接使用或基于业务场景修改。
-
单击,可查看模板调用的代码示例。此处仅为核心代码示例,不能直接运行。完整的代码示例,请参见GetPromptTemplate - 获取Prompt模板中的SDK示例。
-
单击,会在当前页面创建一个自定义Prompt模板:“自定义Prompt模板名称_副本_时间戳”。
-
单击,可删除已创建的模板。
使用Prompt模板
控制台
-
单击预置Prompt模板或自定义Prompt模板中的,模板内容将自动填充到智能体应用的提示词中。
填充后的提示词输入框中可见模板变量(如
${name}),输入框右下角显示字符计数,最大支持 6144 个字符。 -
为应用设置模型,输入问题测试提示词效果。
在模型调试界面左侧,选择模型(如通义千问-Plus-Latest 128K)并在提示词区域编写系统指令;右侧在用户输入区输入测试问题后单击执行,下方展示模型回复内容及输入/输出token统计信息。
API
-
打开获取Prompt模板接口调用文档,单击调试。
-
在参数配置界面分别输入 workspaceId 和 promptTemplateId。
-
workspaceId:即业务空间ID。获取方法参见获取APP ID 和 Workspace ID。
-
promptTemplateId:即预置Prompt模板或自定义模板ID。在模板卡片上获取模板Id即可。
-
-
单击发起调用即可在线调试接口。
调用成功示例:
{ // Schema of Response "variables": [ // 模板变量列表 "platform", // 模板变量 "topic", // 模板变量 "num1", // 模板变量 "num2" // 模板变量 ], "promptTemplateId": "cfec40c311f14f3e976403059d8f0116", // 模板Id "requestId": "8C616xxx", // 请求Id "name": "营销文案生成", // 模板名称 "content": "你是一名在${platform}平台具有丰富经验的专业爆款营销文案策划人,现在请以\"${topic}\"为核心主题,撰写一段极具吸引力的${platform}营销内容。要求内容包括:一个引人入胜且符合SEO优化原则的标题,以及一段详细且富有情感煽动力的正文。在正文中,请至少插入${num1}不同的emoji表情,以增加内容的互动性和视觉吸引力。此外,请根据该主题,设计并提供最多${num2}热门推荐标签,这些标签需具有高度概括主题和吸引目标用户群体的特点。", // 模板内容 }
SDK
-
打开获取Prompt模板接口调用文档,单击调试。
-
在参数配置界面分别输入workspaceId和promptTemplateId。配置完成后,workspaceId和promptTemplateId将自动填充至SDK示例中。
-
workspaceId:即业务空间ID。获取方法参见获取APP ID 和 Workspace ID。
-
promptTemplateId:即预置Prompt模板或自定义Prompt模板ID。在模板卡片上获取模板 Id 即可。
-
-
在调试界面中单击SDK示例。
-
在线运行示例,或下载完整工程,设置 accessKeyId 和 accessKeySecret 后运行。
获取方法请参见获取 AccessKey 与 AgentKey。
在 OpenAPI 调试页面右侧,单击 SDK示例 页签,选择 SDK 代系 V2.0(推荐) 及目标语言(如 Java),即可查看对应的 SDK 示例代码。
效果示例
|
预置Prompt模板 |
介绍 |
推荐使用场景 |
模板内容 |
生成效果文案 |
|
营销标题生成 |
快速生成各流量渠道的吸引眼球的标题文案 |
营销推广 |
你是一名专业的【小红书】爆款标题专家。请你以【杭州亚运会】为主题,以【YYDS、建议收藏、揭秘】为关键词,提供【10】个吸引人眼球的标题。每个标题字数在【20】个字以内。 |
|
错误码
如果调用失败并返回报错信息,请参见错误码进行解决。
常见问题
Q: 调用GetPromptTemplate接口和直接在代码中拼接字符串有什么区别?
A: 使用GetPromptTemplate接口管理Prompt的优势如下:
-
逻辑与内容分离:可在阿里云百炼控制台更新和优化Prompt内容,无需修改或重新部署应用程序代码。
-
集中管理与协作:所有Prompt集中存储,便于团队(如Prompt工程师和开发工程师)协作、版本管理和复用。
-
一致性保障:保证在应用的不同部分或不同服务间使用的Prompt版本和结构一致,避免因手动维护导致的不一致问题。