你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Azure AI Foundry 中的 Azure OpenAI 模型 REST API v1 预览版参考

2025-06-11

本文详细介绍了 Azure OpenAI 的推理 REST API 端点。

数据平面推理

本文的其余部分介绍了 Azure OpenAI 数据平面推理规范的新 v1 预览版 API 版本。在 API 生命周期指南中了解详细信息。

若要查找有关最新 GA API 版本的文档，请参阅最新 GA 数据平面推理 API

创建演讲

POST {endpoint}/openai/v1/audio/speech?api-version=preview

从输入文本生成文本转语音音频。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

内容类型：multipart/form-data

名称	类型	DESCRIPTION	必选	违约
输入	字符串	要为其生成音频的文本。最大长度为 4096 个字符。	是的
指示	字符串	通过额外指令控制生成音频的音质。不适用于 `tts-1` 或 `tts-1-hd`.	否
模型	字符串	要用于此文本转语音请求的模型。	是的
响应格式	物体	文本转语音支持的音频输出格式。	否
速度	数字	生成音频的语速。值在 0.25 到 4.0 的范围内有效，默认值为 1.0，对应于更快的语音。	否	1
语音	物体		是的

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/octet-stream	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

例子

示例：

从提供的文本合成音频。

POST {endpoint}/openai/v1/audio/speech?api-version=preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3",
 "model": "tts-1"
}

响应：状态代码：200

{
  "body": "101010101"
}

创建听录

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

将音频转录为输入语言。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

内容类型：multipart/form-data

名称	类型	DESCRIPTION	必选	违约
chunking_strategy	物体		否
└─ prefix_padding_ms	整数	VAD 检测到语音之前要包括的音频量（以毫秒为单位）。	否	300
└─ silence_duration_ms	整数	用于检测语音停止的沉默持续时间（以毫秒为单位）。使用较短的值，模型将更快地响应，但可能会在用户短暂暂停时突然打断。	否	200
~~ 阈值	数字	用于语音活动检测的敏感度阈值（0.0 到 1.0）。更高的阈值需要更响亮的音频来激活模型，因此在干扰环境中性能可能更好。	否	0.5
└─ 类型	枚举	必须设置为 `server_vad` ，以便使用服务器端 VAD 启用手动分块。可能的值： `server_vad`	否
文件	字符串		是的
文件名	字符串	要与音频数据关联的可选文件名或描述性标识符。	否
include[]	数组	应在记录响应中包含的其他信息。 `logprobs` 将在响应中返回标记的日志概率以了解模型对转录的信心。 `logprobs` 仅在 response_format 设置为 `json` 时才适用，并且仅在这种情况下才适用。模型 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe`。	否
语言	字符串	输入音频的语言。以 ISO-639-1（例如 `en`）格式提供输入语言将提高准确性并减少延迟。	否
模型	字符串	用于此听录请求的模型。	否
prompt	字符串	用于指导模型风格或继续之前的音频片段的可选文本。提示应与音频语言匹配。	否
响应格式	物体		否
溪流	布尔	如果设置为 true，模型响应数据将流式传输到客户端在使用服务器发送的事件生成它时。注意：`whisper-1` 模型不支持流式处理，此特性将被忽略。	否	假
温度	数字	采样温度，介于 0 和 1 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性如果设置为 0，则模型将使用对数概率自动增加温度，直到达到某些阈值。	否	0
timestamp_granularities[]	数组	要为此听录填充的时间戳粒度。 `response_format` 必须设为 `verbose_json` 以使用时间戳粒度。支持以下任一选项或两个选项：`word` 或 `segment`。注意：段时间戳没有额外的延迟，但生成单词时间戳会产生额外的延迟。	否	['segment']

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AzureAudioTranscriptionResponse
text/plain	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

例子

示例：

从提供的语音音频数据中获取转录的文本和关联的元数据。

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "verbose_json"
}

响应：状态代码：200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

示例：

从提供的语音音频数据中获取转录的文本和关联的元数据。

POST {endpoint}/openai/v1/audio/transcriptions?api-version=preview

{
 "file": "<binary audio data>",
 "model": "whisper-1",
 "response_format": "text"
}

响应：状态代码：200

{
  "body": "plain text when requesting text, srt, or vtt"
}

创建聊天完成

POST {endpoint}/openai/v1/chat/completions?api-version=preview

创建聊天完成。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称	类型	DESCRIPTION	必选	违约
音频	物体	音频输出的参数。在使用以下格式请求音频输出时是必需的： `modalities: ["audio"]`。	否
└─ 格式	枚举	指定输出音频格式。必须是以下项之一：`wav`、`mp3`、`flac`、 `opus` 或 `pcm16` 中的一项。可能的值：`wav`、、`aac`、`mp3flac`、`opus`、`pcm16`	否
└─ voice	物体		否
数据来源	数组	用于“你的数据”功能的数据源，专用于 Azure OpenAI。	否
frequency_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会基于目前为止文本中的现有出现频率对新令牌进行惩罚降低模型的逐字重复同一行的可能性。	否	0
function_call	枚举	通过 `{"name": "my_function"}` 指定特定函数会强制模型调用该函数。可能的值： `noneauto`	否
功能	数组	已弃用，改用 `tools`。模型可能为其生成 JSON 输入的函数的列表。	否
logit_bias	物体	修改指定令牌在完成中出现的可能性。接受一个 JSON 对象，该对象将令牌（由 tokenizer 中的令牌 ID 指定）映射到 -100 到 100 之间的关联偏差值。从数学上讲采样之前会将偏差添加到由模型生成的 logit 中。具体效果因模型而异，但 -1 和 1 之间的值应减少或增加被选中的可能性，-100 或 100 等值应生成相关令牌的禁令或专属选择。	否	没有
logprobs	布尔	是否返回输出令牌的对数概率。如果为 true，则返回在下列项中返回的每个输出令牌的对数概率 `content` 的 `message`。	否	假
max_completion_tokens	整数	完成可生成令牌数的上限，包括可见的输出令牌和推理令牌。	否
max_tokens	整数	可以在聊天补全时生成的最大词元数。此值可用于控制通过 API 生成的文本的成本。此值现已弃用，推荐使用 `max_completion_tokens`，并且是与 o1 系列模型不兼容。	否
消息	数组	包含到目前为止的对话的消息列表。取决于使用的模型，支持不同的消息类型（形式），如文本、图像和音频。	是的
元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
方式	物体	希望模型生成的输出类型。大多数模型都能够生成文本，这是默认设置： `["text"]` `gpt-4o-audio-preview` 模型还可用于生成音频。若要请求此模型生成文本和音频响应，可以使用： `["text", "audio"]`	否
模型	字符串	用于聊天完成请求的模型部署标识符。	是的
n	整数	要为每个输入消息生成的聊天完成选项数。请注意，将根据所有选项中生成的令牌数向你收费。将 `n` 保留为 `1` 以尽量降低成本。	否	1
parallel_tool_calls	物体	是否在工具使用期间启用并行函数调用。	否
预测	物体	模型预测输出的基表示形式。	否
└─ 类型	OpenAI.ChatOutputPredictionType		否
presence_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会基于目前为止文本中的现有出现频率对新令牌进行惩罚，增加模型讨论新主题的可能性。	否	0
reasoning_effort	物体	仅适用于 O 系列模型限制推理模型的推理力度。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	否
响应格式	物体		否
└─ 类型	枚举	可能的值：`text`、、 `json_objectjson_schema`	否
seed	整数	此功能以 Beta 版本提供。指定后，我们的系统将尽最大努力进行确定性采样，以便具有相同 `seed` 和参数的重复请求应返回相同的结果。无法保证确定性，应引用 `system_fingerprint` 响应参数来监视后端中的更改。	否
停	物体	不支持最新的推理模型 `o3` 和 `o4-mini`。最多四个序列，其中 API 将停止生成更多令牌。返回的文本将不包含停止序列。	否
store	布尔	是否要存储此聊天完成请求的结果输出用于模型蒸馏或评估产品。	否	假
溪流	布尔	如果设置为 true，模型响应数据将流式传输到客户端因为这是使用服务器发送事件生成的。	否	假
stream_options	物体	用于流式处理响应的选项。仅在设置 `stream: true` 时设置此项。	否
└─ include_usage	布尔	如果已设置，则会在 `data: [DONE]` 之前传输额外的区块。消息作为响应。 `usage`此区块上的字段显示令牌使用情况统计信息对于整个请求，字段 `choices` 将始终为空 array. 所有其他区块也将包含一个 `usage` 字段，但值为 null 价值。注意：如果流中断，您可能无法收到包含请求的令牌总使用量的最终使用区块。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
工具选择	OpenAI.ChatCompletionToolChoiceOption	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息和调用一个或多个工具之间进行选择。 `required` 表示模型必须调用一个或多个工具。通过 `{"type": "function", "function": {"name": "my_function"}}` 指定特定工具将强制模型调用该工具。如果没有工具，则 `none` 为默认值。如果存在工具，则 `auto` 为默认值。	否
工具	数组	模型可能调用的工具列表。目前，仅支持函数作为工具。使用它可以提供函数列表，模型可能为其生成 JSON 输入。最多支持 128 个函数。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，用于指定每个令牌位置最有可能返回的令牌，每个位置都有关联的对数概率。如果使用此参数，则必须将 `logprobs` 设置为 `true`。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
用户	字符串	表示最终用户的唯一标识符，可帮助监视和检测滥用行为。	否
用户安全上下文	AzureUserSecurityContext	用户安全上下文包含描述应用程序本身的多个参数，以及与应用程序交互的最终用户。这些字段通过提供全面的方法来保护 AI 应用程序，从而帮助安全运营团队调查和缓解安全事件。详细了解如何使用 Microsoft Defender for Cloud 保护 AI 应用程序。	否

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

例子

示例：

为提供的提示、参数和所选模型创建补全。

POST {endpoint}/openai/v1/chat/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh?..."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

创建完成

POST {endpoint}/openai/v1/completions?api-version=preview

创建完成。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称	类型	DESCRIPTION	必选	违约
best_of	整数	在服务器端生成 `best_of` 补全并返回“最佳”项（每个标记的对数概率最高的项）。无法流式传输结果。使用 `n`时， `best_of` 控制候选完成次数，并 `n` 指定要返回 `best_of` 的次数必须大于 `n`。注意：由于此参数会生成许多补全，因此可能会快速消耗你的标记配额。谨慎使用并确保对 `max_tokens` 和 `stop` 进行了合理的设置。	否	1
回波	布尔	除了完成之外，还回显提示	否	假
frequency_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。	否	0
logit_bias	物体	修改指定令牌在完成中出现的可能性。接受 JSON 对象，该对象将标记（由其在 GPT tokenizer 中的标记 ID 指定）映射到一个 -100 到 100 之间的关联偏差值。在数学上，采样之前会将偏差添加到由模型生成的 logit 中。具体效果因模型而异，但 -1 和 1 之间的值会减少或增加选择的可能性；-100 或 100 等值会导致相关令牌的禁止或独占选择。例如，可以传递 `{"50256": -100}` 以防止生成 <\|endoftext\|> 标记。	否	没有
logprobs	整数	包含有关 `logprobs` 最有可能的输出标记和已选择的标记的对数概率。例如，如果 `logprobs` 为 5，则 API 将返回包含 5 个最有可能的标记的列表。 API 将始终返回采样令牌的 `logprob`，因此响应中可能最多包含 `logprobs+1` 个元素。 `logprobs` 的最大值是 5。	否	没有
max_tokens	整数	可以在补全时生成的最大令牌数。提示的标记计数加上 `max_tokens` 不能超过模型的上下文长度。	否	16
模型	字符串	要用于文本完成请求的模型。	是的
n	整数	要为每个提示生成的完成数。注意：由于此参数会生成许多补全，因此可能会快速消耗你的标记配额。谨慎使用并确保对 `max_tokens` 和 `stop` 进行了合理的设置。	否	1
presence_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止是否在文本中出现来惩罚新令牌，从而增加模型谈论新话题的可能性。	否	0
prompt	字符串或数组	要生成补全的提示，以字符串、字符串数组、标记数组或标记数组的数组的形式编码。请注意，<\|endoftext\|> 是模型在训练期间看到的文档分隔符，因此如果未指定提示，模型将像从新文档的开头生成一样。	否
seed	整数	指定后，我们的系统将尽最大努力进行确定性采样，以便具有相同 `seed` 和参数的重复请求应返回相同的结果。无法保证确定性，应引用 `system_fingerprint` 响应参数来监视后端中的更改。	否
停	物体	不支持最新的推理模型 `o3` 和 `o4-mini`。最多四个序列，其中 API 将停止生成更多令牌。返回的文本将不包含停止序列。	否
溪流	布尔	是否流式传输回部分进度。如果已设置，令牌将在可用时作为仅限数据的服务器发送的事件发送，并且流式传输由 `data: [DONE]` 消息终止。	否	假
stream_options	物体	用于流式处理响应的选项。仅在设置 `stream: true` 时设置此项。	否
└─ include_usage	布尔	如果已设置，则会在 `data: [DONE]` 之前传输额外的区块。消息作为响应。 `usage`此区块上的字段显示令牌使用情况统计信息对于整个请求，字段 `choices` 将始终为空 array. 所有其他区块也将包含一个 `usage` 字段，但值为 null 价值。注意：如果流中断，您可能无法收到包含请求的令牌总使用量的最终使用区块。	否
后缀	字符串	插入的文本完成后的后缀。此参数仅支持 `gpt-3.5-turbo-instruct`。	否	没有
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AzureCreateCompletionResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

例子

示例：

为提供的提示、参数和所选模型创建补全。

POST {endpoint}/openai/v1/completions?api-version=preview

{
 "model": "gpt-4o-mini",
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

响应：状态代码：200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

创建嵌入

POST {endpoint}/openai/v1/embeddings?api-version=preview

创建表示输入文本的嵌入矢量。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称	类型	DESCRIPTION	必选
尺寸	整数	生成的输出嵌入应具有的维度数。仅在 `text-embedding-3` 及更高版本中受支持。	否
编码格式	枚举	嵌入的返回格式。可以为 `float` 或 `base64`。可能的值： `floatbase64`	否
输入	字符串或数组		是的
模型	字符串	要用于嵌入请求的模型。	是的
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.CreateEmbeddingResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

例子

示例：

返回给定提示的嵌入。

POST {endpoint}/openai/v1/embeddings?api-version=preview

{
 "model": "text-embedding-ada-002",
 "input": [
  "this is a test"
 ]
}

响应：状态代码：200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196,
          -0.020365695,
          -0.009631885,
          -0.007647093,
          0.0033837722,
          -0.026764825,
          -0.010501476,
          0.020219658,
          0.024640633,
          -0.0066912062,
          -0.036456455,
          -0.0040923897,
          -0.013966565,
          0.017816665,
          0.005366905,
          0.022835068,
          0.0103488,
          -0.0010811808,
          -0.028942121,
          0.0074280356,
          -0.017033368,
          0.0074877786,
          0.021640211,
          0.002499245,
          0.013316032,
          0.0021524043,
          0.010129742,
          0.0054731146,
          0.03143805,
          0.014856071,
          0.0023366117,
          -0.0008243692,
          0.022781964,
          0.003038591,
          -0.017617522,
          0.0013309394,
          0.0022154662,
          0.00097414135,
          0.012041516,
          -0.027906578,
          -0.023817508,
          0.013302756,
          -0.003003741,
          -0.006890349,
          0.0016744611
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

图像代系 - 编辑

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

根据给定 gpt-image-1 模型部署上的文本描述编辑图像

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
部署标识符 (deployment-id)	路径	是的	字符串
API版本 (api-version)	查询	是的	字符串

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

内容类型：multipart/form-data

名称	类型	DESCRIPTION	必选	违约
图像	字符串或数组	待编辑的图片。必须是受支持的图像文件或图像数组。每个图像应为小于 25MB 的 png 或 jpg 文件。	是的
掩码	字符串	另一个图像，其完全透明区域（例如 alpha 为零）指示应编辑图像的位置。如果提供了多个映像，掩码将应用于第一个图像。必须是有效的 PNG 文件，小于 4MB，并且具有与图像相同的尺寸。	否
n	整数	要生成的图像数。	否	1
prompt	字符串	所需图像的文本说明。最大长度为 32000 个字符。	是的
质量	枚举	将生成的图像的质量。 `high`、`medium` 和 `low` 仅对 `gpt-image-1` 提供支持。 `dall-e-2` 仅支持 `standard` 质量。默认为 `auto`。可能的值：`standard`、、`lowmedium`、`high`、`auto`	否
响应格式	枚举	返回生成图像的格式。必须是 `url` 或 `b64_json` 之一。 URL 仅在生成映像后 60 分钟有效。此参数仅受支持 `dall-e-2`，因为 `gpt-image-1` 始终返回 base64 编码的图像。可能的值： `urlb64_json`	否
size	枚举	生成的图像的大小。必须是 `1024x1024`、`1536x1024`（横向）、`1024x1536`（纵向）或 `auto` 的 `gpt-image-1`（默认值）之一，以及 `256x256`、`512x512` 或 `1024x1024` 的 `dall-e-2` 之一。可能的值：`256x256`、、`512x512`、`1024x10241536x1024`、`1024x1536`、`auto`	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

反应

状态代码：200

说明：确定

内容类型	类型	说明
application/json	AzureImagesResponse

状态代码：默认值

说明：发生错误。

内容类型	类型	说明
application/json	azureerrorresponse

创建映像

POST {endpoint}/openai/v1/images/generations?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称	类型	DESCRIPTION	必选	违约
背景	枚举	允许为生成的图像的背景设置透明度。此参数仅支持 `gpt-image-1`。必须是以下其中一个 `transparent`或 `opaqueauto` （默认值）。使用 `auto` 时，模型将自动确定图像的最佳背景。如果 `transparent`，那么输出格式需要支持透明度，因此它应设置为 `png` （默认值）或 `webp`。可能的值：`transparent`、、 `opaqueauto`	否
模型	字符串	用于生成映像的模型部署。	是的
审查	枚举	控制由 `gpt-image-1` 生成的图像的内容审核级别。必须是用于限制较少的筛选的 `low` 或 `auto`（默认值）。可能的值： `lowauto`	否
n	整数	要生成的图像数。必须介于 1 到 10 之间。对于 `dall-e-3`，仅 `n=1` 受支持。	否	1
output_compression	整数	生成的图像的压缩级别（0-100%）。此参数仅支持`gpt-image-1`与`webp`或`jpeg`输出格式，默认值为 100。	否	100
输出格式	枚举	返回生成图像的格式。此参数仅支持 `gpt-image-1`。必须为 `png`、`jpeg` 或 `webp` 的其中一个。可能的值：`png`、、 `jpegwebp`	否
prompt	字符串	所需图像的文本说明。最大长度为 `gpt-image-1` 的 32000 个字符，`dall-e-2` 的 1000 个字符，`dall-e-3` 的 4000 个字符。	是的
质量	枚举	将生成的图像的质量。 - `auto` （默认值）将自动为给定模型选择最佳质量。 - `high`， `medium` 并且 `low` 受 `gpt-image-1`支持。 - `hd` 和 `standard` 为 `dall-e-3` 提供支持。 - `standard` 是 `dall-e-2` 的唯一选项。可能的值：`standard`、、`hd`、`lowmedium`、`high`、`auto`	否
响应格式	枚举	返回包含 `dall-e-2` 和 `dall-e-3` 的生成图像的格式。必须是 `url` 或 `b64_json` 之一。 URL 仅在生成映像后 60 分钟有效。不支持 `gpt-image-1` 此参数，该参数将始终返回 base64 编码的图像。可能的值： `urlb64_json`	否
size	枚举	生成的图像的大小。必须是 `1024x1024`、`1536x1024`（横向）、`1024x1536`（纵向）或 `auto` 的 `gpt-image-1`（默认值）之一，`256x256`、`512x512` 或 `1024x1024` 的 `dall-e-2` 之一，以及 `1024x1024`、`1792x1024` 或 `1024x1792` 的 `dall-e-3` 之一。可能的值：`auto`、、、`1024x10241536x1024`、`1024x1536256x256`、`512x512`、、 `1792x10241024x1792`	否
style	枚举	生成的图像的样式。此参数仅支持 `dall-e-3`。必须是 `vivid` 或 `natural` 之一。生动效果使模型倾向于生成高度真实和戏剧性的图像。模型由于自然因素会生成更自然、看起来不那么过于真实的图像。可能的值： `vividnatural`	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AzureImagesResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

例子

示例：

根据提示创建图像。

POST {endpoint}/openai/v1/images/generations?api-version=preview

{
 "model": "dall-e-3",
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

响应：状态代码：200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

创建响应

POST {endpoint}/openai/v1/responses?api-version=preview

创建模型响应。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称	类型	DESCRIPTION	必选	违约
背景	布尔	是否在后台运行模型响应。	否	假
包括	数组	指定要包含在模型响应中的其他输出数据。现在支持的值包括： - `file_search_call.results`：包括文件搜索工具的搜索结果。 - `message.input_image.image_url`：包括输入消息中的图像链接。 - `computer_call_output.output.image_url`：包括计算机调用输出中的图像 URL。 - `reasoning.encrypted_content`：包括经过加密的推理版本推理项目输出中的令牌。这样就可以在无状态使用响应 API 时，在多轮次对话中使用推理项（例如当参数 `store` 设置为 `false`，或当组织在零数据保留计划中注册时）。	否
输入	字符串或数组		是的
指示	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
最大输出标记数量 (max_output_tokens)	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	字符串	用于创建此响应的模型部署。	是的
parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
推理	物体	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ effort	OpenAI.ReasoningEffort	仅适用于 O 系列模型限制推理模型的推理工作量。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	否
└─ generate_summary	枚举	已弃用：改用 `summary` 。模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
store	布尔	是否存储生成的模型响应，以便以后通过某种方式检索应用程序接口。	否	真实
溪流	布尔	如果设置为 true，模型响应数据将流式传输到客户端在使用服务器发送的事件生成它时。	否	假
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	物体	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。	否
└─ 类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。	否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如文件搜索。 - 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

例子

示例：

创建模型响应

POST {endpoint}/openai/v1/responses?api-version=preview

获取响应

GET {endpoint}/openai/v1/responses/{response_id}?api-version=preview

检索具有给定 ID 的模型响应。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
response_id (响应编号)	路径	是的	字符串
include[]	查询	否	数组

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	AzureResponse

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

删除响应

DELETE {endpoint}/openai/v1/responses/{response_id}?api-version=preview

按 ID 删除响应。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
response_id (响应编号)	路径	是的	字符串

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	物体

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

Listinputitems

GET {endpoint}/openai/v1/responses/{response_id}/input_items?api-version=preview

返回给定响应的输入项的列表。

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
response_id (响应编号)	路径	是的	字符串
限制	查询	否	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
订单	查询	否	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
后	查询	否	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
之前	查询	否	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	OpenAI.ResponseItemList

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureErrorResponse

视频生成任务 - 创建

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称	类型	DESCRIPTION	必选	违约
身高	整数	视频的高度。支持以下尺寸：480x480、480x854、854x480、720x720、720x1280、1280x720、1080x1080、1080x1920、1920x1080。	是的
模型	字符串	要用于此请求的部署的名称。	是的
n_秒	整数	视频生成作业的持续时间。必须介于 1 到 20 秒之间。	否	5
n_variants	整数	要作为此作业的变体创建的视频数量。必须介于 1 和 5 之间。较小的尺寸允许更多变体。	否	1
prompt	字符串	此视频生成作业的提示。	是的
width	整数	视频的宽度。支持以下尺寸：480x480、480x854、854x480、720x720、720x1280、1280x720、1080x1080、1080x1920、1920x1080。	是的

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	VideoGenerationJob

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureOpenAIVideoGenerationErrorResponse

例子

示例：

创建视频生成任务

POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview

{
 "prompt": "A cat playing piano in a jazz bar.",
 "model": "video-gen-001"
}

响应：状态代码：200

{
  "body": {
    "id": "vidjob_1234567890",
    "object": "video_generation_job",
    "created": 1680000000,
    "status": "queued",
    "prompt": "A cat playing piano in a jazz bar.",
    "model": "video-gen-001"
  }
}

视频生成作业 - 列表

GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
之前	查询	否	字符串
后	查询	否	字符串
限制	查询	是的	整数
状态	查询	否	数组

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	VideoGenerationJobList

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureOpenAIVideoGenerationErrorResponse

视频生成作业 - 获取

GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
job-id	路径	是的	字符串	要用于 Azure OpenAI 请求的视频生成作业的 ID。

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	VideoGenerationJob

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureOpenAIVideoGenerationErrorResponse

视频生成作业 - 删除

DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
职位编号	路径	是的	字符串	要用于 Azure OpenAI 请求的视频生成作业的 ID。

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码： 204

说明：没有要为此请求发送的内容，但标头可能很有用。

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureOpenAIVideoGenerationErrorResponse

视频生成 - 获取

GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
generation-id	路径	是的	字符串	要用于 Azure OpenAI 请求的视频生成器 ID。

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	VideoGeneration

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureOpenAIVideoGenerationErrorResponse

视频生成 - 检索缩略图

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
generation-id	路径	是的	字符串	要用于 Azure OpenAI 请求的视频生成器 ID。
If-Modified-Since	页眉	否	字符串	格式化为 GMT 时间的时间戳

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureOpenAIVideoGenerationErrorResponse

视频代系 - 检索视频

GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-version=preview

URI 参数

名称	在	必选	类型	DESCRIPTION
端点	路径	是的	字符串网址	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version)	查询	否		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `latest` 如果未另行指定，
generation-id	路径	是的	字符串	要用于 Azure OpenAI 请求的视频生成器 ID。
If-Modified-Since	页眉	否	字符串
质量	查询	否

请求标头

使用基于令牌的身份验证或 API 密钥。建议使用基于令牌的身份验证进行身份验证，更安全。

名称	必选	类型	DESCRIPTION
授权	真实	字符串	示例：`Authorization: Bearer {Azure_OpenAI_Auth_Token}` 使用 Azure CLI 生成身份验证令牌： `az account get-access-token --resource https://cognitiveservices.azure.com` 类型：oauth2 授权 URL： `https://login.microsoftonline.com/common/oauth2/v2.0/authorize` 范围：`https://cognitiveservices.azure.com/.default`
API密钥	真实	字符串	在这里提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型	类型	说明
application/json	字符串

