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

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

本文提供有关 Azure OpenAI 的推理 REST API 终结点的详细信息。

API specs

管理和与 Azure OpenAI 模型和资源交互分为三个主要 API 图面：

  • Control plane
  • 数据平面 - 创作
  • 数据平面 - 推理

每个 API 图面/规范封装了一组不同的 Azure OpenAI 功能。 每个 API 都有自己的独特的预览版和稳定/正式版 （GA） API 版本。 预览版目前往往遵循每月节奏。

Important

现在有一个新的预览推理 API。 在 API 生命周期指南中了解详细信息。

API 最新预览版 最新正式版 Specifications Description
Control plane 2025-07-01-preview 2025-06-01 Spec files 控制平面 API 用于 创建资源、 模型部署和其他更高级别的资源管理任务等操作。 控制平面还控制使用 Azure 资源管理器、Bicep、Terraform 和 Azure CLI 等功能可能执行的操作。
Data plane v1 preview v1 Spec files 数据平面 API 控制推理和创作操作。

Authentication

Azure OpenAI 提供了两种身份验证方法。 可以使用 API 密钥或Microsoft Entra ID。

  • API 密钥身份验证：对于这种类型的身份验证，所有 API 请求都必须在 HTTP 标头中包含 api-key API 密钥。 本快速入门提供了有关如何使用此类身份验证进行调用的指导。

  • Microsoft Entra ID 身份验证：可以使用 Microsoft Entra 令牌对 API 调用进行身份验证。 身份验证令牌作为标头包含在请求 Authorization 中。 例如Bearer，提供的令牌前面必须有Bearer YOUR_AUTH_TOKEN。 可以阅读有关如何 使用 Microsoft Entra ID 进行身份验证的操作指南。

REST API 版本控制

服务 API 使用 api-version 查询参数进行版本控制。 所有版本都遵循 YYYY-MM-DD 日期结构。 For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

数据平面推理

本文的其余部分介绍了 2025-04-01-preview Azure OpenAI 数据平面推理规范的预览版本。

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

完成 - 创建

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

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
best_of 整数 生成 best_of 完成服务器端并返回“最佳”（每个标记具有最高对数概率的完成项）。 无法流式传输结果。

与 一起使用 n时， best_of 控制候选补全数，并 n 指定返回 Œ best_of 必须大于 n多少个。

注意： 由于此参数会生成许多完成，因此可以快速使用令牌配额。 仔细使用并确保你具有合理的设置 max_tokens 和 stop。		 No 1
echo boolean 除了完成之外，还回显提示 No False
frequency_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据文本中的现有频率惩罚新令牌，从而减少模型重复相同行的可能性。 No 0
logit_bias 对象 修改指定令牌在完成中出现的可能性。

接受 JSON 对象，该对象将令牌（由 GPT tokenizer 中的令牌 ID 指定）映射到从 -100 到 100 的关联偏差值。 从数学上看，偏差将添加到模型在采样之前生成的对数。 具体效果因模型而异，但 -1 和 1 之间的值应减少或增加选择的可能性;-100 或 100 等值应导致相关令牌的禁止或独占选择。

例如，可以传递 {"50256": -100} 以防止 <生成 |endoftext|> 令牌。		 No None
logprobs 整数 在最有可能的输出标记上包括对数概率 logprobs ，以及所选的标记。 例如，如果 logprobs 为 5，则 API 返回 5 个最有可能的令牌的列表。 API 始终返回 logprob 采样令牌，因此响应中可能最多有 logprobs+1 元素。

最大值 logprobs 为 5。		 No None
max_tokens 整数 可以在完成时生成的最大令牌数。

提示的令牌计数加上 max_tokens 不能超过模型的上下文长度。		 No 16
n 整数 要为每个提示生成的完成次数。

注意： 由于此参数会生成许多完成，因此可以快速使用令牌配额。 仔细使用并确保你具有合理的设置 max_tokens 和 stop。		 No 1
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。 No 0
提示 字符串或数组 为字符串、字符串数组、令牌数组或令牌数组数组生成完成的提示。

请注意， <|endoftext|> 是模型在训练期间看到的文档分隔符，因此如果未指定提示，模型将生成与从新文档的开头一样。		 Yes
seed 整数 如果指定，我们的系统会尽最大努力确定性地采样，这样，具有相同 seed 参数的重复请求应返回相同的结果。

无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。		 No
stop 字符串或数组 API 停止生成进一步令牌的最多四个序列。 返回的文本不包含停止序列。 No
数据流 boolean 是否回流式传输部分进度。 如果已设置，则令牌在可用时以仅数据 服务器发送的事件的形式发送 ，流由 data: [DONE] 消息终止。 Python 代码示例。
 No False
suffix 字符串 插入的文本完成后的后缀。

此参数仅受支持 gpt-3.5-turbo-instruct。
 No None
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）会使输出更加随机，而 0.2 等较低值则使其更加专注和确定性。

我们通常建议更改这一点， top_p 但不建议同时更改这两者。
 No 1
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。
 No 1
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。
 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json createCompletionResponse

状态代码： 默认值

说明：服务不可用

Content-Type Type Description
application/json errorResponse

Examples

Example

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

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

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

响应：状态代码：200

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

嵌入 - 创建

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

获取给定输入的向量表示形式，该输入可由机器学习模型和算法轻松使用。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串 已部署的模型的部署 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
dimensions 整数 生成的输出嵌入应具有的维度数。 仅在以后的模型中受 text-embedding-3 支持。 No
encoding_format 字符串 要返回嵌入内容的格式。 可以是或 floatbase64。 默认值为 float. No
输入 字符串或数组 要嵌入的输入文本，编码为字符串或标记数组。 若要在单个请求中嵌入多个输入，请传递字符串数组或令牌数组数组。 输入不能超过模型的最大输入标记（8,192 个标记 text-embedding-ada-002），不能为空字符串，任何数组都必须为 2,048 个维度或更少。 Yes
input_type 字符串 要使用的嵌入搜索的输入类型 No
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json 对象

Examples

Example

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

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

