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

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

2025-08-29

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

数据平面推理

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

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

创建演讲

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

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

Content-Type：multipart/form-data

Name	类型	Description	Required	Default
输入	字符串	要为其生成音频的文本。最大长度为 4096 个字符。	Yes
instructions	字符串	通过额外指令控制生成音频的音质。不适用于 `tts-1` 或 `tts-1-hd`.	No
模型	字符串	要用于此文本转语音请求的模型。	Yes
response_format	对象	文本转语音支持的音频输出格式。	No
speed	number	生成音频的语速。值在 0.25 到 4.0 的范围内有效，默认值为 1.0，对应于更快的语音。	No	1
stream_format	枚举	要在其中流式传输音频的格式。支持的格式是 `sse` 和 `audio`。 `sse` `tts-1`不支持或 `tts-1-hd`。可能的值： `sseaudio`	No
voice	对象		Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/octet-stream	字符串

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

从提供的文本合成音频。

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 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

Content-Type：multipart/form-data

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

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureAudioTranscriptionResponse
text/plain	字符串

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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

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/audio/translations?api-version=preview

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

Content-Type：multipart/form-data

Name	类型	Description	Required	Default
文件	字符串		Yes
filename	字符串	要与音频数据关联的可选文件名或描述性标识符	No
模型	字符串	用于此翻译请求的模型。	No
提示	字符串	用于指导模型风格或继续之前的音频片段的可选文本。提示应为英语。	No
response_format	对象		No
temperature	number	采样温度，介于 0 和 1 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性如果设置为 0，则模型将使用对数概率自动增加温度，直到达到某些阈值。	No	0

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureAudioTranslationResponse
text/plain	字符串

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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

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

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

响应：状态代码：200

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

创建 chatcompletion

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

创建聊天完成。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureCreateChatCompletionResponse
text/event-stream	AzureCreateChatCompletionStreamResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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

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/embeddings?api-version=preview

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.CreateEmbeddingResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

返回给定提示的嵌入。

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
    }
  }
}

列出 evals

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

列出针对项目的评估。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
after	查询	No	字符串	上一个分页请求中最后一个评估的标识符。
limit	查询	No	整数	单个分页响应中要返回的疏散次数限制。
顺序	查询	No	字符串可能的值： `ascdesc`	按时间戳对评估进行排序。用于 `asc` 升序或 `desc` 降序。
按...排序	查询	No	字符串可能的值： `created_atupdated_at`	可以通过创建时间或上次更新时间对 Evals 进行排序。使用 `created_at` 用于创建时间或 `updated_at` 上次更新时间。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.EvalList

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Createeval

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

创建可用于测试模型性能的评估的结构。

评估是一组测试条件和数据源。创建评估后，可以在不同的模型和模型参数上运行它。我们支持多种类型的评分程序和数据源。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
数据源配置	对象		Yes
└─ 类型	OpenAI.EvalDataSourceConfigType		No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串	评估的名称。	No
状态码	枚举	可能的值：`201`	Yes
测试标准	数组	此组中所有评估运行的评分程序列表。分级者可以使用双大括号表示法引用数据源中的变量，例如 `{{item.variable_name}}`。若要引用模型的输出，请使用 `sample` 命名空间（即， `{{sample.output_text}}`）。	Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.Eval

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

获取 eval