状态代码：默认值

说明：意外的错误响应。

内容类型	类型	说明
application/json	AzureOpenAIVideoGenerationErrorResponse

组件

AudioTaskLabel

定义可用于音频操作响应的可能描述符。

资产	价值
说明	定义可用于音频操作响应的可能描述符。
类型	字符串
价值观	`transcribe` `translate`

AzureAIFoundryModelsApiVersion

资产	价值
类型	字符串
价值观	`latest` `preview`

AzureAudioTranscriptionResponse

将语音转录为书面文本的操作结果信息。

名称	类型	DESCRIPTION	必选
持续时间	数字	处理以生成随附听录信息的音频的总持续时间。	否
语言	字符串	转录音频数据中检测到的口语。这表示为双字母 ISO-639-1 语言代码，如“en”或“fr”。	否
段	数组	有关每个已处理音频段的计时、概率和其他详细信息的信息集合。	否
任务	物体	定义可用于音频操作响应的可能描述符。	否
文本	字符串	提供的音频数据的转录文本。	是的
单词	数组	有关每个已处理单词时间安排的信息集合。	否

AzureChatCompletionResponseMessage

Azure OpenAI 服务中用于聊天完成消息的扩展响应模型组件。此模型添加了对聊天消息上下文的支持，供“你的数据”功能用于意图、引文以及其他事项。

名称	类型	DESCRIPTION	必选
注释	数组	消息的批注（如果适用）与使用以下项时一样 Web 搜索工具。	否
音频	物体	如果请求音频输出形式，则此对象包含有关模型的音频响应的数据。	否
└─ 数据	字符串	模型生成的 Base64 编码的音频字节，采用请求中指定的格式。	否
└─ expires_at	整数	当此音频响应在服务器上不再可供多轮对话使用时的 Unix 时间戳（以秒为单位）。	否
└─ id	字符串	此音频响应的唯一标识符。	否
└─ transcript	字符串	模型生成的音频的脚本。	否
内容	字符串	消息的内容。	是的
上下文	物体	一个附加属性，添加到聊天完成响应消息，使用扩展行为时由 Azure OpenAI 服务生成。这包括“On Your Data”功能的意图和引文信息。	否
└─ all_retrieved_documents	物体	有关数据检索操作检索的文档的摘要信息。	否
└─ chunk_id	字符串	引文的区块 ID。	否
└─ 内容	字符串	引文的内容。	否
└─ data_source_index	整数	用于检索的数据源的索引。	否
└─ 文件路径	字符串	引文的文件路径。	否
└─ filter_reason	枚举	如果适用，则指示文档被筛选的原因。可能的值： `scorererank`	否
└─ original_search_score	数字	用于检索的原始搜索分数。	否
└─ rerank_score	数字	检索的重新排名分数。	否
└─ search_queries	数组	执行用于检索文档的搜索查询。	否
└─ 标题	字符串	引文的标题。	否
└─ 网址	字符串	引文的 URL。	否
~~ 引文	数组	数据检索生成的引文。	否
└─ 意图	字符串	聊天历史记录中检测到的意向，用于在不同交互之间传递会话上下文	否
function_call	物体	已弃用并替换为 `tool_calls`。应调用的函数的名称和参数，由模型生成。	否
└─ arguments	字符串		否
└─ 名称	字符串		否
reasoning_content	字符串	特定于 Azure 的扩展属性，其中包含从受支持模型生成的推理内容。	否
拒绝	字符串	模型生成的拒绝消息。	是的
角色	枚举	此消息作者的角色。可能的值： `assistant`	是的
tool_calls	ChatCompletionMessageToolCallsItem	模型生成的工具调用，例如函数调用。	否

AzureChatCompletionStreamResponseDelta

Azure OpenAI 服务上流式聊天响应消息的扩展响应模型。此模型添加了对聊天消息上下文的支持，供“你的数据”功能用于意图、引文以及其他事项。

名称	类型	DESCRIPTION	必选
音频	物体		否
└─ 数据	字符串		否
└─ expires_at	整数		否
└─ id	字符串		否
└─ 转录	字符串		否
内容	字符串	区块消息的内容。	否
上下文	物体	一个附加属性，添加到聊天完成响应消息，使用扩展行为时由 Azure OpenAI 服务生成。这包括“On Your Data”功能的意图和引文信息。	否
└─ all_retrieved_documents	物体	有关数据检索操作检索的文档的摘要信息。	否
└─ chunk_id	字符串	引文的区块 ID。	否
└─ 内容	字符串	引文的内容。	否
└─ data_source_index	整数	用于检索的数据源的索引。	否
└─ 文件路径	字符串	引文的文件路径。	否
└─ filter_reason	枚举	如果适用，则指示文档被筛选的原因。可能的值： `scorererank`	否
└─ original_search_score	数字	用于检索的原始搜索分数。	否
└─ rerank_score	数字	检索的重新排名分数。	否
└─ search_queries	数组	执行用于检索文档的搜索查询。	否
└─ 标题	字符串	引文的标题。	否
└─ 网址	字符串	引文的 URL。	否
~~ 引文	数组	数据检索生成的引文。	否
└─ 意图	字符串	聊天历史记录中检测到的意向，用于在不同交互之间传递会话上下文	否
function_call	物体	已弃用并替换为 `tool_calls`。应调用的函数的名称和参数，由模型生成。	否
└─ arguments	字符串		否
└─ 名称	字符串		否
reasoning_content	字符串	特定于 Azure 的扩展属性，其中包含从受支持模型生成的推理内容。	否
拒绝	字符串	模型生成的拒绝消息。	否
角色	物体	邮件作者的角色	否
tool_calls	数组		否

AzureChatDataSource

单个 Azure OpenAI 聊天数据源的配置数据的表示形式。这将由聊天补全请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。使用此配置仅与 Azure OpenAI 兼容。

Discriminator for AzureChatDataSource

此组件使用属性 type 区分不同类型的：

类型值	图式
`azure_search`	AzureSearchChatDataSource
`azure_cosmos_db`	AzureCosmosDBChatDataSource
`elasticsearch`	ElasticsearchChatDataSource
`pinecone`	PineconeChatDataSource
`mongo_db`	MongoDBChatDataSource

名称	类型	DESCRIPTION	必选	违约
类型	物体		是的

AzureChat 数据源访问令牌身份验证选项

名称	类型	DESCRIPTION	必选	违约
访问令牌 (access_token)	字符串		是的
类型	枚举	可能的值： `access_token`	是的

AzureChatDataSourceApiKeyAuthenticationOptions

名称	类型	DESCRIPTION	必选	违约
钥匙	字符串		是的
类型	枚举	可能的值： `api_key`	是的

Azure聊天数据源认证选项(AzureChatDataSourceAuthenticationOptions)

AzureChatDataSourceAuthenticationOptions 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`system_assigned_managed_identity`	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
`access_token`	AzureChatDataSourceAccessTokenAuthenticationOptions (Azure聊天数据源访问令牌身份验证选项)
`connection_string`	AzureChatDataSourceConnectionStringAuthenticationOptions
`key_and_key_id`	AzureChat数据源密钥和密钥ID认证选项
`encoded_api_key`	Azure聊天数据源编码API密钥认证选项
`username_and_password`	Azure聊天数据源用户名和密码身份验证选项

名称	类型	DESCRIPTION	必选	违约
类型	AzureChatDataSourceAuthenticationOptionsType		是的

Azure聊天数据源身份验证选项类型

资产	价值
类型	字符串
价值观	`api_key` `username_and_password` `connection_string` `key_and_key_id` `encoded_api_key` `access_token` `system_assigned_managed_identity` `user_assigned_managed_identity`

AzureChatDataSourceConnectionStringAuthenticationOptions

名称	类型	DESCRIPTION	必选	违约
连接字符串	字符串		是的
类型	枚举	可能的值： `connection_string`	是的

AzureChatDataSourceDeploymentNameVectorizationSource

表示对 Azure OpenAI 嵌入模型部署进行内部服务调用的向量化源。与基于终结点的向量化源不同，基于部署名称的矢量化源必须是同一 Azure OpenAI 资源的一部分，但即使在专用网络中也可以使用。

名称	类型	DESCRIPTION	必选
部署名称	字符串	用于矢量化的嵌入模型的部署。此部署必须存在于同一 Azure OpenAI 中用于完成聊天的模型部署所需资源。	是的
尺寸	整数	请求嵌入时所需的维度数量。仅在 text-embedding-3 和更高版本的模型中受支持。	否
类型	枚举	此矢量化源类型的类型标识符始终为“deployment_name”。可能的值： `deployment_name`	是的

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

名称	类型	DESCRIPTION	必选	违约
编码的API密钥	字符串		是的
类型	枚举	可能的值： `encoded_api_key`	是的

AzureChatDataSourceEndpointVectorizationSource

表示对 Azure OpenAI 嵌入模型部署进行公共服务调用的向量化源。

名称	类型	DESCRIPTION	必选
身份验证	物体		是的
└─ access_token	字符串		否
└─ key	字符串		否
└─ 类型	枚举	可能的值： `access_token`	否
尺寸	整数	请求嵌入时所需的维度数量。仅在 text-embedding-3 和更高版本的模型中受支持。	否
端点	字符串	指定应从中检索嵌入的资源终结点 URL。它的格式应为： https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. 不允许 API 版本查询参数。	是的
类型	枚举	类型标识符，对于此矢量化源类型始终为“endpoint”。可能的值： `endpoint`	是的

Azure聊天数据源集成向量化源

表示在支持搜索资源中定义的集成矢量化源。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	类型标识符，对于此矢量化源类型始终为“integrated”。可能的值： `integrated`	是的

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

名称	类型	DESCRIPTION	必选
钥匙	字符串		是的
密钥ID	字符串		是的
类型	枚举	可能的值： `key_and_key_id`	是的

AzureChatDataSourceModelIdVectorizationSource

表示基于搜索服务模型 ID 进行服务调用的矢量化源。此源类型目前仅受 Elasticsearch 支持。

名称	类型	DESCRIPTION	必选	违约
模型编号	字符串	用于矢量化的嵌入模型的生成 ID。	是的
类型	枚举	此矢量化源类型的类型标识符，始终为“model_id”。可能的值： `model_id`	是的

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `system_assigned_managed_identity`	是的

Azure聊天数据源类型

资产	价值
类型	字符串
价值观	`azure_search` `azure_cosmos_db` `elasticsearch` `pinecone` `mongo_db`

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

名称	类型	DESCRIPTION	必选	违约
managed_identity_resource_id	字符串		是的
类型	枚举	可能的值： `user_assigned_managed_identity`	是的

Azure 聊天数据源用户名和密码验证选项

名称	类型	DESCRIPTION	必选
密码	字符串		是的
类型	枚举	可能的值： `username_and_password`	是的
用户名	字符串		是的

AzureChatDataSourceVectorizationSource

用作包含数据源的嵌入资源的数据向量化源的表示形式。

AzureChatDataSourceVectorizationSource 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`deployment_name`	AzureChatDataSourceDeploymentNameVectorizationSource
`integrated`	AzureChatDataSourceIntegratedVectorizationSource
`model_id`	AzureChat数据源模型ID向量化来源

名称	类型	DESCRIPTION	必选	违约
类型	物体		是的

AzureChatDataSourceVectorizationSourceType

资产	价值
类型	字符串
价值观	`endpoint` `deployment_name` `model_id` `integrated`

Azure聊天消息上下文

一个附加属性，添加到聊天完成响应消息，使用扩展行为时，由 Azure OpenAI 服务生成。这包括“On Your Data”功能的意图和引文信息。

名称	类型	DESCRIPTION	必选
all_retrieved_documents	物体	有关数据检索操作检索的文档的摘要信息。	否
└─ chunk_id	字符串	引文的区块 ID。	否
└─ 内容	字符串	引文的内容。	否
└─ data_source_index	整数	用于检索的数据源的索引。	否
└─ 文件路径	字符串	引文的文件路径。	否
└─ filter_reason	枚举	如果适用，则指示文档被筛选的原因。可能的值： `scorererank`	否
└─ original_search_score	数字	用于检索的原始搜索分数。	否
└─ rerank_score	数字	检索的重新排名分数。	否
└─ search_queries	数组	执行用于检索文档的搜索查询。	否
└─ 标题	字符串	引文的标题。	否
└─ 网址	字符串	引文的 URL。	否
引文	数组	数据检索生成的引文。	否
意向	字符串	聊天历史记录中检测到的意向，用于在不同交互之间传递会话上下文	否

AzureContentFilterBlocklistResult

配置的自定义阻止列表的 true/false 筛选结果的集合。

名称	类型	DESCRIPTION	必选	违约
详细信息	数组	单个阻止列表 ID 对以及它们是否导致筛选操作。	否
filtered	布尔	一个值，该值指示任何详细阻止列表是否触发了过滤操作。	是的

AzureContentFilterCompletionTextSpan

Azure OpenAI 内容筛选器结果中使用的完成文本段的表示形式。

名称	类型	DESCRIPTION	必选	违约
completion_end_offset	整数	从跨度中排除的第一个 UTF32 码位元素的偏移量。对于空跨度，此字段始终等于 completion_start_offset。对于非空范围，此字段始终大于completion_start_offset。	是的
completion_start_offset	整数	开始跨度的 UTF32 码位元素的偏移量。	是的

AzureContentFilterCompletionTextSpanDetectionResult

名称	类型	DESCRIPTION	必选
详细信息	数组	有关检测到的完成文本范围的详细信息。	是的
detected	布尔	是否在内容中检测到标记的内容类别。	是的
filtered	布尔	内容检测是否导致内容筛选操作。	是的

AzureContentFilterDetectionResult

一个标记的内容筛选器结果项，指示是否检测到内容以及是否筛选了内容。

名称	类型	DESCRIPTION	必选	违约
detected	布尔	是否在内容中检测到标记的内容类别。	是的
filtered	布尔	内容检测是否导致内容筛选操作。	是的

AzureContentFilterImagePromptResults

用于图像生成操作的输入请求内容的内容筛选结果。

名称	类型	DESCRIPTION	必选
自定义屏蔽列表	物体	配置的自定义阻止列表的 true/false 筛选结果的集合。	否
~~ 详细信息	数组	单个阻止列表 ID 对以及它们是否导致筛选操作。	否
~~ 已筛选	布尔	一个值，该值指示任何详细阻止列表是否触发了过滤操作。	否
越狱	物体	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	是的
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否
亵渎	物体	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	否
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否

Azure内容过滤器图像响应结果

用于图像生成操作的输出响应内容的内容筛选结果。

名称	类型	DESCRIPTION	必选
hate	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
自残	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ 严重程度	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
性的	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
暴力	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ severity	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否

AzureContentFilterResultForChoice

由生成性 AI 系统生成的单个响应项的内容筛选结果。

名称	类型	DESCRIPTION	必选
自定义屏蔽列表	物体	配置的自定义阻止列表的 true/false 筛选结果的集合。	否
~~ 详细信息	数组	单个阻止列表 ID 对以及它们是否导致筛选操作。	否
~~ 已筛选	布尔	一个值，该值指示任何详细阻止列表是否触发了过滤操作。	否
错误	物体	如果存在，则有关阻止内容筛选完成评估的错误的详细信息。	否
└─ code	整数	与错误关联的独特计算机可读代码。	否
└─ 消息	字符串	与错误关联的人工可读消息。	否
hate	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
亵渎	物体	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	否
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否
protected_material_code	物体	描述与许可代码或其他受保护源材料匹配的检测结果。	否
└─ 引文	物体	如果可用，则为描述关联的许可证及其位置的引文详细信息。	否
└─ 网址	字符串	与许可证关联的 URL。	否
~~ 许可证	字符串	与检测关联的许可证的名称或标识符。	否
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否
protected_material_text	物体	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	否
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否
自残	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ severity	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
性的	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ severity	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
ungrounded_material	AzureContentFilterCompletionTextSpanDetectionResult		否
暴力	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否

AzureContentFilterResultForPrompt

与生成式 AI 系统中的单个输入提示项相关联的内容筛选结果。

名称	类型	DESCRIPTION	必选
content_filter_results	物体	结果的内容筛选类别详细信息。	否
└─ custom_blocklists	物体	配置的自定义阻止列表的 true/false 筛选结果的集合。	否
~~ 详细信息	数组	单个阻止列表 ID 对以及它们是否导致筛选操作。	否
~~ 已筛选	布尔	一个值，该值指示任何详细阻止列表是否触发了过滤操作。	否
~~ 错误	物体	如果存在，则有关阻止内容筛选完成评估的错误的详细信息。	否
└─ code	整数	与错误关联的独特计算机可读代码。	否
└─ 消息	字符串	与错误关联的人工可读消息。	否
~~ 仇恨	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
└─ indirect_attack	物体	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	否
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否
└─ jailbreak	物体	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	否
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否
~~ 亵渎	物体	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	否
└─ detected	布尔	是否在内容中检测到标记的内容类别。	否
~~ 已筛选	布尔	内容检测是否导致内容筛选操作。	否
└─ self_harm	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
└─ sexual	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ severity	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
~~ 暴力	物体	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	否
~~ 已筛选	布尔	内容严重性是否导致进行内容筛选	否
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	否
prompt_index	整数	与随附的内容筛选结果类别关联的输入提示的索引。	否

AzureContentFilterSeverityResult

根据类别内容筛选的配置进行评估，一个标记的内容筛选结果项指示内容是否被筛选以及内容的严重性级别。

名称	类型	DESCRIPTION	必选	违约
filtered	布尔	内容严重性是否导致进行内容筛选	是的
严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	是的

AzureCosmosDB聊天数据源

表示将使用 Azure CosmosDB 资源的数据源配置。