{
 "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.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

聊天完成 - 创建

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

为聊天消息创建完成

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
audio 对象 音频输出的参数。 当使用 .. 请求 modalities: ["audio"]音频输出时是必需的。 No
└─ format 枚举 指定输出音频格式。 必须是 、wavmp3、 flacopus或pcm16之一。

可能的值：wav、、mp3flac、opus、pcm16		 No
└─ voice 枚举 指定语音类型。 支持的语音包括alloy、echo、fable、onyx和novashimmer。

可能的值：alloy、、echo、fableonyx、nova、shimmer		 No
data_sources 数组 使用它们的 Azure OpenAI 聊天扩展的配置条目。
此额外规范仅与 Azure OpenAI 兼容。		 No
frequency_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据文本中的现有频率惩罚新令牌，从而减少模型重复相同行的可能性。
 No 0
function_call string 或 chatCompletionFunctionCallOption 弃用赞成 tool_choice。

控制模型调用哪个（如果有）函数。
none 表示模型不会调用函数，而是生成消息。
auto 表示模型可以在生成消息或调用函数之间进行选择。
通过 {"name": "my_function"} 强制模型调用该函数来指定特定函数。

none 如果没有函数，则为默认值。 auto 如果存在函数，则为默认值。
 No
functions 数组 弃用赞成 tools。

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

接受 JSON 对象，该对象将令牌（由令牌 ID 在 tokenizer 中指定）映射到从 -100 到 100 的关联偏差值。 从数学上看，偏差将添加到模型在采样之前生成的对数。 具体效果因模型而异，但 -1 和 1 之间的值应减少或增加选择的可能性;-100 或 100 等值应导致相关令牌的禁止或独占选择。
 No None
logprobs boolean 是否返回输出令牌的对数概率。 如果为 true，则返回在以下content项中message返回的每个输出令牌的对数概率。 No False
max_completion_tokens 整数 可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 No
max_tokens 整数 可在聊天完成中生成的最大令牌数。

输入令牌和生成的令牌的总长度受模型的上下文长度限制。		 No
messages 数组 到目前为止，包含对话的消息列表。 Python 代码示例。 Yes
元数据 对象 开发人员定义的标记和值，用于筛选存储的完成仪表板中的完成。 No
modalities ChatCompletionModalities 希望模型为此请求生成的输出类型。
大多数模型都能够生成文本，这是默认值：

["text"]

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

["text", "audio"]
 No
n 整数 要为每个输入消息生成的聊天完成选项数。 将根据所有选项中生成的令牌数向你收费。 n尽量1降低成本。 No 1
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
预测 PredictionContent 预测输出的配置，当模型响应的大部分内容提前已知时，可以大大改善响应时间。 在重新生成仅对大部分内容进行轻微更改的文件时，这是最常见的。 No
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。
 No 0
reasoning_effort 枚举 仅限 o1 模型

限制推理模型的推理工作。

当前支持的值是 low， medium以及 high。 减少推理工作量可能会导致响应更快，在响应中用于推理的令牌更少。
可能的值：low、、 mediumhigh		 No
response_format ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema 一个对象，指定模型必须输出的格式。 与 GPT-4o、 GPT-4o mini、 GPT-4 Turbo 和所有 GPT-3.5 Turbo 型号兼容 gpt-3.5-turbo-1106。

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

{ "type": "json_object" }设置为启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。
 No
seed 整数 此功能在 Beta 版中。
如果指定，我们的系统会尽最大努力确定性地采样，这样，具有相同 seed 参数的重复请求应返回相同的结果。
无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。
 No
stop 字符串或数组 API 停止生成进一步令牌的最多 4 个序列。
 No
存储 boolean 是否存储此聊天完成请求的输出，以便在模型提取或评估产品中使用。 No
数据流 boolean 如果已设置，则发送部分消息增量，如在 ChatGPT 中一样。 令牌在可用时作为仅数据 服务器发送的事件 发送，流由 data: [DONE] 消息终止。 Python 代码示例。
 No False
stream_options chatCompletionStreamOptions 流式处理响应的选项。 仅在设置时设置 stream: true此设置。
 No None
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）会使输出更加随机，而 0.2 等较低值则使其更加专注和确定性。

我们通常建议更改这一点， top_p 但不建议同时更改这两者。
 No 1
tool_choice chatCompletionToolChoiceOption 控制模型调用哪个（如果有）工具。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。 通过 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具来指定特定工具。 none 如果没有工具，则为默认值。 auto 如果存在工具，则为默认值。 No
tools 数组 模型可以调用的工具列表。 目前，仅支持函数作为工具。 使用此函数提供模型可能会为其生成 JSON 输入的函数列表。 最多支持 128 个函数。
 No
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 如果使用此参数，则必须设置为 < No
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

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

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json 对象

状态代码： 默认值

说明：服务不可用

Content-Type Type Description
application/json errorResponse

Examples

Example

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

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

{
 "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? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

基于 Azure 搜索数据和系统分配的托管标识创建完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

基于 Azure 搜索图像矢量数据创建完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

基于 Azure 搜索向量数据、以前的助理消息和用户分配的托管标识创建完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

为提供的 Azure Cosmos DB 创建完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

为提供的 Mongo DB 创建完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

为提供的 Elasticsearch 创建完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

为提供的 Pinecone 资源创建完成。

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

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

听录 - 创建

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

将音频转录为输入语言。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: multipart/form-data

Name 类型 Description Required Default
模型 字符串 要使用的模型的 ID。 选项包括gpt-4o-transcribe、gpt-4o-mini-transcribe、gpt-4o-mini-transcribe-2025-12-15和whisper-1gpt-4o-transcribe-diarize。 Yes
文件 字符串 要转录的音频文件对象。 Yes
语言 字符串 输入音频的语言。 以 ISO-639-1 格式提供输入语言可提高准确性和延迟。 No
提示 字符串 用于指导模型样式或继续上一个音频段的可选文本。 提示应与音频语言匹配。 No
response_format audioResponseFormat 定义输出的格式。 No
temperature number 采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。 如果设置为 0，则模型使用对数概率自动增加温度，直到达到某些阈值。 No 0
timestamp_granularities[] 数组 要为此听录填充的时间戳粒度。 response_format 必须设置为 verbose_json 使用时间戳粒度。 支持以下任一选项或两个选项： word或 segment。 注意：段时间戳没有额外的延迟，但生成单词时间戳会产生额外的延迟。 No ['segment']

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json 对象
text/plain 字符串 输出格式的转录文本（当response_format为其中一个textvtt或srt时）。

Examples

Example

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

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

响应：状态代码：200

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

Example

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

响应：状态代码：200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

翻译 - 创建

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

将输入音频转录并翻译为英语文本。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: multipart/form-data

Name 类型 Description Required Default
文件 字符串 要翻译的音频文件。 Yes
提示 字符串 用于指导模型样式或继续上一个音频段的可选文本。 提示应为英语。 No
response_format audioResponseFormat 定义输出的格式。 No
temperature number 采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。 如果设置为 0，则模型使用对数概率自动增加温度，直到达到某些阈值。 No 0

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json 对象
text/plain 字符串 输出格式的转录文本（当response_format为文本、vtt 或 srt 之一时）。

Examples

Example

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

响应：状态代码：200

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

Example

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

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

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

响应：状态代码：200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

语音 - 创建

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

从输入文本生成音频。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: multipart/form-data

Name 类型 Description Required Default
输入 字符串 要为其合成音频的文本。 最大长度为 4,096 个字符。 Yes
response_format 枚举 要合成音频的格式。
可能的值：mp3、、opus、aacflac、wav、pcm		 No
speed number 合成音频的速度。 从中选择一个值0.25。4.0 1.0 为默认值。 No 1.0
voice 枚举 用于语音合成的语音。
可能的值：alloy、、echo、fableonyx、nova、shimmer		 Yes

Responses

状态代码： 200

Description: OK

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

Examples

Example

从提供的文本合成音频。

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

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

响应：状态代码：200

{
  "body": "101010101"
}

映像代系 - 创建

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

从给定映像生成模型部署上的文本标题生成一批图像

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
后台的 imageBackground 允许为生成的图像的背景设置透明度。 仅 gpt-image-1 系列模型支持此参数。 No auto
n 整数 要生成的图像数。 对于 dall-e-3，仅支持 n=1。 No 1
output_compression 整数 生成的图像的压缩级别（0-100%）。 此参数仅支持 jpeg 输出格式的 gpt-image-1 系列模型。 No 100
output_format imagesOutputFormat 返回生成的图像的文件格式。 仅支持 gpt-image-1 系列模型。 No png
提示 字符串 所需图像的文本说明。 gpt-image-1 系列的最大长度为 32000 个字符，dall-e-3 的最大长度为 4000 个字符 Yes
partial_images 整数 要生成的部分图像数。 此参数用于返回部分图像的流式处理响应。 值必须介于 0 和 3 之间。 设置为 0 时，响应将是在一个流式处理事件中发送的单个图像。 请注意，如果生成完整映像的速度更快，则可能会在生成完整映像之前发送最终图像。 0
数据流 boolean 在流式处理模式下编辑图像。 no false
quality imageQuality 将生成的图像的质量。 No auto
response_format imagesResponseFormat 返回生成的图像的格式。 对于始终返回 base64 编码图像的系列模型，不支持 gpt-image-1此参数。
可能的值： url， b64_json。		 No url
size imageSize 生成的图像的大小。 No auto
样式 imageStyle 生成的图像的样式。 仅支持 dall-e-3。 No vivid
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。 No

Responses

状态代码： 200

Description: Ok

Content-Type Type Description
application/json generateImagesResponse

状态代码： 默认值

说明：发生错误。

Content-Type Type Description
application/json dalleErrorResponse

Examples

Example

根据提示创建映像。

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

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

响应：状态代码：200

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

图像代系 - 编辑

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

从给定 gpt-image-1 模型部署上的文本标题编辑图像

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
deployment-id 路径 Yes 字符串
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: multipart/form-data

Name 类型 Description Required Default
图像 字符串或数组 要编辑的图像（s）。 必须是受支持的图像文件或图像数组。 每个图像应为小于 50MB 的 png 或 jpg 文件。 Yes
input_fidelity 字符串 控制模型在匹配输入图像的样式和特征（尤其是面部特征）方面将付出多少努力。 仅 gpt-image-1 系列模型支持此参数。 支持 high 和 low。 no low.
过滤 字符串 另一个图像，其完全透明区域（例如 alpha 为零）指示应编辑图像的位置。 如果提供了多个映像，掩码将应用于第一个图像。 必须是有效的 PNG 文件，小于 4MB，并且具有与图像相同的尺寸。 No
n 整数 要生成的图像数。 必须介于 1 到 10 之间。 No 1
提示 字符串 所需图像的文本说明。 最大长度为 32000 个字符。 Yes
quality imageQuality 将生成的图像的质量。 No auto
partial_images 要生成的部分图像数。 此参数用于返回部分图像的流式处理响应。 值必须介于 0 和 3 之间。 设置为 0 时，响应将是在一个流式处理事件中发送的单个图像。 请注意，如果生成完整映像的速度更快，则可能会在生成完整映像之前发送最终图像。
数据流 boolean 在流式处理模式下编辑图像。 no false
response_format imagesResponseFormat 返回生成的图像的格式。 No url
size imageSize 生成的图像的大小。 No auto
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。 No

Responses

状态代码： 200

Description: Ok

Content-Type Type Description
application/json generateImagesResponse

状态代码： 默认值

说明：发生错误。

Content-Type Type Description
application/json dalleErrorResponse

列表 - 助手

Note

助手 API 已弃用，将于 2026 年 8 月 26 日停用。 使用正式版 Microsoft Foundry 代理服务。 按照 迁移指南 更新工作负荷。 Learn more.

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

返回助理列表。

URI Parameters

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

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json listAssistantsResponse

Examples

Example

返回助理列表。

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

创建 - 助手

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

使用模型和说明创建助手。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
description 字符串 助理的说明。 最大长度为 512 个字符。
 No
instructions 字符串 助手使用的系统说明。 最大长度为 256,000 个字符。
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 Yes
name 字符串 助理的名称。 最大长度为 256 个字符。
 No
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
tool_resources 对象 助手工具使用的一组资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此助手的向量存储。 最多可以有 1 个矢量存储附加到助手。
 No
└─ vector_stores 数组 一个帮助程序，用于创建具有file_ids的向量存储，并将其附加到此助手。 最多可以有 1 个矢量存储附加到助手。
 No
tools 数组 在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具可以是类型 code_interpreter， retrieval也可以 function。
 No []
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json assistantObject

Examples

Example

使用模型和说明创建助手。

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

响应：状态代码：200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

获取 - 助手

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

检索助手。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
assistant_id 路径 Yes 字符串 要检索的助手的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json assistantObject

Examples

Example

检索助手。

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

修改 - 助手

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

修改助手。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
assistant_id 路径 Yes 字符串 要修改的助手的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
description 字符串 助理的说明。 最大长度为 512 个字符。
 No
instructions 字符串 助手使用的系统说明。 最大长度为 32768 个字符。
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 No
name 字符串 助理的名称。 最大长度为 256 个字符。
 No
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
tool_resources 对象 助手工具使用的一组资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 重写可用于 code_interpreter 该工具的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 重写附加到此助手的向量存储。 最多可以有 1 个矢量存储附加到助手。
 No
tools 数组 在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具可以是类型 code_interpreter， retrieval也可以 function。
 No []
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json assistantObject

Examples

Example

修改助手。

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

响应：状态代码：200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

删除 - 助手

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

删除助手。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
assistant_id 路径 Yes 字符串 要删除的助手的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json deleteAssistantResponse

Examples

Example

删除助手。

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

创建 - 线程

Note

助手 API 已弃用，将于 2026 年 8 月 26 日停用。 使用正式版 Microsoft Foundry 代理服务。 按照 迁移指南 更新工作负荷。 Learn more.

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

创建线程。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
messages 数组 消息列表，以启动线程。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
tool_resources 对象 一组可供此线程中的助手工具使用的资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此线程的向量存储。 最多可以附加到线程的 1 个向量存储。
 No
└─ vector_stores 数组 一个帮助程序，用于创建具有file_ids的向量存储并将其附加到此线程。 最多可以附加到线程的 1 个向量存储。
 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json threadObject

Examples

Example

创建线程。

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

获取 - 线程

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

检索线程。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 要检索的线程的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json threadObject

Examples

Example

检索线程。

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

修改 - 线程

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

修改线程。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 要修改的线程的 ID。 metadata只能修改该设置。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
tool_resources 对象 一组可供此线程中的助手工具使用的资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 工具可用的 code_interpreter 文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此线程的向量存储。 最多可以附加到线程的 1 个向量存储。
 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json threadObject

Examples

Example

修改线程。

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

响应：状态代码：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

删除 - 线程

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

删除线程。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 要删除的线程的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json deleteThreadResponse

Examples

Example

删除线程。

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

列表 - 消息

Note

助手 API 已弃用，将于 2026 年 8 月 26 日停用。 使用正式版 Microsoft Foundry 代理服务。 按照 迁移指南 更新工作负荷。 Learn more.

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

返回给定线程的消息列表。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 消息所属的线程的 ID。
limit 查询 No 整数 要返回的对象数的限制。 限制可以介于 1 和 100 之间，默认值为 20。
顺序 查询 No 字符串
可能的值： ascdesc		 按 created_at 对象的时间戳排序顺序。 asc 为升序和 desc 降序。
after 查询 No 字符串 用于分页的游标。 after 是一个对象 ID，用于定义列表中的位置。 例如，如果发出列表请求并接收 100 个对象，以obj_foo结尾，则后续调用可以包含 after=obj_foo，以便提取列表的下一页。
before 查询 No 字符串 用于分页的游标。 before 是一个对象 ID，用于定义列表中的位置。 例如，如果发出列表请求并接收 100 个对象，从obj_foo开始，后续调用可以包括 before=obj_foo，以便提取列表的上一页。
run_id 查询 No 字符串 按生成消息的运行 ID 筛选消息。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json listMessagesResponse

Examples

Example

List Messages

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

创建 - 消息

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

创建消息。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 要为其创建消息的线程的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
attachments 数组 附加到消息的文件列表及其应添加到的工具。 No
内容 字符串 消息的内容。 Yes
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
角色 字符串 正在创建消息的实体的角色。 允许的值包括：
- user：指示消息是由实际用户发送的，在大多数情况下应用于表示用户生成的消息。
- assistant：指示消息是由助手生成的。 使用此值将助手中的消息插入对话。
 Yes

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json messageObject

Examples

Example

创建消息。

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

响应：状态代码：200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

获取 - 消息

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

检索消息。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 此消息所属的线程的 ID。
message_id 路径 Yes 字符串 要检索的消息的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json messageObject

Examples

Example

检索消息。

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

修改 - 消息

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

修改消息。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 此消息所属的线程的 ID。
message_id 路径 Yes 字符串 要修改的消息的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json messageObject

Examples

Example

修改消息。

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

响应：状态代码：200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

创建 - 线程和运行

Note

助手 API 已弃用，将于 2026 年 8 月 26 日停用。 使用正式版 Microsoft Foundry 代理服务。 按照 迁移指南 更新工作负荷。 Learn more.

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

创建一个线程并在一个请求中运行它。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
assistant_id 字符串 用于执行此运行的助手的 ID。 Yes
instructions 字符串 重写助手的默认系统消息。 这对于按运行修改行为非常有用。 No
max_completion_tokens 整数 在运行过程中可以使用的最大完成令牌数。 运行尽力仅使用指定的完成令牌数，跨运行的多个轮次。 如果运行超过指定的完成令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
max_prompt_tokens 整数 在运行过程中可以使用的最大提示令牌数。 运行尽力仅使用指定的提示令牌数，在运行的多个轮次中。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 要用于执行此运行的模型的 ID。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。 No
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
数据流 boolean 如果 true返回在运行方式为服务器发送的事件期间发生的事件流，则当运行进入带有消息的终端状态 data: [DONE] 时终止。
 No
stream_options chatCompletionStreamOptions 流式处理响应的选项。 仅在设置时设置 stream: true此设置。
 No None
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
会话 createThreadRequest No
tool_choice assistantsApiToolChoiceOption 控制模型调用哪个（如果有）工具。
none 表示模型不会调用任何工具，而是生成消息。
auto 是默认值，表示模型可以在生成消息或调用工具之间进行选择。
指定特定工具，例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具。
 No
tool_resources 对象 助手工具使用的一组资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此助手的向量存储的 ID。 最多可以有 1 个矢量存储附加到助手。
 No
tools 数组 重写助手可用于此运行的工具。 这对于按运行修改行为非常有用。 No
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1
truncation_strategy truncationObject 控制如何在运行之前截断线程。 使用此控件可控制运行的初始上下文窗口。 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json runObject

Examples

Example

创建一个线程并在一个请求中运行它。

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

响应：状态代码：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

列表 - 运行

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

返回属于线程的运行列表。

URI Parameters

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

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json listRunsResponse

Examples

Example

返回属于线程的运行列表。

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

创建 - 运行

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

创建运行。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 要运行的线程的 ID。
include[] 查询 No 数组 要包含在响应中的其他字段的列表。 目前唯一支持的值是 step_details.tool_calls[*].file_search.results[*].content 提取文件搜索结果内容。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
additional_instructions 字符串 在运行指令的末尾追加其他指令。 这对于在不重写其他指令的情况下按运行修改行为非常有用。 No
additional_messages 数组 在创建运行之前，将其他消息添加到线程。 No
assistant_id 字符串 用于执行此运行的助手的 ID。 Yes
instructions 字符串 重写助手的默认系统消息。 这对于按运行修改行为非常有用。 No
max_completion_tokens 整数 在运行过程中可以使用的最大完成令牌数。 运行尽力仅使用指定的完成令牌数，跨运行的多个轮次。 如果运行超过指定的完成令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
max_prompt_tokens 整数 在运行过程中可以使用的最大提示令牌数。 运行尽力仅使用指定的提示令牌数，在运行的多个轮次中。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 要用于执行此运行的模型的 ID。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。 No
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
数据流 boolean 如果 true返回在运行方式为服务器发送的事件期间发生的事件流，则当运行进入带有消息的终端状态 data: [DONE] 时终止。
 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
tool_choice assistantsApiToolChoiceOption 控制模型调用哪个（如果有）工具。
none 表示模型不会调用任何工具，而是生成消息。
auto 是默认值，表示模型可以在生成消息或调用工具之间进行选择。
指定特定工具，例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具。
 No
tools 数组 重写助手可用于此运行的工具。 这对于按运行修改行为非常有用。 No
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1
truncation_strategy truncationObject 控制如何在运行之前截断线程。 使用此控件可控制运行的初始上下文窗口。 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json runObject

Examples

Example

创建运行。

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

响应：状态代码：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

获取 - 运行

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

检索运行。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 运行的线程的 ID。
run_id 路径 Yes 字符串 要检索的运行 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json runObject

Examples

Example

获取运行。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

修改 - 运行

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

修改运行。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 运行的线程的 ID。
run_id 路径 Yes 字符串 要修改的运行 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json runObject

Examples

Example

修改运行。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

响应：状态代码：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

提交 - 要运行的工具输出

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

运行完成后 status: "requires_action"required_action.typesubmit_tool_outputs，可以使用此终结点提交工具调用的输出。 所有输出都必须在单个请求中提交。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 此运行所属的线程的 ID。
run_id 路径 Yes 字符串 需要工具输出提交的运行的 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
数据流 boolean 如果 true返回在运行方式为服务器发送的事件期间发生的事件流，则当运行进入带有消息的终端状态 data: [DONE] 时终止。
 No
tool_outputs 数组 要为其提交输出的工具列表。 Yes

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json runObject

Examples

Example

运行完成后 status: "requires_action"required_action.typesubmit_tool_outputs，可以使用此终结点提交工具调用的输出。 所有输出都必须在单个请求中提交。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

响应：状态代码：200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

取消 - 运行

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

取消一个运行，即 in_progress。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 此运行所属的线程的 ID。
run_id 路径 Yes 字符串 要取消的运行 ID。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json runObject

Examples

Example

取消一个运行，即 in_progress。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

列表 - 运行步骤

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

返回属于运行的运行步骤的列表。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 运行和运行步骤所属的线程的 ID。
run_id 路径 Yes 字符串 运行步骤所属的 ID。
limit 查询 No 整数 要返回的对象数的限制。 限制可以介于 1 和 100 之间，默认值为 20。
顺序 查询 No 字符串
可能的值： ascdesc		 按 created_at 对象的时间戳排序顺序。 asc 为升序和 desc 降序。
after 查询 No 字符串 用于分页的游标。 after 是一个对象 ID，用于定义列表中的位置。 例如，如果发出列表请求并接收 100 个对象，以obj_foo结尾，则后续调用可以包含 after=obj_foo，以便提取列表的下一页。
before 查询 No 字符串 用于分页的游标。 before 是一个对象 ID，用于定义列表中的位置。 例如，如果发出列表请求并接收 100 个对象，从obj_foo开始，后续调用可以包括 before=obj_foo，以便提取列表的上一页。
api-version 查询 Yes 字符串
include[] 查询 No 数组 要包含在响应中的其他字段的列表。 目前唯一支持的值是 step_details.tool_calls[*].file_search.results[*].content 提取文件搜索结果内容。

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json listRunStepsResponse

Examples

Example

返回属于运行的运行步骤的列表。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

获取 - 运行步骤

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

检索运行步骤。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
thread_id 路径 Yes 字符串 运行和运行步骤所属的线程的 ID。
run_id 路径 Yes 字符串 运行步骤所属的运行 ID。
step_id 路径 Yes 字符串 要检索的运行步骤的 ID。
include[] 查询 No 数组 要包含在响应中的其他字段的列表。 目前唯一支持的值是 step_details.tool_calls[*].file_search.results[*].content 提取文件搜索结果内容。
api-version 查询 Yes 字符串

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json runStepObject

Examples

Example

检索运行步骤。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

列表 - 矢量存储

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

返回矢量存储的列表。

URI Parameters

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

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json listVectorStoresResponse

Examples

Example

返回矢量存储的列表。

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

创建 - 矢量存储

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

创建矢量存储。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
chunking_strategy autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam 用于对文件进行分块的分块策略。 如果未设置，将使用 auto 策略。 仅当非空时 file_ids 适用。 No
expires_after vectorStoreExpirationAfter 矢量存储的过期策略。 No
file_ids 数组 矢量存储应使用的文件 ID 列表。 可用于访问文件等 file_search 工具。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
name 字符串 矢量存储的名称。 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreObject

Examples

Example

创建矢量存储。

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

Get - 矢量存储

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

检索向量存储。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 要检索的向量存储的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreObject

Examples

Example

检索向量存储。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

修改 - 矢量存储

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

修改向量存储。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 要修改的向量存储的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
expires_after vectorStoreExpirationAfter 矢量存储的过期策略。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
name 字符串 矢量存储的名称。 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreObject

Examples

Example

修改向量存储。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

响应：状态代码：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

删除 - 矢量存储

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

删除向量存储。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 要删除的向量存储的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json deleteVectorStoreResponse

Examples

Example

删除向量存储。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

列表 - 矢量存储文件

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

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

URI Parameters

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

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json listVectorStoreFilesResponse

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

创建 - 矢量存储文件

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 要为其创建文件的向量存储的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
chunking_strategy chunkingStrategyRequestParam 用于对文件进行分块的分块策略。 如果未设置，将使用 auto 策略。 No
file_id 字符串 矢量存储应使用的文件 ID。 可用于访问文件等 file_search 工具。 Yes

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreFileObject

Examples

Example

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

响应：状态代码：200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - 矢量存储文件

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

检索向量存储文件。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 文件所属的向量存储的 ID。
file_id 路径 Yes 字符串 要检索的文件的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreFileObject

Examples

Example

检索向量存储文件。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

删除 - 矢量存储文件

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 文件所属的向量存储的 ID。
file_id 路径 Yes 字符串 要删除的文件的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json deleteVectorStoreFileResponse

Examples

Example

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

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

更新向量存储文件的属性。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 矢量存储文件所属的 ID。
file_id 路径 Yes 字符串 要更新属性的文件的 ID。

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

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

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreFileObject

检索矢量存储文件内容

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

检索矢量存储文件的已分析内容。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 矢量存储的 ID。
file_id 路径 Yes 字符串 矢量存储中文件的 ID。

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json VectorStoreFileContentResponse

搜索矢量存储

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

根据查询和文件属性筛选器搜索相关区块的向量存储。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 要搜索的向量存储的 ID。

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
filters ComparisonFilter 或 CompoundFilter 基于文件属性应用的筛选器。 No
max_num_results 整数 要返回的最大结果数。 此数字应介于 1 和 50 之间（含）。 No 10
查询 字符串或数组 搜索的查询字符串 Yes
ranking_options 对象 用于搜索的排名选项。 No
└─ ranker 枚举
可能的值： autodefault-2024-11-15		 No
└─ score_threshold number No 0
rewrite_query boolean 是否重写矢量搜索的自然语言查询。 No False

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json VectorStoreSearchResultsPage

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 要为其创建文件批处理的向量存储的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
chunking_strategy chunkingStrategyRequestParam 用于对文件进行分块的分块策略。 如果未设置，将使用 auto 策略。 No
file_ids 数组 矢量存储应使用的文件 ID 列表。 可用于访问文件等 file_search 工具。 Yes

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreFileBatchObject

Examples

Example

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

响应：状态代码：200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

获取 - 矢量存储文件批处理

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 文件批处理所属的向量存储的 ID。
batch_id 路径 Yes 字符串 正在检索的文件批处理的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreFileBatchObject

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

Cancel - Vector Store 文件批处理

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
vector_store_id 路径 Yes 字符串 文件批处理所属的向量存储的 ID。
batch_id 路径 Yes 字符串 要取消的文件批处理的 ID。
api-version 查询 Yes 字符串 api version

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json vectorStoreFileBatchObject

Examples

Example

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

列表 - 矢量存储文件批处理文件

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

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

URI Parameters

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

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json listVectorStoreFilesResponse

Examples

Example

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

响应：状态代码：200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

创建 - Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

创建临时 API 令牌，以便在客户端应用程序中使用实时 API。 可以使用与客户端事件相同的会话参数进行 session.update 配置。 它使用会话对象进行响应，以及 client_secret 包含可用于对实时 API 的浏览器客户端进行身份验证的可用临时 API 令牌的密钥。

Request Body

Content-Type: application/json

Name 类型 Description Required Default
input_audio_format 枚举 输入音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
对于 pcm16，输入音频必须采用 24kHz 采样率、单声道（单声道）和小端字节顺序的 16 位 PCM。

可能的值：pcm16、、 g711_ulawg711_alaw		 No
input_audio_noise_reduction 对象 输入音频降噪的配置。 这可以设置为 null 关闭。
降噪会筛选添加到输入音频缓冲区的音频，然后再将其发送到 VAD 和模型。
筛选音频可以通过改进输入音频的感知来提高 VAD 和轮次检测准确性（减少误报）和模型性能。
 No
└─ type 枚举 降噪类型。 near_field 用于近距离麦克风（如耳机）， far_field 适用于远场麦克风，例如笔记本电脑或会议室麦克风。

可能的值： near_fieldfar_field		 No
input_audio_transcription 对象 输入音频听录的配置，默认设置为关闭，并且可以设置为 null 关闭一次。 输入音频听录不是模型的本机内容，因为模型直接使用音频。 听 录通过听录终结点 异步运行，应被视为输入音频内容的指南，而不是模型听到的内容。 客户端可以选择设置语言并提示听录，这些语言为听录服务提供其他指导。
 No
└─ language 字符串 输入音频的语言。 以 ISO-639-1 （例如 en）格式提供输入语言可提高准确性和延迟。
 No
└─ model 字符串 用于听录的模型，当前选项为 gpt-4o-transcribe、 gpt-4o-transcribe-diarize、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15和 whisper-1。
 No
└─ prompt 字符串 用于指导模型样式或继续上一个音频段的可选文本。
对于 whisper-1，提示是关键字列表。
对于 gpt-4o-transcribe 模型，提示是一个自由文本字符串，例如“预期与技术相关的字词”。
 No
instructions 字符串 模型调用前的默认系统指令（即系统消息）。 此字段允许客户端指导模型处理所需的响应。 可以指示模型响应内容和格式（例如“非常简洁”、“行为友好”、“下面是良好响应的示例”）和音频行为（例如“快速说话”、“将情感注入语音”、“经常笑”）。 这些说明不保证遵循模型，但它们为模型提供有关所需行为的指南。

请注意，如果未设置此字段并在会话开始时在事件中 session.created 可见，服务器将设置默认说明。
 No
max_response_output_tokens 整数或字符串 单个助理响应（包括工具调用）的最大输出令牌数。 提供介于 1 和 4096 之间的整数来限制输出令牌，或者 inf 提供给定模型的最大可用令牌。 默认值为 inf.
 No
modalities 模型可以响应的一组形式。 若要禁用音频，请将此项设置为 [“text”]。
 No
模型 字符串 用于此会话的部署的名称。
 No
output_audio_format 枚举 输出音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
对于 pcm16，输出音频的采样速率为 24kHz。

可能的值：pcm16、、 g711_ulawg711_alaw		 No
temperature number 模型的采样温度限制为 [0.6， 1.2]。 对于音频模型，强烈建议将温度为 0.8，以获得最佳性能。
 No 0.8
tool_choice 字符串 模型如何选择工具。 选项为 auto、 none或 required指定函数。
 No auto
tools 数组 可用于模型的工具（函数）。 No
turn_detection 对象 用于轮次检测、以太网 VAD 或语义 VAD 的配置。 这可以设置为 null 关闭，在这种情况下，客户端必须手动触发模型响应。
服务器 VAD 表示模型将基于音频音量检测语音的开始和结束，并在用户语音结束时做出响应。
语义 VAD 更高级，使用轮次检测模型（与 VAD 结合使用）以语义方式估计用户是否已完成说话，然后根据此概率动态设置超时。 例如，如果用户音频离开， uhhm模型将得分低的轮次结束概率，并等待更长的用户继续说话。 这对于更自然的对话非常有用，但延迟可能更高。
 No
└─ create_response boolean 是否在发生 VAD 停止事件时自动生成响应。
 No True
└─ eagerness 枚举 仅用于 semantic_vad 模式。 模型渴望做出响应。 low 将等待更长的用户继续说话， high 将更快地响应。 auto 是默认值，等效于 medium。

可能的值：low、、medium、 highauto		 No
└─ interrupt_response boolean 在发生 VAD 启动事件时，是否自动中断任何持续响应，并将输出到默认会话（即 conversationauto） 中。
 No True
└─ prefix_padding_ms 整数 仅用于 server_vad 模式。 VAD 检测到语音之前要包括的音频量（以毫秒为单位）。 默认为 300 毫秒。
 No
└─ silence_duration_ms 整数 仅用于 server_vad 模式。 用于检测语音停止的沉默持续时间（以毫秒为单位）。 默认值为 500 毫秒。 使用较短的值，模型将更快地响应，但可能会从用户短暂暂停时跳入。
 No
└─ threshold number 仅用于 server_vad 模式。 VAD（0.0 到 1.0）的激活阈值，默认为 0.5。 更高的阈值需要更响亮的音频来激活模型，因此在干扰环境中性能可能更好。
 No
└─ type 枚举 轮次检测的类型。

可能的值： server_vadsemantic_vad		 No
voice VoiceIdsShared No

Responses

状态代码： 200

说明：已成功创建会话。

Content-Type Type Description
application/json RealtimeSessionCreateResponse

创建 - Transcriptionrealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

创建临时 API 令牌，以便在客户端应用程序中使用实时 API，专门用于实时听录。 可以使用与客户端事件相同的会话参数进行 transcription_session.update 配置。 它使用会话对象进行响应，以及 client_secret 包含可用于对实时 API 的浏览器客户端进行身份验证的可用临时 API 令牌的密钥。

Request Body

Content-Type: application/json

Name 类型 Description Required Default
include 数组 要包含在听录中的项集。 当前可用的项包括：
- item.input_audio_transcription.logprobs
 No
input_audio_format 枚举 输入音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
对于 pcm16，输入音频必须采用 24kHz 采样率、单声道（单声道）和小端字节顺序的 16 位 PCM。

可能的值：pcm16、、 g711_ulawg711_alaw		 No
input_audio_noise_reduction 对象 输入音频降噪的配置。 这可以设置为 null 关闭。
降噪会筛选添加到输入音频缓冲区的音频，然后再将其发送到 VAD 和模型。
筛选音频可以通过改进输入音频的感知来提高 VAD 和轮次检测准确性（减少误报）和模型性能。
 No
└─ type 枚举 降噪类型。 near_field 用于近距离麦克风（如耳机）， far_field 适用于远场麦克风，例如笔记本电脑或会议室麦克风。

可能的值： near_fieldfar_field		 No
input_audio_transcription 对象 输入音频听录的配置。 客户端可以选择设置语言并提示听录，这些语言为听录服务提供其他指导。
 No
└─ language 字符串 输入音频的语言。 以 ISO-639-1 （例如 en）格式提供输入语言可提高准确性和延迟。
 No
└─ model 枚举 用于听录的模型，当前选项是gpt-4o-transcribe，gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15和whisper-1。

可能的值：gpt-4o-transcribe、、gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15whisper-1		 No
└─ prompt 字符串 用于指导模型样式或继续上一个音频段的可选文本。
对于 whisper-1，提示是关键字列表。
对于 gpt-4o-transcribe 模型，提示是一个自由文本字符串，例如“预期与技术相关的字词”。
 No
modalities 模型可以响应的一组形式。 若要禁用音频，请将此项设置为 [“text”]。
 No
turn_detection 对象 用于轮次检测、以太网 VAD 或语义 VAD 的配置。 这可以设置为 null 关闭，在这种情况下，客户端必须手动触发模型响应。
服务器 VAD 表示模型将基于音频音量检测语音的开始和结束，并在用户语音结束时做出响应。
语义 VAD 更高级，使用轮次检测模型（与 VAD 结合使用）以语义方式估计用户是否已完成说话，然后根据此概率动态设置超时。 例如，如果用户音频离开， uhhm模型将得分低的轮次结束概率，并等待更长的用户继续说话。 这对于更自然的对话非常有用，但延迟可能更高。
 No
└─ create_response boolean 是否在发生 VAD 停止事件时自动生成响应。 不适用于听录会话。
 No True
└─ eagerness 枚举 仅用于 semantic_vad 模式。 模型渴望做出响应。 low 将等待更长的用户继续说话， high 将更快地响应。 auto 是默认值，等效于 medium。

可能的值：low、、medium、 highauto		 No
└─ interrupt_response boolean 在发生 VAD 启动事件时，是否自动中断任何持续响应，并将输出到默认会话（即 conversationauto） 中。 不适用于听录会话。
 No True
└─ prefix_padding_ms 整数 仅用于 server_vad 模式。 VAD 检测到语音之前要包括的音频量（以毫秒为单位）。 默认为 300 毫秒。
 No
└─ silence_duration_ms 整数 仅用于 server_vad 模式。 用于检测语音停止的沉默持续时间（以毫秒为单位）。 默认值为 500 毫秒。 使用较短的值，模型将更快地响应，但可能会从用户短暂暂停时跳入。
 No
└─ threshold number 仅用于 server_vad 模式。 VAD（0.0 到 1.0）的激活阈值，默认为 0.5。 更高的阈值需要更响亮的音频来激活模型，因此在干扰环境中性能可能更好。
 No
└─ type 枚举 轮次检测的类型。

可能的值： server_vadsemantic_vad		 No

Responses

状态代码： 200

说明：已成功创建会话。

Content-Type Type Description
application/json RealtimeTranscriptionSessionCreateResponse

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

创建模型响应。

Request Body

Content-Type: application/json

Name 类型 Description Required Default
include 数组 No
输入 字符串或数组 Model inputs Yes
instructions 字符串 将系统（或开发人员）消息作为模型上下文中的第一项插入。

与之前响应一起使用 previous_response_id时，不会将上一个响应中的说明转交给下一个响应。 这样就可以轻松地在新响应中交换系统（或开发人员）消息。
 No
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和会话状态。
 No
parallel_tool_calls boolean 是否允许模型并行运行工具调用。
 No True
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此方法可创建多轮次对话。 了解有关聊天状态的详细信息。
 No
reasoning Reasoning 推理模型的配置选项。 No
存储 boolean 是否存储生成的模型响应，以便以后通过 API 进行检索。
 No True
数据流 boolean 如果设置为 true，模型响应数据将流式传输到客户端，因为它使用 服务器发送的事件生成。
有关详细信息，请参阅下面的“流式处理”部分。
 No False
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯文本或结构化 JSON 数据。 Learn more:
- 文本输入和输出
- 结构化输出		 No
└─ format TextResponseFormatConfiguration 一个对象，指定模型必须输出的格式。

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

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

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

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。 对于支持它的模型，首选使用 json_schema 。
 No
tool_choice ToolChoiceOptions 或 ToolChoiceTypes 或 ToolChoiceFunction 模型在生成响应时应如何选择要使用的工具（或工具）。 请参阅参数 tools ，了解如何指定模型可以调用的工具。
 No
tools 数组 生成响应时，模型可能会调用的工具数组。 可以通过设置 tool_choice 参数来指定要使用的工具。

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

- 内置工具：OpenAI 提供的工具，用于扩展
model's capabilities		 No
truncation 枚举 要用于模型响应的截断策略。
- auto：如果此响应的上下文和以前的上下文超出模型的上下文窗口大小，则模型将通过删除会话中间的输入项来截断响应以适应上下文窗口。
- disabled （默认值）：如果模型响应将超过模型的上下文窗口大小，则请求将失败并出现 400 错误。

可能的值： autodisabled		 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json response
text/event-stream responseStreamEvent

状态代码： 默认值

说明：服务不可用

Content-Type Type Description
application/json errorResponse

响应 API - 输入项

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
response_id 路径 Yes 字符串 要检索的响应的 ID。
include 查询 No 数组 要包含在响应中的其他字段。 有关详细信息， include 请参阅上述响应创建参数。

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json response

状态代码： 默认值

说明：服务不可用

Content-Type Type Description
application/json errorResponse

Delete response

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

删除具有给定 ID 的模型响应。

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
response_id 路径 Yes 字符串 要删除的响应的 ID。

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

状态代码： 404

说明：找不到

Content-Type Type Description
application/json error

状态代码： 默认值

说明：服务不可用

Content-Type Type Description
application/json errorResponse

响应 API - 响应项列表

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

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

URI Parameters

Name In Required 类型 Description
终结点 路径 Yes string url 支持的 Azure OpenAI 终结点（协议和主机名，例如： https://aoairesource.openai.azure.com。将“aoairesource”替换为 Azure OpenAI 资源名称。 https://{your-resource-name}.openai.azure.com
response_id 路径 Yes 字符串 要检索其输入项的响应的 ID。
limit 查询 No 整数 要返回的对象数的限制。 限制可以介于 1 和 100 之间，默认值为 20。
顺序 查询 No 字符串
可能的值： ascdesc		 要返回输入项的顺序。 默认值为 asc.
- asc：按升序返回输入项。
- desc：按降序返回输入项。
after 查询 No 字符串 用于列出分页后项的项 ID。
before 查询 No 字符串 之前用于列出项的项 ID，用于分页。

Request Header

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

Name Required 类型 Description
Authorization True 字符串 Example:Authorization: Bearer {Azure_OpenAI_Auth_Token}

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

Type: oauth2
授权 URL： https://login.microsoftonline.com/common/oauth2/v2.0/authorize
范围： https://ai.azure.com/.default
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json responseItemList

Components

errorResponse

Name 类型 Description Required Default
错误 error No

errorBase

Name 类型 Description Required Default
代码 字符串 No
消息 字符串 No

错误

Name 类型 Description Required Default
inner_error innerError 具有其他详细信息的内部错误。 No
param 字符串 No
类型 字符串 No

innerError

具有其他详细信息的内部错误。

Name 类型 Description Required Default
代码 innerErrorCode 内部错误对象的错误代码。 No
content_filter_results contentFilterPromptResults 如果检测到内容筛选类别（仇恨、性、暴力、self_harm），以及严重性级别（very_low、低、中、大规模，用于确定有害内容的强度和风险级别），以及它是否已筛选或未筛选。 有关越狱内容和亵渎内容的信息（如果已检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。 No

innerErrorCode

内部错误对象的错误代码。

Property Value
Description 内部错误对象的错误代码。
Type 字符串
Values ResponsibleAIPolicyViolation

dalleErrorResponse

Name 类型 Description Required Default
错误 dalleError No

dalleError

Name 类型 Description Required Default
inner_error dalleInnerError 具有其他详细信息的内部错误。 No
param 字符串 No
类型 字符串 No

dalleInnerError

具有其他详细信息的内部错误。

Name 类型 Description Required Default
代码 innerErrorCode 内部错误对象的错误代码。 No
content_filter_results dalleFilterResults 如果检测到内容筛选类别（仇恨、性、暴力、self_harm），以及严重性级别（very_low、低、中、大规模，用于确定有害内容的强度和风险级别），以及它是否已筛选或未筛选。 有关越狱内容和亵渎内容的信息（如果已检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。 No
revised_prompt 字符串 用于生成映像的提示（如果有对提示的任何修订）。 No

contentFilterCompletionTextSpan

描述生成的完成文本中的范围。 偏移量 0 是完成文本的第一个 UTF32 代码点。

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

contentFilterResultBase

Name 类型 Description Required Default
filtered boolean Yes

contentFilterSeverityResult

Name 类型 Description Required Default
filtered boolean Yes
severity 字符串 No

contentFilterDetectedResult

Name 类型 Description Required Default
detected boolean No
filtered boolean Yes

contentFilterDetectedWithCitationResult

Name 类型 Description Required Default
citation 对象 No
└─ URL 字符串 No
└─ license 字符串 No

contentFilterDetectedWithCompletionTextSpansResult

Name 类型 Description Required Default
details 数组 No

contentFilterIdResult

Name 类型 Description Required Default
filtered boolean Yes
id 字符串 No

contentFilterResultsBase

有关内容筛选结果的信息。

Name 类型 Description Required Default
custom_blocklists contentFilterDetailedResults 包含筛选段内容筛选器 ID 的详细信息的内容筛选结果。 No
错误 errorBase No
hate contentFilterSeverityResult No
profanity contentFilterDetectedResult No
self_harm contentFilterSeverityResult No
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No

contentFilterPromptResults

如果检测到内容筛选类别（仇恨、性、暴力、self_harm），以及严重性级别（very_low、低、中、大规模，用于确定有害内容的强度和风险级别），以及它是否已筛选或未筛选。 有关越狱内容和亵渎内容的信息（如果已检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。

Name 类型 Description Required Default
custom_blocklists contentFilterDetailedResults 包含筛选段内容筛选器 ID 的详细信息的内容筛选结果。 No
错误 errorBase No
hate contentFilterSeverityResult No
indirect_attack contentFilterDetectedResult No
jailbreak contentFilterDetectedResult No
profanity contentFilterDetectedResult No
self_harm contentFilterSeverityResult No
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No

contentFilterChoiceResults

如果检测到内容筛选类别（仇恨、性、暴力、self_harm），以及严重性级别（very_low、低、中、大规模，用于确定有害内容的强度和风险级别），以及它是否已筛选或未筛选。 有关第三方文本和不雅内容的信息（如果检测到）以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。

Name 类型 Description Required Default
custom_blocklists contentFilterDetailedResults 包含筛选段内容筛选器 ID 的详细信息的内容筛选结果。 No
错误 errorBase No
hate contentFilterSeverityResult No
profanity contentFilterDetectedResult No
protected_material_code contentFilterDetectedWithCitationResult No
protected_material_text contentFilterDetectedResult No
self_harm contentFilterSeverityResult No
sexual contentFilterSeverityResult No
ungrounded_material contentFilterDetectedWithCompletionTextSpansResult No
violence contentFilterSeverityResult No

contentFilterDetailedResults

包含筛选段内容筛选器 ID 的详细信息的内容筛选结果。

Name 类型 Description Required Default
details 数组 No
filtered boolean Yes

promptFilterResult

请求中单个提示的内容筛选结果。

Name 类型 Description Required Default
content_filter_results contentFilterPromptResults 如果检测到内容筛选类别（仇恨、性、暴力、self_harm），以及严重性级别（very_low、低、中、大规模，用于确定有害内容的强度和风险级别），以及它是否已筛选或未筛选。 有关越狱内容和亵渎内容的信息（如果已检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。 No
prompt_index 整数 No

promptFilterResults

请求中零个或多个提示的内容筛选结果。 在流式处理请求中，不同提示的结果可能以不同的时间或不同的顺序到达。

未为此组件定义任何属性。

dalleContentFilterResults

有关内容筛选结果的信息。

Name 类型 Description Required Default
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No

dalleFilterResults

如果检测到内容筛选类别（仇恨、性、暴力、self_harm），以及严重性级别（very_low、低、中、大规模，用于确定有害内容的强度和风险级别），以及它是否已筛选或未筛选。 有关越狱内容和亵渎内容的信息（如果已检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。

Name 类型 Description Required Default
custom_blocklists contentFilterDetailedResults 包含筛选段内容筛选器 ID 的详细信息的内容筛选结果。 No
hate contentFilterSeverityResult No
jailbreak contentFilterDetectedResult No
profanity contentFilterDetectedResult No
self_harm contentFilterSeverityResult No
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No

chatCompletionsRequestCommon

Name 类型 Description Required Default
frequency_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据文本中的现有频率惩罚新令牌，从而减少模型重复相同行的可能性。 No 0
logit_bias 对象 修改指定令牌在完成中出现的可能性。 接受 json 对象，该对象将标记（由令牌 ID 在 tokenizer 中指定）映射到从 -100 到 100 的关联偏差值。 从数学上看，偏差将添加到模型在采样之前生成的对数。 具体效果因模型而异，但 -1 和 1 之间的值应减少或增加选择的可能性;-100 或 100 等值应导致相关令牌的禁止或独占选择。 No
max_completion_tokens 整数 可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 No
max_tokens 整数 所生成答案允许的最大令牌数。 默认情况下，模型可以返回的令牌数将为 （4096 - 提示令牌）。 这与 o1 系列模型不兼容。 No 4096
元数据 对象 开发人员定义的标记和值，用于筛选存储的完成仪表板中的完成。 No
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。 No 0
stop 字符串或数组 API 停止生成进一步令牌的最多 4 个序列。 No
存储 boolean 是否存储此聊天完成请求的输出，以便在模型提取或评估产品中使用。 No
数据流 boolean 如果已设置，则发送部分消息增量，如在 ChatGPT 中一样。 令牌在可用时作为仅数据服务器发送的事件发送，流由 data: [DONE] 消息终止。 No False
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
我们通常建议更改这一点， top_p 但不建议同时更改这两者。		 No 1
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。
我们通常建议更改这一点， temperature 但不建议同时更改这两者。		 No 1
用户 字符串 表示最终用户的唯一标识符，可帮助 Azure OpenAI 监视和检测滥用行为。 No

createCompletionRequest

Name 类型 Description Required Default
best_of 整数 生成 best_of 完成服务器端并返回“最佳”（每个标记具有最高对数概率的完成项）。 无法流式传输结果。

使用 n时， best_of 控制候选完成次数，并 n 指定要返回的次数。 best_of 必须大于 n。

注意： 由于此参数会生成许多完成，因此可以快速使用令牌配额。 仔细使用并确保你具有合理的设置 max_tokens 和 stop。
 No 1
echo boolean 除了完成之外，还回显提示
 No False
frequency_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据文本中的现有频率惩罚新令牌，从而减少模型重复相同行的可能性。
 No 0
logit_bias 对象 修改指定令牌在完成中出现的可能性。

接受 JSON 对象，该对象将令牌（由 GPT tokenizer 中的令牌 ID 指定）映射到从 -100 到 100 的关联偏差值。 从数学上看，偏差将添加到模型在采样之前生成的对数。 具体效果因模型而异，但 -1 和 1 之间的值应减少或增加选择的可能性;-100 或 100 等值应导致相关令牌的禁止或独占选择。

例如，可以传递 {"50256": -100} 以防止 <生成 |endoftext|> 令牌。
 No None
logprobs 整数 在最有可能的输出标记上包括对数概率 logprobs ，以及所选的标记。 例如，如果 logprobs 为 5，API 将返回 5 个最有可能的令牌的列表。 API 将始终返回 logprob 采样令牌，因此响应中可能最多有 logprobs+1 元素。

最大值 logprobs 为 5。
 No None
max_tokens 整数 可以在完成时生成的最大令牌数。

提示的令牌计数加上 max_tokens 不能超过模型的上下文长度。		 No 16
n 整数 要为每个提示生成的完成次数。

注意： 由于此参数会生成许多完成，因此可以快速使用令牌配额。 仔细使用并确保你具有合理的设置 max_tokens 和 stop。
 No 1
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。
 No 0
提示 字符串或数组 要为其生成完成的提示，编码为字符串、字符串数组、令牌数组或令牌数组数组。

请注意， <|endoftext|> 是模型在训练期间看到的文档分隔符，因此如果未指定提示，模型将生成，就像从新文档的开头一样。
 Yes
seed 整数 如果指定，我们的系统会尽最大努力确定性地采样，这样，具有相同 seed 参数的重复请求应返回相同的结果。

无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。
 No
stop 字符串或数组 API 停止生成进一步令牌的最多 4 个序列。 返回的文本不包含停止序列。
 No
数据流 boolean 是否回流式传输部分进度。 如果已设置，则令牌在可用时以仅数据 服务器发送的事件的形式发送 ，流由 data: [DONE] 消息终止。 Python 代码示例。
 No False
suffix 字符串 插入的文本完成后的后缀。

此参数仅受支持 gpt-3.5-turbo-instruct。
 No None
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。

我们通常建议更改这一点， top_p 但不建议同时更改这两者。
 No 1
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。
 No 1
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。
 No

createCompletionResponse

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

Name 类型 Description Required Default
choices 数组 为输入提示生成的模型完成选项的列表。 Yes
created 整数 创建完成时间的 Unix 时间戳（以秒为单位）。 Yes
id 字符串 完成的唯一标识符。 Yes
模型 字符串 用于完成的模型。 Yes
对象 枚举 对象类型，始终为“text_completion”
可能的值： text_completion		 Yes
prompt_filter_results promptFilterResults 请求中零个或多个提示的内容筛选结果。 在流式处理请求中，不同提示的结果可能以不同的时间或不同的顺序到达。 No
system_fingerprint 字符串 此指纹表示模型运行的后端配置。

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

createChatCompletionRequest

Name 类型 Description Required Default
audio 对象 音频输出的参数。 当使用 .. 请求 modalities: ["audio"]音频输出时是必需的。 No
└─ format 枚举 指定输出音频格式。 必须是 、wavmp3、 flacopus或pcm16之一。

可能的值：wav、、mp3flac、opus、pcm16		 No
└─ voice 枚举 指定语音类型。 支持的语音包括alloy、echo、fable、onyx和novashimmer。

可能的值：alloy、、echo、fableonyx、nova、shimmer		 No
data_sources 数组 使用它们的 Azure OpenAI 聊天扩展的配置条目。
此附加规范仅与 Azure OpenAI 兼容。		 No
frequency_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据文本中的现有频率惩罚新令牌，从而减少模型重复相同行的可能性。
 No 0
function_call string 或 chatCompletionFunctionCallOption 弃用赞成 tool_choice。

控制模型调用哪个（如果有）函数。
none 表示模型不会调用函数，而是生成消息。
auto 表示模型可以在生成消息或调用函数之间进行选择。
通过 {"name": "my_function"} 强制模型调用该函数来指定特定函数。

none 如果没有函数，则为默认值。 auto 如果存在函数，则为默认值。
 No
functions 数组 弃用赞成 tools。

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

接受 JSON 对象，该对象将令牌（由令牌 ID 在 tokenizer 中指定）映射到从 -100 到 100 的关联偏差值。 从数学上看，偏差将添加到模型在采样之前生成的对数。 具体效果因模型而异，但 -1 和 1 之间的值应减少或增加选择的可能性;-100 或 100 等值应导致相关令牌的禁止或独占选择。
 No None
logprobs boolean 是否返回输出令牌的对数概率。 如果为 true，则返回在以下content项中message返回的每个输出令牌的对数概率。 No False
max_completion_tokens 整数 可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 No
max_tokens 整数 可在聊天完成中生成的最大令牌数。

输入令牌和生成的令牌的总长度受模型的上下文长度限制。		 No
messages 数组 到目前为止，包含对话的消息列表。 Python 代码示例。 Yes
元数据 对象 开发人员定义的标记和值，用于筛选存储的完成仪表板中的完成。 No
modalities ChatCompletionModalities 希望模型为此请求生成的输出类型。
大多数模型都能够生成文本，这是默认值：

["text"]

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

["text", "audio"]
 No
n 整数 要为每个输入消息生成的聊天完成选项数。 请注意，将根据所有选项中生成的令牌数向你收费。 n尽量1降低成本。 No 1
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
预测 PredictionContent 预测输出的配置，当模型响应的大部分内容提前已知时，可以大大改善响应时间。 在重新生成仅对大部分内容进行轻微更改的文件时，这是最常见的。 No
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。
 No 0
reasoning_effort 枚举 仅限 o1 模型

限制推理模型的推理工作。

当前支持的值是 low， medium以及 high。 减少推理工作量可能会导致响应更快，在响应中用于推理的令牌更少。
可能的值：low、、 mediumhigh		 No
response_format ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema 一个对象，指定模型必须输出的格式。 与 GPT-4o、 GPT-4o mini、 GPT-4 Turbo 和所有 GPT-3.5 Turbo 型号兼容 gpt-3.5-turbo-1106。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，用于保证模型与提供的 JSON 架构匹配。

{ "type": "json_object" }设置为启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。
 No
seed 整数 此功能在 Beta 版中。
如果指定，我们的系统会尽最大努力确定性地采样，这样，具有相同 seed 参数的重复请求应返回相同的结果。
无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。
 No
stop 字符串或数组 API 停止生成进一步令牌的最多 4 个序列。
 No
存储 boolean 是否存储此聊天完成请求的输出，以便在模型提取或评估产品中使用。 No
数据流 boolean 如果已设置，则发送部分消息增量，如在 ChatGPT 中一样。 令牌在可用时作为仅数据 服务器发送的事件 发送，流由 data: [DONE] 消息终止。 Python 代码示例。
 No False
stream_options chatCompletionStreamOptions 流式处理响应的选项。 仅在设置时设置 stream: true此设置。
 No None
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。

我们通常建议更改这一点， top_p 但不建议同时更改这两者。
 No 1
tool_choice chatCompletionToolChoiceOption 控制模型调用哪个（如果有）工具。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。 通过 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具来指定特定工具。 none 如果没有工具，则为默认值。 auto 如果存在工具，则为默认值。 No
tools 数组 模型可以调用的工具列表。 目前，仅支持函数作为工具。 使用此函数提供模型可能会为其生成 JSON 输入的函数列表。 最多支持 128 个函数。
 No
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 如果使用此参数，则必须设置为 < No
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

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

userSecurityContext

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

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

chatCompletionFunctions

Name 类型 Description Required Default
description 字符串 模型用来选择何时以及如何调用函数的说明。 No
name 字符串 要调用的函数的名称。 必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。 Yes
parameters FunctionParameters 函数接受的参数，描述为 JSON 架构对象。 有关格式的文档，请参阅示例指南和 JSON 架构参考。

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

chatCompletionFunctionCallOption

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

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

chatCompletionFunctionParameters

函数接受的参数，描述为 JSON 架构对象。 有关格式的文档，请参阅 指南/ 示例和 JSON 架构参考 。

未为此组件定义任何属性。

chatCompletionRequestMessage

此组件可以是下列组件之一：

ChatCompletionRequestDeveloperMessage

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

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

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

chatCompletionRequestAssistantMessage

Name 类型 Description Required Default
内容 字符串或数组 助理消息的内容。 除非 tool_calls 指定或 function_call 指定，否则是必需的。
 No
function_call 对象 已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。 No
└─ arguments 字符串 使用 JSON 格式的模型生成的用于调用函数的参数。 请注意，模型并不总是生成有效的 JSON，并且可能会使函数架构未定义的参数幻觉。 在调用函数之前验证代码中的参数。 No
└─ name 字符串 要调用的函数的名称。 No
name 字符串 参与者的可选名称。 提供模型信息，以区分同一角色的参与者。 No
refusal 字符串 助理发出的拒绝信息。 No
角色 枚举 消息作者的角色，在本例 assistant中。
可能的值： assistant		 Yes
tool_calls chatCompletionMessageToolCalls 模型生成的工具调用，例如函数调用。 No

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestDeveloperMessageContentPart

此组件可以是下列组件之一：

chatCompletionRequestSystemMessageContentPart

此组件可以是下列组件之一：

chatCompletionRequestUserMessageContentPart

此组件可以是下列组件之一：

chatCompletionRequestAssistantMessageContentPart

此组件可以是下列组件之一：

chatCompletionRequestToolMessageContentPart

此组件可以是下列组件之一：

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartAudio

Name 类型 Description Required Default
input_audio 对象 Yes
└─ data 字符串 Base64 编码的音频数据。 No
└─ format 枚举 编码的音频数据的格式。 目前支持“wav”和“mp3”。

可能的值： wavmp3		 No
类型 枚举 内容部件的类型。 始终 input_audio。
可能的值： input_audio		 Yes

chatCompletionRequestMessageContentPartImage

Name 类型 Description Required Default
image_url 对象 Yes
└─ detail 枚举 指定图像的详细信息级别。 在 视觉指南中了解详细信息。
可能的值：auto、、 lowhigh		 No
└─ url 字符串 图像的 URL 或 base64 编码的图像数据。 No
类型 枚举 内容部件的类型。
可能的值： image_url		 Yes

chatCompletionRequestMessageContentPartRefusal

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

azureChatExtensionConfiguration

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

###azureChatExtensionConfiguration的判别器

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

Type Value Schema
azure_search azureSearchChatExtensionConfiguration
azure_cosmos_db azureCosmosDBChatExtensionConfiguration
elasticsearch elasticsearchChatExtensionConfiguration
mongo_db mongoDBChatExtensionConfiguration
pinecone pineconeChatExtensionConfiguration
Name 类型 Description Required Default
类型 azureChatExtensionType 单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天完成请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。
使用此配置仅与 Azure OpenAI 兼容。		 Yes

azureChatExtensionType

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

Property Value
Description 单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天完成请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。
使用此配置仅与 Azure OpenAI 兼容。
Type 字符串
Values azure_search
azure_cosmos_db
elasticsearch
mongo_db
pinecone

azureSearchChatExtensionConfiguration

将 Azure 搜索用作 Azure OpenAI 聊天扩展时可配置选项的特定表示形式。

Name 类型 Description Required Default
parameters azureSearchChatExtensionParameters 用作 Azure OpenAI 聊天扩展时 Azure 搜索的参数。 No
类型 azureChatExtensionType 单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天完成请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。
使用此配置仅与 Azure OpenAI 兼容。		 Yes

azureSearchChatExtensionParameters

用作 Azure OpenAI 聊天扩展时 Azure 搜索的参数。

Name 类型 Description Required Default
allow_partial_result boolean 如果指定为 true，系统将允许使用部分搜索结果，如果所有查询都失败，请求将失败。 如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。 No False
身份验证 onYourDataApiKeyAuthenticationOptions 或 onYourDataSystemAssignedManagedIdentityAuthenticationOptions 或 onYourDataUserAssignedManagedIdentityAuthenticationOptions 或 onYourDataAccessTokenAuthenticationOptions Yes
embedding_dependency onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource 或 onYourDataIntegratedVectorizationSource No
终结点 字符串 要使用的 Azure 搜索资源的绝对终结点路径。 Yes
fields_mapping azureSearchIndexFieldMappingOptions 用于控制使用配置的 Azure 搜索资源时如何处理字段的可选设置。 No
筛选器 字符串 Search filter. No
in_scope boolean 是否应将查询限制为使用索引数据。 No
include_contexts 数组 输出上下文的包含属性。 如果未指定，则默认值为 citations 和 intent。 No
index_name 字符串 要用作引用的 Azure 搜索资源中可用的索引的名称。 Yes
max_search_queries 整数 应向搜索提供程序发送一条用户消息的最大重写查询数。 如果未指定，系统将决定要发送的查询数。 No
query_type azureSearchQueryType 应将其用作 Azure OpenAI 聊天扩展时执行的 Azure 搜索检索查询的类型。 No
semantic_configuration 字符串 查询的其他语义配置。 No
strictness 整数 搜索相关性筛选的配置严格性。 严格程度越高，精度越高，但对答案的召回率较低。 No
top_n_documents 整数 配置为用于配置查询的最多文档数。 No

azureSearchIndexFieldMappingOptions

用于控制使用配置的 Azure 搜索资源时如何处理字段的可选设置。

Name 类型 Description Required Default
content_fields 数组 应被视为内容的索引字段的名称。 No
content_fields_separator 字符串 内容字段应使用的分隔符模式。 No
filepath_field 字符串 要用作文件路径的索引字段的名称。 No
image_vector_fields 数组 表示图像矢量数据的字段的名称。 No
title_field 字符串 要用作标题的索引字段的名称。 No
url_field 字符串 要用作 URL 的索引字段的名称。 No
vector_fields 数组 表示向量数据的字段的名称。 No

azureSearchQueryType

应将其用作 Azure OpenAI 聊天扩展时执行的 Azure 搜索检索查询的类型。

Property Value
Description 应将其用作 Azure OpenAI 聊天扩展时执行的 Azure 搜索检索查询的类型。
Type 字符串
Values simple
semantic
vector
vector_simple_hybrid
vector_semantic_hybrid

azureCosmosDBChatExtensionConfiguration

将 Azure Cosmos DB 用作 Azure OpenAI 聊天扩展时，可配置选项的特定表示形式。

Name 类型 Description Required Default
parameters azureCosmosDBChatExtensionParameters 使用 Azure Cosmos DB for MongoDB vCore 配置 Azure OpenAI On Data 聊天扩展时要使用的参数。 No
类型 azureChatExtensionType 单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天完成请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。
使用此配置仅与 Azure OpenAI 兼容。		 Yes

azureCosmosDBChatExtensionParameters

使用 Azure Cosmos DB for MongoDB vCore 配置 Azure OpenAI On Data 聊天扩展时要使用的参数。

Name 类型 Description Required Default
allow_partial_result boolean 如果指定为 true，系统将允许使用部分搜索结果，如果所有查询都失败，请求将失败。 如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。 No False
身份验证 onYourDataConnectionStringAuthenticationOptions 使用连接字符串时，Azure OpenAI On Your Data 的身份验证选项。 Yes
container_name 字符串 Azure Cosmos DB 资源容器的名称。 Yes
database_name 字符串 要用于 Azure Cosmos DB 的 MongoDB vCore 数据库名称。 Yes
embedding_dependency onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource Yes
fields_mapping azureCosmosDBFieldMappingOptions 用于控制使用配置的 Azure Cosmos DB 资源时如何处理字段的可选设置。 Yes
in_scope boolean 是否应将查询限制为使用索引数据。 No
include_contexts 数组 输出上下文的包含属性。 如果未指定，则默认值为 citations 和 intent。 No
index_name 字符串 要用于 Azure Cosmos DB 的 MongoDB vCore 索引名称。 Yes
max_search_queries 整数 应向搜索提供程序发送一条用户消息的最大重写查询数。 如果未指定，系统将决定要发送的查询数。 No
strictness 整数 搜索相关性筛选的配置严格性。 严格程度越高，精度越高，但对答案的召回率较低。 No
top_n_documents 整数 配置为用于配置查询的最多文档数。 No

azureCosmosDBFieldMappingOptions

用于控制使用配置的 Azure Cosmos DB 资源时如何处理字段的可选设置。

Name 类型 Description Required Default
content_fields 数组 应被视为内容的索引字段的名称。 Yes
content_fields_separator 字符串 内容字段应使用的分隔符模式。 No
filepath_field 字符串 要用作文件路径的索引字段的名称。 No
title_field 字符串 要用作标题的索引字段的名称。 No
url_field 字符串 要用作 URL 的索引字段的名称。 No
vector_fields 数组 表示向量数据的字段的名称。 Yes

elasticsearchChatExtensionConfiguration

将 Elasticsearch 用作 Azure OpenAI 聊天扩展时可配置选项的特定表示形式。

Name 类型 Description Required Default
parameters elasticsearchChatExtensionParameters 将 Elasticsearch® 配置为 Azure OpenAI 聊天扩展时要使用的参数。 No
类型 azureChatExtensionType 单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天完成请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。
使用此配置仅与 Azure OpenAI 兼容。		 Yes

elasticsearchChatExtensionParameters

将 Elasticsearch® 配置为 Azure OpenAI 聊天扩展时要使用的参数。

Name 类型 Description Required Default
allow_partial_result boolean 如果指定为 true，系统将允许使用部分搜索结果，如果所有查询都失败，请求将失败。 如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。 No False
身份验证 onYourDataKeyAndKeyIdAuthenticationOptions 或 onYourDataEncodedApiKeyAuthenticationOptions Yes
embedding_dependency onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource 或 onYourDataModelIdVectorizationSource No
终结点 字符串 Elasticsearch 的®终结点。 Yes
fields_mapping elasticsearchIndexFieldMappingOptions 可选设置，用于控制使用配置的 Elasticsearch 资源®时如何处理字段。 No
in_scope boolean 是否应将查询限制为使用索引数据。 No
include_contexts 数组 输出上下文的包含属性。 如果未指定，则默认值为 citations 和 intent。 No
index_name 字符串 Elasticsearch 的®索引名称。 Yes
max_search_queries 整数 应向搜索提供程序发送一条用户消息的最大重写查询数。 如果未指定，系统将决定要发送的查询数。 No
query_type elasticsearchQueryType 作为 Azure OpenAI 聊天扩展时应执行的 Elasticsearch 检索®查询的类型。 No
strictness 整数 搜索相关性筛选的配置严格性。 严格程度越高，精度越高，但对答案的召回率较低。 No
top_n_documents 整数 配置为用于配置查询的最多文档数。 No

elasticsearchIndexFieldMappingOptions

可选设置，用于控制使用配置的 Elasticsearch 资源®时如何处理字段。

Name 类型 Description Required Default
content_fields 数组 应被视为内容的索引字段的名称。 No
content_fields_separator 字符串 内容字段应使用的分隔符模式。 No
filepath_field 字符串 要用作文件路径的索引字段的名称。 No
title_field 字符串 要用作标题的索引字段的名称。 No
url_field 字符串 要用作 URL 的索引字段的名称。 No
vector_fields 数组 表示向量数据的字段的名称。 No

elasticsearchQueryType

作为 Azure OpenAI 聊天扩展时应执行的 Elasticsearch 检索®查询的类型。

Property Value
Description 作为 Azure OpenAI 聊天扩展时应执行的 Elasticsearch 检索®查询的类型。
Type 字符串
Values simple
vector

mongoDBChatExtensionConfiguration

将 Mongo DB 用作 Azure OpenAI 聊天扩展时可配置选项的特定表示形式。

Name 类型 Description Required Default
parameters mongoDBChatExtensionParameters 使用 Mongo DB 在数据聊天扩展上配置 Azure OpenAI 时要使用的参数。 No
类型 azureChatExtensionType 单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天完成请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。
使用此配置仅与 Azure OpenAI 兼容。		 Yes

mongoDBChatExtensionParameters

使用 Mongo DB 在数据聊天扩展上配置 Azure OpenAI 时要使用的参数。

Name 类型 Description Required Default
allow_partial_result boolean 如果指定为 true，系统将允许使用部分搜索结果，如果所有查询都失败，请求将失败。 如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。 No False
app_name 字符串 Mongo DB 应用程序的名称。 Yes
身份验证 onYourDataUsernameAndPasswordAuthenticationOptions 使用用户名和密码时，Azure OpenAI On Your Data 的身份验证选项。 Yes
collection_name 字符串 Mongo DB 集合的名称。 Yes
database_name 字符串 Mongo DB 数据库的名称。 Yes
embedding_dependency onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource Yes
终结点 字符串 Mongo DB 群集终结点的名称。 Yes
fields_mapping mongoDBFieldMappingOptions 用于控制使用配置的 Mongo DB 资源时如何处理字段的可选设置。 Yes
in_scope boolean 是否应将查询限制为使用索引数据。 No
include_contexts 数组 输出上下文的包含属性。 如果未指定，则默认值为 citations 和 intent。 No
index_name 字符串 Mongo DB 索引的名称。 Yes
max_search_queries 整数 应向搜索提供程序发送一条用户消息的最大重写查询数。 如果未指定，系统将决定要发送的查询数。 No
strictness 整数 搜索相关性筛选的配置严格性。 严格程度越高，精度越高，但对答案的召回率较低。 No
top_n_documents 整数 配置为用于配置查询的最多文档数。 No

mongoDBFieldMappingOptions

用于控制使用配置的 Mongo DB 资源时如何处理字段的可选设置。

Name 类型 Description Required Default
content_fields 数组 应被视为内容的索引字段的名称。 Yes
content_fields_separator 字符串 内容字段应使用的分隔符模式。 No
filepath_field 字符串 要用作文件路径的索引字段的名称。 No
title_field 字符串 要用作标题的索引字段的名称。 No
url_field 字符串 要用作 URL 的索引字段的名称。 No
vector_fields 数组 表示向量数据的字段的名称。 Yes

pineconeChatExtensionConfiguration

当将其用作 Azure OpenAI 聊天扩展时，Pinecone 可配置选项的特定表示形式。

Name 类型 Description Required Default
parameters pineconeChatExtensionParameters 用于配置 Azure OpenAI Pinecone 聊天扩展的参数。 No
类型 azureChatExtensionType 单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天完成请求使用，该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。
使用此配置仅与 Azure OpenAI 兼容。		 Yes

pineconeChatExtensionParameters

用于配置 Azure OpenAI Pinecone 聊天扩展的参数。

Name 类型 Description Required Default
allow_partial_result boolean 如果指定为 true，系统将允许使用部分搜索结果，如果所有查询都失败，请求将失败。 如果未指定或指定为 false，则如果任何搜索查询失败，请求将失败。 No False
身份验证 onYourDataApiKeyAuthenticationOptions 使用 API 密钥时，Azure OpenAI On Your Data 的身份验证选项。 Yes
embedding_dependency onYourDataDeploymentNameVectorizationSource 应用矢量搜索时，Azure OpenAI On Your Data 使用的矢量化源的详细信息，该源基于同一 Azure OpenAI 资源中的内部嵌入模型部署名称。 Yes
环境 字符串 Pinecone 的环境名称。 Yes
fields_mapping pineconeFieldMappingOptions 用于控制使用配置的 Pinecone 资源时如何处理字段的可选设置。 Yes
in_scope boolean 是否应将查询限制为使用索引数据。 No
include_contexts 数组 输出上下文的包含属性。 如果未指定，则默认值为 citations 和 intent。 No
index_name 字符串 Pinecone 数据库索引的名称。 Yes
max_search_queries 整数 应向搜索提供程序发送一条用户消息的最大重写查询数。 如果未指定，系统将决定要发送的查询数。 No
strictness 整数 搜索相关性筛选的配置严格性。 严格程度越高，精度越高，但对答案的召回率较低。 No
top_n_documents 整数 配置为用于配置查询的最多文档数。 No

pineconeFieldMappingOptions

用于控制使用配置的 Pinecone 资源时如何处理字段的可选设置。

Name 类型 Description Required Default
content_fields 数组 应被视为内容的索引字段的名称。 Yes
content_fields_separator 字符串 内容字段应使用的分隔符模式。 No
filepath_field 字符串 要用作文件路径的索引字段的名称。 No
title_field 字符串 要用作标题的索引字段的名称。 No
url_field 字符串 要用作 URL 的索引字段的名称。 No

onYourDataAuthenticationOptions

Azure OpenAI On Your Data 的身份验证选项。

onYourDataAuthenticationOptions 的鉴别器

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

Type Value Schema
api_key onYourDataApiKeyAuthenticationOptions
connection_string onYourDataConnectionStringAuthenticationOptions
key_and_key_id onYourDataKeyAndKeyIdAuthenticationOptions
encoded_api_key onYourDataEncodedApiKeyAuthenticationOptions
access_token onYourDataAccessTokenAuthenticationOptions
system_assigned_managed_identity onYourDataSystemAssignedManagedIdentityAuthenticationOptions
user_assigned_managed_identity onYourDataUserAssignedManagedIdentityAuthenticationOptions
username_and_password onYourDataUsernameAndPasswordAuthenticationOptions
Name 类型 Description Required Default
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataContextProperty

上下文属性。

Property Value
Description 上下文属性。
Type 字符串
Values citations
intent
all_retrieved_documents

onYourDataAuthenticationType

Azure OpenAI On Your Data 支持的身份验证类型。

Property Value
Description Azure OpenAI On Your Data 支持的身份验证类型。
Type 字符串
Values api_key
connection_string
key_and_key_id
encoded_api_key
access_token
system_assigned_managed_identity
user_assigned_managed_identity
username_and_password

onYourDataApiKeyAuthenticationOptions

使用 API 密钥时，Azure OpenAI On Your Data 的身份验证选项。

Name 类型 Description Required Default
关键值 字符串 用于身份验证的 API 密钥。 No
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataConnectionStringAuthenticationOptions

使用连接字符串时，Azure OpenAI On Your Data 的身份验证选项。

Name 类型 Description Required Default
connection_string 字符串 用于身份验证的连接字符串。 No
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataKeyAndKeyIdAuthenticationOptions

使用 Elasticsearch 密钥和密钥 ID 对时，Azure OpenAI On Data 的身份验证选项。

Name 类型 Description Required Default
关键值 字符串 用于身份验证的 Elasticsearch 密钥。 No
key_id 字符串 要用于身份验证的 Elasticsearch 密钥 ID。 No
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataEncodedApiKeyAuthenticationOptions

使用 Elasticsearch 编码的 API 密钥时，Azure OpenAI On Your Data 的身份验证选项。

Name 类型 Description Required Default
encoded_api_key 字符串 用于身份验证的 Elasticsearch 编码 API 密钥。 No
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataAccessTokenAuthenticationOptions

使用访问令牌时 Azure OpenAI On Data 的身份验证选项。

Name 类型 Description Required Default
access_token 字符串 用于身份验证的访问令牌。 No
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

使用系统分配的托管标识时，Azure OpenAI On Your Data 的身份验证选项。

Name 类型 Description Required Default
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataUserAssignedManagedIdentityAuthenticationOptions

使用用户分配的托管标识时，Azure OpenAI On Your Data 的身份验证选项。

Name 类型 Description Required Default
managed_identity_resource_id 字符串 要用于身份验证的用户分配托管标识的资源 ID。 No
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes

onYourDataUsernameAndPasswordAuthenticationOptions

使用用户名和密码时，Azure OpenAI On Your Data 的身份验证选项。

Name 类型 Description Required Default
密码 字符串 The password. 用于身份验证。 No
类型 onYourDataAuthenticationType Azure OpenAI On Your Data 支持的身份验证类型。 Yes
用户名 字符串 用于身份验证的用户名。 No

onYourDataVectorizationSource

使用矢量搜索的 Azure OpenAI On Your Data 的向量化源的抽象表示形式。

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

Type Value Schema
endpoint onYourDataEndpointVectorizationSource
deployment_name onYourDataDeploymentNameVectorizationSource
integrated onYourDataIntegratedVectorizationSource
model_id onYourDataModelIdVectorizationSource
Name 类型 Description Required Default
类型 onYourDataVectorizationSourceType 表示 Azure OpenAI On Your Data 可用于配置数据向量化以用于矢量搜索的可用源。 Yes

onYourDataVectorizationSourceType

表示 Azure OpenAI On Your Data 可用于配置数据向量化以用于矢量搜索的可用源。

Property Value
Description 表示 Azure OpenAI On Your Data 可用于配置数据向量化以用于矢量搜索的可用源。
Type 字符串
Values endpoint
deployment_name
integrated
model_id

onYourDataEndpointVectorizationSource

应用矢量搜索时由 Azure OpenAI On Your Data 使用的矢量化源的详细信息，该源基于用于嵌入的公共 Azure OpenAI 终结点调用。

Name 类型 Description Required Default
身份验证 onYourDataApiKeyAuthenticationOptions 或 onYourDataAccessTokenAuthenticationOptions No
dimensions 整数 嵌入应具有的维度数。 仅在以后的模型中受 text-embedding-3 支持。 No
终结点 字符串 指定应从中检索嵌入的资源终结点 URL。 它的格式应为 https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings. 不允许 API 版本查询参数。 No
类型 onYourDataVectorizationSourceType 表示 Azure OpenAI On Your Data 可用于配置数据向量化以用于矢量搜索的可用源。 Yes

onYourDataDeploymentNameVectorizationSource

应用矢量搜索时 Azure OpenAI 对数据使用的向量化源的详细信息，该源基于同一 Azure OpenAI 资源中的内部嵌入模型部署名称。

Name 类型 Description Required Default
deployment_name 字符串 指定要用于矢量化的模型部署的名称。 此模型部署必须位于同一 Azure OpenAI 资源中，但 On Your Data 将通过内部调用而不是公共调用使用此模型部署，从而即使在专用网络中也能实现矢量搜索。 No
dimensions 整数 嵌入应具有的维度数。 仅在以后的模型中受 text-embedding-3 支持。 No
类型 onYourDataVectorizationSourceType 表示 Azure OpenAI On Your Data 可用于配置数据向量化以用于矢量搜索的可用源。 Yes

onYourDataIntegratedVectorizationSource

表示搜索资源中定义的集成向量器。

Name 类型 Description Required Default
类型 onYourDataVectorizationSourceType 表示 Azure OpenAI On Your Data 可用于配置数据向量化以用于矢量搜索的可用源。 Yes

onYourDataModelIdVectorizationSource

应用基于搜索服务模型 ID 的矢量搜索时，Azure OpenAI On Your Data 使用的矢量化源的详细信息。 目前仅 Elasticsearch® 支持。

Name 类型 Description Required Default
model_id 字符串 指定要用于矢量化的模型 ID。 必须在搜索服务中定义此模型 ID。 No
类型 onYourDataVectorizationSourceType 表示 Azure OpenAI On Your Data 可用于配置数据向量化以用于矢量搜索的可用源。 Yes

azureChatExtensionsMessageContext

当 Azure OpenAI 聊天扩展涉及到生成相应的聊天完成响应时可用的附加上下文信息的表示形式。 仅当使用配置为使用匹配扩展的 Azure OpenAI 请求时，才会填充此上下文信息。

Name 类型 Description Required Default
all_retrieved_documents 数组 所有检索到的文档。 No
citations 数组 数据源检索结果，用于在响应中生成助理消息。 No
意向 字符串 聊天历史记录中检测到的意向，用于传递到下一轮，以传递上下文。 No

citation

聊天完成响应消息的引文信息。

Name 类型 Description Required Default
chunk_id 字符串 引文的区块 ID。 No
内容 字符串 引文的内容。 Yes
filepath 字符串 引文的文件路径。 No
rerank_score number 检索的文档的重新曲柄分数。 No
title 字符串 引文的标题。 No
url 字符串 引文的 URL。 No

retrievedDocument

检索的文档。

Name 类型 Description Required Default
chunk_id 字符串 引文的区块 ID。 No
内容 字符串 引文的内容。 Yes
data_source_index 整数 数据源的索引。 No
filepath 字符串 引文的文件路径。 No
filter_reason filterReason 检索的文档的筛选原因。 No
original_search_score number 检索到的文档的原始搜索分数。 No
rerank_score number 检索的文档的重新曲柄分数。 No
search_queries 数组 用于检索文档的搜索查询。 No
title 字符串 引文的标题。 No
url 字符串 引文的 URL。 No

filterReason

检索的文档的筛选原因。

Property Value
Description 检索的文档的筛选原因。
Type 字符串
Values score
rerank

chatCompletionMessageToolCall

Name 类型 Description Required Default
函数 对象 模型调用的函数。 Yes
└─ arguments 字符串 使用 JSON 格式的模型生成的用于调用函数的参数。 请注意，模型并不总是生成有效的 JSON，并且可能会使函数架构未定义的参数幻觉。 在调用函数之前验证代码中的参数。 No
└─ name 字符串 要调用的函数的名称。 No
id 字符串 工具调用的 ID。 Yes
类型 toolCallType 工具调用的类型，在本例 function中。 Yes

toolCallType

工具调用的类型，在本例 function中。

Property Value
Description 工具调用的类型，在本例 function中。
Type 字符串
Values function

chatCompletionRequestMessageTool

Name 类型 Description Required Default
内容 字符串 消息的内容。 No
tool_call_id 字符串 此消息正在响应的工具调用。 No

chatCompletionRequestMessageFunction

Name 类型 Description Required Default
内容 字符串 消息的内容。 No
name 字符串 消息的内容。 No
角色 枚举 消息作者的角色，在本例 function中。
可能的值： function		 No

createChatCompletionResponse

表示模型基于提供的输入返回的聊天完成响应。

Name 类型 Description Required Default
choices 数组 聊天完成选项的列表。 如果 n 大于 1，则可以是多个。 Yes
created 整数 创建聊天完成时间的 Unix 时间戳（以秒为单位）。 Yes
id 字符串 聊天完成的唯一标识符。 Yes
模型 字符串 用于聊天完成的模型。 Yes
对象 枚举 对象类型，始终 chat.completion为 .
可能的值： chat.completion		 Yes
prompt_filter_results promptFilterResults 请求中零个或多个提示的内容筛选结果。 在流式处理请求中，不同提示的结果可能以不同的时间或不同的顺序到达。 No
system_fingerprint 字符串 此指纹表示模型运行的后端配置。

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

createChatCompletionStreamResponse

表示模型基于提供的输入返回的聊天完成响应的流式处理区块。

Name 类型 Description Required Default
choices 数组 聊天完成选项的列表。 如果 n 大于 1，则可以包含多个元素。
 Yes
created 整数 创建聊天完成时间的 Unix 时间戳（以秒为单位）。 每个区块具有相同的时间戳。 Yes
id 字符串 聊天完成的唯一标识符。 每个区块具有相同的 ID。 Yes
模型 字符串 要生成完成的模型。 Yes
对象 枚举 对象类型，始终 chat.completion.chunk为 .
可能的值： chat.completion.chunk		 Yes
system_fingerprint 字符串 此指纹表示模型运行的后端配置。
可以与请求参数结合使用 seed ，以了解后端更改何时发生可能影响确定性。
 No

chatCompletionStreamResponseDelta

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

Name 类型 Description Required Default
内容 字符串 区块消息的内容。 No
function_call 对象 已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。 No
└─ arguments 字符串 使用 JSON 格式的模型生成的用于调用函数的参数。 请注意，模型并不总是生成有效的 JSON，并且可能会使函数架构未定义的参数幻觉。 在调用函数之前验证代码中的参数。 No
└─ name 字符串 要调用的函数的名称。 No
refusal 字符串 模型生成的拒绝消息。 No
角色 枚举 此消息的作者的角色。
可能的值：system、、user、 assistanttool		 No
tool_calls 数组 No

chatCompletionMessageToolCallChunk

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

chatCompletionStreamOptions

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

Name 类型 Description Required Default
include_usage boolean 如果已设置，则会在消息之前 data: [DONE] 流式传输其他区块。 usage此区块上的字段显示整个请求的令牌使用情况统计信息，并且choices该字段始终为空数组。 所有其他区块也将包含一个 usage 字段，但值为 null。
 No

chatCompletionChoiceLogProbs

记录所选的概率信息。

Name 类型 Description Required Default
内容 数组 包含日志概率信息的消息内容令牌列表。 Yes
refusal 数组 包含日志概率信息的消息拒绝令牌列表。 No

chatCompletionTokenLogprob

Name 类型 Description Required Default
bytes 数组 表示令牌的 UTF-8 字节表示形式的整数列表。 在多个标记表示字符及其字节表示形式的实例中非常有用，必须组合这些字符才能生成正确的文本表示形式。 null如果令牌没有字节表示形式，则可以使用。 Yes
logprob number 此标记的对数概率。 Yes
代币 字符串 The token. Yes
top_logprobs 数组 在此标记位置上，最有可能的标记及其对数概率的列表。 在极少数情况下，返回的请求 top_logprobs 数可能少于。 Yes

chatCompletionResponseMessage

模型生成的聊天完成消息。

Name 类型 Description Required Default
audio 对象 如果请求音频输出形式，此对象包含有关模型音频响应的数据。 No
└─ data 字符串 以请求中指定的格式生成的模型生成的 Base64 编码音频字节。
 No
└─ expires_at 整数 在服务器上不再可访问此音频响应的 Unix 时间戳（以秒为单位），以便在多轮对话中使用。
 No
└─ id 字符串 此音频响应的唯一标识符。 No
└─ transcript 字符串 模型生成的音频脚本。 No
内容 字符串 消息的内容。 Yes
上下文 azureChatExtensionsMessageContext 当 Azure OpenAI 聊天扩展涉及到生成相应的聊天完成响应时可用的附加上下文信息的表示形式。 仅当使用配置为使用匹配扩展的 Azure OpenAI 请求时，才会填充此上下文信息。 No
function_call chatCompletionFunctionCall 已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。 No
refusal 字符串 模型生成的拒绝消息。 Yes
角色 chatCompletionResponseMessageRole 响应消息的作者的角色。 Yes
tool_calls 数组 模型生成的工具调用，例如函数调用。 No

chatCompletionResponseMessageRole

响应消息的作者的角色。

Property Value
Description 响应消息的作者的角色。
Type 字符串
Values assistant

chatCompletionToolChoiceOption

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

此组件可以是下列组件之一：

chatCompletionNamedToolChoice

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

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

ParallelToolCalls

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

未为此组件定义任何属性。

PredictionContent

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

Name 类型 Description Required Default
内容 字符串或数组 生成模型响应时应匹配的内容。 如果生成的令牌与此内容匹配，则可以更快地返回整个模型响应。 Yes
类型 枚举 要提供的预测内容的类型。 此类型当前始终 content为 。
可能的值： content		 Yes

chatCompletionMessageToolCalls

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

未为此组件定义任何属性。

ChatCompletionModalities

希望模型为此请求生成的输出类型。 大多数模型都能够生成文本，这是默认值：

["text"]

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

["text", "audio"]

未为此组件定义任何属性。

chatCompletionFunctionCall

已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。

Name 类型 Description Required Default
arguments 字符串 使用 JSON 格式的模型生成的用于调用函数的参数。 请注意，模型并不总是生成有效的 JSON，并且可能会使函数架构未定义的参数幻觉。 在调用函数之前验证代码中的参数。 Yes
name 字符串 要调用的函数的名称。 Yes

completionUsage

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

Name 类型 Description Required Default
completion_tokens 整数 生成的完成中的令牌数。 Yes
completion_tokens_details 对象 完成时使用的令牌明细。 No
└─ accepted_prediction_tokens 整数 使用预测输出时，完成中显示的预测中的标记数。 No
└─ audio_tokens 整数 模型生成的音频输入令牌。 No
└─ reasoning_tokens 整数 由模型生成的令牌进行推理。 No
└─ rejected_prediction_tokens 整数 使用预测输出时，预测中未显示在完成中的标记数。 但是，与推理令牌一样，出于计费、输出和上下文窗口限制的目的，这些令牌仍计入总完成令牌中。 No
prompt_tokens 整数 提示符中的令牌数。 Yes
prompt_tokens_details 对象 提示令牌的详细信息。 No
└─ audio_tokens 整数 提示中存在的音频输入令牌。 No
└─ cached_tokens 整数 缓存的提示令牌数。 No
total_tokens 整数 请求中使用的令牌总数（提示 + 完成）。 Yes

chatCompletionTool

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

FunctionParameters

函数接受的参数，描述为 JSON 架构对象。 有关格式的文档，请参阅示例指南和 JSON 架构参考。

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

未为此组件定义任何属性。

FunctionObject

Name 类型 Description Required Default
description 字符串 模型用来选择何时以及如何调用函数的说明。 No
name 字符串 要调用的函数的名称。 必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。 Yes
parameters FunctionParameters 函数接受的参数，描述为 JSON 架构对象。 有关格式的文档，请参阅示例指南和 JSON 架构参考。

省 parameters 略定义具有空参数列表的函数。		 No
strict boolean 生成函数调用时是否启用严格的架构遵循。 如果设置为 true，则模型将遵循字段中定义的 parameters 确切架构。 仅当为 时stricttrue仅支持 JSON 架构的子集。 No False

ResponseFormatText

Name 类型 Description Required Default
类型 枚举 要定义的响应格式的类型： text
可能的值： text		 Yes

ResponseFormatJsonObject

Name 类型 Description Required Default
类型 枚举 要定义的响应格式的类型： json_object
可能的值： json_object		 Yes

ResponseFormatJsonSchemaSchema

响应格式的架构，描述为 JSON 架构对象。

未为此组件定义任何属性。

ResponseFormatJsonSchema

Name 类型 Description Required Default
json_schema 对象 Yes
└─ description 字符串 模型使用响应格式的说明来确定如何以格式进行响应。 No
└─ name 字符串 响应格式的名称。 必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。 No
└─ schema ResponseFormatJsonSchemaSchema 响应格式的架构，描述为 JSON 架构对象。 No
└─ strict boolean 是否在生成输出时启用严格的架构遵循。 如果设置为 true，则模型将始终遵循字段中定义的 schema 确切架构。 仅当为 时stricttrue仅支持 JSON 架构的子集。 No False
类型 枚举 要定义的响应格式的类型： json_schema
可能的值： json_schema		 Yes

chatCompletionChoiceCommon

Name 类型 Description Required Default
finish_reason 字符串 No
索引 整数 No

createTranslationRequest

Translation request.

Name 类型 Description Required Default
文件 字符串 要翻译的音频文件。 Yes
提示 字符串 用于指导模型样式或继续上一个音频段的可选文本。 提示应为英语。 No
response_format audioResponseFormat 定义输出的格式。 No
temperature number 采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。 如果设置为 0，则模型使用对数概率自动增加温度，直到达到某些阈值。 No 0

audioResponse

json response_format时的翻译或听录响应

Name 类型 Description Required Default
文本消息 字符串 已翻译或转录的文本。 Yes

audioVerboseResponse

response_format verbose_json时翻译或听录响应

Name 类型 Description Required Default
duration number Duration. No
语言 字符串 Language. No
segments 数组 No
任务 字符串 音频任务的类型。 No
文本消息 字符串 已翻译或转录的文本。 Yes
words 数组 No

audioResponseFormat

定义输出的格式。

Property Value
Description 定义输出的格式。
Type 字符串
Values json
text
srt
verbose_json
vtt

createTranscriptionRequest

Transcription request.

Name 类型 Description Required Default
文件 字符串 要转录的音频文件对象。 Yes
语言 字符串 输入音频的语言。 以 ISO-639-1 格式提供输入语言可提高准确性和延迟。 No
提示 字符串 用于指导模型样式或继续上一个音频段的可选文本。 提示应与音频语言匹配。 No
response_format audioResponseFormat 定义输出的格式。 No
temperature number 采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。 如果设置为 0，则模型使用对数概率自动增加温度，直到达到某些阈值。 No 0
timestamp_granularities[] 数组 要为此听录填充的时间戳粒度。 response_format 必须设置为 verbose_json 使用时间戳粒度。 支持以下任一选项或两个选项： word或 segment。 注意：段时间戳没有额外的延迟，但生成单词时间戳会产生额外的延迟。 No ['segment']

audioSegment

听录或翻译段。

Name 类型 Description Required Default
avg_logprob number 平均对数概率。 No
compression_ratio number Compression ratio. No
end number 段结束偏移量。 No
id 整数 Segment identifier. No
no_speech_prob number “无语音”的概率。 No
seek number 段的偏移量。 No
start number 段开始偏移量。 No
temperature number Temperature. No
文本消息 字符串 Segment text. No
tokens 数组 文本的标记。 No

audioWord

听录或翻译单词。

Name 类型 Description Required Default
end number 词尾偏移量。 No
start number Word 开始偏移量。 No
字 字符串 Word No

createSpeechRequest

Speech request.

Name 类型 Description Required Default
输入 字符串 要为其合成音频的文本。 最大长度为 4,096 个字符。 Yes
response_format 枚举 要合成音频的格式。
可能的值：mp3、、opus、aacflac、wav、pcm		 No
speed number 合成音频的速度。 从中选择一个值0.25。4.0 1.0 为默认值。 No 1.0
voice 枚举 用于语音合成的语音。
可能的值：alloy、、echo、fableonyx、nova、shimmer		 Yes

imageQuality

将生成的图像的质量。

Property Value
Description 将生成的图像的质量。
Type 字符串
Default auto
Values auto
high
medium
low
hd
standard

imagesResponseFormat

返回生成的图像的格式。

Property Value
Description 返回生成的图像的格式。
Type 字符串
Default url
Values url
b64_json

imagesOutputFormat

返回生成的图像的文件格式。 仅支持系列模型。

Property Value
Description 返回生成的图像的文件格式。 仅支持 gpt-image-1 系列模型。
Type 字符串
Default png
Values png
jpeg

imageSize

生成的图像的大小。

Property Value
Description 生成的图像的大小。
Type 字符串
Default auto
Values auto
1792x1024
1024x1792
1024x1024
1024x1536
1536x1024

imageStyle

生成的图像的样式。 仅支持 dall-e-3。

Property Value
Description 生成的图像的样式。 仅支持 dall-e-3。
Type 字符串
Default vivid
Values vivid
natural

imageBackground

允许为生成的图像的背景设置透明度。 仅 gpt-image-1 系列模型支持此参数。

Property Value
Description 允许为生成的图像的背景设置透明度。 仅 gpt-image-1 系列模型支持此参数。
Type 字符串
Default auto
Values transparent
opaque
auto

imageGenerationsRequest

Name 类型 Description Required Default
后台的 imageBackground 允许为生成的图像的背景设置透明度。 仅 gpt-image-1 系列模型支持此参数。 No auto
n 整数 要生成的图像数。 对于 dall-e-3，仅支持 n=1。 No 1
output_compression 整数 生成的图像的压缩级别（0-100%）。 此参数仅支持 jpeg 输出格式的 gpt-image-1 系列模型。 No 100
output_format imagesOutputFormat 返回生成的图像的文件格式。 仅支持 gpt-image-1 系列模型。 No png
提示 字符串 所需图像的文本说明。 gpt-image-1 系列模型的最大长度为 32000 个字符，dall-e-3 的最大长度为 4000 个字符 Yes
quality imageQuality 将生成的图像的质量。 No auto
response_format imagesResponseFormat 返回生成的图像的格式。 仅支持 dall-e-3。 No url
size imageSize 生成的图像的大小。 No auto
样式 imageStyle 生成的图像的样式。 仅支持 dall-e-3。 No vivid
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。 No

imageEditsRequest

Name 类型 Description Required Default
图像 字符串或数组 要编辑的图像（s）。 必须是受支持的图像文件或图像数组。 每个图像应为小于 25MB 的 png 或 jpg 文件。 Yes
过滤 字符串 另一个图像，其完全透明区域（例如 alpha 为零）指示应编辑图像的位置。 如果提供了多个映像，掩码将应用于第一个图像。 必须是有效的 PNG 文件，小于 4MB，并且具有与图像相同的尺寸。 No
n 整数 要生成的图像数。 No 1
提示 字符串 所需图像的文本说明。 最大长度为 32000 个字符。 Yes
quality imageQuality 将生成的图像的质量。 No auto
response_format imagesResponseFormat 返回生成的图像的格式。 No url
size imageSize 生成的图像的大小。 No auto
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。 No

generateImagesResponse

Name 类型 Description Required Default
created 整数 创建操作时的 unix 时间戳。 Yes
数据 数组 操作的结果数据（如果成功） Yes
使用情况 imageGenerationsUsage 表示映像生成请求的令牌使用情况详细信息。 仅适用于 gpt-image-1 系列模型。 No

imageResult

如果成功，则为图像 URL 或编码图像，否则返回错误。

Name 类型 Description Required Default
b64_json 字符串 base64 编码图像 No
content_filter_results dalleContentFilterResults 有关内容筛选结果的信息。 No
prompt_filter_results dalleFilterResults 如果检测到内容筛选类别（仇恨、性、暴力、self_harm），以及严重性级别（very_low、低、中、大规模，用于确定有害内容的强度和风险级别），以及它是否已筛选或未筛选。 有关越狱内容和亵渎内容的信息（如果已检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。 No
revised_prompt 字符串 用于生成映像的提示（如果有对提示的任何修订）。 No
url 字符串 图像 URL。 No

imageGenerationsUsage

表示映像生成请求的令牌使用情况详细信息。 仅适用于 gpt-image-1 系列模型。

Name 类型 Description Required Default
input_tokens 整数 输入令牌数。 No
input_tokens_details 对象 输入令牌的详细细分。 No
└─ image_tokens 整数 映像令牌数。 No
└─ text_tokens 整数 文本令牌数。 No
output_tokens 整数 输出令牌数。 No
total_tokens 整数 使用的令牌总数。 No

线

内容行对象，由相邻的内容元素序列（如字词和选择标记）组成。

Name 类型 Description Required Default
spans 数组 表示检测到的对象及其边界框信息的跨度数组。 Yes
文本消息 字符串 Yes

span

一个范围对象，表示检测到的对象及其边界框信息。

Name 类型 Description Required Default
length 整数 以 Unicode 代码点为单位的跨度长度（以字符为单位）。 Yes
偏移 整数 范围开始的文本中的字符偏移量。 此偏移量定义为范围的第一个字符的位置，从文本开头计数为 Unicode 代码点。 Yes
多边形 数组 一个对象数组，表示多边形中包含检测到的对象中的点。 Yes
文本消息 字符串 表示检测到的对象范围的文本内容。 Yes

runCompletionUsage

与运行相关的使用情况统计信息。 如果运行未处于终端状态（例如nullin_progress，等等），则此值将为queued此值。

Name 类型 Description Required Default
completion_tokens 整数 运行过程中使用的完成令牌数。 Yes
prompt_tokens 整数 在运行过程中使用的提示令牌数。 Yes
total_tokens 整数 使用的令牌总数（提示 + 完成）。 Yes

runStepCompletionUsage

与运行步骤相关的使用情况统计信息。 当运行步骤的状态为时，此值将为 nullin_progress。

Name 类型 Description Required Default
completion_tokens 整数 运行步骤过程中使用的完成令牌数。 Yes
prompt_tokens 整数 运行步骤过程中使用的提示令牌数。 Yes
total_tokens 整数 使用的令牌总数（提示 + 完成）。 Yes

assistantsApiResponseFormatOption

指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。

此组件可以是下列组件之一：

assistantsApiResponseFormat

描述模型的预期输出的对象。 如果 json_object 只 function 允许将类型 tools 传递给“运行”。 如果 text 模型可以返回文本或所需的任何值。

Name 类型 Description Required Default
类型 字符串 必须是或 textjson_object. No 文本消息

类型枚举：AssistantsApiResponseFormat

Value Description
文本消息
json_object

assistantObject

表示可以调用模型并使用工具的一个 assistant 。

Name 类型 Description Required Default
created_at 整数 创建助理时的 Unix 时间戳（以秒为单位）。 Yes
description 字符串 助理的说明。 最大长度为 512 个字符。
 Yes
id 字符串 可以在 API 终结点中引用的标识符。 Yes
instructions 字符串 助手使用的系统说明。 最大长度为 256,000 个字符。
 Yes
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 Yes
模型 字符串 要使用的模型的 ID。 Yes
name 字符串 助理的名称。 最大长度为 256 个字符。
 Yes
对象 字符串 对象类型，始终 assistant为 . Yes
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
tool_resources 对象 助手工具使用的一组资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此助手的向量存储的 ID。 最多可以有 1 个矢量存储附加到助手。
 No
tools 数组 在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具可以是类型 code_interpreter， file_search也可以 function。
 Yes []
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1

对象枚举：AssistantObjectType

Value Description
助手 对象类型，始终是助手

createAssistantRequest

Name 类型 Description Required Default
description 字符串 助理的说明。 最大长度为 512 个字符。
 No
instructions 字符串 助手使用的系统说明。 最大长度为 256,000 个字符。
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 Yes
name 字符串 助理的名称。 最大长度为 256 个字符。
 No
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
tool_resources 对象 助手工具使用的一组资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此助手的向量存储。 最多可以有 1 个矢量存储附加到助手。
 No
└─ vector_stores 数组 一个帮助程序，用于创建具有file_ids的向量存储，并将其附加到此助手。 最多可以有 1 个矢量存储附加到助手。
 No
tools 数组 在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具可以是类型 code_interpreter， retrieval也可以 function。
 No []
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1

modifyAssistantRequest

Name 类型 Description Required Default
description 字符串 助理的说明。 最大长度为 512 个字符。
 No
instructions 字符串 助手使用的系统说明。 最大长度为 32768 个字符。
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 No
name 字符串 助理的名称。 最大长度为 256 个字符。
 No
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
tool_resources 对象 助手工具使用的一组资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 重写可用于 code_interpreter 该工具的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 重写附加到此助手的向量存储。 最多可以有 1 个矢量存储附加到助手。
 No
tools 数组 在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具可以是类型 code_interpreter， retrieval也可以 function。
 No []
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1

deleteAssistantResponse

Name 类型 Description Required Default
deleted boolean Yes
id 字符串 Yes
对象 字符串 Yes

对象枚举：DeleteAssistantResponseState

Value Description
assistant.deleted

listAssistantsResponse

Name 类型 Description Required Default
数据 数组 Yes
first_id 字符串 Yes
has_more boolean Yes
last_id 字符串 Yes
对象 字符串 Yes

assistantToolsCode

Name 类型 Description Required Default
类型 字符串 要定义的工具的类型： code_interpreter Yes

类型枚举：assistantToolsCodeType

Value Description
code_interpreter

assistantToolsFileSearch

Name 类型 Description Required Default
file_search 对象 文件搜索工具的替代。 No
└─ max_num_results 整数 文件搜索工具应输出的最大结果数。 对于 gpt-4* 模型，默认值为 20，gpt-3.5-turbo 为 5。 此数字应介于 1 和 50 之间（含）。

请注意，文件搜索工具可能输出的结果少于 max_num_results 结果。
No
类型 字符串 要定义的工具的类型： file_search Yes

类型枚举：assistantToolsFileSearchType

Value Description
file_search

assistantToolsFileSearchTypeOnly

Name 类型 Description Required Default
类型 字符串 要定义的工具的类型： file_search Yes

类型枚举：assistantToolsFileSearchType

Value Description
file_search

assistantToolsFunction

Name 类型 Description Required Default
函数 对象 函数定义。 Yes
└─ description 字符串 模型用来选择何时以及如何调用函数的说明。 No
└─ name 字符串 要调用的函数的名称。 必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。 No
└─ parameters chatCompletionFunctionParameters 函数接受的参数，描述为 JSON 架构对象。 有关格式的文档，请参阅 指南/ 示例和 JSON 架构参考 。 No
类型 字符串 要定义的工具的类型： function Yes

类型枚举：assistantToolsFunction

Value Description
函数

truncationObject

控制如何在运行之前截断线程。 使用此控件可控制运行的初始上下文窗口。

Name 类型 Description Required Default
last_messages 整数 构造运行上下文时线程中的最新消息数。 No
类型 字符串 要用于线程的截断策略。 默认值为 auto. 如果设置为 last_messages该线程，该线程将被截断为线程中的 n 条最新消息。 设置为 > 时，将删除线程中间的消息，以适应模型的 上下文长度。 Yes

类型枚举：TruncationType

Value Description
auto
last_messages

assistantsApiToolChoiceOption

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

此组件可以是下列组件之一：

assistantsNamedToolChoice

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

Name 类型 Description Required Default
函数 对象 No
└─ name 字符串 要调用的函数的名称。 No
类型 字符串 工具的类型。 如果类型为 function，则必须设置函数名称 Yes

类型枚举：AssistantsNamedToolChoiceType

Value Description
函数
code_interpreter
file_search

runObject

表示在线程上运行的执行。

Name 类型 Description Required Default
assistant_id 字符串 用于执行此运行的助手的 ID。 Yes
cancelled_at 整数 取消运行时的 Unix 时间戳（以秒为单位）。 Yes
completed_at 整数 运行完成时的 Unix 时间戳（以秒为单位）。 Yes
created_at 整数 创建运行时的 Unix 时间戳（以秒为单位）。 Yes
expires_at 整数 运行时的 Unix 时间戳（以秒为单位）。 Yes
failed_at 整数 运行失败时的 Unix 时间戳（以秒为单位）。 Yes
id 字符串 可以在 API 终结点中引用的标识符。 Yes
incomplete_details 对象 有关运行为何不完整的详细信息。 如果运行不完整，则为null Yes
└─ reason 字符串 运行不完整的原因。 这将指出在运行过程中达到特定令牌限制。 No
instructions 字符串 用于此运行的助手的说明。 Yes
last_error 对象 与此运行关联的最后一个错误。 如果不存在错误，则为 Yes
└─ code 字符串 之 server_error 一或 rate_limit_exceeded. No
└─ message 字符串 错误的人工可读说明。 No
max_completion_tokens 整数 在运行过程中指定的完成令牌的最大数目。
 Yes
max_prompt_tokens 整数 在运行过程中已使用指定的最大提示令牌数。
 Yes
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 Yes
模型 字符串 用于此运行的助手的模型。 Yes
对象 字符串 对象类型，始终 thread.run为 . Yes
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
required_action 对象 有关继续运行所需的操作的详细信息。 如果不需要任何操作，则为null Yes
└─ submit_tool_outputs 对象 有关此运行继续所需的工具输出的详细信息。 No
└─ tool_calls 数组 相关工具调用的列表。 No
└─ type 枚举 目前，这总是 submit_tool_outputs如此。
可能的值： submit_tool_outputs		 No
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 Yes
started_at 整数 启动运行时的 Unix 时间戳（以秒为单位）。 Yes
状态 字符串 运行的状态，可以是queued、、in_progress、requires_action、cancellingcancelled、、failed或completedexpired。 Yes
temperature number 用于此运行的采样温度。 如果未设置，则默认值为 1。 No
thread_id 字符串 在此运行过程中执行的线程的 ID。 Yes
tool_choice assistantsApiToolChoiceOption 控制模型调用哪个（如果有）工具。
none 表示模型不会调用任何工具，而是生成消息。
auto 是默认值，表示模型可以在生成消息或调用工具之间进行选择。
指定特定工具，例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具。
 Yes
tools 数组 助理用于此运行的工具列表。 Yes []
top_p number 用于此运行的核采样值。 如果未设置，则默认值为 1。 No
truncation_strategy truncationObject 控制如何在运行之前截断线程。 使用此控件可控制运行的初始上下文窗口。 Yes
使用情况 runCompletionUsage 与运行相关的使用情况统计信息。 如果运行未处于终端状态（例如nullin_progress，等等），则此值将为queued此值。 Yes

对象枚举：runObjectType

Value Description
thread.run 始终为 thread.run 的 run 对象类型

status Enum： RunObjectStatus

Value Description
queued 排队状态
in_progress in_progress状态
requires_action required_action状态
cancelling 取消状态
cancelled 已取消状态
failed 失败状态
completed 已完成状态
expired 过期状态

createRunRequest

Name 类型 Description Required Default
additional_instructions 字符串 在运行指令的末尾追加其他指令。 这对于在不重写其他指令的情况下按运行修改行为非常有用。 No
additional_messages 数组 在创建运行之前，将其他消息添加到线程。 No
assistant_id 字符串 用于执行此运行的助手的 ID。 Yes
instructions 字符串 重写助手的默认系统消息。 这对于按运行修改行为非常有用。 No
max_completion_tokens 整数 在运行过程中可以使用的最大完成令牌数。 运行尽力仅使用指定的完成令牌数，跨运行的多个轮次。 如果运行超过指定的完成令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
max_prompt_tokens 整数 在运行过程中可以使用的最大提示令牌数。 运行尽力仅使用指定的提示令牌数，在运行的多个轮次中。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 要用于执行此运行的模型的 ID。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。 No
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
数据流 boolean 如果 true返回在运行方式为服务器发送的事件期间发生的事件流，则当运行进入带有消息的终端状态 data: [DONE] 时终止。
 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
tool_choice assistantsApiToolChoiceOption 控制模型调用哪个（如果有）工具。
none 表示模型不会调用任何工具，而是生成消息。
auto 是默认值，表示模型可以在生成消息或调用工具之间进行选择。
指定特定工具，例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具。
 No
tools 数组 重写助手可用于此运行的工具。 这对于按运行修改行为非常有用。 No
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1
truncation_strategy truncationObject 控制如何在运行之前截断线程。 使用此控件可控制运行的初始上下文窗口。 No

listRunsResponse

Name 类型 Description Required Default
数据 数组 Yes
first_id 字符串 Yes
has_more boolean Yes
last_id 字符串 Yes
对象 字符串 Yes

modifyRunRequest

Name 类型 Description Required Default
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No

submitToolOutputsRunRequest

Name 类型 Description Required Default
数据流 boolean 如果 true返回在运行方式为服务器发送的事件期间发生的事件流，则当运行进入带有消息的终端状态 data: [DONE] 时终止。
 No
tool_outputs 数组 要为其提交输出的工具列表。 Yes

runToolCallObject

工具调用对象

Name 类型 Description Required Default
函数 对象 函数定义。 Yes
└─ arguments 字符串 模型期望传递给函数的参数。 No
└─ name 字符串 函数的名称。 No
id 字符串 工具调用的 ID。 当使用提交工具输出将工具输出提交到运行 endpointendpoint 时，必须引用此 ID。 Yes
类型 字符串 工具调用输出的类型是必需的。 目前，这总是 function如此。 Yes

类型枚举：RunToolCallObjectType

Value Description
函数

createThreadAndRunRequest

Name 类型 Description Required Default
assistant_id 字符串 用于执行此运行的助手的 ID。 Yes
instructions 字符串 重写助手的默认系统消息。 这对于按运行修改行为非常有用。 No
max_completion_tokens 整数 在运行过程中可以使用的最大完成令牌数。 运行尽力仅使用指定的完成令牌数，跨运行的多个轮次。 如果运行超过指定的完成令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
max_prompt_tokens 整数 在运行过程中可以使用的最大提示令牌数。 运行尽力仅使用指定的提示令牌数，在运行的多个轮次中。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete结束。 有关详细信息，请参阅incomplete_details
 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
模型 字符串 要用于执行此运行的模型的 ID。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。 No
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
response_format assistantsApiResponseFormatOption 指定模型必须输出的格式。 与 GPT-4o、GPT-4 Turbo 和自那以后 gpt-3.5-turbo-1106的所有 GPT-3.5 Turbo 模型兼容。

{ "type": "json_schema", "json_schema": {...} }设置为启用结构化输出，以确保模型与提供的 JSON 架构匹配。 在结构化输出指南中了解详细信息。

{ "type": "json_object" }设置为启用 JSON 模式，这可确保模型生成的消息是有效的 JSON。

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。		 No
数据流 boolean 如果 true返回在运行方式为服务器发送的事件期间发生的事件流，则当运行进入带有消息的终端状态 data: [DONE] 时终止。
 No
stream_options chatCompletionStreamOptions 流式处理响应的选项。 仅在设置时设置 stream: true此设置。
 No None
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
 No 1
会话 createThreadRequest No
tool_choice assistantsApiToolChoiceOption 控制模型调用哪个（如果有）工具。
none 表示模型不会调用任何工具，而是生成消息。
auto 是默认值，表示模型可以在生成消息或调用工具之间进行选择。
指定特定工具，例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具。
 No
tool_resources 对象 助手工具使用的一组资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此助手的向量存储的 ID。 最多可以有 1 个矢量存储附加到助手。
 No
tools 数组 重写助手可用于此运行的工具。 这对于按运行修改行为非常有用。 No
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改此或温度，但不要同时更改这两者。
 No 1
truncation_strategy truncationObject 控制如何在运行之前截断线程。 使用此控件可控制运行的初始上下文窗口。 No

threadObject

表示包含消息的线程。

Name 类型 Description Required Default
created_at 整数 创建线程时的 Unix 时间戳（以秒为单位）。 Yes
id 字符串 可以在 API 终结点中引用的标识符。 Yes
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 Yes
对象 字符串 对象类型，始终 thread为 . Yes
tool_resources 对象 一组可供此线程中的助手工具使用的资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 Yes
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此线程的向量存储。 最多可以附加到线程的 1 个向量存储。
 No

对象枚举：ThreadObjectType

Value Description
会话 始终为线程对象的类型 thread

createThreadRequest

Name 类型 Description Required Default
messages 数组 消息列表，以启动线程。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
tool_resources 对象 一组可供此线程中的助手工具使用的资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 可供该工具使用 code_interpreter 的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此线程的向量存储。 最多可以附加到线程的 1 个向量存储。
 No
└─ vector_stores 数组 一个帮助程序，用于创建具有file_ids的向量存储并将其附加到此线程。 最多可以附加到线程的 1 个向量存储。
 No

modifyThreadRequest

Name 类型 Description Required Default
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
tool_resources 对象 一组可供此线程中的助手工具使用的资源。 资源特定于工具的类型。 例如，该工具 code_interpreter 需要文件 ID 列表，而 file_search 该工具需要矢量存储 ID 的列表。
 No
└─ code_interpreter 对象 No
└─ file_ids 数组 工具可用的 code_interpreter 文件 ID 列表。 最多可以有 20 个与该工具关联的文件。
 No []
└─ file_search 对象 No
└─ vector_store_ids 数组 附加到此线程的向量存储。 最多可以附加到线程的 1 个向量存储。
 No

deleteThreadResponse

Name 类型 Description Required Default
deleted boolean Yes
id 字符串 Yes
对象 字符串 Yes

对象枚举：DeleteThreadResponseObjectState

Value Description
thread.deleted 删除线程响应对象状态，即 thread.deleted

listThreadsResponse

Name 类型 Description Required Default
数据 数组 Yes
first_id 字符串 Yes
has_more boolean Yes
last_id 字符串 Yes
对象 字符串 Yes

messageObject

表示线程中的消息。

Name 类型 Description Required Default
assistant_id 字符串 如果适用，则为创作此消息的助理的 ID。 Yes
attachments 数组 附加到邮件的文件列表及其添加到的工具。 Yes
completed_at 整数 消息完成时的 Unix 时间戳（以秒为单位）。 Yes
内容 数组 文本和/或图像数组中消息的内容。 Yes
created_at 整数 创建消息时的 Unix 时间戳（以秒为单位）。 Yes
id 字符串 可以在 API 终结点中引用的标识符。 Yes
incomplete_at 整数 消息标记为不完整时的 Unix 时间戳（以秒为单位）。 Yes
incomplete_details 对象 在不完整的邮件中，有关邮件不完整的原因的详细信息。 Yes
└─ reason 字符串 消息不完整的原因。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 Yes
对象 字符串 对象类型，始终 thread.message为 . Yes
角色 字符串 生成消息的实体。 之 user 一或 assistant. Yes
run_id 字符串 如果适用，则与此消息的创作关联的运行 ID。 Yes
状态 字符串 消息的状态，可以是 in_progress， incomplete也可以 completed。 Yes
thread_id 字符串 此消息所属的线程 ID。 Yes

对象枚举：MessageObjectType

Value Description
thread.message 消息对象类型，即 thread.message

status Enum： MessageObjectStatus

Value Description
in_progress
incomplete
completed

role Enum： MessageObjectRole

Value Description
用户
助手

messageDeltaObject

表示消息增量，即流式处理过程中消息上任何已更改的字段。

Name 类型 Description Required Default
delta 对象 包含邮件上已更改的字段的增量。 Yes
└─ content 数组 文本和/或图像数组中消息的内容。 No
└─ role 字符串 生成消息的实体。 之 user 一或 assistant. No
id 字符串 消息的标识符，可在 API 终结点中引用。 Yes
对象 字符串 对象类型，始终 thread.message.delta为 . Yes

对象枚举：MessageDeltaObjectType

Value Description
thread.message.delta

createMessageRequest

Name 类型 Description Required Default
attachments 数组 附加到消息的文件列表及其应添加到的工具。 No
内容 字符串 消息的内容。 Yes
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
角色 字符串 正在创建消息的实体的角色。 允许的值包括：
- user：指示消息是由实际用户发送的，在大多数情况下应用于表示用户生成的消息。
- assistant：指示消息是由助手生成的。 使用此值将助手中的消息插入对话。
 Yes

role Enum： CreateMessageRequestRole

Value Description
用户
助手

modifyMessageRequest

Name 类型 Description Required Default
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No

deleteMessageResponse

Name 类型 Description Required Default
deleted boolean Yes
id 字符串 Yes
对象 字符串 Yes

对象枚举：DeleteMessageResponseObject

Value Description
thread.message.deleted 删除消息响应对象状态

listMessagesResponse

Name 类型 Description Required Default
数据 数组 Yes
first_id 字符串 Yes
has_more boolean Yes
last_id 字符串 Yes
对象 字符串 Yes

messageContentImageFileObject

引用消息内容中的图像文件。

Name 类型 Description Required Default
image_file 对象 Yes
└─ file_id 字符串 消息内容中图像的文件 ID。 No
类型 字符串 始终 image_file。 Yes

类型枚举：MessageContentImageFileObjectType

Value Description
image_file 消息内容图像文件类型

messageContentTextObject

作为消息一部分的文本内容。

Name 类型 Description Required Default
文本消息 对象 Yes
└─ annotations 数组 No
└─ value 字符串 构成文本的数据。 No
类型 字符串 始终 text。 Yes

类型枚举：messageContentTextObjectType

Value Description
文本消息 消息内容文本对象类型

messageContentTextAnnotationsFileCitationObject

消息中的引文，指向与助手或邮件关联的特定文件中的特定引文。 当助手使用“检索”工具搜索文件时生成。

Name 类型 Description Required Default
end_index 整数 Yes
file_citation 对象 Yes
└─ file_id 字符串 引文来源的特定文件的 ID。 No
start_index 整数 Yes
文本消息 字符串 需要替换的邮件内容中的文本。 Yes
类型 字符串 始终 file_citation。 Yes

类型枚举：FileCitationObjectType

Value Description
file_citation 文件引文对象类型

messageContentTextAnnotationsFilePathObject

助理使用 code_interpreter 该工具生成文件时生成的文件的 URL。

Name 类型 Description Required Default
end_index 整数 Yes
file_path 对象 Yes
└─ file_id 字符串 生成的文件的 ID。 No
start_index 整数 Yes
文本消息 字符串 需要替换的邮件内容中的文本。 Yes
类型 字符串 始终 file_path。 Yes

类型枚举：FilePathObjectType

Value Description
file_path 文件路径对象类型

messageDeltaContentImageFileObject

引用消息内容中的图像文件。

Name 类型 Description Required Default
image_file 对象 No
└─ file_id 字符串 消息内容中图像的文件 ID。 No
索引 整数 消息中内容部件的索引。 Yes
类型 字符串 始终 image_file。 Yes

类型枚举：MessageDeltaContentImageFileObjectType

Value Description
image_file

messageDeltaContentTextObject

作为消息一部分的文本内容。

Name 类型 Description Required Default
索引 整数 消息中内容部件的索引。 Yes
文本消息 对象 No
└─ annotations 数组 No
└─ value 字符串 构成文本的数据。 No
类型 字符串 始终 text。 Yes

类型枚举：MessageDeltaContentTextObjectType

Value Description
文本消息

messageDeltaContentTextAnnotationsFileCitationObject

消息中的引文，指向与助手或邮件关联的特定文件中的特定引文。 当助手使用“file_search”工具搜索文件时生成。

Name 类型 Description Required Default
end_index 整数 No
file_citation 对象 No
└─ file_id 字符串 引文来源的特定文件的 ID。 No
└─ quote 字符串 文件中的特定引号。 No
索引 整数 文本内容部件中批注的索引。 Yes
start_index 整数 No
文本消息 字符串 需要替换的邮件内容中的文本。 No
类型 字符串 始终 file_citation。 Yes

类型枚举：MessageDeltaContentTextAnnotationsFileCitationObjectType

Value Description
file_citation

messageDeltaContentTextAnnotationsFilePathObject

助理使用 code_interpreter 该工具生成文件时生成的文件的 URL。

Name 类型 Description Required Default
end_index 整数 No
file_path 对象 No
└─ file_id 字符串 生成的文件的 ID。 No
索引 整数 文本内容部件中批注的索引。 Yes
start_index 整数 No
文本消息 字符串 需要替换的邮件内容中的文本。 No
类型 字符串 始终 file_path。 Yes

类型枚举：MessageDeltaContentTextAnnotationsFilePathObjectType

Value Description
file_path

runStepObject

表示执行运行的步骤。

Name 类型 Description Required Default
assistant_id 字符串 与运行步骤关联的助理的 ID。 Yes
cancelled_at 整数 取消运行步骤时的 Unix 时间戳（以秒为单位）。 Yes
completed_at 整数 运行步骤完成时的 Unix 时间戳（以秒为单位）。 Yes
created_at 整数 创建运行步骤时的 Unix 时间戳（以秒为单位）。 Yes
expired_at 整数 运行步骤过期时的 Unix 时间戳（以秒为单位）。 如果父运行已过期，则认为步骤已过期。 Yes
failed_at 整数 运行步骤失败时的 Unix 时间戳（以秒为单位）。 Yes
id 字符串 可在 API 终结点中引用的运行步骤的标识符。 Yes
last_error 对象 与此运行步骤关联的最后一个错误。 如果不存在错误，则为 Yes
└─ code 字符串 之 server_error 一或 rate_limit_exceeded. No
└─ message 字符串 错误的人工可读说明。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 Yes
对象 字符串 对象类型，始终 assistant.run.step为 . Yes
run_id 字符串 此运行步骤所属的运行 ID。 Yes
状态 字符串 运行的状态，可以是in_progress、cancelled、failed或completedexpired。 Yes
step_details runStepDetailsMessageCreationObject 或 runStepDetailsToolCallsObject 运行步骤的详细信息。 Yes
thread_id 字符串 运行的线程的 ID。 Yes
类型 字符串 运行步骤的类型，可以是 message_creation 或 tool_calls。 Yes

对象枚举：RunStepObjectType

Value Description
assistant.run.step 对象类型，始终为 assistant.run.step

类型枚举：RunStepObjectType

Value Description
message_creation message_creation运行步骤
tool_calls tool_calls运行步骤

status 枚举：RunStepObjectStatus

Value Description
in_progress in_progress运行状态
cancelled 已取消的运行状态
failed 已取消的运行状态
completed 已取消的运行状态
expired 已取消的运行状态

runStepDeltaObject

表示运行步骤增量，即流式处理过程中运行步骤上任何已更改的字段。

Name 类型 Description Required Default
delta 对象 包含运行步骤中已更改的字段的增量。 Yes
└─ step_details runStepDeltaStepDetailsMessageCreationObject 或 runStepDeltaStepDetailsToolCallsObject 运行步骤的详细信息。 No
id 字符串 可在 API 终结点中引用的运行步骤的标识符。 Yes
对象 字符串 对象类型，始终 thread.run.step.delta为 . Yes

对象枚举：RunStepDeltaObjectType

Value Description
thread.run.step.delta

listRunStepsResponse

Name 类型 Description Required Default
数据 数组 Yes
first_id 字符串 Yes
has_more boolean Yes
last_id 字符串 Yes
对象 字符串 Yes

runStepDetailsMessageCreationObject

运行步骤创建消息的详细信息。

Name 类型 Description Required Default
message_creation 对象 Yes
└─ message_id 字符串 此运行步骤创建的消息的 ID。 No
类型 字符串 始终 message_creation。 Yes

类型枚举：RunStepDetailsMessageCreationObjectType

Value Description
message_creation

runStepDeltaStepDetailsMessageCreationObject

运行步骤创建消息的详细信息。

Name 类型 Description Required Default
message_creation 对象 No
└─ message_id 字符串 此运行步骤创建的消息的 ID。 No
类型 字符串 始终 message_creation。 Yes

type Enum： RunStepDeltaStepDetailsMessageCreationObjectType

Value Description
message_creation

runStepDetailsToolCallsObject

工具调用的详细信息。

Name 类型 Description Required Default
tool_calls 数组 涉及运行步骤的工具调用数组。 这些可以与三种类型的工具之一相关联：code_interpreterretrieval或function。
 Yes
类型 字符串 始终 tool_calls。 Yes

类型枚举：RunStepDetailsToolCallsObjectType

Value Description
tool_calls

runStepDeltaStepDetailsToolCallsObject

工具调用的详细信息。

Name 类型 Description Required Default
tool_calls 数组 涉及运行步骤的工具调用数组。 这些可以与三种类型的工具之一相关联：code_interpreterfile_search或function。
 No
类型 字符串 始终 tool_calls。 Yes

类型枚举：RunStepDeltaStepDetailsToolCallsObjectType

Value Description
tool_calls

runStepDetailsToolCallsCodeObject

代码解释器工具调用运行步骤的详细信息。

Name 类型 Description Required Default
code_interpreter 对象 代码解释器工具调用定义。 Yes
└─ input 字符串 代码解释器工具调用的输入。 No
└─ outputs 数组 代码解释器工具调用的输出。 代码解释器可以输出一个或多个项，包括文本（logs）或图像（image）。 每个对象类型都由不同的对象类型表示。 No
id 字符串 工具调用的 ID。 Yes
类型 字符串 工具调用的类型。 这始终适用于 code_interpreter 这种类型的工具调用。 Yes

类型枚举：RunStepDetailsToolCallsCodeObjectType

Value Description
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

代码解释器工具调用运行步骤的详细信息。

Name 类型 Description Required Default
code_interpreter 对象 代码解释器工具调用定义。 No
└─ input 字符串 代码解释器工具调用的输入。 No
└─ outputs 数组 代码解释器工具调用的输出。 代码解释器可以输出一个或多个项，包括文本（logs）或图像（image）。 每个对象类型都由不同的对象类型表示。 No
id 字符串 工具调用的 ID。 No
索引 整数 工具调用数组中工具调用的索引。 Yes
类型 字符串 工具调用的类型。 这始终适用于 code_interpreter 这种类型的工具调用。 Yes

类型枚举：RunStepDeltaStepDetailsToolCallsCodeObjectType

Value Description
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

代码解释器工具调用的文本输出作为运行步骤的一部分。

Name 类型 Description Required Default
日志 字符串 代码解释器工具调用的文本输出。 Yes
类型 字符串 始终 logs。 Yes

类型枚举：RunStepDetailsToolCallsCodeOutputLogsObjectType

Value Description
日志

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

代码解释器工具调用的文本输出作为运行步骤的一部分。

Name 类型 Description Required Default
索引 整数 输出数组中输出的索引。 Yes
日志 字符串 代码解释器工具调用的文本输出。 No
类型 字符串 始终 logs。 Yes

类型枚举：RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

Value Description
日志

runStepDetailsToolCallsCodeOutputImageObject

Name 类型 Description Required Default
图像 对象 Yes
└─ file_id 字符串 映像的文件 ID。 No
类型 字符串 始终 image。 Yes

类型枚举：RunStepDetailsToolCallsCodeOutputImageObjectType

Value Description
图像

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

Name 类型 Description Required Default
图像 对象 No
└─ file_id 字符串 映像的文件 ID。 No
索引 整数 输出数组中输出的索引。 Yes
类型 字符串 始终 image。 Yes

type Enum： RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

Value Description
图像

runStepDetailsToolCallsFileSearchObject

Name 类型 Description Required Default
file_search 对象 目前，这始终是一个空对象。 Yes
└─ results 数组 文件搜索的结果。 No
id 字符串 工具调用对象的 ID。 Yes
类型 字符串 工具调用的类型。 这始终适用于 file_search 这种类型的工具调用。 Yes

类型枚举：RunStepDetailsToolCallsFileSearchObjectType

Value Description
file_search

runStepDetailsToolCallsFileSearchResultObject

文件搜索的结果实例。

Name 类型 Description Required Default
内容 数组 找到的结果的内容。 仅当通过 include 查询参数请求时，才包含内容。 No
file_id 字符串 找到结果的文件的 ID。 Yes
file_name 字符串 找到结果的文件的名称。 Yes
分数 number 结果的分数。 所有值必须是介于 0 和 1 之间的浮点数。 Yes

runStepDeltaStepDetailsToolCallsFileSearchObject

Name 类型 Description Required Default
file_search 对象 目前，这始终是一个空对象。 Yes
id 字符串 工具调用对象的 ID。 No
索引 整数 工具调用数组中工具调用的索引。 Yes
类型 字符串 工具调用的类型。 这始终适用于 retrieval 这种类型的工具调用。 Yes

type Enum： RunStepDeltaStepDetailsToolCallsFileSearchObjectType

Value Description
file_search

runStepDetailsToolCallsFunctionObject

Name 类型 Description Required Default
函数 对象 调用的函数的定义。 Yes
└─ arguments 字符串 传递给函数的参数。 No
└─ name 字符串 函数的名称。 No
└─ output 字符串 函数的输出。 如果尚未提交输出，则会出现 null 这种情况。 No
id 字符串 工具调用对象的 ID。 Yes
类型 字符串 工具调用的类型。 这始终适用于 function 这种类型的工具调用。 Yes

type Enum： RunStepDetailsToolCallsFunctionObjectType

Value Description
函数

runStepDeltaStepDetailsToolCallsFunctionObject

Name 类型 Description Required Default
函数 对象 调用的函数的定义。 No
└─ arguments 字符串 传递给函数的参数。 No
└─ name 字符串 函数的名称。 No
└─ output 字符串 函数的输出。 如果尚未提交输出，则会出现 null 这种情况。 No
id 字符串 工具调用对象的 ID。 No
索引 整数 工具调用数组中工具调用的索引。 Yes
类型 字符串 工具调用的类型。 这始终适用于 function 这种类型的工具调用。 Yes

type Enum： RunStepDetailsToolCallsFunctionObjectType

Value Description
函数

vectorStoreExpirationAfter

矢量存储的过期策略。

Name 类型 Description Required Default
定位标记 字符串 在此时间之后应用过期策略的定位点时间戳。 支持的定位点： last_active_at. Yes
days 整数 矢量存储将过期的定位时间后的天数。 Yes

anchor 枚举：VectorStoreExpirationAfterAnchor

Value Description
last_active_at 过期策略应用之后的定位点时间戳。

vectorStoreObject

矢量存储是工具可以使用 file_search 已处理文件的集合。

Name 类型 Description Required Default
created_at 整数 创建矢量存储时的 Unix 时间戳（以秒为单位）。 Yes
expires_after vectorStoreExpirationAfter 矢量存储的过期策略。 No
expires_at 整数 矢量存储何时过期的 Unix 时间戳（以秒为单位）。 No
file_counts 对象 Yes
└─ cancelled 整数 已取消的文件数。 No
└─ completed 整数 已成功处理的文件数。 No
└─ failed 整数 未能处理的文件数。 No
└─ in_progress 整数 当前正在处理的文件数。 No
└─ total 整数 文件总数。 No
id 字符串 可以在 API 终结点中引用的标识符。 Yes
last_active_at 整数 矢量存储上次处于活动状态时的 Unix 时间戳（以秒为单位）。 Yes
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 Yes
name 字符串 矢量存储的名称。 Yes
对象 枚举 对象类型，始终 vector_store为 .
可能的值： vector_store		 Yes
状态 字符串 矢量存储的状态，可以是 expired， in_progress也可以 completed。 指示矢量存储已准备好使用的状态 completed 。 Yes
usage_bytes 整数 矢量存储区中文件使用的字节总数。 Yes

status 枚举：VectorStoreObjectStatus

Value Description
expired
in_progress
completed

createVectorStoreRequest

Name 类型 Description Required Default
chunking_strategy autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam 用于对文件进行分块的分块策略。 如果未设置，将使用 auto 策略。 仅当非空时 file_ids 适用。 No
expires_after vectorStoreExpirationAfter 矢量存储的过期策略。 No
file_ids 数组 矢量存储应使用的文件 ID 列表。 可用于访问文件等 file_search 工具。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
name 字符串 矢量存储的名称。 No

updateVectorStoreRequest

Name 类型 Description Required Default
expires_after vectorStoreExpirationAfter 矢量存储的过期策略。 No
元数据 对象 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息。 键最多可以包含 64 个字符，值最多可以长 512 个字符。
 No
name 字符串 矢量存储的名称。 No

listVectorStoresResponse

Name 类型 Description Required Default
数据 数组 Yes
first_id 字符串 Yes
has_more boolean Yes
last_id 字符串 Yes
对象 字符串 Yes

deleteVectorStoreResponse

Name 类型 Description Required Default
deleted boolean Yes
id 字符串 Yes
对象 字符串 Yes

对象枚举：DeleteVectorStoreResponseObject

Value Description
vector_store.deleted 删除向量存储响应对象状态

vectorStoreFileObject

附加到向量存储的文件列表。

Name 类型 Description Required Default
chunking_strategy autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam 用于对文件进行分块的分块策略。 如果未设置，将使用 auto 策略。 仅当非空时 file_ids 适用。 No
created_at 整数 创建矢量存储文件时的 Unix 时间戳（以秒为单位）。 Yes
id 字符串 可以在 API 终结点中引用的标识符。 Yes
last_error 对象 与此矢量存储文件关联的最后一个错误。 如果不存在错误，则为 Yes
└─ code 字符串 或 server_errorinvalid_fileunsupported_file. No
└─ message 字符串 错误的人工可读说明。 No
对象 字符串 对象类型，始终 vector_store.file为 . Yes
状态 字符串 矢量存储文件的状态，可以是in_progress，completedcancelledfailed也可以。 状态 completed 指示矢量存储文件可供使用。 Yes
usage_bytes 整数 总矢量存储使用量（以字节为单位）。 请注意，这可能不同于原始文件大小。 Yes
vector_store_id 字符串 文件附加到的向量存储的 ID。 Yes

对象枚举：VectorStoreFileObjectType

Value Description
vector_store.file

status Enum： VectorStoreFileObjectStatus

Value Description
in_progress
completed
cancelled
failed

otherChunkingStrategyResponseParam

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

Name 类型 Description Required Default
类型 字符串 始终 other。 Yes

类型枚举：OtherChunkingStrategyResponseParamType

Value Description
other

staticChunkingStrategyResponseParam

Name 类型 Description Required Default
静态的 staticChunkingStrategy Yes
类型 字符串 始终 static。 Yes

类型枚举：StaticChunkingStrategyResponseParamType

Value Description
静态的

staticChunkingStrategy

Name 类型 Description Required Default
chunk_overlap_tokens 整数 区块之间重叠的令牌数。 默认值为 400.

请注意，重叠不得超过一 max_chunk_size_tokens半。
 Yes
max_chunk_size_tokens 整数 每个区块中的最大令牌数。 默认值为 800. 最小值为 100 ，最大值为 4096。 Yes

autoChunkingStrategyRequestParam

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

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

staticChunkingStrategyRequestParam

Name 类型 Description Required Default
静态的 staticChunkingStrategy Yes
类型 枚举 始终 static。
可能的值： static		 Yes

chunkingStrategyRequestParam

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

此组件可以是下列组件之一：

createVectorStoreFileRequest

Name 类型 Description Required Default
chunking_strategy chunkingStrategyRequestParam 用于对文件进行分块的分块策略。 如果未设置，将使用 auto 策略。 No
file_id 字符串 矢量存储应使用的文件 ID。 可用于访问文件等 file_search 工具。 Yes

listVectorStoreFilesResponse

Name 类型 Description Required Default
数据 数组 Yes
first_id 字符串 Yes
has_more boolean Yes
last_id 字符串 Yes
对象 字符串 Yes

deleteVectorStoreFileResponse

Name 类型 Description Required Default
deleted boolean Yes
id 字符串 Yes
对象 字符串 Yes

对象枚举：DeleteVectorStoreFileResponseObject

Value Description
vector_store.file.deleted

vectorStoreFileBatchObject

附加到向量存储的一批文件。

Name 类型 Description Required Default
created_at 整数 创建矢量存储文件批处理时的 Unix 时间戳（以秒为单位）。 Yes
file_counts 对象 Yes
└─ cancelled 整数 已取消的文件数。 No
└─ completed 整数 已处理的文件数。 No
└─ failed 整数 未能处理的文件数。 No
└─ in_progress 整数 当前正在处理的文件数。 No
└─ total 整数 文件总数。 No
id 字符串 可以在 API 终结点中引用的标识符。 Yes
对象 字符串 对象类型，始终 vector_store.file_batch为 . Yes
状态 字符串 矢量存储文件批处理的状态，可以是in_progress， completedcancelledfailed也可以。 Yes
vector_store_id 字符串 文件附加到的向量存储的 ID。 Yes

对象枚举：VectorStoreFileBatchObjectType

Value Description
vector_store.files_batch

status Enum： VectorStoreFileBatchObjectStatus

Value Description
in_progress
completed
cancelled
failed

createVectorStoreFileBatchRequest

Name 类型 Description Required Default
chunking_strategy chunkingStrategyRequestParam 用于对文件进行分块的分块策略。 如果未设置，将使用 auto 策略。 No
file_ids 数组 矢量存储应使用的文件 ID 列表。 可用于访问文件等 file_search 工具。 Yes

assistantStreamEvent

表示流式处理运行时发出的事件。

服务器发送的事件流中的每个事件都有一个 event 和 data 属性：

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

每当创建新对象、转换为新状态或正在流式传输部分（deltas）时，我们都会发出事件。 例如，在创建新thread.run.created运行、运行完成时等时发出thread.run.completed。 当助手选择在运行期间创建消息时，我们将发出一个、一个thread.message.created eventthread.message.in_progress事件、许多thread.message.delta事件，最后是一个thread.message.completed事件。

我们可能会随着时间的推移添加其他事件，因此我们建议在代码中正常处理未知事件。

此组件可以是下列组件之一：

threadStreamEvent

此组件可以是下列组件之一：

thread.created

创建新线程时发生。

Name 类型 Description Required Default
数据 threadObject 表示包含消息的线程。 Yes
事件 字符串 Yes

Data: threadObject

事件枚举：ThreadStreamEventEnum

Value Description
thread.created 线程创建事件

runStreamEvent

此组件可以是下列组件之一：

thread.run.created

创建新运行时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventCreated

Value Description
thread.run.created

thread.run.queued

当运行移动到 queued 状态时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventQueued

Value Description
thread.run.queued

thread.run.in_progress

当运行移动到 in_progress 状态时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventInProgress

Value Description
thread.run.in_progress

thread.run.requires_action

当运行移动到 requires_action 状态时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventRequiresAction

Value Description
thread.run.requires_action

thread.run.completed

在运行完成后发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventCompleted

Value Description
thread.run.completed

thread.run.failed

在运行失败时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventFailed

Value Description
thread.run.failed

thread.run.cancelling

当运行移动到 cancelling 状态时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventCancelling

Value Description
thread.run.cancelling

thread.run.cancelled

在取消运行时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventCancelled

Value Description
thread.run.cancelled

thread.run.expired

在运行过期时发生。

Name 类型 Description Required Default
数据 runObject 表示在线程上运行的执行。 Yes
事件 字符串 Yes

Data: runObject

事件枚举：RunStreamEventExpired

Value Description
thread.run.expired

runStepStreamEvent

此组件可以是下列组件之一：

thread.run.step.created

创建运行步骤时发生。

Name 类型 Description Required Default
数据 runStepObject 表示执行运行的步骤。
 Yes
事件 字符串 Yes

Data: runStepObject

事件枚举：RunStepStreamEventCreated

Value Description
thread.run.step.created

thread.run.step.in_progress

当运行步骤移动到 in_progress 某个状态时发生。

Name 类型 Description Required Default
数据 runStepObject 表示执行运行的步骤。
 Yes
事件 字符串 Yes

Data: runStepObject

事件枚举：RunStepStreamEventInProgress

Value Description
thread.run.step.in_progress

thread.run.step.delta

在流式传输运行步骤的各个部分时发生。

Name 类型 Description Required Default
数据 runStepDeltaObject 表示运行步骤增量，即流式处理过程中运行步骤上任何已更改的字段。
 Yes
事件 字符串 Yes

Data: runStepDeltaObject

事件枚举：RunStepStreamEventDelta

Value Description
thread.run.step.delta

thread.run.step.completed

完成运行步骤时发生。

Name 类型 Description Required Default
数据 runStepObject 表示执行运行的步骤。
 Yes
事件 字符串 Yes

Data: runStepObject

事件枚举：RunStepStreamEventCompleted

Value Description
thread.run.step.completed

thread.run.step.failed

在运行步骤失败时发生。

Name 类型 Description Required Default
数据 runStepObject 表示执行运行的步骤。
 Yes
事件 字符串 Yes

Data: runStepObject

事件枚举：RunStepStreamEventFailed

Value Description
thread.run.step.failed

thread.run.step.cancelled

在取消运行步骤时发生。

Name 类型 Description Required Default
数据 runStepObject 表示执行运行的步骤。
 Yes
事件 字符串 Yes

Data: runStepObject

事件枚举：RunStepStreamEventCancelled

Value Description
thread.run.step.cancelled

thread.run.step.expired

在运行步骤过期时发生。

Name 类型 Description Required Default
数据 runStepObject 表示执行运行的步骤。
 Yes
事件 字符串 Yes

Data: runStepObject

事件枚举：RunStepStreamEventExpired

Value Description
thread.run.step.expired

messageStreamEvent

此组件可以是下列组件之一：

thread.message.created

创建消息时发生。

Name 类型 Description Required Default
数据 messageObject 表示线程中的消息。 Yes
事件 字符串 Yes

Data: messageObject

事件枚举：MessageStreamEventCreated

Value Description
thread.message.created

thread.message.in_progress

当消息移动到 in_progress 某个状态时发生。

Name 类型 Description Required Default
数据 messageObject 表示线程中的消息。 Yes
事件 字符串 Yes

Data: messageObject

事件枚举：MessageStreamEventInProgress

Value Description
thread.message.in_progress

thread.message.delta

在流式传输消息部分时发生。

Name 类型 Description Required Default
数据 messageDeltaObject 表示消息增量，即流式处理过程中消息上任何已更改的字段。
 Yes
事件 字符串 Yes

Data: messageDeltaObject

事件枚举：MessageStreamEventDelta

Value Description
thread.message.delta

thread.message.completed

消息完成时发生。

Name 类型 Description Required Default
数据 messageObject 表示线程中的消息。 Yes
事件 字符串 Yes

Data: messageObject

事件枚举：MessageStreamEventCompleted

Value Description
thread.message.completed

thread.message.incomplete

在消息完成之前结束时发生。

Name 类型 Description Required Default
数据 messageObject 表示线程中的消息。 Yes
事件 字符串 Yes

Data: messageObject

事件枚举：MessageStreamEventIncomplete

Value Description
thread.message.incomplete

Annotation

此组件可以是下列组件之一：

Click

单击操作。

Name 类型 Description Required Default
button 枚举 指示单击期间按下了哪个鼠标按钮。 之 left一、 right、 wheel、、 back或 forward。

可能的值：left、、rightwheel、back、forward		 Yes
类型 枚举 指定事件类型。 对于单击操作，此属性始终设置为 click。

可能的值： click		 Yes
x 整数 单击位置的 x 坐标。
 Yes
y 整数 发生单击的位置的 y 坐标。
 Yes

CodeInterpreterFileOutput

作为文件的代码解释器工具调用的输出。

Name 类型 Description Required Default
files 数组 Yes
类型 枚举 代码解释器文件输出的类型。 始终 files。

可能的值： files		 Yes

CodeInterpreterTextOutput

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

Name 类型 Description Required Default
日志 字符串 代码解释器工具调用的日志。
 Yes
类型 枚举 代码解释器文本输出的类型。 始终 logs。

可能的值： logs		 Yes

CodeInterpreterTool

运行代码的工具。

Name 类型 Description Required Default
file_ids 数组 要运行代码的文件 ID。
 Yes
类型 枚举 代码解释器工具的类型。 始终 code_interpreter。

可能的值： code_interpreter		 Yes

CodeInterpreterToolCall

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

Name 类型 Description Required Default
代码 字符串 要运行的代码。
 Yes
id 字符串 代码解释器工具调用的唯一 ID。
 Yes
results 数组 代码解释器工具调用的结果。
 Yes
状态 枚举 代码解释器工具调用的状态。

可能的值：in_progress、、 interpretingcompleted		 Yes
类型 枚举 代码解释器工具调用的类型。 始终 code_interpreter_call。

可能的值： code_interpreter_call		 Yes

CodeInterpreterToolOutput

此组件可以是下列组件之一：

ComparisonFilter

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

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

可能的值：eq、、ne、gtgte、lt、lte		 Yes
value 字符串或数字或布尔值 要与属性键进行比较的值;支持字符串、数字或布尔类型。 Yes

CompoundFilter

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

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

ComputerAction

此组件可以是下列组件之一：

ComputerScreenshotImage

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

Name 类型 Description Required Default
file_id 字符串 包含屏幕截图的上传文件的标识符。 No
image_url 字符串 屏幕截图图像的 URL。 No
类型 枚举 指定事件类型。 对于计算机屏幕截图，此属性始终设置为 computer_screenshot。

可能的值： computer_screenshot		 Yes

ComputerTool

控制虚拟计算机的工具。

Name 类型 Description Required Default
display_height number 计算机显示的高度。
 Yes
display_width number 计算机的显示宽度。
 Yes
环境 枚举 要控制的计算机环境的类型。

可能的值：mac、、windows、 ubuntubrowser		 Yes
类型 枚举 计算机使用工具的类型。 始终 computer_use_preview。

可能的值： computer-use-preview		 Yes

ComputerToolCall

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

Name 类型 Description Required Default
操作 ComputerAction Yes
call_id 字符串 使用输出响应工具调用时使用的标识符。
 Yes
id 字符串 计算机调用的唯一 ID。 Yes
pending_safety_checks 数组 挂起的安全检查计算机调用。
 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 Yes
类型 枚举 计算机调用的类型。 始终 computer_call。
可能的值： computer_call		 Yes

ComputerToolCallOutput

计算机工具调用的输出。

Name 类型 Description Required Default
acknowledged_safety_checks 数组 由开发人员确认的 API 报告的安全检查。
 No
call_id 字符串 生成输出的计算机工具调用的 ID。
 Yes
id 字符串 计算机工具调用输出的 ID。
 No
输出 ComputerScreenshotImage 与计算机使用工具一起使用的计算机屏幕截图图像。
 Yes
状态 枚举 消息输入的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回输入项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 计算机工具调用输出的类型。 始终 computer_call_output。

可能的值： computer_call_output		 Yes

ComputerToolCallOutputResource

Name 类型 Description Required Default
acknowledged_safety_checks 数组 由开发人员确认的 API 报告的安全检查。
 No
call_id 字符串 生成输出的计算机工具调用的 ID。
 Yes
id 字符串 计算机调用工具输出的唯一 ID。
 Yes
输出 ComputerScreenshotImage 与计算机使用工具一起使用的计算机屏幕截图图像。
 Yes
状态 枚举 消息输入的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回输入项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 计算机工具调用输出的类型。 始终 computer_call_output。

可能的值： computer_call_output		 Yes

ComputerToolCallSafetyCheck

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

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

Content

多模式输入和输出内容。

此组件可以是下列组件之一：

Coordinate

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

Name 类型 Description Required Default
x 整数 The x-coordinate.
 Yes
y 整数 The y-coordinate.
 Yes

CreateModelResponseProperties

Name 类型 Description Required Default
元数据 Metadata 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。

键是最大长度为 64 个字符的字符串。 值为最大长度为 512 个字符的字符串。
 No
模型 字符串 用于生成响应的模型。 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
我们通常建议更改这一点， top_p 但不建议同时更改这两者。
 No 1
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。
 No 1
用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 .
 No

createResponse

Name 类型 Description Required Default
include 数组 {"$ref": "#/components/schemas/includable/description"} No
输入 字符串或数组 用于生成响应的模型的文本、图像或文件输入。 Yes
instructions 字符串 将系统（或开发人员）消息作为模型上下文中的第一项插入。

与之前响应一起使用 previous_response_id时，不会将上一个响应中的说明转交给下一个响应。 这样就可以轻松地在新响应中交换系统（或开发人员）消息。
 No
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和推理令牌。
 No
parallel_tool_calls boolean 是否允许模型并行运行工具调用。
 No True
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此方法可创建多轮次对话。 No
reasoning Reasoning 推理模型的配置选项。 No
存储 boolean 是否存储生成的模型响应，以便以后通过 API 进行检索。
 No True
数据流 boolean 如果设置为 true，模型响应数据将流式传输到客户端，因为它使用 服务器发送的事件生成。 No False
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯文本或结构化 JSON 数据。 Learn more:
- 文本输入和输出
- 结构化输出
 No
└─ format TextResponseFormatConfiguration 一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。 默认格式 { "type": "text" } 没有其他选项。

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

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。 对于支持它的模型，首选使用 json_schema 。
 No
tool_choice ToolChoiceOptions 或 ToolChoiceTypes 或 ToolChoiceFunction 模型在生成响应时应如何选择要使用的工具（或工具）。 请参阅参数 tools ，了解如何指定模型可以调用的工具。
 No
tools 数组 生成响应时，模型可能会调用的工具数组。 可以通过设置 tool_choice 参数来指定要使用的工具。

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

- 内置工具		 No
truncation 枚举 要用于模型响应的截断策略。
- auto：如果此响应的上下文和以前的上下文超过模型的上下文窗口大小，则模型将截断
通过删除会话中间的输入项来响应上下文窗口。
- disabled （默认值）：如果模型响应将超过模型的上下文窗口大小，则请求将失败并出现 400 错误。

可能的值： autodisabled		 No

DoubleClick

双击操作。

Name 类型 Description Required Default
类型 枚举 指定事件类型。 对于双击操作，此属性始终设置为 double_click。

可能的值： double_click		 Yes
x 整数 出现双击的 x 坐标。
 Yes
y 整数 发生双击的 y 坐标。
 Yes

Drag

拖动操作。

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

可能的值： drag		 Yes

EasyInputMessage

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

Name 类型 Description Required Default
内容 string 或 InputMessageContentList 用于生成响应的模型的文本、图像或音频输入。
还可以包含以前的助理响应。
 Yes
角色 枚举 消息输入的角色。 之user一、assistantsystem或developer。

可能的值：user、、assistant、 systemdeveloper		 Yes
类型 枚举 消息输入的类型。 始终 message。

可能的值： message		 No

FileCitation

指向文件的引文。

Name 类型 Description Required Default
file_id 字符串 文件的 ID。
 Yes
索引 整数 文件列表中的文件的索引。
 Yes
类型 枚举 文件引文的类型。 始终 file_citation。

可能的值： file_citation		 Yes

FilePath

文件的路径。

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

可能的值： file_path		 Yes

FileSearchRanker

要用于文件搜索的排名器。 如果未指定，将使用 auto 排名器。

Property Value
Description 要用于文件搜索的排名器。 如果未指定，将使用 auto 排名器。
Type 字符串
Values auto
default_2024_08_21

FileSearchTool

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

Name 类型 Description Required Default
filters ComparisonFilter 或 CompoundFilter 基于文件属性应用的筛选器。 No
max_num_results 整数 要返回的最大结果数。 此数字应介于 1 和 50 之间（含）。
 No
ranking_options 对象 用于搜索的排名选项。 No
└─ ranker 枚举 要用于文件搜索的排名器。
可能的值： autodefault-2024-11-15		 No
└─ score_threshold number 文件搜索的分数阈值，介于 0 和 1 之间。
接近 1 的数字将尝试仅返回最相关的结果，但可能会返回更少的结果。
 No 0
类型 枚举 文件搜索工具的类型。 始终 file_search。

可能的值： file_search		 Yes
vector_store_ids 数组 要搜索的向量存储的 ID。
 Yes

FileSearchToolCall

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

Name 类型 Description Required Default
id 字符串 文件搜索工具调用的唯一 ID。
 Yes
queries 数组 用于搜索文件的查询。
 Yes
results 数组 文件搜索工具调用的结果。
 No
状态 枚举 文件搜索工具调用的状态。 之in_progress一、searchingincomplete或failed

可能的值：in_progress、、searchingcompleted、incomplete、failed		 Yes
类型 枚举 文件搜索工具调用的类型。 始终 file_search_call。

可能的值： file_search_call		 Yes

FunctionTool

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

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

可能的值： function		 Yes

FunctionToolCall

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

Name 类型 Description Required Default
arguments 字符串 要传递给函数的参数的 JSON 字符串。
 Yes
call_id 字符串 模型生成的函数工具调用的唯一 ID。
 Yes
id 字符串 函数工具调用的唯一 ID。
 Yes
name 字符串 要运行的函数的名称。
 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 函数工具调用的类型。 始终 function_call。

可能的值： function_call		 Yes

FunctionToolCallOutput

函数工具调用的输出。

Name 类型 Description Required Default
call_id 字符串 模型生成的函数工具调用的唯一 ID。
 Yes
id 字符串 函数工具调用输出的唯一 ID。 通过 API 返回此项时填充。
 No
输出 字符串 函数工具调用输出的 JSON 字符串。
 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 函数工具调用输出的类型。 始终 function_call_output。

可能的值： function_call_output		 Yes

FunctionToolCallOutputResource

Name 类型 Description Required Default
call_id 字符串 模型生成的函数工具调用的唯一 ID。
 Yes
id 字符串 函数调用工具输出的唯一 ID。
 Yes
输出 字符串 函数工具调用输出的 JSON 字符串。
 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 函数工具调用输出的类型。 始终 function_call_output。

可能的值： function_call_output		 Yes

includable

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

  • file_search_call.results：包括文件搜索工具调用的搜索结果。
  • message.input_image.image_url：包括输入消息中的图像 URL。
  • computer_call_output.output.image_url：包括计算机调用输出中的图像 URL。
Property Value
Description 指定要包含在模型响应中的其他输出数据。 当前支持的值包括：
- file_search_call.results：包括文件搜索工具调用的搜索结果。
- message.input_image.image_url：包括输入消息中的图像 URL。
- computer_call_output.output.image_url：包括计算机调用输出中的图像 URL。
Type 字符串
Values file_search_call.results
message.input_image.image_url
computer_call_output.output.image_url

InputAudio

模型的音频输入。

Name 类型 Description Required Default
数据 字符串 Base64 编码的音频数据。
 Yes
format 枚举 音频数据的格式。 当前支持的格式为 mp3 和 wav。

可能的值： mp3wav		 Yes
类型 枚举 输入项的类型。 始终 input_audio。

可能的值： input_audio		 Yes

InputContent

此组件可以是下列组件之一：

InputFile

模型的文件输入。

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

可能的值： input_file		 Yes

InputImage

模型的图像输入。

Name 类型 Description Required Default
detail 枚举 要发送到模型的图像的详细信息级别。 之highlow一，或auto。 默认值为 auto.

可能的值：high、、 lowauto		 Yes
file_id 字符串 要发送到模型的文件的 ID。
 No
image_url 字符串 要发送到模型的映像的 URL。 数据 URL 中的完全限定 URL 或 base64 编码图像。
 No
类型 枚举 输入项的类型。 始终 input_image。

可能的值： input_image		 Yes

InputItem

此组件可以是下列组件之一：

InputMessage

模型的消息输入，其中包含指示以下层次结构的说明的角色。 使用 developer 或 system 角色提供的说明优先于角色 user 提供的说明。

Name 类型 Description Required Default
内容 InputMessageContentList 模型包含一个或多个输入项的列表，其中包含不同的内容
types.
 Yes
角色 枚举 消息输入的角色。 之usersystem一，或developer。

可能的值：user、、 systemdeveloper		 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 消息输入的类型。 始终设置为 message.

可能的值： message		 No

InputMessageContentList

模型中包含一个或多个输入项的列表，其中包含不同的内容类型。

未为此组件定义任何属性。

InputMessageResource

Name 类型 Description Required Default
内容 InputMessageContentList 模型包含一个或多个输入项的列表，其中包含不同的内容
types.
 Yes
id 字符串 消息输入的唯一 ID。
 Yes
角色 枚举 消息输入的角色。 之usersystem一，或developer。

可能的值：user、、 systemdeveloper		 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 消息输入的类型。 始终设置为 message.

可能的值： message		 No

InputText

模型的文本输入。

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

可能的值： input_text		 Yes

Item

用于生成响应的内容项。

此组件可以是下列组件之一：

ItemReference

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

Name 类型 Description Required Default
id 字符串 要引用的项的 ID。
 Yes
类型 枚举 要引用的项的类型。 始终 item_reference。

可能的值： item_reference		 Yes

ItemResource

用于生成响应的内容项。

此组件可以是下列组件之一：

KeyPress

模型要执行的键压集合。

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

可能的值： keypress		 Yes

Metadata

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

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

未为此组件定义任何属性。

ModelResponseProperties

Name 类型 Description Required Default
元数据 Metadata 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。

键是最大长度为 64 个字符的字符串。 值为最大长度为 512 个字符的字符串。
 No
模型 字符串 用于生成响应的模型。 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
我们通常建议更改这一点， top_p 但不建议同时更改这两者。
 No 1
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。
 No 1
用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 .
 No

Move

鼠标移动操作。

Name 类型 Description Required Default
类型 枚举 指定事件类型。 对于移动操作，此属性始终设置为 move。

可能的值： move		 Yes
x 整数 要移动到的 x 坐标。
 Yes
y 整数 要移动到的 y 坐标。
 Yes

OutputAudio

模型的音频输出。

Name 类型 Description Required Default
数据 字符串 来自模型的 Base64 编码音频数据。
 Yes
脚本 字符串 来自模型的音频数据的脚本。
 Yes
类型 枚举 输出音频的类型。 始终 output_audio。

可能的值： output_audio		 Yes

OutputContent

此组件可以是下列组件之一：

OutputItem

Name 类型 Description Required Default
操作 ComputerAction Yes
arguments 字符串 要传递给函数的参数的 JSON 字符串。
 Yes
call_id 字符串 使用输出响应工具调用时使用的标识符。
 Yes
内容 数组 推理文本内容。
 Yes
id 字符串 推理内容的唯一标识符。
 Yes
name 字符串 要运行的函数的名称。
 Yes
pending_safety_checks 数组 挂起的安全检查计算机调用。
 Yes
queries 数组 用于搜索文件的查询。
 Yes
results 数组 文件搜索工具调用的结果。
 No
角色 枚举 输出消息的角色。 始终 assistant。

可能的值： assistant		 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 Yes
类型 枚举 对象的类型。 始终 reasoning。

可能的值： reasoning		 Yes

OutputMessage

模型的输出消息。

Name 类型 Description Required Default
内容 数组 输出消息的内容。
 Yes
id 字符串 输出消息的唯一 ID。
 Yes
角色 枚举 输出消息的角色。 始终 assistant。

可能的值： assistant		 Yes
状态 枚举 消息输入的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回输入项时填充。

可能的值：in_progress、、 completedincomplete		 Yes
类型 枚举 输出消息的类型。 始终 message。

可能的值： message		 Yes

OutputText

模型的文本输出。

Name 类型 Description Required Default
annotations 数组 文本输出的注释。
 Yes
文本消息 字符串 模型的文本输出。
 Yes
类型 枚举 输出文本的类型。 始终 output_text。

可能的值： output_text		 Yes

RealtimeSessionCreateRequest

实时会话对象配置。

Name 类型 Description Required Default
input_audio_format 枚举 输入音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
对于 pcm16，输入音频必须采用 24kHz 采样率、单声道（单声道）和小端字节顺序的 16 位 PCM。

可能的值：pcm16、、 g711_ulawg711_alaw		 No
input_audio_noise_reduction 对象 输入音频降噪的配置。 这可以设置为 null 关闭。
降噪会筛选添加到输入音频缓冲区的音频，然后再将其发送到 VAD 和模型。
筛选音频可以通过改进输入音频的感知来提高 VAD 和轮次检测准确性（减少误报）和模型性能。
 No
└─ type 枚举 降噪类型。 near_field 用于近距离麦克风（如耳机）， far_field 适用于远场麦克风，例如笔记本电脑或会议室麦克风。

可能的值： near_fieldfar_field		 No
input_audio_transcription 对象 输入音频听录的配置，默认设置为关闭，并且可以设置为 null 关闭一次。 输入音频听录不是模型的本机内容，因为模型直接使用音频。 听 录通过听录终结点 异步运行，应被视为输入音频内容的指南，而不是模型听到的内容。 客户端可以选择设置语言并提示听录，这些语言为听录服务提供其他指导。
 No
└─ language 字符串 输入音频的语言。 以 ISO-639-1 （例如 en）格式提供输入语言可提高准确性和延迟。
 No
└─ model 字符串 用于听录的模型，当前选项是gpt-4o-transcribe，gpt-4o-mini-transcribegpt-4o-mini-transcribe-2025-12-15和whisper-1。
 No
└─ prompt 字符串 用于指导模型样式或继续上一个音频段的可选文本。
对于 whisper-1，提示是关键字列表。
对于 gpt-4o-transcribe 模型，提示是一个自由文本字符串，例如“预期与技术相关的字词”。
 No
instructions 字符串 模型调用前的默认系统指令（即系统消息）。 此字段允许客户端指导模型处理所需的响应。 可以指示模型响应内容和格式（例如“非常简洁”、“行为友好”、“下面是良好响应的示例”）和音频行为（例如“快速说话”、“将情感注入语音”、“经常笑”）。 这些说明不保证遵循模型，但它们为模型提供有关所需行为的指南。

请注意，如果未设置此字段并在会话开始时在事件中 session.created 可见，服务器将设置默认说明。
 No
max_response_output_tokens 整数或字符串 单个助理响应（包括工具调用）的最大输出令牌数。 提供介于 1 和 4096 之间的整数来限制输出令牌，或者 inf 提供给定模型的最大可用令牌。 默认值为 inf.
 No
modalities 模型可以响应的一组形式。 若要禁用音频，请将此项设置为 [“text”]。
 No
模型 字符串 用于此会话的部署的名称。
 No
output_audio_format 枚举 输出音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
对于 pcm16，输出音频的采样速率为 24kHz。

可能的值：pcm16、、 g711_ulawg711_alaw		 No
temperature number 模型的采样温度限制为 [0.6， 1.2]。 对于音频模型，强烈建议将温度为 0.8，以获得最佳性能。
 No 0.8
tool_choice 字符串 模型如何选择工具。 选项为 auto、 none或 required指定函数。
 No auto
tools 数组 可用于模型的工具（函数）。 No
turn_detection 对象 用于轮次检测、以太网 VAD 或语义 VAD 的配置。 这可以设置为 null 关闭，在这种情况下，客户端必须手动触发模型响应。
服务器 VAD 表示模型将基于音频音量检测语音的开始和结束，并在用户语音结束时做出响应。
语义 VAD 更高级，使用轮次检测模型（与 VAD 结合使用）以语义方式估计用户是否已完成说话，然后根据此概率动态设置超时。 例如，如果用户音频离开， uhhm模型将得分低的轮次结束概率，并等待更长的用户继续说话。 这对于更自然的对话非常有用，但延迟可能更高。
 No
└─ create_response boolean 是否在发生 VAD 停止事件时自动生成响应。
 No True
└─ eagerness 枚举 仅用于 semantic_vad 模式。 模型渴望做出响应。 low 将等待更长的用户继续说话， high 将更快地响应。 auto 是默认值，等效于 medium。

可能的值：low、、medium、 highauto		 No
└─ interrupt_response boolean 在发生 VAD 启动事件时，是否自动中断任何持续响应，并将输出到默认会话（即 conversationauto） 中。
 No True
└─ prefix_padding_ms 整数 仅用于 server_vad 模式。 VAD 检测到语音之前要包括的音频量（以毫秒为单位）。 默认为 300 毫秒。
 No
└─ silence_duration_ms 整数 仅用于 server_vad 模式。 用于检测语音停止的沉默持续时间（以毫秒为单位）。 默认值为 500 毫秒。 使用较短的值，模型将更快地响应，但可能会从用户短暂暂停时跳入。
 No
└─ threshold number 仅用于 server_vad 模式。 VAD（0.0 到 1.0）的激活阈值，默认为 0.5。 更高的阈值需要更响亮的音频来激活模型，因此在干扰环境中性能可能更好。
 No
└─ type 枚举 轮次检测的类型。

可能的值： server_vadsemantic_vad		 No
voice VoiceIdsShared No

RealtimeSessionCreateResponse

具有临时密钥的新实时会话配置。 密钥的默认 TTL 为 1 分钟。

Name 类型 Description Required Default
client_secret 对象 API 返回的临时密钥。 Yes
└─ expires_at 整数 令牌过期时的时间戳。 目前，所有令牌在一分钟后过期。
 No
└─ value 字符串 在客户端环境中可用的临时密钥，用于对与实时 API 的连接进行身份验证。 在客户端环境中使用此令牌，而不是应仅使用服务器端的标准 API 令牌。
 No
input_audio_format 字符串 输入音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
 No
input_audio_transcription 对象 输入音频听录的配置，默认设置为关闭，并且可以设置为 null 关闭一次。 输入音频听录不是模型的本机内容，因为模型直接使用音频。 听录通过 Whisper 异步运行，应被视为粗略的指导，而不是模型理解的表示形式。
 No
└─ model 字符串 用于听 whisper-1 录的模型是目前唯一受支持的模型。
 No
instructions 字符串 模型调用前的默认系统指令（即系统消息）。 此字段允许客户端指导模型处理所需的响应。 可以针对响应内容和格式（例如“非常简洁”、“行为友好”、“下面是良好响应的示例”）以及音频行为（例如“快速说话”、“将情感注入语音”、“经常笑”）进行指示。 这些说明不保证遵循模型，但它们为模型提供有关所需行为的指南。
请注意，如果未设置此字段并在会话开始时在事件中 session.created 可见，服务器将设置默认说明。
 No
max_response_output_tokens 整数或字符串 单个助理响应（包括工具调用）的最大输出令牌数。 提供介于 1 和 4096 之间的整数来限制输出令牌，或者 inf 提供给定模型的最大可用令牌。 默认值为 inf.
 No
modalities 模型可以响应的一组形式。 若要禁用音频，请将此项设置为 [“text”]。
 No
output_audio_format 字符串 输出音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
 No
temperature number 模型的采样温度限制为 [0.6， 1.2]。 默认值为 0.8。
 No
tool_choice 字符串 模型如何选择工具。 选项为 auto、 none或 required指定函数。
 No
tools 数组 可用于模型的工具（函数）。 No
turn_detection 对象 轮次检测的配置。 可以设置为 null 关闭。 服务器 VAD 表示模型将基于音频音量检测语音的开始和结束，并在用户语音结束时做出响应。
 No
└─ prefix_padding_ms 整数 VAD 检测到语音之前要包括的音频量（以毫秒为单位）。 默认为 300 毫秒。
 No
└─ silence_duration_ms 整数 用于检测语音停止的沉默持续时间（以毫秒为单位）。 默认值为 500 毫秒。 使用较短的值，模型将更快地响应，但可能会从用户短暂暂停时跳入。
 No
└─ threshold number VAD（0.0 到 1.0）的激活阈值，默认为 0.5。 更高的阈值需要更响亮的音频来激活模型，因此在干扰环境中性能可能更好。
 No
└─ type 字符串 轮次检测的类型，目前仅 server_vad 受支持。
 No
voice VoiceIdsShared No

RealtimeTranscriptionSessionCreateRequest

实时听录会话对象配置。

Name 类型 Description Required Default
include 数组 要包含在听录中的项集。 当前可用的项包括：
- item.input_audio_transcription.logprobs
 No
input_audio_format 枚举 输入音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
对于 pcm16，输入音频必须采用 24kHz 采样率、单声道（单声道）和小端字节顺序的 16 位 PCM。

可能的值：pcm16、、 g711_ulawg711_alaw		 No
input_audio_noise_reduction 对象 输入音频降噪的配置。 这可以设置为 null 关闭。
降噪会筛选添加到输入音频缓冲区的音频，然后再将其发送到 VAD 和模型。
筛选音频可以通过改进输入音频的感知来提高 VAD 和轮次检测准确性（减少误报）和模型性能。
 No
└─ type 枚举 降噪类型。 near_field 用于近距离麦克风（如耳机）， far_field 适用于远场麦克风，例如笔记本电脑或会议室麦克风。

可能的值： near_fieldfar_field		 No
input_audio_transcription 对象 输入音频听录的配置。 客户端可以选择设置语言并提示听录，这些语言为听录服务提供其他指导。
 No
└─ language 字符串 输入音频的语言。 以 ISO-639-1 （例如 en）格式提供输入语言可提高准确性和延迟。
 No
└─ model 枚举 用于听录的模型，当前选项为 gpt-4o-transcribe、 gpt-4o-transcribe-diarize、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15和 whisper-1。

可能的值：gpt-4o-transcribe、、gpt-4o-transcribe-diarizegpt-4o-mini-transcribe、gpt-4o-mini-transcribe-2025-12-15、whisper-1		 No
└─ prompt 字符串 用于指导模型样式或继续上一个音频段的可选文本。
对于 whisper-1，提示是关键字列表。
对于 gpt-4o-transcribe 模型，提示是一个自由文本字符串，例如“预期与技术相关的字词”。
 No
modalities 模型可以响应的一组形式。 若要禁用音频，请将此项设置为 [“text”]。
 No
turn_detection 对象 用于轮次检测、以太网 VAD 或语义 VAD 的配置。 这可以设置为 null 关闭，在这种情况下，客户端必须手动触发模型响应。
服务器 VAD 表示模型将基于音频音量检测语音的开始和结束，并在用户语音结束时做出响应。
语义 VAD 更高级，使用轮次检测模型（与 VAD 结合使用）以语义方式估计用户是否已完成说话，然后根据此概率动态设置超时。 例如，如果用户音频离开， uhhm模型将得分低的轮次结束概率，并等待更长的用户继续说话。 这对于更自然的对话非常有用，但延迟可能更高。
 No
└─ create_response boolean 是否在发生 VAD 停止事件时自动生成响应。 不适用于听录会话。
 No True
└─ eagerness 枚举 仅用于 semantic_vad 模式。 模型渴望做出响应。 low 将等待更长的用户继续说话， high 将更快地响应。 auto 是默认值，等效于 medium。

可能的值：low、、medium、 highauto		 No
└─ interrupt_response boolean 在发生 VAD 启动事件时，是否自动中断任何持续响应，并将输出到默认会话（即 conversationauto） 中。 不适用于听录会话。
 No True
└─ prefix_padding_ms 整数 仅用于 server_vad 模式。 VAD 检测到语音之前要包括的音频量（以毫秒为单位）。 默认为 300 毫秒。
 No
└─ silence_duration_ms 整数 仅用于 server_vad 模式。 用于检测语音停止的沉默持续时间（以毫秒为单位）。 默认值为 500 毫秒。 使用较短的值，模型将更快地响应，但可能会从用户短暂暂停时跳入。
 No
└─ threshold number 仅用于 server_vad 模式。 VAD（0.0 到 1.0）的激活阈值，默认为 0.5。 更高的阈值需要更响亮的音频来激活模型，因此在干扰环境中性能可能更好。
 No
└─ type 枚举 轮次检测的类型。

可能的值： server_vadsemantic_vad		 No

RealtimeTranscriptionSessionCreateResponse

新的实时听录会话配置。

通过 REST API 在服务器上创建会话时，会话对象还包含临时密钥。 密钥的默认 TTL 为 1 分钟。 当通过 WebSocket API 更新会话时，此属性不存在。

Name 类型 Description Required Default
client_secret 对象 API 返回的临时密钥。 仅当通过 REST API 在服务器上创建会话时才存在。
 Yes
└─ expires_at 整数 令牌过期时的时间戳。 目前，所有令牌在一分钟后过期。
 No
└─ value 字符串 在客户端环境中可用的临时密钥，用于对与实时 API 的连接进行身份验证。 在客户端环境中使用此令牌，而不是应仅使用服务器端的标准 API 令牌。
 No
input_audio_format 字符串 输入音频的格式。 选项为 pcm16、 g711_ulaw或 g711_alaw。
 No
input_audio_transcription 对象 脚本模型的配置。
 No
└─ language 字符串 输入音频的语言。 以 ISO-639-1 （例如 en）格式提供输入语言可提高准确性和延迟。
 No
└─ model 枚举 要用于听录的模型。 可以是 gpt-4o-transcribe、 gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15或 whisper-1。

可能的值：gpt-4o-transcribe、、gpt-4o-mini-transcribe、 gpt-4o-mini-transcribe-2025-12-15whisper-1		 No
└─ prompt 字符串 用于指导模型样式或继续上一个音频段的可选文本。 提示应与音频语言匹配。
 No
modalities 模型可以响应的一组形式。 若要禁用音频，请将此项设置为 [“text”]。
 No
turn_detection 对象 轮次检测的配置。 可以设置为 null 关闭。 服务器 VAD 表示模型将基于音频音量检测语音的开始和结束，并在用户语音结束时做出响应。
 No
└─ prefix_padding_ms 整数 VAD 检测到语音之前要包括的音频量（以毫秒为单位）。 默认为 300 毫秒。
 No
└─ silence_duration_ms 整数 用于检测语音停止的沉默持续时间（以毫秒为单位）。 默认值为 500 毫秒。 使用较短的值，模型将更快地响应，但可能会从用户短暂暂停时跳入。
 No
└─ threshold number VAD（0.0 到 1.0）的激活阈值，默认为 0.5。 更高的阈值需要更响亮的音频来激活模型，因此在干扰环境中性能可能更好。
 No
└─ type 字符串 轮次检测的类型，目前仅 server_vad 受支持。
 No

Reasoning

推理模型的配置选项。

Name 类型 Description Required Default
工作量 ReasoningEffort 限制推理模型的推理工作。
当前支持的值是 low， medium以及 high。 减少推理工作量可能会导致响应更快，在响应中用于推理的令牌更少。
 Yes 中
摘要 枚举 模型执行的推理摘要。 这对于调试和了解模型的推理过程非常有用。
之 concise 一或 detailed.

可能的值： concisedetailed		 No

ReasoningItem

描述推理模型在生成响应时使用的想法链。

Name 类型 Description Required Default
内容 数组 推理文本内容。
 Yes
id 字符串 推理内容的唯一标识符。
 Yes
状态 枚举 项的状态。 之in_progresscompleted一，或incomplete。 通过 API 返回项时填充。

可能的值：in_progress、、 completedincomplete		 No
类型 枚举 对象的类型。 始终 reasoning。

可能的值： reasoning		 Yes

Refusal

模型拒绝。

Name 类型 Description Required Default
refusal 字符串 模型的拒绝解释。
 Yes
类型 枚举 拒绝的类型。 始终 refusal。

可能的值： refusal		 Yes

response

Name 类型 Description Required Default
created_at number 创建此响应时的 Unix 时间戳（以秒为单位）。
 Yes
错误 ResponseError 当模型无法生成响应时返回的错误对象。
 Yes
id 字符串 此响应的唯一标识符。
 Yes
incomplete_details 对象 有关响应不完整的原因的详细信息。
 Yes
└─ reason 枚举 响应不完整的原因。
可能的值： max_output_tokenscontent_filter		 No
instructions 字符串 将系统（或开发人员）消息作为模型上下文中的第一项插入。

与之前响应一起使用 previous_response_id时，不会将上一个响应中的说明转交给下一个响应。 这样就可以轻松地在新响应中交换系统（或开发人员）消息。
 Yes
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和会话状态。
 No
元数据 Metadata 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。

键是最大长度为 64 个字符的字符串。 值为最大长度为 512 个字符的字符串。
 Yes
模型 字符串 用于生成响应的模型。 Yes
对象 枚举 此资源的对象类型 - 始终设置为 response。

可能的值： response		 Yes
输出 数组 模型生成的内容项数组。

- 数组中 output 项的长度和顺序取决于模型的响应。
- 如果不访问数组中的 output 第一项，并且假设它是包含 assistant 模型生成的内容的消息，则可以考虑使用 output_text SDK 中支持的属性。
 Yes
output_text 字符串 仅 SDK 的便利属性，该属性包含数组中所有 output_text 项的 output 聚合文本输出（如果有）。
Python 和 JavaScript SDK 中受支持。
 No
parallel_tool_calls boolean 是否允许模型并行运行工具调用。
 Yes True
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此方法可创建多轮次对话。 No
reasoning Reasoning 推理模型的配置选项。
 No
状态 枚举 响应生成的状态。 之completed一、failedin_progress或incomplete。

可能的值：completed、、failed、 in_progressincomplete		 No
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。
我们通常建议更改这一点， top_p 但不建议同时更改这两者。
 Yes 1
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯文本或结构化 JSON 数据。 Learn more:
- 文本输入和输出
- 结构化输出
 No
└─ format TextResponseFormatConfiguration 一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。 默认格式 { "type": "text" } 没有其他选项。

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

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。 对于支持它的模型，首选使用 json_schema 。
 No
tool_choice ToolChoiceOptions 或 ToolChoiceTypes 或 ToolChoiceFunction 模型在生成响应时应如何选择要使用的工具（或工具）。 请参阅参数 tools ，了解如何指定模型可以调用的工具。
 Yes
tools 数组 生成响应时，模型可能会调用的工具数组。 可以通过设置 tool_choice 参数来指定要使用的工具。

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

- 内置工具		 Yes
top_p number 一种使用温度采样的替代方法，称为核采样，模型将标记的结果视为具有top_p概率质量的标记的结果。 因此，0.1 表示只考虑包含前 10 个% 概率质量的标记。

我们通常建议更改这一点， temperature 但不建议同时更改这两者。
 Yes 1
truncation 枚举 要用于模型响应的截断策略。
- auto：如果此响应的上下文和以前的上下文超出模型的上下文窗口大小，则模型将通过删除会话中间的输入项来截断响应以适应上下文窗口。
- disabled （默认值）：如果模型响应将超过模型的上下文窗口大小，则请求将失败并出现 400 错误。

可能的值： autodisabled		 No
使用情况 ResponseUsage 表示令牌使用情况详细信息，包括输入令牌、输出令牌、输出令牌细分以及所使用的令牌总数。
 No
用户 字符串 表示最终用户的唯一标识符，可帮助 OpenAI 监视和检测滥用行为。 .
 No

ResponseAudioDeltaEvent

当有部分音频响应时发出。

Name 类型 Description Required Default
delta 字符串 Base64 编码的音频字节块。
 Yes
类型 枚举 事件的类型。 始终 response.audio.delta。

可能的值： response.audio.delta		 Yes

ResponseAudioDoneEvent

当音频响应完成时发出。

Name 类型 Description Required Default
类型 枚举 事件的类型。 始终 response.audio.done。

可能的值： response.audio.done		 Yes

ResponseAudioTranscriptDeltaEvent

当有部分音频脚本时发出。

Name 类型 Description Required Default
delta 字符串 音频响应的部分脚本。
 Yes
类型 枚举 事件的类型。 始终 response.audio.transcript.delta。

可能的值： response.audio.transcript.delta		 Yes

ResponseAudioTranscriptDoneEvent

完整音频脚本完成时发出。

Name 类型 Description Required Default
类型 枚举 事件的类型。 始终 response.audio.transcript.done。

可能的值： response.audio.transcript.done		 Yes

ResponseCodeInterpreterCallCodeDeltaEvent

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

Name 类型 Description Required Default
delta 字符串 代码解释器添加的部分代码片段。
 Yes
output_index 整数 代码解释器调用的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.code_interpreter_call.code.delta。

可能的值： response.code_interpreter_call.code.delta		 Yes

ResponseCodeInterpreterCallCodeDoneEvent

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

Name 类型 Description Required Default
代码 字符串 代码解释器输出的最终代码片段。
 Yes
output_index 整数 代码解释器调用的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.code_interpreter_call.code.done。

可能的值： response.code_interpreter_call.code.done		 Yes

ResponseCodeInterpreterCallCompletedEvent

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

Name 类型 Description Required Default
code_interpreter_call CodeInterpreterToolCall 用于运行代码的工具调用。
 Yes
output_index 整数 代码解释器调用的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.code_interpreter_call.completed。

可能的值： response.code_interpreter_call.completed		 Yes

ResponseCodeInterpreterCallInProgressEvent

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

Name 类型 Description Required Default
code_interpreter_call CodeInterpreterToolCall 用于运行代码的工具调用。
 Yes
output_index 整数 代码解释器调用的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.code_interpreter_call.in_progress。

可能的值： response.code_interpreter_call.in_progress		 Yes

ResponseCodeInterpreterCallInterpretingEvent

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

Name 类型 Description Required Default
code_interpreter_call CodeInterpreterToolCall 用于运行代码的工具调用。
 Yes
output_index 整数 代码解释器调用的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.code_interpreter_call.interpreting。

可能的值： response.code_interpreter_call.interpreting		 Yes

ResponseCompletedEvent

模型响应完成时发出。

Name 类型 Description Required Default
response response Yes
类型 枚举 事件的类型。 始终 response.completed。

可能的值： response.completed		 Yes

ResponseContentPartAddedEvent

添加新内容部件时发出。

Name 类型 Description Required Default
content_index 整数 已添加的内容部件的索引。
 Yes
item_id 字符串 内容部件添加到的输出项的 ID。
 Yes
output_index 整数 内容部件添加到的输出项的索引。
 Yes
部件 OutputContent Yes
类型 枚举 事件的类型。 始终 response.content_part.added。

可能的值： response.content_part.added		 Yes

ResponseContentPartDoneEvent

完成内容部件时发出。

Name 类型 Description Required Default
content_index 整数 完成的内容部件的索引。
 Yes
item_id 字符串 内容部件添加到的输出项的 ID。
 Yes
output_index 整数 内容部件添加到的输出项的索引。
 Yes
部件 OutputContent Yes
类型 枚举 事件的类型。 始终 response.content_part.done。

可能的值： response.content_part.done		 Yes

ResponseCreatedEvent

创建响应时发出的事件。

Name 类型 Description Required Default
response response Yes
类型 枚举 事件的类型。 始终 response.created。

可能的值： response.created		 Yes

ResponseError

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

Name 类型 Description Required Default
代码 ResponseErrorCode 响应的错误代码。
 Yes
消息 字符串 错误的人工可读说明。
 Yes

ResponseErrorCode

响应的错误代码。

Property Value
Description 响应的错误代码。
Type 字符串
Values server_error
rate_limit_exceeded
invalid_prompt
vector_store_timeout
invalid_image
invalid_image_format
invalid_base64_image
invalid_image_url
image_too_large
image_too_small
image_parse_error
image_content_policy_violation
invalid_image_mode
image_file_too_large
unsupported_image_media_type
empty_image_file
failed_to_download_image
image_file_not_found

ResponseErrorEvent

发生错误时发出。

Name 类型 Description Required Default
代码 字符串 错误代码。
 Yes
消息 字符串 错误消息。
 Yes
param 字符串 错误参数。
 Yes
类型 枚举 事件的类型。 始终 error。

可能的值： error		 Yes

ResponseFailedEvent

响应失败时发出的事件。

Name 类型 Description Required Default
response response Yes
类型 枚举 事件的类型。 始终 response.failed。

可能的值： response.failed		 Yes

ResponseFileSearchCallCompletedEvent

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

Name 类型 Description Required Default
item_id 字符串 启动文件搜索调用的输出项的 ID。
 Yes
output_index 整数 启动文件搜索调用的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.file_search_call.completed。

可能的值： response.file_search_call.completed		 Yes

ResponseFileSearchCallInProgressEvent

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

Name 类型 Description Required Default
item_id 字符串 启动文件搜索调用的输出项的 ID。
 Yes
output_index 整数 启动文件搜索调用的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.file_search_call.in_progress。

可能的值： response.file_search_call.in_progress		 Yes

ResponseFileSearchCallSearchingEvent

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

Name 类型 Description Required Default
item_id 字符串 启动文件搜索调用的输出项的 ID。
 Yes
output_index 整数 文件搜索调用正在搜索的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.file_search_call.searching。

可能的值： response.file_search_call.searching		 Yes

ResponseFunctionCallArgumentsDeltaEvent

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

Name 类型 Description Required Default
delta 字符串 添加的函数调用参数增量。
 Yes
item_id 字符串 函数调用参数增量添加到的输出项的 ID。
 Yes
output_index 整数 函数调用参数增量添加到的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.function_call_arguments.delta。

可能的值： response.function_call_arguments.delta		 Yes

ResponseFunctionCallArgumentsDoneEvent

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

Name 类型 Description Required Default
arguments 字符串 函数调用参数。 Yes
item_id 字符串 项的 ID。 Yes
output_index 整数 输出项的索引。 Yes
类型 枚举
可能的值： response.function_call_arguments.done		 Yes

ResponseInProgressEvent

响应正在进行时发出。

Name 类型 Description Required Default
response response Yes
类型 枚举 事件的类型。 始终 response.in_progress。

可能的值： response.in_progress		 Yes

ResponseIncompleteEvent

响应完成时发出的事件不完整。

Name 类型 Description Required Default
response response Yes
类型 枚举 事件的类型。 始终 response.incomplete。

可能的值： response.incomplete		 Yes

responseItemList

响应项的列表。

Name 类型 Description Required Default
数据 数组 用于生成此响应的项列表。 Yes
first_id 字符串 列表中第一项的 ID。 Yes
has_more boolean 是否有更多可用项。 Yes
last_id 字符串 列表中最后一项的 ID。 Yes
对象 枚举 返回的对象的类型必须是 list。
可能的值： list		 Yes

ResponseModalities

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

["text"]

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

["text", "audio"]

未为此组件定义任何属性。

ResponseModalitiesTextOnly

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

["text"]

此 API 将很快支持其他输出形式，包括音频和图像。

未为此组件定义任何属性。

ResponseOutputItemAddedEvent

添加新的输出项时发出。

Name 类型 Description Required Default
项 OutputItem Yes
output_index 整数 已添加的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.output_item.added。

可能的值： response.output_item.added		 Yes

ResponseOutputItemDoneEvent

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

Name 类型 Description Required Default
项 OutputItem Yes
output_index 整数 标记为已完成的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.output_item.done。

可能的值： response.output_item.done		 Yes

ResponseProperties

Name 类型 Description Required Default
instructions 字符串 将系统（或开发人员）消息作为模型上下文中的第一项插入。

与之前响应一起使用 previous_response_id时，不会将上一个响应中的说明转交给下一个响应。 这样就可以轻松地在新响应中交换系统（或开发人员）消息。
 No
max_output_tokens 整数 可为响应生成的令牌数上限，包括可见输出令牌和会话状态。
 No
previous_response_id 字符串 对模型的上一个响应的唯一 ID。 使用此方法可创建多轮次对话。 No
reasoning Reasoning 推理模型的配置选项。
 No
文本消息 对象 来自模型的文本响应的配置选项。 可以是纯文本或结构化 JSON 数据。 Learn more:
- 文本输入和输出
- 结构化输出
 No
└─ format TextResponseFormatConfiguration 一个对象，指定模型必须输出的格式。

配置 { "type": "json_schema" } 启用结构化输出，这可确保模型与提供的 JSON 架构匹配。 默认格式 { "type": "text" } 没有其他选项。

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

{ "type": "json_object" }设置为启用较旧的 JSON 模式，这可确保模型生成的消息是有效的 JSON。 对于支持它的模型，首选使用 json_schema 。
 No
tool_choice ToolChoiceOptions 或 ToolChoiceTypes 或 ToolChoiceFunction 模型在生成响应时应如何选择要使用的工具（或工具）。 请参阅参数 tools ，了解如何指定模型可以调用的工具。
 No
tools 数组 生成响应时，模型可能会调用的工具数组。 可以通过设置 tool_choice 参数来指定要使用的工具。

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

- 内置工具		 No
truncation 枚举 要用于模型响应的截断策略。
- auto：如果此响应的上下文和以前的上下文超出模型的上下文窗口大小，则模型将通过删除会话中间的输入项来截断响应以适应上下文窗口。
- disabled （默认值）：如果模型响应将超过模型的上下文窗口大小，则请求将失败并出现 400 错误。

可能的值： autodisabled		 No

ResponseRefusalDeltaEvent

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

Name 类型 Description Required Default
content_index 整数 拒绝文本添加到的内容部件的索引。
 Yes
delta 字符串 添加的拒绝文本。
 Yes
item_id 字符串 拒绝文本添加到的输出项的 ID。
 Yes
output_index 整数 拒绝文本添加到的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.refusal.delta。

可能的值： response.refusal.delta		 Yes

ResponseRefusalDoneEvent

在拒绝文本完成时发出。

Name 类型 Description Required Default
content_index 整数 拒绝文本完成的内容部分的索引。
 Yes
item_id 字符串 拒绝文本最终完成的输出项的 ID。
 Yes
output_index 整数 拒绝文本最终完成的输出项的索引。
 Yes
refusal 字符串 最终完成的拒绝文本。
 Yes
类型 枚举 事件的类型。 始终 response.refusal.done。

可能的值： response.refusal.done		 Yes

responseStreamEvent

Name 类型 Description Required Default
注释 Annotation Yes
annotation_index 整数 已添加的批注的索引。
 Yes
arguments 字符串 函数调用参数。 Yes
代码 字符串 错误代码。
 Yes
code_interpreter_call CodeInterpreterToolCall 用于运行代码的工具调用。
 Yes
content_index 整数 文本内容最终完成的内容部件的索引。
 Yes
delta 字符串 添加的文本增量。
 Yes
项 OutputItem 标记为已完成的输出项。
 Yes
item_id 字符串 文本内容的输出项的 ID。
 Yes
消息 字符串 错误消息。
 Yes
output_index 整数 文本内容的输出项的索引。
 Yes
param 字符串 错误参数。
 Yes
部件 OutputContent 完成的内容部分。
 Yes
refusal 字符串 最终完成的拒绝文本。
 Yes
response response 响应不完整。
 Yes
文本消息 字符串 最终完成的文本内容。
 Yes
类型 枚举 事件的类型。 始终 response.output_text.done。

可能的值： response.output_text.done		 Yes

ResponseTextAnnotationDeltaEvent

添加文本批注时发出。

Name 类型 Description Required Default
注释 Annotation Yes
annotation_index 整数 已添加的批注的索引。
 Yes
content_index 整数 文本批注添加到的内容部件的索引。
 Yes
item_id 字符串 文本批注添加到的输出项的 ID。
 Yes
output_index 整数 文本批注添加到的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.output_text.annotation.added。

可能的值： response.output_text.annotation.added		 Yes

ResponseTextDeltaEvent

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

Name 类型 Description Required Default
content_index 整数 文本增量添加到的内容部件的索引。
 Yes
delta 字符串 添加的文本增量。
 Yes
item_id 字符串 文本增量添加到的输出项的 ID。
 Yes
output_index 整数 文本增量添加到的输出项的索引。
 Yes
类型 枚举 事件的类型。 始终 response.output_text.delta。

可能的值： response.output_text.delta		 Yes

ResponseTextDoneEvent

在完成文本内容时发出。

Name 类型 Description Required Default
content_index 整数 文本内容最终完成的内容部件的索引。
 Yes
item_id 字符串 文本内容的输出项的 ID。
 Yes
output_index 整数 文本内容的输出项的索引。
 Yes
文本消息 字符串 最终完成的文本内容。
 Yes
类型 枚举 事件的类型。 始终 response.output_text.done。

可能的值： response.output_text.done		 Yes

ResponseUsage

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

Name 类型 Description Required Default
input_tokens 整数 输入令牌数。 Yes
output_tokens 整数 输出令牌数。 Yes
output_tokens_details 对象 输出令牌的详细细分。 Yes
└─ reasoning_tokens 整数 推理令牌的数量。 No
total_tokens 整数 使用的令牌总数。 Yes

Screenshot

屏幕截图操作。

Name 类型 Description Required Default
类型 枚举 指定事件类型。 对于屏幕截图操作，此属性始终设置为 screenshot。

可能的值： screenshot		 Yes

Scroll

滚动操作。

Name 类型 Description Required Default
scroll_x 整数 水平滚动距离。
 Yes
scroll_y 整数 垂直滚动距离。
 Yes
类型 枚举 指定事件类型。 对于滚动操作，此属性始终设置为 scroll。

可能的值： scroll		 Yes
x 整数 发生滚动的 x 坐标。
 Yes
y 整数 发生滚动的 y 坐标。
 Yes

StopConfiguration

API 停止生成进一步令牌的最多 4 个序列。 返回的文本将不包含停止序列。

此组件可以是下列组件之一：

TextResponseFormatConfiguration

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

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

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

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

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

此组件可以是下列组件之一：

TextResponseFormatJsonSchema

JSON 架构响应格式。 用于生成结构化 JSON 响应。 详细了解结构化输出。

Name 类型 Description Required Default
description 字符串 模型使用响应格式的说明来确定如何以格式进行响应。
 No
name 字符串 响应格式的名称。 必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。
 No
架构 ResponseFormatJsonSchemaSchema 响应格式的架构，描述为 JSON 架构对象。 Yes
strict boolean 是否在生成输出时启用严格的架构遵循。
如果设置为 true，则模型将始终遵循字段中定义的 schema 确切架构。 仅当为 时stricttrue仅支持 JSON 架构的子集。		 No False
类型 枚举 要定义的响应格式的类型。 始终 json_schema。
可能的值： json_schema		 Yes

Tool

此组件可以是下列组件之一：

ToolChoiceFunction

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

Name 类型 Description Required Default
name 字符串 要调用的函数的名称。 Yes
类型 枚举 对于函数调用，类型始终 function为 .
可能的值： function		 Yes

ToolChoiceOptions

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

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

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

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

Property Value
Description 控制模型调用哪个（如果有）工具。

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

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

required 表示模型必须调用一个或多个工具。
Type 字符串
Values none
auto
required

ToolChoiceTypes

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

Name 类型 Description Required Default
类型 枚举 模型应使用的托管工具的类型。 允许的值为：
- file_search
- computer_use_preview

可能的值： file_searchcomputer_use_preview		 Yes

类型

要键入文本的操作。

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

可能的值： type		 Yes

UpdateVectorStoreFileAttributesRequest

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

UrlCitation

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

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

可能的值： url_citation		 Yes
url 字符串 Web 资源的 URL。
 Yes

VectorStoreFileAttributes

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

未为此组件定义任何属性。

VectorStoreFileContentResponse

表示矢量存储文件的已分析内容。

Name 类型 Description Required Default
数据 数组 分析的文件内容。 Yes
has_more boolean 指示是否有更多要提取的内容页。 Yes
next_page 字符串 下一页的令牌（如果有）。 Yes
对象 枚举 对象类型，始终为 vector_store.file_content.page
可能的值： vector_store.file_content.page		 Yes

VectorStoreSearchRequest

Name 类型 Description Required Default
filters ComparisonFilter 或 CompoundFilter 基于文件属性应用的筛选器。 No
max_num_results 整数 要返回的最大结果数。 此数字应介于 1 和 50 之间（含）。 No 10
查询 字符串或数组 搜索的查询字符串 Yes
ranking_options 对象 用于搜索的排名选项。 No
└─ ranker 枚举 可能的值： autodefault-2024-11-15 No
└─ score_threshold number No 0
rewrite_query boolean 是否重写矢量搜索的自然语言查询。 No False

VectorStoreSearchResultContentObject

Name 类型 Description Required Default
文本消息 字符串 从搜索返回的文本内容。 Yes
类型 枚举 内容类型。
可能的值： text		 Yes

VectorStoreSearchResultItem

Name 类型 Description Required Default
attributes VectorStoreFileAttributes 可以附加到对象的 16 个键值对集。 这可用于以结构化格式存储有关对象的其他信息，以及通过 API 或仪表板查询对象。 键是最大长度为 64 个字符的字符串。 值为最大长度为 512 个字符、布尔值或数字的字符串。
 Yes
内容 数组 文件中的内容区块。 Yes
file_id 字符串 矢量存储文件的 ID。 Yes
filename 字符串 矢量存储文件的名称。 Yes
分数 number 结果的相似性分数。 Yes

VectorStoreSearchResultsPage

Name 类型 Description Required Default
数据 数组 搜索结果项的列表。 Yes
has_more boolean 指示是否有更多要提取的结果。 Yes
next_page 字符串 下一页的令牌（如果有）。 Yes
对象 枚举 对象类型，始终为 vector_store.search_results.page
可能的值： vector_store.search_results.page		 Yes
search_query 数组 Yes

VoiceIdsShared

未为此组件定义任何属性。

Wait

等待操作。

Name 类型 Description Required Default
类型 枚举 指定事件类型。 对于等待操作，此属性始终设置为 wait。

可能的值： wait		 Yes

ReasoningEffort

限制推理模型的推理工作。 当前支持的值是 low， medium以及 high。 减少推理工作量可能会导致响应更快，在响应中用于推理的令牌更少。

Property Value
Description 限制推理模型的推理工作。
当前支持的值是 low， medium以及 high。 减少推理工作量可能会导致响应更快，在响应中用于推理的令牌更少。
Type 字符串
Default 中
Values low
medium
high

errorEvent

发生错误时发生。 这可能是由于内部服务器错误或超时导致的。

Name 类型 Description Required Default
数据 error Yes
事件 字符串 Yes

事件枚举：ErrorEventEnum

Value Description
错误

doneEvent

在流结束时发生。

Name 类型 Description Required Default
数据 字符串 Yes
事件 字符串 Yes

事件枚举：DoneEventEnum

Value Description
done

数据枚举：DoneEventDataEnum

Value Description
[DONE]

Next steps

了解 模型，并使用 REST API 进行微调。 详细了解 支持 Azure OpenAI 的基础模型。

  • Last updated on