主导航

遗留 API

提示

了解如何创建提示词。

提示词(Prompting)是向模型提供输入的过程。输出的质量通常取决于你向模型提供提示词的水平。

概述

提示词工程既是一门艺术,也是一门科学。OpenAI 提供了一些策略和 API 设计方案,旨在帮助你构建高质量的提示词,并从模型中获得稳定、优质的结果。我们鼓励你多加尝试。

API 中的提示词

OpenAI 提供了一个长效的提示词对象,支持版本控制和模板化,并由项目中的所有用户共享。这种设计让你可以在团队中管理、测试和重用提示词,在 API、SDK 和仪表板之间实现统一的定义。

通用的提示词 ID 为你的测试和构建提供了灵活性。变量和提示词共享一个基础提示词,因此当你创建新版本时,可以使用它进行评估,以确定某个提示词的表现是否有所改善。

提示词工具与技巧

创建提示词

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

  1. 开始创建提示词

    Playground (操练场) 中,填写字段以创建所需的提示词。


  2. 添加提示词变量

    变量允许你在不更改提示词的情况下注入动态值。在任何消息角色中使用 {{variable}} 即可。例如,在创建本地天气提示词时,你可以添加一个值为 San Franciscocity 变量。


  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 将指向最新发布的版本。

    要创建新版本,请编辑提示词并点击更新 (Update)。你将获得一个新的提示词 ID,以便在 Responses API 调用中复制并使用。


  5. 根据需要回滚

    提示词仪表板中,选择你想要回滚的提示词。点击右侧的历史记录 (History)。找到你想恢复的版本,然后点击恢复 (Restore)

优化你的提示词

  • 将整体语气或角色设定放在系统消息中;将特定任务的细节和示例放在用户消息中。
  • 将少样本示例 (few-shot examples) 整合为简洁的 YAML 风格或项目符号块,以便于扫描和更新。
  • 使用清晰的文件夹名称来镜像你的项目结构,以便团队成员快速定位提示词。
  • 每次发布时都重新运行关联的评估——在生产环境中修复问题,远不如在早期阶段发现问题成本低。

后续步骤

当你对提示词感到满意时,可以查看以下指南和资源。

在 Playground 中构建提示词

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

文本生成

学习如何引导模型生成文本。

设计更优秀的提示词

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

© . This website operates independently and is not affiliated with or endorsed by OpenAI, Inc. All brand names, logos, and trademarks are the property of their respective owners.