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

Azure OpenAI 服务 REST API 预览版参考

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

API 规范

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

• 控制面板
• 数据平面 - 创作
• 数据平面 - 推理

每个 API 图面/规范封装了一组不同的 Azure OpenAI 功能。 每个 API 都有自己独特的预览版和稳定/正式发布 (GA) API 版本集。 预览版目前按月发布。

API	最新预览版	最新 GA 版本	规范	说明
控制面板	2024-06-01-preview	2024-10-01	规范文件	Azure OpenAI 与所有其他 Azure AI 服务共享通用控制平面。 控制平面 API 用于创建 Azure OpenAI 资源、模型部署和其他更高级别的资源管理任务等。 控制平面还控制使用 Azure 资源管理器、Bicep、Terraform 和 Azure CLI 等功能可以执行的操作。
数据平面 - 创作	2024-10-01-preview	2024-10-21	规范文件	数据平面创作 API 可控制微调、文件上传、引入作业、批处理，以及某些模型级查询
数据平面 - 推理	2024-10-01-preview	2024-10-21	规范文件	数据平面推理 API 为补全、聊天补全、嵌入、语音/耳语、基于自有数据、Dall-e、助手等功能提供推理功能/终结点。

身份验证

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

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

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

REST API 版本控制

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

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

数据平面推理

本文的其余部分介绍了 Azure OpenAI 数据平面推理规范的最新预览版 2024-10-01-preview。 本文包含有关助手、线程和矢量存储等最新预览功能的文档。

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

补全 - 创建

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

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
deployment-id	path	是	string	已部署 模型的部署 ID。
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

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

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	createCompletionResponse	表示来自 API 的补全响应。 注意：流式处理和非流式处理的响应对象共享相同的形状（与聊天终结点不同）。

状态代码：默认值

说明：服务不可用

Content-Type	类型	描述
application/json	errorResponse

示例

示例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
deployment-id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
input	字符串或数组	要嵌入的输入文本，编码为字符串或令牌数组。 若要在单个请求中嵌入多项输入，请传递一个由字符串构成的数组或一个由令牌数组构成的数组。 输入不得超过模型的最大输入标记数（对于 text-embedding-ada-002 为 8,192 个标记），不能为空字符串，并且任何数组的维度都必须小于或等于 2,048。	是
user	string	表示最终用户的唯一标识符，可帮助监视和检测滥用行为。	否
input_type	string	要使用的嵌入搜索的输入类型	否
encoding_format	string	嵌入的返回格式。 可以为 float 或 base64。 默认为 float。	否
dimensions	integer	生成的输出嵌入应有的维度数。 仅在 text-embedding-3 及更高版本中受支持。	否

响应

名称	Type	描述	需要	默认
object	string		是
模型	string		是
data	array		是
使用情况	object		是

用法属性

prompt_tokens

名称	Type	描述	默认
prompt_tokens	integer

total_tokens

名称	Type	描述	默认
total_tokens	integer

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	object

示例

示例

返回给定提示的嵌入。

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-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.0040426035,
          -0.03443847,
          -0.00091273896,
          -0.0019217303,
          0.002349888,
          -0.021560553,
          0.016515596,
          -0.015572986,
          0.0038666942,
          -8.432463e-05,
          0.0032178196
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

聊天补全 - 创建

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

为聊天消息创建完成操作

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
deployment-id	path	是	string	已部署 模型的部署 ID。
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性 我们通常建议更改此设置或 top_p，但不要同时更改两者。	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或 temperature，但不要同时更改两者。	否	1
流 (stream)	boolean	如果设置此选项，将发送部分消息增量，如在 ChatGPT 中一样。 词元将在可用时作为服务器发送的事件发送（内容仅包括数据），并且流式传输将由 data: [DONE] 消息终止。	否	False
stop	字符串或数组	最多四个序列，其中 API 将停止生成进一步的令牌。	否
max_tokens	integer	可以在聊天补全时生成的最大词元数。 输入词元和生成的词元的总长度受模型上下文长度的限制。	否
max_completion_tokens	integer	可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 这仅在 o1 系列模型中受支持。 在未来的 API 版本中，会将支持扩展到其他模型。	否
presence_penalty	数字	介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止是否在文本中出现来惩罚新令牌，从而增加模型谈论新话题的可能性。	否	0
frequency_penalty	数字	介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。	否	0
logit_bias	object	修改指定令牌在完成中出现的可能性。 接受 JSON 对象，该对象将标记（由 tokenizer 中的标记 ID 指定）映射到从 -100 到 100 的相关偏差值。 在数学上，采样之前会将偏差添加到由模型生成的 logit 中。 具体效果因模型而异，但 -1 和 1 之间的值会减少或增加选择的可能性；-100 或 100 等值会导致相关令牌的禁止或独占选择。	否	无
user	string	表示最终用户的唯一标识符，可帮助监视和检测滥用行为。	否
messages	array	包含到目前为止的对话的消息列表。	是
data_sources	array	使用它们的 Azure OpenAI 聊天扩展的配置条目。 此附加规范仅与 Azure OpenAI 兼容。	否
logprobs	boolean	是否返回输出令牌的对数概率。 如果为 true，则返回在 message 的 content 中返回的每个输出令牌的对数概率。	否	False
top_logprobs	integer	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。 如果使用此参数，则必须将 logprobs 设置为 true。	否
n	integer	要为每个输入消息生成的聊天完成选项数。 请注意，将根据所有选项中生成的标记数向你收费。 将 n 保留为 1 以尽量降低成本。	否	1
parallel_tool_calls	ParallelToolCalls	是否在工具使用期间启用并行函数调用。	否	True
response_format	ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema	一个对象，指定模型必须输出的格式。 与 GPT-4o、GPT-4o mini、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，或者对话超过了最大上下文长度。	否
seed	integer	此功能以 Beta 版本提供。 指定后，我们的系统将尽最大努力进行确定性采样，以便具有相同 seed 和参数的重复请求应返回相同的结果。 无法保证确定性，你应参考 system_fingerprint 响应参数来监视后端的更改。	否
stream_options	chatCompletionStreamOptions	用于流式处理响应的选项。 仅在设置 stream: true 时设置此项。	否	无
工具	array	模型可能调用的工具列表。 目前，仅支持函数作为工具。 使用它可以提供函数列表，模型可能为其生成 JSON 输入。 最多支持 128 个函数。	否
tool_choice	chatCompletionToolChoiceOption	控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息和调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。 通过 {"type": "function", "function": {"name": "my_function"}} 指定特定工具将强制模型调用该工具。 如果没有工具，则 none 为默认值。 如果存在工具，则 auto 为默认值。	否
function_call	字符串或 chatCompletionFunctionCallOption	已弃用，改用 tool_choice。 控制模型调用的函数（如有）。 none 表示模型不会调用函数，而是生成消息。 auto 表示模型可以在生成消息和调用函数之间进行选择。 通过 {"name": "my_function"} 指定特定函数会强制模型调用该函数。 当不存在任何函数时，默认值为 none。 如果存在函数，则 auto 是默认值。	否
functions	array	弃用了，改用 tools。 模型可能为其生成 JSON 输入的函数的列表。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	createChatCompletionResponse 或 createChatCompletionStreamResponse

状态代码：默认值

说明：服务不可用

Content-Type	类型	描述
application/json	errorResponse

示例

示例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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
    }
  }
}

示例

基于 Azure 认知搜索数据和系统分配的托管标识创建补全。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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
    }
  }
}

示例

基于 Azure 认知搜索图像矢量数据创建补全。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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
    }
  }
}

示例

基于 Azure 认知搜索矢量数据、以前的助手消息和用户分配的托管标识创建补全。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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
    }
  }
}

示例

为提供的 Azure Cosmos DB 创建补全。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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
    }
  }
}

示例

为提供的 Mongo DB 创建补全。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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
    }
  }
}

示例

为提供的 Elasticsearch 创建补全。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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
    }
  }
}

示例

为提供的 Pinecone 资源创建补全。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2024-10-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=2024-10-01-preview

将音频转录为输入语言。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
deployment-id	path	是	string	耳语模型的部署 ID。
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

内容类型：multipart/form-data

名称	Type	描述	需要	默认
文件	string	要转录的音频文件对象。	是
prompt	string	用于指导模型风格或继续之前的音频片段的可选文本。 提示应与音频语言匹配。	否
response_format	audioResponseFormat	定义输出的格式。	否
温度	数字	采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性 如果设置为 0，则模型将使用对数概率自动升高温度，直到达到特定阈值。	否	0
language	string	输入音频的语言。 以 ISO-639-1 格式提供输入语言将提高准确性并减少延迟。	否
timestamp_granularities[]	array	要为此听录填充的时间戳粒度。 response_format 必须设为 verbose_json 以使用时间戳粒度。 支持以下任一选项或两个选项：word 或 segment。 注意：段时间戳没有额外的延迟，但生成单词时间戳会产生额外的延迟。	否	['segment']

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	audioResponse 或 audioVerboseResponse
text/plain	string	输出格式的转录文本（当 response_format 为 text、vtt 或 srt 之一时）。

示例

示例

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

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

响应：状态代码：200

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

示例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
deployment-id	path	是	string	已部署耳语模型的部署 ID。
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

内容类型：multipart/form-data

名称	Type	描述	需要	默认
文件	string	要翻译的音频文件。	是
prompt	string	用于指导模型风格或继续之前的音频片段的可选文本。 提示应为英语。	否
response_format	audioResponseFormat	定义输出的格式。	否
温度	数字	采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性 如果设置为 0，则模型将使用对数概率自动升高温度，直到达到特定阈值。	否	0

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	audioResponse 或 audioVerboseResponse
text/plain	string	输出格式的转录文本（当 response_format 为 text、vtt 或 srt 之一时）。

示例

示例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-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"
  }
}

示例

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-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=2024-10-01-preview

从输入文本生成音频。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
deployment-id	path	是	string	已部署 tts 模型的部署 ID。
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

内容类型：multipart/form-data

名称	Type	描述	需要	默认
input	string	要为其合成音频的文本。 最大长度为 4,096 个字符。	是
voice	enum	用于语音合成的语音。 可能的值：alloy、echo、fable、onyx、nova、shimmer	是
response_format	enum	合成音频的格式。 可能的值：mp3、opus、aac、flac、wav、pcm	否
速度	数字	合成音频的速度。 从 0.25 到 4.0 范围选择值。 1.0 是默认值。	否	1.0

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/octet-stream	string

示例

示例

从提供的文本合成音频。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2024-10-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=2024-10-01-preview

根据给定 DALLE 模型部署上的文本描述生成一批图像

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
deployment-id	path	是	string	已部署的 dalle 模型的部署 ID。
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
prompt	string	所需图像的文本说明。 最大长度为 4,000 个字符。	是
n	integer	要生成的图像数。	否	1
size	imageSize	生成的图像的大小。	否	1024x1024
response_format	imagesResponseFormat	返回生成图像的格式。	否	url
user	string	表示最终用户的唯一标识符，可帮助监视和检测滥用行为。	否
质量	imageQuality	将生成的图像的质量。	否	standard
style	imageStyle	生成的图像的样式。	否	vivid

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	generateImagesResponse

状态代码：默认值

说明：发生错误。

Content-Type	类型	描述
application/json	dalleErrorResponse

示例

示例

根据提示创建图像。

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-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
          }
        }
      }
    ]
  }
}

列表 - 助手

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

返回助手列表。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
limit	查询	否	integer
订单	查询	否	string
after	查询	否	string
before	查询	否	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	listAssistantsResponse

示例

示例

返回助手列表。

GET https://{endpoint}/openai/assistants?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
模型			是
名称	string	助手的名称。 最大长度为 256 个字符。	否
description	string	助手的说明。 最大长度为 512 个字符。	否
instructions	string	助手使用的系统说明。 最大长度为 256,000 个字符。	否
工具	array	在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具类型可以是 code_interpreter、retrieval 或 function。	否	[]
tool_resources	object	助手工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此助手的矢量存储。 助手最多可以附加 1 个矢量存储。
vector_stores	array	一个帮助程序，用于创建具有 file_ids 的矢量存储，并将其附加到此助手。 助手最多可以附加 1 个矢量存储。

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	assistantObject	表示可以调用模型并使用工具的 assistant。

示例

示例

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

POST https://{endpoint}/openai/assistants?api-version=2024-10-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=2024-10-01-preview

检索助手。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
assistant_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	assistantObject	表示可以调用模型并使用工具的 assistant。

示例

示例

检索助手。

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-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=2024-10-01-preview

修改助手。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
assistant_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
模型			否
name	string	助手的名称。 最大长度为 256 个字符。	否
description	string	助手的说明。 最大长度为 512 个字符。	否
instructions	string	助手使用的系统说明。 最大长度为 32,768 个字符。	否
工具	array	在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具类型可以是 code_interpreter、retrieval 或 function。	否	[]
tool_resources	object	助手工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	替代可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	替代附加到此助手的矢量存储。 助手最多可以附加 1 个矢量存储。

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	assistantObject	表示可以调用模型并使用工具的 assistant。

示例

示例

修改助手。

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2024-10-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=2024-10-01-preview

删除助手。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
assistant_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	deleteAssistantResponse

示例

示例

删除助手。

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

响应：状态代码：200

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

创建 - 线程

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

创建线程。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
messages	array	用于启动线程的消息列表。	否
tool_resources	object	一组可供此线程中的助手工具使用的资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此线程的矢量存储。 线程最多可以附加 1 个矢量存储。
vector_stores	array	一个帮助程序，用于创建具有 file_ids 的矢量存储，并将其附加到此线程。 线程最多可以附加一个矢量存储。

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	threadObject	表示包含消息的线程。

示例

示例

创建线程。

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

响应：状态代码：200

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

获取 - 线程

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

检索线程。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	threadObject	表示包含消息的线程。

示例

示例

检索线程。

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-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=2024-10-01-preview

修改线程。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
tool_resources	object	一组可供此线程中的助手工具使用的资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此线程的矢量存储。 线程最多可以附加一个矢量存储。

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	threadObject	表示包含消息的线程。

示例

示例

修改线程。

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2024-10-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=2024-10-01-preview

删除线程。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	deleteThreadResponse

示例

示例

删除线程。

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

响应：状态代码：200

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

列出 - 消息

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

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
limit	查询	否	integer
订单	查询	否	string
after	查询	否	string
before	查询	否	string
run_id	查询	否	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	listMessagesResponse

示例

示例

列出消息

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-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=2024-10-01-preview

创建邮件。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
role	string	正在创建消息的实体的角色。 允许的值包括： - user：指示消息是由实际用户发送的，应在大多数情况下用于表示用户生成的消息。 - assistant：指示消息由助手生成。 使用此值将来自助手的消息插入对话。	是
内容	string	消息的内容。	是
附件	array	附加到消息的文件列表及其应添加到的工具。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	messageObject	表示线程中的消息。

