跳到主要内容Skip to main content
← 深水指南Guides

API 契约API contract

提示词与工作流Prompts & workflows · 提示词案例Prompt case

输出请求/响应 schema 与错误表;未定义项标未知。

Output request/response schemas and an error table; mark undefined items unknown.

提示词效果未实测。Prompt effect has not been tested.

提示词是可复跑的模板,不是效果承诺。换模型、换版本、换输入都可能改变结果;用本页的检查点自己核对,并把官方出处当作机制依据而不是效果保证。A prompt is a re-runnable template, not a promise of results. Changing the model, version or input can change the outcome. Use the checkpoints on this page to verify it yourself, and treat the official sources as evidence of mechanism rather than a guarantee of effect.

任务与输入Task and inputs

整理 API 契约与错误分支。 输入:API 描述、示例请求响应、错误码。

Output request/response schemas and an error table; mark undefined items unknown. Inputs: API description, example requests/responses, and error codes.

提示词本体The prompt

整理 API 契约。输出 endpoint、request_schema、response_schema、errors[]:code、condition、client_action。schema 字段只能来自描述/示例;未定义字段标 undefined。errors 不得编造未给出的错误码。

占位符用 {字段} 标注,运行前替换为本次输入。

Organise the API contract. Output endpoint, request_schema, response_schema and errors[] with code, condition and client_action. Schema fields must come from description/examples; mark undefined fields. Do not invent error codes not provided.

Replace {field} placeholders with the current inputs before running.

预期输出形态Expected output shape

endpoint、schemas、errors[]。

endpoint, schemas, and errors[].

检查点Checkpoints

  • 字段有示例或描述依据。
  • 错误码来自输入。
  • undefined 项明确。
  • Fields have example or description support.
  • Error codes come from input.
  • Undefined items are explicit.

失败分支Failure branches

  • 示例不足:标 undefined,不猜类型。
  • 错误分支缺:列 gap。
  • Insufficient examples: mark undefined, do not guess types.
  • Missing error branches: list gaps.

出处与边界Sources and limits

提示词效果未实测。机制依据见出处;换模型、版本或输入会改变结果。

This site has not tested the effect of this prompt. See the sources for the mechanism; changing model, version or input can change the result.

出处Sources

来源Source链接URL
OpenAI Cookbook · Introduction to Structured Outputs(官方仓库 raw,2026-11-07 直抓 200)OpenAI Cookbook: Introduction to Structured Outputs (official repository raw, fetched 200 on 2026-11-07)https://raw.githubusercontent.com/openai/openai-cookbook/main/examples/Structured_Outputs_Intro.ipynbhttps://raw.githubusercontent.com/openai/openai-cookbook/main/examples/Structured_Outputs_Intro.ipynb

资料快照日期:2026-11-07;单项复核范围与日期见对应正文或来源记录。产品功能与条款可能变化,使用前请核对原始来源。Source snapshot: 2026-11-07; item-specific rechecks and their scope are recorded in the text or source notes. Features and terms may change; check the original sources before use.