GET {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

按其 ID 检索评估。按其 ID 检索评估。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.Eval

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

更新 eval

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

更新指定评估的 select、可变属性。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required	Default
元数据	OpenAI.MetadataPropertyForRequest	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串		No

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.Eval

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

删除 eval

DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=preview

删除指定的计算。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	对象

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

获取 eval 运行

GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

检索指定计算的运行列表。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串
after	查询	No	字符串
limit	查询	No	整数
顺序	查询	No	字符串可能的值： `ascdesc`
状态	查询	No	字符串可能的值：`queued`、、`in_progresscompleted`、`canceled`、`failed`

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.EvalRunList

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建 eval 运行

POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=preview

创建新的评估运行，从评分过程开始。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
数据源	对象		Yes
└─ 类型	OpenAI.EvalRunDataSourceType		No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串	运行的名称。	No

Responses

状态代码： 201

说明：请求已成功，因此创建了一个新资源。

Content-Type	Type	Description
application/json	OpenAI.EvalRun

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

获取 eval 运行

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

检索按其 ID 运行的特定评估。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串
run_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.EvalRun

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

取消 eval 运行

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

取消按 ID 运行的特定评估。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串
run_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.EvalRun

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Deleteevalrun

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=preview

删除按 ID 运行的特定评估。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串
run_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	对象

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

获取 eval 运行输出项

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=preview

获取指定评估运行的输出项的列表。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串
run_id	路径	Yes	字符串
after	查询	No	字符串
limit	查询	No	整数
状态	查询	No	字符串可能的值： `failpass`
顺序	查询	No	字符串可能的值： `ascdesc`

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.EvalRunOutputItemList

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

获取 eval 运行输出项

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=preview

从计算中按 ID 检索特定输出项。

注意：此 Azure OpenAI API 处于预览状态，可能会更改。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
aoai-evals	标头	Yes	字符串可能的值：`preview`	允许访问 AOAI Evals（预览功能）。此功能要求将“aoai-evals”标头设置为“preview”。
eval_id	路径	Yes	字符串
run_id	路径	Yes	字符串
output_item_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.EvalRunOutputItem

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建文件

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

Content-Type：multipart/form-data

Name	类型	Description	Required
过期时间	对象		Yes
~~ 定位点	AzureFileExpiryAnchor		No
~~ 秒	整数		No
文件	字符串		Yes
purpose	枚举	上传文件的预期用途。其中一个： - `assistants`：在助手 API 中使用 - `batch`：在 Batch API 中使用 - `fine-tune`：用于微调 - `evals`：用于 eval 数据集可能的值：`assistants`、`batch`、`fine-tune`、`evals`	Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureOpenAIFile

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

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

列出文件

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
purpose	查询	No	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureListFilesResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

检索文件

GET {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
file_id	路径	Yes	字符串	要用于此请求的文件的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureOpenAIFile

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

删除文件

DELETE {endpoint}/openai/v1/files/{file_id}?api-version=preview

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
file_id	路径	Yes	字符串	要用于此请求的文件的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.DeleteFileResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

下载文件

GET {endpoint}/openai/v1/files/{file_id}/content?api-version=preview

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
file_id	路径	Yes	字符串	要用于此请求的文件的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/octet-stream	字符串

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Rungrader

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=preview

运行分级程序。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
年级	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	Yes
calculate_output	字符串	用于基于评分器结果计算输出的公式。	No
evaluation_metric	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	No
~~ 评分员	对象		No
image_tag	字符串	用于 python 脚本的图像标记。	No
└─ 输入	数组	输入文本。这可能包括模板字符串。	No
└─ 模型	字符串	要用于评估的模型。	No
└─ 名称	字符串	评分程序的名称。	No
~~作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	No
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	No
~~ 参考	字符串	作为评分参照的文本。	No
采样参数 (sampling_params)		模型的采样参数。	No
└─ 来源	字符串	python 脚本的源代码。	No
└─ 类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	No
项		提供给评分器的数据集项。这将用于填充命名空间 `item` 。	No
model_sample	字符串	要评估的模型示例。此值将用于填充命名空间 `sample` 。 `output_json`如果模型示例是一个变量，则会填充变量有效的 JSON 字符串。	Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.RunGraderResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

验证分级程序

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=preview

验证分级程序。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
年级	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	Yes
calculate_output	字符串	用于基于评分器结果计算输出的公式。	No
evaluation_metric	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	No
~~ 评分员	对象		No
image_tag	字符串	用于 python 脚本的图像标记。	No
└─ 输入	数组	输入文本。这可能包括模板字符串。	No
└─ 模型	字符串	要用于评估的模型。	No
└─ 名称	字符串	评分程序的名称。	No
~~作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	No
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	No
~~ 参考	字符串	作为评分参照的文本。	No
采样参数 (sampling_params)		模型的采样参数。	No
└─ 来源	字符串	python 脚本的源代码。	No
└─ 类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	No

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ValidateGraderResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建微调作业

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

创建微调作业，该作业开始从给定数据集创建新模型的过程。

响应包括排队作业的详细信息，包括作业状态以及完成后微调的模型的名称。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required	Default
超参数	对象	用于微调作业的超参数。此值现在已弃用 `method`，应该在参数下 `method` 传入。	No
batch_size	枚举	可能的值：`auto`	No
learning_rate_multiplier	枚举	可能的值：`auto`	No
n_epochs	枚举	可能的值：`auto`	No
整合	数组	要为微调作业启用的集成列表。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
方法	OpenAI.FineTuneMethod	用于微调的方法。	No
模型	字符串（请参阅下面的有效模型）	要微调的模型的名称。	Yes
seed	整数	种子控制作业的可重现性。传入相同的种子和作业参数应会产生相同的结果，但在极少数情况下可能会有差异。如果未指定种子，则会为你生成一个种子。	No
suffix	字符串	最多 64 个字符的字符串，将添加到微调的模型名称中。例如，一个 `suffix` “custom-model-name”将生成一个模型名称，如下所示 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`。	No	None
训练文件	字符串	包含训练数据的上传文件的 ID。数据集的格式必须为 JSONL 文件。此外，还必须使用目的 `fine-tune`上传文件。文件的内容应有所不同，具体取决于模型是否使用聊天、完成格式，或者微调方法是否使用首选项格式。	Yes
验证文件	字符串	包含验证数据的上传文件的 ID。如果提供此文件，则数据用于生成验证在微调期间定期指标。可以在其中查看这些指标微调结果文件。训练文件和验证文件中不应存在相同的数据。数据集的格式必须为 JSONL 文件。必须按照目的 `fine-tune`上传文件。	No

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

列出分页微调作业

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

列出组织的微调作业

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
after	查询	No	字符串	上一个分页请求中最后一个作业的标识符。
limit	查询	No	整数	要检索的微调作业数。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ListPaginatedFineTuningJobsResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

检索微调作业

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=preview

获取有关微调作业的信息。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
微调任务ID (fine_tuning_job_id)	路径	Yes	字符串	微调作业的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

取消微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=preview

立即取消微调作业。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
微调任务ID (fine_tuning_job_id)	路径	Yes	字符串	要取消的微调作业的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

列出微调作业检查点

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=preview

列出微调作业的检查点。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
微调任务ID (fine_tuning_job_id)	路径	Yes	字符串	要为其获取检查点的微调作业的 ID。
after	查询	No	字符串	上一个分页请求中最后一个检查点 ID 的标识符。
limit	查询	No	整数	要检索的检查点数。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ListFineTuningJobCheckpointsResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

列出微调事件

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=preview

获取微调作业的状态更新。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
微调任务ID (fine_tuning_job_id)	路径	Yes	字符串	要为其获取事件的微调作业的 ID。
after	查询	No	字符串	上一个分页请求中最后一个事件的标识符。
limit	查询	No	整数	要检索的事件数。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ListFineTuningJobEventsResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

暂停微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=preview

暂停微调作业。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
微调任务ID (fine_tuning_job_id)	路径	Yes	字符串	要暂停的微调作业的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

恢复微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=preview

恢复暂停的微调作业。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
微调任务ID (fine_tuning_job_id)	路径	Yes	字符串	要恢复的微调作业的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.FineTuningJob

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建图像编辑

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

Content-Type：multipart/form-data

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

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureImagesResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Createimage

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureImagesResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

根据提示创建图像。

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
          }
        }
      }
    ]
  }
}

列出模型

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

列出当前可用的模型，并提供有关每个模型的基本信息，例如所有者和可用性。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ListModelsResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

检索模型

GET {endpoint}/openai/v1/models/{model}?api-version=preview

检索模型实例，提供有关模型的基本信息，例如所有者和权限。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
模型	路径	Yes	字符串	要用于此请求的模型的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.Model

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建响应

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

创建模型响应。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureResponse
text/event-stream	OpenAI.ResponseStreamEvent

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

Example

创建模型响应

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

获取响应

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

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

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
response_id	路径	Yes	字符串
include[]	查询	No	数组

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	AzureResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

删除响应

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

按 ID 删除响应。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
response_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	对象

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

列出输入项

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

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

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ResponseItemList

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

列出矢量存储

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

返回矢量存储列表。

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ListVectorStoresResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建矢量存储

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

创建矢量存储。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
chunking_strategy	对象	默认策略。此策略目前使用 `max_chunk_size_tokens` 的 `800` 和 `chunk_overlap_tokens` 的 `400`。	No
~~ 静态	OpenAI.StaticChunkingStrategy		No
└─ 类型	枚举	始终为 `static`。可能的值：`static`	No
过期时间	OpenAI.VectorStoreExpirationAfter	矢量存储过期策略。	No
file_ids	数组	矢量存储应使用的文件 ID 列表。适用于可以访问文件的 `file_search` 等工具。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串	矢量存储的名称。	No

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

Examples

找不到示例文件：./examples/vector_stores.json

获取矢量存储

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

检索矢量存储。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	要检索的矢量存储的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

修改矢量存储

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

修改矢量存储。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	要修改的矢量存储的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
过期时间	对象	矢量存储过期策略。	No
~~ 定位点	枚举	定位点时间戳，在此时间之后会应用过期策略。支持的定位点：`last_active_at`。可能的值：`last_active_at`	No
~~ 天	整数	在定位点时间之后，矢量存储将过期的天数。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串	矢量存储的名称。	No

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

删除矢量存储

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}?api-version=preview

删除矢量存储。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	要删除的矢量存储的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.DeleteVectorStoreResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建矢量存储文件批处理

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches?api-version=preview

创建矢量存储文件批处理。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	要为其创建文件批处理的向量存储的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
属性	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为最大值的字符串 512 个字符、布尔值或数字的字符串。	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	用于对文件进行分块的分块策略。如果未设置，则将使用 `auto` 策略。	No
file_ids	数组	矢量存储应使用的文件 ID 列表。适用于可以访问文件的 `file_search` 等工具。	Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileBatchObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

获取矢量存储文件批处理

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=preview

检索矢量存储文件批处理。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	文件批处理所属的矢量存储的 ID。
batch_id	路径	Yes	字符串	正在检索的文件批处理的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileBatchObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

取消矢量存储文件批处理

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=preview

取消矢量存储文件批处理。这会尝试尽快取消此批处理中的文件处理。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	文件批处理所属的矢量存储的 ID。
batch_id	路径	Yes	字符串	要取消的文件批处理的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileBatchObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

列出矢量存储批处理中的文件

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=preview

返回批处理中的矢量存储文件列表。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	文件批处理所属的矢量存储的 ID。
batch_id	路径	Yes	字符串	文件所属的文件批处理的 ID。
limit	查询	No	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	No	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	No	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	No	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
筛选器	查询	No		按文件状态进行筛选。 `in_progress`, `completed`, `failed`, `cancelled`之一。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ListVectorStoreFilesResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

列出矢量存储文件

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

返回矢量存储文件列表。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	文件所属的矢量存储的 ID。
limit	查询	No	整数	要返回的对象数的限制。限制可以介于 1 和 100 之间，以及默认值为 20。
顺序	查询	No	字符串可能的值： `ascdesc`	按 `created_at` 对象的时间戳排序顺序。升序为 `asc`，降序为 `desc` 。
after	查询	No	字符串	用于分页的游标。 `after` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 after=obj_foo，以便提取列表的下一页。
before	查询	No	字符串	用于分页的游标。 `before` 是一个对象 ID，用于定义你在列表中的位置。例如，如果发出列表请求并接收 100 个对象，以 obj_foo 结尾，则后续调用可以包括 before=obj_foo，以便提取列表中的上一页内容。
筛选器	查询	No		按文件状态进行筛选。 `in_progress`, `completed`, `failed`, `cancelled`之一。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.ListVectorStoreFilesResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

创建矢量存储文件

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files?api-version=preview

通过将文件附加到矢量存储来创建矢量存储文件。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	要为其创建文件的矢量存储的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required
属性	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为最大值的字符串 512 个字符、布尔值或数字的字符串。	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	用于对文件进行分块的分块策略。如果未设置，则将使用 `auto` 策略。	No
file_id	字符串	矢量存储应使用的文件 ID。适用于可以访问文件的 `file_search` 等工具。	Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

获取矢量存储文件

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

检索矢量存储文件。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	文件所属的矢量存储的 ID。
file_id	路径	Yes	字符串	要检索的文件的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

更新矢量存储文件属性

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串
file_id	路径	Yes	字符串

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required	Default
属性	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为最大值的字符串 512 个字符、布尔值或数字的字符串。	Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.VectorStoreFileObject

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

删除矢量存储文件

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}?api-version=preview

删除矢量存储文件。这会从向量存储中删除文件，但不会删除文件本身。若要删除该文件，请使用删除文件终结点。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
vector_store_id	路径	Yes	字符串	文件所属的矢量存储的 ID。
file_id	路径	Yes	字符串	要删除的文件的 ID。

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	OpenAI.DeleteVectorStoreFileResponse

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureErrorResponse

视频生成任务 - 创建

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

创建新的视频生成作业。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

Name	类型	Description	Required	Default
height	整数	视频的高度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes
模型	字符串	要用于此请求的部署的名称。	Yes
n_seconds	整数	视频生成作业的持续时间。必须介于 1 到 20 秒之间。	No	5
n_variants	整数	要作为此作业的变体创建的视频数量。必须介于 1 和 5 之间。较小的尺寸允许更多变体。	No	1
提示	字符串	此视频生成作业的提示。	Yes
width	整数	视频的宽度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes

请求主体

Content-Type：multipart/form-data

Name	类型	Description	Required	Default
files	数组		Yes
height	整数	视频的高度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes
inpaint_items	数组	此视频生成作业的可选内插项目。	No
模型	字符串	要用于此请求的部署的名称。	Yes
n_seconds	整数	视频生成作业的持续时间。必须介于 1 到 20 秒之间。	No	5
n_variants	整数	要作为此作业的变体创建的视频数量。必须介于 1 和 5 之间。较小的尺寸允许更多变体。	No	1
提示	字符串	此视频生成作业的提示。	Yes
width	整数	视频的宽度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	VideoGenerationJob

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

找不到示例文件：./examples/create_video_generation_job_simple.json

视频生成作业 - 列表

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

列出视频生成作业。

URI 参数

Name	In	Required	类型	Description
终结点	路径	Yes	字符串 url	支持的 Azure OpenAI 终结点（协议和主机名，例如：`https://aoairesource.openai.azure.com`。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	No		要用于此请求的显式 Azure AI Foundry 模型 API 版本。 `v1` 如果未另行指定，
before	查询	No	字符串
after	查询	No	字符串
limit	查询	Yes	整数
statuses	查询	No	数组

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	VideoGenerationJobList

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

找不到示例文件：./examples/get_video_generation_job_list.json

视频生成作业 - 获取

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

检索视频生成作业的属性。

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	VideoGenerationJob

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

找不到示例文件：./examples/get_video_generation_job.json

视频生成作业 - 删除

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

删除视频生成作业。

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 204

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

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

视频生成 - 获取

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

按 ID 检索视频生成。

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
application/json	VideoGeneration

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Examples

找不到示例文件：./examples/get_video_generation.json

视频生成 - 检索缩略图

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

检索生成的视频内容的缩略图。

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
image/jpg	字符串

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

视频代系 - 检索视频内容

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

检索生成的视频内容。

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

Content-Type	Type	Description
video/mp4	字符串

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

视频代系 - 仅检索视频内容标头

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

检索生成的视频内容的标头。

URI 参数

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

请求标头

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

Name	Required	类型	Description
Authorization	True	字符串	示例：`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-key	True	字符串	在此处提供 Azure OpenAI API 密钥

Responses

状态代码：200

说明：请求已成功。

状态代码：默认值

说明：意外的错误响应。

Content-Type	Type	Description
application/json	AzureOpenAIVideoGenerationErrorResponse

Components

AudioTaskLabel

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

Property	Value
Description	定义可用于音频操作响应的可能描述符。
Type	字符串
Values	`transcribe` `translate`

AudioTranslationSegment

有关已转换音频数据的单个段的扩展信息。段通常表示大约 5-10 秒的语音。段边界通常发生在单词之间，但不一定是句子。

Name	类型	Description	Required
avg_logprob	number	与此音频段关联的平均对数概率。	Yes
compression_ratio	number	此音频段的压缩比率。	Yes
end	number	此段相对于已翻译音频的开头结束的时间。	Yes
id	整数	转换中此段的从 0 开始的索引。	Yes
no_speech_prob	number	此音频段中没有语音检测的概率。	Yes
seek	整数	与此音频段的处理关联的查找位置。查找位置表示为数百秒。模型可能处理单个查找位置中的多个段，因此，虽然查找位置永远不会表示比段的开始时间晚，段的开始时间可能比段的关联搜寻位置。	Yes
start	number	此段相对于已翻译音频的开头开始的时间。	Yes
temperature	number	与此音频段关联的温度分数。	Yes
文本消息	字符串	属于此音频段的已翻译文本。	Yes
tokens	数组	与此音频段中翻译的文本匹配的令牌 ID。	Yes

AzureAIFoundryModelsApiVersion

Property	Value
Type	字符串
Values	`v1` `preview`

AzureAudioTranscriptionResponse

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

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

AzureAudioTranslationResponse

将语音翻译为书面文本的作的结果信息。

Name	类型	Description	Required
duration	number	处理以生成随附翻译信息的音频的总持续时间。	No
语言	字符串	在翻译的音频数据中检测到的口语。这表示为双字母 ISO-639-1 语言代码，如“en”或“fr”。	No
segments	数组	有关每个已处理音频段的计时、概率和其他详细信息的信息集合。	No
任务	对象	定义可用于音频操作响应的可能描述符。	No
文本消息	字符串	提供的音频数据的翻译文本。	Yes

AzureChatCompletionResponseMessage

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

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

AzureChatCompletionStreamResponseDelta

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

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

AzureChatDataSource

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

AzureChatDataSource 的鉴别器

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

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

Name	类型	Description	Required	Default
类型	对象		Yes

AzureChatDataSourceAccessTokenAuthenticationOptions

Name	类型	Description	Required	Default
access_token	字符串		Yes
类型	枚举	可能的值：`access_token`	Yes

AzureChatDataSourceApiKeyAuthenticationOptions

Name	类型	Description	Required	Default
关键值	字符串		Yes
类型	枚举	可能的值：`api_key`	Yes

AzureChatDataSourceAuthenticationOptions

AzureChatDataSourceAuthenticationOptions 的鉴别器

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

类型值	Schema
`system_assigned_managed_identity`	AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions
`user_assigned_managed_identity`	AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions
`access_token`	AzureChatDataSourceAccessTokenAuthenticationOptions
`connection_string`	AzureChatDataSourceConnectionStringAuthenticationOptions
`key_and_key_id`	AzureChatDataSourceKeyAndKeyIdAuthenticationOptions
`encoded_api_key`	AzureChatDataSourceEncodedApiKeyAuthenticationOptions
`username_and_password`	AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name	类型	Description	Required	Default
类型	AzureChatDataSourceAuthenticationOptionsType		Yes

AzureChatDataSourceAuthenticationOptionsType

Property	Value
Type	字符串
Values	`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

Name	类型	Description	Required	Default
connection_string	字符串		Yes
类型	枚举	可能的值：`connection_string`	Yes

AzureChatDataSourceDeploymentNameVectorizationSource

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

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

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

Name	类型	Description	Required	Default
encoded_api_key	字符串		Yes
类型	枚举	可能的值：`encoded_api_key`	Yes

AzureChatDataSourceEndpointVectorizationSource

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

Name	类型	Description	Required
身份验证	对象		Yes
access_token（访问令牌）	字符串		No
~~ 键	字符串		No
└─ 类型	枚举	可能的值：`access_token`	No
dimensions	整数	请求嵌入时所需的维度数量。仅在 text-embedding-3 和更高版本的模型中受支持。	No
终结点	字符串	指定应从中检索嵌入的资源终结点 URL。它的格式应为： https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. 不允许 api-version 查询参数。	Yes
类型	枚举	类型标识符，对于此矢量化源类型始终为“endpoint”。可能的值：`endpoint`	Yes

AzureChatDataSourceIntegratedVectorizationSource

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

Name	类型	Description	Required	Default
类型	枚举	类型标识符，对于此矢量化源类型始终为“integrated”。可能的值：`integrated`	Yes

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

Name	类型	Description	Required
关键值	字符串		Yes
key_id	字符串		Yes
类型	枚举	可能的值：`key_and_key_id`	Yes

AzureChatDataSourceModelIdVectorizationSource

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

Name	类型	Description	Required	Default
model_id	字符串	用于矢量化的嵌入模型的生成 ID。	Yes
类型	枚举	此矢量化源类型的类型标识符，始终为“model_id”。可能的值：`model_id`	Yes

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

Name	类型	Description	Required	Default
类型	枚举	可能的值：`system_assigned_managed_identity`	Yes

AzureChatDataSourceType

Property	Value
Type	字符串
Values	`azure_search` `azure_cosmos_db` `elasticsearch` `pinecone` `mongo_db`

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

Name	类型	Description	Required	Default
managed_identity_resource_id	字符串		Yes
类型	枚举	可能的值：`user_assigned_managed_identity`	Yes

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

Name	类型	Description	Required
密码	字符串		Yes
类型	枚举	可能的值：`username_and_password`	Yes
用户名	字符串		Yes

AzureChatDataSourceVectorizationSource

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

AzureChatDataSourceVectorizationSource 的鉴别器

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

类型值	Schema
`deployment_name`	AzureChatDataSourceDeploymentNameVectorizationSource
`integrated`	AzureChatDataSourceIntegratedVectorizationSource
`model_id`	AzureChatDataSourceModelIdVectorizationSource

Name	类型	Description	Required	Default
类型	对象		Yes

AzureChatDataSourceVectorizationSourceType

Property	Value
Type	字符串
Values	`endpoint` `deployment_name` `model_id` `integrated`

AzureChatMessageContext

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

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

AzureContentFilterBlocklistResult

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

Name	类型	Description	Required	Default
details	数组	单个阻止列表 ID 对以及它们是否导致筛选操作。	No
filtered	boolean	一个值，该值指示任何详细阻止列表是否触发了过滤操作。	Yes

AzureContentFilterCompletionTextSpan

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

Name	类型	Description	Required	Default
completion_end_offset	整数	从跨度中排除的第一个 UTF32 码位元素的偏移量。对于空跨度，此字段始终等于 completion_start_offset。对于非空范围，此字段始终大于completion_start_offset。	Yes
completion_start_offset	整数	开始跨度的 UTF32 码位元素的偏移量。	Yes

AzureContentFilterCompletionTextSpanDetectionResult

Name	类型	Description	Required
details	数组	有关检测到的完成文本范围的详细信息。	Yes
detected	boolean	是否在内容中检测到标记的内容类别。	Yes
filtered	boolean	内容检测是否导致内容筛选操作。	Yes

AzureContentFilterCustomTopicResult

已配置的自定义主题的 true/false 筛选结果的集合。

Name	类型	Description	Required	Default
details	数组	各个主题 ID 的对以及是否检测到它们。	No
filtered	boolean	一个值，该值指示任何详细主题是否导致筛选作。	Yes

AzureContentFilterDetectionResult

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

Name	类型	Description	Required	Default
detected	boolean	是否在内容中检测到标记的内容类别。	Yes
filtered	boolean	内容检测是否导致内容筛选操作。	Yes

AzureContentFilterImagePromptResults

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

Name	类型	Description	Required
custom_blocklists	对象	配置的自定义阻止列表的 true/false 筛选结果的集合。	No
~~ 详细信息	数组	单个阻止列表 ID 对以及它们是否导致筛选操作。	No
~~ 已筛选	boolean	一个值，该值指示任何详细阻止列表是否触发了过滤操作。	No
custom_topics	对象	已配置的自定义主题的 true/false 筛选结果的集合。	No
~~ 详细信息	数组	各个主题 ID 的对以及是否检测到它们。	No
~~ 已筛选	boolean	一个值，该值指示任何详细主题是否导致筛选作。	No
jailbreak	对象	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	Yes
检测到	boolean	是否在内容中检测到标记的内容类别。	No
~~ 已筛选	boolean	内容检测是否导致内容筛选操作。	No
profanity	对象	一个标记的内容筛选结果项，用于指示是否检测到内容以及内容是否经过筛选。	No
检测到	boolean	是否在内容中检测到标记的内容类别。	No
~~ 已筛选	boolean	内容检测是否导致内容筛选操作。	No

AzureContentFilterImageResponseResults

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

Name	类型	Description	Required
hate	对象	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	No
~~ 已筛选	boolean	内容严重性是否导致进行内容筛选	No
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	No
self_harm	对象	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	No
~~ 已筛选	boolean	内容严重性是否导致进行内容筛选	No
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	No
sexual	对象	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	No
~~ 已筛选	boolean	内容严重性是否导致进行内容筛选	No
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	No
violence	对象	一个标记的内容筛选结果项，用于指示内容是否被筛选以及内容的定性严重性级别，根据类别的内容筛选器配置进行评估。	No
~~ 已筛选	boolean	内容严重性是否导致进行内容筛选	No
└─ 严重性	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	No

AzureContentFilterResultForChoice

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

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

AzureContentFilterResultForPrompt

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

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

AzureContentFilterSeverityResult

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

Name	类型	Description	Required	Default
filtered	boolean	内容严重性是否导致进行内容筛选	Yes
severity	枚举	内容标记的严重性。可能的值：`safe`、`low`、`medium`、`high`	Yes

AzureCosmosDBChatDataSource

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

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

AzureCreateChatCompletionRequest

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

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

AzureCreateChatCompletionResponse

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

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

AzureCreateChatCompletionStreamResponse

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

AzureCreateEmbeddingRequest

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

AzureCreateFileRequestMultiPart

Name	类型	Description	Required
过期时间	对象		Yes
~~ 定位点	AzureFileExpiryAnchor		No
~~ 秒	整数		No
文件	字符串		Yes
purpose	枚举	上传文件的预期用途。其中一个： - `assistants`：在助手 API 中使用 - `batch`：在 Batch API 中使用 - `fine-tune`：用于微调 - `evals`：用于 eval 数据集可能的值：`assistants`、`batch`、`fine-tune`、`evals`	Yes

AzureCreateImageEditRequestMultiPart

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

AzureCreateImageRequest

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

AzureCreateResponse

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

AzureCreateSpeechRequestMultiPart

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

Name	类型	Description	Required	Default
输入	字符串	要为其生成音频的文本。最大长度为 4096 个字符。	Yes
instructions	字符串	通过额外指令控制生成音频的音质。不适用于 `tts-1` 或 `tts-1-hd`.	No
模型	字符串	要用于此文本转语音请求的模型。	Yes
response_format	对象	文本转语音支持的音频输出格式。	No
speed	number	生成音频的语速。值在 0.25 到 4.0 的范围内有效，默认值为 1.0，对应于更快的语音。	No	1
stream_format	枚举	要在其中流式传输音频的格式。支持的格式是 `sse` 和 `audio`。 `sse` `tts-1`不支持或 `tts-1-hd`。可能的值： `sseaudio`	No
voice	对象		Yes

AzureCreateTranscriptionRequestMultiPart

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

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

AzureCreateTranslationRequestMultiPart

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

Name	类型	Description	Required	Default
文件	字符串		Yes
filename	字符串	要与音频数据关联的可选文件名或描述性标识符	No
模型	字符串	用于此翻译请求的模型。	No
提示	字符串	用于指导模型风格或继续之前的音频片段的可选文本。提示应为英语。	No
response_format	对象		No
temperature	number	采样温度，介于 0 和 1 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性如果设置为 0，则模型将使用对数概率自动增加温度，直到达到某些阈值。	No	0

AzureErrorResponse

Name	类型	Description	Required
错误	对象	错误详细信息。	No
└─ 代码	字符串	计算机生成的独特错误标识符。	No
内部错误			No
└─ 消息	字符串	与错误关联的人工可读消息。	No
└─ 参数	字符串	如果适用，则与错误有关的请求输入参数	No
└─ 类型	枚举	对象类型，始终为“error”。可能的值：`error`	No

AzureEvalAPICompletionsSamplingParams

Name	类型	Required
parallel_tool_calls	boolean	No
response_format	OpenAI.ResponseTextFormatConfiguration	No
tools	数组	No

AzureEvalAPIModelSamplingParams

Name	类型	Description	Required
max_tokens	整数	生成的输出中令牌的最大数目。	No
reasoning_effort	枚举	控制生成过程中应用的推理工作量级别。可能的值：`low`、、 `mediumhigh`	No
seed	整数	用于在采样期间初始化随机性的种子值。	No
temperature	number	较高的温度会增加输出中的随机性。	No
top_p	number	核采样温度的替代方法；1.0 包括所有令牌。	No

AzureEvalAPIResponseSamplingParams

Name	类型	Required
parallel_tool_calls	boolean	No
response_format	OpenAI.ResponseTextFormatConfiguration	No
tools	数组	No

AzureFileExpiryAnchor

Property	Value
Type	字符串
Values	`created_at`

AzureFineTuneReinforcementMethod

Name	类型	Description	Required
年级	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	Yes
calculate_output	字符串	用于基于评分器结果计算输出的公式。	No
evaluation_metric	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	No
~~ 评分员	对象		No
└─ 输入	数组	输入文本。这可能包括模板字符串。	No
└─ 模型	字符串	要用于评估的模型。	No
└─ 名称	字符串	评分程序的名称。	No
~~作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	No
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	No
~~ 参考	字符串	作为评分参照的文本。	No
采样参数 (sampling_params)		模型的采样参数。	No
└─ 类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	No
超参数	OpenAI.FineTuneReinforcementHyperparameters	用于强化微调作业的超参数。	No
response_format	对象		No
json_schema	对象	响应格式的 JSON 架构	No
└─ 类型	枚举	响应格式的类型可能的值：`json_schema`	No

AzureImage

Name	类型	Description	Required
b64_json	字符串	生成的映像的 base64 编码 JSON。的`gpt-image-1`默认值，并且仅在设置为 `response_format` for `b64_json` 和`dall-e-2`时`dall-e-3`存在。	No
content_filter_results	AzureContentFilterImageResponseResults	用于图像生成操作的输出响应内容的内容筛选结果。	Yes
prompt_filter_results	AzureContentFilterImagePromptResults	用于图像生成操作的输入请求内容的内容筛选结果。	Yes
修订后的提示	字符串	仅针对 `dall-e-3` 用于生成映像的修订提示。	No
url	字符串	使用 `dall-e-2` 或 `dall-e-3`设置为（默认值）时，生成的图像 `response_formaturl` 的 URL。不支持 `gpt-image-1`。	No

AzureImagesResponse

Name	类型	Description	Required
后台的	枚举	用于生成图像的背景参数。 `transparent` 或 `opaque`。可能的值： `transparentopaque`	No
created	整数	创建映像时的 Unix 时间戳（以秒为单位）。	Yes
数据	数组		No
output_format	枚举	图像生成的输出格式。 `png`、 `webp`或 `jpeg`。可能的值：`png`、、 `webpjpeg`	No
quality	枚举	生成的图像的质量。 `low`、 `medium`或 `high`。可能的值：`low`、、 `mediumhigh`	No
size	枚举	生成的映像的大小。 `1024x1024`、 `1024x1536`或 `1536x1024`。可能的值：`1024x1024`、、 `1024x15361536x1024`	No
使用情况	对象	仅针对 `gpt-image-1` 的图像生成过程中的令牌使用信息。	No
input_tokens	整数	输入提示中的标记数（图像和文本）。	No
input_tokens_details	对象	图像生成的输入令牌详细信息。	No
image_tokens	整数	输入提示中的图像令牌数。	No
text_tokens	整数	输入提示中的文本令牌数。	No
输出标记 (output_tokens)	整数	输出图像中的图像标记数。	No
total_tokens	整数	用于生成图像的令牌（图像和文本）总数。	No

AzureListFilesResponse

Name	类型	Description	Required
数据	数组		Yes
first_id	字符串		Yes
has_more	boolean		Yes
last_id	字符串		Yes
对象	枚举	可能的值：`list`	Yes

AzureOpenAIFile

Name	类型	Description	Required
bytes	整数	文件的大小（以字节为单位）。	Yes
created_at	整数	创建文件时的 Unix 时间戳（以秒为单位）。	Yes
expires_at	整数	文件的过期时间的 Unix 时间戳（以秒为单位）。	No
filename	字符串	文件的名称。	Yes
id	字符串	可在 API 终结点中引用的文件标识符。	Yes
对象	枚举	始终为 `file` 的对象类型。可能的值：`file`	Yes
purpose	枚举	文件的预期用途。支持的值为`assistants`、、`assistants_outputbatch`、`batch_output`和 `fine-tunefine-tune-results`。可能的值：`assistants`、、`assistants_output`、`batchbatch_output`、`fine-tune`、`fine-tune-results`、`evals`	Yes
状态	枚举	可能的值：`uploaded`、、`pending`、`runningprocessed`、`error`、`deleting`、`deleted`	Yes
状态详情	字符串	已弃用。有关微调训练文件为何未能通过验证的详细信息，请参阅有关该 `error` 字段的详细信息 `fine_tuning.job`。	No

AzureOpenAIVideoGenerationErrorResponse

Name	类型	Description	Required
代码	字符串	计算机生成的独特错误标识符。	No
inner_error	对象	导致此错误的上游错误（如果适用）。	No
└─ 代码	枚举	与内部错误关联的代码。可能的值：`ResponsibleAIPolicyViolation`	No
错误详情		与内部错误关联的内容筛选器结果详细信息。	No
revised_prompt	字符串	用于生成的修改后的提示（如果适用）。	No
消息	字符串	与错误关联的人工可读消息。	No
param	字符串	如果适用，则与错误有关的请求输入参数	No
类型	字符串	与错误关联的输入行号（如果适用）。	No

AzureResponse

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

AzureSearchChatDataSource

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

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

AzureUserSecurityContext

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

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

ChatCompletionMessageToolCallsItem

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

数组：OpenAI.ChatCompletionMessageToolCall

CreateVideoGenerationRequest

Name	类型	Description	Required	Default
height	整数	视频的高度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes
模型	字符串	要用于此请求的部署的名称。	Yes
n_seconds	整数	视频生成作业的持续时间。必须介于 1 到 20 秒之间。	No	5
n_variants	整数	要作为此作业的变体创建的视频数量。必须介于 1 和 5 之间。较小的尺寸允许更多变体。	No	1
提示	字符串	此视频生成作业的提示。	Yes
width	整数	视频的宽度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes

CreateVideoGenerationWithMediaRequestMultiPart

包含媒体文件的视频生成作业请求的属性。

Name	类型	Description	Required	Default
files	数组		Yes
height	整数	视频的高度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes
inpaint_items	数组	此视频生成作业的可选内插项目。	No
模型	字符串	要用于此请求的部署的名称。	Yes
n_seconds	整数	视频生成作业的持续时间。必须介于 1 到 20 秒之间。	No	5
n_variants	整数	要作为此作业的变体创建的视频数量。必须介于 1 和 5 之间。较小的尺寸允许更多变体。	No	1
提示	字符串	此视频生成作业的提示。	Yes
width	整数	视频的宽度。支持以下尺寸：横向和纵向方向为 480x480、854x480、720x720、1280x720、1080x1080 和 1920x1080。	Yes

CropBounds

剪裁项的裁剪边界。这指定应用于修补的媒体项的区域。

Name	类型	Description	Required	Default
bottom_fraction	number	指定为原始媒体项高度的分数的裁剪框的底部边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半高度。	No	1
left_fraction	number	指定为原始媒体项宽度的分数的裁剪框的左边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半宽度。	No	0
right_fraction	number	指定为原始媒体项宽度的分数的裁剪框的右边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半宽度。	No	1
top_fraction	number	指定为原始媒体项高度的分数的裁剪框的上边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半高度。	No	0

ElasticsearchChatDataSource

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

InpaintItem

视频生成作业的内插项目。这指定应用于在视频生成中进行修补的媒体项。

Name	类型	Description	Required	Default
crop_bounds	对象	剪裁项的裁剪边界。这指定应用于修补的媒体项的区域。	No
bottom_fraction	number	指定为原始媒体项高度的分数的裁剪框的底部边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半高度。	No	1
left_fraction	number	指定为原始媒体项宽度的分数的裁剪框的左边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半宽度。	No	0
right_fraction	number	指定为原始媒体项宽度的分数的裁剪框的右边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半宽度。	No	1
top_fraction	number	指定为原始媒体项高度的分数的裁剪框的上边界。必须介于 0.0 和 1.0 之间。将 0.5 用于原始媒体项的一半高度。	No	0
文件名	字符串	媒体项的文件名。它必须与此请求中的文件附件的文件名匹配。	Yes
frame_index	整数	此媒体项的帧索引。这将为此嵌入项指定生成的视频中的起始帧。	Yes	0
类型	对象	内修补项的类型。	Yes

JobStatus

视频生成作业的状态。

Property	Value
Description	视频生成作业的状态。
Type	字符串
Values	`preprocessing` `queued` `running` `processing` `cancelled` `succeeded` `failed`

MediaItemType

内修补项的类型。

Property	Value
Description	内修补项的类型。
Type	字符串
Values	`image`

MongoDBChatDataSource

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

OpenAI.Annotation

OpenAI.Annotation 的鉴别器

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

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

Name	类型	Description	Required	Default
类型	OpenAI.AnnotationType		Yes

OpenAI.AnnotationFileCitation

文件的引文。

Name	类型	Description	Required
file_id	字符串	文件的 ID。	Yes
filename	字符串	引用的文件的文件名。	Yes
索引	整数	文件列表中的文件的索引。	Yes
类型	枚举	文件引文的类型。始终为 `file_citation`。可能的值：`file_citation`	Yes

OpenAI.AnnotationFilePath

文件路径。

Name	类型	Description	Required
file_id	字符串	文件的 ID。	Yes
索引	整数	文件列表中的文件的索引。	Yes
类型	枚举	文件路径的类型。始终为 `file_path`。可能的值：`file_path`	Yes

OpenAI.AnnotationType

Property	Value
Type	字符串
Values	`file_citation` `url_citation` `file_path` `container_file_citation`

OpenAI.AnnotationUrlCitation

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

Name	类型	Description	Required
end_index	整数	消息中 URL 引文的最后一个字符的索引。	Yes
start_index	整数	消息中 URL 引文的第一个字符的索引。	Yes
title	字符串	Web 资源的标题。	Yes
类型	枚举	URL 引文的类型。始终为 `url_citation`。可能的值：`url_citation`	Yes
url	字符串	Web 资源的 URL。	Yes

OpenAI.ApproximateLocation

Name	类型	Description	Required
city	字符串		No
country	字符串		No
区域	字符串		No
timezone	字符串		No
类型	枚举	可能的值：`approximate`	Yes

OpenAI.AudioResponseFormat

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

Property	Value
Description	输出的格式，采用以下选项之一：`json`、、`text`、`srt`或`verbose_jsonvtt`。对于 `gpt-4o-transcribe`， `gpt-4o-transcribe-diarize`和 `gpt-4o-mini-transcribe`，唯一支持的格式是 `json`。
Type	字符串
Values	`json` `text` `srt` `verbose_json` `vtt`

OpenAI.AutoChunkingStrategyRequestParam

默认策略。此策略目前使用 max_chunk_size_tokens 的 800 和 chunk_overlap_tokens 的 400。

Name	类型	Description	Required	Default
类型	枚举	始终为 `auto`。可能的值：`auto`	Yes

OpenAI.ChatCompletionFunctionCallOption

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

Name	类型	Description	Required	Default
name	字符串	要调用的函数名称。	Yes

OpenAI.ChatCompletionFunctions

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

OpenAI.ChatCompletionMessageAudioChunk

Name	类型	Required
数据	字符串	No
expires_at	整数	No
id	字符串	No
脚本	字符串	No

OpenAI.ChatCompletionMessageToolCall

Name	类型	Description	Required
函数	对象	模型调用的函数。	Yes
~~ 参数	字符串	用于调用函数的参数，由模型以 JSON 格式生成。请注意，该模型并非始终生成有效的 JSON，并且可能会幻化出未由函数架构定义的参数。在调用函数之前验证代码中的参数。	No
└─ 名称	字符串	要调用的函数名称。	No
id	字符串	工具调用的 ID。	Yes
类型	枚举	工具的类型。目前仅支持 `function`。可能的值：`function`	Yes

OpenAI.ChatCompletionMessageToolCallChunk

Name	类型	Description	Required
函数	对象		No
~~ 参数	字符串	用于调用函数的参数，由模型以 JSON 格式生成。请注意，该模型并非始终生成有效的 JSON，并且可能会幻化出未由函数架构定义的参数。在调用函数之前验证代码中的参数。	No
└─ 名称	字符串	要调用的函数名称。	No
id	字符串	工具调用的 ID。	No
索引	整数		Yes
类型	枚举	工具的类型。目前仅支持 `function`。可能的值：`function`	No

OpenAI.ChatCompletionNamedToolChoice

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

Name	类型	Description	Required
函数	对象		Yes
└─ 名称	字符串	要调用的函数名称。	No
类型	枚举	工具的类型。目前仅支持 `function`。可能的值：`function`	Yes

OpenAI.ChatCompletionRequestAssistantMessage

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

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

OpenAI.ChatCompletionRequestAssistantMessageContentPart

Name	类型	Description	Required
refusal	字符串	模型生成的拒绝消息。	Yes
文本消息	字符串	文本内容。	Yes
类型	枚举	内容部件的类型。可能的值：`refusal`	Yes

OpenAI.ChatCompletionRequestDeveloperMessage

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

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

OpenAI.ChatCompletionRequestFunctionMessage

Name	类型	Description	Required
内容	字符串	函数消息的内容。	Yes
name	字符串	要调用的函数名称。	Yes
角色	枚举	消息作者的角色，在本例中为 `function`。可能的值：`function`	Yes

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage 的鉴别器

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

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

Name	类型	Description	Required	Default
内容	字符串或数组		No
角色	对象	邮件作者的角色	Yes

OpenAI.ChatCompletionRequestMessageContentPart

OpenAI.ChatCompletionRequestMessageContentPart 的鉴别器

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

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

Name	类型	Description	Required	Default
类型	OpenAI.ChatCompletionRequestMessageContentPartType		Yes

OpenAI.ChatCompletionRequestMessageContentPartAudio

Name	类型	Description	Required
input_audio	对象		Yes
└─ 数据	字符串	Base64 编码的音频数据。	No
└─ 格式	枚举	编码的音频数据的格式。目前支持“wav”和“mp3”。可能的值： `wavmp3`	No
类型	枚举	内容部件的类型。始终为 `input_audio`。可能的值：`input_audio`	Yes

OpenAI.ChatCompletionRequestMessageContentPartFile

Name	类型	Description	Required
文件	对象		Yes
file_data	字符串	传递文件到模型时所用的 base64 编码的文件数据作为字符串。	No
file_id	字符串	要用作输入的上传文件的 ID。	No
~~ 文件名	字符串	文件名，用于将文件作为以下项传给模型时字符串。	No
类型	枚举	内容部件的类型。始终为 `file`。可能的值：`file`	Yes

OpenAI.ChatCompletionRequestMessageContentPartImage

Name	类型	Description	Required
image_url	对象		Yes
└─ 详细信息	枚举	指定图像的详细信息级别。可能的值：`auto`、、 `lowhigh`	No
└─ 网址	字符串	图像的 URL 或 base64 编码的图像数据。	No
类型	枚举	内容部件的类型。可能的值：`image_url`	Yes

OpenAI.ChatCompletionRequestMessageContentPartRefusal

Name	类型	Description	Required	Default
refusal	字符串	模型生成的拒绝消息。	Yes
类型	枚举	内容部件的类型。可能的值：`refusal`	Yes

OpenAI.ChatCompletionRequestMessageContentPartText

Name	类型	Description	Required	Default
文本消息	字符串	文本内容。	Yes
类型	枚举	内容部件的类型。可能的值：`text`	Yes

OpenAI.ChatCompletionRequestMessageContentPartType

Property	Value
Type	字符串
Values	`text` `file` `input_audio` `image_url` `refusal`

OpenAI.ChatCompletionRequestSystemMessage

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

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

OpenAI.ChatCompletionRequestSystemMessageContentPart

参考：OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

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

OpenAI.ChatCompletionRequestToolMessageContentPart

参考：OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

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

OpenAI.ChatCompletionRequestUserMessageContentPart

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

OpenAI.ChatCompletionRole

邮件作者的角色

Property	Value
Description	邮件作者的角色
Type	字符串
Values	`system` `developer` `user` `assistant` `tool` `function`

OpenAI.ChatCompletionStreamOptions

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

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

OpenAI.ChatCompletionStreamResponseDelta

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

Name	类型	Description	Required
audio	对象		No
└─ 数据	字符串		No
过期时间	整数		No
{~ id	字符串		No
~~ 脚本	字符串		No
内容	字符串	区块消息的内容。	No
function_call	对象	已弃用并替换为 `tool_calls`。应调用的函数的名称和参数，由模型生成。	No
~~ 参数	字符串		No
└─ 名称	字符串		No
refusal	字符串	模型生成的拒绝消息。	No
角色	对象	邮件作者的角色	No
tool_calls	数组		No

OpenAI.ChatCompletionTokenLogprob

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

OpenAI.ChatCompletionTool

Name	类型	Description	Required	Default
函数	OpenAI.FunctionObject		Yes
类型	枚举	工具的类型。目前仅支持 `function`。可能的值：`function`	Yes

OpenAI.ChatCompletionToolChoiceOption

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

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

Name	类型	Description	Required
函数	对象		Yes
└─ 名称	字符串	要调用的函数名称。	No
类型	枚举	工具的类型。目前仅支持 `function`。可能的值：`function`	Yes

OpenAI.ChatOutputPrediction

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

OpenAI.ChatOutputPrediction 的鉴别器

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

类型值	Schema
`content`	OpenAI.ChatOutputPredictionContent

Name	类型	Description	Required	Default
类型	OpenAI.ChatOutputPredictionType		Yes

OpenAI.ChatOutputPredictionContent

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

Name	类型	Description	Required	Default
内容	字符串或数组		Yes
类型	枚举	要提供的预测内容的类型。此类型当前始终为 `content`。可能的值：`content`	Yes

OpenAI.ChatOutputPredictionType

Property	Value
Type	字符串
Values	`content`

OpenAI.ChunkingStrategyRequestParam

用于对文件进行分块的分块策略。如果未设置，则将使用 auto 策略。

OpenAI.ChunkingStrategyRequestParam 的鉴别器

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

类型值	Schema
`static`	OpenAI.StaticChunkingStrategyRequestParam

Name	类型	Description	Required	Default
类型	枚举	分块策略的类型。可能的值： `autostatic`	Yes

OpenAI.ChunkingStrategyResponseParam

OpenAI.ChunkingStrategyResponseParam 的鉴别器

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

类型值	Schema
`other`	OpenAI.OtherChunkingStrategyResponseParam
`static`	OpenAI.StaticChunkingStrategyResponseParam

Name	类型	Description	Required	Default
类型	枚举	可能的值： `staticother`	Yes

OpenAI.CodeInterpreterOutput

OpenAI.CodeInterpreterOutput 的鉴别器

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

类型值	Schema
`image`	OpenAI.CodeInterpreterOutputImage
`logs`	OpenAI.CodeInterpreterOutputLogs

Name	类型	Description	Required	Default
类型	OpenAI.CodeInterpreterOutputType		Yes

OpenAI.CodeInterpreterOutputImage

代码解释器的图像输出。

Name	类型	Description	Required	Default
类型	枚举	输出的类型。始终为“image”。可能的值：`image`	Yes
url	字符串	代码解释器的图像输出的 URL。	Yes

OpenAI.CodeInterpreterOutputLogs

代码解释器的日志输出。

Name	类型	Description	Required	Default
日志	字符串	代码解释器的日志输出。	Yes
类型	枚举	输出的类型。始终为“logs”。可能的值：`logs`	Yes

OpenAI.CodeInterpreterOutputType

Property	Value
Type	字符串
Values	`logs` `image`

OpenAI.CodeInterpreterTool

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

Name	类型	Description	Required
容器	对象	代码解释器容器的配置。（可选）指定 ID 要运行代码的文件的该项。	Yes
file_ids	数组	可提供给代码使用的已上传文件的一个可选列表。	No
└─ 类型	枚举	始终为 `auto`。可能的值：`auto`	No
类型	枚举	代码解释器工具的类型。始终为 `code_interpreter`。可能的值：`code_interpreter`	Yes

OpenAI.CodeInterpreterToolAuto

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

Name	类型	Description	Required	Default
file_ids	数组	可提供给代码使用的已上传文件的一个可选列表。	No
类型	枚举	始终为 `auto`。可能的值：`auto`	Yes

OpenAI.CodeInterpreterToolCallItemParam

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

Name	类型	Description	Required
代码	字符串	要运行的代码，如果不可用，则为 null。	Yes
container_id	字符串	用于运行代码的容器的 ID。	Yes
outputs	数组	代码解释器生成的输出，例如日志或图像。如果没有可用的输出，可以为 null。	Yes
类型	枚举	可能的值：`code_interpreter_call`	Yes

OpenAI.CodeInterpreterToolCallItemResource

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

Name	类型	Description	Required
代码	字符串	要运行的代码，如果不可用，则为 null。	Yes
container_id	字符串	用于运行代码的容器的 ID。	Yes
outputs	数组	代码解释器生成的输出，例如日志或图像。如果没有可用的输出，可以为 null。	Yes
状态	枚举	可能的值：`in_progress`、、`completedincomplete`、`interpreting`、`failed`	Yes
类型	枚举	可能的值：`code_interpreter_call`	Yes

OpenAI.ComparisonFilter

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

Name	类型	Description	Required
关键值	字符串	要与值进行比较的键。	Yes
类型	枚举	指定比较运算符：`eq`、、`negt`、`gte`、`ltlte`。 - `eq`：等于 - `ne`：不等于 - `gt`：大于 - `gte`：大于或等于 - `lt`：小于 - `lte`：小于或等于可能的值：`eq`、、`ne`、`gtgte`、`lt`、`lte`	Yes
value	字符串或数字或布尔值		Yes

OpenAI.CompletionUsage

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

Name	类型	Description	Required	Default
completion_tokens	整数	生成的补全中的词元数。	Yes	0
completion_tokens_details	对象	完成中使用的令牌明细。	No
接受的预测标记	整数	使用预测的输出时，在完成中显示的预测中的令牌数量。	No	0
音频标记	整数	模型生成的音频输入标记。	No	0
reasoning_tokens	整数	用于推理的由模型生成的令牌。	No	0
rejected_prediction_tokens	整数	使用预测的输出时，没有出现在结果中的预测的令牌数量。但是，例如推理令牌，这些令牌仍计算在用于计费、输出和上下文窗口限制的完成令牌总数中。	No	0
prompt_tokens	整数	提示中的标记数。	Yes	0
prompt_tokens_details	对象	提示中使用的标识符分解。	No
音频标记	整数	提示中存在的音频输入标记。	No	0
cached_tokens	整数	提示中存在的缓存令牌。	No	0
total_tokens	整数	请求中使用的令牌总数（提示 + 补全）。	Yes	0

OpenAI.CompoundFilter

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

Name	类型	Description	Required	Default
filters	数组	要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`。	Yes
类型	枚举	操作类型：`and` 或 `or`。可能的值： `andor`	Yes

OpenAI.ComputerAction

OpenAI.ComputerAction 的鉴别器

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

类型值	Schema
`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

Name	类型	Description	Required	Default
类型	OpenAI.ComputerActionType		Yes

OpenAI.ComputerActionClick

单击操作。

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

OpenAI.ComputerActionDoubleClick

双击操作。

Name	类型	Description	Required
类型	枚举	指定事件类型。对于双击作，此属性为始终设置为 `double_click`。可能的值：`double_click`	Yes
x	整数	双击发生时的 x 坐标。	Yes
y	整数	发生双击的 y 坐标。	Yes

OpenAI.ComputerActionDrag

拖动操作。

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

OpenAI.ComputerActionKeyPress

模型要执行的按键集合。

Name	类型	Description	Required	Default
keys	数组	模型请求按下的键的组合。这是一字符串数组，每个字符串表示一个键。	Yes
类型	枚举	指定事件类型。对于键压缩作，此属性为始终设置为 `keypress`。可能的值：`keypress`	Yes

OpenAI.ComputerActionMove

鼠标移动操作。

Name	类型	Description	Required
类型	枚举	指定事件类型。对于移动作，此属性为始终设置为 `move`。可能的值：`move`	Yes
x	整数	要移动到的 X 坐标。	Yes
y	整数	要移动到的 Y 坐标。	Yes

OpenAI.ComputerActionScreenshot

屏幕截图操作。

Name	类型	Description	Required	Default
类型	枚举	指定事件类型。对于屏幕截图作，此属性为始终设置为 `screenshot`。可能的值：`screenshot`	Yes

OpenAI.ComputerActionScroll

滚动操作。

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

OpenAI.ComputerActionType

Property	Value
Type	字符串
Values	`screenshot` `click` `double_click` `scroll` `type` `wait` `keypress` `drag` `move`

OpenAI.ComputerActionTypeKeys

键入文本的操作。

Name	类型	Description	Required	Default
文本消息	字符串	要键入的文本。	Yes
类型	枚举	指定事件类型。对于类型作，此属性为始终设置为 `type`。可能的值：`type`	Yes

OpenAI.ComputerActionWait

等待操作。

Name	类型	Description	Required	Default
类型	枚举	指定事件类型。对于等待作，此属性为始终设置为 `wait`。可能的值：`wait`	Yes

OpenAI.ComputerToolCallItemParam

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

Name	类型	Description	Required
操作	OpenAI.ComputerAction		Yes
call_id	字符串	用输出来响应工具调用时使用的标识符。	Yes
pending_safety_checks	数组	计算机调用的挂起安全检查。	Yes
类型	枚举	可能的值：`computer_call`	Yes

OpenAI.ComputerToolCallItemResource

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

Name	类型	Description	Required
操作	OpenAI.ComputerAction		Yes
call_id	字符串	用输出来响应工具调用时使用的标识符。	Yes
pending_safety_checks	数组	计算机调用的挂起安全检查。	Yes
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	Yes
类型	枚举	可能的值：`computer_call`	Yes

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput 的鉴别器

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

类型值	Schema
`computer_screenshot`	OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name	类型	Description	Required	Default
类型	OpenAI.ComputerToolCallOutputItemOutputType	与计算机使用工具一起使用的计算机屏幕截图图像。	Yes

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

Name	类型	Description	Required
file_id	字符串		No
image_url	字符串		No
类型	枚举	可能的值：`computer_screenshot`	Yes

OpenAI.ComputerToolCallOutputItemOutputType

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

Property	Value
Description	与计算机使用工具一起使用的计算机屏幕截图图像。
Type	字符串
Values	`computer_screenshot`

OpenAI.ComputerToolCallOutputItemParam

计算机工具调用的输出。

Name	类型	Description	Required
acknowledged_safety_checks	数组	API 报告的安全检查，这些检查的确认者为开发人员。	No
call_id	字符串	生成输出的计算机工具调用的 ID。	Yes
输出	OpenAI.ComputerToolCallOutputItemOutput		Yes
类型	枚举	可能的值：`computer_call_output`	Yes

OpenAI.ComputerToolCallOutputItemResource

计算机工具调用的输出。

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

OpenAI.ComputerToolCallSafetyCheck

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

Name	类型	Description	Required
代码	字符串	挂起的安全检查的类型。	Yes
id	字符串	挂起的安全检查的 ID。	Yes
消息	字符串	有关挂起的安全检查的详细信息。	Yes

OpenAI.ComputerUsePreviewTool

控制虚拟计算机的工具。

Name	类型	Description	Required
display_height	整数	计算机显示的高度。	Yes
display_width	整数	计算机的显示宽度。	Yes
环境	枚举	要控制的计算机环境的类型。可能的值：`windows`、、`maclinux`、`ubuntu`、`browser`	Yes
类型	枚举	计算机使用工具的类型。始终为 `computer_use_preview`。可能的值：`computer_use_preview`	Yes

OpenAI.Coordinate

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

Name	类型	Description	Required	Default
x	整数	X 坐标。	Yes
y	整数	Y 坐标。	Yes

OpenAI.CreateEmbeddingResponse

Name	类型	Description	Required
数据	数组	模型生成的嵌入列表。	Yes
模型	字符串	用于生成嵌入的模型的名称。	Yes
对象	枚举	对象类型，始终为“list”。可能的值：`list`	Yes
使用情况	对象	请求的使用情况信息。	Yes
prompt_tokens	整数	提示使用的令牌数。	No
total_tokens	整数	请求使用的令牌总数。	No

OpenAI.CreateEvalItem

构成提示或上下文的聊天消息。可能包括对命名空间的 item 变量引用，即 {{item.name}}。

Name	类型	Description	Required
内容	string 或 OpenAI.EvalItemContent	模型的文本输入 - 可以包含模板字符串。	Yes
角色	枚举	消息输入的角色。 `user`、`assistant`、`system`之一或 `developer`。可能的值：`user`、`assistant`、`system`、`developer`	Yes
类型	枚举	消息输入的类型。始终为 `message`。可能的值：`message`	No

OpenAI.CreateEvalRunRequest

Name	类型	Description	Required
数据源	对象		Yes
└─ 类型	OpenAI.EvalRunDataSourceType		No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串	运行的名称。	No

OpenAI.CreateFineTuningJobRequest

有效模型：

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini

Name	类型	Description	Required	Default
超参数	对象	用于微调作业的超参数。此值现在已弃用 `method`，应该在参数下 `method` 传入。	No
batch_size	枚举	可能的值：`auto`	No
learning_rate_multiplier	枚举	可能的值：`auto`	No
n_epochs	枚举	可能的值：`auto`	No
整合	数组	要为微调作业启用的集成列表。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
方法	OpenAI.FineTuneMethod	用于微调的方法。	No
模型	字符串（请参阅下面的有效模型）	要微调的模型的名称。	Yes
seed	整数	种子控制作业的可重现性。传入相同的种子和作业参数应会产生相同的结果，但在极少数情况下可能会有差异。如果未指定种子，则会为你生成一个种子。	No
suffix	字符串	最多 64 个字符的字符串，将添加到微调的模型名称中。例如，一个 `suffix` “custom-model-name”将生成一个模型名称，如下所示 `ft:gpt-4o-mini:openai:custom-model-name:7p4lURel`。	No	None
训练文件	字符串	包含训练数据的上传文件的 ID。数据集的格式必须为 JSONL 文件。此外，还必须使用目的 `fine-tune`上传文件。文件的内容应有所不同，具体取决于模型是否使用聊天、完成格式，或者微调方法是否使用首选项格式。	Yes
验证文件	字符串	包含验证数据的上传文件的 ID。如果提供此文件，则数据用于生成验证在微调期间定期指标。可以在其中查看这些指标微调结果文件。训练文件和验证文件中不应存在相同的数据。数据集的格式必须为 JSONL 文件。必须按照目的 `fine-tune`上传文件。	No

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration 的鉴别器

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

类型值	Schema
`wandb`	OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	类型	Description	Required	Default
类型	字符串（请参阅下面的有效模型）		Yes

OpenAI.CreateFineTuningJobRequestWandbIntegration

Name	类型	Description	Required
类型	枚举	可能的值：`wandb`	Yes
wandb	对象		Yes
~~ 实体	字符串		No
└─ 名称	字符串		No
~~ 项目	字符串		No
~~ 标记	数组		No

OpenAI.CreateVectorStoreFileBatchRequest

Name	类型	Description	Required
属性	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为最大值的字符串 512 个字符、布尔值或数字的字符串。	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	用于对文件进行分块的分块策略。如果未设置，则将使用 `auto` 策略。	No
file_ids	数组	矢量存储应使用的文件 ID 列表。适用于可以访问文件的 `file_search` 等工具。	Yes

OpenAI.CreateVectorStoreFileRequest

Name	类型	Description	Required
属性	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为最大值的字符串 512 个字符、布尔值或数字的字符串。	No
chunking_strategy	OpenAI.ChunkingStrategyRequestParam	用于对文件进行分块的分块策略。如果未设置，则将使用 `auto` 策略。	No
file_id	字符串	矢量存储应使用的文件 ID。适用于可以访问文件的 `file_search` 等工具。	Yes

OpenAI.CreateVectorStoreRequest

Name	类型	Description	Required
chunking_strategy	对象	默认策略。此策略目前使用 `max_chunk_size_tokens` 的 `800` 和 `chunk_overlap_tokens` 的 `400`。	No
~~ 静态	OpenAI.StaticChunkingStrategy		No
└─ 类型	枚举	始终为 `static`。可能的值：`static`	No
过期时间	OpenAI.VectorStoreExpirationAfter	矢量存储过期策略。	No
file_ids	数组	矢量存储应使用的文件 ID 列表。适用于可以访问文件的 `file_search` 等工具。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串	矢量存储的名称。	No

OpenAI.DeleteFileResponse

Name	类型	Description	Required
已删除	boolean		Yes
id	字符串		Yes
对象	枚举	可能的值：`file`	Yes

OpenAI.DeleteVectorStoreFileResponse

Name	类型	Description	Required
已删除	boolean		Yes
id	字符串		Yes
对象	枚举	可能的值：`vector_store.file.deleted`	Yes

OpenAI.DeleteVectorStoreResponse

Name	类型	Description	Required
已删除	boolean		Yes
id	字符串		Yes
对象	枚举	可能的值：`vector_store.deleted`	Yes

OpenAI.Embedding

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

Name	类型	Description	Required
embedding	数组或字符串		Yes
索引	整数	嵌入列表的嵌入索引。	Yes
对象	枚举	对象类型，始终为“embedding”。可能的值：`embedding`	Yes

OpenAI.Eval

具有数据源配置和测试条件的 Eval 对象。评估表示要为 LLM 集成完成的任务。例如：

提高聊天机器人的质量
了解聊天机器人如何处理客户支持
检查 o4-mini 在我的用例上是否比 gpt-4o 更好

Name	类型	Description	Required	Default
created_at	整数	创建 eval 时的 Unix 时间戳（以秒为单位）。	Yes
数据源配置	对象		Yes
└─ 类型	OpenAI.EvalDataSourceConfigType		No
id	字符串	评估的唯一标识符。	Yes
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	Yes
name	字符串	评估的名称。	Yes
对象	枚举	对象类型。可能的值：`eval`	Yes
测试标准	数组	测试条件列表。	Yes	None

OpenAI.EvalApiError

一个对象，表示来自 Eval API 的错误响应。

Name	类型	Description	Required	Default
代码	字符串	错误代码。	Yes
消息	字符串	错误消息。	Yes

OpenAI.EvalCompletionsRunDataSourceParams

描述模型采样配置的 CompletionsRunDataSource 对象。

Name	类型	Description	Required
输入消息	对象		No
item_reference	字符串	对命名空间中的变量的 `item` 引用。 Ie，“item.input_trajectory”	No
~~ 模板	数组	构成提示或上下文的聊天消息列表。可能包括对命名空间的 `item` 变量引用，即 {{item.name}}。	No
└─ 类型	枚举	输入消息的类型。始终为 `item_reference`。可能的值：`item_reference`	No
模型	字符串	用于生成完成的模型的名称（例如“o3-mini”）。	No
采样参数	AzureEvalAPICompletionsSamplingParams		No
源	对象		Yes
└─ 内容	数组	jsonl 文件的内容。	No
created_after	整数	一个可选的 Unix 时间戳，用于筛选在此时间之后创建的项。	No
created_before	整数	一个可选的 Unix 时间戳，用于筛选此时间之前创建的项。	No
{~ id	字符串	文件的标识符。	No
~~ 限制	整数	（可选）要返回的最大项数。	No
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
└─ 模型	字符串	用于筛选的可选模型（例如，“gpt-4o”）。	No
└─ 类型	枚举	源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	No
类型	枚举	运行数据源的类型。始终为 `completions`。可能的值：`completions`	Yes

OpenAI.EvalCustomDataSourceConfigParams

一个 CustomDataSourceConfig 对象，用于定义用于评估运行的数据源的架构。此架构用于定义以下数据的形状：

用于定义测试条件和
创建运行时需要哪些数据

Name	类型	Description	Required	Default
include_sample_schema	boolean	评估是否应期望由你填充示例命名空间（即通过从数据源生成响应）	No	False
item_schema	对象	数据源中每一行的 json 架构。	Yes
类型	枚举	数据源的类型。始终为 `custom`。可能的值：`custom`	Yes

OpenAI.EvalCustomDataSourceConfigResource

一个 CustomDataSourceConfig，用于指定你的 item 架构和可选 sample 命名空间。响应架构定义以下数据的形状：

用于定义测试条件和
创建运行时需要哪些数据

Name	类型	Description	Required	Default
架构	对象	运行数据源项的 json 架构。了解如何在此处生成 JSON 架构。	Yes
类型	枚举	数据源的类型。始终为 `custom`。可能的值：`custom`	Yes

OpenAI.EvalDataSourceConfigParams

OpenAI.EvalDataSourceConfigParams 的鉴别器

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

类型值	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigParams
`logs`	OpenAI.EvalLogsDataSourceConfigParams
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigParams

Name	类型	Description	Required	Default
类型	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigResource

OpenAI.EvalDataSourceConfigResource 的鉴别器

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

类型值	Schema
`custom`	OpenAI.EvalCustomDataSourceConfigResource
`stored_completions`	OpenAI.EvalStoredCompletionsDataSourceConfigResource
`logs`	OpenAI.EvalLogsDataSourceConfigResource

Name	类型	Description	Required	Default
类型	OpenAI.EvalDataSourceConfigType		Yes

OpenAI.EvalDataSourceConfigType

Property	Value
Type	字符串
Values	`custom` `logs` `stored_completions`

OpenAI.EvalGraderLabelModelParams

一个 LabelModelGrader 对象，该对象使用模型将标签分配给评估中的每个项。

Name	类型	Description	Required
输入	数组	构成提示或上下文的聊天消息列表。可能包括对命名空间的 `item` 变量引用，即 {{item.name}}。	Yes
标签	数组	要分类到评估中每个项的标签。	Yes
模型	字符串	要用于评估的模型。必须支持结构化输出。	Yes
name	字符串	评分程序的名称。	Yes
passing_labels	数组	指示通过结果的标签。必须是标签的子集。	Yes
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	Yes

OpenAI.EvalGraderLabelModelResource

Name	类型	Description	Required
输入	数组		Yes
标签	数组	要分配给评估中每个项的标签。	Yes
模型	字符串	要用于评估的模型。必须支持结构化输出。	Yes
name	字符串	评分程序的名称。	Yes
passing_labels	数组	指示通过结果的标签。必须是标签的子集。	Yes
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	Yes

OpenAI.EvalGraderParams

OpenAI.EvalGraderParams 的鉴别器

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

类型值	Schema
`label_model`	OpenAI.EvalGraderLabelModelParams
`string_check`	OpenAI.EvalGraderStringCheckParams
`text_similarity`	OpenAI.EvalGraderTextSimilarityParams
`python`	OpenAI.EvalGraderPythonParams
`score_model`	OpenAI.EvalGraderScoreModelParams

Name	类型	Description	Required	Default
类型	OpenAI.GraderType		Yes

OpenAI.EvalGraderPythonParams

Name	类型	Description	Required
image_tag	字符串	用于 python 脚本的图像标记。	No
name	字符串	评分程序的名称。	Yes
通过阈值	number	分数的阈值。	No
源	字符串	python 脚本的源代码。	Yes
类型	枚举	始终为 `python` 的对象类型。可能的值：`python`	Yes

OpenAI.EvalGraderPythonResource

Name	类型	Description	Required
image_tag	字符串	用于 python 脚本的图像标记。	No
name	字符串	评分程序的名称。	Yes
通过阈值	number	分数的阈值。	No
源	字符串	python 脚本的源代码。	Yes
类型	枚举	始终为 `python` 的对象类型。可能的值：`python`	Yes

OpenAI.EvalGraderResource

OpenAI.EvalGraderResource 的鉴别器

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

类型值	Schema
`label_model`	OpenAI.EvalGraderLabelModelResource
`text_similarity`	OpenAI.EvalGraderTextSimilarityResource
`python`	OpenAI.EvalGraderPythonResource
`score_model`	OpenAI.EvalGraderScoreModelResource

Name	类型	Description	Required	Default
类型	OpenAI.GraderType		Yes

OpenAI.EvalGraderScoreModelParams

Name	类型	Description	Required
输入	数组	输入文本。这可能包括模板字符串。	Yes
模型	字符串	要用于评估的模型。	Yes
name	字符串	评分程序的名称。	Yes
通过阈值	number	分数的阈值。	No
范围	数组	分数的范围。默认为 `[0, 1]`。	No
采样参数		模型的采样参数。	No
类型	枚举	始终为 `score_model` 的对象类型。可能的值：`score_model`	Yes

OpenAI.EvalGraderScoreModelResource

Name	类型	Description	Required
输入	数组	输入文本。这可能包括模板字符串。	Yes
模型	字符串	要用于评估的模型。	Yes
name	字符串	评分程序的名称。	Yes
通过阈值	number	分数的阈值。	No
范围	数组	分数的范围。默认为 `[0, 1]`。	No
采样参数		模型的采样参数。	No
类型	枚举	始终为 `score_model` 的对象类型。可能的值：`score_model`	Yes

OpenAI.EvalGraderStringCheckParams

Name	类型	Description	Required
输入	字符串	输入文本。这可能包括模板字符串。	Yes
name	字符串	评分程序的名称。	Yes
操作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	Yes
引用	字符串	引用文本。这可能包括模板字符串。	Yes
类型	枚举	始终为 `string_check` 的对象类型。可能的值：`string_check`	Yes

OpenAI.EvalGraderTextSimilarityParams

Name	类型	Description	Required
评估指标	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	Yes
输入	字符串	正在评分的文本。	Yes
name	字符串	评分程序的名称。	Yes
通过阈值	number	分数的阈值。	Yes
引用	字符串	作为评分参照的文本。	Yes
类型	枚举	评分程序的类型。可能的值：`text_similarity`	Yes

OpenAI.EvalGraderTextSimilarityResource

Name	类型	Description	Required
评估指标	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	Yes
输入	字符串	正在评分的文本。	Yes
name	字符串	评分程序的名称。	Yes
通过阈值	number	分数的阈值。	Yes
引用	字符串	作为评分参照的文本。	Yes
类型	枚举	评分程序的类型。可能的值：`text_similarity`	Yes

OpenAI.EvalItem

模型的消息输入，具有指示以下层次结构的说明的角色。使用 developer 或 system 角色提供的说明优先于角色 user 提供的说明。假定具有 assistant 角色的消息是由模型在以前的交互中生成的。

Name	类型	Description	Required
内容	对象		Yes
└─ 类型	OpenAI.EvalItemContentType		No
角色	枚举	消息输入的角色。 `user`、`assistant`、`system`之一或 `developer`。可能的值：`user`、`assistant`、`system`、`developer`	Yes
类型	枚举	消息输入的类型。始终为 `message`。可能的值：`message`	No

OpenAI.EvalItemContent

OpenAI.EvalItemContent 的鉴别器

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

类型值	Schema
`input_text`	OpenAI.EvalItemContentInputText
`output_text`	OpenAI.EvalItemContentOutputText

Name	类型	Description	Required	Default
类型	OpenAI.EvalItemContentType		Yes

OpenAI.EvalItemContentInputText

Name	类型	Description	Required	Default
文本消息	字符串		Yes
类型	枚举	可能的值：`input_text`	Yes

OpenAI.EvalItemContentOutputText

Name	类型	Description	Required	Default
文本消息	字符串		Yes
类型	枚举	可能的值：`output_text`	Yes

OpenAI.EvalItemContentType

Property	Value
Type	字符串
Values	`input_text` `output_text`

OpenAI.EvalJsonlRunDataSourceParams

一个 JsonlRunDataSource 对象，该对象指定与 eval 匹配的 JSONL 文件

Name	类型	Description	Required
源	对象		Yes
└─ 内容	数组	jsonl 文件的内容。	No
{~ id	字符串	文件的标识符。	No
└─ 类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	No
类型	枚举	数据源的类型。始终为 `jsonl`。可能的值：`jsonl`	Yes

OpenAI.EvalList

一个表示评估列表的对象。

Name	类型	Description	Required
数据	数组	一组评估对象。	Yes
first_id	字符串	数据数组中第一个评估的标识符。	Yes
has_more	boolean	指示是否有更多的评估可用。	Yes
last_id	字符串	数据数组中最后一个评估的标识符。	Yes
对象	枚举	此对象的类型。它始终设置为“list”。可能的值：`list`	Yes

OpenAI.EvalLogsDataSourceConfigParams

一个数据源配置，用于指定日志查询的元数据属性。这通常是类似 usecase=chatbot 或 prompt-version=v2等的元数据。

Name	类型	Description	Required	Default
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
类型	枚举	数据源的类型。始终为 `logs`。可能的值：`logs`	Yes

OpenAI.EvalLogsDataSourceConfigResource

一个 LogsDataSourceConfig，指定日志查询的元数据属性。这通常是类似 usecase=chatbot 或 prompt-version=v2等的元数据。此数据源配置返回的架构用于定义 evals 中可用的变量。 item 和 sample 在使用此数据源配置时都得到了定义。

Name	类型	Description	Required
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	Yes
架构	对象	运行数据源项的 json 架构。了解如何在此处生成 JSON 架构。	Yes
类型	枚举	数据源的类型。始终为 `logs`。可能的值：`logs`	Yes

OpenAI.EvalResponsesRunDataSourceParams

描述模型采样配置的 ResponsesRunDataSource 对象。

Name	类型	Description	Required
输入消息	对象		No
item_reference	字符串	对命名空间中的变量的 `item` 引用。 Ie，“item.name”	No
~~ 模板	数组	构成提示或上下文的聊天消息列表。可能包括对命名空间的 `item` 变量引用，即 {{item.name}}。	No
└─ 类型	枚举	输入消息的类型。始终为 `item_reference`。可能的值：`item_reference`	No
模型	字符串	用于生成完成的模型的名称（例如“o3-mini”）。	No
采样参数	AzureEvalAPIResponseSamplingParams		No
源	对象		Yes
└─ 内容	数组	jsonl 文件的内容。	No
created_after	整数	仅包括在此时间戳之后创建的项（非独占）。这是用于选择响应的查询参数。	No
created_before	整数	仅包含在此时间戳之前创建的项（非独占）。这是用于选择响应的查询参数。	No
{~ id	字符串	文件的标识符。	No
instructions_search	字符串	用于搜索“指令”字段的可选字符串。这是用于选择响应的查询参数。	No
└─ 元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
└─ 模型	字符串	要查找其响应的模型的名称。这是用于选择响应的查询参数。	No
reasoning_effort	OpenAI.ReasoningEffort	可选的推理工作参数。这是用于选择响应的查询参数。	No
~~ 温度	number	采样温度。这是用于选择响应的查询参数。	No
└─ 工具	数组	工具名称列表。这是用于选择响应的查询参数。	No
top_p	number	核采样参数。这是用于选择响应的查询参数。	No
└─ 类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	No
~~ 用户	数组	用户标识符列表。这是用于选择响应的查询参数。	No
类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	Yes

OpenAI.EvalRun

表示评估运行的架构。

Name	类型	Description	Required
created_at	整数	创建评估运行时的 Unix 时间戳（以秒为单位）。	Yes
数据源	对象		Yes
└─ 类型	OpenAI.EvalRunDataSourceType		No
错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	Yes
eval_id	字符串	关联的评估的标识符。	Yes
id	字符串	评估运行的唯一标识符。	Yes
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	Yes
模型	字符串	评估的模型（如果适用）。	Yes
name	字符串	评估运行的名称。	Yes
对象	枚举	对象的类型。始终为“eval.run”。可能的值：`eval.run`	Yes
每模型使用量	数组	评估运行期间每个模型的使用情况统计信息。	Yes
per_testing_criteria_results	数组	评估运行期间应用的每个测试条件的结果。	Yes
report_url	字符串	UI 仪表板上呈现的评估运行报告的 URL。	Yes
result_counts	对象	汇总评估运行结果的计数器。	Yes
└─ 发生错误	整数	导致错误的输出项数。	No
~~ 失败	整数	未能通过评估的输出项数目。	No
└─ 通过	整数	通过评估的输出项数量。	No
~~ 总计	整数	执行的输出项总数。	No
状态	字符串	评估运行的状态。	Yes

OpenAI.EvalRunDataContentSource

OpenAI.EvalRunDataContentSource 的鉴别器

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

类型值	Schema
`file_id`	OpenAI.EvalRunFileIdDataContentSource
`stored_completions`	OpenAI.EvalRunStoredCompletionsDataContentSource
`responses`	OpenAI.EvalRunResponsesDataContentSource

Name	类型	Description	Required	Default
类型	OpenAI.EvalRunDataContentSourceType		Yes

OpenAI.EvalRunDataContentSourceType

Property	Value
Type	字符串
Values	`file_id` `file_content` `stored_completions` `responses`

OpenAI.EvalRunDataSourceCompletionsResource

Name	类型	Description	Required	Default
类型	枚举	可能的值：`completions`	Yes

OpenAI.EvalRunDataSourceJsonlResource

Name	类型	Description	Required	Default
类型	枚举	可能的值：`jsonl`	Yes

OpenAI.EvalRunDataSourceParams

OpenAI.EvalRunDataSourceParams 的鉴别器

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

类型值	Schema
`jsonl`	OpenAI.EvalJsonlRunDataSourceParams
`completions`	OpenAI.EvalCompletionsRunDataSourceParams
`responses`	OpenAI.EvalResponsesRunDataSourceParams

Name	类型	Description	Required	Default
类型	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResource

Name	类型	Description	Required	Default
类型	OpenAI.EvalRunDataSourceType		Yes

OpenAI.EvalRunDataSourceResponsesResource

Name	类型	Description	Required	Default
类型	枚举	可能的值：`responses`	Yes

OpenAI.EvalRunDataSourceType

Property	Value
Type	字符串
Values	`jsonl` `completions` `responses`

OpenAI.EvalRunFileContentDataContentSource

Name	类型	Description	Required	Default
内容	数组	jsonl 文件的内容。	Yes
类型	枚举	jsonl 源的类型。始终为 `file_content`。可能的值：`file_content`	Yes

OpenAI.EvalRunFileIdDataContentSource

Name	类型	Description	Required	Default
id	字符串	文件的标识符。	Yes
类型	枚举	jsonl 源的类型。始终为 `file_id`。可能的值：`file_id`	Yes

OpenAI.EvalRunList

表示评估的运行列表的对象。

Name	类型	Description	Required
数据	数组	一组评估运行对象。	Yes
first_id	字符串	数据数组中第一个评估运行的标识符。	Yes
has_more	boolean	指示是否有更多的评估可用。	Yes
last_id	字符串	数据数组中最后一个评估运行的标识符。	Yes
对象	枚举	此对象的类型。它始终设置为“list”。可能的值：`list`	Yes

OpenAI.EvalRunOutputItem

表示评估运行输出项的架构。

Name	类型	Description	Required
created_at	整数	创建评估运行时的 Unix 时间戳（以秒为单位）。	Yes
数据源项	对象	输入数据源项的详细信息。	Yes
数据源_项目_ID	整数	数据源项的标识符。	Yes
eval_id	字符串	评估组的标识符。	Yes
id	字符串	评估运行输出项的唯一标识符。	Yes
对象	枚举	对象的类型。始终为“eval.run.output_item”。可能的值：`eval.run.output_item`	Yes
results	数组	评估运行的结果列表。	Yes
run_id	字符串	与此输出项关联的评估运行的标识符。	Yes
示例	对象	包含评估运行的输入和输出的示例。	Yes
~~ 错误	OpenAI.EvalApiError	一个对象，表示来自 Eval API 的错误响应。	No
finish_reason	字符串	示例生成完成的原因。	No
└─ 输入	数组	一组输入消息。	No
max_completion_tokens	整数	补全允许的最大令牌数。	No
└─ 模型	字符串	用于生成示例的模型。	No
└─ 输出	数组	一组输出消息。	No
~~ 种子	整数	用于生成样本的种子。	No
~~ 温度	number	使用的采样温度。	No
top_p	number	用于采样的 top_p 值。	No
└─ 用法	对象	示例的令牌使用情况详细信息。	No
cached_tokens	整数	从缓存中检索到的令牌数。	No
completion_tokens	整数	生成的完成令牌数。	No
prompt_tokens	整数	使用的提示令牌数。	No
total_tokens	整数	使用的令牌总数。	No
状态	字符串	评估运行的状态。	Yes

OpenAI.EvalRunOutputItemList

一个对象，表示评估运行的输出项列表。

Name	类型	Description	Required
数据	数组	一组评估运行输出项对象。	Yes
first_id	字符串	数据数组中第一个评估运行输出项的标识符。	Yes
has_more	boolean	指示是否有更多可用的 eval 运行输出项。	Yes
last_id	字符串	数据数组中最后一个 eval 运行输出项的标识符。	Yes
对象	枚举	此对象的类型。它始终设置为“list”。可能的值：`list`	Yes

OpenAI.EvalRunResponsesDataContentSource

描述运行数据源配置的 EvalResponsesSource 对象。

Name	类型	Description	Required
created_after	整数	仅包括在此时间戳之后创建的项（非独占）。这是用于选择响应的查询参数。	No
created_before	整数	仅包含在此时间戳之前创建的项（非独占）。这是用于选择响应的查询参数。	No
instructions_search	字符串	用于搜索“指令”字段的可选字符串。这是用于选择响应的查询参数。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
模型	字符串	要查找其响应的模型的名称。这是用于选择响应的查询参数。	No
reasoning_effort	对象	仅适用于 O 系列模型限制推理模型的推理力度。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	No
temperature	number	采样温度。这是用于选择响应的查询参数。	No
tools	数组	工具名称列表。这是用于选择响应的查询参数。	No
top_p	number	核采样参数。这是用于选择响应的查询参数。	No
类型	枚举	运行数据源的类型。始终为 `responses`。可能的值：`responses`	Yes
用户	数组	用户标识符列表。这是用于选择响应的查询参数。	No

OpenAI.EvalRunStoredCompletionsDataContentSource

描述一组筛选器的 StoredCompletionsRunDataSource 配置

Name	类型	Description	Required
created_after	整数	一个可选的 Unix 时间戳，用于筛选在此时间之后创建的项。	No
created_before	整数	一个可选的 Unix 时间戳，用于筛选此时间之前创建的项。	No
limit	整数	（可选）要返回的最大项数。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	Yes
模型	字符串	用于筛选的可选模型（例如，“gpt-4o”）。	No
类型	枚举	源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigParams

弃用了 LogsDataSourceConfig。

Name	类型	Description	Required	Default
元数据	对象	存储的完成数据源的元数据筛选器。	No
类型	枚举	数据源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	Yes

OpenAI.EvalStoredCompletionsDataSourceConfigResource

弃用了 LogsDataSourceConfig。

Name	类型	Description	Required
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	Yes
架构	对象	运行数据源项的 json 架构。了解如何在此处生成 JSON 架构。	Yes
类型	枚举	数据源的类型。始终为 `stored_completions`。可能的值：`stored_completions`	Yes

OpenAI.FileSearchTool

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

Name	类型	Description	Required
filters	对象		No
max_num_results	整数	要返回的最大结果数。此数字应介于 1 和 50 之间（含）。	No
ranking_options	对象		No
~~ 排名器	枚举	用于文件搜索的排序算法。可能的值： `autodefault-2024-11-15`	No
分数阈值	number	文件搜索的分数阈值，介于 0 和 1 之间。接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。	No
类型	枚举	文件搜索工具的类型。始终为 `file_search`。可能的值：`file_search`	Yes
vector_store_ids	数组	要搜索的矢量存储的 ID。	Yes

OpenAI.FileSearchToolCallItemParam

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

Name	类型	Description	Required
queries	数组	用于搜索文件的查询。	Yes
results	数组	文件搜索工具调用的结果。	No
类型	枚举	可能的值：`file_search_call`	Yes

OpenAI.FileSearchToolCallItemResource

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

Name	类型	Description	Required
queries	数组	用于搜索文件的查询。	Yes
results	数组	文件搜索工具调用的结果。	No
状态	枚举	文件搜索工具调用的状态。以下之一：`in_progress`、 `searching`、`incomplete`或`failed` 可能的值：`in_progress`、、`searchingcompleted`、`incomplete`、`failed`	Yes
类型	枚举	可能的值：`file_search_call`	Yes

OpenAI.Filters

Name	类型	Description	Required
filters	数组	要组合的筛选器数组。项可以是 `ComparisonFilter` 或 `CompoundFilter`。	Yes
关键值	字符串	要与值进行比较的键。	Yes
类型	枚举	操作类型：`and` 或 `or`。可能的值： `andor`	Yes
value	字符串或数字或布尔值	要与属性键进行比较的值;支持字符串、数字或布尔类型。	Yes

OpenAI.FineTuneDPOHyperparameters

用于 DPO 微调作业的超参数。

Name	类型	Description	Required
批处理大小	枚举	可能的值：`auto`	No
beta 版本	枚举	可能的值：`auto`	No
学习率乘数 (learning_rate_multiplier)	枚举	可能的值：`auto`	No
n_epochs	枚举	可能的值：`auto`	No

OpenAI.FineTuneDPOMethod

DPO 微调方法的配置。

Name	类型	Description	Required	Default
超参数	OpenAI.FineTuneDPOHyperparameters	用于 DPO 微调作业的超参数。	No

OpenAI.FineTuneMethod

用于微调的方法。

Name	类型	Description	Required
dpo	OpenAI.FineTuneDPOMethod	DPO 微调方法的配置。	No
加固	AzureFineTuneReinforcementMethod		No
监督	OpenAI.FineTuneSupervisedMethod	监督式微调方法的配置。	No
类型	枚举	方法的类型。 `supervised`要么是，`dpo`要么`reinforcement`。可能的值：`supervised`、、 `dporeinforcement`	Yes

OpenAI.FineTuneReinforcementHyperparameters

用于强化微调作业的超参数。

Name	类型	Description	Required
批处理大小	枚举	可能的值：`auto`	No
compute_multiplier	枚举	可能的值：`auto`	No
eval_interval	枚举	可能的值：`auto`	No
eval_samples	枚举	可能的值：`auto`	No
学习率乘数 (learning_rate_multiplier)	枚举	可能的值：`auto`	No
n_epochs	枚举	可能的值：`auto`	No
reasoning_effort	枚举	推理工作级别。可能的值：`default`、`low`、`medium`、`high`	No

OpenAI.FineTuneSupervisedHyperparameters

用于微调作业的超参数。

Name	类型	Description	Required
批处理大小	枚举	可能的值：`auto`	No
学习率乘数 (learning_rate_multiplier)	枚举	可能的值：`auto`	No
n_epochs	枚举	可能的值：`auto`	No

OpenAI.FineTuneSupervisedMethod

监督式微调方法的配置。

Name	类型	Description	Required	Default
超参数	OpenAI.FineTuneSupervisedHyperparameters	用于微调作业的超参数。	No

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration 的鉴别器

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

类型值	Schema
`wandb`	OpenAI.FineTuningIntegrationWandb

Name	类型	Description	Required	Default
类型	字符串（请参阅下面的有效模型）		Yes

OpenAI.FineTuningIntegrationWandb

Name	类型	Description	Required
类型	枚举	正在为微调作业启用的集成类型可能的值：`wandb`	Yes
wandb	对象	与权重和偏差的集成设置。此有效负载指定项目指标将发送到。（可选）可以为运行设置显式显示名称，添加标记设置为运行，并将默认实体（团队、用户名等）设置为与运行相关联。	Yes
~~ 实体	字符串	要用于运行的实体。这样，你可以设置要设置的 WandB 用户的团队或用户名与运行关联的类似。如果未设置，则使用已注册 WandB API 密钥的默认实体。	No
└─ 名称	字符串	要为运行设置的显示名称。如果未设置，我们将使用作业 ID 作为名称。	No
~~ 项目	字符串	将在其中创建新运行的项目的名称。	No
~~ 标记	数组	要附加到新创建的运行的标记列表。这些标记直接传递到 WandB。部分默认标记由 OpenAI 生成：“openai/finetune”、“openai/{base-model}”、“openai/{ftjob-abcdef}”。	No

OpenAI.FineTuningJob

该 fine_tuning.job 对象表示通过 API 创建的微调作业。

Name	类型	Description	Required
created_at	整数	创建微调作业时的 Unix 时间戳（以秒为单位）。	Yes
错误	对象	对于具有 `failed`微调作业的作业，这将包含有关失败原因的详细信息。	Yes
└─ 代码	字符串	计算机可读错误代码。	No
└─ 消息	字符串	用户可读的错误消息。	No
└─ 参数	字符串	无效的参数通常 `training_file` 为或 `validation_file`。如果失败不特定于参数，则此字段将为 null。	No
预计完成	整数	估计微调作业完成时间的 Unix 时间戳（以秒为单位）。如果微调作业未运行，该值将为 null。	No
微调模型	字符串	正在创建的微调模型的名称。如果微调作业仍在运行，该值将为 null。	Yes
finished_at	整数	完成微调作业的 Unix 时间戳（以秒为单位）。如果微调作业仍在运行，该值将为 null。	Yes
超参数	对象	用于微调作业的超参数。仅当运行 `supervised` 作业时，才会返回此值。	Yes
batch_size	枚举	可能的值：`auto`	No
learning_rate_multiplier	枚举	可能的值：`auto`	No
n_epochs	枚举	可能的值：`auto`	No
id	字符串	可以在 API 终结点中引用的对象标识符。	Yes
整合	数组	要为此微调作业启用的集成列表。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	Yes
方法	OpenAI.FineTuneMethod	用于微调的方法。	No
模型	字符串	正在微调的基本模型。	Yes
对象	枚举	对象类型，始终为“fine_tuning.job”。可能的值：`fine_tuning.job`	Yes
organization_id	字符串	拥有微调作业的组织。	Yes
result_files	数组	用于微调作业的已编译结果文件 ID。可以使用文件 API 检索结果。	Yes
seed	整数	用于微调作业的种子。	Yes
状态	枚举	微调作业的当前状态，可以是`validating_files`、`queued`、`running`、`succeeded`或`failedcancelled`。可能的值：`validating_files`、、`queued`、`runningsucceeded`、`failed`、`cancelled`	Yes
trained_tokens	整数	此微调作业处理的可计费令牌总数。如果微调作业仍在运行，该值将为 null。	Yes
训练文件	字符串	用于训练的文件 ID。可以使用文件 API 检索训练数据。	Yes
user_provided_suffix	字符串	应用于作业的描述性后缀，如作业创建请求中指定的。	No
验证文件	字符串	用于验证的文件 ID。可以使用文件 API 检索验证结果。	Yes

OpenAI.FineTuningJobCheckpoint

该 fine_tuning.job.checkpoint 对象表示可用于微调作业的模型检查点。

Name	类型	Description	Required
created_at	整数	创建检查点的时间的 Unix 时间戳（以秒为单位）。	Yes
调整好的模型检查点	字符串	创建的微调检查点模型的名称。	Yes
微调任务ID (fine_tuning_job_id)	字符串	从中创建此检查点的微调作业的名称。	Yes
id	字符串	可在 API 终结点中引用的检查点标识符。	Yes
指标	对象	微调作业期间步骤编号的指标。	Yes
full_valid_loss	number		No
full_valid_mean_token_accuracy	number		No
~~ 步骤	number		No
train_loss	number		No
train_mean_token_accuracy	number		No
valid_loss	number		No
valid_mean_token_accuracy	number		No
对象	枚举	对象类型，始终为“fine_tuning.job.checkpoint”。可能的值：`fine_tuning.job.checkpoint`	Yes
步骤编号	整数	创建检查点的步号。	Yes

OpenAI.FineTuningJobEvent

微调作业事件对象

Name	类型	Description	Required
created_at	整数	创建微调作业时的 Unix 时间戳（以秒为单位）。	Yes
数据		与事件关联的数据。	No
id	字符串	对象标识符。	Yes
水平仪	枚举	事件的日志级别。可能的值：`info`、、 `warnerror`	Yes
消息	字符串	事件的消息。	Yes
对象	枚举	对象类型，始终为“fine_tuning.job.event”。可能的值：`fine_tuning.job.event`	Yes
类型	枚举	事件类型。可能的值： `messagemetrics`	No

OpenAI.FunctionObject

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

OpenAI.FunctionTool

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

Name	类型	Description	Required
description	字符串	函数的说明。该模型用于判断是否调用函数。	No
name	字符串	要调用的函数名称。	Yes
parameters		描述函数参数的 JSON 架构对象。	Yes
strict	boolean	是否强制实施严格的参数验证。默认 `true`。	Yes
类型	枚举	函数工具的类型。始终为 `function`。可能的值：`function`	Yes

OpenAI.FunctionToolCallItemParam

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

Name	类型	Description	Required
arguments	字符串	要传递给函数的参数的 JSON 字符串。	Yes
call_id	字符串	模型生成的函数工具调用的唯一 ID。	Yes
name	字符串	要运行的函数的名称。	Yes
类型	枚举	可能的值：`function_call`	Yes

OpenAI.FunctionToolCallItemResource

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

Name	类型	Description	Required
arguments	字符串	要传递给函数的参数的 JSON 字符串。	Yes
call_id	字符串	模型生成的函数工具调用的唯一 ID。	Yes
name	字符串	要运行的函数的名称。	Yes
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	Yes
类型	枚举	可能的值：`function_call`	Yes

OpenAI.FunctionToolCallOutputItemParam

函数工具调用的输出。

Name	类型	Description	Required
call_id	字符串	模型生成的函数工具调用的唯一 ID。	Yes
输出	字符串	函数工具调用输出的 JSON 字符串。	Yes
类型	枚举	可能的值：`function_call_output`	Yes

OpenAI.FunctionToolCallOutputItemResource

函数工具调用的输出。

Name	类型	Description	Required
call_id	字符串	模型生成的函数工具调用的唯一 ID。	Yes
输出	字符串	函数工具调用输出的 JSON 字符串。	Yes
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	Yes
类型	枚举	可能的值：`function_call_output`	Yes

OpenAI.Grader

OpenAI.Grader 的鉴别器

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

类型值	Schema
`label_model`	OpenAI.GraderLabelModel
`text_similarity`	OpenAI.GraderTextSimilarity
`python`	OpenAI.GraderPython
`score_model`	OpenAI.GraderScoreModel
`multi`	OpenAI.GraderMulti

Name	类型	Description	Required	Default
类型	OpenAI.GraderType		Yes

OpenAI.GraderLabelModel

一个 LabelModelGrader 对象，该对象使用模型将标签分配给评估中的每个项。

Name	类型	Description	Required
输入	数组		Yes
标签	数组	要分配给评估中每个项的标签。	Yes
模型	字符串	要用于评估的模型。必须支持结构化输出。	Yes
name	字符串	评分程序的名称。	Yes
passing_labels	数组	指示通过结果的标签。必须是标签的子集。	Yes
类型	枚举	始终为 `label_model` 的对象类型。可能的值：`label_model`	Yes

OpenAI.GraderMulti

MultiGrader 对象合并了多个评分员的输出，以生成单个分数。

Name	类型	Description	Required
calculate_output	字符串	用于基于评分器结果计算输出的公式。	Yes
年级	对象		Yes
name	字符串	评分程序的名称。	Yes
类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	Yes

OpenAI.GraderPython

在输入上运行 Python 脚本的 PythonGrader 对象。

Name	类型	Description	Required
image_tag	字符串	用于 python 脚本的图像标记。	No
name	字符串	评分程序的名称。	Yes
源	字符串	python 脚本的源代码。	Yes
类型	枚举	始终为 `python` 的对象类型。可能的值：`python`	Yes

OpenAI.GraderScoreModel

一个 ScoreModelGrader 对象，该对象使用模型将分数分配给输入。

Name	类型	Description	Required
输入	数组	输入文本。这可能包括模板字符串。	Yes
模型	字符串	要用于评估的模型。	Yes
name	字符串	评分程序的名称。	Yes
范围	数组	分数的范围。默认为 `[0, 1]`。	No
采样参数		模型的采样参数。	No
类型	枚举	始终为 `score_model` 的对象类型。可能的值：`score_model`	Yes

OpenAI.GraderStringCheck

一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。

Name	类型	Description	Required
输入	字符串	输入文本。这可能包括模板字符串。	Yes
name	字符串	评分程序的名称。	Yes
操作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	Yes
引用	字符串	引用文本。这可能包括模板字符串。	Yes
类型	枚举	始终为 `string_check` 的对象类型。可能的值：`string_check`	Yes

OpenAI.GraderTextSimilarity

TextSimilarityGrader 对象，该对象基于相似性指标对文本进行评分。

Name	类型	Description	Required
评估指标	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	Yes
输入	字符串	正在评分的文本。	Yes
name	字符串	评分程序的名称。	Yes
引用	字符串	作为评分参照的文本。	Yes
类型	枚举	评分程序的类型。可能的值：`text_similarity`	Yes

OpenAI.GraderType

Property	Value
Type	字符串
Values	`string_check` `text_similarity` `score_model` `label_model` `python` `multi`

OpenAI.ImageGenTool

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

Name	类型	Description	Required	Default
后台的	枚举	生成的图像的背景类型。 `transparent`、 `opaque` 或 `auto` 中的一项。默认值：`auto`。可能的值：`transparent`、、 `opaqueauto`	No
input_image_mask	对象	用于修复的可选掩码。包含 `image_url` （字符串，可选）和 `file_id` （字符串，可选）。	No
file_id	字符串	掩码图像的文件 ID。	No
image_url	字符串	Base64 编码的掩码图像。	No
模型	枚举	要使用的图像生成模型。默认值：`gpt-image-1`。可能的值：`gpt-image-1`	No
moderation	枚举	生成图像的审核级别。默认值：`auto`。可能的值： `autolow`	No
output_compression	整数	输出图像的压缩级别。默认值：100。	No	100
output_format	枚举	生成的图像的输出格式。以下之一：`png`、`webp` 或 `jpeg`。默认值：`png`。可能的值：`png`、、 `webpjpeg`	No
partial_images	整数	在流式处理模式中可以生成的部分图像数量，从 0（默认值）到 3。	No	0
quality	枚举	生成的图像的质量。其中一个`low`，`medium`，， `high` 或 `auto`。默认值：`auto`。可能的值：`low`、`medium`、`high`、`auto`	No
size	枚举	生成的映像的大小。其中一个`1024x1024`， `1024x1536` `1536x1024` 或 `auto` 中的一项。默认值：`auto`。可能的值：`1024x1024`、`1024x1536`、`1536x1024`、`auto`	No
类型	枚举	图像生成工具的类型。始终为 `image_generation`。可能的值：`image_generation`	Yes

OpenAI.ImageGenToolCallItemParam

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

Name	类型	Description	Required	Default
result	字符串	以 base64 编码生成的图像。	Yes
类型	枚举	可能的值：`image_generation_call`	Yes

OpenAI.ImageGenToolCallItemResource

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

Name	类型	Description	Required
result	字符串	以 base64 编码生成的图像。	Yes
状态	枚举	可能的值：`in_progress`、`completed`、`generating`、`failed`	Yes
类型	枚举	可能的值：`image_generation_call`	Yes

OpenAI.ImplicitUserMessage

Name	类型	Description	Required	Default
内容	字符串或数组		Yes

OpenAI.Includable

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

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

Property	Value
Description	指定要包含在模型响应中的其他输出数据。现在支持的值包括： - `code_interpreter_call.outputs`：包括 python 代码执行的输出在代码解释器工具调用项中。 - `computer_call_output.output.image_url`：包括计算机调用输出中的图像 URL。 - `file_search_call.results`：包括文件搜索工具的搜索结果。 - `message.input_image.image_url`：包括输入消息中的图像链接。 - `message.output_text.logprobs`：包括带助理消息的日志程序。 - `reasoning.encrypted_content`：包括加密版本的推理推理项目输出中的令牌。这样就可以在无状态使用响应 API 时，在多轮次对话中使用推理项（例如当参数 `store` 设置为 `false`，或当组织在零数据保留计划中注册时）。
Type	字符串
Values	`code_interpreter_call.outputs` `computer_call_output.output.image_url` `file_search_call.results` `message.input_image.image_url` `message.output_text.logprobs` `reasoning.encrypted_content`

OpenAI.ItemContent

OpenAI.ItemContent 的鉴别器

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

类型值	Schema
`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

Name	类型	Description	Required	Default
类型	OpenAI.ItemContentType	多模态输入和输出内容。	Yes

OpenAI.ItemContentInputAudio

模型的音频输入。

Name	类型	Description	Required
数据	字符串	Base64 编码的音频数据。	Yes
format	枚举	音频数据的格式。当前支持的格式包括 `mp3` 和 `wav`。可能的值： `mp3wav`	Yes
类型	枚举	输入项的类型。始终为 `input_audio`。可能的值：`input_audio`	Yes

OpenAI.ItemContentInputFile

模型的文件输入。

Name	类型	Description	Required
file_data	字符串	要发送到模型的文件的内容。	No
file_id	字符串	要发送到模型的文件的 ID。	No
filename	字符串	要发送到模型的文件的名称。	No
类型	枚举	输入项的类型。始终为 `input_file`。可能的值：`input_file`	Yes

OpenAI.ItemContentInputImage

输入到模型中的图像

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

OpenAI.ItemContentInputText

模型的文本输入。

Name	类型	Description	Required	Default
文本消息	字符串	模型的文本输入。	Yes
类型	枚举	输入项的类型。始终为 `input_text`。可能的值：`input_text`	Yes

OpenAI.ItemContentOutputAudio

模型的音频输出。

Name	类型	Description	Required
数据	字符串	来自模型的 Base64 编码音频数据。	Yes
脚本	字符串	来自模型的音频数据转录。	Yes
类型	枚举	输出音频的类型。始终为 `output_audio`。可能的值：`output_audio`	Yes

OpenAI.ItemContentOutputText

模型的文本输出。

Name	类型	Description	Required
annotations	数组	文本输出的注释。	Yes
logprobs	数组		No
文本消息	字符串	模型的文本输出。	Yes
类型	枚举	输出文本的类型。始终为 `output_text`。可能的值：`output_text`	Yes

OpenAI.ItemContentRefusal

模型的拒绝。

Name	类型	Description	Required	Default
refusal	字符串	模型的拒绝解释。	Yes
类型	枚举	拒绝的类型。始终为 `refusal`。可能的值：`refusal`	Yes

OpenAI.ItemContentType

多模态输入和输出内容。

Property	Value
Description	多模态输入和输出内容。
Type	字符串
Values	`input_text` `input_audio` `input_image` `input_file` `output_text` `output_audio` `refusal`

OpenAI.ItemParam

用于生成响应的内容项。

OpenAI.ItemParam 的鉴别器

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

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

Name	类型	Description	Required	Default
类型	OpenAI.ItemType		Yes

OpenAI.ItemReferenceItemParam

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

Name	类型	Description	Required	Default
id	字符串	要引用的以前生成的响应项的服务发起的 ID。	Yes
类型	枚举	可能的值：`item_reference`	Yes

OpenAI.ItemResource

用于生成响应的内容项。

OpenAI.ItemResource 的鉴别器

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

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

Name	类型	Description	Required	Default
id	字符串		Yes
类型	OpenAI.ItemType		Yes

OpenAI.ItemType

Property	Value
Type	字符串
Values	`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` `local_shell_call` `local_shell_call_output` `mcp_list_tools` `mcp_approval_request` `mcp_approval_response` `mcp_call`

OpenAI.ListFineTuningJobCheckpointsResponse

Name	类型	Description	Required
数据	数组		Yes
first_id	字符串		No
has_more	boolean		Yes
last_id	字符串		No
对象	枚举	可能的值：`list`	Yes

OpenAI.ListFineTuningJobEventsResponse

Name	类型	Description	Required
数据	数组		Yes
has_more	boolean		Yes
对象	枚举	可能的值：`list`	Yes

OpenAI.ListModelsResponse

Name	类型	Description	Required	Default
数据	数组		Yes
对象	枚举	可能的值：`list`	Yes

OpenAI.ListPaginatedFineTuningJobsResponse

Name	类型	Description	Required
数据	数组		Yes
has_more	boolean		Yes
对象	枚举	可能的值：`list`	Yes

OpenAI.ListVectorStoreFilesFilter

Property	Value
Type	字符串
Values	`in_progress` `completed` `failed` `cancelled`

OpenAI.ListVectorStoreFilesResponse

Name	类型	Description	Required
数据	数组		Yes
first_id	字符串		Yes
has_more	boolean		Yes
last_id	字符串		Yes
对象	枚举	可能的值：`list`	Yes

OpenAI.ListVectorStoresResponse

Name	类型	Description	Required
数据	数组		Yes
first_id	字符串		Yes
has_more	boolean		Yes
last_id	字符串		Yes
对象	枚举	可能的值：`list`	Yes

OpenAI.LocalShellExecAction

在服务器上执行 shell 命令。

Name	类型	Description	Required
指令	数组	要执行的命令	Yes
env	对象	要为命令设置的环境变量。	Yes
timeout_ms	整数	命令的可选超时（以毫秒为单位）。	No
类型	枚举	本地 shell作的类型。始终为 `exec`。可能的值：`exec`	Yes
用户	字符串	运行命令的可选用户。	No
working_directory	字符串	要在其中运行命令的可选工作目录。	No

OpenAI.LocalShellTool

一种工具，允许模型在本地环境中执行 shell 命令。

Name	类型	Description	Required	Default
类型	枚举	本地 shell 工具的类型。始终为 `local_shell`。可能的值：`local_shell`	Yes

OpenAI.LocalShellToolCallItemParam

用于在本地 shell 上运行命令的工具调用。

Name	类型	Description	Required
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	Yes
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	Yes
类型	枚举	可能的值：`local_shell_call`	Yes

OpenAI.LocalShellToolCallItemResource

用于在本地 shell 上运行命令的工具调用。

Name	类型	Description	Required
操作	OpenAI.LocalShellExecAction	在服务器上执行 shell 命令。	Yes
call_id	字符串	模型生成的本地 shell 工具调用的唯一 ID。	Yes
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	Yes
类型	枚举	可能的值：`local_shell_call`	Yes

OpenAI.LocalShellToolCallOutputItemParam

本地 shell 工具调用的输出。

Name	类型	Description	Required	Default
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	Yes
类型	枚举	可能的值：`local_shell_call_output`	Yes

OpenAI.LocalShellToolCallOutputItemResource

本地 shell 工具调用的输出。

Name	类型	Description	Required
输出	字符串	本地 shell 工具调用输出的 JSON 字符串。	Yes
状态	枚举	可能的值：`in_progress`、、 `completedincomplete`	Yes
类型	枚举	可能的值：`local_shell_call_output`	Yes

OpenAI.Location

OpenAI.Location 的鉴别器

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

类型值	Schema
`approximate`	OpenAI.ApproximateLocation

Name	类型	Description	Required	Default
类型	OpenAI.LocationType		Yes

OpenAI.LocationType

Property	Value
Type	字符串
Values	`approximate`

OpenAI.LogProb

标记的对数概率。

Name	类型	Required
bytes	数组	Yes
logprob	number	Yes
代币	字符串	Yes
top_logprobs	数组	Yes

OpenAI.MCPApprovalRequestItemParam

请求人工批准工具调用。

Name	类型	Description	Required
arguments	字符串	工具的参数的 JSON 字符串。	Yes
name	字符串	要运行的工具的名称。	Yes
server_label	字符串	发出请求的 MCP 服务器的标签。	Yes
类型	枚举	可能的值：`mcp_approval_request`	Yes

OpenAI.MCPApprovalRequestItemResource

请求人工批准工具调用。

Name	类型	Description	Required
arguments	字符串	工具的参数的 JSON 字符串。	Yes
name	字符串	要运行的工具的名称。	Yes
server_label	字符串	发出请求的 MCP 服务器的标签。	Yes
类型	枚举	可能的值：`mcp_approval_request`	Yes

OpenAI.MCPApprovalResponseItemParam

对 MCP 审批请求的响应。

Name	类型	Description	Required
approval_request_id	字符串	正在应答的审批请求的 ID。	Yes
approve	boolean	请求是否已获得批准。	Yes
reason	字符串	决定的可选原因。	No
类型	枚举	可能的值：`mcp_approval_response`	Yes

OpenAI.MCPApprovalResponseItemResource

对 MCP 审批请求的响应。

Name	类型	Description	Required
approval_request_id	字符串	正在应答的审批请求的 ID。	Yes
approve	boolean	请求是否已获得批准。	Yes
reason	字符串	决定的可选原因。	No
类型	枚举	可能的值：`mcp_approval_response`	Yes

OpenAI.MCPCallItemParam

在 MCP 服务器上调用工具。

Name	类型	Description	Required
arguments	字符串	传递给工具的参数的 JSON 字符串。	Yes
错误	字符串	工具调用中的错误（如果有）。	No
name	字符串	运行的工具的名称。	Yes
输出	字符串	工具调用的输出。	No
server_label	字符串	运行该工具的 MCP 服务器的标签。	Yes
类型	枚举	可能的值：`mcp_call`	Yes

OpenAI.MCPCallItemResource

在 MCP 服务器上调用工具。

Name	类型	Description	Required
arguments	字符串	传递给工具的参数的 JSON 字符串。	Yes
错误	字符串	工具调用中的错误（如果有）。	No
name	字符串	运行的工具的名称。	Yes
输出	字符串	工具调用的输出。	No
server_label	字符串	运行该工具的 MCP 服务器的标签。	Yes
类型	枚举	可能的值：`mcp_call`	Yes

OpenAI.MCPListToolsItemParam

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

Name	类型	Description	Required
错误	字符串	如果服务器无法列出工具，则显示错误消息。	No
server_label	字符串	MCP 服务器的标签。	Yes
tools	数组	服务器上可用的工具。	Yes
类型	枚举	可能的值：`mcp_list_tools`	Yes

OpenAI.MCPListToolsItemResource

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

Name	类型	Description	Required
错误	字符串	如果服务器无法列出工具，则显示错误消息。	No
server_label	字符串	MCP 服务器的标签。	Yes
tools	数组	服务器上可用的工具。	Yes
类型	枚举	可能的值：`mcp_list_tools`	Yes

OpenAI.MCPListToolsTool

MCP 服务器上可用的工具。

Name	类型	Description	Required
annotations		有关该工具的其他注释。	No
description	字符串	工具的说明。	No
input_schema		描述工具输入的 JSON 架构。	Yes
name	字符串	工具的名称。	Yes

OpenAI.MCPTool

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

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

OpenAI.MetadataPropertyForRequest

按 16 个成组的可附加到对象的键值对。这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。

键是最大长度为 64 个字符的字符串。值为最大长度为 512 个字符的字符串。

Name	类型	Description	Required	Default
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No

OpenAI.Model

介绍可与 API 一起使用的 OpenAI 模型产品/服务。

Name	类型	Description	Required
created	整数	创建模型时，Unix 时间戳（以秒为单位）。	Yes
id	字符串	可以在 API 终结点中引用的模型标识符。	Yes
对象	枚举	对象类型，始终为“model”。可能的值：`model`	Yes
owned_by	字符串	拥有模型的组织。	Yes

OpenAI.OtherChunkingStrategyResponseParam

当分块策略未知时，将返回此值。通常，这是因为文件是在 API 中引入 chunking_strategy 概念之前编制索引的。

Name	类型	Description	Required	Default
类型	枚举	始终为 `other`。可能的值：`other`	Yes

OpenAI.ParallelToolCalls

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

类型：布尔值

OpenAI.Prompt

对提示模板及其变量的引用。

Name	类型	Description	Required
id	字符串	要使用的提示模板的唯一标识符。	Yes
变量	对象	用于替换变量的值的可选映射提示。替换值可以是字符串或其他响应输入类型，如图像或文件。	No
版本	字符串	提示模板的可选版本。	No

OpenAI.RankingOptions

Name	类型	Description	Required	Default
排名程序	枚举	用于文件搜索的排序算法。可能的值： `autodefault-2024-11-15`	No
score_threshold	number	文件搜索的分数阈值，介于 0 和 1 之间。接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。	No

OpenAI.Reasoning

仅适用于 O 系列模型

Name	类型	Description	Required
工作量	对象	仅适用于 O 系列模型限制推理模型的推理力度。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。	No
generate_summary	枚举	已弃用：改用 `summary` 。模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	No
摘要	枚举	模型执行的推理摘要。这可以是可用于调试和了解模型的推理过程。 `auto`、`concise` 或 `detailed` 之一。可能的值：`auto`、、 `concisedetailed`	No

OpenAI.ReasoningEffort

仅适用于 O 系列模型

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

Property	Value
Description	仅适用于 O 系列模型限制推理模型的推理力度。当前支持的值为 `low`、`medium` 和 `high`。减少推理努力可能会导致更快的响应和更少的标记使用于响应中的推理。
Type	字符串
Values	`low` `medium` `high`

OpenAI.ReasoningItemParam

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

Name	类型	Description	Required
encrypted_content	字符串	推理项的加密内容 - 在在 `reasoning.encrypted_content` 参数中使用 `include` 生成响应时填充。	No
摘要	数组	推理文本内容。	Yes
类型	枚举	可能的值：`reasoning`	Yes

OpenAI.ReasoningItemResource

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

Name	类型	Description	Required
encrypted_content	字符串	推理项的加密内容 - 在在 `reasoning.encrypted_content` 参数中使用 `include` 生成响应时填充。	No
摘要	数组	推理文本内容。	Yes
类型	枚举	可能的值：`reasoning`	Yes

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart 的鉴别器

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

类型值	Schema
`summary_text`	OpenAI.ReasoningItemSummaryTextPart

Name	类型	Description	Required	Default
类型	OpenAI.ReasoningItemSummaryPartType		Yes

OpenAI.ReasoningItemSummaryPartType

Property	Value
Type	字符串
Values	`summary_text`

OpenAI.ReasoningItemSummaryTextPart

Name	类型	Description	Required	Default
文本消息	字符串		Yes
类型	枚举	可能的值：`summary_text`	Yes

OpenAI.Response

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

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

当代码解释器流式传输部分代码片段时发出。

Name	类型	Description	Required
delta	字符串	由代码解释器流式传输的部分代码片段。	Yes
item_id	字符串	代码解释器工具调用项的唯一标识符。	Yes
output_index	整数	要为其流式传输代码的响应中的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.code_interpreter_call_code.delta`。可能的值：`response.code_interpreter_call_code.delta`	Yes

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

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

Name	类型	Description	Required
代码	字符串	代码解释器输出的最终代码片段。	Yes
item_id	字符串	代码解释器工具调用项的唯一标识符。	Yes
output_index	整数	在完成代码的响应中输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.code_interpreter_call_code.done`。可能的值：`response.code_interpreter_call_code.done`	Yes

OpenAI.ResponseCodeInterpreterCallCompletedEvent

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

Name	类型	Description	Required
item_id	字符串	代码解释器工具调用项的唯一标识符。	Yes
output_index	整数	完成代码解释器调用的响应中的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.code_interpreter_call.completed`。可能的值：`response.code_interpreter_call.completed`	Yes

OpenAI.ResponseCodeInterpreterCallInProgressEvent

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

Name	类型	Description	Required
item_id	字符串	代码解释器工具调用项的唯一标识符。	Yes
output_index	整数	正在进行代码解释器调用的响应中输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.code_interpreter_call.in_progress`。可能的值：`response.code_interpreter_call.in_progress`	Yes

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

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

Name	类型	Description	Required
item_id	字符串	代码解释器工具调用项的唯一标识符。	Yes
output_index	整数	代码解释器正在解释代码的响应中输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.code_interpreter_call.interpreting`。可能的值：`response.code_interpreter_call.interpreting`	Yes

OpenAI.ResponseCompletedEvent

模型响应完成时发出。

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

OpenAI.ResponseContentPartAddedEvent

添加新内容部分时发出。

Name	类型	Description	Required
content_index	整数	已添加的内容部分的索引。	Yes
item_id	字符串	将内容部分添加到的输出项的 ID。	Yes
output_index	整数	将内容部分添加到的输出项的索引。	Yes
部件	对象		Yes
└─ 类型	OpenAI.ItemContentType	多模态输入和输出内容。	No
类型	枚举	事件类型。始终为 `response.content_part.added`。可能的值：`response.content_part.added`	Yes

OpenAI.ResponseContentPartDoneEvent

完成内容部分时发出。

Name	类型	Description	Required
content_index	整数	完成的内容部分的索引。	Yes
item_id	字符串	将内容部分添加到的输出项的 ID。	Yes
output_index	整数	将内容部分添加到的输出项的索引。	Yes
部件	对象		Yes
└─ 类型	OpenAI.ItemContentType	多模态输入和输出内容。	No
类型	枚举	事件类型。始终为 `response.content_part.done`。可能的值：`response.content_part.done`	Yes

OpenAI.ResponseCreatedEvent

创建响应时发出的事件。

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

OpenAI.ResponseError

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

Name	类型	Description	Required	Default
代码	OpenAI.ResponseErrorCode	响应的错误代码。	Yes
消息	字符串	可读的错误说明。	Yes

OpenAI.ResponseErrorCode

响应的错误代码。

Property	Value
Description	响应的错误代码。
Type	字符串
Values	`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

在发生错误时发出。

Name	类型	Description	Required
代码	字符串	错误代码。	Yes
消息	字符串	错误消息。	Yes
param	字符串	错误参数。	Yes
类型	枚举	事件类型。始终为 `error`。可能的值：`error`	Yes

OpenAI.ResponseFailedEvent

响应失败时发出的事件。

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

OpenAI.ResponseFileSearchCallCompletedEvent

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

Name	类型	Description	Required
item_id	字符串	启动文件搜索调用的输出项的 ID。	Yes
output_index	整数	启动文件搜索调用的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.file_search_call.completed`。可能的值：`response.file_search_call.completed`	Yes

OpenAI.ResponseFileSearchCallInProgressEvent

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

Name	类型	Description	Required
item_id	字符串	启动文件搜索调用的输出项的 ID。	Yes
output_index	整数	启动文件搜索调用的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.file_search_call.in_progress`。可能的值：`response.file_search_call.in_progress`	Yes

OpenAI.ResponseFileSearchCallSearchingEvent

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

Name	类型	Description	Required
item_id	字符串	启动文件搜索调用的输出项的 ID。	Yes
output_index	整数	文件搜索调用正在搜索的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.file_search_call.searching`。可能的值：`response.file_search_call.searching`	Yes

OpenAI.ResponseFormat

OpenAI.ResponseFormat 的鉴别器

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

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

Name	类型	Description	Required	Default
类型	枚举	可能的值：`text`、、 `json_objectjson_schema`	Yes

OpenAI.ResponseFormatJsonObject

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

Name	类型	Description	Required	Default
类型	枚举	要定义的响应格式的类型。始终为 `json_object`。可能的值：`json_object`	Yes

OpenAI.ResponseFormatJsonSchema

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

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

OpenAI.ResponseFormatJsonSchemaSchema

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

类型：对象

OpenAI.ResponseFormatText

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

Name	类型	Description	Required	Default
类型	枚举	要定义的响应格式的类型。始终为 `text`。可能的值：`text`	Yes

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

Name	类型	Description	Required
delta	字符串	添加的函数调用参数增量。	Yes
item_id	字符串	函数调用参数增量添加到的输出项的 ID。	Yes
output_index	整数	函数调用参数增量添加到的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.function_call_arguments.delta`。可能的值：`response.function_call_arguments.delta`	Yes

OpenAI.ResponseFunctionCallArgumentsDoneEvent

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

Name	类型	Description	Required
arguments	字符串	函数调用参数。	Yes
item_id	字符串	项的 ID。	Yes
output_index	整数	输出项的索引。	Yes
类型	枚举	可能的值：`response.function_call_arguments.done`	Yes

OpenAI.ResponseImageGenCallCompletedEvent

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

Name	类型	Description	Required
item_id	字符串	正在处理的图像生成项的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
类型	枚举	事件类型。始终为“response.image_generation_call.completed”。可能的值：`response.image_generation_call.completed`	Yes

OpenAI.ResponseImageGenCallGeneratingEvent

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

Name	类型	Description	Required
item_id	字符串	正在处理的图像生成项的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值：`response.image_generation_call.generating`	Yes

OpenAI.ResponseImageGenCallInProgressEvent

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

Name	类型	Description	Required
item_id	字符串	正在处理的图像生成项的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
类型	枚举	事件类型。始终为“response.image_generation_call.generating”。可能的值：`response.image_generation_call.in_progress`	Yes

OpenAI.ResponseImageGenCallPartialImageEvent

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

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

OpenAI.ResponseInProgressEvent

响应正在进行时发出。

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

OpenAI.ResponseIncompleteEvent

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

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

OpenAI.ResponseItemList

响应项的列表。

Name	类型	Description	Required
数据	数组	用于生成此响应的项列表。	Yes
first_id	字符串	列表中第一项的 ID。	Yes
has_more	boolean	是否有更多可用项。	Yes
last_id	字符串	列表中最后一项的 ID。	Yes
对象	枚举	返回的对象的类型必须是 `list`。可能的值：`list`	Yes

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

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

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

Name	类型	Description	Required
arguments		MCP 工具调用的最终参数。	Yes
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
类型	枚举	事件类型。始终为“response.mcp_call.arguments_done”。可能的值：`response.mcp_call.arguments_done`	Yes

OpenAI.ResponseMCPCallCompletedEvent

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

Name	类型	Description	Required	Default
类型	枚举	事件类型。始终为“response.mcp_call.completed”。可能的值：`response.mcp_call.completed`	Yes

OpenAI.ResponseMCPCallFailedEvent

MCP 工具调用失败时发出。

Name	类型	Description	Required	Default
类型	枚举	事件类型。始终为“response.mcp_call.failed”。可能的值：`response.mcp_call.failed`	Yes

OpenAI.ResponseMCPCallInProgressEvent

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

Name	类型	Description	Required
item_id	字符串	正在处理的 MCP 工具调用项的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
类型	枚举	事件类型。始终为“response.mcp_call.in_progress”。可能的值：`response.mcp_call.in_progress`	Yes

OpenAI.ResponseMCPListToolsCompletedEvent

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

Name	类型	Description	Required	Default
类型	枚举	事件类型。始终为“response.mcp_list_tools.completed”。可能的值：`response.mcp_list_tools.completed`	Yes

OpenAI.ResponseMCPListToolsFailedEvent

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

Name	类型	Description	Required	Default
类型	枚举	事件类型。始终为“response.mcp_list_tools.failed”。可能的值：`response.mcp_list_tools.failed`	Yes

OpenAI.ResponseMCPListToolsInProgressEvent

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

Name	类型	Description	Required	Default
类型	枚举	事件类型。始终为“response.mcp_list_tools.in_progress”。可能的值：`response.mcp_list_tools.in_progress`	Yes

OpenAI.ResponseOutputItemAddedEvent

添加新的输出项时发出。

Name	类型	Description	Required
项	对象	用于生成响应的内容项。	Yes
{~ id	字符串		No
└─ 类型	OpenAI.ItemType		No
output_index	整数	已添加的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.output_item.added`。可能的值：`response.output_item.added`	Yes

OpenAI.ResponseOutputItemDoneEvent

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

Name	类型	Description	Required
项	对象	用于生成响应的内容项。	Yes
{~ id	字符串		No
└─ 类型	OpenAI.ItemType		No
output_index	整数	标记为已完成的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.output_item.done`。可能的值：`response.output_item.done`	Yes

OpenAI.ResponsePromptVariables

在提示符中替换变量的值的可选映射。替换值可以是字符串，也可以是图像或文件等其他响应输入类型。

类型：对象

OpenAI.ResponseQueuedEvent

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

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

OpenAI.ResponseReasoningDeltaEvent

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

Name	类型	Description	Required
content_index	整数	输出项中推理内容部件的索引。	Yes
delta		对推理内容的部分更新。	Yes
item_id	字符串	正在更新推理的项目的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
类型	枚举	事件类型。始终为“response.reasoning.delta”。可能的值：`response.reasoning.delta`	Yes

OpenAI.ResponseReasoningDoneEvent

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

Name	类型	Description	Required
content_index	整数	输出项中推理内容部件的索引。	Yes
item_id	字符串	完成推理的项的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
文本消息	字符串	最终的推理文本。	Yes
类型	枚举	事件类型。始终为“response.reasoning.done”。可能的值：`response.reasoning.done`	Yes

OpenAI.ResponseReasoningSummaryDeltaEvent

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

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

OpenAI.ResponseReasoningSummaryDoneEvent

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

Name	类型	Description	Required
item_id	字符串	完成推理摘要的项的唯一标识符。	Yes
output_index	整数	响应的输出数组中输出项的索引。	Yes
summary_index	整数	输出项中概要部分的索引。	Yes
文本消息	字符串	最终的推理摘要文本。	Yes
类型	枚举	事件类型。始终为“response.reasoning_summary.done”。可能的值：`response.reasoning_summary.done`	Yes

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

Name	类型	Description	Required
item_id	字符串	此摘要部分关联的项的 ID。	Yes
output_index	整数	此摘要部分关联的输出项的索引。	Yes
部件	对象		Yes
└─ 类型	OpenAI.ReasoningItemSummaryPartType		No
summary_index	整数	推理摘要中摘要部分的索引。	Yes
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.added`。可能的值：`response.reasoning_summary_part.added`	Yes

OpenAI.ResponseReasoningSummaryPartDoneEvent

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

Name	类型	Description	Required
item_id	字符串	此摘要部分关联的项的 ID。	Yes
output_index	整数	此摘要部分关联的输出项的索引。	Yes
部件	对象		Yes
└─ 类型	OpenAI.ReasoningItemSummaryPartType		No
summary_index	整数	推理摘要中摘要部分的索引。	Yes
类型	枚举	事件类型。始终为 `response.reasoning_summary_part.done`。可能的值：`response.reasoning_summary_part.done`	Yes

OpenAI.ResponseReasoningSummaryTextDeltaEvent

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

Name	类型	Description	Required
delta	字符串	添加到摘要的文本增量。	Yes
item_id	字符串	此摘要文本增量关联的项的 ID。	Yes
output_index	整数	此摘要文本增量关联的输出项的索引。	Yes
summary_index	整数	推理摘要中摘要部分的索引。	Yes
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.delta`。可能的值：`response.reasoning_summary_text.delta`	Yes

OpenAI.ResponseReasoningSummaryTextDoneEvent

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

Name	类型	Description	Required
item_id	字符串	此摘要文本关联的项的 ID。	Yes
output_index	整数	与此摘要文本关联的输出项的索引。	Yes
summary_index	整数	推理摘要中摘要部分的索引。	Yes
文本消息	字符串	已完成推理摘要的全文。	Yes
类型	枚举	事件类型。始终为 `response.reasoning_summary_text.done`。可能的值：`response.reasoning_summary_text.done`	Yes

OpenAI.ResponseRefusalDeltaEvent

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

Name	类型	Description	Required
content_index	整数	拒绝文本添加到的内容部分的索引。	Yes
delta	字符串	添加的拒绝文本。	Yes
item_id	字符串	拒绝文本添加到的输出项的 ID。	Yes
output_index	整数	拒绝文本添加到的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.refusal.delta`。可能的值：`response.refusal.delta`	Yes

OpenAI.ResponseRefusalDoneEvent

在拒绝文本完成时发出。

Name	类型	Description	Required
content_index	整数	已完成拒绝文本的内容部分的索引。	Yes
item_id	字符串	已完成拒绝文本的输出项的 ID。	Yes
output_index	整数	已完成拒绝文本的输出项的索引。	Yes
refusal	字符串	最终完成的拒绝文本。	Yes
类型	枚举	事件类型。始终为 `response.refusal.done`。可能的值：`response.refusal.done`	Yes

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent 的鉴别器

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

类型值	Schema
`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.ResponseFailedEvent
`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.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

Name	类型	Description	Required	Default
sequence_number	整数	此事件的序列号。	Yes
类型	OpenAI.ResponseStreamEventType		Yes

OpenAI.ResponseStreamEventType

Property Value

Type 字符串

Values 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.ResponseTextDeltaEvent

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

Name	类型	Description	Required
content_index	整数	文本增量添加到的内容部分的索引。	Yes
delta	字符串	添加的文本增量。	Yes
item_id	字符串	文本增量添加到的输出项的 ID。	Yes
output_index	整数	文本增量添加到的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.output_text.delta`。可能的值：`response.output_text.delta`	Yes

OpenAI.ResponseTextDoneEvent

在完成文本内容时发出。

Name	类型	Description	Required
content_index	整数	已完成文本内容的内容部分的索引。	Yes
item_id	字符串	已完成文本内容的输出项的 ID。	Yes
output_index	整数	已完成文本内容的输出项的索引。	Yes
文本消息	字符串	最终完成的文本内容。	Yes
类型	枚举	事件类型。始终为 `response.output_text.done`。可能的值：`response.output_text.done`	Yes

OpenAI.ResponseTextFormatConfiguration

OpenAI.ResponseTextFormatConfiguration 的鉴别器

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

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

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

OpenAI.ResponseTextFormatConfigurationJsonObject

Name	类型	Description	Required	Default
类型	枚举	可能的值：`json_object`	Yes

OpenAI.ResponseTextFormatConfigurationJsonSchema

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

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

OpenAI.ResponseTextFormatConfigurationText

Name	类型	Description	Required	Default
类型	枚举	可能的值：`text`	Yes

OpenAI.ResponseTextFormatConfigurationType

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

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

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

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

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

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

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

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

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

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

OpenAI.ResponseUsage

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

Name	类型	Description	Required
input_tokens	整数	输入令牌数。	Yes
input_tokens_details	对象	输入令牌的明细。	Yes
cached_tokens	整数	从缓存中检索的令牌数。	No
output_tokens	整数	输出标记数。	Yes
output_tokens_details	对象	输出令牌的明细。	Yes
reasoning_tokens	整数	推理令牌的数量。	No
total_tokens	整数	使用的令牌总数。	Yes

OpenAI.ResponseWebSearchCallCompletedEvent

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

Name	类型	Description	Required
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	Yes
output_index	整数	Web 搜索调用关联的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.web_search_call.completed`。可能的值：`response.web_search_call.completed`	Yes

OpenAI.ResponseWebSearchCallInProgressEvent

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

Name	类型	Description	Required
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	Yes
output_index	整数	Web 搜索调用关联的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.web_search_call.in_progress`。可能的值：`response.web_search_call.in_progress`	Yes

OpenAI.ResponseWebSearchCallSearchingEvent

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

Name	类型	Description	Required
item_id	字符串	与 Web 搜索调用关联的输出项的唯一 ID。	Yes
output_index	整数	Web 搜索调用关联的输出项的索引。	Yes
类型	枚举	事件类型。始终为 `response.web_search_call.searching`。可能的值：`response.web_search_call.searching`	Yes

OpenAI.ResponsesAssistantMessageItemParam

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `assistant`。可能的值：`assistant`	Yes

OpenAI.ResponsesAssistantMessageItemResource

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `assistant`。可能的值：`assistant`	Yes

OpenAI.ResponsesDeveloperMessageItemParam

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `developer`。可能的值：`developer`	Yes

OpenAI.ResponsesDeveloperMessageItemResource

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `developer`。可能的值：`developer`	Yes

OpenAI.ResponsesMessageItemParam

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

OpenAI.ResponsesMessageItemParam 的鉴别器

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

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

Name	类型	Description	Required	Default
角色	对象	响应消息项中有效角色的集合。	Yes
类型	枚举	响应项的类型，始终为“message”。可能的值：`message`	Yes

OpenAI.ResponsesMessageItemResource

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

OpenAI.ResponsesMessageItemResource 的鉴别器

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

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

Name	类型	Description	Required
角色	对象	响应消息项中有效角色的集合。	Yes
状态	枚举	项目的状态。以下之一：`in_progress`、`completed` 或 `incomplete`。通过 API 返回项时填充。可能的值：`in_progress`、、 `completedincomplete`	Yes
类型	枚举	响应项的类型，始终为“message”。可能的值：`message`	Yes

OpenAI.ResponsesMessageRole

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

Property	Value
Description	响应消息项中有效角色的集合。
Type	字符串
Values	`system` `developer` `user` `assistant`

OpenAI.ResponsesSystemMessageItemParam

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `system`。可能的值：`system`	Yes

OpenAI.ResponsesSystemMessageItemResource

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `system`。可能的值：`system`	Yes

OpenAI.ResponsesUserMessageItemParam

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `user`。可能的值：`user`	Yes

OpenAI.ResponsesUserMessageItemResource

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

Name	类型	Description	Required	Default
内容	数组	与消息关联的内容。	Yes
角色	枚举	消息的角色，始终为 `user`。可能的值：`user`	Yes

OpenAI.RunGraderRequest

Name	类型	Description	Required
年级	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	Yes
calculate_output	字符串	用于基于评分器结果计算输出的公式。	No
evaluation_metric	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	No
~~ 评分员	对象		No
image_tag	字符串	用于 python 脚本的图像标记。	No
└─ 输入	数组	输入文本。这可能包括模板字符串。	No
└─ 模型	字符串	要用于评估的模型。	No
└─ 名称	字符串	评分程序的名称。	No
~~作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	No
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	No
~~ 参考	字符串	作为评分参照的文本。	No
采样参数 (sampling_params)		模型的采样参数。	No
└─ 来源	字符串	python 脚本的源代码。	No
└─ 类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	No
项		提供给评分器的数据集项。这将用于填充命名空间 `item` 。	No
model_sample	字符串	要评估的模型示例。此值将用于填充命名空间 `sample` 。 `output_json`如果模型示例是一个变量，则会填充变量有效的 JSON 字符串。	Yes

OpenAI.RunGraderResponse

Name	类型	Required
元数据	对象	Yes
~~ 错误	对象	No
formula_parse_error	boolean	No
invalid_variable_error	boolean	No
model_grader_parse_error	boolean	No
model_grader_refusal_error	boolean	No
model_grader_server_error	boolean	No
model_grader_server_error_details	字符串	No
other_error	boolean	No
python_grader_runtime_error	boolean	No
python_grader_runtime_error_details	字符串	No
python_grader_server_error	boolean	No
python_grader_server_error_type	字符串	No
sample_parse_error	boolean	No
truncated_observation_error	boolean	No
unresponsive_reward_error	boolean	No
execution_time	number	No
└─ 名称	字符串	No
sampled_model_name	字符串	No
~~ 分数		No
token_usage	整数	No
└─ 类型	字符串	No
model_grader_token_usage_per_model		Yes
奖励	number	Yes
sub_rewards		Yes

OpenAI.StaticChunkingStrategy

Name	类型	Description	Required	Default
chunk_overlap_tokens	整数	区块之间重叠的标记数。默认值是 `400`。请注意，重叠不得超过 `max_chunk_size_tokens` 的一半。	Yes
max_chunk_size_tokens	整数	每个区块中的最大标记数。默认值是 `800`。最小值为 `100`，最大值为 `4096`。	Yes

OpenAI.StaticChunkingStrategyRequestParam

通过设置区块大小和区块重叠来自定义自己的分块策略。

Name	类型	Description	Required	Default
静态的	OpenAI.StaticChunkingStrategy		Yes
类型	枚举	始终为 `static`。可能的值：`static`	Yes

OpenAI.StaticChunkingStrategyResponseParam

Name	类型	Description	Required	Default
静态的	OpenAI.StaticChunkingStrategy		Yes
类型	枚举	始终为 `static`。可能的值：`static`	Yes

OpenAI.StopConfiguration

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

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

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

string
array

OpenAI.Tool

OpenAI.Tool 的鉴别器

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

类型值	Schema
`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
`local_shell`	OpenAI.LocalShellTool
`mcp`	OpenAI.MCPTool

Name	类型	Description	Required	Default
类型	OpenAI.ToolType	可用于生成响应的工具。	Yes

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject 的鉴别器

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

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

Name	类型	Description	Required	Default
类型	OpenAI.ToolChoiceObjectType	指示模型应使用内置工具生成响应。	Yes

OpenAI.ToolChoiceObjectCodeInterpreter

Name	类型	Description	Required	Default
类型	枚举	可能的值：`code_interpreter`	Yes

OpenAI.ToolChoiceObjectComputer

Name	类型	Description	Required	Default
类型	枚举	可能的值：`computer_use_preview`	Yes

OpenAI.ToolChoiceObjectFileSearch

Name	类型	Description	Required	Default
类型	枚举	可能的值：`file_search`	Yes

OpenAI.ToolChoiceObjectFunction

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

Name	类型	Description	Required	Default
name	字符串	要调用的函数名称。	Yes
类型	枚举	对于函数调用，类型始终为`function`。可能的值：`function`	Yes

OpenAI.ToolChoiceObjectImageGen

Name	类型	Description	Required	Default
类型	枚举	可能的值：`image_generation`	Yes

OpenAI.ToolChoiceObjectMCP

使用此选项强制模型在远程 MCP 服务器上调用特定工具。

Name	类型	Description	Required
name	字符串	在服务器上调用的工具的名称。	No
server_label	字符串	要使用的 MCP 服务器的标签。	Yes
类型	枚举	对于 MCP 工具，类型始终 `mcp`为。可能的值：`mcp`	Yes

OpenAI.ToolChoiceObjectType

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

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

Type	字符串
Values	`file_search` `function` `computer_use_preview` `web_search_preview` `image_generation` `code_interpreter` `mcp`

OpenAI.ToolChoiceObjectWebSearch

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

Name	类型	Description	Required	Default
类型	枚举	可能的值：`web_search_preview`	Yes

OpenAI.ToolChoiceOptions

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

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

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

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

Property	Value
Description	控制模型调用哪些工具（如有）。 `none` 表示模型不会调用任何工具，而是生成消息。 `auto` 表示模型可以在生成消息或调用一个消息之间进行选择更多工具。 `required` 表示模型必须调用一个或多个工具。
Type	字符串
Values	`none` `auto` `required`

OpenAI.ToolType

可用于生成响应的工具。

Property	Value
Description	可用于生成响应的工具。
Type	字符串
Values	`file_search` `function` `computer_use_preview` `web_search_preview` `mcp` `code_interpreter` `image_generation` `local_shell`

OpenAI.TopLogProb

令牌的最高对数概率。

Name	类型	Required
bytes	数组	Yes
logprob	number	Yes
代币	字符串	Yes

OpenAI.TranscriptionAudioResponseFormat

参考： OpenAI.AudioResponseFormat

OpenAI.TranscriptionInclude

Property	Value
Type	字符串
Values	`logprobs`

OpenAI.TranscriptionSegment

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

OpenAI.TranscriptionWord

Name	类型	Description	Required
end	number	单词的结束时间（以秒为单位）。	Yes
start	number	单词的开始时间（以秒为单位）。	Yes
字	字符串	单词的文本内容。	Yes

OpenAI.TranslationAudioResponseFormat

参考： OpenAI.AudioResponseFormat

OpenAI.UpdateVectorStoreFileAttributesRequest

Name	类型	Description	Required	Default
属性	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为最大值的字符串 512 个字符、布尔值或数字的字符串。	Yes

OpenAI.UpdateVectorStoreRequest

Name	类型	Description	Required
过期时间	对象	矢量存储过期策略。	No
~~ 定位点	枚举	定位点时间戳，在此时间之后会应用过期策略。支持的定位点：`last_active_at`。可能的值：`last_active_at`	No
~~ 天	整数	在定位点时间之后，矢量存储将过期的天数。	No
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	No
name	字符串	矢量存储的名称。	No

OpenAI.VadConfig

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

OpenAI.ValidateGraderRequest

Name	类型	Description	Required
年级	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	Yes
calculate_output	字符串	用于基于评分器结果计算输出的公式。	No
evaluation_metric	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	No
~~ 评分员	对象		No
image_tag	字符串	用于 python 脚本的图像标记。	No
└─ 输入	数组	输入文本。这可能包括模板字符串。	No
└─ 模型	字符串	要用于评估的模型。	No
└─ 名称	字符串	评分程序的名称。	No
~~作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	No
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	No
~~ 参考	字符串	作为评分参照的文本。	No
采样参数 (sampling_params)		模型的采样参数。	No
└─ 来源	字符串	python 脚本的源代码。	No
└─ 类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	No

OpenAI.ValidateGraderResponse

Name	类型	Description	Required
年级	对象	一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。	No
calculate_output	字符串	用于基于评分器结果计算输出的公式。	No
evaluation_metric	枚举	要使用的评估指标。 `fuzzy_match`、`bleu`、`gleu`、`meteor`、`rouge_1`、`rouge_2`、`rouge_3`、`rouge_4`、`rouge_5`或`rouge_l`之一。可能的值：`fuzzy_match`, `bleu`, `gleu`, `meteor`, `rouge_1`, `rouge_2`, `rouge_3`, `rouge_4`, `rouge_5`, `rouge_l`	No
~~ 评分员	对象		No
image_tag	字符串	用于 python 脚本的图像标记。	No
└─ 输入	数组	输入文本。这可能包括模板字符串。	No
└─ 模型	字符串	要用于评估的模型。	No
└─ 名称	字符串	评分程序的名称。	No
~~作	枚举	要执行的字符串检查操作。 `eq`、`ne`、`like` 或 `ilike` 之一。可能的值：`eq`、`ne`、`like`、`ilike`	No
~~ 范围	数组	分数的范围。默认为 `[0, 1]`。	No
~~ 参考	字符串	作为评分参照的文本。	No
采样参数 (sampling_params)		模型的采样参数。	No
└─ 来源	字符串	python 脚本的源代码。	No
└─ 类型	枚举	始终为 `multi` 的对象类型。可能的值：`multi`	No

OpenAI.VectorStoreExpirationAfter

矢量存储过期策略。

Name	类型	Description	Required	Default
定位标记	枚举	定位点时间戳，在此时间之后会应用过期策略。支持的定位点：`last_active_at`。可能的值：`last_active_at`	Yes
日	整数	在定位点时间之后，矢量存储将过期的天数。	Yes

OpenAI.VectorStoreFileAttributes

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

类型：对象

OpenAI.VectorStoreFileBatchObject

附加到矢量存储的批量文件。

Name	类型	Description	Required
created_at	整数	创建矢量存储文件批处理时的 Unix 时间戳（以秒为单位）。	Yes
文件数	对象		Yes
~~ 已取消	整数	已取消的文件数。	No
~~ 已完成	整数	已处理的文件数。	No
~~ 失败	整数	未能处理的文件数。	No
进行中	整数	当前正在处理的文件数。	No
~~ 总计	整数	文件总数。	No
id	字符串	可以在 API 终结点中引用的标识符。	Yes
对象	枚举	始终为 `vector_store.file_batch` 的对象类型。可能的值：`vector_store.files_batch`	Yes
状态	枚举	矢量存储文件批处理的状态，可以是 `in_progress`、`completed`、`cancelled` 或 `failed`。可能的值：`in_progress`、`completed`、`cancelled`、`failed`	Yes
vector_store_id	字符串	附加文件的矢量存储的 ID。	Yes

OpenAI.VectorStoreFileObject

附加到矢量存储的文件列表。

Name	类型	Description	Required
属性	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是字符串最大长度为 64 个字符。值为最大值的字符串 512 个字符、布尔值或数字的字符串。	No
chunking_strategy	对象		No
└─ 类型	枚举	可能的值： `staticother`	No
created_at	整数	创建矢量存储文件时的 Unix 时间戳（以秒为单位）。	Yes
id	字符串	可以在 API 终结点中引用的标识符。	Yes
最后错误 (last_error)	对象	与此矢量存储文件关联的最后一个错误。如果没有错误，则为 `null`。	Yes
└─ 代码	枚举	`server_error` 或 `rate_limit_exceeded` 中的一项。可能的值：`server_error`、、 `unsupported_fileinvalid_file`	No
└─ 消息	字符串	可读的错误说明。	No
对象	枚举	始终为 `vector_store.file` 的对象类型。可能的值：`vector_store.file`	Yes
状态	枚举	矢量存储文件的状态，可以是 `in_progress`、`completed`、`cancelled` 或 `failed`。状态 `completed` 指示矢量存储文件可供使用。可能的值：`in_progress`、`completed`、`cancelled`、`failed`	Yes
usage_bytes	整数	总矢量存储使用量（以字节为单位）。请注意，这可能不同于原始文件大小。	Yes
vector_store_id	字符串	附加文件的矢量存储的 ID。	Yes

OpenAI.VectorStoreObject

矢量存储是 file_search 工具可以使用已处理文件的集合。

Name	类型	Description	Required
created_at	整数	创建矢量存储时的 Unix 时间戳（以秒为单位）。	Yes
过期时间	OpenAI.VectorStoreExpirationAfter	矢量存储过期策略。	No
expires_at	整数	矢量存储将过期时的 Unix 时间戳（以秒为单位）。	No
文件数	对象		Yes
~~ 已取消	整数	已取消的文件数。	No
~~ 已完成	整数	已成功处理的文件数。	No
~~ 失败	整数	未能处理的文件数。	No
进行中	整数	当前正在处理的文件数。	No
~~ 总计	整数	文件总数。	No
id	字符串	可以在 API 终结点中引用的标识符。	Yes
最后活动时间	整数	矢量存储上次活动时的 Unix 时间戳（以秒为单位）。	Yes
元数据	对象	按 16 个成组的可附加到对象的键值对。这可以是用于将有关对象的其他信息存储在结构化对象中通过 API 或仪表板格式化和查询对象。键是最大长度为 64 个字符的字符串。值为字符串最大长度为 512 个字符。	Yes
name	字符串	矢量存储的名称。	Yes
对象	枚举	始终为 `vector_store` 的对象类型。可能的值：`vector_store`	Yes
状态	枚举	矢量存储的状态，可以是 `expired`、`in_progress` 或 `completed`。状态 `completed` 指示矢量存储可供使用。可能的值：`expired`、、 `in_progresscompleted`	Yes
usage_bytes	整数	矢量存储区中文件使用的总字节数。	Yes

OpenAI.VoiceIdsShared

Property	Value
Type	字符串
Values	`alloy` `ash` `ballad` `coral` `echo` `fable` `onyx` `nova` `sage` `shimmer` `verse`

OpenAI.WebSearchAction

OpenAI.WebSearchAction 的鉴别器

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

类型值	Schema
`find`	OpenAI.WebSearchActionFind
`open_page`	OpenAI.WebSearchActionOpenPage
`search`	OpenAI.WebSearchActionSearch

Name	类型	Description	Required	Default
类型	OpenAI.WebSearchActionType		Yes

OpenAI.WebSearchActionFind

作类型“find”：在加载的页面中搜索模式。

Name	类型	Description	Required
模式	字符串	在页面中搜索的模式或文本。	Yes
类型	枚举	作类型。可能的值：`find`	Yes
url	字符串	搜索模式的页面的 URL。	Yes

OpenAI.WebSearchActionOpenPage

作类型“open_page” - 打开搜索结果中的特定 URL。

Name	类型	Description	Required	Default
类型	枚举	作类型。可能的值：`open_page`	Yes
url	字符串	模型打开的 URL。	Yes

OpenAI.WebSearchActionSearch

作类型“search”- 执行 Web 搜索查询。

Name	类型	Description	Required	Default
查询	字符串	搜索查询。	Yes
类型	枚举	作类型。可能的值：`search`	Yes

OpenAI.WebSearchActionType

Property	Value
Type	字符串
Values	`search` `open_page` `find`

OpenAI.WebSearchPreviewTool

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

Name	类型	Description	Required
search_context_size	枚举	用于搜索的上下文窗口空间量的高级指南。 `low`、`medium` 或 `high` 之一。 `medium` 是默认值。可能的值：`low`、、 `mediumhigh`	No
类型	枚举	Web 搜索工具的类型。 `web_search_preview` 或 `web_search_preview_2025_03_11` 中的一项。可能的值：`web_search_preview`	Yes
user_location	对象		No
└─ 类型	OpenAI.LocationType		No

OpenAI.WebSearchToolCallItemParam

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

Name	类型	Description	Required
操作	对象		Yes
└─ 类型	OpenAI.WebSearchActionType		No
类型	枚举	可能的值：`web_search_call`	Yes

OpenAI.WebSearchToolCallItemResource

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

Name	类型	Description	Required
操作	对象		Yes
└─ 类型	OpenAI.WebSearchActionType		No
状态	枚举	Web 搜索工具调用的状态。可能的值：`in_progress`、`searching`、`completed`、`failed`	Yes
类型	枚举	可能的值：`web_search_call`	Yes

PineconeChatDataSource

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

Quality

要检索的视频内容的质量。这指定应返回的视频内容的质量。

Property	Value
Description	要检索的视频内容的质量。这指定应返回的视频内容的质量。
Type	字符串
Values	`high` `low`

ResponseFormatJSONSchemaRequest

Name	类型	Description	Required	Default
json_schema	对象	响应格式的 JSON 架构	Yes
类型	枚举	响应格式的类型可能的值：`json_schema`	Yes

ResponseModalities

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

["text"]

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

["text", "audio"]

数组：字符串

SpeechGenerationResponseFormat

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

此组件可以是下列组件之一：

VideoGeneration

视频生成结果。

Name	类型	Description	Required
created_at	整数	创建视频生成的时间。	Yes
height	整数	视频的高度。	Yes
id	字符串	视频生成的 ID。	Yes
job_id	字符串	此视频的视频生成作业的 ID。	Yes
n_seconds	整数	视频生成持续时间。	Yes
对象	枚举	可能的值：`video.generation`	Yes
提示	字符串	此视频生成的提示。	Yes
width	整数	视频的宽度。	Yes

VideoGenerationJob

视频生成作业。

Name	类型	Description	Required
created_at	整数	创建作业的时间。	Yes
expires_at	整数	作业自动从服务中删除的时间。应在此日期之前存储作业的视频内容和元数据，以避免数据丢失。	No
failure_reason	字符串（请参阅下面的有效模型）		No
finished_at	整数	作业完成所有视频生成的时间。	No
generations	数组	为此作业生成的视频。该数量取决于给定的 n_variants 和生成的创建成功率。	No
height	整数	视频的高度。	Yes
id	字符串	作业 ID。	Yes
inpaint_items	数组	此视频生成作业的可选内插项目。	No
模型	字符串	要用于此视频生成作业的部署的名称。	Yes
n_seconds	整数	视频生成作业的持续时间。	Yes
n_variants	整数	要作为此视频生成作业的变体创建的视频数量。	Yes
对象	枚举	可能的值：`video.generation.job`	Yes
提示	字符串	此视频生成作业的提示。	Yes
状态	对象	视频生成作业的状态。	Yes
width	整数	视频的高度。	Yes

VideoGenerationJobList

视频生成作业的列表。

Name	类型	Description	Required
数据	数组	视频生成作业的列表。	Yes
first_id	字符串	当前页中第一个作业的 ID（如果可用）。	No
has_more	boolean	一个标志，指示列表后是否有更多可用作业。	Yes
last_id	字符串	当前页中最后一个作业的 ID（如果可用）。	No
对象	枚举	可能的值：`list`	Yes

后续步骤

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

反馈

此页面是否有帮助？