示例

示例

创建邮件。

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2024-10-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=2024-10-01-preview

检索消息。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
message_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	messageObject	表示线程中的消息。

示例

示例

检索消息。

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-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=2024-10-01-preview

修改消息。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
message_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	messageObject	表示线程中的消息。

示例

示例

修改消息。

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2024-10-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"
    }
  }
}

创建 - 线程和运行

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

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
assistant_id	string	用于执行此运行的助手的 ID。	是
thread	createThreadRequest		否
model	string	用于执行此运行的模型的部署名称。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。	否
instructions	string	替代助手的默认系统消息。 这对按运行修改行为很有用。	否
工具	array	替代助手可用于此运行的工具。 这对按运行修改行为很有用。	否
tool_resources	object	助手工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
流 (stream)	boolean	如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。	否
stream_options	chatCompletionStreamOptions	用于流式处理响应的选项。 仅在设置 stream: true 时设置此项。	否	无
max_prompt_tokens	integer	在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
max_completion_tokens	integer	在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
truncation_strategy	truncationObject	用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。	否
tool_choice	assistantsApiToolChoiceOption	控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 是默认值，表示模型可以在生成消息和调用工具之间进行选择。 指定特定工具（例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}}）将强制模型调用该工具。	否
parallel_tool_calls	ParallelToolCalls	是否在工具使用期间启用并行函数调用。	否	True
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此助手的矢量存储 ID。 助手最多可以附加 1 个矢量存储。

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	runObject	表示在线程上运行的执行。

示例

示例

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

POST https://{endpoint}/openai/threads/runs?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
limit	查询	否	integer
订单	查询	否	string
after	查询	否	string
before	查询	否	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	listRunsResponse

示例

示例

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

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-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=2024-10-01-preview

创建运行。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
assistant_id	string	用于执行此运行的助手的 ID。	是
模型	string	用于执行此运行的模型的 ID。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。	否
instructions	string	替代助手的默认系统消息。 这对按运行修改行为很有用。	否
additional_instructions	string	在运行指令的末尾追加其他指令。 这对不替代其他指令的情况下按运行修改行为很有用。	否
additional_messages	array	在创建运行之前，将其他消息添加到线程。	否
工具	array	替代助手可用于此运行的工具。 这对按运行修改行为很有用。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
流 (stream)	boolean	如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。	否
max_prompt_tokens	integer	在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
max_completion_tokens	integer	在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
truncation_strategy	truncationObject	用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。	否
tool_choice	assistantsApiToolChoiceOption	控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 是默认值，表示模型可以在生成消息和调用工具之间进行选择。 指定特定工具（例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}}）将强制模型调用该工具。	否
parallel_tool_calls	ParallelToolCalls	是否在工具使用期间启用并行函数调用。	否	True
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	runObject	表示在线程上运行的执行。

示例

示例

创建运行。

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2024-10-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=2024-10-01-preview

检索运行。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
run_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	runObject	表示在线程上运行的执行。

示例

示例

启动运行。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-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=2024-10-01-preview

修改运行。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
run_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	runObject	表示在线程上运行的执行。

示例

示例

修改运行。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2024-10-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=2024-10-01-preview

当运行具有 status: "requires_action" 且 required_action.type 为 submit_tool_outputs 时，此终结点可用于在工具调用完成后提交输出。 所有输出都必须在单个请求中提交。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
run_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
tool_outputs	array	其输出正在提交的工具列表。	是
流 (stream)	boolean	如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	runObject	表示在线程上运行的执行。

示例

示例

当运行具有 status: "requires_action" 且 required_action.type 为 submit_tool_outputs 时，此终结点可用于在工具调用完成后提交输出。 所有输出都必须在单个请求中提交。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2024-10-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=2024-10-01-preview

取消 in_progress 的运行。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
run_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	runObject	表示在线程上运行的执行。

示例

示例

取消 in_progress 的运行。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
run_id	path	是	string
limit	查询	否	integer
订单	查询	否	string
after	查询	否	string
before	查询	否	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	listRunStepsResponse

示例

示例

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

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2024-10-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=2024-10-01-preview

检索运行步骤。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
thread_id	path	是	string
run_id	path	是	string
step_id	path	是	string
api-version	查询	是	string	API 版本

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	runStepObject	表示运行执行过程中的一个步骤。

示例

示例

检索运行步骤。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2024-10-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=2024-10-01-preview

返回矢量存储列表。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
limit	查询	否	integer
订单	查询	否	string
after	查询	否	string
before	查询	否	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	listVectorStoresResponse

示例

示例

返回矢量存储列表。

GET https://{endpoint}/openai/vector_stores?api-version=2024-10-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=2024-10-01-preview

创建矢量存储。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
file_ids	array	矢量存储应使用的文件 ID 列表。 适用于可以访问文件的 file_search 等工具。	否
name	string	矢量存储的名称。	否
expires_after	vectorStoreExpirationAfter	矢量存储过期策略。	否
chunking_strategy	autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam	用于对文件进行分块的分块策略。 如果未设置，则将使用 auto 策略。 仅当 file_ids 非空时适用。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreObject	矢量存储是 file_search 工具可以使用已处理文件的集合。

示例

示例

创建矢量存储。

POST https://{endpoint}/openai/vector_stores?api-version=2024-10-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 https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-01-preview

检索矢量存储。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreObject	矢量存储是 file_search 工具可以使用已处理文件的集合。

示例

示例

检索矢量存储。

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

响应：状态代码：200

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

修改 - 矢量存储

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

修改矢量存储。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
name	string	矢量存储的名称。	否
expires_after	vectorStoreExpirationAfter	矢量存储过期策略。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreObject	矢量存储是 file_search 工具可以使用已处理文件的集合。

示例

示例

修改矢量存储。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-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=2024-10-01-preview

删除矢量存储。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	deleteVectorStoreResponse

示例

示例

删除矢量存储。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2024-10-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=2024-10-01-preview

返回矢量存储文件列表。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
limit	查询	否	integer
订单	查询	否	string
after	查询	否	string
before	查询	否	string
filter	查询	否	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	listVectorStoreFilesResponse

示例

示例

返回矢量存储文件列表。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
file_id	string	矢量存储应使用的文件 ID。 适用于可以访问文件的 file_search 等工具。	是
chunking_strategy	chunkingStrategyRequestParam	用于对文件进行分块的分块策略。 如果未设置，则将使用 auto 策略。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreFileObject	附加到矢量存储的文件列表。

示例

示例

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2024-10-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 https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-01-preview

检索矢量存储文件。

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
file_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreFileObject	附加到矢量存储的文件列表。

示例

示例

检索矢量存储文件。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
file_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	deleteVectorStoreFileResponse

示例

示例

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

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

响应：状态代码：200

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

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

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

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

请求正文

“内容类型”: application/json

名称	Type	描述	需要	默认
file_ids	array	矢量存储应使用的文件 ID 列表。 适用于可以访问文件的 file_search 等工具。	是
chunking_strategy	chunkingStrategyRequestParam	用于对文件进行分块的分块策略。 如果未设置，则将使用 auto 策略。	否

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreFileBatchObject	附加到矢量存储的批量文件。

示例

示例

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
batch_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreFileBatchObject	附加到矢量存储的批量文件。

示例

示例

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

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2024-10-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
    }
  }
}

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

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

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
batch_id	path	是	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	vectorStoreFileBatchObject	附加到矢量存储的批量文件。

示例

示例

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

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2024-10-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=2024-10-01-preview

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

URI 参数

名称	在	必需	类型​​	描述
endpoint	path	是	string url	支持的 Azure OpenAI 终结点（协议和主机名，例如：https://aoairesource.openai.azure.com。将“aoairesource”替换为你的 Azure OpenAI 资源名称）。 https://{your-resource-name}.openai.azure.com
vector_store_id	path	是	string
batch_id	path	是	string
limit	查询	否	integer
订单	查询	否	string
after	查询	否	string
before	查询	否	string
filter	查询	否	string
api-version	查询	是	string

请求头

名称	必需	类型​​	描述
api-key	True	string	在这里提供 Azure OpenAI API 密钥

响应

状态代码：200

说明：确定

Content-Type	类型	描述
application/json	listVectorStoreFilesResponse

示例

示例

返回矢量存储文件列表。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2024-10-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
  }
}

组件

errorResponse

名称	Type	描述	需要	默认
error	error		否

errorBase

名称	Type	描述	需要	默认
code	string		否
message	string		否

error

名称	Type	描述	需要	默认
param	string		否
type	string		否
inner_error	innerError	包含其他详细信息的内部错误。	否

innerError

包含其他详细信息的内部错误。

名称	Type	描述	需要	默认
code	innerErrorCode	内部错误对象的错误代码。	否
content_filter_results	contentFilterPromptResults	有关内容筛选类别（hate、sexual、violence、self_harm）的信息（如果检测到），及严重性级别（very_low、low、medium、high-scale，用于确定有害内容的强度和风险级别），以及内容是否已筛选。 有关越狱内容和亵渎内容的信息（如果检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。	否

innerErrorCode

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

说明：内部错误对象的错误代码。

类型：string

默认：

枚举名称：InnerErrorCode

枚举值：

值	说明
ResponsibleAIPolicyViolation	提示违反了其他内容筛选器规则之一。

dalleErrorResponse

名称	Type	描述	需要	默认
error	dalleError		否

dalleError

名称	Type	描述	需要	默认
param	string		否
type	string		否
inner_error	dalleInnerError	包含其他详细信息的内部错误。	否

dalleInnerError

包含其他详细信息的内部错误。

名称	Type	描述	需要	默认
code	innerErrorCode	内部错误对象的错误代码。	否
content_filter_results	dalleFilterResults	有关内容筛选类别（hate、sexual、violence、self_harm）的信息（如果检测到），及严重性级别（very_low、low、medium、high-scale，用于确定有害内容的强度和风险级别），以及内容是否已筛选。 有关越狱内容和亵渎内容的信息（如果检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。	否
revised_prompt	string	用于生成图像的提示（如果有对提示的任何修订）。	否

contentFilterCompletionTextSpan

描述生成的补全文本中的跨度。 偏移量 0 是补全文本的第一个 UTF32 码位元素。

名称	Type	描述	需要	默认
completion_start_offset	integer	开始跨度的 UTF32 码位元素的偏移量。	是
completion_end_offset	integer	从跨度中排除的第一个 UTF32 码位元素的偏移量。 对于空跨度，此字段始终等于 completion_start_offset。 对于非空跨度，此字段始终大于 completion_start_offset。	是

contentFilterResultBase

名称	Type	描述	需要	默认
filtered	boolean		是

contentFilterSeverityResult

名称	Type	描述	需要	默认
filtered	boolean		是
severity	string		否

contentFilterDetectedResult

名称	Type	描述	需要	默认
filtered	boolean		是
detected	boolean		否

contentFilterDetectedWithCitationResult

名称	Type	描述	需要	默认
citation	object		否

citation 的属性

URL

名称	Type	描述	默认
URL	string

license

名称	Type	描述	默认
license	string

contentFilterDetectedWithCompletionTextSpansResult

名称	Type	描述	需要	默认
详细信息	数组		否

contentFilterIdResult

名称	Type	描述	需要	默认
filtered	boolean		是
id	string		否

contentFilterResultsBase

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

名称	Type	描述	需要	默认
sexual	contentFilterSeverityResult		否
violence	contentFilterSeverityResult		否
hate	contentFilterSeverityResult		否
self_harm	contentFilterSeverityResult		否
profanity	contentFilterDetectedResult		否
custom_blocklists	contentFilterDetailedResults	包含筛选段内容筛选器 ID 详细信息的内容筛选结果。	否
error	errorBase		否

contentFilterPromptResults

有关内容筛选类别（hate、sexual、violence、self_harm）的信息（如果检测到），及严重性级别（very_low、low、medium、high-scale，用于确定有害内容的强度和风险级别），以及内容是否已筛选。 有关越狱内容和亵渎内容的信息（如果检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。

名称	Type	描述	需要	默认
sexual	contentFilterSeverityResult		否
violence	contentFilterSeverityResult		否
hate	contentFilterSeverityResult		否
self_harm	contentFilterSeverityResult		否
profanity	contentFilterDetectedResult		否
custom_blocklists	contentFilterDetailedResults	包含筛选段内容筛选器 ID 详细信息的内容筛选结果。	否
error	errorBase		否
越狱	contentFilterDetectedResult		否
indirect_attack	contentFilterDetectedResult		否

contentFilterChoiceResults

有关内容筛选类别（hate、sexual、violence、self_harm）的信息（如果检测到），及严重性级别（very_low、low、medium、high-scale，用于确定有害内容的强度和风险级别），以及内容是否已筛选。 有关第三方文本和亵渎内容的信息（如果检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。

名称	Type	描述	需要	默认
sexual	contentFilterSeverityResult		否
violence	contentFilterSeverityResult		否
hate	contentFilterSeverityResult		否
self_harm	contentFilterSeverityResult		否
profanity	contentFilterDetectedResult		否
custom_blocklists	contentFilterDetailedResults	包含筛选段内容筛选器 ID 详细信息的内容筛选结果。	否
error	errorBase		否
protected_material_text	contentFilterDetectedResult		否
protected_material_code	contentFilterDetectedWithCitationResult		否
ungrounded_material	contentFilterDetectedWithCompletionTextSpansResult		否

contentFilterDetailedResults

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

名称	Type	描述	需要	默认
filtered	boolean		是
详细信息	数组		否

promptFilterResult

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

名称	Type	描述	需要	默认
prompt_index	integer		否
content_filter_results	contentFilterPromptResults	有关内容筛选类别（hate、sexual、violence、self_harm）的信息（如果检测到），及严重性级别（very_low、low、medium、high-scale，用于确定有害内容的强度和风险级别），以及内容是否已筛选。 有关越狱内容和亵渎内容的信息（如果检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。	否

promptFilterResults

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

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

dalleContentFilterResults

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

名称	Type	描述	需要	默认
sexual	contentFilterSeverityResult		否
violence	contentFilterSeverityResult		否
hate	contentFilterSeverityResult		否
self_harm	contentFilterSeverityResult		否

dalleFilterResults

有关内容筛选类别（hate、sexual、violence、self_harm）的信息（如果检测到），及严重性级别（very_low、low、medium、high-scale，用于确定有害内容的强度和风险级别），以及内容是否已筛选。 有关越狱内容和亵渎内容的信息（如果检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。