名称	类型	DESCRIPTION	必选	违约
参数	物体	用于控制 Azure CosmosDB 数据源使用的参数信息。	是的
└─ allow_partial_result	布尔	如果设置为 true，系统将允许使用部分搜索结果，并且请求将失败（如果全部）部分查询失败。如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。	否	假
~~ 身份验证	AzureChatDataSourceConnectionStringAuthenticationOptions		否
└─ 容器名称	字符串		否
└─ 数据库名称	字符串		否
└─ embedding_dependency	AzureChatDataSourceVectorizationSource	用作包含数据源的嵌入资源的数据向量化源的表示形式。	否
└─ fields_mapping	物体		否
└─ content_fields	数组		否
└─ content_fields_separator	字符串		否
└─ filepath_field	字符串		否
└─ title_field	字符串		否
└─ url_field	字符串		否
└─ 向量场	数组		否
└─ in_scope	布尔	是否应将查询限制为使用索引数据。	否
└─ include_contexts	数组	响应中要包含的输出上下文属性。默认情况下，会请求引用和意向。	否	['引文', '意图']
└─ index_name	字符串		否
└─ max_search_queries	整数	应发送到搜索提供程序的单个用户消息的最大重写查询数。默认情况下，系统将进行自动确定。	否
~~ 严格性	整数	搜索相关性筛选的已配置严格性。更高的严格性会增加精度，但降低答案的召回率。	否
└─ top_n_documents	整数	用于查询中展示的已配置文档数量。	否
类型	枚举	区分类型标识符，始终为“azure_cosmos_db”。可能的值： `azure_cosmos_db`	是的

AzureCreateChatCompletionRequest

针对 Azure OpenAI 服务的聊天完成的扩展请求模型。这增加了为“你的数据”功能提供数据源的能力。

名称	类型	DESCRIPTION	必选	违约
音频	物体	音频输出的参数。在使用以下格式请求音频输出时是必需的： `modalities: ["audio"]`。	否
└─ 格式	枚举	指定输出音频格式。必须是以下项之一：`wav`、`mp3`、`flac`、 `opus` 或 `pcm16` 中的一项。可能的值：`wav`、、`aac`、`mp3flac`、`opus`、`pcm16`	否
└─ voice	物体		否
数据来源	数组	用于“你的数据”功能的数据源，专用于 Azure OpenAI。	否
frequency_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会基于目前为止文本中的现有出现频率对新令牌进行惩罚降低模型的逐字重复同一行的可能性。	否	0
function_call	枚举	通过 `{"name": "my_function"}` 指定特定函数会强制模型调用该函数。可能的值： `noneauto`	否
功能	数组	已弃用，改用 `tools`。模型可能为其生成 JSON 输入的函数的列表。	否
logit_bias	物体	修改指定令牌在完成中出现的可能性。接受一个 JSON 对象，该对象将令牌（由 tokenizer 中的令牌 ID 指定）映射到 -100 到 100 之间的关联偏差值。从数学上讲采样之前会将偏差添加到由模型生成的 logit 中。具体效果因模型而异，但 -1 和 1 之间的值应减少或增加被选中的可能性，-100 或 100 等值应生成相关令牌的禁令或专属选择。	否	没有
logprobs	布尔	是否返回输出令牌的对数概率。如果为 true，则返回在下列项中返回的每个输出令牌的对数概率 `content` 的 `message`。	否	假
max_completion_tokens	整数	完成可生成令牌数的上限，包括可见的输出令牌和推理令牌。	否
max_tokens	整数	可以在聊天补全时生成的最大词元数。此值可用于控制通过 API 生成的文本的成本。此值现已弃用，推荐使用 `max_completion_tokens`，并且是与 o1 系列模型不兼容。	否
消息	数组	包含到目前为止的对话的消息列表。取决于使用的模型，支持不同的消息类型（形式），如文本、图像和音频。	是的
元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
方式	物体	希望模型生成的输出类型。大多数模型都能够生成文本，这是默认设置： `["text"]` `gpt-4o-audio-preview` 模型还可用于生成音频。若要请求此模型生成文本和音频响应，可以使用： `["text", "audio"]`	否
模型	字符串	用于聊天完成请求的模型部署标识符。	是的
n	整数	要为每个输入消息生成的聊天完成选项数。请注意，将根据所有选项中生成的令牌数向你收费。将 `n` 保留为 `1` 以尽量降低成本。	否	1
parallel_tool_calls	物体	是否在工具使用期间启用并行函数调用。	否
预测	物体	模型预测输出的基表示形式。	否
└─ 类型	OpenAI.ChatOutputPredictionType		否
presence_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会基于目前为止文本中的现有出现频率对新令牌进行惩罚，增加模型讨论新主题的可能性。	否	0
reasoning_effort	物体	仅适用于 O 系列模型限制推理模型的推理工作量。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	否
响应格式	物体		否
└─ 类型	枚举	可能的值：`text`、、 `json_objectjson_schema`	否
seed	整数	此功能以 Beta 版本提供。指定后，我们的系统将尽最大努力进行确定性采样，以便具有相同 `seed` 和参数的重复请求应返回相同的结果。无法保证确定性，应引用 `system_fingerprint` 响应参数来监视后端中的更改。	否
停	物体	不支持最新的推理模型 `o3` 和 `o4-mini`。最多四个序列，其中 API 将停止生成更多令牌。返回的文本将不包含停止序列。	否
store	布尔	是否要存储此聊天完成请求的结果输出用于模型蒸馏或评估产品。	否	假
溪流	布尔	如果设置为 true，模型响应数据将流式传输到客户端因为这是使用服务器发送事件生成的。	否	假
stream_options	物体	用于流式处理响应的选项。仅在设置 `stream: true` 时设置此项。	否
└─ include_usage	布尔	如果已设置，则会在 `data: [DONE]` 之前传输额外的区块。消息作为响应。 `usage`此区块上的字段显示令牌使用情况统计信息对于整个请求，字段 `choices` 将始终为空 array. 所有其他区块也将包含一个 `usage` 字段，但值为 null 价值。注意：如果流中断，您可能无法收到包含请求的令牌总使用量的最终使用区块。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
工具选择	OpenAI.ChatCompletionToolChoiceOption	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息和调用一个或多个工具之间进行选择。 `required` 表示模型必须调用一个或多个工具。通过 `{"type": "function", "function": {"name": "my_function"}}` 指定特定工具将强制模型调用该工具。如果没有工具，则 `none` 为默认值。如果存在工具，则 `auto` 为默认值。	否
工具	数组	模型可能调用的工具列表。目前，仅支持函数作为工具。使用它可以提供函数列表，模型可能为其生成 JSON 输入。最多支持 128 个函数。	否
top_logprobs	整数	一个介于 0 和 20 之间的整数，用于指定每个令牌位置最有可能返回的令牌，每个位置都有关联的对数概率。如果使用此参数，则必须将 `logprobs` 设置为 `true`。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
用户	字符串	表示最终用户的唯一标识符，可帮助监视和检测滥用行为。	否
用户安全上下文	AzureUserSecurityContext	用户安全上下文包含描述应用程序本身的多个参数，以及与应用程序交互的最终用户。这些字段通过提供全面的方法来保护 AI 应用程序，从而帮助安全运营团队调查和缓解安全事件。详细了解如何使用 Microsoft Defender for Cloud 保护 AI 应用程序。	否

AzureCreateChatCompletionResponse

Azure OpenAI 服务的扩展顶级聊天完成响应模型。此模型在提示输入中添加负责任 AI 内容标注。

名称	类型	DESCRIPTION	必选
选择	数组		是的
已创建	整数	聊天补全创建时间的 Unix 时间戳（以秒为单位）。	是的
ID	字符串	聊天补全的唯一标识符。	是的
模型	字符串	用于聊天完成的模型。	是的
物体	枚举	始终为 `chat.completion` 的对象类型。可能的值： `chat.completion`	是的
prompt_filter_results	数组	与聊天完成相关的提示输入中关联的负责任的 AI 内容筛选批注。	否
system_fingerprint	字符串	这个指纹表示模型运行的后端配置。可以与 `seed` 请求参数一起使用，以了解何时进行了可能影响确定性的后端更改。	否
使用量	OpenAI.CompletionUsage	完成请求的使用情况统计信息。	否

AzureCreateChatCompletionStreamResponse

名称	类型	DESCRIPTION	必选	违约
选择	数组	聊天完成选项的列表。如果 `n` 大于 1，则可以包含多个元素。对于最后一个区块也可以为空，如果已设置 `stream_options: {"include_usage": true}`。	是的
已创建	整数	聊天补全创建时间的 Unix 时间戳（以秒为单位）。每个区块具有相同的时间戳。	是的
delta	AzureChatCompletionStreamResponseDelta	Azure OpenAI 服务上流式聊天响应消息的扩展响应模型。此模型添加了对聊天消息上下文的支持，供“你的数据”功能用于意图、引文以及与检索增强生成执行相关的其他信息。	否
ID	字符串	聊天补全的唯一标识符。每个区块具有相同的 ID。	是的
模型	字符串	要生成补全的模型。	是的
物体	枚举	始终为 `chat.completion.chunk` 的对象类型。可能的值： `chat.completion.chunk`	是的
system_fingerprint	字符串	这个指纹表示模型运行的后端配置。可以与 `seed` 请求参数一起使用，以了解何时进行了可能影响确定性的后端更改。	否
使用量	物体	完成请求的使用情况统计信息。	否
└─ completion_tokens	整数	生成的补全中的词元数。	否	0
└─ completion_tokens_details	物体	完成时使用的令牌明细。	否
└─ accepted_prediction_tokens	整数	使用预测的输出时，在完成中显示的预测中的令牌数量。	否	0
└─ audio_tokens	整数	模型生成的音频输入标记。	否	0
└─ reasoning_tokens	整数	用于推理的由模型生成的令牌。	否	0
└─ rejected_prediction_tokens	整数	使用预测的输出时，没有出现在结果中的预测的令牌数量。但是，例如推理令牌，这些令牌仍计算在用于计费、输出和上下文窗口限制的完成令牌总数中。	否	0
└─ prompt_tokens	整数	提示中的标记数。	否	0
└─ prompt_tokens_details	物体	提示中使用的标识符分解。	否
└─ audio_tokens	整数	提示中存在的音频输入标记。	否	0
└─ cached_tokens	整数	提示中存在的缓存令牌。	否	0
└─ total_tokens	整数	请求中使用的令牌总数（提示 + 补全）。	否	0

AzureCreateCompletionRequest

名称	类型	DESCRIPTION	必选	违约
best_of	整数	在服务器端生成 `best_of` 补全并返回“最佳”项（每个标记的对数概率最高的项）。无法流式传输结果。与 `n` 一起使用时，`best_of` 控制着候选补全数，`n` 指定返回的补全数 - `best_of` 必须大于 `n`。注意：由于此参数会生成许多补全，因此可能会快速消耗你的标记配额。谨慎使用并确保对 `max_tokens` 和 `stop` 进行了合理的设置。	否	1
回波	布尔	除了完成之外，还回显提示	否	假
frequency_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。	否	0
logit_bias	物体	修改指定令牌在完成中出现的可能性。接受 JSON 对象，该对象将标记（由其在 GPT tokenizer 中的标记 ID 指定）映射到一个 -100 到 100 之间的关联偏差值。在数学上，采样之前会将偏差添加到由模型生成的 logit 中。具体效果因模型而异，但 -1 和 1 之间的值会减少或增加选择的可能性；-100 或 100 等值会导致相关令牌的禁止或独占选择。例如，可以传递 `{"50256": -100}` 以防止生成 <\|endoftext\|> 标记。	否	没有
logprobs	整数	包含有关 `logprobs` 最有可能的输出标记和已选择的标记的对数概率。例如，如果 `logprobs` 为 5，则 API 将返回包含 5 个最有可能的标记的列表。 API 将始终返回采样令牌的 `logprob`，因此响应中可能最多包含 `logprobs+1` 个元素。 `logprobs` 的最大值是 5。	否	没有
max_tokens	整数	可以在补全时生成的最大令牌数。提示的标记计数加上 `max_tokens` 不能超过模型的上下文长度。	否	16
模型	字符串	要用于文本完成请求的模型。	是的
n	整数	要为每个提示生成的完成数。注意：由于此参数会生成许多补全，因此可能会快速消耗你的标记配额。谨慎使用并确保对 `max_tokens` 和 `stop` 进行了合理的设置。	否	1
presence_penalty	数字	介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止是否在文本中出现来惩罚新令牌，从而增加模型谈论新话题的可能性。	否	0
prompt	字符串或数组	要生成补全的提示，以字符串、字符串数组、标记数组或标记数组的数组的形式编码。请注意，<\|endoftext\|> 是模型在训练期间看到的文档分隔符，因此如果未指定提示，模型将像从新文档的开头生成一样。	否
seed	整数	指定后，我们的系统将尽最大努力进行确定性采样，以便具有相同 `seed` 和参数的重复请求应返回相同的结果。无法保证确定性，应引用 `system_fingerprint` 响应参数来监视后端中的更改。	否
停	物体	不支持最新的推理模型 `o3` 和 `o4-mini`。最多四个序列，其中 API 将停止生成更多令牌。返回的文本将不包含停止序列。	否
溪流	布尔	是否流式传输回部分进度。如果已设置，令牌将在可用时作为仅限数据的服务器发送的事件发送，并且流式传输由 `data: [DONE]` 消息终止。	否	假
stream_options	物体	用于流式处理响应的选项。仅在设置 `stream: true` 时设置此项。	否
└─ include_usage	布尔	如果已设置，则会在 `data: [DONE]` 之前传输额外的区块。消息作为响应。 `usage`此区块上的字段显示令牌使用情况统计信息对于整个请求，字段 `choices` 将始终为空 array. 所有其他区块也将包含一个 `usage` 字段，但值为 null 价值。注意：如果流中断，您可能无法收到包含请求的令牌总使用量的最终使用区块。	否
后缀	字符串	插入的文本完成后的后缀。此参数仅支持 `gpt-3.5-turbo-instruct`。	否	没有
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

AzureCreateCompletionResponse

表示来自 API 的补全响应。注意：流式处理和非流式处理的响应对象共享相同的形状（与聊天终结点不同）。

名称	类型	DESCRIPTION	必选
选择	数组	为输入提示生成的模型完成选项的列表。	是的
已创建	整数	创建完成时间的 Unix 时间戳（以秒为单位）。	是的
ID	字符串	完成的唯一标识符。	是的
模型	字符串	用于补全的模型。	是的
物体	枚举	对象类型，始终为“text_completion”。可能的值： `text_completion`	是的
prompt_filter_results	数组		否
system_fingerprint	字符串	这个指纹表示模型运行的后端配置。可以与 `seed` 请求参数一起使用，以了解何时进行了可能影响确定性的后端更改。	否
使用量	OpenAI.CompletionUsage	完成请求的使用情况统计信息。	否

AzureCreateEmbeddingRequest

名称	类型	DESCRIPTION	必选
尺寸	整数	生成的输出嵌入应具有的维度数。仅在 `text-embedding-3` 及更高版本中受支持。	否
编码格式	枚举	嵌入的返回格式。可以为 `float` 或 `base64`。可能的值： `floatbase64`	否
输入	字符串或数组		是的
模型	字符串	要用于嵌入请求的模型。	是的
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

AzureCreateImageEditRequestMultiPart

名称	类型	DESCRIPTION	必选	违约
背景	枚举	允许为生成的图像的背景设置透明度。此参数仅支持 `gpt-image-1`。必须是以下其中一个 `transparent`或 `opaqueauto` （默认值）。使用 `auto` 时，模型将自动确定图像的最佳背景。如果 `transparent`，那么输出格式需要支持透明度，因此它应设置为 `png` （默认值）或 `webp`。可能的值：`transparent`、、 `opaqueauto`	否
图像	字符串或数组		是的
掩码	字符串		否
模型	字符串	用于执行图像编辑操作的模型部署。	是的
n	整数	要生成的图像数。必须介于 1 到 10 之间。	否	1
prompt	字符串	所需图像的文本说明。最大长度为 1000 个字符`dall-e-2`，32000 个字符。`gpt-image-1`	是的
质量	枚举	将生成的图像的质量。 `high`、`medium` 和 `low` 仅对 `gpt-image-1` 提供支持。 `dall-e-2` 仅支持 `standard` 质量。默认为 `auto`。可能的值：`standard`、、`lowmedium`、`high`、`auto`	否
响应格式	枚举	返回生成图像的格式。必须是 `url` 或 `b64_json` 之一。 URL 仅在生成映像后 60 分钟有效。此参数仅受支持 `dall-e-2`，因为 `gpt-image-1` 始终返回 base64 编码的图像。可能的值： `urlb64_json`	否
size	枚举	生成的图像的大小。必须是 `1024x1024`、`1536x1024`（横向）、`1024x1536`（纵向）或 `auto` 的 `gpt-image-1`（默认值）之一，以及 `256x256`、`512x512` 或 `1024x1024` 的 `dall-e-2` 之一。可能的值：`256x256`、、`512x512`、`1024x10241536x1024`、`1024x1536`、`auto`	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

AzureCreateImageRequest

名称	类型	DESCRIPTION	必选	违约
背景	枚举	允许为生成的图像的背景设置透明度。此参数仅支持 `gpt-image-1`。必须是以下其中一个 `transparent`或 `opaqueauto` （默认值）。使用 `auto` 时，模型将自动确定图像的最佳背景。如果 `transparent`，那么输出格式需要支持透明度，因此它应设置为 `png` （默认值）或 `webp`。可能的值：`transparent`、、 `opaqueauto`	否
模型	字符串	用于生成映像的模型部署。	是的
审查	枚举	控制由 `gpt-image-1` 生成的图像的内容审核级别。必须是用于限制较少的筛选的 `low` 或 `auto`（默认值）。可能的值： `lowauto`	否
n	整数	要生成的图像数。必须介于 1 到 10 之间。对于 `dall-e-3`，仅 `n=1` 受支持。	否	1
output_compression	整数	生成的图像的压缩级别（0-100%）。此参数仅支持`gpt-image-1`与`webp`或`jpeg`输出格式，默认值为 100。	否	100
输出格式	枚举	返回生成图像的格式。此参数仅支持 `gpt-image-1`。必须为 `png`、`jpeg` 或 `webp` 的其中一个。可能的值：`png`、、 `jpegwebp`	否
prompt	字符串	所需图像的文本说明。最大长度为 `gpt-image-1` 的 32000 个字符，`dall-e-2` 的 1000 个字符，`dall-e-3` 的 4000 个字符。	是的
质量	枚举	将生成的图像的质量。 - `auto` （默认值）将自动为给定模型选择最佳质量。 - `high`， `medium` 并且 `low` 受 `gpt-image-1`支持。 - `hd` 和 `standard` 为 `dall-e-3` 提供支持。 - `standard` 是 `dall-e-2` 的唯一选项。可能的值：`standard`、、`hd`、`lowmedium`、`high`、`auto`	否
响应格式	枚举	返回包含 `dall-e-2` 和 `dall-e-3` 的生成图像的格式。必须是 `url` 或 `b64_json` 之一。 URL 仅在生成映像后 60 分钟有效。不支持 `gpt-image-1` 此参数，该参数将始终返回 base64 编码的图像。可能的值： `urlb64_json`	否
size	枚举	生成的图像的大小。必须是 `1024x1024`、`1536x1024`（横向）、`1024x1536`（纵向）或 `auto` 的 `gpt-image-1`（默认值）之一，`256x256`、`512x512` 或 `1024x1024` 的 `dall-e-2` 之一，以及 `1024x1024`、`1792x1024` 或 `1024x1792` 的 `dall-e-3` 之一。可能的值：`auto`、、、`1024x10241536x1024`、`1024x1536256x256`、`512x512`、、 `1792x10241024x1792`	否
style	枚举	生成的图像的样式。此参数仅支持 `dall-e-3`。必须是 `vivid` 或 `natural` 之一。生动效果使模型倾向于生成高度真实和戏剧性的图像。模型由于自然因素会生成更自然、看起来不那么过于真实的图像。可能的值： `vividnatural`	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

AzureCreateResponse

名称	类型	DESCRIPTION	必选	违约
背景	布尔	是否在后台运行模型响应。	否	假
包括	数组	指定要包含在模型响应中的其他输出数据。现在支持的值包括： - `file_search_call.results`：包括文件搜索工具的搜索结果。 - `message.input_image.image_url`：包括输入消息中的图像链接。 - `computer_call_output.output.image_url`：包括计算机调用输出中的图像 URL。 - `reasoning.encrypted_content`：包括经过加密的推理版本推理项目输出中的令牌。这样就可以在无状态使用响应 API 时，在多轮次对话中使用推理项（例如当参数 `store` 设置为 `false`，或当组织在零数据保留计划中注册时）。	否
输入	字符串或数组		是的
指示	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
最大输出标记数量 (max_output_tokens)	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
模型	字符串	用于创建此响应的模型部署。	是的
parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
推理	物体	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ effort	OpenAI.ReasoningEffort	仅适用于 O 系列模型限制推理模型的推理工作量。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	否
└─ generate_summary	枚举	已弃用：改用 `summary` 。模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
store	布尔	是否存储生成的模型响应，以便以后通过某种方式检索应用程序接口。	否	真实
溪流	布尔	如果设置为 true，模型响应数据将流式传输到客户端在使用服务器发送的事件生成它时。	否	假
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否	1
文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	物体	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。	否
└─ 类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。	否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能，如文件搜索。 - 函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否	1
truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否

AzureCreateSpeechRequestMultiPart

用于控制文本转语音操作行为的请求选项的示意。

名称	类型	DESCRIPTION	必选	违约
输入	字符串	要为其生成音频的文本。最大长度为 4096 个字符。	是的
指示	字符串	通过额外指令控制生成音频的音质。不适用于 `tts-1` 或 `tts-1-hd`.	否
模型	字符串	要用于此文本转语音请求的模型。	是的
响应格式	物体	文本转语音支持的音频输出格式。	否
速度	数字	生成音频的语速。值在 0.25 到 4.0 的范围内有效，默认值为 1.0，对应于更快的语音。	否	1
语音	物体		是的

