English
主导航

旧版 API

提示

了解如何创建提示词。

提示 是向模型提供输入的过程。输出的质量通常取决于您提示模型的能力。

概览

提示词设计既是一门艺术,也是一门科学。OpenAI 提供了一些策略和 API 设计决策,可帮助您构建强大的提示词,并从模型中获得一致的良好结果。我们鼓励您多加尝试。

API 中的提示词

OpenAI 提供了一个长效的提示词对象,带有版本控制和模板功能,可供项目中的所有用户共享。这种设计使您能够在团队中管理、测试和重用提示词,并在 API、SDK 和仪表板中保持一个核心定义。

通用提示词 ID 为您提供了测试和构建的灵活性。变量和提示词共享一个基础提示词,因此当您创建新版本时,您可以将其用于 评估 并确定某个提示词的表现是更好还是更差。

提示词工具和技巧

  • 提示缓存: 降低高达 80% 的延迟和高达 75% 的成本
  • 提示工程: 了解构建提示词的策略、技巧和工具

创建提示词

登录并使用 OpenAI 仪表板 来创建、保存、版本化并分享您的提示词。

  1. 开始编写提示词

    In the 在 Playground 中生成并迭代函数模式, 填写相关字段以创建所需的提示词。


  2. 添加提示词变量

    变量允许您在不更改提示词的情况下注入动态值。可以在任何消息角色中使用它们,只需使用 {{variable}}。例如,在创建本地天气提示词时,你可以添加一个 city 变量及其值 San Francisco.


  3. 在您的 Responses API 调用中使用提示词

    在 URL 中找到您的提示词 ID 和版本号,并将其作为 prompt_id:

    curl -s -X POST "https://api.openai.com/v1/responses" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
        "prompt": {
        "prompt_id": "pmpt_123",
        "variables": {
            "city": "San Francisco"
        }
        }
    }'
  4. 创建新的提示词版本

    版本让您可以迭代提示词,而不会覆盖已有的细节。您可以在 API 中使用所有版本,并相互比较评估它们的性能。除非您指定版本,否则提示词 ID 默认指向最新发布的版本。

    要创建新版本,请编辑提示词并单击 5 月 28 日。你将收到一个新的提示词 ID,可以将其复制并用于 Responses API 调用中。


  5. 需要时回滚

    In the 提示词仪表板, 选择你要回滚的提示词。在右侧,点击 历史记录。找到你要恢复的版本,然后点击 恢复.

优化您的提示词

  • 将整体基调或角色指导放在系统消息中;将与任务相关的细节和示例保留在用户消息中。
  • 将少样本示例组合成简洁的 YAML 样式或项目符号块,以便于浏览和更新。
  • 使用清晰的文件夹名称反映您的项目结构,以便团队成员能够快速找到提示词。
  • 每次发布时都重新运行关联的评估——在早期发现问题比在生产环境中修复成本更低。

后续步骤

当您对提示词充满信心时,您可能会想查看以下指南和资源。

在 Playground 中构建提示词

使用 Playground 来开发和迭代提示词。

文本生成

了解如何向模型提供提示词以生成文本。

构建更出色的提示词

了解 OpenAI 的提示词工程工具和技巧。