名称	Type	描述	需要	默认
sexual	contentFilterSeverityResult		否
violence	contentFilterSeverityResult		否
hate	contentFilterSeverityResult		否
self_harm	contentFilterSeverityResult		否
profanity	contentFilterDetectedResult		否
越狱	contentFilterDetectedResult		否
custom_blocklists	contentFilterDetailedResults	包含筛选段内容筛选器 ID 详细信息的内容筛选结果。	否

chatCompletionsRequestCommon

名称	Type	描述	需要	默认
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性 我们通常建议更改此设置或 top_p，但不要同时更改两者。	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或 temperature，但不要同时更改两者。	否	1
流 (stream)	boolean	如果设置此选项，将发送部分消息增量，如在 ChatGPT 中一样。 令牌将在可用时作为服务器发送的事件发送（内容仅包括数据），并且流式传输将由 data: [DONE] 消息终止。	否	False
stop	字符串或数组	最多四个序列，其中 API 将停止生成更多令牌。	否
max_tokens	integer	生成的答案允许的最大令牌数。 默认情况下，模型可返回的标记数将为（4096 - 提示标记）。 这与 o1 系列模型不兼容。	否	4096
max_completion_tokens	integer	可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 这仅在 o1 系列模型中受支持。 在未来的 API 版本中，会将支持扩展到其他模型。	否
presence_penalty	数字	介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止是否在文本中出现来惩罚新令牌，从而增加模型谈论新话题的可能性。	否	0
frequency_penalty	数字	介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。	否	0
logit_bias	object	修改指定令牌在完成中出现的可能性。 接受 json 对象，该对象将标记（由 tokenizer 中的标记 ID 指定）映射到从 -100 到 100 的相关偏差值。 在数学上，采样之前会将偏差添加到由模型生成的 logit 中。 具体效果因模型而异，但 -1 和 1 之间的值会减少或增加选择的可能性；-100 或 100 等值会导致相关令牌的禁止或独占选择。	否
user	string	表示最终用户的唯一标识符，可帮助 Azure OpenAI 监视和检测滥用行为。	否

createCompletionRequest

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

createCompletionResponse

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

名称	Type	描述	需要	默认
id	string	完成的唯一标识符。	是
choices	array	为输入提示生成的模型完成选项的列表。	是
created	integer	创建完成时间的 Unix 时间戳（以秒为单位）。	是
模型	string	用于补全的模型。	是
prompt_filter_results	promptFilterResults	请求中零个或多个提示的内容筛选结果。 在流式处理请求中，不同提示的结果可能以不同的时间或不同的顺序到达。	否
system_fingerprint	string	这个指纹表示模型运行的后端配置。 可以与 seed 请求参数一起使用，以了解何时进行了可能影响确定性的后端更改。	否
object	enum	对象类型，始终为“text_completion”。 可能的值：text_completion	是
使用情况	completionUsage	完成请求的使用情况统计信息。	否

createChatCompletionRequest

名称	Type	描述	需要	默认
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性 我们通常建议更改此设置或 top_p，但不要同时更改两者。	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或 temperature，但不要同时更改两者。	否	1
流 (stream)	boolean	如果设置此选项，将发送部分消息增量，如在 ChatGPT 中一样。 词元将在可用时作为服务器发送的事件发送（内容仅包括数据），并且流式传输将由 data: [DONE] 消息终止。	否	False
stop	字符串或数组	最多四个序列，其中 API 将停止生成更多令牌。	否
max_tokens	integer	可以在聊天补全时生成的最大词元数。 输入词元和生成的词元的总长度受模型上下文长度的限制。	否
max_completion_tokens	integer	可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 这仅在 o1 系列模型中受支持。 在未来的 API 版本中，会将支持扩展到其他模型。	否
presence_penalty	数字	介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止是否在文本中出现来惩罚新令牌，从而增加模型谈论新话题的可能性。	否	0
frequency_penalty	数字	介于 -2.0 和 2.0 之间的数字。 正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。	否	0
logit_bias	object	修改指定令牌在完成中出现的可能性。 接受 JSON 对象，该对象将标记（由 tokenizer 中的标记 ID 指定）映射到从 -100 到 100 的相关偏差值。 在数学上，采样之前会将偏差添加到由模型生成的 logit 中。 具体效果因模型而异，但 -1 和 1 之间的值会减少或增加选择的可能性；-100 或 100 等值会导致相关令牌的禁止或独占选择。	否	无
user	string	表示最终用户的唯一标识符，可帮助监视和检测滥用行为。	否
messages	array	包含到目前为止的对话的消息列表。	是
data_sources	array	使用它们的 Azure OpenAI 聊天扩展的配置条目。 此附加规范仅与 Azure OpenAI 兼容。	否
logprobs	boolean	是否返回输出令牌的对数概率。 如果为 true，则返回在 message 的 content 中返回的每个输出令牌的对数概率。	否	False
top_logprobs	integer	一个介于 0 和 20 之间的整数，指定在每个标记位置最有可能返回的的标记数，每个都有关联的对数概率。 如果使用此参数，则必须将 logprobs 设置为 true。	否
n	integer	要为每个输入消息生成的聊天完成选项数。 请注意，将根据所有选项中生成的标记数向你收费。 将 n 保留为 1 以尽量降低成本。	否	1
parallel_tool_calls	ParallelToolCalls	是否在工具使用期间启用并行函数调用。	否	True
response_format	ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema	一个对象，指定模型必须输出的格式。 与 GPT-4o、GPT-4o mini、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，或者对话超过了最大上下文长度。	否
seed	integer	此功能以 Beta 版本提供。 指定后，我们的系统将尽最大努力进行确定性采样，以便具有相同 seed 和参数的重复请求应返回相同的结果。 无法保证确定性，你应参考 system_fingerprint 响应参数来监视后端的更改。	否
stream_options	chatCompletionStreamOptions	用于流式处理响应的选项。 仅在设置 stream: true 时设置此项。	否	无
工具	array	模型可能调用的工具列表。 目前，仅支持函数作为工具。 使用它可以提供函数列表，模型可能为其生成 JSON 输入。 最多支持 128 个函数。	否
tool_choice	chatCompletionToolChoiceOption	控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息和调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。 通过 {"type": "function", "function": {"name": "my_function"}} 指定特定工具将强制模型调用该工具。 如果没有工具，则 none 为默认值。 如果存在工具，则 auto 为默认值。	否
function_call	字符串或 chatCompletionFunctionCallOption	已弃用，改用 tool_choice。 控制模型调用的函数（如有）。 none 表示模型不会调用函数，而是生成消息。 auto 表示模型可以在生成消息和调用函数之间进行选择。 通过 {"name": "my_function"} 指定特定函数会强制模型调用该函数。 当不存在任何函数时，默认值为 none。 如果存在函数，则 auto 是默认值。	否
functions	array	弃用了，改用 tools。 模型可能为其生成 JSON 输入的函数的列表。	否

chatCompletionFunctions

名称	Type	描述	需要	默认
description	string	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
name	string	要调用的函数的名称。 必须是 a-z、A-z、0-9，或包含下划线和短划线，最大长度为 64。	是
parameters	FunctionParameters	函数接受的参数，被描述为 JSON 架构对象。 请参阅指南](/azure/ai-services/openai/how-to/function-calling) 查看示例，参阅 JSON 架构参考查看有关格式的文档。 省略 parameters 会定义具有空参数列表的函数。	否

chatCompletionFunctionCallOption

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

名称	Type	描述	需要	默认
name	string	要调用的函数名称。	是

chatCompletionFunctionParameters

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

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

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

名称	Type	描述	需要	默认
content	字符串或数组	系统消息的内容。	是
role	enum	消息作者的角色，在本例中为 system。 可能的值：系统	是
名称	string	参与者的可选名称。 提供模型信息，以区分同一角色的参与者。	否

chatCompletionRequestUserMessage

名称	Type	描述	需要	默认
content	字符串或数组	用户消息的内容。	是
role	enum	消息作者的角色，在本例中为 user。 可能的值：用户	是
名称	string	参与者的可选名称。 提供模型信息，以区分同一角色的参与者。	否

chatCompletionRequestAssistantMessage

名称	Type	描述	需要	默认
content	字符串或数组	助手消息的内容。 除非指定了 tool_calls 或 function_call，否则是必需的。	否
拒绝	string	助手发出的拒绝消息。	否
role	enum	消息作者的角色，在本例中为 assistant。 可能的值：助手	是
名称	string	参与者的可选名称。 提供模型信息，以区分同一角色的参与者。	否
tool_calls	chatCompletionMessageToolCalls	模型生成的工具调用，例如函数调用。	否
function_call	object	已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。	否

function_call 的属性

参数

名称	Type	描述	默认
参数	string	用于调用函数的参数，由模型以 JSON 格式生成。 请注意，该模型并非始终生成有效的 JSON，并且可能会生成未由函数架构定义的参数。 在调用函数之前验证代码中的参数。

name

名称	Type	描述	默认
name	string	要调用的函数名称。

chatCompletionRequestToolMessage

名称	Type	描述	需要	默认
role	enum	消息作者的角色，在本例中为 tool。 可能的值：工具	是
内容	字符串或数组	工具消息的内容。	是
tool_call_id	string	此消息正在响应的工具调用。	是

chatCompletionRequestFunctionMessage

名称	Type	描述	需要	默认
role	enum	消息作者的角色，在本例中为 function。 可能的值：function	是
内容	string	函数消息的内容。	是
名称	string	要调用的函数名称。	是

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

名称	Type	描述	需要	默认
type	enum	内容部件的类型。 可能的值：文本	是
text	string	文本内容。	是

chatCompletionRequestMessageContentPartImage

名称	Type	描述	需要	默认
type	enum	内容部件的类型。 可能的值：image_url	是
image_url	object		是

image_url 的属性

url

名称	Type	描述	默认
url	string	图像的 URL 或 base64 编码的图像数据。

detail

名称	Type	描述	默认
detail	string	指定图像的详细信息级别。 在视觉指南中了解详细信息。	auto

chatCompletionRequestMessageContentPartRefusal

名称	Type	描述	需要	默认
type	enum	内容部件的类型。 可能的值：拒绝	是
拒绝	string	模型生成的拒绝消息。	是

azureChatExtensionConfiguration

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

名称	Type	描述	需要	默认
type	azureChatExtensionType	单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天补全请求使用， 该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。 使用此配置仅与 Azure OpenAI 兼容。	是

azureChatExtensionType

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

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

类型：string

默认：

枚举名称：AzureChatExtensionType

枚举值：

值	说明
azure_search	表示将 Azure 认知搜索用作 Azure OpenAI 聊天扩展。
azure_cosmos_db	表示将 Azure Cosmos DB 用作 Azure OpenAI 聊天扩展。
elasticsearch	表示将 Elasticsearch® 索引用作 Azure OpenAI 聊天扩展。
mongo_db	表示将 Mongo DB 用作 Azure OpenAI 聊天扩展。
pinecone	表示将 Pinecone 索引用作 Azure OpenAI 聊天扩展。

azureSearchChatExtensionConfiguration

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

名称	Type	描述	需要	默认
type	azureChatExtensionType	单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天补全请求使用， 该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。 使用此配置仅与 Azure OpenAI 兼容。	是
parameters	azureSearchChatExtensionParameters	用作 Azure OpenAI 聊天扩展时 Azure 认知搜索的参数。	否

azureSearchChatExtensionParameters

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

名称	Type	描述	需要	默认
authentication	onYourDataApiKeyAuthenticationOptions 或 onYourDataSystemAssignedManagedIdentityAuthenticationOptions 或 onYourDataUserAssignedManagedIdentityAuthenticationOptions 或 onYourDataAccessTokenAuthenticationOptions		是
top_n_documents	integer	为配置的查询提供的已配置最多文档数。	否
max_search_queries	integer	对于一条用户消息，应发送到搜索提供程序的重写查询的最大数量。 如果未指定，系统将决定要发送的查询数。	否
allow_partial_result	boolean	如果指定为 true，系统将允许使用部分搜索结果，如果所有查询都失败，请求将失败。 如果未指定或指定为 false，若任何搜索查询失败，则请求将失败。	否	False
in_scope	boolean	是否应将查询限制为使用索引数据。	否
strictness	integer	搜索相关性筛选的已配置严格性。 严格度越高，精准率越高，但回复的召回率越低。	否
endpoint	string	要使用的 Azure 认知搜索资源的绝对终结点路径。	是
index_name	string	在引用的 Azure 认知搜索资源中可供使用的索引的名称。	是
fields_mapping	azureSearchIndexFieldMappingOptions	用于控制使用配置的 Azure 认知搜索资源时如何处理字段的可选设置。	否
query_type	azureSearchQueryType	在将其用作 Azure OpenAI 聊天扩展时应执行的 Azure 认知搜索检索查询的类型。	否
semantic_configuration	string	查询的附加语义配置。	否
filter	string	搜索筛选器。	否
embedding_dependency	onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource 或 onYourDataIntegratedVectorizationSource		否
include_contexts	array	输出上下文所包含的属性。 如果未指定，默认值为 citations 和 intent。	否

azureSearchIndexFieldMappingOptions

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

名称	Type	描述	需要	默认
title_field	string	要用作标题的索引字段的名称。	否
url_field	string	要用作 URL 的索引字段的名称。	否
filepath_field	string	要用作文件路径的索引字段的名称。	否
content_fields	array	应被视为内容的索引字段的名称。	否
content_fields_separator	string	内容字段应使用的分隔符模式。	否
vector_fields	array	表示矢量数据的字段的名称。	否
image_vector_fields	array	表示图像矢量数据的字段的名称。	否

azureSearchQueryType

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

说明：在将其用作 Azure OpenAI 聊天扩展时应执行的 Azure 认知搜索检索查询的类型。

类型：string

默认：

枚举名称：AzureSearchQueryType

枚举值：

值	说明
简单	表示默认的简单查询分析程序。
语义	表示用于高级语义建模的语义查询分析程序。
vector	表示对计算数据的矢量搜索。
vector_simple_hybrid	表示简单查询策略与矢量数据的组合。
vector_semantic_hybrid	表示语义搜索和矢量数据查询的组合。

azureCosmosDBChatExtensionConfiguration

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

名称	Type	描述	需要	默认
type	azureChatExtensionType	单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天补全请求使用， 该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。 使用此配置仅与 Azure OpenAI 兼容。	是
parameters	azureCosmosDBChatExtensionParameters	使用 Azure Cosmos DB for MongoDB vCore 配置基于自有数据的 Azure OpenAI 聊天扩展时 要使用的参数。	否

azureCosmosDBChatExtensionParameters

使用 Azure Cosmos DB for MongoDB vCore 配置基于自有数据的 Azure OpenAI 聊天扩展时要使用的参数。

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

azureCosmosDBFieldMappingOptions

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