AzureCreateTranscriptionRequestMultiPart

音频听录请求的配置信息。

名称	类型	DESCRIPTION	必选	违约
chunking_strategy	物体		否
└─ prefix_padding_ms	整数	VAD 检测到语音之前要包括的音频量（按毫秒计）。	否	300
└─ silence_duration_ms	整数	用于检测语音停止的沉默持续时间（以毫秒为单位）。使用较短的值，模型将更快地响应，但可能会在用户短暂暂停时突然打断。	否	200
~~ 阈值	数字	用于语音活动检测的敏感度阈值（0.0 到 1.0）。 A 更高的阈值将需要更响亮的音频来激活模型，并且因此，在嘈杂环境中性能可能更好。	否	0.5
└─ 类型	枚举	必须设置为 `server_vad` ，以便使用服务器端 VAD 启用手动分块。可能的值： `server_vad`	否
文件	字符串		是的
文件名	字符串	要与音频数据关联的可选文件名或描述性标识符。	否
include[]	数组	应在记录响应中包含的其他信息。 `logprobs` 将在响应中返回标记的日志概率以了解模型对转录的信心。 `logprobs` 仅在 response_format 设置为 `json` 时才适用，并且仅在这种情况下才适用。模型 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe`。	否
语言	字符串	输入音频的语言。以 ISO-639-1（例如 `en`）格式提供输入语言将提高准确性并减少延迟。	否
模型	字符串	用于此听录请求的模型。	否
prompt	字符串	用于指导模型风格或继续之前的音频片段的可选文本。提示应与音频语言匹配。	否
响应格式	物体		否
溪流	布尔	如果设置为 true，模型响应数据将流式传输到客户端在使用服务器发送的事件生成它时。注意：`whisper-1` 模型不支持流式处理，此特性将被忽略。	否	假
温度	数字	采样温度，介于 0 和 1 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性如果设置为 0，则模型将使用对数概率自动增加温度，直到达到某些阈值。	否	0
timestamp_granularities[]	数组	要为此听录填充的时间戳粒度。 `response_format` 必须设为 `verbose_json` 以使用时间戳粒度。支持以下任一选项或两个选项：`word` 或 `segment`。注意：段时间戳没有额外的延迟，但生成单词时间戳会产生额外的延迟。	否	['segment']

Azure错误响应 (AzureErrorResponse)

名称	类型	DESCRIPTION	必选
错误	物体	错误详细信息。	否
└─ code	字符串	计算机生成的独特错误标识符。	否
└─ inner_error			否
└─ 消息	字符串	与错误关联的人工可读消息。	否
└─ 参数	字符串	如果适用，则与错误有关的请求输入参数	否
└─ 类型	枚举	对象类型，始终为“error”。可能的值： `error`	否

AzureImage

名称	类型	DESCRIPTION	必选	违约
content_filter_results	AzureContentFilterImageResponseResults	用于图像生成操作的输出响应内容的内容筛选结果。	是的
prompt_filter_results	AzureContentFilterImagePromptResults	用于图像生成操作的输入请求内容的内容筛选结果。	是的

AzureImagesResponse

名称	类型	DESCRIPTION	必选
已创建	整数	创建映像时的 Unix 时间戳（以秒为单位）。	是的
数据	数组		否
使用量	物体	仅针对 `gpt-image-1` 的图像生成过程中的令牌使用信息。	否
└─ input_tokens	整数	输入提示中的标记数（图像和文本）。	否
└─ input_tokens_details	物体	图像生成的输入令牌详细信息。	否
└─ image_tokens	整数	输入提示中的图像令牌数。	否
└─ text_tokens	整数	输入提示中的文本令牌数。	否
└─ output_tokens	整数	输出图像中的图像标记数。	否
└─ total_tokens	整数	用于生成图像的令牌（图像和文本）总数。	否

AzureOpenAIVideoGenerationErrorResponse

名称	类型	DESCRIPTION	必选
代码	字符串	计算机生成的独特错误标识符。	否
inner_error	物体	导致此错误的上游错误（如果适用）。	否
└─ code	枚举	与内部错误关联的代码。可能的值： `ResponsibleAIPolicyViolation`	否
└─ error_details	物体		否
└─ revised_prompt	字符串	用于生成的修改后的提示（如果适用）。	否
消息	字符串	与错误关联的人工可读消息。	否
param	字符串	如果适用，则与错误有关的请求输入参数	否
类型	字符串	与错误关联的输入行号（如果适用）。	否

AzureResponse

名称	类型	DESCRIPTION	必选	违约
背景	布尔	是否在后台运行模型响应。	否	假
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
错误	物体	当模型无法生成响应时返回的错误对象。	是的
└─ code	OpenAI.ResponseErrorCode	响应的错误代码。	否
└─ 消息	字符串	可读的错误说明。	否
ID	字符串	此响应的唯一标识符。	是的
incomplete_details	物体	有关响应不完整的原因的详细信息。	是的
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
指示	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
最大输出标记数量 (max_output_tokens)	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
模型	字符串	用于生成此响应的模型。	是的
物体	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	是的
输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
推理	物体	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ effort	OpenAI.ReasoningEffort	仅适用于 O 系列模型限制推理模型的推理工作量。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	否
└─ generate_summary	枚举	已弃用：改用 `summary` 。模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
地位	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	是的
文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	物体	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。	否
└─ 类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。	否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能。函数调用（自定义工具）：由你定义的函数，使模型能够调用你自己的代码	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	是的
truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
使用量	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	是的

AzureSearchChatDataSource

表示将使用 Azure 搜索资源的数据源配置。

名称	类型	DESCRIPTION	必选	违约
参数	物体	用于控制 Azure 搜索数据源使用的参数信息。	是的
└─ allow_partial_result	布尔	如果设置为 true，系统将允许使用部分搜索结果，并且请求将失败（如果全部）部分查询失败。如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。	否	假
~~ 身份验证	物体		否
└─ access_token	字符串		否
└─ key	字符串		否
└─ managed_identity_resource_id	字符串		否
└─ 类型	枚举	可能的值： `access_token`	否
└─ embedding_dependency	物体	表示对 Azure OpenAI 嵌入模型部署进行公共服务调用的向量化源。	否
~~ 身份验证	AzureChatDataSourceApiKeyAuthenticationOptions 或 AzureChatDataSourceAccessTokenAuthenticationOptions	与基于终结点的向量化源一起使用的身份验证机制。终结点身份验证支持 API 密钥和访问令牌机制。	否
└─ deployment_name	字符串	用于矢量化的嵌入模型的部署。此部署必须存在于同一 Azure OpenAI 中用于完成聊天的模型部署所需资源。	否
└─ dimensions	整数	请求嵌入时所需的维度数量。仅在 text-embedding-3 和更高版本的模型中受支持。	否
~~ 终结点	字符串	指定应从中检索嵌入的资源终结点 URL。它的格式应为： https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. 不允许 API 版本查询参数。	否
└─ 类型	枚举	类型标识符，对于此矢量化源类型始终为“integrated”。可能的值： `integrated`	否
~~ 终结点	字符串	要使用的 Azure 认知搜索资源的绝对终结点路径。	否
└─ fields_mapping	物体	用于 Azure 搜索资源的字段映射。	否
└─ content_fields	数组	应被视为内容的索引字段的名称。	否
└─ content_fields_separator	字符串	内容字段应使用的分隔符模式。	否
└─ filepath_field	字符串	要用作文件路径的索引字段的名称。	否
└─ image_vector_fields	数组	表示图像矢量数据的字段的名称。	否
└─ title_field	字符串	要用作标题的索引字段的名称。	否
└─ url_field	字符串	要用作 URL 的索引字段的名称。	否
└─ 向量场	数组	表示矢量数据的字段的名称。	否
~~ 筛选器	字符串	要应用于搜索的筛选器。	否
└─ in_scope	布尔	是否应将查询限制为使用索引数据。	否
└─ include_contexts	数组	响应中要包含的输出上下文属性。默认情况下，会请求引用和意向。	否	['引文', '意图']
└─ index_name	字符串	要使用的索引的名称，如 Azure 搜索资源中指定的。	否
└─ max_search_queries	整数	应发送到搜索提供程序的单个用户消息的最大重写查询数。默认情况下，系统将进行自动确定。	否
└─ query_type	枚举	要使用的 Azure 搜索资源的查询类型。可能的值：`simple`、、`semanticvector`、`vector_simple_hybrid`、`vector_semantic_hybrid`	否
└─ semantic_configuration	字符串	额外的查询语义配置。	否
~~ 严格性	整数	搜索相关性筛选的已配置严格性。更高的严格性会增加精度，但降低答案的召回率。	否
└─ top_n_documents	整数	用于查询中展示的已配置文档数量。	否
类型	枚举	区分类型标识符，始终为“azure_search”。可能的值： `azure_search`	是的

Azure 用户安全上下文

用户安全上下文包含描述应用程序本身的多个参数，以及与应用程序交互的最终用户。这些字段通过提供全面的方法来保护 AI 应用程序，从而帮助安全运营团队调查和缓解安全事件。详细了解如何使用 Microsoft Defender for Cloud 保护 AI 应用程序。

名称	类型	DESCRIPTION	必选
应用程序名称	字符串	应用程序的名称。不应在此字段中包含个人敏感信息。	否
最终用户ID	字符串	此标识符是用于在生成式 AI 应用程序中对最终用户进行身份验证的 Microsoft Entra ID（以前称为 Azure Active Directory）用户对象 ID。不应在此字段中包含个人敏感信息。	否
end_user_tenant_id	字符串	最终用户所属的 Microsoft 365 租户 ID。当生成式 AI 应用程序是多租户时，这是必需的。	否
源IP地址	字符串	捕获原始客户端的 IP 地址。	否

AzureVideoGenerationError

类型：对象

ChatCompletionMessageToolCallsItem

模型生成的工具调用，例如函数调用。

数组：OpenAI.ChatCompletionMessageToolCall

CompletionChoice

名称	类型	DESCRIPTION	必选
content_filter_results	AzureContentFilterResultForChoice	由生成性 AI 系统生成的单个响应项的内容筛选结果。	否
finish_reason	枚举	模型停止生成令牌的原因。如果模型命中自然停止点或提供的停止序列，则 `stop` 会出现这种情况。 `length` 如果达到请求中指定的最大令牌数，或 `content_filter` 如果内容因内容筛选器的标志而省略内容。可能的值：`stop`、、 `lengthcontent_filter`	是的
索引	整数		是的
logprobs	物体		是的
└─ text_offset	数组		否
└─ token_logprobs	数组		否
└─ 令牌	数组		否
└─ top_logprobs	数组		否
文本	字符串		是的

CreateVideoGenerationRequest

名称	类型	DESCRIPTION	必选	违约
身高	整数	视频的高度。支持以下尺寸：480x480、480x854、854x480、720x720、720x1280、1280x720、1080x1080、1080x1920、1920x1080。	是的
模型	字符串	要用于此请求的部署的名称。	是的
n_秒	整数	视频生成作业的持续时间。必须介于 1 到 20 秒之间。	否	5
n_variants	整数	要作为此作业的变体创建的视频数量。必须介于 1 和 5 之间。较小的尺寸允许更多变体。	否	1
prompt	字符串	此视频生成作业的提示。	是的
width	整数	视频的宽度。支持以下尺寸：480x480、480x854、854x480、720x720、720x1280、1280x720、1080x1080、1080x1920、1920x1080。	是的

ElasticsearchChatDataSource

名称	类型	DESCRIPTION	必选	违约
参数	物体	用于控制 Elasticsearch 数据源使用的参数信息。	是的
└─ allow_partial_result	布尔	如果设置为 true，系统将允许使用部分搜索结果，并且请求将失败（如果全部）部分查询失败。如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。	否	假
~~ 身份验证	物体		否
└─ encoded_api_key	字符串		否
└─ key	字符串		否
└─ key_id	字符串		否
└─ 类型	枚举	可能的值： `encoded_api_key`	否
└─ embedding_dependency	AzureChatDataSourceVectorizationSource	用作包含数据源的嵌入资源的数据向量化源的表示形式。	否
~~ 终结点	字符串		否
└─ fields_mapping	物体		否
└─ content_fields	数组		否
└─ content_fields_separator	字符串		否
└─ filepath_field	字符串		否
└─ title_field	字符串		否
└─ url_field	字符串		否
└─ 向量场	数组		否
└─ in_scope	布尔	是否应将查询限制为使用索引数据。	否
└─ include_contexts	数组	响应中要包含的输出上下文属性。默认情况下，会请求引用和意向。	否	['引文', '意图']
└─ index_name	字符串		否
└─ max_search_queries	整数	应发送到搜索提供程序的单个用户消息的最大重写查询数。默认情况下，系统将进行自动确定。	否
└─ query_type	枚举	可能的值： `simplevector`	否
~~ 严格性	整数	搜索相关性筛选的已配置严格性。更高的严格性会增加精度，但降低答案的召回率。	否
└─ top_n_documents	整数	用于查询中展示的已配置文档数量。	否
类型	枚举	区分类型标识符，始终为“elasticsearch”。可能的值： `elasticsearch`	是的

工作状态

资产	价值
类型	字符串
价值观	`preprocessing` `queued` `running` `processing` `cancelled` `succeeded` `failed`

MongoDBChatDataSource

名称	类型	DESCRIPTION	必选	违约
参数	物体	用于控制 MongoDB 数据源使用的参数信息。	是的
└─ allow_partial_result	布尔	如果设置为 true，系统将允许使用部分搜索结果，并且请求将失败（如果全部）部分查询失败。如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。	否	假
└─ 应用程序名称	字符串	MongoDB 应用程序的名称。	否
~~ 身份验证	物体		否
~~ 密码	字符串		否
└─ 类型	枚举	可能的值： `username_and_password`	否
~~ 用户名	字符串		否
└─ collection_name	字符串	MongoDB 集合的名称。	否
└─ 数据库名称	字符串	MongoDB 数据库的名称。	否
└─ embedding_dependency	物体	表示对 Azure OpenAI 嵌入模型部署进行公共服务调用的向量化源。	否
~~ 身份验证	AzureChatDataSourceApiKeyAuthenticationOptions 或 AzureChatDataSourceAccessTokenAuthenticationOptions	与基于终结点的向量化源一起使用的身份验证机制。终结点身份验证支持 API 密钥和访问令牌机制。	否
└─ deployment_name	字符串	用于矢量化的嵌入模型的部署。此部署必须存在于同一 Azure OpenAI 中用于完成聊天的模型部署所需资源。	否
└─ dimensions	整数	请求嵌入时所需的维度数量。仅在 text-embedding-3 和更高版本的模型中受支持。	否
~~ 终结点	字符串	指定应从中检索嵌入的资源终结点 URL。它的格式应为： https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. 不允许 API 版本查询参数。	否
└─ 类型	枚举	此矢量化源类型的类型标识符始终为“deployment_name”。可能的值： `deployment_name`	否
~~ 终结点	字符串	MongoDB 群集终结点的名称。	否
└─ fields_mapping	物体	应用于 MongoDB 数据源所用数据的字段映射。请注意，MongoDB 需要内容和矢量字段映射。	否
└─ content_fields	数组		否
└─ content_fields_separator	字符串		否
└─ filepath_field	字符串		否
└─ title_field	字符串		否
└─ url_field	字符串		否
└─ 向量场	数组		否
└─ in_scope	布尔	是否应将查询限制为使用索引数据。	否
└─ include_contexts	数组	响应中要包含的输出上下文属性。默认情况下，会请求引用和意向。	否	['引文', '意图']
└─ index_name	字符串	MongoDB 索引的名称。	否
└─ max_search_queries	整数	应发送到搜索提供程序的单个用户消息的最大重写查询数。默认情况下，系统将进行自动确定。	否
~~ 严格性	整数	搜索相关性筛选的已配置严格性。更高的严格性会增加精度，但降低答案的召回率。	否
└─ top_n_documents	整数	用于查询中展示的已配置文档数量。	否
类型	枚举	区分类型标识符，始终为“mongo_db”。可能的值： `mongo_db`	是的

OpenAI.Annotation

OpenAI.Annotation 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`file_citation`	OpenAI.AnnotationFileCitation
`url_citation`	OpenAI.AnnotationUrlCitation
`file_path`	OpenAI.AnnotationFilePath

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.AnnotationType		是的

OpenAI.AnnotationFileCitation

文件的引文。

名称	类型	DESCRIPTION	必选
file_id	字符串	文件的 ID。	是的
索引	整数	文件列表中的文件的索引。	是的
类型	枚举	文件引文的类型。始终为 `file_citation`。可能的值： `file_citation`	是的

OpenAI.AnnotationFilePath

文件路径。

名称	类型	DESCRIPTION	必选
file_id	字符串	文件的 ID。	是的
索引	整数	文件列表中的文件的索引。	是的
类型	枚举	文件路径的类型。始终为 `file_path`。可能的值： `file_path`	是的

OpenAI.AnnotationType

资产	价值
类型	字符串
价值观	`file_citation` `url_citation` `file_path`

OpenAI.AnnotationUrlCitation

用于生成模型响应的 Web 资源的引文。

名称	类型	DESCRIPTION	必选
end_index	整数	消息中 URL 引文的最后一个字符的索引。	是的
start_index	整数	消息中 URL 引文的第一个字符的索引。	是的
title	字符串	Web 资源的标题。	是的
类型	枚举	URL 引文的类型。始终为 `url_citation`。可能的值： `url_citation`	是的
网址	字符串	Web 资源的 URL。	是的

OpenAI.ApproximateLocation

名称	类型	DESCRIPTION	必选
city	字符串		否
country	字符串		否
区域	字符串		否
时区	字符串		否
类型	枚举	可能的值： `approximate`	是的

OpenAI.AudioResponseFormat

输出的格式，采用以下选项之一：json、、text、srt或verbose_jsonvtt。对于 gpt-4o-transcribe 和 gpt-4o-mini-transcribe，唯一支持的格式是 json。

资产	价值
说明	输出的格式，采用以下选项之一：`json`、、`text`、`srt`或`verbose_jsonvtt`。对于 `gpt-4o-transcribe` 和 `gpt-4o-mini-transcribe`，唯一支持的格式是 `json`。
类型	字符串
价值观	`json` `text` `srt` `verbose_json` `vtt`

OpenAI.ChatCompletionFunctionCallOption

通过 {"name": "my_function"} 指定特定函数会强制模型调用该函数。

名称	类型	DESCRIPTION	必选	违约
姓名	字符串	要调用的函数的名称。	是的

OpenAI.ChatCompletionFunctions

名称	类型	DESCRIPTION	必选
描述	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
姓名	字符串	要调用的函数的名称。必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	是的
参数		函数接受的参数，被描述为 JSON 架构对象。请参阅 JSON 架构参考有关格式的文档。省略 `parameters` 会定义具有空参数列表的函数。	否

OpenAI.ChatCompletionMessageAudioChunk

名称	类型	必选
数据	字符串	否
expires_at	整数	否
ID	字符串	否
脚本	字符串	否

OpenAI.ChatCompletionMessageToolCall

名称	类型	DESCRIPTION	必选
功能	物体	模型调用的函数。	是的
└─ arguments	字符串	使用 JSON 格式的模型生成的用于调用函数的参数。请注意，模型并不总是生成有效的 JSON，并且可能会使函数架构未定义的参数幻觉。在调用函数之前验证代码中的参数。	否
└─ 名称	字符串	要调用的函数的名称。	否
ID	字符串	工具调用的 ID。	是的
类型	枚举	工具的类型。目前仅支持 `function`。可能的值： `function`	是的

OpenAI.ChatCompletionMessageToolCallChunk

名称	类型	DESCRIPTION	必选
功能	物体		否
└─ arguments	字符串	使用 JSON 格式的模型生成的用于调用函数的参数。请注意，模型并不总是生成有效的 JSON，并且可能会使函数架构未定义的参数幻觉。在调用函数之前验证代码中的参数。	否
└─ 名称	字符串	要调用的函数的名称。	否
ID	字符串	工具调用的 ID。	否
索引	整数		是的
类型	枚举	工具的类型。目前仅支持 `function`。可能的值： `function`	否

OpenAI.ChatCompletionNamedToolChoice

指定模型应使用的工具。用于强制模型调用特定函数。

名称	类型	DESCRIPTION	必选
功能	物体		是的
└─ 名称	字符串	要调用的函数的名称。	否
类型	枚举	工具的类型。目前仅支持 `function`。可能的值： `function`	是的

OpenAI.ChatCompletionRequestAssistantMessage

模型发送的消息以响应用户消息。

名称	类型	DESCRIPTION	必选
音频	物体	有关模型之前音频响应的数据。	否
└─ id	字符串	来自模型的之前音频响应的唯一标识符。	否
内容	字符串或数组		否
function_call	物体	已弃用并替换为 `tool_calls`。应调用的函数的名称和参数，由模型生成。	否
└─ arguments	字符串		否
└─ 名称	字符串		否
姓名	字符串	参与者的可选名称。提供模型信息，以区分同一角色的参与者。	否
拒绝	字符串	助手发出的拒绝消息。	否
角色	枚举	消息作者的角色，在本例中为 `assistant`。可能的值： `assistant`	是的
tool_calls	ChatCompletionMessageToolCallsItem	模型生成的工具调用，例如函数调用。	否

OpenAI.ChatCompletionRequestAssistantMessageContentPart

名称	类型	DESCRIPTION	必选
拒绝	字符串	模型生成的拒绝消息。	是的
文本	字符串	文本内容。	是的
类型	枚举	内容部件的类型。可能的值： `refusal`	是的

OpenAI.ChatCompletionRequestDeveloperMessage

开发人员提供的指令，无论用户发送什么消息，模型都应遵循。使用 o1 模型和更新版本后，developer 消息替换以前的 system 消息。

名称	类型	DESCRIPTION	必选
内容	字符串或数组		是的
姓名	字符串	参与者的可选名称。提供模型信息，以区分同一角色的参与者。	否
角色	枚举	消息作者的角色，在本例中为 `developer`。可能的值： `developer`	是的

OpenAI.ChatCompletionRequestFunctionMessage

名称	类型	DESCRIPTION	必选
内容	字符串	函数消息的内容。	是的
姓名	字符串	要调用的函数的名称。	是的
角色	枚举	消息作者的角色，在本例中为 `function`。可能的值： `function`	是的

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage 的鉴别器

此组件使用属性 role 区分不同类型的：

类型值	图式
`system`	OpenAI.ChatCompletionRequestSystemMessage
`developer`	OpenAI.ChatCompletionRequestDeveloperMessage
`user`	OpenAI.ChatCompletionRequestUserMessage
`assistant`	OpenAI.ChatCompletionRequestAssistantMessage
`tool`	OpenAI.ChatCompletionRequestToolMessage
`function`	OpenAI.ChatCompletionRequestFunctionMessage

名称	类型	DESCRIPTION	必选	违约
内容	字符串或数组		否
角色	物体	邮件作者的角色	是的

OpenAI.ChatCompletionRequestMessageContentPart

OpenAI.ChatCompletionRequestMessageContentPart 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`text`	OpenAI.ChatCompletionRequestMessageContentPartText
`image_url`	OpenAI.ChatCompletionRequestMessageContentPartImage
`refusal`	OpenAI.ChatCompletionRequestMessageContentPartRefusal
`file`	OpenAI.ChatCompletionRequestMessageContentPartFile
`input_audio`	OpenAI.ChatCompletionRequestMessageContentPartAudio

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ChatCompletionRequestMessageContentPartType		是的

OpenAI.ChatCompletionRequestMessageContentPartAudio

名称	类型	DESCRIPTION	必选
input_audio	物体		是的
└─ 数据	字符串	Base64 编码的音频数据。	否
└─ 格式	枚举	编码的音频数据的格式。目前支持“wav”和“mp3”。可能的值： `wavmp3`	否
类型	枚举	内容部件的类型。始终为 `input_audio`。可能的值： `input_audio`	是的

OpenAI.ChatCompletionRequestMessageContentPartFile

名称	类型	DESCRIPTION	必选
文件	物体		是的
└─ file_data	字符串	传递文件到模型时所用的 base64 编码的文件数据作为字符串。	否
└─ file_id	字符串	要用作输入的上传文件的 ID。	否
~~ 文件名	字符串	文件名，用于将文件作为以下项传给模型时 string。	否
类型	枚举	内容部件的类型。始终为 `file`。可能的值： `file`	是的

OpenAI.ChatCompletionRequestMessageContentPartImage

名称	类型	DESCRIPTION	必选
image_url	物体		是的
└─ 详细信息	枚举	指定图像的详细信息级别。 . 可能的值：`auto`、、 `lowhigh`	否
└─ 网址	字符串	图像的 URL 或 base64 编码的图像数据。	否
类型	枚举	内容部件的类型。可能的值： `image_url`	是的

OpenAI.ChatCompletionRequestMessageContentPartRefusal

名称	类型	DESCRIPTION	必选	违约
拒绝	字符串	模型生成的拒绝消息。	是的
类型	枚举	内容部件的类型。可能的值： `refusal`	是的

OpenAI.ChatCompletionRequestMessageContentPartText

名称	类型	DESCRIPTION	必选	违约
文本	字符串	文本内容。	是的
类型	枚举	内容部件的类型。可能的值： `text`	是的

OpenAI.ChatCompletionRequestMessageContentPartType

资产	价值
类型	字符串
价值观	`text` `file` `input_audio` `image_url` `refusal`

OpenAI.ChatCompletionRequestSystemMessage

开发人员提供的指令，无论用户发送什么消息，模型都应遵循。对于 o1 及更新的模型，请改为使用 developer 消息来实现此目的。

名称	类型	DESCRIPTION	必选
内容	字符串或数组		是的
姓名	字符串	参与者的可选名称。提供模型信息，以区分同一角色的参与者。	否
角色	枚举	消息作者的角色，在本例中为 `system`。可能的值： `system`	是的

OpenAI.ChatCompletionRequestSystemMessageContentPart

参考：OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

名称	类型	DESCRIPTION	必选
内容	字符串或数组		是的
角色	枚举	消息作者的角色，在本例中为 `tool`。可能的值： `tool`	是的
tool_call_id	字符串	此消息正在响应的工具调用。	是的

OpenAI.ChatCompletionRequestToolMessageContentPart

参考：OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

最终用户发送的消息，包含提示或其他上下文信息。

名称	类型	DESCRIPTION	必选
内容	字符串或数组		是的
姓名	字符串	参与者的可选名称。提供模型信息，以区分同一角色的参与者。	否
角色	枚举	消息作者的角色，在本例中为 `user`。可能的值： `user`	是的

OpenAI.ChatCompletionRequestUserMessageContentPart

名称	类型	DESCRIPTION	必选
文件	物体		是的
└─ 文件数据	字符串	传递文件到模型时所用的 base64 编码的文件数据作为字符串。	否
└─ file_id	字符串	要用作输入的上传文件的 ID。	否
~~ 文件名	字符串	文件名，用于将文件作为以下项传给模型时 string。	否
image_url	物体		是的
└─ 详细信息	枚举	指定图像的详细信息级别。 . 可能的值：`auto`、、 `lowhigh`	否
└─ 网址	字符串	图像的 URL 或 base64 编码的图像数据。	否
input_audio	物体		是的
└─ 数据	字符串	Base64 编码的音频数据。	否
└─ 格式	枚举	编码的音频数据的格式。目前支持“wav”和“mp3”。可能的值： `wavmp3`	否
文本	字符串	文本内容。	是的
类型	枚举	内容部件的类型。始终为 `file`。可能的值： `file`	是的

OpenAI.ChatCompletionRole

邮件作者的角色

资产	价值
说明	邮件作者的角色
类型	字符串
价值观	`system` `developer` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionStreamOptions

用于流式处理响应的选项。仅在设置 stream: true 时设置此项。

名称	类型	DESCRIPTION	必选	违约
include_usage	布尔	如果已设置，则会在 `data: [DONE]` 之前传输额外的区块。消息作为响应。 `usage`此区块上的字段显示令牌使用情况统计信息对于整个请求，字段 `choices` 将始终为空 array. 所有其他区块也将包含一个 `usage` 字段，但值为 null 价值。注意：如果流中断，您可能无法收到包含请求的令牌总使用量的最终使用区块。	否

OpenAI.ChatCompletionStreamResponseDelta

流式处理的模型响应生成的聊天补全增量。

名称	类型	DESCRIPTION	必选
音频	物体		否
└─ 数据	字符串		否
└─ expires_at	整数		否
└─ id	字符串		否
└─ 转录	字符串		否
内容	字符串	区块消息的内容。	否
function_call	物体	已弃用并替换为 `tool_calls`。应调用的函数的名称和参数，由模型生成。	否
└─ arguments	字符串		否
└─ 名称	字符串		否
拒绝	字符串	模型生成的拒绝消息。	否
角色	物体	邮件作者的角色	否
tool_calls	数组		否

OpenAI.ChatCompletionTokenLogprob

名称	类型	DESCRIPTION	必选
字节	数组	表示令牌的 UTF-8 字节表示形式的整数列表。在字符由多个令牌表示，并且其字节表示形式必须组合在一起才能生成正确的文本表示形式的情况下非常有用。如果令牌没有字节表示形式，则为 `null`。	是的
logprob	数字	此令牌的对数概率（如果它位于前 20 个最有可能的标记中）。否则，`-9999.0` 的值用于表示令牌不太可能。	是的
令牌	字符串	令牌。	是的
top_logprobs	数组	在此标记位置上，最有可能的标记及其对数概率的列表。在极少数情况下，返回的数量可能少于请求的 `top_logprobs` 数。	是的

OpenAI.ChatCompletionTool

名称	类型	DESCRIPTION	必选	违约
功能	OpenAI.FunctionObject		是的
类型	枚举	工具的类型。目前仅支持 `function`。可能的值： `function`	是的

OpenAI.ChatCompletionToolChoiceOption

控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息和调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。通过 {"type": "function", "function": {"name": "my_function"}} 指定特定工具将强制模型调用该工具。

如果没有工具，则 none 为默认值。如果存在工具，则 auto 为默认值。

名称	类型	DESCRIPTION	必选
功能	物体		是的
└─ 名称	字符串	要调用的函数的名称。	否
类型	枚举	工具的类型。目前仅支持 `function`。可能的值： `function`	是的

OpenAI.ChatOutputPrediction

模型预测输出的基表示形式。

OpenAI.ChatOutputPrediction 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`content`	OpenAI.ChatOutputPredictionContent

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ChatOutputPredictionType		是的

OpenAI.ChatOutputPredictionContent

静态预测输出内容，例如正在重新生成的文本文件的内容。

名称	类型	DESCRIPTION	必选	违约
内容	字符串或数组		是的
类型	枚举	要提供的预测内容的类型。此类型当前始终为 `content`。可能的值： `content`	是的

OpenAI.ChatOutputPredictionType

资产	价值
类型	字符串
价值观	`content`

OpenAI代码解释器文件输出

文件形式的代码解释器工具调用的输出。

名称	类型	DESCRIPTION	必选	违约
文件	数组		是的
类型	枚举	代码解释器文件输出的类型。始终为 `files`。可能的值： `files`	是的

OpenAI代码解释器文本输出

代码解释器工具调用的输出，即文本。

名称	类型	DESCRIPTION	必选	违约
日志	字符串	代码解释器工具调用的日志。	是的
类型	枚举	代码解释器文本输出的类型。始终为 `logs`。可能的值： `logs`	是的

OpenAI.CodeInterpreterTool

运行 Python 代码以帮助生成对提示的响应的工具。

名称	类型	DESCRIPTION	必选
容器	物体	代码解释器容器的配置。（可选）指定 ID 要运行代码的文件的该项。	是的
└─ file_ids	数组	可提供给代码使用的已上传文件的一个可选列表。	否
└─ 类型	枚举	始终为 `auto`。可能的值： `auto`	否
类型	枚举	代码解释器工具的类型。始终为 `code_interpreter`。可能的值： `code_interpreter`	是的

OpenAI.CodeInterpreterToolAuto

代码解释器容器的配置。（可选）指定要运行代码的文件 ID。

名称	类型	DESCRIPTION	必选	违约
file_ids	数组	可提供给代码使用的已上传文件的一个可选列表。	否
类型	枚举	始终为 `auto`。可能的值： `auto`	是的

OpenAI.CodeInterpreterToolCallItemParam

用于运行代码的工具调用。

名称	类型	DESCRIPTION	必选
代码	字符串	要运行的代码。	是的
container_id	字符串	用于运行代码的容器的 ID。	否
结果	数组	代码解释器工具调用的结果。	是的
类型	枚举	可能的值： `code_interpreter_call`	是的

OpenAI.CodeInterpreterToolCallItemResource

用于运行代码的工具调用。

名称	类型	DESCRIPTION	必选
代码	字符串	要运行的代码。	是的
container_id	字符串	用于运行代码的容器的 ID。	否
结果	数组	代码解释器工具调用的结果。	是的
地位	枚举	可能的值：`in_progress`、、 `interpretingcompleted`	是的
类型	枚举	可能的值： `code_interpreter_call`	是的

OpenAI.CodeInterpreterToolOutput

代码解释器工具的输出。

名称	类型	DESCRIPTION	必选
文件	数组		是的
日志	字符串	代码解释器工具调用的日志。	是的
类型	枚举	代码解释器文件输出的类型。始终为 `files`。可能的值： `files`	是的

OpenAI.ComparisonFilter

用于使用定义的比较操作来比较指定属性键与给定值的筛选器。

名称	类型	DESCRIPTION	必选
钥匙	字符串	要与值进行比较的键。	是的
类型	枚举	指定比较运算符：`eq`、、`negt`、`gte`、`ltlte`。 - `eq`：等于 - `ne`：不等于 - `gt`：大于 - `gte`：大于或等于 - `lt`：小于 - `lte`：小于或等于可能的值：`eq`、、`ne`、`gtgte`、`lt`、`lte`	是的
价值	字符串或数字或布尔值		是的

OpenAI.CompletionUsage

完成请求的使用情况统计信息。

名称	类型	DESCRIPTION	必选	违约
completion_tokens	整数	生成的补全中的词元数。	是的	0
completion_tokens_details	物体	完成时使用的令牌明细。	否
└─ accepted_prediction_tokens	整数	使用预测的输出时，在完成中显示的预测中的令牌数量。	否	0
└─ audio_tokens	整数	模型生成的音频输入标记。	否	0
└─ reasoning_tokens	整数	用于推理的由模型生成的令牌。	否	0
└─ rejected_prediction_tokens	整数	使用预测的输出时，没有出现在结果中的预测的令牌数量。但是，例如推理令牌，这些令牌仍计算在用于计费、输出和上下文窗口限制的完成令牌总数中。	否	0
prompt_tokens	整数	提示中的标记数。	是的	0
prompt_tokens_details	物体	提示中使用的标识符分解。	否
└─ audio_tokens	整数	提示中存在的音频输入标记。	否	0
└─ cached_tokens	整数	提示中存在的缓存令牌。	否	0
total_tokens	整数	请求中使用的令牌总数（提示 + 补全）。	是的	0

OpenAI.CompoundFilter

使用 and 或 or. 合并多个筛选器。

名称	类型	DESCRIPTION	必选	违约
筛选器	数组	要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`。	是的
类型	枚举	操作类型：`and` 或 `or`。可能的值： `andor`	是的

