通过

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

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

v1 API 目前仅支持一部分作。 若要了解详细信息，请参阅 API 版本生命周期指南。

创建聊天完成

POST {endpoint}/openai/v1/chat/completions

创建聊天完成。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
音频 对象 音频输出的参数。 当使用 请求音频输出时是必需的
modalities: ["audio"]。		 否
~~ 格式 枚举 指定输出音频格式。 必须是以下项之wav一： mp3flac
opus 或 pcm16 中的一项。
可能的值：wav、、aac、mp3flac、opus、pcm16		 否
~~ 语音 对象 否
data_sources 数组 用于“数据上的”功能的数据源，专用于 Azure OpenAI。 否
frequency_penalty 数字 介于 -2.0 和 2.0 之间的数字。 正值基于
到目前为止，文本中的现有频率会减少模型
重复同一行的可能性。		 否 0
function_call 枚举 通过 {"name": "my_function"} 强制模型调用该函数来指定特定函数。
可能的值： noneauto		 否
functions 数组 弃用赞成 tools。

模型可能为其生成 JSON 输入的函数列表。		 否
logit_bias 对象 修改指定令牌在完成中出现的可能性。

接受映射令牌的 JSON 对象（由令牌 ID 在
tokenizer）到从 -100 到 100 的关联偏差值。 数学
偏差将添加到采样之前模型生成的对数。
具体效果因模型而异，但 -1 和 1 之间的值应
减少或增加选择的可能性;-100 或 100 等值
应生成相关令牌的禁令或独占选择。		 否 没有
logprobs 布尔 是否返回输出令牌的对数概率。 如果为 true，则为
返回在 中返回的每个输出令牌的对数概率
content的 .message		 否 假
max_completion_tokens 整数 可为其生成令牌数的上限
完成，包括可见的输出令牌和推理令牌。		 否
max_tokens 整数 可在聊天完成中生成的最大令牌数。
此值可用于控制通过 API 生成的文本的成本。

此值现已弃用 max_completion_tokens，适合，并且
与 o1 系列模型不兼容。		 否
messages 数组 到目前为止，包含对话的消息列表。 取决于
你使用的模型，支持不同的消息类型（形式）
如文本、图像和音频。		 是的
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
方式 对象 希望模型生成的输出类型。
大多数模型都能够生成文本，这是默认值：

["text"]

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

["text", "audio"]		 否
模型 字符串 用于聊天完成请求的模型部署标识符。 是的
n 整数 要为每个输入消息生成的聊天完成选项数。 请注意，将根据所有选项中生成的令牌数向你收费。 n尽量1降低成本。 否 1
并行工具调用 对象 是否在工具使用期间启用 并行函数调用 。 否
预测 对象 模型预测输出的基表示形式。 否
└─ 类型 OpenAI.ChatOutputPredictionType 否
presence_penalty 数字 介于 -2.0 和 2.0 之间的数字。 正值基于
它们目前是否出现在文本中，增加模型的可能性
讨论新主题。		 否 0
推理努力 对象 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
响应格式 对象 否
└─ 类型 枚举
可能的值：text、、 json_objectjson_schema		 否
seed 整数 此功能在 Beta 版中。
如果指定，我们的系统将尽最大努力以确定性方式采样，这样具有相同参数的重复请求 seed 应返回相同的结果。
无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。		 否
stop 对象 不支持最新的推理模型 o3 和 o4-mini。

最多 4 个序列，其中 API 将停止生成进一步的令牌。 这
返回的文本将不包含停止序列。		 否
存储 布尔 是否存储此聊天完成请求的输出
用于模型提取或疏散产品。		 否 假
数据流 布尔 如果设置为 true，模型响应数据将流式传输到客户端
使用服务器发送的事件生成时。		 否 假
stream_options 对象 流式处理响应的选项。 仅在设置时设置 stream: true此设置。 否
include_usage 布尔 如果已设置，则会在 之前流式传输其他区块
消息。 usage此区块上的字段显示令牌使用情况统计信息
对于整个请求，字段 choices 将始终为空
数组。

所有其他区块也将包含一个 usage 字段，但值为 null
价值。 注意： 如果流中断，则可能不会收到
包含请求的令牌总使用量的最终使用区块。		 否
温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否 1
tool_choice OpenAI.ChatCompletionToolChoiceOption 控制模型调用哪个（如果有）工具。
none 表示模型不会调用任何工具，而是生成消息。
auto 表示模型可以在生成消息或调用一个或多个工具之间进行选择。
required 表示模型必须调用一个或多个工具。
通过 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具来指定特定工具。

none 如果没有工具，则为默认值。 auto 如果存在工具，则为默认值。		 否
tools 数组 模型可以调用的工具列表。 目前，仅支持函数作为工具。 使用此函数提供模型可能会为其生成 JSON 输入的函数列表。 最多支持 128 个函数。 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否 1
用户 字符串 表示最终用户的唯一标识符，可帮助
监视和检测滥用行为。		 否
user_security_context AzureUserSecurityContext 用户安全上下文包含描述应用程序本身的多个参数，以及与应用程序交互的最终用户。 这些字段通过提供全面的方法来保护 AI 应用程序，帮助安全运营团队调查和缓解安全事件。 详细了解 如何使用 Microsoft Defender for Cloud 保护 AI 应用程序。 否

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

例子

示例：

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

POST {endpoint}/openai/v1/chat/completions

{
 "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

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

例子

示例：

返回给定提示的嵌入内容。

POST {endpoint}/openai/v1/embeddings

{
 "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

列出针对项目的评估。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建 eval

POST {endpoint}/openai/v1/evals

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

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

有关详细信息，请参阅 Evals 指南。

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
数据源配置 对象 是的
└─ 类型 OpenAI.EvalDataSourceConfigType 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
姓名 字符串 评估的名称。 否
状态码 枚举
可能的值：201		 是的
测试标准 数组 此组中所有评估运行的评分程序列表。 分级者可以使用双大括号表示法引用数据源中的变量，例如 {{item.variable_name}}。 若要引用模型的输出，请使用 sample 命名空间（即， {{sample.output_text}}）。 是的

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取 eval

GET {endpoint}/openai/v1/evals/{eval_id}

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

更新 eval

POST {endpoint}/openai/v1/evals/{eval_id}

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
元数据 OpenAI.MetadataPropertyForRequest 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

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

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除 eval

DELETE {endpoint}/openai/v1/evals/{eval_id}

删除指定的计算。

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型 类型 说明
application/json 对象

状态代码：默认值

说明：意外的错误响应。

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

获取 eval 运行

GET {endpoint}/openai/v1/evals/{eval_id}/runs

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建 eval 运行

POST {endpoint}/openai/v1/evals/{eval_id}/runs

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
数据源 对象 是的
└─ 类型 OpenAI.EvalRunDataSourceType 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
姓名 字符串 运行的名称。 否

反应

状态代码： 201

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

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

状态代码：默认值

说明：意外的错误响应。

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

获取 eval 运行

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

取消 eval 运行

POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除 eval 运行

DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型 类型 说明
application/json 对象

状态代码：默认值

说明：意外的错误响应。

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

获取 eval 运行输出项

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取 eval 运行输出项

GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}

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

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建文件

POST {endpoint}/openai/v1/files

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

Content-Type：multipart/form-data

名称 类型 DESCRIPTION 必选 违约
过期时间 对象 是的
~~ 定位点 AzureFileExpiryAnchor 否
~~ 秒 整数 否
文件 字符串 是的
purpose 枚举 上传文件的预期用途。 其中一个： - assistants： 在助手 API 中使用 - batch： 在 Batch API 中使用 - fine-tune： 用于微调 - evals： 用于 eval 数据集
可能的值：assistants、batch、fine-tune、evals		 是的

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

例子

示例：

POST {endpoint}/openai/v1/files

列出文件

GET {endpoint}/openai/v1/files

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

检索文件

GET {endpoint}/openai/v1/files/{file_id}

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除文件

DELETE {endpoint}/openai/v1/files/{file_id}

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

下载文件

GET {endpoint}/openai/v1/files/{file_id}/content

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

运行分级程序

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run

运行分级程序。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
年级 对象 一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。 是的
calculate_output 字符串 用于基于评分器结果计算输出的公式。 否
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		 否
~~ 评分员 对象 否
image_tag 字符串 用于 python 脚本的图像标记。 否
└─ 输入 数组 输入文本。 这可能包括模板字符串。 否
└─ 模型 字符串 要用于评估的模型。 否
└─ 名称 字符串 评分程序的名称。 否
~~作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 否
~~ 范围 数组 分数的范围。 默认为 [0, 1]。 否
~~ 参考 字符串 作为评分参照的文本。 否
采样参数 (sampling_params) 模型的采样参数。 否
└─ 来源 字符串 python 脚本的源代码。 否
└─ 类型 枚举 始终为 multi 的对象类型。
可能的值：multi		 否
项 提供给评分器的数据集项。 这将用于填充
命名空间 item 。 有关更多详细信息 ，请参阅指南 。		 否
model_sample 字符串 要评估的模型示例。 此值将用于填充
命名空间 sample 。 有关更多详细信息 ，请参阅指南 。
output_json如果模型示例是一个变量，则会填充变量
有效的 JSON 字符串。		 是的

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

验证分级程序

POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate

验证分级程序。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
年级 对象 一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。 是的
calculate_output 字符串 用于基于评分器结果计算输出的公式。 否
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		 否
~~ 评分员 对象 否
image_tag 字符串 用于 python 脚本的图像标记。 否
└─ 输入 数组 输入文本。 这可能包括模板字符串。 否
└─ 模型 字符串 要用于评估的模型。 否
└─ 名称 字符串 评分程序的名称。 否
~~作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 否
~~ 范围 数组 分数的范围。 默认为 [0, 1]。 否
~~ 参考 字符串 作为评分参照的文本。 否
采样参数 (sampling_params) 模型的采样参数。 否
└─ 来源 字符串 python 脚本的源代码。 否
└─ 类型 枚举 始终为 multi 的对象类型。
可能的值：multi		 否

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs

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

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

详细了解微调

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
超参数 对象 用于微调作业的超参数。
此值现在已弃用 method，应该在参数下 method 传入。		 否
batch_size 枚举
可能的值：auto		 否
learning_rate_multiplier 枚举
可能的值：auto		 否
n_epochs 枚举
可能的值：auto		 否
整合 数组 要为微调作业启用的集成列表。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
方法 OpenAI.FineTuneMethod 用于微调的方法。 否
模型 字符串 （请参阅下面的有效模型） 要微调的模型的名称。 可以选择其中一个
支持的模型。		 是的
seed 整数 种子控制作业的可重现性。 传入相同的种子和作业参数应会产生相同的结果，但在极少数情况下可能会有差异。
如果未指定种子，则会为你生成一个种子。		 否
suffix 字符串 最多 64 个字符的字符串，将添加到微调的模型名称中。

例如，一个 suffix “custom-model-name”将生成一个模型名称，如下所示 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel。		 否 没有
训练文件 字符串 包含训练数据的上传文件的 ID。

请参阅 上传文件 ，了解如何上传文件。

数据集的格式必须为 JSONL 文件。 此外，还必须使用目的 fine-tune上传文件。

文件的内容应有所不同，具体取决于模型是否使用 聊天，或者微调方法是否使用 首选项 格式。

有关更多详细信息 ，请参阅微调指南 。		 是的
验证文件 字符串 包含验证数据的上传文件的 ID。

如果提供此文件，则数据用于生成验证
在微调期间定期指标。 可以在其中查看这些指标
微调结果文件。
训练文件和验证文件中不应存在相同的数据。

数据集的格式必须为 JSONL 文件。 必须按照目的 fine-tune上传文件。

有关更多详细信息 ，请参阅微调指南 。		 否

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出分页微调作业

GET {endpoint}/openai/v1/fine_tuning/jobs

列出组织的微调作业

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

检索微调作业

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}

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

详细了解微调

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

取消微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel

立即取消微调作业。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出微调作业检查点

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints

列出微调作业的检查点。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

微调 - 复制检查点

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_name}/copy

在给定的目标帐户和区域创建微调检查点的副本。

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

名称 在 必选 类型 DESCRIPTION
终结点 路径 是的 字符串
网址		 支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version) 查询 否 要用于此请求的显式 Azure AI Foundry 模型 API 版本。
v1 如果未另行指定，
aoai-copy-ft-checkpoints 标头 是的 字符串
可能的值：preview		 允许访问模型的检查点复制作（AOAI 预览功能）。
此功能要求将“aoai-copy-ft-checkpoints”标头设置为“preview”。
接受 标头 是的 字符串
可能的值：application/json
微调任务ID (fine_tuning_job_id) 路径 是的 字符串
fine_tuning_checkpoint_name 路径 是的 字符串

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
destinationResourceId 字符串 要复制的目标资源的 ID。 是的
区域 字符串 要将模型复制到的区域。 是的

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

微调 - 获取检查点

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints/{fine_tuning_checkpoint_name}/copy

获取微调检查点副本的状态。

注释

此 Azure OpenAI作以预览版提供，可能会更改。

参数

名称 在 必选 类型 DESCRIPTION
终结点 路径 是的 字符串
网址		 支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version) 查询 否 要用于此请求的显式 Azure AI Foundry 模型 API 版本。
v1 如果未另行指定，
aoai-copy-ft-checkpoints 标头 是的 字符串
可能的值：preview		 允许访问模型的检查点复制作（AOAI 预览功能）。
此功能要求将“aoai-copy-ft-checkpoints”标头设置为“preview”。
接受 标头 是的 字符串
可能的值：application/json
微调任务ID (fine_tuning_job_id) 路径 是的 字符串
fine_tuning_checkpoint_name 路径 是的 字符串

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出微调事件

GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

暂停微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause

暂停微调作业。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

恢复微调作业

POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume

恢复暂停的微调作业。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出模型

GET {endpoint}/openai/v1/models

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

检索模型

GET {endpoint}/openai/v1/models/{model}

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建响应

POST {endpoint}/openai/v1/responses

创建模型响应。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
后台的 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
包括 数组 指定要包含在模型响应中的其他输出数据。 现在
支持的值包括：
- 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或组织时
在零数据保留计划中注册）。		 否
输入 字符串或数组 否
指示 字符串 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
模型 字符串 用于创建此响应的模型部署。 是的
并行工具调用 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
提示 对象 对提示模板及其变量的引用。
 否
{~ id 字符串 要使用的提示模板的唯一标识符。 否
~~ 变量 OpenAI.ResponsePromptVariables 用于替换变量的值的可选映射
提示。 替换值可以是字符串或其他
响应输入类型，如图像或文件。		 否
~~ 版本 字符串 提示模板的可选版本。 否
推理 对象 仅推理模型

的配置选项
推理模型。		 否
~~ 工作 OpenAI.ReasoningEffort 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
generate_summary 枚举 已弃用： 改用 summary 。

模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
~~ 摘要 枚举 模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
存储 布尔 是否存储生成的模型响应，以便以后通过
应用程序接口。		 否 真 实
数据流 布尔 如果设置为 true，模型响应数据将流式传输到客户端
使用 服务器发送的事件生成时。
请参阅 下面的流式处理部分
有关详细信息。		 否 假
温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否 1
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice 对象 控制模型调用哪个（如果有）工具。

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

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

required 表示模型必须调用一个或多个工具。		 否
└─ 类型 OpenAI.ToolChoiceObjectType 指示模型应使用内置工具生成响应。 否
tools 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如文件搜索。
- 函数调用（自定义工具）：由你定义的函数，
使模型能够调用自己的代码。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否 1
截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

例子

示例：

创建模型响应

POST {endpoint}/openai/v1/responses

获取响应

GET {endpoint}/openai/v1/responses/{response_id}

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

参数

名称 在 必选 类型 DESCRIPTION
终结点 路径 是的 字符串
网址		 支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
API版本 (api-version) 查询 否 要用于此请求的显式 Azure AI Foundry 模型 API 版本。
v1 如果未另行指定，
response_id 路径 是的 字符串
include_obfuscation 查询 否 布尔 如果为 true，将启用流模糊处理。 流模糊处理将随机字符添加到 obfuscation 流式传输增量事件的字段，以规范化有效负载大小，以缓解某些侧通道攻击。 默认情况下包括这些模糊处理字段，但会向数据流添加少量开销。 如果信任应用程序与 OpenAI API 之间的网络链接，则可以设置为 include_obfuscation false 以优化带宽。
include[] 查询 否 数组

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除响应

DELETE {endpoint}/openai/v1/responses/{response_id}

按 ID 删除响应。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

内容类型 类型 说明
application/json 对象

状态代码：默认值

说明：意外的错误响应。

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

列出输入项

GET {endpoint}/openai/v1/responses/{response_id}/input_items

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出矢量存储

GET {endpoint}/openai/v1/vector_stores

返回矢量存储的列表。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

Createvectorstore

POST {endpoint}/openai/v1/vector_stores

创建矢量存储。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
chunking_strategy 对象 默认策略。 此策略目前使用和 max_chunk_size_tokens800 //chunk_overlap_tokens400 否
~~ 静态 OpenAI.StaticChunkingStrategy 否
└─ 类型 枚举 始终为 static。
可能的值：static		 否
过期时间 OpenAI.VectorStoreExpirationAfter 矢量存储的过期策略。 否
file_ids 数组 矢量存储应使用的文件 ID 列表。 可用于访问文件等 file_search 工具。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
姓名 字符串 矢量存储的名称。 否

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

例子

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

获取矢量存储

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}