名称	Type	描述	需要	默认
title_field	string	要用作标题的索引字段的名称。	否
url_field	string	要用作 URL 的索引字段的名称。	否
filepath_field	string	要用作文件路径的索引字段的名称。	否
content_fields	array	应被视为内容的索引字段的名称。	是
content_fields_separator	string	内容字段应使用的分隔符模式。	否
vector_fields	array	表示矢量数据的字段的名称。	是

elasticsearchChatExtensionConfiguration

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

名称	Type	描述	需要	默认
type	azureChatExtensionType	单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天补全请求使用， 该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。 使用此配置仅与 Azure OpenAI 兼容。	是
parameters	elasticsearchChatExtensionParameters	将 Elasticsearch® 配置为 Azure OpenAI 聊天扩展时要使用的参数。	否

elasticsearchChatExtensionParameters

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

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

elasticsearchIndexFieldMappingOptions

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

名称	Type	描述	需要	默认
title_field	string	要用作标题的索引字段的名称。	否
url_field	string	要用作 URL 的索引字段的名称。	否
filepath_field	string	要用作文件路径的索引字段的名称。	否
content_fields	array	应被视为内容的索引字段的名称。	否
content_fields_separator	string	内容字段应使用的分隔符模式。	否
vector_fields	array	表示矢量数据的字段的名称。	否

elasticsearchQueryType

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

说明：在将其用作 Azure OpenAI 聊天扩展时应执行的 Elasticsearch® 检索查询的类型。

类型：string

默认：

枚举名称：ElasticsearchQueryType

枚举值：

值	说明
简单	表示默认的简单查询分析程序。
vector	表示对计算数据的矢量搜索。

mongoDBChatExtensionConfiguration

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

名称	Type	描述	需要	默认
type	azureChatExtensionType	单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天补全请求使用， 该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。 使用此配置仅与 Azure OpenAI 兼容。	是
parameters	mongoDBChatExtensionParameters	使用 Mongo DB 配置 Azure OpenAI On Your Data 聊天扩展时使用的参数。	否

mongoDBChatExtensionParameters

使用 Mongo DB 配置 Azure OpenAI On Your Data 聊天扩展时使用的参数。

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

mongoDBFieldMappingOptions

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

名称	Type	描述	需要	默认
title_field	string	要用作标题的索引字段的名称。	否
url_field	string	要用作 URL 的索引字段的名称。	否
filepath_field	string	要用作文件路径的索引字段的名称。	否
content_fields	array	应被视为内容的索引字段的名称。	是
content_fields_separator	string	内容字段应使用的分隔符模式。	否
vector_fields	array	表示矢量数据的字段的名称。	是

pineconeChatExtensionConfiguration

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

名称	Type	描述	需要	默认
type	azureChatExtensionType	单个 Azure OpenAI 聊天扩展的配置数据的表示形式。 这将由聊天补全请求使用， 该请求应使用 Azure OpenAI 聊天扩展来增强响应行为。 使用此配置仅与 Azure OpenAI 兼容。	是
parameters	pineconeChatExtensionParameters	用于配置 Azure OpenAI Pinecone 聊天扩展的参数。	否

pineconeChatExtensionParameters

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

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

pineconeFieldMappingOptions

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

名称	Type	描述	需要	默认
title_field	string	要用作标题的索引字段的名称。	否
url_field	string	要用作 URL 的索引字段的名称。	否
filepath_field	string	要用作文件路径的索引字段的名称。	否
content_fields	array	应被视为内容的索引字段的名称。	是
content_fields_separator	string	内容字段应使用的分隔符模式。	否

onYourDataAuthenticationOptions

基于自有数据的 Azure OpenAI 的身份验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是

onYourDataContextProperty

上下文属性。

说明：上下文属性。

类型：string

默认：

枚举名称：OnYourDataContextProperty

枚举值：

值	说明
citations	citations 属性。
意向	intent 属性。
all_retrieved_documents	all_retrieved_documents 属性。

onYourDataAuthenticationType

基于自有数据的 Azure OpenAI 支持的身份验证类型。

说明：基于自有数据的 Azure OpenAI 支持的身份验证类型。

类型：string

默认：

枚举名称：OnYourDataAuthenticationType

枚举值：

值	说明
api_key	通过 API 密钥进行身份验证。
connection_string	通过连接字符串进行身份验证。
key_and_key_id	通过密钥和密钥 ID 对进行身份验证。
encoded_api_key	通过编码 API 密钥进行身份验证。
access_token	通过访问令牌进行身份验证。
system_assigned_managed_identity	通过系统分配的托管标识进行身份验证。
user_assigned_managed_identity	通过用户分配的托管标识进行身份验证。
username_and_password	通过用户名和密码进行身份验证。

onYourDataApiKeyAuthenticationOptions

使用 API 密钥时，基于自有数据的 Azure OpenAI 的验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是
key	string	用于身份验证的 API 密钥。	否

onYourDataConnectionStringAuthenticationOptions

使用连接字符串时，基于自有数据的 Azure OpenAI 的验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是
connection_string	string	用于身份验证的连接字符串。	否

onYourDataKeyAndKeyIdAuthenticationOptions

使用 Elasticsearch 密钥和密钥 ID 对时，基于自有数据的 Azure OpenAI 的身份验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是
key	string	用于身份验证的 Elasticsearch 密钥。	否
key_id	string	用于身份验证的 Elasticsearch 密钥 ID。	否

onYourDataEncodedApiKeyAuthenticationOptions

使用 Elasticsearch 编码 API 密钥时，基于自有数据的 Azure OpenAI 的验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是
encoded_api_key	string	用于身份验证的 Elasticsearch 编码 API 密钥。	否

onYourDataAccessTokenAuthenticationOptions

使用访问令牌时，基于自有数据的 Azure OpenAI 的验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是
access_token	string	要用于身份验证的访问令牌。	否

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

使用系统分配的托管标识时，基于自有数据的 Azure OpenAI 的验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是

onYourDataUserAssignedManagedIdentityAuthenticationOptions

使用用户分配的托管标识时，基于自有数据的 Azure OpenAI 的验证选项。

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是
managed_identity_resource_id	string	用于进行身份验证的用户分配托管标识的资源 ID。	否

onYourDataUsernameAndPasswordAuthenticationOptions

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

名称	Type	描述	需要	默认
type	onYourDataAuthenticationType	基于自有数据的 Azure OpenAI 支持的身份验证类型。	是
username	string	用于身份验证的用户名。	否
password	string	密码。 用于身份验证。	否

onYourDataVectorizationSource

使用矢量搜索的基于自有数据的 Azure OpenAI 的矢量化源的抽象表示形式。

名称	Type	描述	需要	默认
type	onYourDataVectorizationSourceType	表示基于自有数据的 Azure OpenAI 可用于配置用于矢量搜索的矢量化数据的 可用源。	是

onYourDataVectorizationSourceType

表示基于自有数据的 Azure OpenAI 可用于配置用于矢量搜索的矢量化数据的可用源。

说明：表示基于自有数据的 Azure OpenAI 可用于配置用于矢量搜索的矢量化数据的
可用源。

类型：string

默认：

枚举名称：OnYourDataVectorizationSourceType

枚举值：

值	说明
endpoint	表示通过对 Azure OpenAI 嵌入模型的公共服务调用执行的矢量化。
deployment_name	表示要使用的 Ada 模型部署名称。 此模型部署必须位于同一 Azure OpenAI 资源中，但 基于自有数据将通过内部调用（而不是公共调用）使用此模型部署，这使得 即使在专用网络中也可以进行矢量搜索。
集成	表示搜索资源中定义的集成矢量器。
model_id	表示搜索服务中定义的特定嵌入模型 ID。 目前仅支持 Elasticsearch®。

onYourDataEndpointVectorizationSource

应用矢量搜索时基于自有数据的 Azure OpenAI 使用的矢量化源的详细信息，此矢量化源基于用于嵌入的 Azure OpenAI 终结点调用。

名称	Type	描述	需要	默认
type	onYourDataVectorizationSourceType	表示基于自有数据的 Azure OpenAI 可用于配置用于矢量搜索的矢量化数据的 可用源。	是
endpoint	string	指定应从中检索嵌入的资源终结点 URL。 其格式应为：https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings。 不允许 api-version 查询参数。	否
authentication	onYourDataApiKeyAuthenticationOptions 或 onYourDataAccessTokenAuthenticationOptions		否
dimensions	integer	嵌入应有的维度数。 仅在 text-embedding-3 及更高版本中受支持。	否

onYourDataDeploymentNameVectorizationSource

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

名称	Type	描述	需要	默认
type	onYourDataVectorizationSourceType	表示基于自有数据的 Azure OpenAI 可用于配置用于矢量搜索的矢量化数据的 可用源。	是
deployment_name	string	指定要用于矢量化的模型部署的名称。 此模型部署必须位于同一 Azure OpenAI 资源中，但基于自有数据将通过内部调用（而不是公共调用）使用此模型部署，从而即使在专用网络中也能实现矢量搜索。	否
dimensions	integer	嵌入应有的维度数。 仅在 text-embedding-3 及更高版本中受支持。	否

onYourDataIntegratedVectorizationSource

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

名称	Type	描述	需要	默认
type	onYourDataVectorizationSourceType	表示基于自有数据的 Azure OpenAI 可用于配置用于矢量搜索的矢量化数据的 可用源。	是

onYourDataModelIdVectorizationSource

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

名称	Type	描述	需要	默认
type	onYourDataVectorizationSourceType	表示基于自有数据的 Azure OpenAI 可用于配置用于矢量搜索的矢量化数据的 可用源。	是
model_id	string	指定要用于矢量化的模型 ID。 必须在搜索服务中定义此模型 ID。	否

azureChatExtensionsMessageContext

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

名称	Type	描述	需要	默认
citations	array	数据源检索结果，用于在响应中生成助手消息。	否
意向	string	聊天历史记录中检测到的意向，用于传递到下一轮，以传递上下文。	否
all_retrieved_documents	array	所有检索到的文档。	否

citation

聊天补全响应消息的引文信息。

名称	Type	描述	需要	默认
content	string	引文的内容。	是
title	string	引文的标题。	否
url	string	引文的 URL。	否
filepath	string	引文的文件路径。	否
chunk_id	string	引文的区块 ID。	否
rerank_score	数字	检索到的文档的重新排名分数。	否

retrievedDocument

检索到的文档。

名称	Type	描述	需要	默认
content	string	引文的内容。	是
title	string	引文的标题。	否
url	string	引文的 URL。	否
filepath	string	引文的文件路径。	否
chunk_id	string	引文的区块 ID。	否
rerank_score	数字	检索到的文档的重新排名分数。	否
search_queries	array	用于检索文档的搜索查询。	否
data_source_index	integer	数据源的索引。	否
original_search_score	数字	检索到的文档的原始搜索分数。	否
filter_reason	filterReason	检索的文档的筛选原因。	否

filterReason

检索的文档的筛选原因。

说明：检索到的文档的筛选原因。

类型：string

默认：

枚举名称：FilterReason

枚举值：

值	说明
score	文档按由 strictness 配置定义的原始搜索分数阈值进行筛选。
rerank	文档不按原始搜索分数阈值进行筛选，而是按重新排名分数和 top_n_documents 配置进行筛选。

chatCompletionMessageToolCall

名称	Type	描述	需要	默认
id	string	工具调用的 ID。	是
type	toolCallType	工具调用的类型，在本例中为 function。	是
function	object	模型调用的函数。	是

function 的属性

name

名称	Type	描述	默认
name	string	要调用的函数名称。

参数

名称	Type	描述	默认
参数	string	用于调用函数的参数，由模型以 JSON 格式生成。 请注意，该模型并非始终生成有效的 JSON，并且可能会生成未由函数架构定义的参数。 在调用函数之前验证代码中的参数。

toolCallType

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

说明：工具调用的类型，在本例中为 function。

类型：string

默认：

枚举名称：ToolCallType

枚举值：

值	说明
function	工具调用类型为 function。

chatCompletionRequestMessageTool

名称	Type	描述	需要	默认
tool_call_id	string	此消息正在响应的工具调用。	否
content	string	消息的内容。	否

chatCompletionRequestMessageFunction

名称	Type	描述	需要	默认
role	enum	消息作者的角色，在本例中为 function。 可能的值：function	否
name	string	消息的内容。	否
content	string	消息的内容。	否

createChatCompletionResponse

表示模型根据提供的输入返回的聊天补全响应。

名称	Type	描述	需要	默认
id	string	聊天补全的唯一标识符。	是
prompt_filter_results	promptFilterResults	请求中零个或多个提示的内容筛选结果。 在流式处理请求中，不同提示的结果可能以不同的时间或不同的顺序到达。	否
choices	array	聊天完成选项的列表。 如果 n 大于 1，则可以具备多个角色。	是
created	integer	聊天补全创建时间的 Unix 时间戳（以秒为单位）。	是
模型	string	用于聊天补全的模型。	是
system_fingerprint	string	这个指纹表示模型运行的后端配置。 可以与 seed 请求参数一起使用，以了解何时进行了可能影响确定性的后端更改。	否
object	enum	始终为 chat.completion 的对象类型。 可能的值：chat.completion	是
使用情况	completionUsage	完成请求的使用情况统计信息。	否

createChatCompletionStreamResponse

表示模型根据提供的输入返回的聊天补全响应的流式区块。

名称	Type	描述	需要	默认
id	string	聊天补全的唯一标识符。 每个区块具有相同的 ID。	是
choices	array	聊天完成选项的列表。 如果 n 大于 1，则可以包含多个元素。	是
created	integer	聊天补全创建时间的 Unix 时间戳（以秒为单位）。 每个区块具有相同的时间戳。	是
模型	string	要生成补全的模型。	是
system_fingerprint	string	这个指纹表示模型运行的后端配置。 可以与 seed 请求参数一起使用，以了解何时进行了可能影响确定性的后端更改。	否
object	enum	始终为 chat.completion.chunk 的对象类型。 可能的值：chat.completion.chunk	是

chatCompletionStreamResponseDelta

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

名称	Type	描述	需要	默认
content	string	区块消息的内容。	否
function_call	object	已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。	否
tool_calls	array		否
role	enum	此消息作者的角色。 可能的值：系统、用户、助手、工具	否
拒绝	string	模型生成的拒绝消息。	否

function_call 的属性

参数

名称	Type	描述	默认
参数	string	用于调用函数的参数，由模型以 JSON 格式生成。 请注意，该模型并非始终生成有效的 JSON，并且可能会生成未由函数架构定义的参数。 在调用函数之前验证代码中的参数。

name

名称	Type	描述	默认
name	string	要调用的函数名称。

chatCompletionMessageToolCallChunk