OpenAI.ComputerAction

OpenAI.ComputerAction 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`click`	OpenAI.ComputerActionClick
`double_click`	OpenAI.ComputerActionDoubleClick
`drag`	OpenAI.ComputerActionDrag
`move`	OpenAI.ComputerActionMove
`screenshot`	OpenAI.ComputerActionScreenshot
`scroll`	OpenAI.ComputerActionScroll
`type`	OpenAI.ComputerActionTypeKeys
`wait`	OpenAI.ComputerActionWait
`keypress`	OpenAI.ComputerActionKeyPress

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ComputerActionType		是的

OpenAI.ComputerActionClick

单击操作。

名称	类型	DESCRIPTION	必选
button	枚举	指示单击期间按下了哪个鼠标按钮。 `left`、`right`、`wheel`、`back` 或 `forward` 中的一个。可能的值：`left`、、`rightwheel`、`back`、`forward`	是的
类型	枚举	指定事件类型。对于单击操作，此属性为始终设置为 `click`。可能的值： `click`	是的
x	整数	单击位置的 x 坐标。	是的
y	整数	发生单击的位置的 y 坐标。	是的

OpenAI.ComputerActionDoubleClick

双击操作。

名称	类型	DESCRIPTION	必选
类型	枚举	指定事件类型。对于双击操作，此属性为始终设置为 `double_click`。可能的值： `double_click`	是的
x	整数	双击发生时的 x 坐标。	是的
y	整数	发生双击的 y 坐标。	是的

OpenAI.ComputerActionDrag

拖动操作。

名称	类型	DESCRIPTION	必选	违约
路径	数组	表示拖动作路径的坐标数组。坐标将显示为数组对象，例如 `<br>[<br> { x: 100, y: 200 },<br> { x: 200, y: 300 }<br>]<br>`	是的
类型	枚举	指定事件类型。对于拖动作，此属性为始终设置为 `drag`。可能的值： `drag`	是的

OpenAI.ComputerActionKeyPress

模型要执行的按键集合。

名称	类型	DESCRIPTION	必选	违约
钥匙	数组	模型请求按下的键的组合。这是一字符串数组，每个字符串表示一个键。	是的
类型	枚举	指定事件类型。对于按键动作，此属性为始终设置为 `keypress`。可能的值： `keypress`	是的

OpenAI.ComputerActionMove

鼠标移动操作。

名称	类型	DESCRIPTION	必选
类型	枚举	指定事件类型。对于移动操作，此属性始终设置为 `move`。可能的值： `move`	是的
x	整数	要移动到的 X 坐标。	是的
y	整数	要移动到的 Y 坐标。	是的

OpenAI.ComputerActionScreenshot

屏幕截图操作。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	指定事件类型。对于屏幕截图操作，此属性为始终设置为 `screenshot`。可能的值： `screenshot`	是的

OpenAI.ComputerActionScroll

滚动操作。

名称	类型	DESCRIPTION	必选
scroll_x	整数	水平滚动距离。	是的
scroll_y	整数	垂直滚动距离。	是的
类型	枚举	指定事件类型。对于滚动作，此属性为始终设置为 `scroll`。可能的值： `scroll`	是的
x	整数	发生滚动的 X 坐标。	是的
y	整数	发生滚动的 Y 坐标。	是的

OpenAI.ComputerActionType

资产	价值
类型	字符串
价值观	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

键入文本的操作。

名称	类型	DESCRIPTION	必选	违约
文本	字符串	要键入的文本。	是的
类型	枚举	指定事件类型。对于类型操作，此属性为... 始终设置为 `type`。可能的值： `type`	是的

OpenAI.ComputerActionWait

等待操作。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	指定事件类型。对于等待动作，此属性为[...] 始终设置为 `wait`。可能的值： `wait`	是的

OpenAI.ComputerToolCallItemParam

对计算机使用工具的工具调用。

名称	类型	DESCRIPTION	必选
行動	OpenAI.ComputerAction		是的
通话编号	字符串	用输出来响应工具调用时使用的标识符。	是的
pending_safety_checks	数组	计算机调用的挂起安全检查。	是的
类型	枚举	可能的值： `computer_call`	是的

OpenAI.ComputerToolCallItemResource

对计算机使用工具的工具调用。

名称	类型	DESCRIPTION	必选
行動	OpenAI.ComputerAction		是的
通话编号	字符串	用输出来响应工具调用时使用的标识符。	是的
pending_safety_checks	数组	计算机调用的挂起安全检查。	是的
地位	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值： `computer_call`	是的

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ComputerToolCallOutputItemOutputType	与计算机使用工具一起使用的计算机屏幕截图图像。	是的

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

名称	类型	DESCRIPTION	必选
file_id	字符串		否
image_url	字符串		否
类型	枚举	可能的值： `computer_screenshot`	是的

OpenAI.ComputerToolCallOutputItemOutputType

与计算机使用工具一起使用的计算机屏幕截图图像。

资产	价值
说明	与计算机使用工具一起使用的计算机屏幕截图图像。
类型	字符串
价值观	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

计算机工具调用的输出。

名称	类型	DESCRIPTION	必选
acknowledged_safety_checks	数组	API 报告的安全检查，这些检查的确认者为开发人员。	否
通话编号	字符串	生成输出的计算机工具调用的 ID。	是的
输出	OpenAI.ComputerToolCallOutputItemOutput		是的
类型	枚举	可能的值： `computer_call_output`	是的

OpenAI.ComputerToolCallOutputItemResource

计算机工具调用的输出。

名称	类型	DESCRIPTION	必选
acknowledged_safety_checks	数组	API 报告的安全检查，这些检查的确认者为开发人员。	否
通话编号	字符串	生成输出的计算机工具调用的 ID。	是的
输出	OpenAI.ComputerToolCallOutputItemOutput		是的
地位	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值： `computer_call_output`	是的

OpenAI.ComputerToolCallSafetyCheck

计算机调用的挂起安全检查。

名称	类型	DESCRIPTION	必选
代码	字符串	挂起的安全检查的类型。	是的
ID	字符串	挂起的安全检查的 ID。	是的
消息	字符串	有关挂起的安全检查的详细信息。	是的

OpenAI.ComputerUsePreviewTool

控制虚拟计算机的工具。

名称	类型	DESCRIPTION	必选
显示高度	整数	计算机显示的高度。	是的
显示宽度	整数	计算机的显示宽度。	是的
环境	枚举	要控制的计算机环境的类型。可能的值：`windows`、、`maclinux`、`ubuntu`、`browser`	是的
类型	枚举	计算机使用工具的类型。始终为 `computer_use_preview`。可能的值： `computer_use_preview`	是的

OpenAI.Coordinate

x/y 坐标对，例如 { x: 100, y: 200 }

名称	类型	DESCRIPTION	必选	违约
x	整数	X 坐标。	是的
y	整数	Y 坐标。	是的

OpenAI.CreateEmbeddingResponse

名称	类型	DESCRIPTION	必选
数据	数组	模型生成的嵌入列表。	是的
模型	字符串	用于生成嵌入的模型的名称。	是的
物体	枚举	对象类型，始终为“list”。可能的值： `list`	是的
使用量	物体	请求的使用情况信息。	是的
└─ prompt_tokens	整数	提示使用的令牌数。	否
└─ total_tokens	整数	请求使用的令牌总数。	否

OpenAI.Embedding

表示嵌入终结点返回的嵌入向量。

名称	类型	DESCRIPTION	必选
嵌入	数组或字符串		是的
索引	整数	嵌入列表的嵌入索引。	是的
物体	枚举	对象类型，始终为“embedding”。可能的值： `embedding`	是的

OpenAI.FileSearchTool

一个工具，用于搜索已上传文件中的相关内容。

名称	类型	DESCRIPTION	必选
筛选器	物体		否
max_num_results（最大结果数）	整数	要返回的最大结果数。此数字应介于 1 和 50 之间（含）。	否
排名选项	物体		否
└─ ranker	枚举	用于文件搜索的排序算法。可能的值： `autodefault-2024-11-15`	否
└─ score_threshold	数字	文件搜索的分数阈值，介于 0 和 1 之间。接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。	否
类型	枚举	文件搜索工具的类型。始终为 `file_search`。可能的值： `file_search`	是的
vector_store_ids	数组	要搜索的矢量存储的 ID。	是的

OpenAI.FileSearchToolCallItemParam

文件搜索工具调用的结果。

名称	类型	DESCRIPTION	必选
查询	数组	用于搜索文件的查询。	是的
结果	数组	文件搜索工具调用的结果。	否
类型	枚举	可能的值： `file_search_call`	是的

