OpenAI Responses API 写作怎么调用可复用提示词模板
先理解调用关系
Responses API 的创建请求支持 prompt 参数,用来引用提示词模板和变量。稳定的角色、写作规则、格式要求适合放进模板;本次文章主题、目标读者和资料适合放进变量或 input。
模板引用通常需要模板标识、版本信息和变量对象。不同账号、SDK 版本或接口规范的字段细节可能不同,下面的请求只作为可复制的结构示例,正式接入前请以当前 SDK 的 ResponsePromptParam 类型和官方接口说明为准。想先梳理稳定规则与任务输入的边界,可以参考Responses API 写作输入怎么组织。
准备
- 准备 OpenAI API 密钥,并放入服务端环境变量,不要写进前端代码。
- 安装并锁定项目使用的 OpenAI Python SDK 版本。
- 在提示词管理入口创建一个写作模板,至少写清角色、事实边界、文章结构、输出格式和未知信息处理方式。
- 为模板记录模板标识、当前版本和变量名,例如
topic、audience、source_material。 - 准备一组固定测试输入,便于模板升级后比较旧版本和新版本的输出。
分步操作
- 拆分固定规则与变化内容。固定规则放在模板中,例如“只依据提供资料写作”“资料没有确认的内容标为待核实”“输出包含标题、提纲和正文”。变化内容放在变量中,例如文章主题和目标受众。
- 先核对变量名。程序发送的变量名必须与模板声明的变量名完全一致。建议在部署前读取配置清单,检查缺少变量、拼写差异和多余变量。
- 调用 Responses API。下面示例保留模板引用位置,模板标识和版本号请替换为你实际创建的值。
import os
from openai import OpenAI
client = OpenAI(api_key=os.environ["OPENAI_API_KEY"])
template_ref = {
"id": "pmpt_your_template_id",
"version": "3",
"variables": {
"topic": "如何为新手整理产品资料",
"audience": "第一次使用 AI 写作工具的内容编辑",
"source_material": "只允许使用已确认的产品说明,不补写资料之外的参数。"
}
}
response = client.responses.create(
model="your_model_id",
prompt=template_ref,
input="请根据模板生成文章提纲和首稿。输出时保留待核实信息标记。",
store=True,
metadata={"template_version": "3", "task_type": "article_draft"}
)
print(response.id)
print(response.output_text)可复制的写作模板
可以把下面内容整理到可复用提示词模板中,再把方括号部分改成团队实际规则:
你是内容编辑,只能依据输入资料写作。
写作目标:生成一篇服务于明确操作问题的文章。
目标主题:[topic]
目标读者:[audience]
可用资料:[source_material]
固定规则:
1. 先说明准备条件,再给出分步操作。
2. 每一步写清动作、判断依据和预期结果。
3. 资料没有确认的事实不得补写,信息不足时标记“待核实”。
4. 提供一段可以直接修改的代码或请求示例。
5. 结尾给出发布前检查项。
6. 输出使用清晰的小标题、列表和代码块,不输出与任务无关的内容。
输出字段:
- title
- intro
- steps
- example
- checks提示词版本管理怎么做
不要只保存“当前模板”四个字。每次修改都应生成明确版本,并记录修改原因、影响范围和一组测试输入。模板只调整表达规则时,可以重点比较结构和格式;模板增加事实约束时,还要检查模型是否停止补写未知内容。
生产请求中固定传入模板版本,测试通过后再切换默认版本。若需要回溯某次生成,使用保存的响应 ID、变量快照和版本号重现请求上下文。
翻车怎么改
常见故障:接口返回参数校验错误,或模型没有按模板输出。
原因:请求里的模板引用结构、变量名称或变量类型与当前模板配置不一致;也可能是代码仍使用旧版本 SDK,导致参数类型定义不同。
修正动作:先打印经过脱敏处理的请求结构,逐项对照模板声明的标识、版本和变量名;再查看已安装 SDK 中的 ResponsePromptParam 类型,确认字段名称和嵌套层级。修正后只用一条最小测试输入验证,成功后再恢复批量任务。
如果接口调用成功但输出跑题,把稳定规则从 input 移回模板,把本次任务资料留在 input 或变量中,并在模板里增加明确的输出字段和未知信息处理规则。
完成前检查
- 发布前验收:确认文章使用的模板标识和版本号已记录,且与本次测试通过的版本一致。
- 确认所有模板变量都有值,变量名没有拼写差异或未替换的占位符。
- 确认响应文本完整,标题、提纲、正文或结构化字段均存在。
- 确认事实内容没有超出提供资料;无法确认的内容已标记待核实。
- 确认 API 密钥没有出现在前端、日志或公开代码中。
下一步
把这篇的方法练一遍
提示词和步骤可以带到创作里直接试做一版。