名称	Type	描述	需要	默认
index	integer		是
id	string	工具调用的 ID。	否
type	枚举	工具的类型。 目前仅支持 function。 可能的值：function	否
function	object		否

function 的属性

name

名称	Type	描述	默认
name	string	要调用的函数名称。

参数

名称	Type	描述	默认
参数	string	用于调用函数的参数，由模型以 JSON 格式生成。 请注意，该模型并非始终生成有效的 JSON，并且可能会生成未由函数架构定义的参数。 在调用函数之前验证代码中的参数。

chatCompletionStreamOptions

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

名称	Type	描述	需要	默认
include_usage	boolean	如果已设置，则会在 data: [DONE] 消息之前流式传输其他区块。 此区块上的 usage 字段将显示整个请求的令牌使用情况统计信息，并且 choices 字段将始终为空数组。 所有其他区块也将包含一个 usage 字段，但值为 null。	否

chatCompletionChoiceLogProbs

所选的对数概率信息。

名称	Type	描述	需要	默认
内容	array	包含对数概率信息的消息内容令牌列表。	是
拒绝	array	包含对数概率信息的消息拒绝标记的列表。	否

chatCompletionTokenLogprob

名称	Type	描述	需要	默认
token	string	令牌。	是
logprob	数字	此令牌的对数概率。	是
bytes	array	表示令牌的 UTF-8 字节表示形式的整数列表。 在字符由多个令牌表示，并且其字节表示形式必须组合在一起才能生成正确的文本表示形式的情况下非常有用。 如果令牌没有字节表示形式，则为 null。	是
top_logprobs	array	在此标记位置上，最有可能的标记及其对数概率的列表。 在极少数情况下，返回的数量可能少于请求的 top_logprobs 数。	是

chatCompletionResponseMessage

模型生成的聊天补全消息。

名称	Type	描述	需要	默认
role	chatCompletionResponseMessageRole	响应消息作者的角色。	是
拒绝	string	模型生成的拒绝消息。	是
内容	string	消息的内容。	是
tool_calls	array	模型生成的工具调用，例如函数调用。	否
function_call	chatCompletionFunctionCall	已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。	否
上下文	azureChatExtensionsMessageContext	当 Azure OpenAI 聊天扩展涉及到生成相应的聊天补全响应时 可用的其他上下文信息的表示形式。 此上下文信息仅在使用 配置为使用匹配扩展的 Azure OpenAI 请求时填充。	否

chatCompletionResponseMessageRole

响应消息作者的角色。

说明：响应消息作者的角色。

类型：string

默认：

枚举值：

• assistant

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

名称	Type	描述	需要	默认
type	枚举	工具的类型。 目前仅支持 function。 可能的值：function	是
function	object		是

function 的属性

name

名称	Type	描述	默认
name	string	要调用的函数名称。

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

名称	Type	描述	需要	默认
name	string	要调用的函数名称。	是
参数	string	用于调用函数的参数，由模型以 JSON 格式生成。 请注意，该模型并非始终生成有效的 JSON，并且可能会生成未由函数架构定义的参数。 在调用函数之前验证代码中的参数。	是

completionUsage

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

名称	Type	描述	需要	默认
prompt_tokens	integer	提示中的标记数。	是
completion_tokens	integer	生成的补全中的词元数。	是
total_tokens	integer	请求中使用的令牌总数（提示 + 补全）。	是
prompt_tokens_details	object	提示令牌的详细信息。	否
completion_tokens_details	object	完成中使用的令牌明细。	否

prompt_tokens_details 的属性

cached_tokens

名称	Type	描述	默认
cached_tokens	integer	缓存的提示令牌数。

completion_tokens_details 的属性

reasoning_tokens

名称	Type	描述	默认
reasoning_tokens	integer	用于推理的由模型生成的令牌。

chatCompletionTool

名称	Type	描述	需要	默认
type	枚举	工具的类型。 目前仅支持 function。 可能的值：function	是
函数	FunctionObject		是

FunctionParameters

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

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

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

FunctionObject

名称	Type	描述	需要	默认
description	string	函数作用的描述，由模型用于选择何时以及如何调用函数。	否
name	string	要调用的函数的名称。 必须是 a-z、A-z、0-9，或包含下划线和短划线，最大长度为 64。	是
parameters	FunctionParameters	函数接受的参数，被描述为 JSON 架构对象。 请参阅指南查看示例，参阅 JSON 架构参考查看有关格式的文档。 省略 parameters 会定义具有空参数列表的函数。	否
strict	boolean	生成函数调用时是否启用严格的架构遵循。 如果设置为 true，则模型将遵循 parameters 字段中定义的确切架构。 当 strict 为 true 时仅支持 JSON 架构的子集。	否	False

ResponseFormatText

名称	Type	描述	需要	默认
type	enum	要定义的响应格式的类型：text 可能的值：文本	是

ResponseFormatJsonObject

名称	Type	描述	需要	默认
type	enum	要定义的响应格式的类型：json_object 可能的值：json_object	是

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

名称	Type	描述	需要	默认
type	enum	要定义的响应格式的类型：json_schema 可能的值：json_schema	是
json_schema	object		是

json_schema 的属性

description

Name	Type	描述	默认值
description	string	对响应格式用途的描述，由模型用于确定如何以该格式进行响应。

name

名称	Type	描述	默认
name	string	响应格式的名称。 必须是 a-z、A-z、0-9，或包含下划线和短划线，最大长度为 64。

schema

名称	Type	描述	默认
schema	ResponseFormatJsonSchemaSchema	响应格式的架构，描述为 JSON 架构对象。

strict

名称	Type	描述	默认
strict	boolean	生成输出时是否启用严格的架构遵循。 如果设置为 true，则模型将始终遵循 schema 字段中定义的确切架构。 当 strict 为 true 时仅支持 JSON 架构的子集。	False

chatCompletionChoiceCommon

名称	Type	描述	需要	默认
index	integer		否
finish_reason	string		否

createTranslationRequest

翻译请求。

名称	Type	描述	需要	默认
文件	string	要翻译的音频文件。	是
prompt	string	用于指导模型风格或继续之前的音频片段的可选文本。 提示应为英语。	否
response_format	audioResponseFormat	定义输出的格式。	否
温度	数字	采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性 如果设置为 0，则模型将使用对数概率自动升高温度，直到达到特定阈值。	否	0

audioResponse

response_format 为 json 时的翻译或听录响应

名称	Type	描述	需要	默认
text	string	已翻译或转录的文本。	是

audioVerboseResponse

response_format 为 verbose_json 时的翻译或听录响应

名称	Type	描述	需要	默认
text	string	已翻译或转录的文本。	是
task	string	音频任务类型。	否
language	string	语言。	否
duration	数字	持续时间。	否
段	数组		否
words	数组		否

audioResponseFormat

定义输出的格式。

说明：定义输出的格式。

类型：string

默认：

枚举值：

• json
• text
• srt
• verbose_json
• vtt

createTranscriptionRequest

听录请求。

名称	Type	描述	需要	默认
文件	string	要转录的音频文件对象。	是
prompt	string	用于指导模型风格或继续之前的音频片段的可选文本。 提示应与音频语言匹配。	否
response_format	audioResponseFormat	定义输出的格式。	否
温度	数字	采样温度，介于 0 和 1 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性 如果设置为 0，则模型将使用对数概率自动升高温度，直到达到特定阈值。	否	0
language	string	输入音频的语言。 以 ISO-639-1 格式提供输入语言将提高准确性并减少延迟。	否
timestamp_granularities[]	array	要为此听录填充的时间戳粒度。 response_format 必须设为 verbose_json 以使用时间戳粒度。 支持以下任一选项或两个选项：word 或 segment。 注意：段时间戳没有额外的延迟，但生成单词时间戳会产生额外的延迟。	否	['segment']

audioSegment

听录或翻译段。

名称	Type	描述	需要	默认
id	integer	段标识符。	否
seek	数字	段偏移量。	否
start	number	段初始偏移量。	否
end	数字	段结束偏移量。	否
text	string	段文本。	否
tokens	array	文本令牌。	否
温度	数字	温度。	否
avg_logprob	数字	平均对数概率。	否
compression_ratio	数字	压缩率。	否
no_speech_prob	数字	“无语音”的概率。	否

audioWord

听录或翻译字。

名称	Type	描述	需要	默认
word	string	Word	否
start	number	字初始偏移量。	否
end	数字	字结束偏移量。	否

createSpeechRequest

语音请求。

名称	Type	描述	需要	默认
input	string	要为其合成音频的文本。 最大长度为 4096 个字符。	是
voice	enum	用于语音合成的语音。 可能的值：alloy、echo、fable、onyx、nova、shimmer	是
response_format	enum	合成音频的格式。 可能的值：mp3、opus、aac、flac、wav、pcm	否
速度	数字	合成音频的速度。 从 0.25 到 4.0 范围选择值。 1.0 是默认值。	否	1.0

imageQuality

将生成的图像的质量。

说明：将生成的图像的质量。

类型：string

默认值：standard

枚举名称：Quality

枚举值：

值	说明
standard	标准质量创建具有标准质量的图像。
hd	HD 质量会创建具有更精细的细节和更具一致性的图像。

imagesResponseFormat

返回生成图像的格式。

说明：返回生成图像的格式。

类型：string

默认值：URL

枚举名称：ImagesResponseFormat

枚举值：

值	说明
url	提供临时访问权限以下载生成的图像的 URL。
b64_json	生成的图像将作为 base64 编码字符串返回。

imageSize

生成的图像的大小。

说明：生成的图像的大小。

类型：string

默认值：1024x1024

枚举名称：Size

枚举值：

值	说明
256x256	生成的图像的所需大小为 256x256 像素。 仅支持 dall-e-2。
512x512	生成的图像的所需大小为 512x512 像素。 仅支持 dall-e-2。
1792x1024	生成的图像的所需大小为 1792x1024 像素。 仅支持 dall-e-3。
1024x1792	生成的图像的所需大小为 1024x1792 像素。 仅支持 dall-e-3。
1024x1024	生成的图像的所需大小为 1024x1024 像素。

imageStyle

生成的图像的样式。

说明：生成的图像的样式。

类型：string

默认值：vivid

枚举名称：Style

枚举值：

值	说明
vivid	Vivid 创建超现实和戏剧性的图像。
natural	Natural 会创建更自然、不那么超现实的图像。

imageGenerationsRequest

名称	Type	描述	需要	默认
prompt	string	所需图像的文本说明。 最大长度为 4000 个字符。	是
n	integer	要生成的图像数。	否	1
size	imageSize	生成的图像的大小。	否	1024x1024
response_format	imagesResponseFormat	返回生成图像的格式。	否	url
user	string	表示最终用户的唯一标识符，可帮助监视和检测滥用行为。	否
质量	imageQuality	将生成的图像的质量。	否	standard
style	imageStyle	生成的图像的样式。	否	vivid

generateImagesResponse

名称	Type	描述	需要	默认
created	integer	创建操作时的 UNIX 时间戳。	是
data	array	操作的结果数据（如果成功）	是

imageResult

如果成功，则返回图像 URL 或编码图像，否则返回错误。

名称	Type	描述	需要	默认
url	string	图像 URL。	否
b64_json	string	base64 编码的图像	否
content_filter_results	dalleContentFilterResults	有关内容筛选结果的信息。	否
revised_prompt	string	用于生成图像的提示（如果有对提示的任何修订）。	否
prompt_filter_results	dalleFilterResults	有关内容筛选类别（hate、sexual、violence、self_harm）的信息（如果检测到），及严重性级别（very_low、low、medium、high-scale，用于确定有害内容的强度和风险级别），以及内容是否已筛选。 有关越狱内容和亵渎内容的信息（如果检测到），以及是否已筛选。 以及有关客户阻止列表的信息（如果已筛选）及其 ID。	否

line

内容行对象，由相邻的内容元素序列（如字词和选择标记）组成。

名称	Type	描述	需要	默认
text	string		是
spans	array	表示检测到的对象及其边界框信息的跨度数组。	是

span

表示检测到的对象及其边界框信息的跨度对象。

名称	Type	描述	需要	默认
text	string	表示检测到的对象的跨度的文本内容。	是
offset	integer	文本中跨度开始处的字符偏移量。 这个偏移量定义为跨度的第一个字符的位置，从文本开头作为 Unicode 码位开计数。	是
length	integer	以字符为单位的跨度长度，以 Unicode 码位表示。	是
polygon	array	一个对象数组，表示多边形中包含检测到的对象中的点。	是

runCompletionUsage

与运行相关的使用情况统计信息。 如果运行不处于终端状态（例如 in_progress、queued 等），则此值将为 null。

名称	Type	描述	需要	默认
completion_tokens	integer	在运行过程中使用的补全令牌的数目。	是
prompt_tokens	integer	在运行过程中使用的提示令牌的最大数目。	是
total_tokens	integer	使用的令牌总数（提示 + 补全）。	是

runStepCompletionUsage

与运行步骤相关的使用情况统计信息。 当运行步骤的状态为 in_progress 时，此值将为 null。

名称	Type	描述	需要	默认
completion_tokens	integer	在运行步骤过程中使用的补全令牌的数目。	是
prompt_tokens	integer	在运行步骤过程中使用的提示令牌的数目。	是
total_tokens	integer	使用的令牌总数（提示 + 补全）。	是

assistantsApiResponseFormatOption

指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。

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

重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。

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

assistantsApiResponseFormat

描述模型的预期输出的对象。 如果为 json_object，则只允许将 function 类型 tools 传递给 Run。 如果为 text，则模型可以返回文本或任何所需的值。

名称	Type	描述	需要	默认
type	string	必须是 text 或 json_object 之一。	否	text

类型枚举：AssistantsApiResponseFormat

值	说明
text
json_object

assistantObject

表示可以调用模型并使用工具的 assistant。

名称	Type	描述	需要	默认
id	string	可以在 API 终结点中引用的标识符。	是
对象 (object)	string	始终为 assistant 的对象类型。	是
created_at	integer	创建助手时的 Unix 时间戳（以秒为单位）。	是
名称	string	助手的名称。 最大长度为 256 个字符。	是
description	string	助手的说明。 最大长度为 512 个字符。	是
模型	string	要使用的模型的 ID。 可以使用列出模型 API 查看所有可用的模型。	是
instructions	string	助手使用的系统说明。 最大长度为 256,000 个字符。	是
工具	array	在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具类型可以是 code_interpreter、file_search 或 function。	是	[]
tool_resources	object	助手工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	是
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此助手的矢量存储 ID。 助手最多可以附加 1 个矢量存储。

对象枚举：AssistantObjectType

值	说明
assistant	对象类型，始终为 assistant。

createAssistantRequest