OpenAI.FileSearchToolCallItemResource

文件搜索工具调用的结果。

名称	类型	DESCRIPTION	必选
查询	数组	用于搜索文件的查询。	是的
结果	数组	文件搜索工具调用的结果。	否
地位	枚举	文件搜索工具调用的状态。以下之一：`in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	是的
类型	枚举	可能的值： `file_search_call`	是的

OpenAI.Filters

名称	类型	DESCRIPTION	必选
筛选器	数组	要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`。	是的
钥匙	字符串	要与值进行比较的键。	是的
类型	枚举	操作类型：`and` 或 `or`。可能的值： `andor`	是的
价值	字符串或数字或布尔值	要与属性键进行比较的值;支持字符串、数字或布尔类型。	是的

OpenAI.FunctionObject

名称	类型	DESCRIPTION	必选	违约
描述	字符串	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
姓名	字符串	要调用的函数的名称。必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	是的
参数		函数接受的参数，被描述为 JSON 架构对象。	否
strict	布尔	生成函数调用时是否启用严格的架构遵循。如果设置为 true，则模型将遵循 `parameters` 字段中定义的确切架构。 `stricttrue` 时，仅支持 JSON 架构的子集。	否	假

OpenAI.FunctionTool

在自己的代码中定义模型可以选择调用的函数。

名称	类型	DESCRIPTION	必选
描述	字符串	函数的说明。该模型用于判断是否调用函数。	否
姓名	字符串	要调用的函数的名称。	是的
参数		描述函数参数的 JSON 架构对象。	是的
strict	布尔	是否强制实施严格的参数验证。默认 `true`。	是的
类型	枚举	函数工具的类型。始终为 `function`。可能的值： `function`	是的

OpenAI.FunctionToolCallItemParam

用于运行函数的工具调用。

名称	类型	DESCRIPTION	必选
论点	字符串	要传递给函数的参数的 JSON 字符串。	是的
通话编号	字符串	模型生成的函数工具调用的唯一 ID。	是的
姓名	字符串	要运行的函数的名称。	是的
类型	枚举	可能的值： `function_call`	是的

OpenAI.FunctionToolCallItemResource

用于运行函数的工具调用。

名称	类型	DESCRIPTION	必选
论点	字符串	要传递给函数的参数的 JSON 字符串。	是的
通话编号	字符串	模型生成的函数工具调用的唯一 ID。	是的
姓名	字符串	要运行的函数的名称。	是的
地位	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值： `function_call`	是的

OpenAI.FunctionToolCallOutputItemParam

函数工具调用的输出。

名称	类型	DESCRIPTION	必选
通话编号	字符串	模型生成的函数工具调用的唯一 ID。	是的
输出	字符串	函数工具调用输出的 JSON 字符串。	是的
类型	枚举	可能的值： `function_call_output`	是的

OpenAI.FunctionToolCallOutputItemResource

函数工具调用的输出。

名称	类型	DESCRIPTION	必选
通话编号	字符串	模型生成的函数工具调用的唯一 ID。	是的
输出	字符串	函数工具调用输出的 JSON 字符串。	是的
地位	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	可能的值： `function_call_output`	是的

OpenAI.ImageGenTool

使用类似 gpt-image-1模型生成图像的工具。

名称	类型	DESCRIPTION	必选	违约
背景	枚举	生成的图像的背景类型。以下之一：`transparent`、 `opaque` 或 `auto` 中的一项。默认值：`auto`。可能的值：`transparent`、、 `opaqueauto`	否
input_image_mask	物体	用于修复的可选掩码。包含 `image_url` （字符串，可选）和 `file_id` （字符串，可选）。	否
└─ file_id	字符串	掩码图像的文件 ID。	否
└─ image_url	字符串	Base64 编码的掩码图像。	否
模型	枚举	要使用的图像生成模型。默认值：`gpt-image-1`。可能的值： `gpt-image-1`	否
审查	枚举	生成图像的审核级别。默认值：`auto`。可能的值： `autolow`	否
output_compression	整数	输出图像的压缩级别。默认值：100。	否	100
输出格式	枚举	生成的图像的输出格式。以下之一：`png`、`webp` 或 `jpeg`。默认值：`png`。可能的值：`png`、、 `webpjpeg`	否
partial_images	整数	在流式处理模式中可以生成的部分图像数量，从 0（默认值）到 3。	否	0
质量	枚举	生成的图像的质量。 `low`、`medium`、`high` 之一，或 `auto`。默认值：`auto`。可能的值：`low`、`medium`、`high`、`auto`	否
size	枚举	生成的映像的大小。以下之一：`1024x1024`、`1024x1536`、 `1536x1024` 或 `auto` 中的一项。默认值：`auto`。可能的值：`1024x1024`、`1024x1536`、`1536x1024`、`auto`	否
类型	枚举	图像生成工具的类型。始终为 `image_generation`。可能的值： `image_generation`	是的

OpenAI.ImageGenToolCallItemParam

模型发出的图像生成请求。

名称	类型	DESCRIPTION	必选	违约
结果	字符串	以 base64 编码生成的图像。	是的
类型	枚举	可能的值： `image_generation_call`	是的

OpenAI.ImageGenToolCallItemResource

模型发出的图像生成请求。

名称	类型	DESCRIPTION	必选
结果	字符串	以 base64 编码生成的图像。	是的
地位	枚举	可能的值：`in_progress`、`completed`、`generating`、`failed`	是的
类型	枚举	可能的值： `image_generation_call`	是的

OpenAI.ImplicitUserMessage

名称	类型	DESCRIPTION	必选	违约
内容	字符串或数组		是的

OpenAI.Includable

指定要包含在模型响应中的其他输出数据。当前支持的值包括：

file_search_call.results：包括通过调用文件搜索工具而获得的搜索结果。
message.input_image.image_url：包括输入消息中的图像 URL。
computer_call_output.output.image_url：包括计算机调用输出中的图像 URL。
reasoning.encrypted_content：在推理项输出中包含推理令牌的加密版本。这样，当无状态使用响应 API 时（如将store参数设置为false，或组织在零数据保留计划中注册时），多轮次对话中可以使用推理内容。

资产	价值
说明	指定要包含在模型响应中的其他输出数据。现在支持的值包括： - `file_search_call.results`：包括文件搜索工具的搜索结果。 - `message.input_image.image_url`：包括输入消息中的图像链接。 - `computer_call_output.output.image_url`：包括计算机调用输出中的图像 URL。 - `reasoning.encrypted_content`：包括经过加密的推理版本推理项目输出中的令牌。这样就可以在无状态使用响应 API 时，在多轮次对话中使用推理项（例如当参数 `store` 设置为 `false`，或当组织在零数据保留计划中注册时）。
类型	字符串
价值观	`file_search_call.results` `message.input_image.image_url` `computer_call_output.output.image_url` `reasoning.encrypted_content`

OpenAI.ItemContent

OpenAI.ItemContent 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`input_audio`	OpenAI.ItemContentInputAudio
`output_audio`	OpenAI.ItemContentOutputAudio
`refusal`	OpenAI.ItemContentRefusal
`input_text`	OpenAI.ItemContentInputText
`input_image`	OpenAI.ItemContentInputImage
`input_file`	OpenAI.ItemContentInputFile
`output_text`	OpenAI.ItemContentOutputText

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ItemContentType	多模态输入和输出内容。	是的

OpenAI.ItemContentInputAudio

模型的音频输入。

名称	类型	DESCRIPTION	必选
数据	字符串	Base64 编码的音频数据。	是的
格式	枚举	音频数据的格式。当前支持的格式包括 `mp3` 和 `wav`。可能的值： `mp3wav`	是的
类型	枚举	输入项的类型。始终为 `input_audio`。可能的值： `input_audio`	是的

OpenAI.ItemContentInputFile

模型的文件输入。

名称	类型	DESCRIPTION	必选
file_data	字符串	要发送到模型的文件的内容。	否
file_id	字符串	要发送到模型的文件的 ID。	否
文件名	字符串	要发送到模型的文件的名称。	否
类型	枚举	输入项的类型。始终为 `input_file`。可能的值： `input_file`	是的

OpenAI.ItemContentInputImage

输入到模型中的图像

名称	类型	DESCRIPTION	必选
细节	枚举	要发送到模型的图像的细节级别。 `high`、`low` 或 `auto` 之一。默认为 `auto`。可能的值：`low`、、 `highauto`	否
file_id	字符串	要发送到模型的文件的 ID。	否
image_url	字符串	图像的 URL 要发送到模型。数据 URL 中的完全限定 URL 或 base64 编码图像。	否
类型	枚举	输入项的类型。始终为 `input_image`。可能的值： `input_image`	是的

OpenAI.ItemContentInputText

模型的文本输入。

名称	类型	DESCRIPTION	必选	违约
文本	字符串	模型的文本输入。	是的
类型	枚举	输入项的类型。始终为 `input_text`。可能的值： `input_text`	是的

OpenAI.ItemContentOutputAudio

模型的音频输出。

名称	类型	DESCRIPTION	必选
数据	字符串	来自模型的 Base64 编码音频数据。	是的
脚本	字符串	来自模型的音频数据转录。	是的
类型	枚举	输出音频的类型。始终为 `output_audio`。可能的值： `output_audio`	是的

OpenAI.ItemContentOutputText

模型的文本输出。

名称	类型	DESCRIPTION	必选
注释	数组	文本输出的注释。	是的
文本	字符串	模型的文本输出。	是的
类型	枚举	输出文本的类型。始终为 `output_text`。可能的值： `output_text`	是的

OpenAI.ItemContentRefusal

模型的拒绝。

名称	类型	DESCRIPTION	必选	违约
拒绝	字符串	模型的拒绝的解释。	是的
类型	枚举	拒绝的类型。始终为 `refusal`。可能的值： `refusal`	是的

OpenAI.ItemContentType

多模态输入和输出内容。

资产	价值
说明	多模态输入和输出内容。
类型	字符串
价值观	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

用于生成响应的内容项。

OpenAI.ItemParam 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`message`	OpenAI.ResponsesMessageItemParam
`function_call_output`	OpenAI.FunctionToolCallOutputItemParam
`file_search_call`	OpenAI.FileSearchToolCallItemParam
`computer_call`	OpenAI.ComputerToolCallItemParam
`computer_call_output`	OpenAI.ComputerToolCallOutputItemParam
`web_search_call`	OpenAI.WebSearchToolCallItemParam
`function_call`	OpenAI.FunctionToolCallItemParam
`reasoning`	OpenAI.ReasoningItemParam
`item_reference`	OpenAI.ItemReferenceItemParam
`image_generation_call`	OpenAI.ImageGenToolCallItemParam
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemParam
`mcp_list_tools`	OpenAI.MCPListToolsItemParam
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemParam
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemParam
`mcp_call`	OpenAI.MCPCallItemParam

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ItemType		是的

OpenAI.ItemReferenceItemParam

要引用的项的内部标识符。

名称	类型	DESCRIPTION	必选	违约
ID	字符串	要引用的以前生成的响应项的服务发起的 ID。	是的
类型	枚举	可能的值： `item_reference`	是的

OpenAI.ItemResource

用于生成响应的内容项。

OpenAI.ItemResource 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`message`	OpenAI.ResponsesMessageItemResource
`computer_call_output`	OpenAI.ComputerToolCallOutputItemResource
`function_call`	OpenAI.FunctionToolCallItemResource
`function_call_output`	OpenAI.FunctionToolCallOutputItemResource
`mcp_approval_response`	OpenAI.MCPApprovalResponseItemResource
`code_interpreter_call`	OpenAI.CodeInterpreterToolCallItemResource
`file_search_call`	OpenAI.FileSearchToolCallItemResource
`computer_call`	OpenAI.ComputerToolCallItemResource
`web_search_call`	OpenAI.WebSearchToolCallItemResource
`reasoning`	OpenAI.ReasoningItemResource
`image_generation_call`	OpenAI.ImageGenToolCallItemResource
`mcp_list_tools`	OpenAI.MCPListToolsItemResource
`mcp_approval_request`	OpenAI.MCPApprovalRequestItemResource
`mcp_call`	OpenAI.MCPCallItemResource

名称	类型	DESCRIPTION	必选	违约
ID	字符串		是的
类型	OpenAI.ItemType		是的

OpenAI.ItemType

资产	价值
类型	字符串
价值观	`message` `file_search_call` `function_call` `function_call_output` `computer_call` `computer_call_output` `web_search_call` `reasoning` `item_reference` `image_generation_call` `code_interpreter_call` `mcp_list_tools` `mcp_approval_request` `mcp_approval_response` `mcp_call`

OpenAI.Location

OpenAI.Location 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`approximate`	OpenAI.ApproximateLocation

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.LocationType		是的

OpenAI.LocationType

资产	价值
类型	字符串
价值观	`approximate`

OpenAI.MCPApprovalRequestItemParam

请求人工批准工具调用。

名称	类型	DESCRIPTION	必选
论点	字符串	工具的参数的 JSON 字符串。	是的
姓名	字符串	要运行的工具的名称。	是的
server_label	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	可能的值： `mcp_approval_request`	是的

OpenAI.MCPApprovalRequestItemResource

请求人工批准工具调用。

名称	类型	DESCRIPTION	必选
论点	字符串	工具的参数的 JSON 字符串。	是的
姓名	字符串	要运行的工具的名称。	是的
server_label	字符串	发出请求的 MCP 服务器的标签。	是的
类型	枚举	可能的值： `mcp_approval_request`	是的

OpenAI.MCPApprovalResponseItemParam

对 MCP 审批请求的响应。

名称	类型	DESCRIPTION	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
原因	字符串	决定的可选原因。	否
类型	枚举	可能的值： `mcp_approval_response`	是的

OpenAI.MCPApprovalResponseItemResource

对 MCP 审批请求的响应。

名称	类型	DESCRIPTION	必选
approval_request_id	字符串	正在应答的审批请求的 ID。	是的
批准	布尔	请求是否已获得批准。	是的
原因	字符串	决定的可选原因。	否
类型	枚举	可能的值： `mcp_approval_response`	是的

OpenAI.MCPCallItemParam

在 MCP 服务器上调用工具。

名称	类型	DESCRIPTION	必选
论点	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	字符串	工具调用中的错误（如果有）。	否
姓名	字符串	运行的工具的名称。	是的
输出	字符串	工具调用的输出。	否
server_label	字符串	运行该工具的 MCP 服务器的标签。	是的
类型	枚举	可能的值： `mcp_call`	是的

OpenAI.MCPCallItemResource

在 MCP 服务器上调用工具。

名称	类型	DESCRIPTION	必选
论点	字符串	传递给工具的参数的 JSON 字符串。	是的
错误	字符串	工具调用中的错误（如果有）。	否
姓名	字符串	运行的工具的名称。	是的
输出	字符串	工具调用的输出。	否
server_label	字符串	运行该工具的 MCP 服务器的标签。	是的
类型	枚举	可能的值： `mcp_call`	是的

OpenAI.MCPListToolsItemParam

MCP 服务器上可用的工具列表。

名称	类型	DESCRIPTION	必选
错误	字符串	如果服务器无法列出工具，则显示错误消息。	否
server_label	字符串	MCP 服务器的标签。	是的
工具	数组	服务器上可用的工具。	是的
类型	枚举	可能的值： `mcp_list_tools`	是的

OpenAI.MCPListToolsItemResource

MCP 服务器上可用的工具列表。

名称	类型	DESCRIPTION	必选
错误	字符串	如果服务器无法列出工具，则显示错误消息。	否
server_label	字符串	MCP 服务器的标签。	是的
工具	数组	服务器上可用的工具。	是的
类型	枚举	可能的值： `mcp_list_tools`	是的

OpenAI.MCPListToolsTool

MCP 服务器上可用的工具。

名称	类型	DESCRIPTION	必选
注释		有关该工具的其他注释。	否
描述	字符串	工具的说明。	否
输入架构		描述工具输入的 JSON 架构。	是的
姓名	字符串	工具的名称。	是的

OpenAI.MCPTool

通过远程模型上下文协议（MCP）服务器向模型授予对其他工具的访问权限。

名称	类型	DESCRIPTION	必选
允许的工具	物体		否
└─ tool_names	数组	允许的工具名称列表。	否
标题	物体	要发送到 MCP 服务器的可选 HTTP 标头。用于身份验证或其他目的。	否
require_approval	对象（请参阅下面的有效模型）	指定哪些 MCP 服务器工具需要批准。	否
server_label	字符串	此 MCP 服务器的标签，用于在工具调用中标识它。	是的
server_url（服务器网址）	字符串	MCP 服务器的 URL。	是的
类型	枚举	MCP 工具的类型。始终为 `mcp`。可能的值： `mcp`	是的

OpenAI.ParallelToolCalls

是否在工具使用期间启用并行函数调用。

类型：布尔值

OpenAI.RankingOptions

名称	类型	DESCRIPTION	必选	违约
ranker	枚举	用于文件搜索的排序算法。可能的值： `autodefault-2024-11-15`	否
分数阈值	数字	文件搜索的分数阈值，介于 0 和 1 之间。接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。	否

OpenAI.Reasoning

仅适用于 O 系列模型

推理模型的配置选项。

名称	类型	DESCRIPTION	必选
effort	物体	仅适用于 O 系列模型限制推理模型的推理工作量。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	否
生成摘要	枚举	已弃用：改用 `summary` 。模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否

OpenAI.ReasoningEffort

仅适用于 O 系列模型

限制推理模型的推理力度。

当前支持的值为 low、medium 和 high。减少推理工作量可以加快回复速度，减少回复中用于推理的标记。

资产	价值
说明	仅适用于 O 系列模型限制推理模型的推理工作量。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。
类型	字符串
价值观	`low` `medium` `high`

OpenAI.ReasoningItemParam

描述推理模型在生成响应时使用的想法链。如果要手动管理上下文，请务必将这些 input 项包含在响应 API 中，以便后续轮次对话。

名称	类型	DESCRIPTION	必选
加密内容	字符串	推理项的加密内容 - 在在 `reasoning.encrypted_content` 参数中使用 `include` 生成响应时填充。	否
摘要	数组	推理文本内容。	是的
类型	枚举	可能的值： `reasoning`	是的

OpenAI.ReasoningItemResource

描述推理模型在生成响应时使用的想法链。如果要手动管理上下文，请务必将这些 input 项包含在响应 API 中，以便后续轮次对话。

名称	类型	DESCRIPTION	必选
加密内容	字符串	推理项的加密内容 - 在在 `reasoning.encrypted_content` 参数中使用 `include` 生成响应时填充。	否
摘要	数组	推理文本内容。	是的
类型	枚举	可能的值： `reasoning`	是的

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ReasoningItemSummaryPartType		是的

OpenAI.ReasoningItemSummaryPartType

资产	价值
类型	字符串
价值观	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

名称	类型	DESCRIPTION	必选	违约
文本	字符串		是的
类型	枚举	可能的值： `summary_text`	是的

OpenAI.Response

名称	类型	DESCRIPTION	必选	违约
背景	布尔	是否在后台运行模型响应。	否	假
created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	是的
错误	物体	当模型无法生成响应时返回的错误对象。	是的
└─ code	OpenAI.ResponseErrorCode	响应的错误代码。	否
└─ 消息	字符串	可读的错误说明。	否
ID	字符串	此响应的唯一标识符。	是的
incomplete_details	物体	有关响应不完整的原因的详细信息。	是的
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
指示	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
最大输出标记数量 (max_output_tokens)	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	是的
物体	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	是的
输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	是的
output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	是的	真实
previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
推理	物体	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ effort	OpenAI.ReasoningEffort	仅适用于 O 系列模型限制推理模型的推理工作量。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	否
└─ generate_summary	枚举	已弃用：改用 `summary` 。模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
~~ 摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	否
地位	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	是的
文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
工具选择	物体	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。	否
└─ 类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。	否
工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。管理上下文。	否
top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	是的
truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
使用量	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	是的

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

由代码解释器添加部分代码片段时发出。

名称	类型	DESCRIPTION	必选
delta	字符串	代码解释器添加的部分代码片段。	是的
output_index	整数	代码解释器调用正在处理的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.code.delta`。可能的值： `response.code_interpreter_call.code.delta`	是的

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

当代码片段输出由代码解释器完成时发出。

名称	类型	DESCRIPTION	必选
代码	字符串	代码解释器输出的最终代码片段。	是的
output_index	整数	代码解释器调用正在处理的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.code.done`。可能的值： `response.code_interpreter_call.code.done`	是的

OpenAI.ResponseCodeInterpreterCallCompletedEvent

在代码解释器调用完成时发出。

名称	类型	DESCRIPTION	必选
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource	用于运行代码的工具调用。	是的
output_index	整数	代码解释器调用正在处理的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.completed`。可能的值： `response.code_interpreter_call.completed`	是的

OpenAI.ResponseCodeInterpreterCallInProgressEvent

代码解释器调用正在进行时发出。

名称	类型	DESCRIPTION	必选
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource	用于运行代码的工具调用。	是的
output_index	整数	代码解释器调用正在处理的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.in_progress`。可能的值： `response.code_interpreter_call.in_progress`	是的

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

当代码解释器主动解释代码片段时发出。