检索向量存储。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

修改矢量存储

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}

修改向量存储。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

名称 类型 DESCRIPTION 必选 违约
过期时间 对象 矢量存储的过期策略。 否
~~ 定位点 枚举 在此时间之后应用过期策略的定位点时间戳。 支持的定位点： last_active_at.
可能的值：last_active_at		 否
~~ 天 整数 矢量存储将过期的定位时间后的天数。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
姓名 字符串 矢量存储的名称。 否

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除矢量存储

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}

删除向量存储。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建矢量存储文件批处理

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取矢量存储文件批处理

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

取消矢量存储文件批处理

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

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

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/file_batches/{batch_id}/files

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

列出矢量存储文件

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

返回矢量存储文件的列表。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

创建矢量存储文件

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

获取矢量存储文件

GET {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

检索向量存储文件。

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

更新矢量存储文件属性

POST {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

请求主体

“内容类型”: application/json

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

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

删除矢量存储文件

DELETE {endpoint}/openai/v1/vector_stores/{vector_store_id}/files/{file_id}

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

参数

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

请求标头

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

名称 必选 类型 DESCRIPTION
授权 真 实 字符串               示例：Authorization: Bearer {Azure_OpenAI_Auth_Token}

使用 Azure CLI 生成身份验证令牌： az account get-access-token --resource https://cognitiveservices.azure.com

类型：oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围：https://cognitiveservices.azure.com/.default
API密钥 真 实 字符串 在此处提供 Azure OpenAI API 密钥

反应

状态代码：200

说明：请求已成功。

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

状态代码：默认值

说明：意外的错误响应。

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

组件

AzureAIFoundryModelsApiVersion

资产 价值
类型 字符串
价值观 v1
preview

AzureChatCompletionResponseMessage

Azure OpenAI 服务上聊天完成响应消息的扩展响应模型组件。 此模型添加了对聊天消息上下文的支持，由 On Your Data 功能用于意向、引文和其他与检索扩充生成相关的信息。

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

AzureChatCompletionStreamResponseDelta

Azure OpenAI 服务上流式聊天响应消息的扩展响应模型。 此模型添加了对聊天消息上下文的支持，由 On Your Data 功能用于意向、引文和其他与检索扩充生成相关的信息。

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

AzureChatDataSource

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

AzureChatDataSource 的鉴别器

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

类型值 图式
azure_search AzureSearchChatDataSource
azure_cosmos_db AzureCosmosDBChatDataSource
elasticsearch ElasticsearchChatDataSource
pinecone PineconeChatDataSource
mongo_db MongoDBChatDataSource
名称 类型 DESCRIPTION 必选 违约
类型 对象 是的

AzureChatDataSourceAccessTokenAuthenticationOptions

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

AzureChatDataSourceApiKeyAuthenticationOptions

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

AzureChatDataSourceAuthenticationOptions

AzureChatDataSourceAuthenticationOptions 的鉴别器

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

类型值 图式
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
名称 类型 DESCRIPTION 必选 违约
类型 AzureChatDataSourceAuthenticationOptionsType 是的

AzureChatDataSourceAuthenticationOptionsType

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

AzureChatDataSourceConnectionStringAuthenticationOptions

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

AzureChatDataSourceDeploymentNameVectorizationSource

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

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

AzureChatDataSourceEncodedApiKeyAuthenticationOptions

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

AzureChatDataSourceEndpointVectorizationSource

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

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

AzureChatDataSourceIntegratedVectorizationSource

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

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

AzureChatDataSourceKeyAndKeyIdAuthenticationOptions

名称 类型 DESCRIPTION 必选 违约
关键值 字符串 是的
key_id 字符串 是的
类型 枚举
可能的值：key_and_key_id		 是的

AzureChatDataSourceModelIdVectorizationSource

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

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

AzureChatDataSourceSystemAssignedManagedIdentityAuthenticationOptions

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

AzureChatDataSourceType

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

AzureChatDataSourceUserAssignedManagedIdentityAuthenticationOptions

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

AzureChatDataSourceUsernameAndPasswordAuthenticationOptions

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

AzureChatDataSourceVectorizationSource

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

AzureChatDataSourceVectorizationSource 的鉴别器

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

类型值 图式
deployment_name AzureChatDataSourceDeploymentNameVectorizationSource
integrated AzureChatDataSourceIntegratedVectorizationSource
model_id AzureChatDataSourceModelIdVectorizationSource
名称 类型 DESCRIPTION 必选 违约
类型 对象 是的

AzureChatDataSourceVectorizationSourceType

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

AzureChatMessageContext

使用扩展行为时，添加到聊天完成响应消息的其他属性，由 Azure OpenAI 服务生成。 这包括“关于数据”功能的意向和引文信息。

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

AzureContentFilterBlocklistResult

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

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

AzureContentFilterCompletionTextSpan

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

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

AzureContentFilterCompletionTextSpanDetectionResult

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

AzureContentFilterCustomTopicResult

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

名称 类型 DESCRIPTION 必选 违约
details 数组 各个主题 ID 的对以及是否检测到它们。 否
过滤 布尔 一个值，该值指示任何详细主题是否导致筛选作。 是的

AzureContentFilterDetectionResult

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

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

AzureContentFilterPersonallyIdentifiableInformationResult

包含危害扩展的个人身份信息的内容筛选器检测结果。

名称 类型 DESCRIPTION 必选 违约
redacted_text 字符串 删除或屏蔽 PII 信息的修订文本。 否
sub_categories 数组 单个 PIIHarmSubCategory（s）的详细结果。 否

AzureContentFilterResultForChoice

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

名称 类型 DESCRIPTION 必选 违约
custom_blocklists 对象 配置的自定义阻止列表的 true/false 筛选结果的集合。 否
~~ 详细信息 数组 单个阻止列表 ID 对以及它们是否导致筛选作。 否
~~ 已筛选 布尔 一个值，该值指示任何详细的阻止列表是否导致筛选作。 否
custom_topics 对象 已配置的自定义主题的 true/false 筛选结果的集合。 否
~~ 详细信息 数组 各个主题 ID 的对以及是否检测到它们。 否
~~ 已筛选 布尔 一个值，该值指示任何详细主题是否导致筛选作。 否
错误 对象 如果存在，则有关阻止内容筛选完成评估的错误的详细信息。 否
└─ 代码 整数 与错误关联的不同计算机可读代码。 否
└─ 消息 字符串 与错误关联的人工可读消息。 否
恨 对象 一个标记的内容筛选器结果项，指示是否筛选了内容以及内容定性
内容的严重性级别根据类别的内容筛选器配置进行评估。		 否
~~ 已筛选 布尔 内容严重性是否导致内容筛选作。 否
~~ 严重性 枚举 内容的标记严重性。
可能的值：safe、low、medium、high		 否
personally_identifiable_information 对象 包含危害扩展的个人身份信息的内容筛选器检测结果。 否
redacted_text 字符串 删除或屏蔽 PII 信息的修订文本。 否
sub_categories 数组 单个 PIIHarmSubCategory（s）的详细结果。 否
亵渎 对象 一个标记的内容筛选器结果项，指示是否检测到内容以及内容是否为
过滤。		 否
检测到 布尔 是否在内容中检测到标记的内容类别。 否
~~ 已筛选 布尔 内容检测是否导致内容筛选作。 否
protected_material_code 对象 描述与许可代码或其他受保护源材料匹配的检测结果。 否
~~ 引文 对象 如果可用，则引文详细信息，描述关联的许可证及其位置。 否
{} URL 字符串 与许可证关联的 URL。 否
~~ 许可证 字符串 与检测关联的许可证的名称或标识符。 否
检测到 布尔 是否在内容中检测到标记的内容类别。 否
~~ 已筛选 布尔 内容检测是否导致内容筛选作。 否
protected_material_text 对象 一个标记的内容筛选器结果项，指示是否检测到内容以及内容是否为
过滤。		 否
检测到 布尔 是否在内容中检测到标记的内容类别。 否
~~ 已筛选 布尔 内容检测是否导致内容筛选作。 否
self_harm 对象 一个标记的内容筛选器结果项，指示是否筛选了内容以及内容定性
内容的严重性级别根据类别的内容筛选器配置进行评估。		 否
~~ 已筛选 布尔 内容严重性是否导致内容筛选作。 否
~~ 严重性 枚举 内容的标记严重性。
可能的值：safe、low、medium、high		 否
性的 对象 一个标记的内容筛选器结果项，指示是否筛选了内容以及内容定性
内容的严重性级别根据类别的内容筛选器配置进行评估。		 否
~~ 已筛选 布尔 内容严重性是否导致内容筛选作。 否
~~ 严重性 枚举 内容的标记严重性。
可能的值：safe、low、medium、high		 否
ungrounded_material AzureContentFilterCompletionTextSpanDetectionResult 否
暴力 对象 一个标记的内容筛选器结果项，指示是否筛选了内容以及内容定性
内容的严重性级别根据类别的内容筛选器配置进行评估。		 否
~~ 已筛选 布尔 内容严重性是否导致内容筛选作。 否
~~ 严重性 枚举 内容的标记严重性。
可能的值：safe、low、medium、high		 否

AzureContentFilterResultForPrompt

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

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

AzureContentFilterSeverityResult

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

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

AzureCosmosDBChatDataSource

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

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

AzureCreateChatCompletionRequest

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

名称 类型 DESCRIPTION 必选 违约
音频 对象 音频输出的参数。 当使用 请求音频输出时是必需的
modalities: ["audio"]。		 否
~~ 格式 枚举 指定输出音频格式。 必须是以下项之wav一： mp3flac
opus 或 pcm16 中的一项。
可能的值：wav、、aac、mp3flac、opus、pcm16		 否
~~ 语音 对象 否
data_sources 数组 用于“数据上的”功能的数据源，专用于 Azure OpenAI。 否
frequency_penalty 数字 介于 -2.0 和 2.0 之间的数字。 正值基于
到目前为止，文本中的现有频率会减少模型
重复同一行的可能性。		 否 0
function_call 枚举 通过 {"name": "my_function"} 强制模型调用该函数来指定特定函数。
可能的值： noneauto		 否
functions 数组 弃用赞成 tools。

模型可能为其生成 JSON 输入的函数列表。		 否
logit_bias 对象 修改指定令牌在完成中出现的可能性。

接受映射令牌的 JSON 对象（由令牌 ID 在
tokenizer）到从 -100 到 100 的关联偏差值。 数学
偏差将添加到采样之前模型生成的对数。
具体效果因模型而异，但 -1 和 1 之间的值应
减少或增加选择的可能性;-100 或 100 等值
应生成相关令牌的禁令或独占选择。		 否 没有
logprobs 布尔 是否返回输出令牌的对数概率。 如果为 true，则为
返回在 中返回的每个输出令牌的对数概率
content的 .message		 否 假
max_completion_tokens 整数 可为其生成令牌数的上限
完成，包括可见的输出令牌和推理令牌。		 否
max_tokens 整数 可在聊天完成中生成的最大令牌数。
此值可用于控制通过 API 生成的文本的成本。

此值现已弃用 max_completion_tokens，适合，并且
与 o1 系列模型不兼容。		 否
messages 数组 到目前为止，包含对话的消息列表。 取决于
你使用的模型，支持不同的消息类型（形式）
如文本、图像和音频。		 是的
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
方式 对象 希望模型生成的输出类型。
大多数模型都能够生成文本，这是默认值：

["text"]

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

["text", "audio"]		 否
模型 字符串 用于聊天完成请求的模型部署标识符。 是的
n 整数 要为每个输入消息生成的聊天完成选项数。 请注意，将根据所有选项中生成的令牌数向你收费。 n尽量1降低成本。 否 1
并行工具调用 对象 是否在工具使用期间启用 并行函数调用 。 否
预测 对象 模型预测输出的基表示形式。 否
└─ 类型 OpenAI.ChatOutputPredictionType 否
presence_penalty 数字 介于 -2.0 和 2.0 之间的数字。 正值基于
它们目前是否出现在文本中，增加模型的可能性
讨论新主题。		 否 0
推理努力 对象 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
响应格式 对象 否
└─ 类型 枚举
可能的值：text、、 json_objectjson_schema		 否
seed 整数 此功能在 Beta 版中。
如果指定，我们的系统将尽最大努力以确定性方式采样，这样具有相同参数的重复请求 seed 应返回相同的结果。
无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。		 否
stop 对象 不支持最新的推理模型 o3 和 o4-mini。

最多 4 个序列，其中 API 将停止生成进一步的令牌。 这
返回的文本将不包含停止序列。		 否
存储 布尔 是否存储此聊天完成请求的输出
用于模型提取或疏散产品。		 否 假
数据流 布尔 如果设置为 true，模型响应数据将流式传输到客户端
使用服务器发送的事件生成时。		 否 假
stream_options 对象 流式处理响应的选项。 仅在设置时设置 stream: true此设置。 否
include_usage 布尔 如果已设置，则会在 之前流式传输其他区块
消息。 usage此区块上的字段显示令牌使用情况统计信息
对于整个请求，字段 choices 将始终为空
数组。

所有其他区块也将包含一个 usage 字段，但值为 null
价值。 注意： 如果流中断，则可能不会收到
包含请求的令牌总使用量的最终使用区块。		 否
温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否 1
tool_choice OpenAI.ChatCompletionToolChoiceOption 控制模型调用哪个（如果有）工具。
none 表示模型不会调用任何工具，而是生成消息。
auto 表示模型可以在生成消息或调用一个或多个工具之间进行选择。
required 表示模型必须调用一个或多个工具。
通过 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具来指定特定工具。

none 如果没有工具，则为默认值。 auto 如果存在工具，则为默认值。		 否
tools 数组 模型可以调用的工具列表。 目前，仅支持函数作为工具。 使用此函数提供模型可能会为其生成 JSON 输入的函数列表。 最多支持 128 个函数。 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否 1
用户 字符串 表示最终用户的唯一标识符，可帮助
监视和检测滥用行为。		 否
user_security_context AzureUserSecurityContext 用户安全上下文包含描述应用程序本身的多个参数，以及与应用程序交互的最终用户。 这些字段通过提供全面的方法来保护 AI 应用程序，帮助安全运营团队调查和缓解安全事件。 详细了解 如何使用 Microsoft Defender for Cloud 保护 AI 应用程序。 否

AzureCreateChatCompletionResponse

Azure OpenAI 服务的扩展顶级聊天完成响应模型。 此模型为提示输入添加“负责任的 AI 内容”筛选器批注。

名称 类型 DESCRIPTION 必选 违约
选择 数组 是的
created 整数 创建聊天完成时间的 Unix 时间戳（以秒为单位）。 是的
id 字符串 聊天完成的唯一标识符。 是的
模型 字符串 用于聊天完成的模型。 是的
对象 枚举 始终为 chat.completion 的对象类型。
可能的值：chat.completion		 是的
prompt_filter_results 数组 与聊天完成提示输入关联的“负责任的 AI 内容”筛选器批注。 否
system_fingerprint 字符串 此指纹表示模型运行的后端配置。

可以与请求参数结合使用 seed ，以了解后端更改何时发生可能影响确定性。		 否
使用情况 OpenAI.CompletionUsage 完成请求的使用情况统计信息。 否

AzureCreateChatCompletionStreamResponse

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

AzureCreateEmbeddingRequest

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

AzureCreateFileRequestMultiPart

名称 类型 DESCRIPTION 必选 违约
过期时间 对象 是的
~~ 定位点 AzureFileExpiryAnchor 否
~~ 秒 整数 否
文件 字符串 是的
purpose 枚举 上传文件的预期用途。 其中一个： - assistants： 在助手 API 中使用 - batch： 在 Batch API 中使用 - fine-tune： 用于微调 - evals： 用于 eval 数据集
可能的值：assistants、batch、fine-tune、evals		 是的

AzureCreateResponse

名称 类型 DESCRIPTION 必选 违约
后台的 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
包括 数组 指定要包含在模型响应中的其他输出数据。 现在
支持的值包括：
- 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或组织时
在零数据保留计划中注册）。		 否
输入 字符串或数组 否
指示 字符串 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
模型 字符串 用于创建此响应的模型部署。 是的
并行工具调用 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
提示 对象 对提示模板及其变量的引用。
 否
{~ id 字符串 要使用的提示模板的唯一标识符。 否
~~ 变量 OpenAI.ResponsePromptVariables 用于替换变量的值的可选映射
提示。 替换值可以是字符串或其他
响应输入类型，如图像或文件。		 否
~~ 版本 字符串 提示模板的可选版本。 否
推理 对象 仅推理模型

的配置选项
推理模型。		 否
~~ 工作 OpenAI.ReasoningEffort 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
generate_summary 枚举 已弃用： 改用 summary 。

模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
~~ 摘要 枚举 模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
存储 布尔 是否存储生成的模型响应，以便以后通过
应用程序接口。		 否 真 实
数据流 布尔 如果设置为 true，模型响应数据将流式传输到客户端
使用 服务器发送的事件生成时。
请参阅 下面的流式处理部分
有关详细信息。		 否 假
温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否 1
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice 对象 控制模型调用哪个（如果有）工具。

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

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

required 表示模型必须调用一个或多个工具。		 否
└─ 类型 OpenAI.ToolChoiceObjectType 指示模型应使用内置工具生成响应。 否
tools 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如文件搜索。
- 函数调用（自定义工具）：由你定义的函数，
使模型能够调用自己的代码。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否 1
截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否

Azure错误响应 (AzureErrorResponse)

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

AzureEvalAPICompletionsSamplingParams

名称 类型 DESCRIPTION 必选 违约
并行工具调用 布尔 否
响应格式 OpenAI.ResponseTextFormatConfiguration 否
tools 数组 否

AzureEvalAPIModelSamplingParams

名称 类型 DESCRIPTION 必选 违约
max_tokens 整数 生成的输出中令牌的最大数目。 否
推理努力 枚举 控制生成过程中应用的推理工作量级别。
可能的值：low、、 mediumhigh		 否
seed 整数 用于在采样期间初始化随机性的种子值。 否
温度 数字 较高的温度会增加输出中的随机性。 否
top_p 数字 核采样温度的替代方法；1.0 包括所有令牌。 否

AzureEvalAPIResponseSamplingParams

名称 类型 DESCRIPTION 必选 违约
并行工具调用 布尔 否
响应格式 OpenAI.ResponseTextFormatConfiguration 否
tools 数组 否

AzureFileExpiryAnchor

资产 价值
类型 字符串
价值观 created_at

AzureFineTuneReinforcementMethod

名称 类型 DESCRIPTION 必选 违约
年级 对象 一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。 是的
calculate_output 字符串 用于基于评分器结果计算输出的公式。 否
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		 否
~~ 评分员 对象 否
└─ 输入 数组 输入文本。 这可能包括模板字符串。 否
└─ 模型 字符串 要用于评估的模型。 否
└─ 名称 字符串 评分程序的名称。 否
~~作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 否
~~ 范围 数组 分数的范围。 默认为 [0, 1]。 否
~~ 参考 字符串 作为评分参照的文本。 否
采样参数 (sampling_params) 模型的采样参数。 否
└─ 类型 枚举 始终为 multi 的对象类型。
可能的值：multi		 否
超参数 OpenAI.FineTuneReinforcementHyperparameters 用于强化微调作业的超参数。 否
响应格式 对象 否
json_schema 对象 响应格式的 JSON 架构 否
└─ 类型 枚举 响应格式的类型
可能的值：json_schema		 否

AzureListFilesResponse

名称 类型 DESCRIPTION 必选 违约
数据 数组 是的
first_id 字符串 是的
has_more 布尔 是的
last_id 字符串 是的
对象 枚举
可能的值：list		 是的

AzureOpenAIFile

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

AzurePiiSubCategoryResult

单个 PIIHarmSubCategory（s）的结果详细信息。

名称 类型 DESCRIPTION 必选 违约
检测 布尔 是否在内容中检测到标记的内容子类别。 是的
过滤 布尔 内容检测是否导致此子类别的内容筛选作。 是的
redacted 布尔 是否为此子类别修改了内容。 是的
sub_category 字符串 已评估的 PIIHarmSubCategory。 是的

AzureResponse

名称 类型 DESCRIPTION 必选 违约
后台的 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
创建时间 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 是的
错误 对象 当模型无法生成响应时返回的错误对象。 是的
└─ 代码 OpenAI.ResponseErrorCode 响应的错误代码。 否
└─ 消息 字符串 错误的人工可读说明。 否
id 字符串 此响应的唯一标识符。 是的
incomplete_details 对象 有关响应不完整的原因的详细信息。 是的
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
指示 字符串或数组 是的
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
模型 字符串 用于生成此响应的模型。 是的
对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 是的
输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 是的
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
并行工具调用 布尔 是否允许模型并行运行工具调用。 是的 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
提示 对象 对提示模板及其变量的引用。
 否
{~ id 字符串 要使用的提示模板的唯一标识符。 否
~~ 变量 OpenAI.ResponsePromptVariables 用于替换变量的值的可选映射
提示。 替换值可以是字符串或其他
响应输入类型，如图像或文件。		 否
~~ 版本 字符串 提示模板的可选版本。 否
推理 对象 仅推理模型

的配置选项
推理模型。		 否
~~ 工作 OpenAI.ReasoningEffort 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
generate_summary 枚举 已弃用： 改用 summary 。

模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
~~ 摘要 枚举 模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 是的
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice 对象 控制模型调用哪个（如果有）工具。

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

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

required 表示模型必须调用一个或多个工具。		 否
└─ 类型 OpenAI.ToolChoiceObjectType 指示模型应使用内置工具生成响应。 否
tools 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 是的
截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
使用情况 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 是的

AzureSearchChatDataSource

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

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

AzureUserSecurityContext

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

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

ChatCompletionMessageToolCallsItem

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

数组： OpenAI.ChatCompletionMessageToolCall

CopiedAccountDetails

名称 类型 DESCRIPTION 必选 违约
destinationResourceId 字符串 复制到模型的目标资源的 ID。 是的
区域 字符串 将模型复制到的区域。 是的
状态 枚举 复制作的状态。
可能的值：Completed、、 FailedInProgress		 是的

CopyModelRequest

名称 类型 DESCRIPTION 必选 违约
destinationResourceId 字符串 要复制的目标资源的 ID。 是的
区域 字符串 要将模型复制到的区域。 是的

CopyModelResponse

名称 类型 DESCRIPTION 必选 违约
checkpointedModelName 字符串 复制的模型的 ID。 是的
copiedAccountDetails 数组 复制目标资源 ID 的 ID 是的
fineTuningJobId 字符串 从中复制检查点的微调作业的 ID。 是的

ElasticsearchChatDataSource

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

MongoDBChatDataSource

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

OpenAI.Annotation

OpenAI.Annotation 的鉴别器

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

类型值 图式
file_citation OpenAI.AnnotationFileCitation
url_citation OpenAI.AnnotationUrlCitation
file_path OpenAI.AnnotationFilePath
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.AnnotationType 是的

OpenAI.AnnotationFileCitation

指向文件的引文。

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

OpenAI.AnnotationFilePath

文件的路径。

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

OpenAI.AnnotationType

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

OpenAI.AnnotationUrlCitation

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

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

OpenAI.ApproximateLocation

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

OpenAI.AutoChunkingStrategyRequestParam

默认策略。 此策略目前使用和 max_chunk_size_tokens800 //chunk_overlap_tokens400

名称 类型 DESCRIPTION 必选 违约
类型 枚举 始终为 auto。
可能的值：auto		 是的

OpenAI.ChatCompletionFunctionCallOption

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

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

OpenAI.ChatCompletionFunctions

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

省 parameters 略定义具有空参数列表的函数。		 否

OpenAI.ChatCompletionMessageAudioChunk

名称 类型 DESCRIPTION 必选 违约
数据 字符串 否
过期时间 整数 否
id 字符串 否
脚本 字符串 否

OpenAI.ChatCompletionMessageToolCall

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

OpenAI.ChatCompletionMessageToolCallChunk

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

OpenAI.ChatCompletionNamedToolChoice

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

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

OpenAI.ChatCompletionRequestAssistantMessage

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

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

OpenAI.ChatCompletionRequestAssistantMessageContentPart

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

OpenAI.ChatCompletionRequestDeveloperMessage

开发人员提供的说明，无论用户发送的消息如何，模型都应遵循。 使用 o1 模型和更新后， developer 消息将替换以前的 system 消息。

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

OpenAI.ChatCompletionRequestFunctionMessage

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

OpenAI.ChatCompletionRequestMessage

OpenAI.ChatCompletionRequestMessage 的鉴别器

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

类型值 图式
system OpenAI.ChatCompletionRequestSystemMessage
developer OpenAI.ChatCompletionRequestDeveloperMessage
user OpenAI.ChatCompletionRequestUserMessage
assistant OpenAI.ChatCompletionRequestAssistantMessage
tool OpenAI.ChatCompletionRequestToolMessage
function OpenAI.ChatCompletionRequestFunctionMessage
名称 类型 DESCRIPTION 必选 违约
内容 字符串或数组 否
角色 对象 邮件作者的角色 是的

OpenAI.ChatCompletionRequestMessageContentPart

OpenAI.ChatCompletionRequestMessageContentPart 的鉴别器

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

类型值 图式
text OpenAI.ChatCompletionRequestMessageContentPartText
image_url OpenAI.ChatCompletionRequestMessageContentPartImage
refusal OpenAI.ChatCompletionRequestMessageContentPartRefusal
file OpenAI.ChatCompletionRequestMessageContentPartFile
input_audio OpenAI.ChatCompletionRequestMessageContentPartAudio
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ChatCompletionRequestMessageContentPartType 是的

OpenAI.ChatCompletionRequestMessageContentPartAudio

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

OpenAI.ChatCompletionRequestMessageContentPartFile

名称 类型 DESCRIPTION 必选 违约
文件 对象 是的
file_data 字符串 将文件传递到模型时使用的 base64 编码文件数据
作为字符串。		 否
file_id 字符串 要用作输入的上传文件的 ID。 否
~~ 文件名 字符串 文件的名称，在将文件作为一个模型传递给模型时使用
字符串。		 否
类型 枚举 内容部件的类型。 始终为 file。
可能的值：file		 是的

OpenAI.ChatCompletionRequestMessageContentPartImage

名称 类型 DESCRIPTION 必选 违约
image_url 对象 是的
~~ 详细信息 枚举 指定图像的详细信息级别。
可能的值：auto、、 lowhigh		 否
{} url 字符串 图像的 URL 或 base64 编码的图像数据。 否
类型 枚举 内容部件的类型。
可能的值：image_url		 是的

OpenAI.ChatCompletionRequestMessageContentPartRefusal

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

OpenAI.ChatCompletionRequestMessageContentPartText

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

OpenAI.ChatCompletionRequestMessageContentPartType

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

OpenAI.ChatCompletionRequestSystemMessage

开发人员提供的说明，无论用户发送的消息如何，模型都应遵循。 对于 o1 模型和更新， developer 请改用消息进行此目的。

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

OpenAI.ChatCompletionRequestSystemMessageContentPart

参考： OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestToolMessage

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

OpenAI.ChatCompletionRequestToolMessageContentPart

参考： OpenAI.ChatCompletionRequestMessageContentPartText

OpenAI.ChatCompletionRequestUserMessage

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

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

OpenAI.ChatCompletionRequestUserMessageContentPart

名称 类型 DESCRIPTION 必选 违约
文件 对象 是的
file_data 字符串 将文件传递到模型时使用的 base64 编码文件数据
作为字符串。		 否
file_id 字符串 要用作输入的上传文件的 ID。 否
~~ 文件名 字符串 文件的名称，在将文件作为一个模型传递给模型时使用
字符串。		 否
image_url 对象 是的
~~ 详细信息 枚举 指定图像的详细信息级别。
可能的值：auto、、 lowhigh		 否
{} url 字符串 图像的 URL 或 base64 编码的图像数据。 否
input_audio 对象 是的
~~ 数据 字符串 Base64 编码的音频数据。 否
~~ 格式 枚举 编码的音频数据的格式。 目前支持“wav”和“mp3”。
可能的值： wavmp3		 否
文本消息 字符串 文本内容。 是的
类型 枚举 内容部件的类型。 始终为 file。
可能的值：file		 是的

OpenAI.ChatCompletionRole

邮件作者的角色

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

OpenAI.ChatCompletionStreamOptions

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

名称 类型 DESCRIPTION 必选 违约
include_usage 布尔 如果已设置，则会在 之前流式传输其他区块
消息。 usage此区块上的字段显示令牌使用情况统计信息
对于整个请求，字段 choices 将始终为空
数组。

所有其他区块也将包含一个 usage 字段，但值为 null
价值。 注意： 如果流中断，则可能不会收到
包含请求的令牌总使用量的最终使用区块。		 否

OpenAI.ChatCompletionStreamResponseDelta

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

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

OpenAI.ChatCompletionTokenLogprob

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

OpenAI 聊天完成工具

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

OpenAI.ChatCompletionToolChoiceOption

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

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

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

OpenAI.ChatOutputPrediction

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

OpenAI.ChatOutputPrediction 的鉴别器

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

类型值 图式
content OpenAI.ChatOutputPredictionContent
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ChatOutputPredictionType 是的

OpenAI.ChatOutputPredictionContent

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

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

OpenAI.ChatOutputPredictionType

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

OpenAI.ChunkingStrategyRequestParam

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

OpenAI.ChunkingStrategyRequestParam 的鉴别器

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

类型值 图式
static OpenAI.StaticChunkingStrategyRequestParam
名称 类型 DESCRIPTION 必选 违约
类型 枚举 分块策略的类型。
可能的值： autostatic		 是的

OpenAI.ChunkingStrategyResponseParam

OpenAI.ChunkingStrategyResponseParam 的鉴别器

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

类型值 图式
other OpenAI.OtherChunkingStrategyResponseParam
static OpenAI.StaticChunkingStrategyResponseParam
名称 类型 DESCRIPTION 必选 违约
类型 枚举
可能的值： staticother		 是的

OpenAI.CodeInterpreterOutput

OpenAI.CodeInterpreterOutput 的鉴别器

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

类型值 图式
image OpenAI.CodeInterpreterOutputImage
logs OpenAI.CodeInterpreterOutputLogs
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.CodeInterpreterOutputType 是的

OpenAI.CodeInterpreterOutputImage

代码解释器的图像输出。

名称 类型 DESCRIPTION 必选 违约
类型 枚举 输出的类型。 始终为“image”。
可能的值：image		 是的
网址 字符串 代码解释器的图像输出的 URL。 是的

OpenAI.CodeInterpreterOutputLogs

代码解释器的日志输出。

名称 类型 DESCRIPTION 必选 违约
日志 字符串 代码解释器的日志输出。 是的
类型 枚举 输出的类型。 始终为“logs”。
可能的值：logs		 是的

OpenAI.CodeInterpreterOutputType

资产 价值
类型 字符串
价值观 logs
image

OpenAI.CodeInterpreterTool

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

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

OpenAI.CodeInterpreterToolAuto

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

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

OpenAI.CodeInterpreterToolCallItemParam

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

名称 类型 DESCRIPTION 必选 违约
代码 字符串 要运行的代码，如果不可用，则为 null。 是的
container_id 字符串 用于运行代码的容器的 ID。 是的
outputs 数组 代码解释器生成的输出，例如日志或图像。
如果没有可用的输出，可以为 null。		 是的
类型 枚举
可能的值：code_interpreter_call		 是的

OpenAI.CodeInterpreterToolCallItemResource

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

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

OpenAI.ComparisonFilter（比较过滤器）

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

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

OpenAI.CompletionUsage

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

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

OpenAI.复合过滤器

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

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

OpenAI.ComputerAction

OpenAI.ComputerAction 的鉴别器

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

类型值 图式
click OpenAI.ComputerActionClick
double_click OpenAI.ComputerActionDoubleClick
drag OpenAI.ComputerActionDrag
move OpenAI.ComputerActionMove
screenshot OpenAI.ComputerActionScreenshot
scroll OpenAI.ComputerActionScroll
type OpenAI.ComputerActionTypeKeys
wait OpenAI.ComputerActionWait
keypress OpenAI.ComputerActionKeyPress
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ComputerActionType 是的

OpenAI.ComputerActionClick

单击作。

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

OpenAI.ComputerActionDoubleClick

双击作。

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

OpenAI.ComputerActionDrag

拖动作。

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

OpenAI.ComputerActionKeyPress

模型要执行的键压集合。

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

OpenAI.ComputerActionMove

鼠标移动作。

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

OpenAI.ComputerActionScreenshot

屏幕截图作。

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

OpenAI.ComputerActionScroll

滚动作。

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

OpenAI.ComputerActionType

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

OpenAI.ComputerActionTypeKeys

要键入文本的作。

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

OpenAI.ComputerActionWait

等待作。

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

OpenAI.ComputerToolCallItemParam

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

名称 类型 DESCRIPTION 必选 违约
操作 OpenAI.ComputerAction 是的
call_id 字符串 使用输出响应工具调用时使用的标识符。 是的
pending_safety_checks 数组 挂起的安全检查计算机调用。 是的
类型 枚举
可能的值：computer_call		 是的

OpenAI.ComputerToolCallItemResource

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

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

OpenAI.ComputerToolCallOutputItemOutput

OpenAI.ComputerToolCallOutputItemOutput 的鉴别器

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

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

OpenAI.ComputerToolCallOutputItemOutputComputerScreenshot

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

OpenAI.ComputerToolCallOutputItemOutputType

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

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

OpenAI.ComputerToolCallOutputItemParam

计算机工具调用的输出。

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

OpenAI.ComputerToolCallOutputItemResource

计算机工具调用的输出。

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

OpenAI.ComputerToolCallSafetyCheck

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

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

OpenAI.ComputerUsePreviewTool

控制虚拟计算机的工具。

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

OpenAI.Coordinate

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

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

OpenAI.CreateEmbeddingResponse

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

OpenAI.CreateEvalItem

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

名称 类型 DESCRIPTION 必选 违约
内容 string 或 OpenAI.EvalItemContent 模型的文本输入 - 可以包含模板字符串。 是的
角色 枚举 消息输入的角色。 user、assistant、system之一或
developer。
可能的值：user、assistant、system、developer		 是的
类型 枚举 消息输入的类型。 始终为 message。
可能的值：message		 否

OpenAI.CreateEvalRunRequest

名称 类型 DESCRIPTION 必选 违约
数据源 对象 是的
└─ 类型 OpenAI.EvalRunDataSourceType 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
姓名 字符串 运行的名称。 否

OpenAI.CreateFineTuningJobRequest

有效模型：

babbage-002
davinci-002
gpt-3.5-turbo
gpt-4o-mini
名称 类型 DESCRIPTION 必选 违约
超参数 对象 用于微调作业的超参数。
此值现在已弃用 method，应该在参数下 method 传入。		 否
batch_size 枚举
可能的值：auto		 否
learning_rate_multiplier 枚举
可能的值：auto		 否
n_epochs 枚举
可能的值：auto		 否
整合 数组 要为微调作业启用的集成列表。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
方法 OpenAI.FineTuneMethod 用于微调的方法。 否
模型 字符串 （请参阅下面的有效模型） 要微调的模型的名称。 可以选择其中一个
支持的模型。		 是的
seed 整数 种子控制作业的可重现性。 传入相同的种子和作业参数应会产生相同的结果，但在极少数情况下可能会有差异。
如果未指定种子，则会为你生成一个种子。		 否
suffix 字符串 最多 64 个字符的字符串，将添加到微调的模型名称中。

例如，一个 suffix “custom-model-name”将生成一个模型名称，如下所示 ft:gpt-4o-mini:openai:custom-model-name:7p4lURel。		 否 没有
训练文件 字符串 包含训练数据的上传文件的 ID。

请参阅 上传文件 ，了解如何上传文件。

数据集的格式必须为 JSONL 文件。 此外，还必须使用目的 fine-tune上传文件。

文件的内容应有所不同，具体取决于模型是否使用 聊天，或者微调方法是否使用 首选项 格式。

有关更多详细信息 ，请参阅微调指南 。		 是的
验证文件 字符串 包含验证数据的上传文件的 ID。

如果提供此文件，则数据用于生成验证
在微调期间定期指标。 可以在其中查看这些指标
微调结果文件。
训练文件和验证文件中不应存在相同的数据。

数据集的格式必须为 JSONL 文件。 必须按照目的 fine-tune上传文件。

有关更多详细信息 ，请参阅微调指南 。		 否

OpenAI.CreateFineTuningJobRequestIntegration

OpenAI.CreateFineTuningJobRequestIntegration 的鉴别器

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

类型值 图式
wandb OpenAI.CreateFineTuningJobRequestWandbIntegration
名称 类型 DESCRIPTION 必选 违约
类型 字符串 （请参阅下面的有效模型） 是的

OpenAI.CreateFineTuningJobRequestWandbIntegration

名称 类型 DESCRIPTION 必选 违约
类型 枚举
可能的值：wandb		 是的
wandb 对象 是的
~~ 实体 字符串 否
└─ 名称 字符串 否
~~ 项目 字符串 否
~~ 标记 数组 否

OpenAI.CreateVectorStoreFileBatchRequest

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

OpenAI.CreateVectorStoreFileRequest

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

OpenAI.CreateVectorStoreRequest

名称 类型 DESCRIPTION 必选 违约
chunking_strategy 对象 默认策略。 此策略目前使用和 max_chunk_size_tokens800 //chunk_overlap_tokens400 否
~~ 静态 OpenAI.StaticChunkingStrategy 否
└─ 类型 枚举 始终为 static。
可能的值：static		 否
过期时间 OpenAI.VectorStoreExpirationAfter 矢量存储的过期策略。 否
file_ids 数组 矢量存储应使用的文件 ID 列表。 可用于访问文件等 file_search 工具。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
姓名 字符串 矢量存储的名称。 否

OpenAI.DeleteFileResponse

名称 类型 DESCRIPTION 必选 违约
已删除 布尔 是的
id 字符串 是的
对象 枚举
可能的值：file		 是的

OpenAI.DeleteVectorStoreFileResponse

名称 类型 DESCRIPTION 必选 违约
已删除 布尔 是的
id 字符串 是的
对象 枚举
可能的值：vector_store.file.deleted		 是的

OpenAI.DeleteVectorStoreResponse

名称 类型 DESCRIPTION 必选 违约
已删除 布尔 是的
id 字符串 是的
对象 枚举
可能的值：vector_store.deleted		 是的

OpenAI.Embedding

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

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

OpenAI.Eval

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

  • 提高聊天机器人的质量
  • 了解聊天机器人如何处理客户支持
  • 检查 o4-mini 在我的用例上是否比 gpt-4o 更好
名称 类型 DESCRIPTION 必选 违约
创建时间 整数 创建 eval 时的 Unix 时间戳（以秒为单位）。 是的
数据源配置 对象 是的
└─ 类型 OpenAI.EvalDataSourceConfigType 否
id 字符串 评估的唯一标识符。 是的
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
姓名 字符串 评估的名称。 是的
对象 枚举 对象类型。
可能的值：eval		 是的
测试标准 数组 测试条件列表。 是的 没有

OpenAI.EvalApiError

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

名称 类型 DESCRIPTION 必选 违约
代码 字符串 错误代码。 是的
消息 字符串 错误消息。 是的

OpenAI.EvalCompletionsRunDataSourceParams

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

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

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
└─ 模型 字符串 用于筛选的可选模型（例如，“gpt-4o”）。 否
└─ 类型 枚举 源的类型。 始终为 stored_completions。
可能的值：stored_completions		 否
类型 枚举 运行数据源的类型。 始终为 completions。
可能的值：completions		 是的

OpenAI.EvalCustomDataSourceConfigParams

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

  • 用于定义测试条件和
  • 创建运行时需要哪些数据
名称 类型 DESCRIPTION 必选 违约
include_sample_schema 布尔 评估是否应期望由你填充示例命名空间（即通过从数据源生成响应） 否 假
item_schema 对象 数据源中每一行的 json 架构。 是的
类型 枚举 数据源的类型。 始终为 custom。
可能的值：custom		 是的

OpenAI.EvalCustomDataSourceConfigResource

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

  • 用于定义测试条件和
  • 创建运行时需要哪些数据
名称 类型 DESCRIPTION 必选 违约
架构 对象 运行数据源项的 json 架构。
了解如何 在此处生成 JSON 架构。		 是的
类型 枚举 数据源的类型。 始终为 custom。
可能的值：custom		 是的

OpenAI.EvalDataSourceConfigParams

OpenAI.EvalDataSourceConfigParams 的鉴别器

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

类型值 图式
custom OpenAI.EvalCustomDataSourceConfigParams
logs OpenAI.EvalLogsDataSourceConfigParams
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigParams
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.EvalDataSourceConfigType 是的

OpenAI.EvalDataSourceConfigResource

OpenAI.EvalDataSourceConfigResource 的鉴别器

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

类型值 图式
custom OpenAI.EvalCustomDataSourceConfigResource
stored_completions OpenAI.EvalStoredCompletionsDataSourceConfigResource
logs OpenAI.EvalLogsDataSourceConfigResource
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.EvalDataSourceConfigType 是的

OpenAI.EvalDataSourceConfigType

资产 价值
类型 字符串
价值观 custom
logs
stored_completions

OpenAI.EvalGraderLabelModelParams

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

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

OpenAI.EvalGraderLabelModelResource

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

OpenAI.EvalGraderParams

OpenAI.EvalGraderParams 的鉴别器

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

类型值 图式
label_model OpenAI.EvalGraderLabelModelParams
string_check OpenAI.EvalGraderStringCheckParams
text_similarity OpenAI.EvalGraderTextSimilarityParams
python OpenAI.EvalGraderPythonParams
score_model OpenAI.EvalGraderScoreModelParams
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.GraderType 是的

OpenAI.EvalGraderPythonParams

名称 类型 DESCRIPTION 必选 违约
image_tag 字符串 用于 python 脚本的图像标记。 否
姓名 字符串 评分程序的名称。 是的
通过阈值 数字 分数的阈值。 否
源 字符串 python 脚本的源代码。 是的
类型 枚举 始终为 python 的对象类型。
可能的值：python		 是的

OpenAI.EvalGraderPythonResource

名称 类型 DESCRIPTION 必选 违约
image_tag 字符串 用于 python 脚本的图像标记。 否
姓名 字符串 评分程序的名称。 是的
通过阈值 数字 分数的阈值。 否
源 字符串 python 脚本的源代码。 是的
类型 枚举 始终为 python 的对象类型。
可能的值：python		 是的

OpenAI.EvalGraderResource

OpenAI.EvalGraderResource 的鉴别器

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

类型值 图式
label_model OpenAI.EvalGraderLabelModelResource
text_similarity OpenAI.EvalGraderTextSimilarityResource
python OpenAI.EvalGraderPythonResource
score_model OpenAI.EvalGraderScoreModelResource
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.GraderType 是的

OpenAI.EvalGraderScoreModelParams

名称 类型 DESCRIPTION 必选 违约
输入 数组 输入文本。 这可能包括模板字符串。 是的
模型 字符串 要用于评估的模型。 是的
姓名 字符串 评分程序的名称。 是的
通过阈值 数字 分数的阈值。 否
范围 数组 分数的范围。 默认为 [0, 1]。 否
采样参数 模型的采样参数。 否
类型 枚举 始终为 score_model 的对象类型。
可能的值：score_model		 是的

OpenAI.EvalGraderScoreModelResource

名称 类型 DESCRIPTION 必选 违约
输入 数组 输入文本。 这可能包括模板字符串。 是的
模型 字符串 要用于评估的模型。 是的
姓名 字符串 评分程序的名称。 是的
通过阈值 数字 分数的阈值。 否
范围 数组 分数的范围。 默认为 [0, 1]。 否
采样参数 模型的采样参数。 否
类型 枚举 始终为 score_model 的对象类型。
可能的值：score_model		 是的

OpenAI.EvalGraderStringCheckParams

名称 类型 DESCRIPTION 必选 违约
输入 字符串 输入文本。 这可能包括模板字符串。 是的
姓名 字符串 评分程序的名称。 是的
操作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 是的
引用 字符串 引用文本。 这可能包括模板字符串。 是的
类型 枚举 始终为 string_check 的对象类型。
可能的值：string_check		 是的

OpenAI.EvalGraderTextSimilarityParams

名称 类型 DESCRIPTION 必选 违约
评估指标 枚举 要使用的评估指标。 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		 是的
输入 字符串 正在评分的文本。 是的
姓名 字符串 评分程序的名称。 是的
通过阈值 数字 分数的阈值。 是的
引用 字符串 作为评分参照的文本。 是的
类型 枚举 评分程序的类型。
可能的值：text_similarity		 是的

OpenAI.EvalGraderTextSimilarityResource

名称 类型 DESCRIPTION 必选 违约
评估指标 枚举 要使用的评估指标。 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		 是的
输入 字符串 正在评分的文本。 是的
姓名 字符串 评分程序的名称。 是的
通过阈值 数字 分数的阈值。 是的
引用 字符串 作为评分参照的文本。 是的
类型 枚举 评分程序的类型。
可能的值：text_similarity		 是的

OpenAI.EvalItem

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

名称 类型 DESCRIPTION 必选 违约
内容 对象 是的
└─ 类型 OpenAI.EvalItemContentType 否
角色 枚举 消息输入的角色。 user、assistant、system之一或
developer。
可能的值：user、assistant、system、developer		 是的
类型 枚举 消息输入的类型。 始终为 message。
可能的值：message		 否

OpenAI.EvalItemContent

OpenAI.EvalItemContent 的鉴别器

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

类型值 图式
input_text OpenAI.EvalItemContentInputText
output_text OpenAI.EvalItemContentOutputText
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.EvalItemContentType 是的

OpenAI.EvalItemContentInputText

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

OpenAI.EvalItemContentOutputText

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

OpenAI.EvalItemContentType

资产 价值
类型 字符串
价值观 input_text
output_text

OpenAI.EvalJsonlRunDataSourceParams

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

名称 类型 DESCRIPTION 必选 违约
源 对象 是的
└─ 内容 数组 jsonl 文件的内容。 否
{~ id 字符串 文件的标识符。 否
└─ 类型 枚举 jsonl 源的类型。 始终为 file_id。
可能的值：file_id		 否
类型 枚举 数据源的类型。 始终为 jsonl。
可能的值：jsonl		 是的

OpenAI.EvalList

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

名称 类型 DESCRIPTION 必选 违约
数据 数组 一组评估对象。 是的
first_id 字符串 数据数组中第一个评估的标识符。 是的
has_more 布尔 指示是否有更多的评估可用。 是的
last_id 字符串 数据数组中最后一个评估的标识符。 是的
对象 枚举 此对象的类型。 它始终设置为“list”。
可能的值：list		 是的

OpenAI.EvalLogsDataSourceConfigParams

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

名称 类型 DESCRIPTION 必选 违约
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
类型 枚举 数据源的类型。 始终为 logs。
可能的值：logs		 是的

OpenAI.EvalLogsDataSourceConfigResource

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

名称 类型 DESCRIPTION 必选 违约
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
架构 对象 运行数据源项的 json 架构。
了解如何 在此处生成 JSON 架构。		 是的
类型 枚举 数据源的类型。 始终为 logs。
可能的值：logs		 是的

OpenAI.EvalResponsesRunDataSourceParams

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

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

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
└─ 模型 字符串 要查找其响应的模型的名称。 这是用于选择响应的查询参数。 否
reasoning_effort OpenAI.ReasoningEffort 可选的推理工作参数。 这是用于选择响应的查询参数。 否
~~ 温度 数字 采样温度。 这是用于选择响应的查询参数。 否
└─ 工具 数组 工具名称列表。 这是用于选择响应的查询参数。 否
top_p 数字 核采样参数。 这是用于选择响应的查询参数。 否
└─ 类型 枚举 运行数据源的类型。 始终为 responses。
可能的值：responses		 否
~~ 用户 数组 用户标识符列表。 这是用于选择响应的查询参数。 否
类型 枚举 运行数据源的类型。 始终为 responses。
可能的值：responses		 是的

OpenAI.EvalRun

表示评估运行的架构。

名称 类型 DESCRIPTION 必选 违约
创建时间 整数 创建评估运行时的 Unix 时间戳（以秒为单位）。 是的
数据源 对象 是的
└─ 类型 OpenAI.EvalRunDataSourceType 否
错误 OpenAI.EvalApiError 一个对象，表示来自 Eval API 的错误响应。 是的
eval_id 字符串 关联的评估的标识符。 是的
id 字符串 评估运行的唯一标识符。 是的
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
模型 字符串 评估的模型（如果适用）。 是的
姓名 字符串 评估运行的名称。 是的
对象 枚举 对象的类型。 始终为“eval.run”。
可能的值：eval.run		 是的
每模型使用量 数组 评估运行期间每个模型的使用情况统计信息。 是的
per_testing_criteria_results 数组 评估运行期间应用的每个测试条件的结果。 是的
report_url 字符串 UI 仪表板上呈现的评估运行报告的 URL。 是的
result_counts 对象 汇总评估运行结果的计数器。 是的
└─ 发生错误 整数 导致错误的输出项数。 否
~~ 失败 整数 未能通过评估的输出项数目。 否
└─ 通过 整数 通过评估的输出项数量。 否
~~ 总计 整数 执行的输出项总数。 否
状态 字符串 评估运行的状态。 是的

OpenAI.EvalRunDataContentSource

OpenAI.EvalRunDataContentSource 的鉴别器

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

类型值 图式
file_id OpenAI.EvalRunFileIdDataContentSource
stored_completions OpenAI.EvalRunStoredCompletionsDataContentSource
responses OpenAI.EvalRunResponsesDataContentSource
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.EvalRunDataContentSourceType 是的

OpenAI.EvalRunDataContentSourceType

资产 价值
类型 字符串
价值观 file_id
file_content
stored_completions
responses

OpenAI.EvalRunDataSourceCompletionsResource

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

OpenAI.EvalRunDataSourceJsonlResource

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

OpenAI.EvalRunDataSourceParams

OpenAI.EvalRunDataSourceParams 的鉴别器

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

类型值 图式
jsonl OpenAI.EvalJsonlRunDataSourceParams
completions OpenAI.EvalCompletionsRunDataSourceParams
responses OpenAI.EvalResponsesRunDataSourceParams
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.EvalRunDataSourceType 是的

OpenAI.EvalRunDataSourceResource

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

OpenAI.EvalRunDataSourceResponsesResource

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

OpenAI.EvalRunDataSourceType

资产 价值
类型 字符串
价值观 jsonl
completions
responses

OpenAI.EvalRunFileContentDataContentSource

名称 类型 DESCRIPTION 必选 违约
内容 数组 jsonl 文件的内容。 是的
类型 枚举 jsonl 源的类型。 始终为 file_content。
可能的值：file_content		 是的

OpenAI.EvalRunFileIdDataContentSource

名称 类型 DESCRIPTION 必选 违约
id 字符串 文件的标识符。 是的
类型 枚举 jsonl 源的类型。 始终为 file_id。
可能的值：file_id		 是的

OpenAI.EvalRunList

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

名称 类型 DESCRIPTION 必选 违约
数据 数组 一组评估运行对象。 是的
first_id 字符串 数据数组中第一个评估运行的标识符。 是的
has_more 布尔 指示是否有更多的评估可用。 是的
last_id 字符串 数据数组中最后一个评估运行的标识符。 是的
对象 枚举 此对象的类型。 它始终设置为“list”。
可能的值：list		 是的

OpenAI.EvalRunOutputItem

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

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

OpenAI.EvalRunOutputItemList

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

名称 类型 DESCRIPTION 必选 违约
数据 数组 一组评估运行输出项对象。 是的
first_id 字符串 数据数组中第一个评估运行输出项的标识符。 是的
has_more 布尔 指示是否有更多可用的 eval 运行输出项。 是的
last_id 字符串 数据数组中最后一个 eval 运行输出项的标识符。 是的
对象 枚举 此对象的类型。 它始终设置为“list”。
可能的值：list		 是的

OpenAI.EvalRunResponsesDataContentSource

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

名称 类型 DESCRIPTION 必选 违约
created_after 整数 仅包括在此时间戳之后创建的项（非独占）。 这是用于选择响应的查询参数。 否
created_before 整数 仅包含在此时间戳之前创建的项（非独占）。 这是用于选择响应的查询参数。 否
instructions_search 字符串 用于搜索“指令”字段的可选字符串。 这是用于选择响应的查询参数。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
模型 字符串 要查找其响应的模型的名称。 这是用于选择响应的查询参数。 否
推理努力 对象 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
温度 数字 采样温度。 这是用于选择响应的查询参数。 否
tools 数组 工具名称列表。 这是用于选择响应的查询参数。 否
top_p 数字 核采样参数。 这是用于选择响应的查询参数。 否
类型 枚举 运行数据源的类型。 始终为 responses。
可能的值：responses		 是的
用户 数组 用户标识符列表。 这是用于选择响应的查询参数。 否

OpenAI.EvalRunStoredCompletionsDataContentSource

描述一组筛选器的 StoredCompletionsRunDataSource 配置

名称 类型 DESCRIPTION 必选 违约
created_after 整数 一个可选的 Unix 时间戳，用于筛选在此时间之后创建的项。 否
created_before 整数 一个可选的 Unix 时间戳，用于筛选此时间之前创建的项。 否
限制 整数 （可选）要返回的最大项数。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
模型 字符串 用于筛选的可选模型（例如，“gpt-4o”）。 否
类型 枚举 源的类型。 始终为 stored_completions。
可能的值：stored_completions		 是的

OpenAI.EvalStoredCompletionsDataSourceConfigParams

弃用了 LogsDataSourceConfig。

名称 类型 DESCRIPTION 必选 违约
元数据 对象 存储的完成数据源的元数据筛选器。 否
类型 枚举 数据源的类型。 始终为 stored_completions。
可能的值：stored_completions		 是的

OpenAI.EvalStoredCompletionsDataSourceConfigResource

弃用了 LogsDataSourceConfig。

名称 类型 DESCRIPTION 必选 违约
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
架构 对象 运行数据源项的 json 架构。
了解如何 在此处生成 JSON 架构。		 是的
类型 枚举 数据源的类型。 始终为 stored_completions。
可能的值：stored_completions		 是的

OpenAI.FileSearchTool

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

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

OpenAI.FileSearchToolCallItemParam

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

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

OpenAI.FileSearchToolCallItemResource

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

名称 类型 DESCRIPTION 必选 违约
queries 数组 用于搜索文件的查询。 是的
结果 数组 文件搜索工具调用的结果。 否
状态 枚举 文件搜索工具调用的状态。 其中一个 in_progress，
searching incomplete或， failed
可能的值：in_progress、、searchingcompleted、incomplete、failed		 是的
类型 枚举
可能的值：file_search_call		 是的

OpenAI.Filters

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

OpenAI.FineTuneDPOHyperparameters

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

名称 类型 DESCRIPTION 必选 违约
批处理大小 枚举
可能的值：auto		 否
beta 版本 枚举
可能的值：auto		 否
学习率乘数 (learning_rate_multiplier) 枚举
可能的值：auto		 否
n_epochs 枚举
可能的值：auto		 否

OpenAI.FineTuneDPOMethod

DPO 微调方法的配置。

名称 类型 DESCRIPTION 必选 违约
超参数 OpenAI.FineTuneDPOHyperparameters 用于 DPO 微调作业的超参数。 否

OpenAI.FineTuneMethod

用于微调的方法。

名称 类型 DESCRIPTION 必选 违约
dpo OpenAI.FineTuneDPOMethod DPO 微调方法的配置。 否
加固 AzureFineTuneReinforcementMethod 否
监督 OpenAI.FineTuneSupervisedMethod 监督式微调方法的配置。 否
类型 枚举 方法的类型。 supervised要么是，dpo要么reinforcement。
可能的值：supervised、、 dporeinforcement		 是的

OpenAI.FineTuneReinforcementHyperparameters

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

名称 类型 DESCRIPTION 必选 违约
批处理大小 枚举
可能的值：auto		 否
compute_multiplier 枚举
可能的值：auto		 否
eval_interval 枚举
可能的值：auto		 否
eval_samples 枚举
可能的值：auto		 否
学习率乘数 (learning_rate_multiplier) 枚举
可能的值：auto		 否
n_epochs 枚举
可能的值：auto		 否
推理努力 枚举 推理工作级别。
可能的值：default、low、medium、high		 否

OpenAI.FineTuneSupervisedHyperparameters

用于微调作业的超参数。

名称 类型 DESCRIPTION 必选 违约
批处理大小 枚举
可能的值：auto		 否
学习率乘数 (learning_rate_multiplier) 枚举
可能的值：auto		 否
n_epochs 枚举
可能的值：auto		 否

OpenAI.FineTuneSupervisedMethod

监督式微调方法的配置。

名称 类型 DESCRIPTION 必选 违约
超参数 OpenAI.FineTuneSupervisedHyperparameters 用于微调作业的超参数。 否

OpenAI.FineTuningIntegration

OpenAI.FineTuningIntegration 的鉴别器

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

类型值 图式
wandb OpenAI.FineTuningIntegrationWandb
名称 类型 DESCRIPTION 必选 违约
类型 字符串 （请参阅下面的有效模型） 是的

OpenAI.FineTuningIntegrationWandb

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

OpenAI.FineTuningJob

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

名称 类型 DESCRIPTION 必选 违约
创建时间 整数 创建微调作业时的 Unix 时间戳（以秒为单位）。 是的
错误 对象 对于具有 failed微调作业的作业，这将包含有关失败原因的详细信息。 是的
└─ 代码 字符串 计算机可读错误代码。 否
└─ 消息 字符串 用户可读的错误消息。 否
└─ 参数 字符串 无效的参数通常 training_file 为或 validation_file。 如果失败不特定于参数，则此字段将为 null。 否
预计完成 整数 估计微调作业完成时间的 Unix 时间戳（以秒为单位）。 如果微调作业未运行，该值将为 null。 否
微调模型 字符串 正在创建的微调模型的名称。 如果微调作业仍在运行，该值将为 null。 是的
完成于 整数 完成微调作业的 Unix 时间戳（以秒为单位）。 如果微调作业仍在运行，该值将为 null。 是的
超参数 对象 用于微调作业的超参数。 仅当运行 supervised 作业时，才会返回此值。 是的
batch_size 枚举
可能的值：auto		 否
learning_rate_multiplier 枚举
可能的值：auto		 否
n_epochs 枚举
可能的值：auto		 否
id 字符串 可以在 API 终结点中引用的对象标识符。 是的
整合 数组 要为此微调作业启用的集成列表。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
方法 OpenAI.FineTuneMethod 用于微调的方法。 否
模型 字符串 正在微调的基本模型。 是的
对象 枚举 对象类型，始终为“fine_tuning.job”。
可能的值：fine_tuning.job		 是的
organization_id 字符串 拥有微调作业的组织。 是的
result_files 数组 用于微调作业的已编译结果文件 ID。 可以使用文件 API 检索结果。 是的
seed 整数 用于微调作业的种子。 是的
状态 枚举 微调作业的当前状态，可以是validating_files、queued、running、succeeded或failedcancelled。
可能的值：validating_files、、queued、runningsucceeded、failed、cancelled		 是的
trained_tokens 整数 此微调作业处理的可计费令牌总数。 如果微调作业仍在运行，该值将为 null。 是的
训练文件 字符串 用于训练的文件 ID。 可以使用文件 API 检索训练数据。 是的
user_provided_suffix 字符串 应用于作业的描述性后缀，如作业创建请求中指定的。 否
验证文件 字符串 用于验证的文件 ID。 可以使用文件 API 检索验证结果。 是的

OpenAI.FineTuningJobCheckpoint

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

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

OpenAI.FineTuningJobEvent

微调作业事件对象

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

OpenAI.FunctionObject

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

省 parameters 略定义具有空参数列表的函数。		 否
strict 布尔 生成函数调用时是否启用严格的架构遵循。 如果设置为 true，则模型将遵循 parameters 字段中定义的确切架构。 当 strict 为 true 时仅支持 JSON 架构的子集。 在 函数调用指南中详细了解结构化输出。 否 假

OpenAI.FunctionTool

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

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

OpenAI.FunctionToolCallItemParam

用于运行函数的工具调用。 有关详细信息，请参阅 函数调用指南 。

名称 类型 DESCRIPTION 必选 违约
arguments 字符串 要传递给函数的参数的 JSON 字符串。 是的
call_id 字符串 模型生成的函数工具调用的唯一 ID。 是的
姓名 字符串 要运行的函数的名称。 是的
类型 枚举
可能的值：function_call		 是的

OpenAI.FunctionToolCallItemResource

用于运行函数的工具调用。 有关详细信息，请参阅 函数调用指南 。

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

OpenAI.FunctionToolCallOutputItemParam

函数工具调用的输出。

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

OpenAI.FunctionToolCallOutputItemResource

函数工具调用的输出。

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

OpenAI.Grader

OpenAI.Grader 的鉴别器

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

类型值 图式
label_model OpenAI.GraderLabelModel
text_similarity OpenAI.GraderTextSimilarity
python OpenAI.GraderPython
score_model OpenAI.GraderScoreModel
multi OpenAI.GraderMulti
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.GraderType 是的

OpenAI.GraderLabelModel

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

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

OpenAI.GraderMulti

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

名称 类型 DESCRIPTION 必选 违约
calculate_output 字符串 用于基于评分器结果计算输出的公式。 是的
年级 对象 是的
姓名 字符串 评分程序的名称。 是的
类型 枚举 始终为 multi 的对象类型。
可能的值：multi		 是的

OpenAI.GraderPython

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

名称 类型 DESCRIPTION 必选 违约
image_tag 字符串 用于 python 脚本的图像标记。 否
姓名 字符串 评分程序的名称。 是的
源 字符串 python 脚本的源代码。 是的
类型 枚举 始终为 python 的对象类型。
可能的值：python		 是的

OpenAI.GraderScoreModel

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

名称 类型 DESCRIPTION 必选 违约
输入 数组 输入文本。 这可能包括模板字符串。 是的
模型 字符串 要用于评估的模型。 是的
姓名 字符串 评分程序的名称。 是的
范围 数组 分数的范围。 默认为 [0, 1]。 否
采样参数 模型的采样参数。 否
类型 枚举 始终为 score_model 的对象类型。
可能的值：score_model		 是的

OpenAI.GraderStringCheck

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

名称 类型 DESCRIPTION 必选 违约
输入 字符串 输入文本。 这可能包括模板字符串。 是的
姓名 字符串 评分程序的名称。 是的
操作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 是的
引用 字符串 引用文本。 这可能包括模板字符串。 是的
类型 枚举 始终为 string_check 的对象类型。
可能的值：string_check		 是的

OpenAI.GraderTextSimilarity

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

名称 类型 DESCRIPTION 必选 违约
评估指标 枚举 要使用的评估指标。 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		 是的
输入 字符串 正在评分的文本。 是的
姓名 字符串 评分程序的名称。 是的
引用 字符串 作为评分参照的文本。 是的
类型 枚举 评分程序的类型。
可能的值：text_similarity		 是的

OpenAI.GraderType

资产 价值
类型 字符串
价值观 string_check
text_similarity
score_model
label_model
python
multi

OpenAI.ImageGenTool

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

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

OpenAI.ImageGenToolCallItemParam

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

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

OpenAI.ImageGenToolCallItemResource

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

名称 类型 DESCRIPTION 必选 违约
结果 字符串 在 base64 中编码的生成的图像。 是的
状态 枚举
可能的值：in_progress、completed、generating、failed		 是的
类型 枚举
可能的值：image_generation_call		 是的

OpenAI.ImplicitUserMessage

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

OpenAI.Includable

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

  • 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）时，多轮次对话中可以使用推理项。
资产 价值
说明 指定要包含在模型响应中的其他输出数据。 现在
支持的值包括：
- 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或组织时
在零数据保留计划中注册）。
类型 字符串
价值观 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 区分不同类型的：

类型值 图式
input_audio OpenAI.ItemContentInputAudio
output_audio OpenAI.ItemContentOutputAudio
refusal OpenAI.ItemContentRefusal
input_text OpenAI.ItemContentInputText
input_image OpenAI.ItemContentInputImage
input_file OpenAI.ItemContentInputFile
output_text OpenAI.ItemContentOutputText
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ItemContentType 多模式输入和输出内容。 是的

OpenAI.ItemContentInputAudio

模型的音频输入。

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

OpenAI.ItemContentInputFile

模型的文件输入。

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

OpenAI.ItemContentInputImage

模型的图像输入。

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

OpenAI.ItemContentInputText

模型的文本输入。

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

OpenAI.ItemContentOutputAudio

模型的音频输出。

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

OpenAI.ItemContentOutputText

模型的文本输出。

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

OpenAI.ItemContentRefusal

模型拒绝。

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

OpenAI.ItemContentType

多模式输入和输出内容。

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

OpenAI.ItemParam

用于生成响应的内容项。

OpenAI.ItemParam 的鉴别器

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

类型值 图式
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
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ItemType 是的

OpenAI.ItemReferenceItemParam

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

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

OpenAI.ItemResource

用于生成响应的内容项。

OpenAI.ItemResource 的鉴别器

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

类型值 图式
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
名称 类型 DESCRIPTION 必选 违约
id 字符串 是的
类型 OpenAI.ItemType 是的

OpenAI.ItemType

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

OpenAI.ListFineTuningJobCheckpointsResponse

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

OpenAI.ListFineTuningJobEventsResponse

名称 类型 DESCRIPTION 必选 违约
数据 数组 是的
has_more 布尔 是的
对象 枚举
可能的值：list		 是的

OpenAI.ListModelsResponse

名称 类型 DESCRIPTION 必选 违约
数据 数组 是的
对象 枚举
可能的值：list		 是的

OpenAI.ListPaginatedFineTuningJobsResponse

名称 类型 DESCRIPTION 必选 违约
数据 数组 是的
has_more 布尔 是的
对象 枚举
可能的值：list		 是的

OpenAI.ListVectorStoreFilesFilter

资产 价值
类型 字符串
价值观 in_progress
completed
failed
cancelled

OpenAI.ListVectorStoreFilesResponse

名称 类型 DESCRIPTION 必选 违约
数据 数组 是的
first_id 字符串 是的
has_more 布尔 是的
last_id 字符串 是的
对象 枚举
可能的值：list		 是的

OpenAI.ListVectorStoresResponse

名称 类型 DESCRIPTION 必选 违约
数据 数组 是的
first_id 字符串 是的
has_more 布尔 是的
last_id 字符串 是的
对象 枚举
可能的值：list		 是的

OpenAI.LocalShellExecAction

在服务器上执行 shell 命令。

名称 类型 DESCRIPTION 必选 违约
指令 数组 要运行的命令。 是的
env 对象 要为命令设置的环境变量。 是的
timeout_ms 整数 命令的可选超时（以毫秒为单位）。 否
类型 枚举 本地 shell作的类型。 始终为 exec。
可能的值：exec		 是的
用户 字符串 运行命令的可选用户。 否
working_directory 字符串 要在其中运行命令的可选工作目录。 否

OpenAI.LocalShellTool

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

名称 类型 DESCRIPTION 必选 违约
类型 枚举 本地 shell 工具的类型。 始终为 local_shell。
可能的值：local_shell		 是的

OpenAI.LocalShellToolCallItemParam

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

名称 类型 DESCRIPTION 必选 违约
操作 OpenAI.LocalShellExecAction 在服务器上执行 shell 命令。 是的
call_id 字符串 模型生成的本地 shell 工具调用的唯一 ID。 是的
类型 枚举
可能的值：local_shell_call		 是的

OpenAI.LocalShellToolCallItemResource

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

名称 类型 DESCRIPTION 必选 违约
操作 OpenAI.LocalShellExecAction 在服务器上执行 shell 命令。 是的
call_id 字符串 模型生成的本地 shell 工具调用的唯一 ID。 是的
状态 枚举
可能的值：in_progress、、 completedincomplete		 是的
类型 枚举
可能的值：local_shell_call		 是的

OpenAI.LocalShellToolCallOutputItemParam

本地 shell 工具调用的输出。

名称 类型 DESCRIPTION 必选 违约
输出 字符串 本地 shell 工具调用输出的 JSON 字符串。 是的
类型 枚举
可能的值：local_shell_call_output		 是的

OpenAI.LocalShellToolCallOutputItemResource

本地 shell 工具调用的输出。

名称 类型 DESCRIPTION 必选 违约
输出 字符串 本地 shell 工具调用输出的 JSON 字符串。 是的
状态 枚举
可能的值：in_progress、、 completedincomplete		 是的
类型 枚举
可能的值：local_shell_call_output		 是的

OpenAI.Location

OpenAI.Location 的鉴别器

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

类型值 图式
approximate OpenAI.ApproximateLocation
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.LocationType 是的

OpenAI.LocationType

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

OpenAI.LogProb

标记的对数概率。

名称 类型 DESCRIPTION 必选 违约
字节 数组 是的
logprob 数字 是的
代币 字符串 是的
top_logprobs 数组 是的

OpenAI.MCPApprovalRequestItemParam

请求人工批准工具调用。

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

OpenAI.MCPApprovalRequestItemResource

请求人工批准工具调用。

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

OpenAI.MCPApprovalResponseItemParam

对 MCP 审批请求的响应。

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

OpenAI.MCPApprovalResponseItemResource

对 MCP 审批请求的响应。

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

OpenAI.MCPCallItemParam

在 MCP 服务器上调用工具。

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

OpenAI.MCPCallItemResource

在 MCP 服务器上调用工具。

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

OpenAI.MCPListToolsItemParam

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

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

OpenAI.MCPListToolsItemResource

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

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

OpenAI.MCPListToolsTool

MCP 服务器上可用的工具。

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

OpenAI.MCPTool

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

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

OpenAI.MetadataPropertyForRequest

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

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

名称 类型 DESCRIPTION 必选 违约
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

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

OpenAI.Model

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

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

OpenAI.OtherChunkingStrategyResponseParam

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

名称 类型 DESCRIPTION 必选 违约
类型 枚举 始终为 other。
可能的值：other		 是的

OpenAI.ParallelToolCalls

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

类型：布尔值

OpenAI.Prompt

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

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

OpenAI.RankingOptions

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

OpenAI.Reasoning

仅推理模型

推理模型的配置选项。

名称 类型 DESCRIPTION 必选 违约
工作量 对象 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
generate_summary 枚举 已弃用： 改用 summary 。

模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
摘要 枚举 模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否

OpenAI.ReasoningEffort

仅推理模型

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

资产 价值
说明 仅推理模型

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

OpenAI.ReasoningItemParam

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

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

OpenAI.ReasoningItemResource

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

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

OpenAI.ReasoningItemSummaryPart

OpenAI.ReasoningItemSummaryPart 的鉴别器

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

类型值 图式
summary_text OpenAI.ReasoningItemSummaryTextPart
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ReasoningItemSummaryPartType 是的

OpenAI.ReasoningItemSummaryPartType

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

OpenAI.ReasoningItemSummaryTextPart

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

OpenAI.Response

名称 类型 DESCRIPTION 必选 违约
后台的 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
创建时间 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 是的
错误 对象 当模型无法生成响应时返回的错误对象。 是的
└─ 代码 OpenAI.ResponseErrorCode 响应的错误代码。 否
└─ 消息 字符串 错误的人工可读说明。 否
id 字符串 此响应的唯一标识符。 是的
incomplete_details 对象 有关响应不完整的原因的详细信息。 是的
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
指示 字符串或数组 是的
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 是的
输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 是的
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
并行工具调用 布尔 是否允许模型并行运行工具调用。 是的 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
提示 对象 对提示模板及其变量的引用。
 否
{~ id 字符串 要使用的提示模板的唯一标识符。 否
~~ 变量 OpenAI.ResponsePromptVariables 用于替换变量的值的可选映射
提示。 替换值可以是字符串或其他
响应输入类型，如图像或文件。		 否
~~ 版本 字符串 提示模板的可选版本。 否
推理 对象 仅推理模型

的配置选项
推理模型。		 否
~~ 工作 OpenAI.ReasoningEffort 仅推理模型

限制推理工作
推理模型。
当前支持的值为 low、medium 和 high。 减少
推理努力可能会导致更快的响应和更少的标记使用
于响应中的推理。		 否
generate_summary 枚举 已弃用： 改用 summary 。

模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
~~ 摘要 枚举 模型执行的推理摘要。 这可以是
可用于调试和了解模型的推理过程。
auto、concise 或 detailed 之一。
可能的值：auto、、 concisedetailed		 否
状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 是的
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice 对象 控制模型调用哪个（如果有）工具。

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

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

required 表示模型必须调用一个或多个工具。		 否
└─ 类型 OpenAI.ToolChoiceObjectType 指示模型应使用内置工具生成响应。 否
tools 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 是的
截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
使用情况 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 是的

OpenAI.ResponseCodeInterpreterCallCodeDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
三角洲 字符串 由代码解释器流式传输的部分代码片段。 是的
item_id 字符串 代码解释器工具调用项的唯一标识符。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 要为其流式传输代码的响应中的输出项的索引。 是的
类型 枚举 事件的类型。 始终为 response.code_interpreter_call_code.delta。
可能的值：response.code_interpreter_call_code.delta		 是的

OpenAI.ResponseCodeInterpreterCallCodeDoneEvent

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

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

OpenAI.ResponseCodeInterpreterCallCompletedEvent

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

名称 类型 DESCRIPTION 必选 违约
item_id 字符串 代码解释器工具调用项的唯一标识符。 是的
output_index 整数 完成代码解释器调用的响应中的输出项的索引。 是的
类型 枚举 事件的类型。 始终为 response.code_interpreter_call.completed。
可能的值：response.code_interpreter_call.completed		 是的

OpenAI.ResponseCodeInterpreterCallInProgressEvent

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

名称 类型 DESCRIPTION 必选 违约
item_id 字符串 代码解释器工具调用项的唯一标识符。 是的
output_index 整数 正在进行代码解释器调用的响应中输出项的索引。 是的
类型 枚举 事件的类型。 始终为 response.code_interpreter_call.in_progress。
可能的值：response.code_interpreter_call.in_progress		 是的

OpenAI.ResponseCodeInterpreterCallInterpretingEvent

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

名称 类型 DESCRIPTION 必选 违约
item_id 字符串 代码解释器工具调用项的唯一标识符。 是的
output_index 整数 代码解释器正在解释代码的响应中输出项的索引。 是的
类型 枚举 事件的类型。 始终为 response.code_interpreter_call.interpreting。
可能的值：response.code_interpreter_call.interpreting		 是的

OpenAI.ResponseCompletedEvent

模型响应完成时发出。

名称 类型 DESCRIPTION 必选 违约
response 对象 是的
~~ 背景 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
created_at 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 否
~~ 错误 OpenAI.ResponseError 当模型无法生成响应时返回的错误对象。 否
{~ id 字符串 此响应的唯一标识符。 否
incomplete_details 对象 有关响应不完整的原因的详细信息。 否
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
~~ 说明 字符串或数组 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
└─ 元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
~~ 对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 否
└─ 输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 否
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
parallel_tool_calls 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
~~ 提示 OpenAI.Prompt 对提示模板及其变量的引用。
 否
~~ 推理 OpenAI.Reasoning 仅推理模型

的配置选项
推理模型。		 否
~~ 状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
~~ 温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否
~~ 文本 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject 模型在生成时应如何选择要使用的工具（或工具）
响应。 tools请参阅参数，了解如何指定哪些工具
模型可以调用。		 否
└─ 工具 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否
~~ 截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
└─ 用法 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
~~ 用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否
类型 枚举 事件的类型。 始终为 response.completed。
可能的值：response.completed		 是的

OpenAI.ResponseContentPartAddedEvent

添加新内容部件时发出。

名称 类型 DESCRIPTION 必选 违约
content_index 整数 已添加的内容部件的索引。 是的
item_id 字符串 内容部件添加到的输出项的 ID。 是的
output_index 整数 内容部件添加到的输出项的索引。 是的
部件 对象 是的
└─ 类型 OpenAI.ItemContentType 多模式输入和输出内容。 否
类型 枚举 事件的类型。 始终为 response.content_part.added。
可能的值：response.content_part.added		 是的

OpenAI.ResponseContentPartDoneEvent

完成内容部件时发出。

名称 类型 DESCRIPTION 必选 违约
content_index 整数 完成的内容部件的索引。 是的
item_id 字符串 内容部件添加到的输出项的 ID。 是的
output_index 整数 内容部件添加到的输出项的索引。 是的
部件 对象 是的
└─ 类型 OpenAI.ItemContentType 多模式输入和输出内容。 否
类型 枚举 事件的类型。 始终为 response.content_part.done。
可能的值：response.content_part.done		 是的

OpenAI.ResponseCreatedEvent

创建响应时发出的事件。

名称 类型 DESCRIPTION 必选 违约
response 对象 是的
~~ 背景 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
created_at 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 否
~~ 错误 OpenAI.ResponseError 当模型无法生成响应时返回的错误对象。 否
{~ id 字符串 此响应的唯一标识符。 否
incomplete_details 对象 有关响应不完整的原因的详细信息。 否
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
~~ 说明 字符串或数组 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
└─ 元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
~~ 对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 否
└─ 输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 否
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
parallel_tool_calls 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
~~ 提示 OpenAI.Prompt 对提示模板及其变量的引用。
 否
~~ 推理 OpenAI.Reasoning 仅推理模型

的配置选项
推理模型。		 否
~~ 状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
~~ 温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否
~~ 文本 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject 模型在生成时应如何选择要使用的工具（或工具）
响应。 tools请参阅参数，了解如何指定哪些工具
模型可以调用。		 否
└─ 工具 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否
~~ 截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
└─ 用法 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
~~ 用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否
类型 枚举 事件的类型。 始终为 response.created。
可能的值：response.created		 是的

OpenAI.ResponseError

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

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

OpenAI.ResponseErrorCode

响应的错误代码。

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

OpenAI.ResponseErrorEvent

发生错误时发出。

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

OpenAI.ResponseFailedEvent

响应失败时发出的事件。

名称 类型 DESCRIPTION 必选 违约
response 对象 是的
~~ 背景 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
created_at 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 否
~~ 错误 OpenAI.ResponseError 当模型无法生成响应时返回的错误对象。 否
{~ id 字符串 此响应的唯一标识符。 否
incomplete_details 对象 有关响应不完整的原因的详细信息。 否
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
~~ 说明 字符串或数组 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
└─ 元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
~~ 对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 否
└─ 输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 否
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
parallel_tool_calls 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
~~ 提示 OpenAI.Prompt 对提示模板及其变量的引用。
 否
~~ 推理 OpenAI.Reasoning 仅推理模型

的配置选项
推理模型。		 否
~~ 状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
~~ 温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否
~~ 文本 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject 模型在生成时应如何选择要使用的工具（或工具）
响应。 tools请参阅参数，了解如何指定哪些工具
模型可以调用。		 否
└─ 工具 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否
~~ 截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
└─ 用法 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
~~ 用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否
类型 枚举 事件的类型。 始终为 response.failed。
可能的值：response.failed		 是的

OpenAI.ResponseFileSearchCallCompletedEvent

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

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

OpenAI.ResponseFileSearchCallInProgressEvent

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

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

OpenAI.ResponseFileSearchCallSearchingEvent

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

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

OpenAI.ResponseFormat

OpenAI.ResponseFormat 的鉴别器

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

类型值 图式
text OpenAI.ResponseFormatText
json_object OpenAI.ResponseFormatJsonObject
json_schema OpenAI.ResponseFormatJsonSchema
名称 类型 DESCRIPTION 必选 违约
类型 枚举
可能的值：text、、 json_objectjson_schema		 是的

OpenAI.ResponseFormatJsonObject

JSON 对象响应格式。 生成 JSON 响应的较旧方法。 建议对支持它的模型使用 json_schema 。 请注意，模型在系统或用户消息指示其执行此作的情况下不会生成 JSON。

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

OpenAI.ResponseFormatJsonSchema

JSON 架构响应格式。 用于生成结构化 JSON 响应。 详细了解 结构化输出。

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

OpenAI.ResponseFormatJsonSchemaSchema

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

类型：对象

OpenAI.ResponseFormatText

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

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

OpenAI.ResponseFunctionCallArgumentsDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
三角洲 字符串 添加的函数调用参数增量。 是的
item_id 字符串 函数调用参数增量添加到的输出项的 ID。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 函数调用参数增量添加到的输出项的索引。 是的
类型 枚举 事件的类型。 始终为 response.function_call_arguments.delta。
可能的值：response.function_call_arguments.delta		 是的

OpenAI.ResponseFunctionCallArgumentsDoneEvent

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

名称 类型 DESCRIPTION 必选 违约
arguments 字符串 函数调用参数。 是的
item_id 字符串 项的 ID。 是的
output_index 整数 输出项的索引。 是的
类型 枚举
可能的值：response.function_call_arguments.done		 是的

OpenAI.ResponseImageGenCallCompletedEvent

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

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

OpenAI.ResponseImageGenCallGeneratingEvent

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

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

OpenAI.ResponseImageGenCallInProgressEvent

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

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

OpenAI.ResponseImageGenCallPartialImageEvent

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

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

OpenAI.ResponseInProgressEvent

响应正在进行时发出。

名称 类型 DESCRIPTION 必选 违约
response 对象 是的
~~ 背景 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
created_at 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 否
~~ 错误 OpenAI.ResponseError 当模型无法生成响应时返回的错误对象。 否
{~ id 字符串 此响应的唯一标识符。 否
incomplete_details 对象 有关响应不完整的原因的详细信息。 否
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
~~ 说明 字符串或数组 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
└─ 元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
~~ 对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 否
└─ 输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 否
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
parallel_tool_calls 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
~~ 提示 OpenAI.Prompt 对提示模板及其变量的引用。
 否
~~ 推理 OpenAI.Reasoning 仅推理模型

的配置选项
推理模型。		 否
~~ 状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
~~ 温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否
~~ 文本 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject 模型在生成时应如何选择要使用的工具（或工具）
响应。 tools请参阅参数，了解如何指定哪些工具
模型可以调用。		 否
└─ 工具 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否
~~ 截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
└─ 用法 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
~~ 用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否
类型 枚举 事件的类型。 始终为 response.in_progress。
可能的值：response.in_progress		 是的

OpenAI.ResponseIncompleteEvent

响应完成时发出的事件不完整。

名称 类型 DESCRIPTION 必选 违约
response 对象 是的
~~ 背景 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
created_at 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 否
~~ 错误 OpenAI.ResponseError 当模型无法生成响应时返回的错误对象。 否
{~ id 字符串 此响应的唯一标识符。 否
incomplete_details 对象 有关响应不完整的原因的详细信息。 否
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
~~ 说明 字符串或数组 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
└─ 元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
~~ 对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 否
└─ 输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 否
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
parallel_tool_calls 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
~~ 提示 OpenAI.Prompt 对提示模板及其变量的引用。
 否
~~ 推理 OpenAI.Reasoning 仅推理模型

的配置选项
推理模型。		 否
~~ 状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
~~ 温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否
~~ 文本 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject 模型在生成时应如何选择要使用的工具（或工具）
响应。 tools请参阅参数，了解如何指定哪些工具
模型可以调用。		 否
└─ 工具 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否
~~ 截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
└─ 用法 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
~~ 用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否
类型 枚举 事件的类型。 始终为 response.incomplete。
可能的值：response.incomplete		 是的

OpenAI.ResponseItemList

响应项的列表。

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

OpenAI.ResponseMCPCallArgumentsDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
三角洲 MCP 工具调用参数的部分更新。 是的
item_id 字符串 正在处理的 MCP 工具调用项的唯一标识符。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 响应的输出数组中输出项的索引。 是的
类型 枚举 事件的类型。 始终为“response.mcp_call.arguments_delta”。
可能的值：response.mcp_call.arguments_delta		 是的

OpenAI.ResponseMCPCallArgumentsDoneEvent

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

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

OpenAI.ResponseMCPCallCompletedEvent

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

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

OpenAI.ResponseMCPCallFailedEvent

MCP 工具调用失败时发出。

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

OpenAI.ResponseMCPCallInProgressEvent

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

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

OpenAI.ResponseMCPListToolsCompletedEvent

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

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

OpenAI.ResponseMCPListToolsFailedEvent

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

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

OpenAI.ResponseMCPListToolsInProgressEvent

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

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

OpenAI.ResponseOutputItemAddedEvent

添加新的输出项时发出。

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

OpenAI.ResponseOutputItemDoneEvent

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

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

OpenAI.ResponsePromptVariables

在提示符中替换变量的值的可选映射。 替换值可以是字符串，也可以是图像或文件等其他响应输入类型。

类型：对象

OpenAI.ResponseQueuedEvent

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

名称 类型 DESCRIPTION 必选 违约
response 对象 是的
~~ 背景 布尔 是否在后台运行模型响应。
了解详细信息。		 否 假
created_at 整数 创建此响应时的 Unix 时间戳（以秒为单位）。 否
~~ 错误 OpenAI.ResponseError 当模型无法生成响应时返回的错误对象。 否
{~ id 字符串 此响应的唯一标识符。 否
incomplete_details 对象 有关响应不完整的原因的详细信息。 否
~~ 原因 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 否
~~ 说明 字符串或数组 插入模型上下文中的系统（或开发人员）消息。

一起使用 previous_response_id时，前面的说明
响应不会传递到下一个响应。 这使得它变得简单
在新的响应中交换系统（或开发人员）消息。		 否
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。 否
max_tool_calls 整数 对可在响应中处理的内置工具的最大调用总数。 此最大数目适用于所有内置工具调用，而不适用于每个工具。 将忽略模型调用工具的任何进一步尝试。 否
└─ 元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
~~ 对象 枚举 此资源的对象类型 - 始终设置为 response。
可能的值：response		 否
└─ 输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于
在模型的响应中。
- 而不是访问数组中的 output 第一项和
假设它是包含由 /a0> 生成的内容的消息
模型，可以考虑使用 output_text 属性的位置
SDK 支持。		 否
output_text 字符串 仅 SDK 的便利属性，其中包含聚合的文本输出
来自数组中的所有output_textoutput项（如果有）。
Python 和 JavaScript SDK 中受支持。		 否
parallel_tool_calls 布尔 是否允许模型并行运行工具调用。 否 真 实
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此服务
创建多轮次对话。		 否
~~ 提示 OpenAI.Prompt 对提示模板及其变量的引用。
 否
~~ 推理 OpenAI.Reasoning 仅推理模型

的配置选项
推理模型。		 否
~~ 状态 枚举 响应生成的状态。 其中一个completed， failed
in_progress、cancelled、queued 或 incomplete。
可能的值：completed、、failed、in_progresscancelled、queued、incomplete		 否
~~ 温度 数字 要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 否
~~ 文本 对象 来自模型的文本响应的配置选项。 可以是纯的
文本或结构化 JSON 数据。 了解详细信息： 结构化输出		 否
~~ 格式 OpenAI.ResponseTextFormatConfiguration 否
tool_choice OpenAI.ToolChoiceOptions 或 OpenAI.ToolChoiceObject 模型在生成时应如何选择要使用的工具（或工具）
响应。 tools请参阅参数，了解如何指定哪些工具
模型可以调用。		 否
└─ 工具 数组 生成响应时，模型可能会调用的工具数组。 你
可以通过设置 tool_choice 参数来指定要使用的工具。

可以提供模型的两类工具包括：

- 内置工具：OpenAI 提供的工具，用于扩展
模型的功能，如 Web 搜索或文件搜索。		 否
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 否
top_p 数字 使用温度进行采样的替代方法，称为核采样，
其中，模型考虑具有top_p概率的令牌的结果
质量。 因此，0.1 仅表示包含前 10 个% 概率质量的标记
被视为。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 否
~~ 截断 枚举 要用于模型响应的截断策略。
- auto：如果此响应和以前的上下文超过
模型的上下文窗口大小，模型将截断
通过删除输入项在 中调整上下文窗口的响应
对话的中间。
- disabled （默认值）：如果模型响应将超过上下文窗口
模型的大小，请求将失败并出现 400 错误。
可能的值： autodisabled		 否
└─ 用法 OpenAI.ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、
输出令牌的细分以及所使用的令牌总数。		 否
~~ 用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 否
类型 枚举 事件的类型。 始终为“response.queued”。
可能的值：response.queued		 是的

OpenAI.ResponseReasoningDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
content_index 整数 输出项中推理内容部件的索引。 是的
三角洲 对推理内容的部分更新。 是的
item_id 字符串 正在更新推理的项的唯一标识符。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 响应的输出数组中输出项的索引。 是的
类型 枚举 事件的类型。 始终为“response.reasoning.delta”。
可能的值：response.reasoning.delta		 是的

OpenAI.ResponseReasoningDoneEvent

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

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

OpenAI.ResponseReasoningSummaryDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
三角洲 对推理摘要内容的部分更新。 是的
item_id 字符串 正在更新推理摘要的项的唯一标识符。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 响应的输出数组中输出项的索引。 是的
summary_index 整数 输出项中摘要部件的索引。 是的
类型 枚举 事件的类型。 始终为“response.reasoning_summary.delta”。
可能的值：response.reasoning_summary.delta		 是的

OpenAI.ResponseReasoningSummaryDoneEvent

在项目完成推理摘要内容时发出。

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

OpenAI.ResponseReasoningSummaryPartAddedEvent

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

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

OpenAI.ResponseReasoningSummaryPartDoneEvent

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

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

OpenAI.ResponseReasoningSummaryTextDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
三角洲 字符串 添加到摘要的文本增量。 是的
item_id 字符串 与此摘要文本增量关联的项的 ID。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 与此摘要文本增量关联的输出项的索引。 是的
summary_index 整数 推理摘要中摘要部分的索引。 是的
类型 枚举 事件的类型。 始终为 response.reasoning_summary_text.delta。
可能的值：response.reasoning_summary_text.delta		 是的

OpenAI.ResponseReasoningSummaryTextDoneEvent

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

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

OpenAI.ResponseRefusalDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
content_index 整数 拒绝文本添加到的内容部件的索引。 是的
三角洲 字符串 添加的拒绝文本。 是的
item_id 字符串 拒绝文本添加到的输出项的 ID。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 拒绝文本添加到的输出项的索引。 是的
类型 枚举 事件的类型。 始终为 response.refusal.delta。
可能的值：response.refusal.delta		 是的

OpenAI.ResponseRefusalDoneEvent

在拒绝文本完成时发出。

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

OpenAI.ResponseStreamEvent

OpenAI.ResponseStreamEvent 的鉴别器

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

类型值 图式
response.completed OpenAI.ResponseCompletedEvent
response.content_part.added OpenAI.ResponseContentPartAddedEvent
response.content_part.done OpenAI.ResponseContentPartDoneEvent
response.created OpenAI.ResponseCreatedEvent
error OpenAI.ResponseErrorEvent
response.file_search_call.completed OpenAI.ResponseFileSearchCallCompletedEvent
response.file_search_call.in_progress OpenAI.ResponseFileSearchCallInProgressEvent
response.file_search_call.searching OpenAI.ResponseFileSearchCallSearchingEvent
response.function_call_arguments.delta OpenAI.ResponseFunctionCallArgumentsDeltaEvent
response.function_call_arguments.done OpenAI.ResponseFunctionCallArgumentsDoneEvent
response.in_progress OpenAI.ResponseInProgressEvent
response.failed OpenAI.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
名称 类型 DESCRIPTION 必选 违约
sequence_number 整数 此事件的序列号。 是的
类型 OpenAI.ResponseStreamEventType 是的

OpenAI.ResponseStreamEventType

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

OpenAI.ResponseTextDeltaEvent

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

名称 类型 DESCRIPTION 必选 违约
content_index 整数 文本增量添加到的内容部件的索引。 是的
三角洲 字符串 添加的文本增量。 是的
item_id 字符串 文本增量添加到的输出项的 ID。 是的
混淆 字符串 流模糊处理引入的随机字符字段。 流模糊处理是一种缓解某些侧通道攻击的机制。 是的
output_index 整数 文本增量添加到的输出项的索引。 是的
类型 枚举 事件的类型。 始终为 response.output_text.delta。
可能的值：response.output_text.delta		 是的

OpenAI.ResponseTextDoneEvent

在完成文本内容时发出。

名称 类型 DESCRIPTION 必选 违约
content_index 整数 文本内容最终完成的内容部件的索引。 是的
item_id 字符串 文本内容的输出项的 ID。 是的
output_index 整数 文本内容的输出项的索引。 是的
文本消息 字符串 最终完成的文本内容。 是的
类型 枚举 事件的类型。 始终为 response.output_text.done。
可能的值：response.output_text.done		 是的

OpenAI.响应文本格式配置

OpenAI.ResponseTextFormatConfiguration 的鉴别器

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

类型值 图式
text OpenAI响应文本格式配置文本
json_object OpenAI.ResponseTextFormatConfigurationJsonObject
json_schema OpenAI.ResponseTextFormatConfigurationJsonSchema
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ResponseTextFormatConfigurationType 一个对象，指定模型必须输出的格式。

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

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

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

设置 { "type": "json_object" } 可启用旧版 JSON 模式，
确保模型生成的消息是有效的 JSON。 使用 json_schema
对于支持该功能的模型而言，这是优先选择。		 是的

OpenAI.ResponseTextFormatConfigurationJsonObject

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

OpenAI响应文本格式配置JSON架构

JSON 架构响应格式。 用于生成结构化 JSON 响应。 详细了解 结构化输出。

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

OpenAI.ResponseTextFormatConfigurationText

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

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

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

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。 在 结构化输出指南中了解详细信息。

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

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

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

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

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。 在 结构化输出指南中了解详细信息。

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

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

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

OpenAI.ResponseUsage

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

名称 类型 DESCRIPTION 必选 违约
input_tokens 整数 输入令牌数。 是的
input_tokens_details 对象 输入令牌的详细细分。 是的
cached_tokens 整数 从缓存中检索的令牌数。
有关提示缓存的详细信息。		 否
output_tokens 整数 输出令牌数。 是的
output_tokens_details 对象 输出令牌的详细细分。 是的
reasoning_tokens 整数 推理令牌的数量。 否
total_tokens 整数 使用的令牌总数。 是的

OpenAI.ResponseWebSearchCallCompletedEvent

注释

web_search 尚无法通过 Azure OpenAI 使用。

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

OpenAI.ResponseWebSearchCallInProgressEvent

注释

web_search 尚无法通过 Azure OpenAI 使用。

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

OpenAI.ResponseWebSearchCallSearchingEvent

注释

web_search 尚无法通过 Azure OpenAI 使用。

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

OpenAI.ResponsesAssistantMessageItemParam

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

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

OpenAI.ResponsesAssistantMessageItemResource

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

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

OpenAI.ResponsesDeveloperMessageItemParam

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

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

OpenAI.ResponsesDeveloperMessageItemResource

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

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

OpenAI.ResponsesMessageItemParam

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

OpenAI.ResponsesMessageItemParam 的鉴别器

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

类型值 图式
user OpenAI.ResponsesUserMessageItemParam
system OpenAI.ResponsesSystemMessageItemParam
developer OpenAI.ResponsesDeveloperMessageItemParam
assistant OpenAI.ResponsesAssistantMessageItemParam
名称 类型 DESCRIPTION 必选 违约
角色 对象 响应消息项的有效角色的集合。 是的
类型 枚举 响应项的类型，始终为“message”。
可能的值：message		 是的

OpenAI.ResponsesMessageItemResource

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

OpenAI.ResponsesMessageItemResource 的鉴别器

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

类型值 图式
user OpenAI.ResponsesUserMessageItemResource
system OpenAI.ResponsesSystemMessageItemResource
developer OpenAI.ResponsesDeveloperMessageItemResource
assistant OpenAI.ResponsesAssistantMessageItemResource
名称 类型 DESCRIPTION 必选 违约
角色 对象 响应消息项的有效角色的集合。 是的
状态 枚举 项的状态。 以下之一：in_progress、completed 或
incomplete。 通过 API 返回项时填充。
可能的值：in_progress、、 completedincomplete		 是的
类型 枚举 响应项的类型，始终为“message”。
可能的值：message		 是的

OpenAI.ResponsesMessageRole

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

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

OpenAI.ResponsesSystemMessageItemParam

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

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

OpenAI.ResponsesSystemMessageItemResource

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

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

OpenAI.ResponsesUserMessageItemParam

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

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

OpenAI.ResponsesUserMessageItemResource

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

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

OpenAI.RunGraderRequest

名称 类型 DESCRIPTION 必选 违约
年级 对象 一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。 是的
calculate_output 字符串 用于基于评分器结果计算输出的公式。 否
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		 否
~~ 评分员 对象 否
image_tag 字符串 用于 python 脚本的图像标记。 否
└─ 输入 数组 输入文本。 这可能包括模板字符串。 否
└─ 模型 字符串 要用于评估的模型。 否
└─ 名称 字符串 评分程序的名称。 否
~~作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 否
~~ 范围 数组 分数的范围。 默认为 [0, 1]。 否
~~ 参考 字符串 作为评分参照的文本。 否
采样参数 (sampling_params) 模型的采样参数。 否
└─ 来源 字符串 python 脚本的源代码。 否
└─ 类型 枚举 始终为 multi 的对象类型。
可能的值：multi		 否
项 提供给评分器的数据集项。 这将用于填充
命名空间 item 。 有关更多详细信息 ，请参阅指南 。		 否
model_sample 字符串 要评估的模型示例。 此值将用于填充
命名空间 sample 。 有关更多详细信息 ，请参阅指南 。
output_json如果模型示例是一个变量，则会填充变量
有效的 JSON 字符串。		 是的

OpenAI.RunGraderResponse

名称 类型 DESCRIPTION 必选 违约
元数据 对象 是的
~~ 错误 对象 否
formula_parse_error 布尔 否
invalid_variable_error 布尔 否
model_grader_parse_error 布尔 否
model_grader_refusal_error 布尔 否
model_grader_server_error 布尔 否
model_grader_server_error_details 字符串 否
other_error 布尔 否
python_grader_runtime_error 布尔 否
python_grader_runtime_error_details 字符串 否
python_grader_server_error 布尔 否
python_grader_server_error_type 字符串 否
sample_parse_error 布尔 否
truncated_observation_error 布尔 否
unresponsive_reward_error 布尔 否
execution_time 数字 否
└─ 名称 字符串 否
sampled_model_name 字符串 否
~~ 分数 否
token_usage 整数 否
└─ 类型 字符串 否
model_grader_token_usage_per_model 是的
奖励 数字 是的
sub_rewards 是的

OpenAI.StaticChunkingStrategy

名称 类型 DESCRIPTION 必选 违约
chunk_overlap_tokens 整数 区块之间重叠的令牌数。 默认值为 400。

请注意，重叠不得超过一 max_chunk_size_tokens半。		 是的
max_chunk_size_tokens 整数 每个区块中的最大令牌数。 默认值为 800。 最小值为 100 ，最大值为 4096。 是的

OpenAI.StaticChunkingStrategyRequestParam

通过设置区块大小和区块重叠来自定义自己的分块策略。

名称 类型 DESCRIPTION 必选 违约
静态的 OpenAI.StaticChunkingStrategy 是的
类型 枚举 始终为 static。
可能的值：static		 是的

OpenAI.StaticChunkingStrategyResponseParam

名称 类型 DESCRIPTION 必选 违约
静态的 OpenAI.StaticChunkingStrategy 是的
类型 枚举 始终为 static。
可能的值：static		 是的

OpenAI.StopConfiguration

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

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

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

  • 字符串
  • 数组

OpenAI.Tool

OpenAI.Tool 的鉴别器

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

类型值 图式
function OpenAI.FunctionTool
file_search OpenAI.FileSearchTool
computer_use_preview OpenAI.ComputerUsePreviewTool
web_search_preview OpenAI.WebSearchPreviewTool
code_interpreter OpenAI.CodeInterpreterTool
image_generation OpenAI.ImageGenTool
local_shell OpenAI.LocalShellTool
mcp OpenAI.MCPTool
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ToolType 可用于生成响应的工具。 是的

OpenAI.ToolChoiceObject

OpenAI.ToolChoiceObject 的鉴别器

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

类型值 图式
file_search OpenAI.ToolChoiceObjectFileSearch
computer_use_preview OpenAI.ToolChoiceObjectComputer
web_search_preview OpenAI.ToolChoiceObjectWebSearch
image_generation OpenAI.ToolChoiceObjectImageGen
code_interpreter OpenAI.ToolChoiceObjectCodeInterpreter
function OpenAI.ToolChoiceObjectFunction
mcp OpenAI.ToolChoiceObjectMCP
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.ToolChoiceObjectType 指示模型应使用内置工具生成响应。 是的

OpenAI.ToolChoiceObjectCodeInterpreter

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

OpenAI.ToolChoiceObjectComputer

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

OpenAI.ToolChoiceObjectFileSearch

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

OpenAI.ToolChoiceObjectFunction

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

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

OpenAI.ToolChoiceObjectImageGen

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

OpenAI.ToolChoiceObjectMCP

使用此选项强制模型在远程 MCP 服务器上调用特定工具。

名称 类型 DESCRIPTION 必选 违约
姓名 字符串 在服务器上调用的工具的名称。 否
服务器标签 字符串 要使用的 MCP 服务器的标签。 是的
类型 枚举 对于 MCP 工具，类型始终 mcp为 。
可能的值：mcp		 是的

OpenAI.ToolChoiceObjectType

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

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

OpenAI.ToolChoiceObjectWebSearch

注释

web_search 尚无法通过 Azure OpenAI 使用。

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

OpenAI.ToolChoiceOptions

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

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

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

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

资产 价值
说明 控制模型调用哪个（如果有）工具。

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

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

required 表示模型必须调用一个或多个工具。
类型 字符串
价值观 none
auto
required

OpenAI.ToolType

可用于生成响应的工具。

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

OpenAI.TopLogProb

令牌的最高对数概率。

名称 类型 DESCRIPTION 必选 违约
字节 数组 是的
logprob 数字 是的
代币 字符串 是的

OpenAI.UpdateVectorStoreFileAttributesRequest

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

OpenAI.UpdateVectorStoreRequest

名称 类型 DESCRIPTION 必选 违约
过期时间 对象 矢量存储的过期策略。 否
~~ 定位点 枚举 在此时间之后应用过期策略的定位点时间戳。 支持的定位点： last_active_at.
可能的值：last_active_at		 否
~~ 天 整数 矢量存储将过期的定位时间后的天数。 否
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 否
姓名 字符串 矢量存储的名称。 否

OpenAI.ValidateGraderRequest

名称 类型 DESCRIPTION 必选 违约
年级 对象 一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。 是的
calculate_output 字符串 用于基于评分器结果计算输出的公式。 否
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		 否
~~ 评分员 对象 否
image_tag 字符串 用于 python 脚本的图像标记。 否
└─ 输入 数组 输入文本。 这可能包括模板字符串。 否
└─ 模型 字符串 要用于评估的模型。 否
└─ 名称 字符串 评分程序的名称。 否
~~作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 否
~~ 范围 数组 分数的范围。 默认为 [0, 1]。 否
~~ 参考 字符串 作为评分参照的文本。 否
采样参数 (sampling_params) 模型的采样参数。 否
└─ 来源 字符串 python 脚本的源代码。 否
└─ 类型 枚举 始终为 multi 的对象类型。
可能的值：multi		 否

OpenAI.ValidateGraderResponse

名称 类型 DESCRIPTION 必选 违约
年级 对象 一个 StringCheckGrader 对象，该对象使用指定的操作在输入和参考之间执行字符串比较。 否
calculate_output 字符串 用于基于评分器结果计算输出的公式。 否
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		 否
~~ 评分员 对象 否
image_tag 字符串 用于 python 脚本的图像标记。 否
└─ 输入 数组 输入文本。 这可能包括模板字符串。 否
└─ 模型 字符串 要用于评估的模型。 否
└─ 名称 字符串 评分程序的名称。 否
~~作 枚举 要执行的字符串检查操作。 eq、ne、like 或 ilike 之一。
可能的值：eq、ne、like、ilike		 否
~~ 范围 数组 分数的范围。 默认为 [0, 1]。 否
~~ 参考 字符串 作为评分参照的文本。 否
采样参数 (sampling_params) 模型的采样参数。 否
└─ 来源 字符串 python 脚本的源代码。 否
└─ 类型 枚举 始终为 multi 的对象类型。
可能的值：multi		 否

OpenAI.VectorStoreExpirationAfter

矢量存储的过期策略。

名称 类型 DESCRIPTION 必选 违约
定位标记 枚举 在此时间之后应用过期策略的定位点时间戳。 支持的定位点： last_active_at.
可能的值：last_active_at		 是的
天 整数 矢量存储将过期的定位时间后的天数。 是的

OpenAI.VectorStoreFileAttributes

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

类型：对象

OpenAI.VectorStoreFileBatchObject

附加到向量存储的一批文件。

名称 类型 DESCRIPTION 必选 违约
创建时间 整数 创建矢量存储文件批处理时的 Unix 时间戳（以秒为单位）。 是的
file_counts 对象 是的
~~ 已取消 整数 取消的文件数。 否
~~ 已完成 整数 已处理的文件数。 否
~~ 失败 整数 未能处理的文件数。 否
in_progress 整数 当前正在处理的文件数。 否
~~ 总计 整数 文件总数。 否
id 字符串 可以在 API 终结点中引用的标识符。 是的
对象 枚举 始终为 vector_store.file_batch 的对象类型。
可能的值：vector_store.files_batch		 是的
状态 枚举 矢量存储文件批处理的状态，可以是in_progress， completedcancelledfailed也可以。
可能的值：in_progress、completed、cancelled、failed		 是的
vector_store_id 字符串 文件附加到的向量存储的 ID。 是的

OpenAI.VectorStoreFileObject

附加到向量存储的文件列表。

名称 类型 DESCRIPTION 必选 违约
attributes 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。 键是字符串
最大长度为 64 个字符。 值为最大值的字符串
长度为 512 个字符、布尔值或数字。		 否
chunking_strategy 对象 否
└─ 类型 枚举
可能的值： staticother		 否
创建时间 整数 创建矢量存储文件时的 Unix 时间戳（以秒为单位）。 是的
id 字符串 可以在 API 终结点中引用的标识符。 是的
last_error 对象 与此矢量存储文件关联的最后一个错误。 如果不存在错误，则为 是的
└─ 代码 枚举 server_error或rate_limit_exceeded之一。
可能的值：server_error、、 unsupported_fileinvalid_file		 否
└─ 消息 字符串 错误的人工可读说明。 否
对象 枚举 始终为 vector_store.file 的对象类型。
可能的值：vector_store.file		 是的
状态 枚举 矢量存储文件的状态，可以是in_progress，completedcancelledfailed也可以。 状态 completed 指示矢量存储文件可供使用。
可能的值：in_progress、completed、cancelled、failed		 是的
usage_bytes 整数 总矢量存储使用量（以字节为单位）。 请注意，这可能不同于原始文件大小。 是的
vector_store_id 字符串 文件附加到的向量存储的 ID。 是的

OpenAI.VectorStoreObject

矢量存储是工具可以使用 file_search 已处理文件的集合。

名称 类型 DESCRIPTION 必选 违约
创建时间 整数 创建矢量存储时的 Unix 时间戳（以秒为单位）。 是的
过期时间 OpenAI.VectorStoreExpirationAfter 矢量存储的过期策略。 否
过期时间 整数 矢量存储何时过期的 Unix 时间戳（以秒为单位）。 否
file_counts 对象 是的
~~ 已取消 整数 已取消的文件数。 否
~~ 已完成 整数 已成功处理的文件数。 否
~~ 失败 整数 未能处理的文件数。 否
in_progress 整数 当前正在处理的文件数。 否
~~ 总计 整数 文件总数。 否
id 字符串 可以在 API 终结点中引用的标识符。 是的
last_active_at 整数 矢量存储上次处于活动状态时的 Unix 时间戳（以秒为单位）。 是的
元数据 对象 按 16 个成组的可附加到对象的键值对。 这可以是
用于将有关对象的其他信息存储在结构化对象中
通过 API 或仪表板格式化和查询对象。

键是最大长度为 64 个字符的字符串。 值为字符串
最大长度为 512 个字符。		 是的
姓名 字符串 矢量存储的名称。 是的
对象 枚举 始终为 vector_store 的对象类型。
可能的值：vector_store		 是的
状态 枚举 矢量存储的状态，可以是 expired， in_progress也可以 completed。 指示矢量存储已准备好使用的状态 completed 。
可能的值：expired、、 in_progresscompleted		 是的
usage_bytes 整数 矢量存储区中文件使用的字节总数。 是的

OpenAI.VoiceIdsShared

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

OpenAI.WebSearchAction

OpenAI.WebSearchAction 的鉴别器

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

类型值 图式
find OpenAI.WebSearchActionFind
open_page OpenAI.WebSearchActionOpenPage
search OpenAI.WebSearchActionSearch
名称 类型 DESCRIPTION 必选 违约
类型 OpenAI.WebSearchActionType 是的

OpenAI.WebSearchActionFind

作类型“find”：在加载的页面中搜索模式。

名称 类型 DESCRIPTION 必选 违约
模式 字符串 在页面中搜索的模式或文本。 是的
类型 枚举 作类型。
可能的值：find		 是的
网址 字符串 搜索模式的页面的 URL。 是的

OpenAI.WebSearchActionOpenPage

作类型“open_page” - 打开搜索结果中的特定 URL。

名称 类型 DESCRIPTION 必选 违约
类型 枚举 作类型。
可能的值：open_page		 是的
网址 字符串 模型打开的 URL。 是的

OpenAI.WebSearchActionSearch

作类型“search”- 执行 Web 搜索查询。

名称 类型 DESCRIPTION 必选 违约
查询 字符串 搜索查询。 是的
类型 枚举 作类型。
可能的值：search		 是的

OpenAI.WebSearchActionType

资产 价值
类型 字符串
价值观 search
open_page
find

OpenAI.WebSearchPreviewTool

注释

web_search 尚无法通过 Azure OpenAI 使用。

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

OpenAI.WebSearchToolCallItemParam

注释

web_search 尚无法通过 Azure OpenAI 使用。

名称 类型 DESCRIPTION 必选 违约
操作 对象 是的
└─ 类型 OpenAI.WebSearchActionType 否
类型 枚举
可能的值：web_search_call		 是的

OpenAI.WebSearchToolCallItemResource

注释

web_search 尚无法通过 Azure OpenAI 使用。

名称 类型 DESCRIPTION 必选 违约
操作 对象 是的
└─ 类型 OpenAI.WebSearchActionType 否
状态 枚举 Web 搜索工具调用的状态。
可能的值：in_progress、searching、completed、failed		 是的
类型 枚举
可能的值：web_search_call		 是的

PineconeChatDataSource

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

ResponseFormatJSONSchemaRequest

名称 类型 DESCRIPTION 必选 违约
json_schema 对象 响应格式的 JSON 架构 是的
类型 枚举 响应格式的类型
可能的值：json_schema		 是的

ResponseModalities

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

["text"]

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

["text", "audio"]

数组：字符串