名称	Type	描述	需要	默认
模型			是
名称	string	助手的名称。 最大长度为 256 个字符。	否
description	string	助手的说明。 最大长度为 512 个字符。	否
instructions	string	助手使用的系统说明。 最大长度为 256,000 个字符。	否
工具	array	在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具类型可以是 code_interpreter、retrieval 或 function。	否	[]
tool_resources	object	助手工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此助手的矢量存储。 助手最多可以附加 1 个矢量存储。
vector_stores	array	一个帮助程序，用于创建具有 file_ids 的矢量存储，并将其附加到此助手。 助手最多可以附加 1 个矢量存储。

modifyAssistantRequest

名称	Type	描述	需要	默认
模型			否
name	string	助手的名称。 最大长度为 256 个字符。	否
description	string	助手的说明。 最大长度为 512 个字符。	否
instructions	string	助手使用的系统说明。 最大长度为 32768 个字符。	否
工具	array	在助手上启用的工具列表。 每个助手最多可以有 128 个工具。 工具类型可以是 code_interpreter、retrieval 或 function。	否	[]
tool_resources	object	助手工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	替代可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	替代附加到此助手的矢量存储。 助手最多可以附加 1 个矢量存储。

deleteAssistantResponse

名称	Type	描述	需要	默认
id	string		是
deleted	boolean		是
对象 (object)	string		是

对象枚举：DeleteAssistantResponseState

值	说明
assistant.deleted

listAssistantsResponse

名称	Type	描述	需要	默认
object	string		是
data	array		是
first_id	string		是
last_id	string		是
has_more	boolean		是

assistantToolsCode

名称	Type	描述	需要	默认
type	string	要定义的工具类型：code_interpreter	是

类型枚举：assistantToolsCodeType

值	说明
code_interpreter

assistantToolsFileSearch

名称	Type	描述	需要	默认
type	string	要定义的工具类型：file_search	是
file_search	object	文件搜索工具的替代。	否

file_search 的属性

max_num_results

名称	Type	描述	默认
max_num_results	integer	文件搜索工具应输出的最大结果数。 对于 gpt-4* 模型，默认值为 20；对于 gpt-3.5-turbo，默认值为 5。 此数字应介于 1 和 50 之间（含）。 请注意，文件搜索工具输出的结果可能会少于 max_num_results 个。

类型枚举：assistantToolsFileSearchType

值	说明
file_search

assistantToolsFileSearchTypeOnly

名称	Type	描述	需要	默认
type	string	要定义的工具类型：file_search	是

类型枚举：assistantToolsFileSearchType

值	说明
file_search

assistantToolsFunction

名称	Type	描述	需要	默认
type	string	要定义的工具类型：function	是
function	object	函数定义。	是

function 的属性

description

Name	Type	描述	默认值
description	string	函数作用的描述，由模型用于选择何时以及如何调用函数。

name

名称	Type	描述	默认
name	string	要调用的函数的名称。 必须是 a-z、A-z、0-9，或包含下划线和短划线，最大长度为 64。

parameters

客户	Type	描述	默认
parameters	chatCompletionFunctionParameters	函数接受的参数，被描述为 JSON 架构对象。 请参阅指南查看示例，参阅 JSON 架构参考查看有关格式的文档。

类型枚举：assistantToolsFunction

值	说明
function

truncationObject

用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。

名称	Type	描述	需要	默认
type	string	用于线程的截断策略。 默认为 auto。 如果设置为 last_messages，则线程将被截断为线程中的 n 条最新消息。 设置为 auto 时，将删除线程中间的消息，以适应模型的上下文长度 max_prompt_tokens。	是
last_messages	integer	构造运行上下文时线程中的最新消息数。	否

类型枚举：TruncationType

值	说明
auto
last_messages

assistantsApiToolChoiceOption

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

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

assistantsNamedToolChoice

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

名称	Type	描述	需要	默认
type	string	工具的类型。 如果类型为 function，则必须设置函数名称	是
function	object		否

function 的属性

name

名称	Type	描述	默认
name	string	要调用的函数名称。

类型枚举：AssistantsNamedToolChoiceType

值	说明
function
code_interpreter
file_search

runObject

表示在线程上运行的执行。

名称	Type	描述	需要	默认
id	string	可以在 API 终结点中引用的标识符。	是
对象 (object)	string	始终为 thread.run 的对象类型。	是
created_at	integer	创建运行时的 Unix 时间戳（以秒为单位）。	是
thread_id	string	作为此运行的一部分执行的线程的 ID。	是
assistant_id	string	用于执行此运行的助手的 ID。	是
状态	string	运行的状态，可以是 queued、in_progress、requires_action、cancelling、cancelled、failed、completed 或 expired。	是
required_action	object	有关继续运行所需的操作的详细信息。 如果不需要任何操作，则为 null。	是
last_error	object	与此运行关联的最后一个错误。 如果没有错误，则为 null。	是
expires_at	integer	运行过期时的 Unix 时间戳（以秒为单位）。	是
started_at	integer	运行启动时的 Unix 时间戳（以秒为单位）。	是
cancelled_at	integer	运行取消时的 Unix 时间戳（以秒为单位）。	是
failed_at	integer	运行失败时的 Unix 时间戳（以秒为单位）。	是
completed_at	integer	运行完成时的 Unix 时间戳（以秒为单位）。	是
incomplete_details	object	有关运行为何不完整的详细信息。 如果运行不完整，则将为 null。	是
模型	string	助手用于此运行的模型。	是
instructions	string	助手用于此运行的指令。	是
工具	array	助手用于此运行的工具列表。	是	[]
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	是
使用情况	runCompletionUsage	与运行相关的使用情况统计信息。 如果运行不处于终端状态（例如 in_progress、queued 等），则此值将为 null。	是
温度	数字	用于此运行的采样温度。 如果未设置，则默认值为 1。	否
top_p	数字	用于此运行的核心采样值。 如果未设置，则默认值为 1。	否
max_prompt_tokens	integer	指定的在运行过程中已使用提示令牌的最大数目。	是
max_completion_tokens	integer	指定的在运行过程中已使用完成令牌的最大数目。	是
truncation_strategy	truncationObject	用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。	是
tool_choice	assistantsApiToolChoiceOption	控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 是默认值，表示模型可以在生成消息和调用工具之间进行选择。 指定特定工具（例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}}）将强制模型调用该工具。	是
parallel_tool_calls	ParallelToolCalls	是否在工具使用期间启用并行函数调用。	否	True
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	是

required_action 的属性

type

名称	Type	描述	默认
type	string	目前始终为 submit_tool_outputs。

submit_tool_outputs

名称	Type	描述	默认
tool_calls	array	相关工具调用的列表。

last_error 的属性

code

名称	Type	描述	默认
code	string	server_error 或 rate_limit_exceeded 中的一项。

message

名称	Type	描述	默认
message	string	可读的错误说明。

incomplete_details 的属性

reason

名称	Type	描述	默认
reason	string	运行不完整的原因。 这将指出在运行过程中达到了哪个特定令牌限制。

对象枚举：runObjectType

值	说明
thread.run	运行对象类型，始终为 thread.run。

状态枚举：RunObjectStatus

值	说明
queued	queued 状态
in_progress	in_progress 状态
requires_action	required_action 状态
cancelling	cancelling 状态
cancelled	cancelled 状态
失败	failed 状态
completed	completed 状态
已过期	expired 状态

createRunRequest

名称	Type	描述	需要	默认
assistant_id	string	用于执行此运行的助手的 ID。	是
模型	string	用于执行此运行的模型的部署 ID。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。	否
instructions	string	替代助手的默认系统消息。 这对按运行修改行为很有用。	否
additional_instructions	string	在运行指令的末尾追加其他指令。 这对不替代其他指令的情况下按运行修改行为很有用。	否
additional_messages	array	在创建运行之前，将其他消息添加到线程。	否
工具	array	替代助手可用于此运行的工具。 这对按运行修改行为很有用。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
流 (stream)	boolean	如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。	否
max_prompt_tokens	integer	在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
max_completion_tokens	integer	在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
truncation_strategy	truncationObject	用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。	否
tool_choice	assistantsApiToolChoiceOption	控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 是默认值，表示模型可以在生成消息和调用工具之间进行选择。 指定特定工具（例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}}）将强制模型调用该工具。	否
parallel_tool_calls	ParallelToolCalls	是否在工具使用期间启用并行函数调用。	否	True
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

listRunsResponse

名称	Type	描述	需要	默认
object	string		是
data	array		是
first_id	string		是
last_id	string		是
has_more	boolean		是

modifyRunRequest

名称	Type	描述	需要	默认
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

submitToolOutputsRunRequest

名称	Type	描述	需要	默认
tool_outputs	array	其输出正在提交的工具列表。	是
流 (stream)	boolean	如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。	否

runToolCallObject

工具调用对象

名称	Type	描述	需要	默认
id	string	工具调用的 ID。 使用提交工具输出以运行终结点时，必须引用此 ID。	是
type	string	需要输出的工具调用的类型。 目前始终为 function。	是
function	object	函数定义。	是

function 的属性

name

名称	Type	描述	默认
name	string	函数的名称。

参数

名称	Type	描述	默认
参数	string	模型期望传递给函数的参数。

类型枚举：RunToolCallObjectType

值	说明
function

createThreadAndRunRequest

名称	Type	描述	需要	默认
assistant_id	string	用于执行此运行的助手的 ID。	是
thread	createThreadRequest		否
model	string	用于执行此运行的模型的部署名称。 如果此处提供了一个值，它将替代与助手关联的模型。 否则，将使用与助手关联的模型。	否
instructions	string	替代助手的默认系统消息。 这对按运行修改行为很有用。	否
工具	array	替代助手可用于此运行的工具。 这对按运行修改行为很有用。	否
tool_resources	object	助手工具使用的一组资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否
温度	数字	要使用的采样温度，介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性	否	1
top_p	数字	温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。 所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。 我们通常建议更改此设置或温度，但不要同时更改这两者。	否	1
流 (stream)	boolean	如果为 true，则返回在运行为服务器发送事件期间发生的事件流，在运行进入附带 data: [DONE] 消息的终端状态时终止。	否
stream_options	chatCompletionStreamOptions	用于流式处理响应的选项。 仅在设置 stream: true 时设置此项。	否	无
max_prompt_tokens	integer	在运行过程中可能会使用的提示令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的提示令牌数。 如果运行超过指定的提示令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
max_completion_tokens	integer	在运行过程中可能会使用的完成令牌的最大数目。 在多轮运行中，运行将尽最大可能地只使用指定的补全令牌数。 如果运行超过指定的补全令牌数，则运行将以状态 incomplete 结束。 有关详细信息，请参阅 incomplete_details。	否
truncation_strategy	truncationObject	用于指示在运行之前如何截断线程的控件。 使用此控件可控制运行的初始上下文窗口。	否
tool_choice	assistantsApiToolChoiceOption	控制模型调用哪些工具（如有）。 none 表示模型不会调用任何工具，而是生成消息。 auto 是默认值，表示模型可以在生成消息和调用工具之间进行选择。 指定特定工具（例如 {"type": "file_search"} 或 {"type": "function", "function": {"name": "my_function"}}）将强制模型调用该工具。	否
parallel_tool_calls	ParallelToolCalls	是否在工具使用期间启用并行函数调用。	否	True
response_format	assistantsApiResponseFormatOption	指定模型必须输出的格式。 与 GPT-4 Turbo 和自 gpt-3.5-turbo-1106 起的所有 GPT-3.5 Turbo 型号兼容。 设置为 { "type": "json_object" } 可启用 JSON 模式，这可以保证模型生成的消息是有效的 JSON。 重要提示：使用 JSON 模式时，还必须使用系统或用户消息指示模型自行生成 JSON。 如果没有此项，则模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而生成长期运行且似乎“卡滞”的请求。 另请注意，如果使用 finish_reason="length"，则消息内容可能会部分截断，这表示生成超过了 max_tokens，或者对话超过了最大上下文长度。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此助手的矢量存储 ID。 助手最多可以附加 1 个矢量存储。

threadObject

表示包含消息的线程。

名称	Type	描述	需要	默认
id	string	可以在 API 终结点中引用的标识符。	是
对象 (object)	string	始终为 thread 的对象类型。	是
created_at	integer	创建线程时的 Unix 时间戳（以秒为单位）。	是
tool_resources	object	一组可供此线程中的助手工具使用的资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	是
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	是

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此线程的矢量存储。 线程最多可以附加 1 个矢量存储。

对象枚举：ThreadObjectType

值	说明
thread	始终为 thread 的线程对象的类型

createThreadRequest

名称	Type	描述	需要	默认
messages	array	用于启动线程的消息列表。	否
tool_resources	object	一组可供此线程中的助手工具使用的资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此线程的矢量存储。 线程最多可以附加 1 个矢量存储。
vector_stores	array	一个帮助程序，用于创建具有 file_ids 的矢量存储，并将其附加到此线程。 线程最多可以附加 1 个矢量存储。

modifyThreadRequest

名称	Type	描述	需要	默认
tool_resources	object	一组可供此线程中的助手工具使用的资源。 资源特定于工具类型。 例如，code_interpreter 工具需要文件 ID 列表，而 file_search 工具需要矢量存储 ID 列表。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

tool_resources 的属性

code_interpreter

名称	Type	描述	默认
file_ids	array	可供 code_interpreter 工具使用的文件 ID 列表。 最多可以有 20 个与该工具关联的文件。	[]

file_search

名称	Type	描述	默认
vector_store_ids	array	附加到此线程的矢量存储。 线程最多可以附加 1 个矢量存储。

deleteThreadResponse

名称	Type	描述	需要	默认
id	string		是
deleted	boolean		是
对象 (object)	string		是

对象枚举：DeleteThreadResponseObjectState

值	说明
thread.deleted	删除线程响应对象状态，为 thread.deleted

listThreadsResponse

名称	Type	描述	需要	默认
object	string		是
data	array		是
first_id	string		是
last_id	string		是
has_more	boolean		是

messageObject

表示线程中的消息。

名称	Type	描述	需要	默认
id	string	可以在 API 终结点中引用的标识符。	是
对象 (object)	string	始终为 thread.message 的对象类型。	是
created_at	integer	创建消息时的 Unix 时间戳（以秒为单位）。	是
thread_id	string	此消息所属的线程 ID。	是
状态	string	运行的状态，可以是 in_progress、incomplete 或 completed。	是
incomplete_details	object	对于未补全的消息，详细说明消息未补全的原因。	是
completed_at	integer	消息补全时的 Unix 时间戳（以秒为单位）。	是
incomplete_at	integer	消息标记为未补全时的 Unix 时间戳（以秒为单位）。	是
role	string	生成消息的实体。 user 或 assistant 中的一项。	是
内容	array	文本和/或图像数组中消息的内容。	是
assistant_id	string	如果适用，则为创作此消息的助手的 ID。	是
run_id	string	如果适用，则为与此消息的创作关联的运行的 ID。	是
附件	array	附加到消息的文件列表及其添加到的工具。	是
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	是