名称	类型	DESCRIPTION	必选
code_interpreter_call	OpenAI.CodeInterpreterToolCallItemResource	用于运行代码的工具调用。	是的
output_index	整数	代码解释器调用正在处理的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.code_interpreter_call.interpreting`。可能的值： `response.code_interpreter_call.interpreting`	是的

OpenAI.ResponseCompletedEvent

模型响应完成时发出。

名称	类型	DESCRIPTION	必选	违约
response	物体		是的
~~ 背景	布尔	是否在后台运行模型响应。	否	假
└─ created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ id	字符串	此响应的唯一标识符。	否
└─ incomplete_details	物体	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ instructions	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
└─ max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
└─ 元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ object	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
└─ output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
└─ parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
└─ previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
└─推理	OpenAI.Reasoning	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
└─ tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：扩展模型功能的工具。	否
└─ top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否
类型	枚举	事件类型。始终为 `response.completed`。可能的值： `response.completed`	是的

OpenAI.ResponseContentPartAddedEvent

添加新内容部分时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	已添加的内容部分的索引。	是的
项目编号	字符串	将内容部分添加到的输出项的 ID。	是的
output_index	整数	将内容部分添加到的输出项的索引。	是的
part	物体		是的
└─ 类型	OpenAI.ItemContentType	多模态输入和输出内容。	否
类型	枚举	事件类型。始终为 `response.content_part.added`。可能的值： `response.content_part.added`	是的

OpenAI.ResponseContentPartDoneEvent

完成内容部分时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	完成的内容部分的索引。	是的
项目编号	字符串	将内容部分添加到的输出项的 ID。	是的
output_index	整数	将内容部分添加到的输出项的索引。	是的
part	物体		是的
└─ 类型	OpenAI.ItemContentType	多模态输入和输出内容。	否
类型	枚举	事件类型。始终为 `response.content_part.done`。可能的值： `response.content_part.done`	是的

OpenAI.ResponseCreatedEvent

创建响应时发出的事件。

名称	类型	DESCRIPTION	必选	违约
response	物体		是的
~~ 背景	布尔	是否在后台运行模型响应。	否	假
└─ created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ id	字符串	此响应的唯一标识符。	否
└─ incomplete_details	物体	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 指令	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
└─ max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
└─ 元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
└─ output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
└─ parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
└─ previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
└─ 推理	OpenAI.Reasoning	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
└─ tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能。函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。管理上下文。	否
└─ top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否
类型	枚举	事件类型。始终为 `response.created`。可能的值： `response.created`	是的

OpenAI.ResponseError

当模型无法生成响应时返回的错误对象。

名称	类型	DESCRIPTION	必选	违约
代码	OpenAI.ResponseErrorCode	响应的错误代码。	是的
消息	字符串	可读的错误说明。	是的

OpenAI.ResponseErrorCode

响应的错误代码。

资产	价值
说明	响应的错误代码。
类型	字符串
价值观	`server_error` `rate_limit_exceeded` `invalid_prompt` `vector_store_timeout` `invalid_image` `invalid_image_format` `invalid_base64_image` `invalid_image_url` `image_too_large` `image_too_small` `image_parse_error` `image_content_policy_violation` `invalid_image_mode` `image_file_too_large` `unsupported_image_media_type` `empty_image_file` `failed_to_download_image` `image_file_not_found`

OpenAI.ResponseErrorEvent

在发生错误时发出。

名称	类型	DESCRIPTION	必选
代码	字符串	错误代码。	是的
消息	字符串	错误消息。	是的
param	字符串	错误参数。	是的
类型	枚举	事件类型。始终为 `error`。可能的值： `error`	是的

OpenAI.ResponseFailedEvent

响应失败时发出的事件。

名称	类型	DESCRIPTION	必选	违约
response	物体		是的
~~ 背景	布尔	是否在后台运行模型响应。	否	假
└─ created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ id	字符串	此响应的唯一标识符。	否
└─ incomplete_details	物体	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 指令	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
└─ max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
└─ 元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
└─ output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
└─ parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
└─ previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
└─ 推理	OpenAI.Reasoning	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
└─ tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能。函数调用（自定义工具）：由你定义的函数，使模型能够调用自己的代码。管理上下文。	否
└─ top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否
类型	枚举	事件类型。始终为 `response.failed`。可能的值： `response.failed`	是的

OpenAI.ResponseFileSearchCallCompletedEvent

在文件搜索调用完成时发出（找到结果）。

名称	类型	DESCRIPTION	必选
项目编号	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	整数	启动文件搜索调用的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.file_search_call.completed`。可能的值： `response.file_search_call.completed`	是的

OpenAI.ResponseFileSearchCallInProgressEvent

在启动文件搜索调用时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	整数	启动文件搜索调用的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.file_search_call.in_progress`。可能的值： `response.file_search_call.in_progress`	是的

OpenAI.ResponseFileSearchCallSearchingEvent

当文件搜索当前正在搜索时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	启动文件搜索调用的输出项的 ID。	是的
output_index	整数	文件搜索调用正在搜索的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.file_search_call.searching`。可能的值： `response.file_search_call.searching`	是的

OpenAI.ResponseFormat（OpenAI响应格式）

OpenAI.ResponseFormat 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`text`	OpenAI.ResponseFormatText
`json_object`	OpenAI.ResponseFormatJsonObject
`json_schema`	OpenAI.ResponseFormatJsonSchema

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值：`text`、、 `json_objectjson_schema`	是的

OpenAI.ResponseFormatJsonObject

JSON 对象响应格式。生成 JSON 响应的较旧方法。建议对支持它的模型使用 json_schema 。请注意，除非有系统或用户消息指示，模型不会生成 JSON。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `json_object`。可能的值： `json_object`	是的

OpenAI.ResponseFormatJsonSchema

JSON 架构响应格式。用于生成结构化 JSON 响应。

名称	类型	DESCRIPTION	必选	违约
json_schema	物体	结构化输出配置选项，包括 JSON 架构。	是的
└─ 说明	字符串	响应格式用途的描述，供模型确定如何按该格式响应。	否
└─ 名称	字符串	响应格式的名称。必须为 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	否
└─ 架构	OpenAI.ResponseFormatJsonSchemaSchema	响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。	否
└─ 严格	布尔	是否在生成输出时启用严格的架构遵循。如果设置为 true，则模型将始终遵循定义的确切架构在 `schema` 字段中。以下情况时仅支持 JSON 架构的子集： `strict` 是 `true`。 .	否	假
类型	枚举	要定义的响应格式的类型。始终为 `json_schema`。可能的值： `json_schema`	是的

OpenAI.ResponseFormatJsonSchemaSchema

响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。

类型：对象

OpenAI.ResponseFormatText

默认响应格式。用于生成文本响应。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	要定义的响应格式的类型。始终为 `text`。可能的值： `text`	是的

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

当存在部分函数调用参数增量时发出。

名称	类型	DESCRIPTION	必选
delta	字符串	添加的函数调用参数增量。	是的
项目编号	字符串	函数调用参数增量添加到的输出项的 ID。	是的
output_index	整数	函数调用参数增量添加到的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.function_call_arguments.delta`。可能的值： `response.function_call_arguments.delta`	是的

OpenAI.ResponseFunctionCallArgumentsDoneEvent

在函数调用参数完成时发出。

名称	类型	DESCRIPTION	必选
论点	字符串	函数调用参数。	是的
项目编号	字符串	项的 ID。	是的
output_index	整数	输出项的索引。	是的
类型	枚举	可能的值： `response.function_call_arguments.done`	是的

OpenAI.ResponseImageGenCallCompletedEvent

当映像生成工具调用完成并且最终映像可用时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.completed”。可能的值： `response.image_generation_call.completed`	是的

OpenAI.ResponseImageGenCallGeneratingEvent

当映像生成工具调用正在主动生成映像（中间状态）时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值： `response.image_generation_call.generating`	是的

OpenAI.ResponseImageGenCallInProgressEvent

映像生成工具调用正在进行时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值： `response.image_generation_call.in_progress`	是的

OpenAI.ResponseImageGenCallPartialImageEvent

当部分图像在图像生成流式处理期间可用时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	正在处理的图像生成项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
partial_image_b64	字符串	Base64 编码的部分图像数据，适合作为图像呈现。	是的
partial_image_index	整数	部分映像的基于 0 的索引（后端基于 1，但用户基于 0）。	是的
类型	枚举	事件类型。始终为“response.image_generation_call.partial_image”。可能的值： `response.image_generation_call.partial_image`	是的

OpenAI.ResponseInProgressEvent

响应正在进行时发出。

名称	类型	DESCRIPTION	必选	违约
response	物体		是的
~~ 背景	布尔	是否在后台运行模型响应。	否	假
└─ created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ id	字符串	此响应的唯一标识符。	否
└─ incomplete_details	物体	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 指令	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
└─ max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
└─ 元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
└─ output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
└─ parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
└─ previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
└─ 推理	OpenAI.Reasoning	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
└─ tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：OpenAI 提供的工具，用于扩展模型的功能。	否
└─ top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否
类型	枚举	事件类型。始终为 `response.in_progress`。可能的值： `response.in_progress`	是的

OpenAI.ResponseIncompleteEvent

响应以不完整状态结束时发出的事件。

名称	类型	DESCRIPTION	必选	违约
response	物体		是的
~~ 背景	布尔	是否在后台运行模型响应。	否	假
└─ created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ id	字符串	此响应的唯一标识符。	否
└─ incomplete_details	物体	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 指令	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
└─ max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
└─ 元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
└─ output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
└─ parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
└─ previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
└─ 推理	OpenAI.Reasoning	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
└─ tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： - 内置工具：扩展模型功能的工具，函数调用（自定义工具）	否
└─ top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否
类型	枚举	事件类型。始终为 `response.incomplete`。可能的值： `response.incomplete`	是的

OpenAI.ResponseItemList

响应项的列表。

名称	类型	DESCRIPTION	必选
数据	数组	用于生成此响应的项列表。	是的
first_id	字符串	列表中第一项的 ID。	是的
has_more	布尔	是否有更多可用项。	是的
last_id	字符串	列表中最后一项的 ID。	是的
物体	枚举	返回的对象的类型必须是 `list`。可能的值： `list`	是的

OpenAI.ResponseMCPCallArgumentsDeltaEvent

当 MCP 工具调用的参数存在增量（部分更新）时发出。

名称	类型	DESCRIPTION	必选
delta		MCP 工具调用参数的部分更新。	是的
项目编号	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.mcp_call.arguments_delta”。可能的值： `response.mcp_call.arguments_delta`	是的

OpenAI.ResponseMCPCallArgumentsDoneEvent

在完成 MCP 工具调用的参数时发出。

名称	类型	DESCRIPTION	必选
论点		MCP 工具调用的最终参数。	是的
项目编号	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.mcp_call.arguments_done”。可能的值： `response.mcp_call.arguments_done`	是的

OpenAI.ResponseMCPCallCompletedEvent

MCP 工具调用成功完成时发出。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	事件类型。始终为“response.mcp_call.completed”。可能的值： `response.mcp_call.completed`	是的

OpenAI.ResponseMCPCallFailedEvent

MCP 工具调用失败时发出。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	事件类型。始终为“response.mcp_call.failed”。可能的值： `response.mcp_call.failed`	是的

OpenAI.ResponseMCPCallInProgressEvent

当 MCP 工具调用正在进行时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	正在处理的 MCP 工具调用项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.mcp_call.in_progress”。可能的值： `response.mcp_call.in_progress`	是的

OpenAI.ResponseMCPListToolsCompletedEvent

成功检索可用 MCP 工具列表时发出。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	事件类型。始终为“response.mcp_list_tools.completed”。可能的值： `response.mcp_list_tools.completed`	是的

OpenAI.ResponseMCPListToolsFailedEvent

尝试列出可用 MCP 工具失败时发出。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	事件类型。始终为“response.mcp_list_tools.failed”。可能的值： `response.mcp_list_tools.failed`	是的

OpenAI.ResponseMCPListToolsInProgressEvent

当系统正在检索可用 MCP 工具列表时发出。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	事件类型。始终为“response.mcp_list_tools.in_progress”。可能的值： `response.mcp_list_tools.in_progress`	是的

OpenAI.ResponseOutputItemAddedEvent

添加新的输出项时发出。

名称	类型	DESCRIPTION	必选
物品	物体	用于生成响应的内容项。	是的
└─ id	字符串		否
└─ 类型	OpenAI.ItemType		否
output_index	整数	已添加的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.output_item.added`。可能的值： `response.output_item.added`	是的

OpenAI.ResponseOutputItemDoneEvent

当输出项标记为已完成时发出。

名称	类型	DESCRIPTION	必选
物品	物体	用于生成响应的内容项。	是的
└─ id	字符串		否
└─ 类型	OpenAI.ItemType		否
output_index	整数	标记为已完成的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.output_item.done`。可能的值： `response.output_item.done`	是的

OpenAI.ResponseQueuedEvent

当响应排队并等待处理时发出。

名称	类型	DESCRIPTION	必选	违约
response	物体		是的
~~ 背景	布尔	是否在后台运行模型响应。	否	假
└─ created_at	整数	创建此响应时的 Unix 时间戳（以秒为单位）。	否
~~ 错误	OpenAI.ResponseError	当模型无法生成响应时返回的错误对象。	否
└─ id	字符串	此响应的唯一标识符。	否
└─ incomplete_details	物体	有关响应不完整的原因的详细信息。	否
~~ 原因	枚举	响应不够详尽的原因。可能的值： `max_output_tokenscontent_filter`	否
└─ 指令	字符串	将系统（或开发人员）消息作为模型上下文中的第一项插入。当与 `previous_response_id` 一起使用时，先前的响应的指令不会传递到下一个响应。这使得它变得简单在新的响应中交换系统（或开发人员）消息。	否
└─ max_output_tokens	整数	可为响应生成的令牌数上限，包括可见输出令牌和。	否
└─ 元数据	物体	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	否
└─ 对象	枚举	此资源的对象类型 - 始终设置为 `response`。可能的值： `response`	否
└─ 输出	数组	模型生成的内容项数组。 - 数组中 `output` 项的长度和顺序取决于于模型的响应。 - 与其访问 `output` 数组中的第一项并假设它是包含模型生成内容的 `assistant` 消息，可以考虑在 SDK 中支持的位置使用 `output_text` 属性。	否
└─ output_text	字符串	仅限 SDK 的便利属性，其中包含来自 `output_text` 数组中的所有 `output` 项聚合的文本输出（如果有）。 Python 和 JavaScript SDK 中受支持。	否
└─ parallel_tool_calls	布尔	是否允许模型并行运行工具调用。	否	真实
└─ previous_response_id	字符串	对模型的上一个响应的唯一 ID。用它创建多轮对话。推理模型的推理工作量。	否
└─ 推理	OpenAI.Reasoning	仅适用于 O 系列模型配置选项用于推理模型的推理工作量。	否
└─ 状态	枚举	响应生成的状态。以下之一：`completed`、`failed`、 `in_progress`、`cancelled`、`queued` 或 `incomplete`。可能的值：`completed`、、`failed`、`in_progresscancelled`、`queued`、`incomplete`	否
~~ 温度	数字	要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 `top_p`，但不要同时更改两者。	否
└─ 文本	物体	来自模型的文本响应的配置选项。可以是纯文本或结构化 JSON 数据。	否
└─ 格式	OpenAI.ResponseTextFormatConfiguration		否
└─ tool_choice	OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject	模型在生成时应如何选择要使用的工具（或工具）响应。 `tools`请参阅参数，了解如何指定哪些工具模型可以调用。	否
└─ 工具	数组	生成响应时，模型可能会调用的工具数组。你可以通过设置 `tool_choice` 参数来指定要使用的工具。可以提供模型的两类工具包括： -内置工具：扩展模型功能的工具。函数调用（自定义工具）：由你定义的函数，使模型调用自己的代码。	否
└─ top_p	数字	使用温度进行采样的替代方法，称为核采样，其中，模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或 `temperature`，但不要同时更改两者。	否
└─ truncation	枚举	要用于模型响应的截断策略。 - `auto`：如果此响应和以前的响应上下文超过模型的上下文窗口大小，模型将截断响应以适应上下文窗口，方法是在对话中删除输入项。 - `disabled` （默认值）：如果模型响应将超过上下文窗口模型的大小，请求将失败并出现 400 错误。可能的值： `autodisabled`	否
└─ 用法	OpenAI.ResponseUsage	表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌的细分以及所使用的令牌总数。	否
└─ 用户	字符串	表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。	否
类型	枚举	事件类型。始终为“response.queued”。可能的值： `response.queued`	是的

OpenAI.ResponseReasoningDeltaEvent

当推理内容存在增量（部分更新）时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	输出项中推理内容部件的索引。	是的
delta		对推理内容的部分更新。	是的
项目编号	字符串	正在更新推理的项目的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
类型	枚举	事件类型。始终为“response.reasoning.delta”。可能的值： `response.reasoning.delta`	是的

OpenAI.ResponseReasoningDoneEvent

当项的推理内容完成时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	输出项中推理内容部件的索引。	是的
项目编号	字符串	完成推理的项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
文本	字符串	最终的推理文本。	是的
类型	枚举	事件类型。始终为“response.reasoning.done”。可能的值： `response.reasoning.done`	是的

OpenAI.ResponseReasoningSummaryDeltaEvent

当推理摘要内容存在增量（部分更新）时发出。

名称	类型	DESCRIPTION	必选
delta		对推理摘要内容的部分更新。	是的
项目编号	字符串	正在更新推理摘要的项目的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
摘要索引	整数	输出项中概要部分的索引。	是的
类型	枚举	事件类型。始终为“response.reasoning_summary.delta”。可能的值： `response.reasoning_summary.delta`	是的

OpenAI.ResponseReasoningSummaryDoneEvent

当项目的推理摘要内容被最终确定时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	完成推理摘要的项的唯一标识符。	是的
output_index	整数	响应的输出数组中输出项的索引。	是的
摘要索引	整数	输出项中概要部分的索引。	是的
文本	字符串	最终的推理摘要文本。	是的
类型	枚举	事件类型。始终为“response.reasoning_summary.done”。可能的值： `response.reasoning_summary.done`	是的

OpenAI.ResponseReasoningSummaryPartAddedEvent

添加新的推理摘要部分时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	此摘要部分关联的项的 ID。	是的
output_index	整数	此摘要部分关联的输出项的索引。	是的
part	物体		是的
└─ 类型	OpenAI.ReasoningItemSummaryPartType		否
摘要索引	整数	推理摘要中摘要部分的索引。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.added`。可能的值： `response.reasoning_summary_part.added`	是的

OpenAI.ResponseReasoningSummaryPartDoneEvent

完成推理摘要部分时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	此摘要部分关联的项的 ID。	是的
output_index	整数	此摘要部分关联的输出项的索引。	是的
part	物体		是的
└─ 类型	OpenAI.ReasoningItemSummaryPartType		否
摘要索引	整数	推理摘要中摘要部分的索引。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.done`。可能的值： `response.reasoning_summary_part.done`	是的

OpenAI.ResponseReasoningSummaryTextDeltaEvent

将增量添加到推理摘要文本时发出。

名称	类型	DESCRIPTION	必选
delta	字符串	添加到摘要的文本增量。	是的
项目编号	字符串	此摘要文本增量关联的项的 ID。	是的
output_index	整数	此摘要文本增量关联的输出项的索引。	是的
摘要索引	整数	推理摘要中摘要部分的索引。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.delta`。可能的值： `response.reasoning_summary_text.delta`	是的

OpenAI.ResponseReasoningSummaryTextDoneEvent

完成推理摘要文本时发出。

名称	类型	DESCRIPTION	必选
项目编号	字符串	此摘要文本关联的项的 ID。	是的
output_index	整数	与此摘要文本关联的输出项的索引。	是的
摘要索引	整数	推理摘要中摘要部分的索引。	是的
文本	字符串	已完成推理摘要的全文。	是的
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.done`。可能的值： `response.reasoning_summary_text.done`	是的

OpenAI.ResponseRefusalDeltaEvent

当存在部分拒绝文本时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	拒绝文本添加到的内容部分的索引。	是的
delta	字符串	添加的拒绝文本。	是的
项目编号	字符串	拒绝文本添加到的输出项的 ID。	是的
output_index	整数	拒绝文本添加到的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.refusal.delta`。可能的值： `response.refusal.delta`	是的

OpenAI.ResponseRefusalDoneEvent

在拒绝文本完成时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	已完成拒绝文本的内容部分的索引。	是的
项目编号	字符串	已完成拒绝文本的输出项的 ID。	是的
output_index	整数	已完成拒绝文本的输出项的索引。	是的
拒绝	字符串	最终完成的拒绝文本。	是的
类型	枚举	事件类型。始终为 `response.refusal.done`。可能的值： `response.refusal.done`	是的

OpenAI.ResponseStreamEvent

Discriminator for OpenAI.ResponseStreamEvent

此组件使用属性 type 区分不同类型的：