incomplete_details 的属性

reason

名称	Type	描述	默认
reason	string	消息未补全的原因。

对象枚举：MessageObjectType

值	说明
thread.message	消息对象类型（为 thread.message）

状态枚举：MessageObjectStatus

值	说明
in_progress
incomplete
completed

角色枚举：MessageObjectRole

值	说明
user
assistant

messageDeltaObject

表示消息增量，例如，流式传输期间任何消息字段的更改。

名称	Type	描述	需要	默认
id	string	消息标识符，可在 API 终结点中引用。	是
对象 (object)	string	始终为 thread.message.delta 的对象类型。	是
delta	object	增量包含消息中有所更改的字段。	是

delta 的属性

role

名称	Type	描述	默认
role	string	生成消息的实体。 user 或 assistant 中的一项。

content

名称	Type	描述	默认
内容	array	文本和/或图像数组中消息的内容。

对象枚举：MessageDeltaObjectType

值	说明
thread.message.delta

createMessageRequest

名称	Type	描述	需要	默认
role	string	正在创建消息的实体的角色。 允许的值包括： - user：指示消息是由实际用户发送的，应在大多数情况下用于表示用户生成的消息。 - assistant：指示消息由助手生成。 使用此值将来自助手的消息插入对话。	是
内容	string	消息的内容。	是
附件	array	附加到消息的文件列表及其应添加到的工具。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

角色枚举：CreateMessageRequestRole

值	说明
user
assistant

modifyMessageRequest

名称	Type	描述	需要	默认
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

deleteMessageResponse

名称	Type	描述	需要	默认
id	string		是
deleted	boolean		是
对象 (object)	string		是

对象枚举：DeleteMessageResponseObject

值	说明
thread.message.deleted	删除消息响应对象状态

listMessagesResponse

名称	Type	描述	需要	默认
object	string		是
data	array		是
first_id	string		是
last_id	string		是
has_more	boolean		是

messageContentImageFileObject

引用消息内容中的图像文件。

名称	Type	描述	需要	默认
type	string	总是为 image_file。	是
image_file	object		是

image_file 的属性

file_id

名称	Type	描述	默认
file_id	string	消息内容中图像的文件 ID。

类型枚举：MessageContentImageFileObjectType

值	说明
image_file	消息内容图像文件类型

messageContentTextObject

作为消息一部分的文本内容。

名称	Type	描述	需要	默认
type	string	总是为 text。	是
text	object		是

text 的属性

value

名称	Type	描述	默认
value	string	构成文本的数据。

annotations

名称	Type	描述	默认
annotations	array

类型枚举：messageContentTextObjectType

值	说明
text	消息内容文本对象类型

messageContentTextAnnotationsFileCitationObject

消息中的引文，指向与助手或消息关联的特定文件中的特定引文。 当助手使用“检索”工具搜索文件时生成。

名称	Type	描述	需要	默认
type	string	总是为 file_citation。	是
text	string	需要替换的消息内容中的文本。	是
file_citation	object		是
start_index	integer		是
end_index	integer		是

file_citation 的属性

file_id

名称	Type	描述	默认
file_id	string	引文来源的特定文件的 ID。

类型枚举：FileCitationObjectType

值	说明
file_citation	文件引文对象类型

messageContentTextAnnotationsFilePathObject

助手使用 code_interpreter 工具生成文件时生成的文件的 URL。

名称	Type	描述	需要	默认
type	string	总是为 file_path。	是
text	string	需要替换的消息内容中的文本。	是
file_path	object		是
start_index	integer		是
end_index	integer		是

file_path 的属性

file_id

名称	Type	描述	默认
file_id	string	生成的文件的 ID。

类型枚举：FilePathObjectType

值	说明
file_path	文件路径对象类型

messageDeltaContentImageFileObject

引用消息内容中的图像文件。

名称	Type	描述	需要	默认
index	integer	消息中内容部件的索引。	是
type	string	总是为 image_file。	是
image_file	object		否

image_file 的属性

file_id

名称	Type	描述	默认
file_id	string	消息内容中图像的文件 ID。

类型枚举：MessageDeltaContentImageFileObjectType

值	说明
image_file

messageDeltaContentTextObject

作为消息一部分的文本内容。

名称	Type	描述	需要	默认
index	integer	消息中内容部件的索引。	是
type	string	总是为 text。	是
text	object		否

text 的属性

value

名称	Type	描述	默认
value	string	构成文本的数据。

annotations

名称	Type	描述	默认
annotations	array

类型枚举：MessageDeltaContentTextObjectType

值	说明
text

messageDeltaContentTextAnnotationsFileCitationObject

消息中的引文，指向与助手或消息关联的特定文件中的特定引文。 当助手使用“file_search”工具搜索文件时生成。

名称	Type	描述	需要	默认
index	integer	文本内容部件中批注的索引。	是
type	string	总是为 file_citation。	是
text	string	需要替换的消息内容中的文本。	否
file_citation	object		否
start_index	integer		否
end_index	integer		否

file_citation 的属性

file_id

名称	Type	描述	默认
file_id	string	引文来源的特定文件的 ID。

引号

名称	Type	描述	默认
引号	string	文件中的特定引文。

类型枚举：MessageDeltaContentTextAnnotationsFileCitationObjectType

值	说明
file_citation

messageDeltaContentTextAnnotationsFilePathObject

助手使用 code_interpreter 工具生成文件时生成的文件的 URL。

名称	Type	描述	需要	默认
index	integer	文本内容部件中批注的索引。	是
type	string	总是为 file_path。	是
text	string	需要替换的消息内容中的文本。	否
file_path	object		否
start_index	integer		否
end_index	integer		否

file_path 的属性

file_id

名称	Type	描述	默认
file_id	string	生成的文件的 ID。

类型枚举：MessageDeltaContentTextAnnotationsFilePathObjectType

值	说明
file_path

runStepObject

表示运行执行过程中的一个步骤。

名称	Type	描述	需要	默认
id	string	可在 API 终结点中引用的运行步骤标识符。	是
对象 (object)	string	始终为 assistant.run.step 的对象类型。	是
created_at	integer	创建运行步骤时的 Unix 时间戳（以秒为单位）。	是
assistant_id	string	与运行步骤关联的助手的 ID。	是
thread_id	string	运行的线程的 ID。	是
run_id	string	此运行步骤所属的运行的 ID。	是
type	string	运行步骤的状态，可以是 message_creation 或 tool_calls。	是
状态	string	运行的状态，可以是 in_progress、cancelled、failed、completed 或 expired。	是
step_details	runStepDetailsMessageCreationObject 或 runStepDetailsToolCallsObject	运行步骤的详细信息。	是
last_error	object	与此运行步骤关联的最后一个错误。 如果没有错误，则为 null。	是
expired_at	integer	运行步骤过期时的 Unix 时间戳（以秒为单位）。 如果父运行已过期，则认为步骤已过期。	是
cancelled_at	integer	取消运行步骤时的 Unix 时间戳（以秒为单位）。	是
failed_at	integer	运行步骤失败时的 Unix 时间戳（以秒为单位）。	是
completed_at	integer	运行步骤完成时的 Unix 时间戳（以秒为单位）。	是
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	是

last_error 的属性

code

名称	Type	描述	默认
code	string	server_error 或 rate_limit_exceeded 中的一项。

message

名称	Type	描述	默认
message	string	可读的错误说明。

对象枚举：RunStepObjectType

值	说明
assistant.run.step	对象类型，始终为 assistant.run.step

类型枚举：RunStepObjectType

值	说明
message_creation	message_creation 运行步骤
tool_calls	tool_calls 运行步骤

状态枚举：RunStepObjectStatus

值	说明
in_progress	in_progress 运行状态
cancelled	cancelled 运行状态
失败	cancelled 运行状态
completed	cancelled 运行状态
已过期	cancelled 运行状态

runStepDeltaObject

表示运行步骤增量，例如，流式传输期间任何运行步骤字段的更改。

名称	Type	描述	需要	默认
id	string	可在 API 终结点中引用的运行步骤标识符。	是
对象 (object)	string	始终为 thread.run.step.delta 的对象类型。	是
delta	object	增量包含运行步骤中有所更改的字段。	是

delta 的属性

step_details

名称	Type	描述	默认
step_details	runStepDeltaStepDetailsMessageCreationObject 或 runStepDeltaStepDetailsToolCallsObject	运行步骤的详细信息。

对象枚举：RunStepDeltaObjectType

值	说明
thread.run.step.delta

listRunStepsResponse

名称	Type	描述	需要	默认
object	string		是
data	array		是
first_id	string		是
last_id	string		是
has_more	boolean		是

runStepDetailsMessageCreationObject

运行步骤创建消息的详细信息。

名称	Type	描述	需要	默认
type	string	总是为 message_creation。	是
message_creation	object		是

message_creation 的属性

message_id

名称	Type	描述	默认
message_id	string	此运行步骤创建的消息的 ID。

类型枚举：RunStepDetailsMessageCreationObjectType

值	说明
message_creation

runStepDeltaStepDetailsMessageCreationObject

运行步骤创建消息的详细信息。

名称	Type	描述	需要	默认
type	string	总是为 message_creation。	是
message_creation	object		否

message_creation 的属性

message_id

名称	Type	描述	默认
message_id	string	此运行步骤创建的消息的 ID。

类型枚举：RunStepDeltaStepDetailsMessageCreationObjectType

值	说明
message_creation

runStepDetailsToolCallsObject

工具调用的详细信息。

名称	Type	描述	需要	默认
type	string	总是为 tool_calls。	是
tool_calls	array	涉及运行步骤的工具调用数组。 这可以与以下三种类型的工具之一相关联：code_interpreter、retrieval 或 function。	是

类型枚举：RunStepDetailsToolCallsObjectType

值	说明
tool_calls

runStepDeltaStepDetailsToolCallsObject

工具调用的详细信息。

名称	Type	描述	需要	默认
type	string	总是为 tool_calls。	是
tool_calls	array	涉及运行步骤的工具调用数组。 这可以与以下三种类型的工具之一相关联：code_interpreter、file_search 或 function。	否

类型枚举：RunStepDeltaStepDetailsToolCallsObjectType

值	说明
tool_calls

runStepDetailsToolCallsCodeObject

运行步骤所涉及的代码解释器工具调用的详细信息。

名称	Type	描述	需要	默认
id	string	工具调用的 ID。	是
type	string	工具调用的类型。 这种类型的工具调用始终为 code_interpreter。	是
code_interpreter	object	代码解释器工具调用定义。	是

code_interpreter 的属性

input

名称	Type	描述	默认
input	string	代码解释器工具调用的输入。

outputs

名称	Type	描述	默认
outputs	array	代码解释器工具调用的输出。 代码解释器可以输出一个或多个项目，包括文本 (logs) 或图像 (image)。 每个项目都由不同的对象类型表示。

类型枚举：RunStepDetailsToolCallsCodeObjectType

值	说明
code_interpreter

runStepDeltaStepDetailsToolCallsCodeObject

运行步骤所涉及的代码解释器工具调用的详细信息。

名称	Type	描述	需要	默认
index	integer	工具调用数组中工具调用的索引。	是
id	string	工具调用的 ID。	否
type	string	工具调用的类型。 这种类型的工具调用始终为 code_interpreter。	是
code_interpreter	object	代码解释器工具调用定义。	否

code_interpreter 的属性

input

名称	Type	描述	默认
input	string	代码解释器工具调用的输入。

outputs

名称	Type	描述	默认
outputs	array	代码解释器工具调用的输出。 代码解释器可以输出一个或多个项目，包括文本 (logs) 或图像 (image)。 每个项目都由不同的对象类型表示。

类型枚举：RunStepDeltaStepDetailsToolCallsCodeObjectType

值	说明
code_interpreter

runStepDetailsToolCallsCodeOutputLogsObject

作为运行步骤一部分的代码解释器工具调用的文本输出。

名称	Type	描述	需要	默认
type	string	总是为 logs。	是
日志	string	代码解释器工具调用的文本输出。	是

类型枚举：RunStepDetailsToolCallsCodeOutputLogsObjectType

值	说明
日志

runStepDeltaStepDetailsToolCallsCodeOutputLogsObject

作为运行步骤一部分的代码解释器工具调用的文本输出。

名称	Type	描述	需要	默认
index	integer	输出数组中输出的索引。	是
type	string	总是为 logs。	是
日志	string	代码解释器工具调用的文本输出。	否

类型枚举：RunStepDeltaStepDetailsToolCallsCodeOutputLogsObjectType

值	说明
日志

runStepDetailsToolCallsCodeOutputImageObject

名称	Type	描述	需要	默认
type	string	总是为 image。	是
image	object		是

image 的属性

file_id

名称	Type	描述	默认
file_id	string	图像的文件 ID。

类型枚举：RunStepDetailsToolCallsCodeOutputImageObjectType

值	说明
图像

runStepDeltaStepDetailsToolCallsCodeOutputImageObject

名称	Type	描述	需要	默认
index	integer	输出数组中输出的索引。	是
type	string	总是为 image。	是
image	object		否

image 的属性

file_id

名称	Type	描述	默认
file_id	string	图像的文件 ID。

类型枚举：RunStepDeltaStepDetailsToolCallsCodeOutputImageObject

值	说明
图像

runStepDetailsToolCallsFileSearchObject

名称	Type	描述	需要	默认
id	string	工具调用对话的 ID。	是
type	string	工具调用的类型。 这种类型的工具调用始终为 file_search。	是
file_search	object	目前，这始终是一个空对象。	是

类型枚举：RunStepDetailsToolCallsFileSearchObjectType

值	说明
file_search

runStepDeltaStepDetailsToolCallsFileSearchObject

名称	Type	描述	需要	默认
index	integer	工具调用数组中工具调用的索引。	是
id	string	工具调用对话的 ID。	否
type	string	工具调用的类型。 这种类型的工具调用始终为 retrieval。	是
file_search	object	目前，这始终是一个空对象。	是

类型枚举：RunStepDeltaStepDetailsToolCallsFileSearchObjectType

值	说明
file_search

runStepDetailsToolCallsFunctionObject

名称	Type	描述	需要	默认
id	string	工具调用对话的 ID。	是
type	string	工具调用的类型。 这种类型的工具调用始终为 function。	是
function	object	调用的函数的定义。	是

function 的属性

name

名称	Type	描述	默认
name	string	函数的名称。

参数