类型值	图式
`response.completed`	OpenAI.ResponseCompletedEvent
`response.content_part.added`	OpenAI.ResponseContentPartAddedEvent
`response.content_part.done`	OpenAI.ResponseContentPartDoneEvent
`response.created`	OpenAI.ResponseCreatedEvent
`error`	OpenAI.ResponseErrorEvent
`response.file_search_call.completed`	OpenAI.ResponseFileSearchCallCompletedEvent
`response.file_search_call.in_progress`	OpenAI.ResponseFileSearchCallInProgressEvent
`response.file_search_call.searching`	OpenAI.ResponseFileSearchCallSearchingEvent
`response.function_call_arguments.delta`	OpenAI.ResponseFunctionCallArgumentsDeltaEvent
`response.function_call_arguments.done`	OpenAI.ResponseFunctionCallArgumentsDoneEvent
`response.in_progress`	OpenAI.ResponseInProgressEvent
`response.failed`	OpenAI.响应失败事件
`response.incomplete`	OpenAI.ResponseIncompleteEvent
`response.output_item.added`	OpenAI.ResponseOutputItemAddedEvent
`response.output_item.done`	OpenAI.ResponseOutputItemDoneEvent
`response.refusal.delta`	OpenAI.ResponseRefusalDeltaEvent
`response.refusal.done`	OpenAI.ResponseRefusalDoneEvent
`response.output_text.annotation.added`	OpenAI.ResponseTextAnnotationDeltaEvent
`response.output_text.delta`	OpenAI.ResponseTextDeltaEvent
`response.output_text.done`	OpenAI.ResponseTextDoneEvent
`response.reasoning_summary_part.added`	OpenAI.ResponseReasoningSummaryPartAddedEvent
`response.reasoning_summary_part.done`	OpenAI.ResponseReasoningSummaryPartDoneEvent
`response.reasoning_summary_text.delta`	OpenAI.ResponseReasoningSummaryTextDeltaEvent
`response.reasoning_summary_text.done`	OpenAI.ResponseReasoningSummaryTextDoneEvent
`response.web_search_call.completed`	OpenAI.ResponseWebSearchCallCompletedEvent
`response.web_search_call.in_progress`	OpenAI.ResponseWebSearchCallInProgressEvent
`response.web_search_call.searching`	OpenAI.ResponseWebSearchCallSearchingEvent
`response.image_generation_call.completed`	OpenAI.ResponseImageGenCallCompletedEvent
`response.image_generation_call.generating`	OpenAI.ResponseImageGenCallGeneratingEvent
`response.image_generation_call.in_progress`	OpenAI.ResponseImageGenCallInProgressEvent
`response.image_generation_call.partial_image`	OpenAI.ResponseImageGenCallPartialImageEvent
`response.mcp_call.arguments_delta`	OpenAI.ResponseMCPCallArgumentsDeltaEvent
`response.mcp_call.arguments_done`	OpenAI.ResponseMCPCallArgumentsDoneEvent
`response.mcp_call.completed`	OpenAI.ResponseMCPCallCompletedEvent
`response.mcp_call.failed`	OpenAI.ResponseMCPCallFailedEvent
`response.mcp_call.in_progress`	OpenAI.ResponseMCPCallInProgressEvent
`response.mcp_list_tools.completed`	OpenAI.ResponseMCPListToolsCompletedEvent
`response.mcp_list_tools.failed`	OpenAI.ResponseMCPListToolsFailedEvent
`response.mcp_list_tools.in_progress`	OpenAI.ResponseMCPListToolsInProgressEvent
`response.queued`	OpenAI.ResponseQueuedEvent
`response.reasoning.delta`	OpenAI.ResponseReasoningDeltaEvent
`response.reasoning.done`	OpenAI.ResponseReasoningDoneEvent
`response.reasoning_summary.delta`	OpenAI.ResponseReasoningSummaryDeltaEvent
`response.reasoning_summary.done`	OpenAI.ResponseReasoningSummaryDoneEvent
`response.code_interpreter_call.code.delta`	OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent
`response.code_interpreter_call.code.done`	OpenAI.ResponseCodeInterpreterCallCodeDoneEvent
`response.code_interpreter_call.completed`	OpenAI.ResponseCodeInterpreterCallCompletedEvent
`response.code_interpreter_call.in_progress`	OpenAI.ResponseCodeInterpreterCallInProgressEvent
`response.code_interpreter_call.interpreting`	OpenAI.ResponseCodeInterpreterCallInterpretingEvent

名称	类型	DESCRIPTION	必选	违约
序列号	整数	此事件的序列号。	是的
类型	OpenAI.ResponseStreamEventType		是的

OpenAI.ResponseStreamEventType

资产价值

类型字符串

价值观 response.audio.delta
response.audio.done
response.audio_transcript.delta
response.audio_transcript.done
response.code_interpreter_call.code.delta
response.code_interpreter_call.code.done
response.code_interpreter_call.completed
response.code_interpreter_call.in_progress
response.code_interpreter_call.interpreting
response.completed
response.content_part.added
response.content_part.done
response.created
error
response.file_search_call.completed
response.file_search_call.in_progress
response.file_search_call.searching
response.function_call_arguments.delta
response.function_call_arguments.done
response.in_progress
response.failed
response.incomplete
response.output_item.added
response.output_item.done
response.refusal.delta
response.refusal.done
response.output_text.annotation.added
response.output_text.delta
response.output_text.done
response.reasoning_summary_part.added
response.reasoning_summary_part.done
response.reasoning_summary_text.delta
response.reasoning_summary_text.done
response.web_search_call.completed
response.web_search_call.in_progress
response.web_search_call.searching
response.image_generation_call.completed
response.image_generation_call.generating
response.image_generation_call.in_progress
response.image_generation_call.partial_image
response.mcp_call.arguments_delta
response.mcp_call.arguments_done
response.mcp_call.completed
response.mcp_call.failed
response.mcp_call.in_progress
response.mcp_list_tools.completed
response.mcp_list_tools.failed
response.mcp_list_tools.in_progress
response.queued
response.reasoning.delta
response.reasoning.done
response.reasoning_summary.delta
response.reasoning_summary.done

OpenAI.ResponseTextAnnotationDeltaEvent

添加文本批注时发出。

名称	类型	DESCRIPTION	必选
注解	OpenAI.Annotation		是的
annotation_index	整数	已添加的批注的索引。	是的
内容索引	整数	文本批注添加到的内容部分的索引。	是的
项目编号	字符串	文本批注添加到的输出项的 ID。	是的
output_index	整数	文本批注添加到的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.output_text.annotation.added`。可能的值： `response.output_text.annotation.added`	是的

OpenAI.ResponseTextDeltaEvent

当有额外的文本增量时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	文本增量添加到的内容部分的索引。	是的
delta	字符串	添加的文本增量。	是的
项目编号	字符串	文本增量添加到的输出项的 ID。	是的
output_index	整数	文本增量添加到的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.output_text.delta`。可能的值： `response.output_text.delta`	是的

OpenAI.ResponseTextDoneEvent

在完成文本内容时发出。

名称	类型	DESCRIPTION	必选
内容索引	整数	已完成文本内容的内容部分的索引。	是的
项目编号	字符串	已完成文本内容的输出项的 ID。	是的
output_index	整数	已完成文本内容的输出项的索引。	是的
文本	字符串	最终完成的文本内容。	是的
类型	枚举	事件类型。始终为 `response.output_text.done`。可能的值： `response.output_text.done`	是的

OpenAI.ResponseTextFormatConfiguration

OpenAI.ResponseTextFormatConfiguration 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`text`	OpenAI.ResponseTextFormatConfigurationText
`json_object`	OpenAI.ResponseTextFormatConfigurationJsonObject
`json_schema`	OpenAI.ResponseTextFormatConfigurationJsonSchema

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ResponseTextFormatConfigurationType	一个对象，指定模型必须输出的格式。配置 `{ "type": "json_schema" }` 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。默认格式 `{ "type": "text" }` 没有其他选项。不建议用于 gpt-4o 和较新的模型：设置 `{ "type": "json_object" }` 可启用旧版 JSON 模式，确保模型生成的消息是有效的 JSON。使用 `json_schema` 对于支持该功能的模型而言，这是优先选择。	是的

OpenAI.ResponseTextFormatConfigurationJsonObject

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `json_object`	是的

OpenAI.ResponseTextFormatConfigurationJsonSchema

JSON 架构响应格式。用于生成结构化 JSON 响应。

名称	类型	DESCRIPTION	必选	违约
描述	字符串	响应格式用途的描述，供模型确定如何按该格式响应。	否
姓名	字符串	响应格式的名称。必须为 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。	是的
图式	OpenAI.ResponseFormatJsonSchemaSchema	响应格式的架构，描述为 JSON 架构对象。了解如何在此处生成 JSON 架构。	是的
strict	布尔	是否在生成输出时启用严格的架构遵循。如果设置为 true，则模型将始终遵循定义的确切架构在 `schema` 字段中。以下情况时仅支持 JSON 架构的子集： `strict` 是 `true`。	否	假
类型	枚举	要定义的响应格式的类型。始终为 `json_schema`。可能的值： `json_schema`	是的

OpenAI.ResponseTextFormatConfigurationText

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `text`	是的

OpenAI 响应文本格式配置类型 (OpenAI.ResponseTextFormatConfigurationType)

一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。

默认格式 { "type": "text" } 没有其他选项。

不建议用于 gpt-4o 和较新的模型：

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。对于支持它的模型，首选使用 json_schema 。

资产	价值
说明	一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。

默认格式 { "type": "text" } 没有其他选项。

不建议用于 gpt-4o 和较新的模型：

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。对于支持它的模型，首选使用 json_schema 。 | | 类型 |string | | 值 | text
json_schema
json_object |

OpenAI响应使用情况

表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌细分以及所使用的令牌总数。

名称	类型	DESCRIPTION	必选
input_tokens	整数	输入令牌数。	是的
input_tokens_details	物体	输入令牌的明细。	是的
└─ cached_tokens	整数	从缓存中检索的令牌数。	否
output_tokens	整数	输出标记数。	是的
output_tokens_details	物体	输出令牌的明细。	是的
└─ reasoning_tokens	整数	推理令牌的数量。	否
total_tokens	整数	使用的令牌总数。	是的

OpenAI.ResponseWebSearchCallCompletedEvent

注意：web_search尚未通过 Azure OpenAI 提供。

名称	类型	DESCRIPTION	必选
项目编号	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	整数	Web 搜索调用关联的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.web_search_call.completed`。可能的值： `response.web_search_call.completed`	是的

OpenAI.ResponseWebSearchCallInProgressEvent

注意：web_search尚未通过 Azure OpenAI 提供。

名称	类型	DESCRIPTION	必选
项目编号	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	整数	Web 搜索调用关联的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.web_search_call.in_progress`。可能的值： `response.web_search_call.in_progress`	是的

OpenAI.ResponseWebSearchCallSearchingEvent

注意：web_search尚未通过 Azure OpenAI 提供。

名称	类型	DESCRIPTION	必选
项目编号	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	是的
output_index	整数	Web 搜索调用关联的输出项的索引。	是的
类型	枚举	事件类型。始终为 `response.web_search_call.searching`。可能的值： `response.web_search_call.searching`	是的

OpenAI.ResponsesAssistantMessageItemParam

具有 assistant 角色的消息参数项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `assistant`。可能的值： `assistant`	是的

OpenAI.ResponsesAssistantMessageItemResource

具有 assistant 角色的消息资源项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `assistant`。可能的值： `assistant`	是的

OpenAI.ResponsesDeveloperMessageItemParam

具有 developer 角色的消息参数项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `developer`。可能的值： `developer`	是的

OpenAI.ResponsesDeveloperMessageItemResource

具有 developer 角色的消息资源项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `developer`。可能的值： `developer`	是的

OpenAI.ResponsesMessageItemParam

响应消息项，表示作为客户端请求参数提供的角色和内容。

OpenAI.ResponsesMessageItemParam 的鉴别器

此组件使用属性 role 区分不同类型的：

类型值	图式
`user`	OpenAI.ResponsesUserMessageItemParam
`system`	OpenAI.ResponsesSystemMessageItemParam
`developer`	OpenAI.ResponsesDeveloperMessageItemParam
`assistant`	OpenAI.ResponsesAssistantMessageItemParam

名称	类型	DESCRIPTION	必选	违约
角色	物体	响应消息项中有效角色的集合。	是的
类型	枚举	响应项的类型，始终为“message”。可能的值： `message`	是的

OpenAI.ResponsesMessageItemResource

响应消息资源项，表示服务响应中提供的角色和内容。

OpenAI.ResponsesMessageItemResource 的鉴别器

此组件使用属性 role 区分不同类型的：

类型值	图式
`user`	OpenAI.ResponsesUserMessageItemResource
`system`	OpenAI.ResponsesSystemMessageItemResource
`developer`	OpenAI.ResponsesDeveloperMessageItemResource
`assistant`	OpenAI.ResponsesAssistantMessageItemResource

名称	类型	DESCRIPTION	必选
角色	物体	响应消息项中有效角色的集合。	是的
地位	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	是的
类型	枚举	响应项的类型，始终为“message”。可能的值： `message`	是的

OpenAI.ResponsesMessageRole

响应消息项中有效角色的集合。

资产	价值
说明	响应消息项中有效角色的集合。
类型	字符串
价值观	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

具有 system 角色的消息参数项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `system`。可能的值： `system`	是的

OpenAI.ResponsesSystemMessageItemResource

具有 system 角色的消息资源项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `system`。可能的值： `system`	是的

OpenAI.ResponsesUserMessageItemParam

具有 user 角色的消息参数项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `user`。可能的值： `user`	是的

OpenAI.ResponsesUserMessageItemResource

具有 user 角色的消息资源项。

名称	类型	DESCRIPTION	必选	违约
内容	数组	与消息关联的内容。	是的
角色	枚举	消息的角色，始终为 `user`。可能的值： `user`	是的

OpenAI.StopConfiguration

不支持最新的推理模型 o3 和 o4-mini。

最多四个序列，其中 API 将停止生成更多令牌。返回的文本将不包含停止序列。

此架构接受以下类型之一：

字符串
数组

OpenAI.Tool

OpenAI.Tool 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`function`	OpenAI.FunctionTool
`file_search`	OpenAI.FileSearchTool
`computer_use_preview`	OpenAI.ComputerUsePreviewTool
`web_search_preview`	OpenAI.WebSearchPreviewTool
`code_interpreter`	OpenAI.CodeInterpreterTool
`image_generation`	OpenAI.ImageGenTool
`mcp`	OpenAI.MCPTool

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ToolType	可用于生成响应的工具。	是的

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject 的鉴别器

此组件使用属性 type 区分不同类型的：

类型值	图式
`file_search`	OpenAI.ToolChoiceObjectFileSearch
`computer_use_preview`	OpenAI.ToolChoiceObjectComputer
`web_search_preview`	OpenAI.ToolChoiceObjectWebSearch
`image_generation`	OpenAI.ToolChoiceObjectImageGen
`code_interpreter`	OpenAI.ToolChoiceObjectCodeInterpreter
`mcp`	OpenAI.ToolChoiceObjectMCP
`function`	OpenAI.ToolChoiceObjectFunction

名称	类型	DESCRIPTION	必选	违约
类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。	是的

OpenAI.ToolChoiceObjectCodeInterpreter

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `code_interpreter`	是的

OpenAI.ToolChoiceObjectComputer

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `computer_use_preview`	是的

OpenAI.ToolChoiceObjectFileSearch

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `file_search`	是的

OpenAI.ToolChoiceObjectFunction

使用此选项强制模型调用特定函数。

名称	类型	DESCRIPTION	必选	违约
姓名	字符串	要调用的函数的名称。	是的
类型	枚举	对于函数调用，类型始终为`function`。可能的值： `function`	是的

OpenAI.ToolChoiceObjectImageGen

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `image_generation`	是的

OpenAI.ToolChoiceObjectMCP

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `mcp`	是的

OpenAI.ToolChoiceObjectType

指示模型应使用内置工具生成响应。

资产	价值
说明	指示模型应使用内置工具生成响应。
类型	字符串
价值观	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

注意：web_search尚未通过 Azure OpenAI 提供。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `web_search_preview`	是的

OpenAI.ToolChoiceOptions

控制模型调用哪些工具（如有）。

none 表示模型不会调用任何工具，而是生成消息。

auto 表示模型可以在生成消息和调用一个或多个工具之间进行选择。

required 表示模型必须调用一个或多个工具。

资产	价值
说明	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。
类型	字符串
价值观	`none` `auto` `required`

OpenAI.ToolType

可用于生成响应的工具。

资产	价值
说明	可用于生成响应的工具。
类型	字符串
价值观	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation`

OpenAI.TranscriptionAudioResponseFormat

参考： OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

资产	价值
类型	字符串
价值观	`logprobs`

OpenAI.TranscriptionSegment

名称	类型	DESCRIPTION	必选
avg_logprob	数字	段的平均 logprob。如果该值低于 -1，请认为对数概率计算失败。	是的
压缩比	数字	段的压缩比率。如果该值大于 2.4，请考虑压缩失败。	是的
end	数字	段的结束时间（以秒为单位）。	是的
ID	整数	段的唯一标识符。	是的
no_speech_prob	数字	段中没有语音的概率。如果该值高于 1.0 且 `avg_logprob` 低于 -1，请考虑此段保持静默。	是的
seek	整数	查找段的偏移量。	是的
start	数字	段的开始时间（以秒为单位）。	是的
温度	数字	用于生成段的温度参数。	是的
文本	字符串	段的文本内容。	是的
tokens	数组	文本内容的令牌 ID 数组。	是的

OpenAI.TranscriptionWord

名称	类型	DESCRIPTION	必选
end	数字	单词的结束时间（以秒为单位）。	是的
start	数字	单词的开始时间（以秒为单位）。	是的
word	字符串	单词的文本内容。	是的

OpenAI.VadConfig

名称	类型	DESCRIPTION	必选	违约
prefix_padding_ms	整数	VAD 检测到语音之前要包括的音频量（按毫秒计）。	否	300
静默时长_毫秒	整数	用于检测语音停止的沉默持续时间（以毫秒为单位）。使用较短的值，模型将更快地响应，但可能会在用户短暂暂停时突然打断。	否	200
阈值	数字	用于语音活动检测的敏感度阈值（0.0 到 1.0）。 A 更高的阈值将需要更响亮的音频来激活模型，并且因此，在嘈杂环境中性能可能更好。	否	0.5
类型	枚举	必须设置为 `server_vad` ，以便使用服务器端 VAD 启用手动分块。可能的值： `server_vad`	是的

OpenAI.VectorStoreFileAttributes

按 16 个成组的可附加到对象的键值对。这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符、布尔值或数字的字符串。

类型：对象

OpenAI.VoiceIdsShared

资产	价值
类型	字符串
价值观	`alloy` `ash` `ballad` `coral` `echo` `fable` `onyx` `nova` `sage` `shimmer` `verse`

OpenAI.WebSearchPreviewTool

注意：web_search尚未通过 Azure OpenAI 提供。

名称	类型	DESCRIPTION	必选
search_context_size	枚举	用于搜索的上下文窗口空间量的高级指南。 `low`、`medium` 或 `high` 之一。 `medium` 是默认值。可能的值：`low`、、 `mediumhigh`	否
类型	枚举	Web 搜索工具的类型。 `web_search_preview`或`web_search_preview_2025_03_11`之一。可能的值： `web_search_preview`	是的
用户位置	物体		否
└─ 类型	OpenAI.LocationType		否

OpenAI.WebSearchToolCallItemParam

Web 搜索工具调用的结果。

名称	类型	DESCRIPTION	必选	违约
类型	枚举	可能的值： `web_search_call`	是的

OpenAI.WebSearchToolCallItemResource

Web 搜索工具调用的结果。

名称	类型	DESCRIPTION	必选	违约
地位	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	是的
类型	枚举	可能的值： `web_search_call`	是的

PineconeChatDataSource

名称	类型	DESCRIPTION	必选	违约
参数	物体	用于控制 Pinecone 数据源使用情况的参数信息。	是的
└─ allow_partial_result	布尔	如果设置为 true，系统将允许使用部分搜索结果，并且请求将失败（如果全部）部分查询失败。如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。	否	假
~~ 身份验证	物体		否
└─ key	字符串		否
└─ 类型	枚举	可能的值： `api_key`	否
└─ embedding_dependency	物体	用作包含数据源的嵌入资源的数据向量化源的表示形式。	否
└─ 类型	AzureChatDataSourceVectorizationSourceType	具体矢量化源的区分标识符。	否
~~ 环境	字符串	要用于 Pinecone 的环境名称。	否
└─ fields_mapping	物体	要应用于 Pinecone 数据源使用的数据的字段映射。请注意，Pinecone 需要内容字段映射。	否
└─ content_fields	数组		否
└─ content_fields_separator	字符串		否
└─ filepath_field	字符串		否
└─ title_field	字符串		否
└─ url_field	字符串		否
└─ in_scope	布尔	是否应将查询限制为使用索引数据。	否
└─ include_contexts	数组	响应中要包含的输出上下文属性。默认情况下，会请求引用和意向。	否	['引文', '意图']
└─ index_name	字符串	要使用的 Pinecone 数据库索引的名称。	否
└─ max_search_queries	整数	应发送到搜索提供程序的单个用户消息的最大重写查询数。默认情况下，系统将进行自动确定。	否
~~ 严格性	整数	搜索相关性筛选的已配置严格性。更高的严格性会增加精度，但降低答案的召回率。	否
└─ top_n_documents	整数	用于查询中展示的已配置文档数量。	否
类型	枚举	区分的类型标识符，始终为“pinecone”。可能的值： `pinecone`	是的

质量

资产	价值
类型	字符串
价值观	`high` `low`

响应方式

希望模型生成的输出类型。大多数模型都能够生成文本，这是默认设置：

["text"]

gpt-4o-audio-preview 模型还可用于生成音频。若要请求此模型生成文本和音频响应，你可以使用：

["text", "audio"]

数组：字符串

语音生成响应格式

文本转语音支持的音频输出格式。

VideoGeneration

名称	类型	DESCRIPTION	必选
created_at	整数	创建视频生成的时间。	是的
身高	整数	视频的高度。	是的
ID	字符串	视频生成的 ID。	是的
作业编号	字符串	此视频的视频生成作业的 ID。	是的
n_秒	整数	视频生成持续时间。	是的
物体	枚举	可能的值： `video.generation`	是的
prompt	字符串	此视频生成的提示。	是的
width	整数	视频的宽度。	是的

VideoGenerationJob

名称	类型	DESCRIPTION	必选
created_at	整数	创建作业的时间。	是的
expires_at	整数	从服务器中删除作业的 Unix 时间戳（以秒为单位）。应在此日期之前存储作业的视频内容和元数据，以避免数据丢失。默认范围和最大范围均为作业完成时间戳后的 24 小时。	否
失败原因	字符串（请参阅下面的有效模型）		否
finished_at	整数	作业完成所有视频生成的时间。	否
代数	数组	为此作业生成的视频。该数量取决于给定的 n_variants 和生成的创建成功率。	否
身高	整数	视频的高度。	是的
ID	字符串	作业的 ID。	是的
模型	字符串	要用于此视频生成作业的部署的名称。	是的
n_秒	整数	视频生成作业的持续时间。	是的
n_variants	整数	要作为此视频生成作业的变体创建的视频数量。	是的
物体	枚举	可能的值： `video.generation.job`	是的
prompt	字符串	此视频生成作业的提示。	是的
地位	物体		是的
width	整数	视频的高度。	是的

VideoGenerationJobList

名称	类型	DESCRIPTION	必选
数据	数组		是的
first_id	字符串		否
has_more	布尔		是的
last_id	字符串		否
物体	枚举	可能的值： `list`	是的

后续步骤

了解模型和微调与 REST API。详细了解支持 Azure OpenAI 的基础模型。