名称	Type	描述	默认
参数	string	传递给函数的参数。

output

名称	Type	描述	默认
output	string	函数的输出。 如果尚未提交输出，则为 null。

类型枚举：RunStepDetailsToolCallsFunctionObjectType

值	说明
function

runStepDeltaStepDetailsToolCallsFunctionObject

名称	Type	描述	需要	默认
index	integer	工具调用数组中工具调用的索引。	是
id	string	工具调用对话的 ID。	否
type	string	工具调用的类型。 这种类型的工具调用始终为 function。	是
function	object	调用的函数的定义。	否

function 的属性

name

名称	Type	描述	默认
name	string	函数的名称。

参数

名称	Type	描述	默认
参数	string	传递给函数的参数。

output

名称	Type	描述	默认
output	string	函数的输出。 如果尚未提交输出，则为 null。

类型枚举：RunStepDetailsToolCallsFunctionObjectType

值	说明
function

vectorStoreExpirationAfter

矢量存储过期策略。

名称	Type	描述	需要	默认
定位点	string	定位点时间戳，在此时间之后会应用过期策略。 支持的定位点：last_active_at。	是
days	integer	在定位点时间之后，矢量存储将过期的天数。	是

定位点枚举：VectorStoreExpirationAfterAnchor

值	说明
last_active_at	定位点时间戳，在此时间之后会应用过期策略。

vectorStoreObject

矢量存储是 file_search 工具可以使用已处理文件的集合。

名称	Type	描述	需要	默认
id	string	可以在 API 终结点中引用的标识符。	是
对象 (object)	enum	始终为 vector_store 的对象类型。 可能的值：vector_store	是
created_at	integer	创建矢量存储时的 Unix 时间戳（以秒为单位）。	是
名称	string	矢量存储的名称。	是
usage_bytes	integer	矢量存储区中文件使用的总字节数。	是
file_counts	object		是
状态	string	矢量存储的状态，可以是 expired、in_progress 或 completed。 状态 completed 指示矢量存储可供使用。	是
expires_after	vectorStoreExpirationAfter	矢量存储过期策略。	否
expires_at	integer	矢量存储将过期时的 Unix 时间戳（以秒为单位）。	否
last_active_at	integer	矢量存储上次活动时的 Unix 时间戳（以秒为单位）。	是
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	是

file_counts 的属性

in_progress

名称	Type	描述	默认
in_progress	integer	当前正在处理的文件数。

completed

名称	Type	描述	默认
completed	integer	已成功处理的文件数。

失败

名称	Type	描述	默认
失败	integer	未能处理的文件数。

cancelled

名称	Type	描述	默认
cancelled	integer	已取消的文件数。

total

名称	Type	描述	默认
total	integer	文件总数。

状态枚举：VectorStoreObjectStatus

值	说明
已过期
in_progress
completed

createVectorStoreRequest

名称	Type	描述	需要	默认
file_ids	array	矢量存储应使用的文件 ID 列表。 适用于可以访问文件的 file_search 等工具。	否
name	string	矢量存储的名称。	否
expires_after	vectorStoreExpirationAfter	矢量存储过期策略。	否
chunking_strategy	autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam	用于对文件进行分块的分块策略。 如果未设置，则将使用 auto 策略。 仅当 file_ids 非空时适用。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

updateVectorStoreRequest

名称	Type	描述	需要	默认
name	string	矢量存储的名称。	否
expires_after	vectorStoreExpirationAfter	矢量存储过期策略。	否
metadata	object	按 16 个成组的可附加到对象的键值对。 这对以结构化格式存储对象相关的附加信息很有用。 键的最大长度为 64 个字符，值的最大长度为 512 个字符。	否

listVectorStoresResponse

名称	Type	描述	需要	默认
object	string		是
data	array		是
first_id	string		是
last_id	string		是
has_more	boolean		是

deleteVectorStoreResponse

名称	Type	描述	需要	默认
id	string		是
deleted	boolean		是
对象 (object)	string		是

对象枚举：DeleteVectorStoreResponseObject

值	说明
vector_store.deleted	删除矢量存储响应对象状态

vectorStoreFileObject

附加到矢量存储的文件列表。

名称	Type	描述	需要	默认
id	string	可以在 API 终结点中引用的标识符。	是
对象 (object)	string	始终为 vector_store.file 的对象类型。	是
usage_bytes	integer	总矢量存储使用量（以字节为单位）。 请注意，这可能不同于原始文件大小。	是
created_at	integer	创建矢量存储文件时的 Unix 时间戳（以秒为单位）。	是
vector_store_id	string	附加文件的矢量存储的 ID。	是
状态	string	矢量存储文件的状态，可以是 in_progress、completed、cancelled 或 failed。 状态 completed 指示矢量存储文件可供使用。	是
last_error	object	与此矢量存储文件关联的最后一个错误。 如果没有错误，则为 null。	是
chunking_strategy	autoChunkingStrategyRequestParam 或 staticChunkingStrategyRequestParam	用于对文件进行分块的分块策略。 如果未设置，则将使用 auto 策略。 仅当 file_ids 非空时适用。	否

last_error 的属性

code

名称	Type	描述	默认
code	string	server_error 或 rate_limit_exceeded 中的一项。

message

名称	Type	描述	默认
message	string	可读的错误说明。

对象枚举：VectorStoreFileObjectType

值	说明
vector_store.file

状态枚举：VectorStoreFileObjectStatus

值	说明
in_progress
completed
cancelled
失败

otherChunkingStrategyResponseParam

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

名称	Type	描述	需要	默认
type	string	总是为 other。	是

type Enum: OtherChunkingStrategyResponseParamType

值	说明
其他

staticChunkingStrategyResponseParam

名称	Type	描述	需要	默认
type	string	总是为 static。	是
静态	staticChunkingStrategy		是

type Enum: StaticChunkingStrategyResponseParamType

值	说明
静态

staticChunkingStrategy

名称	Type	描述	需要	默认
max_chunk_size_tokens	integer	每个区块中的最大标记数。 默认值为 800。 最小值为 100，最大值为 4096。	是
chunk_overlap_tokens	integer	区块之间重叠的标记数。 默认值为 400。 请注意，重叠不得超过 max_chunk_size_tokens 的一半。	是

autoChunkingStrategyRequestParam

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

名称	Type	描述	需要	默认
type	enum	总是为 auto。 可能的值：自动	是

staticChunkingStrategyRequestParam

名称	Type	描述	需要	默认
type	enum	总是为 static。 可能的值：静态	是
静态	staticChunkingStrategy		是

chunkingStrategyRequestParam

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

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

createVectorStoreFileRequest

名称	Type	描述	需要	默认
file_id	string	矢量存储应使用的文件 ID。 适用于可以访问文件的 file_search 等工具。	是
chunking_strategy	chunkingStrategyRequestParam	用于对文件进行分块的分块策略。 如果未设置，则将使用 auto 策略。	否

listVectorStoreFilesResponse

名称	Type	描述	需要	默认
object	string		是
data	array		是
first_id	string		是
last_id	string		是
has_more	boolean		是

deleteVectorStoreFileResponse

名称	Type	描述	需要	默认
id	string		是
deleted	boolean		是
对象 (object)	string		是

对象枚举：DeleteVectorStoreFileResponseObject

值	说明
vector_store.file.deleted

vectorStoreFileBatchObject

附加到矢量存储的批量文件。

名称	Type	描述	需要	默认
id	string	可以在 API 终结点中引用的标识符。	是
对象 (object)	string	始终为 vector_store.file_batch 的对象类型。	是
created_at	integer	创建矢量存储文件批处理时的 Unix 时间戳（以秒为单位）。	是
vector_store_id	string	附加文件的矢量存储的 ID。	是
状态	string	矢量存储文件批处理的状态，可以是 in_progress、completed、cancelled 或 failed。	是
file_counts	object		是

file_counts 的属性

in_progress

名称	Type	描述	默认
in_progress	integer	当前正在处理的文件数。

completed

名称	Type	描述	默认
completed	integer	已处理的文件数。

失败

名称	Type	描述	默认
失败	integer	未能处理的文件数。

cancelled

名称	Type	描述	默认
cancelled	integer	已取消的文件数。

total

名称	Type	描述	默认
total	integer	文件总数。

对象枚举：VectorStoreFileBatchObjectType

值	说明
vector_store.files_batch

状态枚举：VectorStoreFileBatchObjectStatus

值	说明
in_progress
completed
cancelled
失败

createVectorStoreFileBatchRequest

名称	Type	描述	需要	默认
file_ids	array	矢量存储应使用的文件 ID 列表。 适用于可以访问文件的 file_search 等工具。	是
chunking_strategy	chunkingStrategyRequestParam	用于对文件进行分块的分块策略。 如果未设置，则将使用 auto 策略。	否

assistantStreamEvent

表示流式传输运行时发出的事件。

服务器发送事件流中的每个事件都有一个 event 和 data 属性：

event: thread.created
data: {"id": "thread_123", "object": "thread", ...}

每当创建新对象、转换为新状态或部分流式传输（增量）时，就会发出事件。 例如，创建新运行时发出 thread.run.created，运行完成后发出 thread.run.completed 等。 当助手选择在运行期间创建消息时，将发出 thread.message.created event 事件、thread.message.in_progress 事件、多个 thread.message.delta 事件以及最终的 thread.message.completed 事件。

随着时间的推移，我们可能会添加其他事件，因此我们建议在代码中妥善处理未知事件。

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

threadStreamEvent

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

thread.created

创建新线程时发生。

名称	Type	描述	需要	默认
event	string		是
data	threadObject	表示包含消息的线程。	是

数据：threadObject

事件枚举：ThreadStreamEventEnum

值	说明
thread.created	线程创建事件

---

runStreamEvent

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

thread.run.created

创建新运行时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventCreated

值	说明
thread.run.created

---

thread.run.queued

当运行变为 queued 状态时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventQueued

值	说明
thread.run.queued

---

thread.run.in_progress

当运行变为 in_progress 状态时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventInProgress

值	说明
thread.run.in_progress

---

thread.run.requires_action

当运行变为 requires_action 状态时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventRequiresAction

值	说明
thread.run.requires_action

---

thread.run.completed

当运行完成时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventCompleted

值	说明
thread.run.completed

---

thread.run.failed

当运行失败时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventFailed

值	说明
thread.run.failed

---

thread.run.cancelling

当运行变为 cancelling 状态时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventCancelling

值	说明
thread.run.cancelling

---

thread.run.cancelled

当运行取消时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventCancelled

值	说明
thread.run.cancelled

---

thread.run.expired

当运行过期时发生。

名称	Type	描述	需要	默认
event	string		是
data	runObject	表示在线程上运行的执行。	是

数据：runObject

事件枚举：RunStreamEventExpired

值	说明
thread.run.expired

---

runStepStreamEvent

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

thread.run.step.created

当创建运行步骤时发生。

名称	Type	描述	需要	默认
event	string		是
data	runStepObject	表示运行执行过程中的一个步骤。	是

数据：runStepObject

事件枚举：RunStepStreamEventCreated

值	说明
thread.run.step.created

---

thread.run.step.in_progress

当运行步骤变为 in_progress 状态时发生。

名称	Type	描述	需要	默认
event	string		是
data	runStepObject	表示运行执行过程中的一个步骤。	是

数据：runStepObject

事件枚举：RunStepStreamEventInProgress

值	说明
thread.run.step.in_progress

---

thread.run.step.delta

在流式传输部分运行步骤时发生。

名称	Type	描述	需要	默认
event	string		是
data	runStepDeltaObject	表示运行步骤增量，例如，流式传输期间任何运行步骤字段的更改。	是

数据：runStepDeltaObject

事件枚举：RunStepStreamEventDelta

值	说明
thread.run.step.delta

---

thread.run.step.completed

当运行步骤完成时发生。

名称	Type	描述	需要	默认
event	string		是
data	runStepObject	表示运行执行过程中的一个步骤。	是

数据：runStepObject

事件枚举：RunStepStreamEventCompleted

值	说明
thread.run.step.completed

---

thread.run.step.failed

当运行步骤失败时发生。

名称	Type	描述	需要	默认
event	string		是
data	runStepObject	表示运行执行过程中的一个步骤。	是

数据：runStepObject

事件枚举：RunStepStreamEventFailed

值	说明
thread.run.step.failed

---

thread.run.step.cancelled

当运行步骤取消时发生。

名称	Type	描述	需要	默认
event	string		是
data	runStepObject	表示运行执行过程中的一个步骤。	是

数据：runStepObject

事件枚举：RunStepStreamEventCancelled

值	说明
thread.run.step.cancelled

---

thread.run.step.expired

当运行步骤过期时发生。

名称	Type	描述	需要	默认
event	string		是
data	runStepObject	表示运行执行过程中的一个步骤。	是

数据：runStepObject

事件枚举：RunStepStreamEventExpired

值	说明
thread.run.step.expired

---

messageStreamEvent

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

thread.message.created

当创建消息时发生。

名称	Type	描述	需要	默认
event	string		是
data	messageObject	表示线程中的消息。	是

数据：messageObject

事件枚举：MessageStreamEventCreated

值	说明
thread.message.created

---

thread.message.in_progress

当消息变为 in_progress 状态时发生。

名称	Type	描述	需要	默认
event	string		是
data	messageObject	表示线程中的消息。	是

数据：messageObject

事件枚举：MessageStreamEventInProgress

值	说明
thread.message.in_progress

---

thread.message.delta

当流式传输部分消息时发生。

名称	Type	描述	需要	默认
event	string		是
data	messageDeltaObject	表示消息增量，例如，流式传输期间任何消息字段的更改。	是

数据：messageDeltaObject

事件枚举：MessageStreamEventDelta

值	说明
thread.message.delta

---

thread.message.completed

当消息完成时发生。

名称	Type	描述	需要	默认
event	string		是
data	messageObject	表示线程中的消息。	是

数据：messageObject

事件枚举：MessageStreamEventCompleted

值	说明
thread.message.completed

---

thread.message.incomplete

当消息在完成前结束时发生。

名称	Type	描述	需要	默认
event	string		是
data	messageObject	表示线程中的消息。	是

数据：messageObject

事件枚举：MessageStreamEventIncomplete

值	说明
thread.message.incomplete

---

errorEvent

当出现错误时发生。 这可能是内部服务器错误或超时导致的。

名称	Type	描述	需要	默认
event	string		是
data	error		是

事件枚举：ErrorEventEnum

值	说明
error

doneEvent

当流式传输结束时发生。

名称	Type	描述	需要	默认
event	string		是
data	string		是

事件枚举：DoneEventEnum

值	说明
done

数据枚举：DoneEventDataEnum

值	说明
[完成]

后续步骤

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