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

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

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

API specs

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

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

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

Important

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

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

Authentication

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

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

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

REST API 版本控制

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

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

数据平面推理

本文的其余部分介绍了 Azure OpenAI 数据平面推理规范的正式发布，2024-10-21。

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

Completions

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

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

URI Parameters

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

Request Header

Name Required 类型 Description
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
提示 字符串或数组 要为其生成完成的提示，编码为字符串、字符串数组、令牌数组或令牌数组数组。

请注意， <|endoftext|> 是模型在训练期间看到的文档分隔符，因此如果未指定提示，模型将生成，就像从新文档的开头一样。
 Yes
best_of 整数 生成 best_of 完成服务器端并返回“最佳”（每个标记具有最高对数概率的完成项）。 无法流式传输结果。

与 一起使用时，控制候选补全数，并指定返回的次数必须大于/a0>。

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

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

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

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

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

注意： 由于此参数会生成许多完成，因此可以快速使用令牌配额。 仔细使用并确保你具有合理的设置 max_tokens 和 stop。
 No 1
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。
 No 0
seed 整数 如果指定，我们的系统将尽最大努力以确定性方式采样，这样具有相同参数的重复请求 seed 应返回相同的结果。

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

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

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

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

Responses

状态代码： 200

Description: OK

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

状态代码： 默认值

说明：服务不可用

Content-Type Type Description
application/json errorResponse

Examples

Example

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

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

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

Embeddings

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

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

URI Parameters

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

Request Header

Name Required 类型 Description
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

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

Responses

Name 类型 Description Required Default
对象 字符串 Yes
模型 字符串 Yes
数据 数组 Yes
使用情况 对象 Yes

用法属性

prompt_tokens

Name 类型 Description Default
prompt_tokens 整数

total_tokens

Name 类型 Description Default
total_tokens 整数

状态代码： 200

Description: OK

Content-Type Type Description
application/json 对象

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2024-10-21

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

Chat completions

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

为聊天消息创建完成

URI Parameters

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

Request Header

Name Required 类型 Description
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。

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

我们通常建议更改这一点， temperature 但不建议同时更改这两者。
 No 1
数据流 boolean 如果已设置，则会发送部分消息增量，例如 ChatGPT。 令牌将在可用时以仅数据服务器 发送的事件的形式发送 ，流由 data: [DONE] 消息终止。 No False
stop 字符串或数组 最多四个序列，其中 API 将停止生成进一步的令牌。
 No
max_tokens 整数 可在聊天完成中生成的最大令牌数。

输入令牌和生成的令牌的总长度受模型的上下文长度限制。		 No
max_completion_tokens 整数 可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 No
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。
 No 0
frequency_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据文本中的现有频率惩罚新令牌，从而减少模型重复相同行的可能性。
 No 0
logit_bias 对象 修改指定令牌在完成中出现的可能性。

接受 JSON 对象，该对象将令牌（由令牌 ID 在 tokenizer 中指定）映射到从 -100 到 100 的关联偏差值。 从数学上看，偏差将添加到模型在采样之前生成的对数。 具体效果因模型而异，但 -1 和 1 之间的值应减少或增加选择的可能性;-100 或 100 等值应导致相关令牌的禁止或独占选择。
 No None
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。
 No
messages 数组 到目前为止，包含对话的消息列表。 Yes
data_sources 数组 Azure使用 OpenAI 聊天扩展的配置条目。
此附加规范仅与 Azure OpenAI 兼容。		 No
logprobs boolean 是否返回输出令牌的对数概率。 如果为 true，则返回在以下content项中message返回的每个输出令牌的对数概率。 No False
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 如果使用此参数，则必须设置为 < No
n 整数 要为每个输入消息生成的聊天完成选项数。 请注意，将根据所有选项中生成的令牌数向你收费。 n尽量1降低成本。 No 1
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
response_format ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema 一个对象，指定模型必须输出的格式。 与 GPT-4o、 GPT-4o mini、 GPT-4 Turbo 和所有 GPT-3.5 Turbo 型号兼容 gpt-3.5-turbo-1106。

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

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

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。
 No
seed 整数 此功能在 Beta 版中。
如果指定，我们的系统将尽最大努力以确定性方式采样，这样具有相同参数的重复请求 seed 应返回相同的结果。
无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。
 No
tools 数组 模型可以调用的工具列表。 目前，仅支持函数作为工具。 使用此函数提供模型可能会为其生成 JSON 输入的函数列表。 最多支持 128 个函数。
 No
tool_choice chatCompletionToolChoiceOption 控制模型调用哪个（如果有）工具。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。 通过 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具来指定特定工具。 none 如果没有工具，则为默认值。 auto 如果存在工具，则为默认值。 No
function_call string 或 chatCompletionFunctionCallOption 弃用赞成 tool_choice。

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

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

模型可能为其生成 JSON 输入的函数列表。
 No

Responses

状态代码： 200

Description: OK

Content-Type Type Description
application/json createChatCompletionResponse 或 createChatCompletionStreamResponse

状态代码： 默认值

说明：服务不可用

Content-Type Type Description
application/json errorResponse

Examples

Example

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

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

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

响应：状态代码：200

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

Example

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

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

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

响应：状态代码：200

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

Example

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

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

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

响应：状态代码：200

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

Example

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

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

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

听录 - 创建

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

将音频转录为输入语言。

URI Parameters

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

有关支持的模型的信息，请参阅 [/azure/ai-foundry/openai/concepts/models#audio-models]。
api-version 查询 Yes 字符串 API version

Request Header

Name Required 类型 Description
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: multipart/form-data

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

Responses

状态代码： 200

Description: OK

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

Examples

Example

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

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

响应：状态代码：200

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

Example

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

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

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

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

URI Parameters

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

有关支持的模型的信息，请参阅 [/azure/ai-foundry/openai/concepts/models#audio-models]。
api-version 查询 Yes 字符串 API version

Request Header

Name Required 类型 Description
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: multipart/form-data

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

Responses

状态代码： 200

Description: OK

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

Examples

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

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

响应：状态代码：200

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

Example

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

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2024-10-21

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

Image generation

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

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

URI Parameters

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

Request Header

Name Required 类型 Description
api-key True 字符串 在此处提供 Azure OpenAI API 密钥

Request Body

Content-Type: application/json

Name 类型 Description Required Default
提示 字符串 所需图像的文本说明。 最大长度为 4,000 个字符。 Yes
n 整数 要生成的图像数。 No 1
size imageSize 生成的图像的大小。 No 1024x1024
response_format imagesResponseFormat 返回生成的图像的格式。 No url
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。 No
quality imageQuality 将生成的图像的质量。 No 标准
样式 imageStyle 生成的图像的样式。 No vivid

Responses

状态代码： 200

Description: Ok

Content-Type Type Description
application/json generateImagesResponse

状态代码： 默认值

说明：发生错误。

Content-Type Type Description
application/json dalleErrorResponse

Examples

Example

根据提示创建映像。

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2024-10-21

{
 "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
          }
        },
        "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
          }
        }
      }
    ]
  }
}

Components

errorResponse

Name 类型 Description Required Default
错误 error No

errorBase

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

错误

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

innerError

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

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

innerErrorCode

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

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

Type: string

Default:

枚举名称：InnerErrorCode

Enum Values:

Value Description
ResponsibleAIPolicyViolation 提示违反了其他内容筛选器规则之一。

dalleErrorResponse

Name 类型 Description Required Default
错误 dalleError No

dalleError

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

dalleInnerError

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

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

contentFilterResultBase

Name 类型 Description Required Default
filtered boolean Yes

contentFilterSeverityResult

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

contentFilterDetectedResult

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

contentFilterDetectedWithCitationResult

Name 类型 Description Required Default
citation 对象 No

引文的属性

URL

Name 类型 Description Default
URL 字符串

许可

Name 类型 Description Default
许可 字符串

contentFilterResultsBase

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

Name 类型 Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
profanity contentFilterDetectedResult No
错误 errorBase No

contentFilterPromptResults

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

Name 类型 Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
profanity contentFilterDetectedResult No
错误 errorBase No
jailbreak contentFilterDetectedResult No

contentFilterChoiceResults

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

Name 类型 Description Required Default
sexual contentFilterSeverityResult No
violence contentFilterSeverityResult No
hate contentFilterSeverityResult No
self_harm contentFilterSeverityResult No
profanity contentFilterDetectedResult No
错误 errorBase No
protected_material_text contentFilterDetectedResult No
protected_material_code contentFilterDetectedWithCitationResult No

promptFilterResult

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

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

promptFilterResults

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

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

dalleContentFilterResults

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

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

dalleFilterResults

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

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

chatCompletionsRequestCommon

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

createCompletionRequest

Name 类型 Description Required Default
提示 字符串或数组 要为其生成完成的提示，编码为字符串、字符串数组、令牌数组或令牌数组数组。

请注意， <|endoftext|> 是模型在训练期间看到的文档分隔符，因此如果未指定提示，模型将生成，就像从新文档的开头一样。
 Yes
best_of 整数 生成 best_of 完成服务器端并返回“最佳”（每个标记具有最高对数概率的完成项）。 无法流式传输结果。

与 一起使用时，控制候选补全数，并指定返回的次数必须大于/a0>。

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

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

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

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

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

注意： 由于此参数会生成许多完成，因此可以快速使用令牌配额。 仔细使用并确保你具有合理的设置 max_tokens 和 stop。
 No 1
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。
 No 0
seed 整数 如果指定，我们的系统将尽最大努力以确定性方式采样，这样具有相同参数的重复请求 seed 应返回相同的结果。

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

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

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

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

createCompletionResponse

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

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

可以与请求参数结合使用 seed ，以了解后端更改何时发生可能影响确定性。
 No
对象 枚举 对象类型，始终为“text_completion”
可能的值：text_completion		 Yes
使用情况 completionUsage 完成请求的使用情况统计信息。 No

createChatCompletionRequest

Name 类型 Description Required Default
temperature number 要使用的采样温度介于 0 和 2 之间。 较高的值（如 0.8）将使输出更随机，而 0.2 等较低值将使输出更加集中和确定。

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

我们通常建议更改这一点， temperature 但不建议同时更改这两者。
 No 1
数据流 boolean 如果已设置，则会发送部分消息增量，例如 ChatGPT。 令牌将在可用时以仅数据服务器 发送的事件的形式发送 ，流由 data: [DONE] 消息终止。 No False
stop 字符串或数组 最多四个序列，其中 API 将停止生成进一步的令牌。
 No
max_tokens 整数 可在聊天完成中生成的最大令牌数。

输入令牌和生成的令牌的总长度受模型的上下文长度限制。		 No
max_completion_tokens 整数 可为完成生成的令牌数的上限，包括可见的输出令牌和推理令牌。 No
presence_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据这些令牌是否出现在文本中来惩罚新标记，从而增加模型谈论新主题的可能性。
 No 0
frequency_penalty number 介于 -2.0 和 2.0 之间的数字。 正值会根据文本中的现有频率惩罚新令牌，从而减少模型重复相同行的可能性。
 No 0
logit_bias 对象 修改指定令牌在完成中出现的可能性。

接受 JSON 对象，该对象将令牌（由令牌 ID 在 tokenizer 中指定）映射到从 -100 到 100 的关联偏差值。 从数学上看，偏差将添加到模型在采样之前生成的对数。 具体效果因模型而异，但 -1 和 1 之间的值应减少或增加选择的可能性;-100 或 100 等值应导致相关令牌的禁止或独占选择。
 No None
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。
 No
messages 数组 到目前为止，包含对话的消息列表。 Yes
data_sources 数组 Azure使用 OpenAI 聊天扩展的配置条目。
此附加规范仅与 Azure OpenAI 兼容。		 No
logprobs boolean 是否返回输出令牌的对数概率。 如果为 true，则返回在以下content项中message返回的每个输出令牌的对数概率。 No False
top_logprobs 整数 一个介于 0 和 20 之间的整数，指定在每个标记位置返回的最有可能的标记数，每个标记都有关联的对数概率。 如果使用此参数，则必须设置为 < No
n 整数 要为每个输入消息生成的聊天完成选项数。 请注意，将根据所有选项中生成的令牌数向你收费。 n尽量1降低成本。 No 1
parallel_tool_calls ParallelToolCalls 是否在工具使用期间启用并行函数调用。 No True
response_format ResponseFormatText 或 ResponseFormatJsonObject 或 ResponseFormatJsonSchema 一个对象，指定模型必须输出的格式。 与 GPT-4o、 GPT-4o mini、 GPT-4 Turbo 和所有 GPT-3.5 Turbo 型号兼容 gpt-3.5-turbo-1106。

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

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

重要说明： 使用 JSON 模式时， 还必须 指示模型通过系统或用户消息自行生成 JSON。 如果没有此限制，模型可能会生成一个无限的空白流，直到生成达到令牌限制，从而导致长时间运行且看似“停滞”的请求。 另请注意，如果 finish_reason="length"消息内容已超出，则消息内容可能会部分中断，这表示已超出 max_tokens 生成或会话超出最大上下文长度。
 No
seed 整数 此功能在 Beta 版中。
如果指定，我们的系统将尽最大努力以确定性方式采样，这样具有相同参数的重复请求 seed 应返回相同的结果。
无法保证确定性，应引用 system_fingerprint 响应参数来监视后端中的更改。
 No
tools 数组 模型可以调用的工具列表。 目前，仅支持函数作为工具。 使用此函数提供模型可能会为其生成 JSON 输入的函数列表。 最多支持 128 个函数。
 No
tool_choice chatCompletionToolChoiceOption 控制模型调用哪个（如果有）工具。 none 表示模型不会调用任何工具，而是生成消息。 auto 表示模型可以在生成消息或调用一个或多个工具之间进行选择。 required 表示模型必须调用一个或多个工具。 通过 {"type": "function", "function": {"name": "my_function"}} 强制模型调用该工具来指定特定工具。 none 如果没有工具，则为默认值。 auto 如果存在工具，则为默认值。 No
function_call string 或 chatCompletionFunctionCallOption 弃用赞成 tool_choice。

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

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

模型可能为其生成 JSON 输入的函数列表。
 No

chatCompletionFunctions

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

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

chatCompletionFunctionCallOption

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

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

chatCompletionRequestMessage

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

chatCompletionRequestSystemMessage

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

chatCompletionRequestUserMessage

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

chatCompletionRequestAssistantMessage

Name 类型 Description Required Default
内容 字符串或数组 助理消息的内容。 除非 tool_calls 指定或 function_call 指定，否则是必需的。
 No
refusal 字符串 助理发出的拒绝信息。 No
角色 枚举 消息作者的角色，在本例 assistant中。
可能的值：助手		 Yes
name 字符串 参与者的可选名称。 提供模型信息，以区分同一角色的参与者。 No
tool_calls chatCompletionMessageToolCalls 模型生成的工具调用，例如函数调用。 No
function_call 对象 已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。 No

function_call的属性

arguments

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

name

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

chatCompletionRequestToolMessage

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

chatCompletionRequestFunctionMessage

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

chatCompletionRequestSystemMessageContentPart

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

chatCompletionRequestUserMessageContentPart

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

chatCompletionRequestAssistantMessageContentPart

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

chatCompletionRequestToolMessageContentPart

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

chatCompletionRequestMessageContentPartText

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

chatCompletionRequestMessageContentPartImage

Name 类型 Description Required Default
类型 枚举 内容部件的类型。
可能的值：image_url		 Yes
image_url 对象 Yes

image_url的属性

url

Name 类型 Description Default
url 字符串 图像的 URL 或 base64 编码的图像数据。

detail

Name 类型 Description Default
detail 字符串 指定图像的详细信息级别。 在 视觉指南中了解详细信息。 auto

chatCompletionRequestMessageContentPartRefusal

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

azureChatExtensionConfiguration

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

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

azureChatExtensionType

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

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

Type: string

Default:

枚举名称：AzureChatExtensionType

Enum Values:

Value Description
azure_search 表示将Azure搜索用作 openAI 聊天扩展Azure。
azure_cosmos_db 表示将 Azure Cosmos DB 用作 openAI 聊天扩展Azure。

azureSearchChatExtensionConfiguration

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

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

azureSearchChatExtensionParameters

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

Name 类型 Description Required Default
身份验证 onYourDataApiKeyAuthenticationOptions 或 onYourDataSystemAssignedManagedIdentityAuthenticationOptions 或 onYourDataUserAssignedManagedIdentityAuthenticationOptions Yes
top_n_documents 整数 配置为用于配置查询的最多文档数。 No
in_scope boolean 是否应将查询限制为使用索引数据。 No
strictness 整数 搜索相关性筛选的配置严格性。 严格程度越高，精度越高，但对答案的召回率较低。 No
role_information 字符串 提供有关其行为方式以及生成响应时应引用的任何上下文的模型说明。 可以描述助手的个性，并告知其如何设置响应的格式。 有 100 个令牌限制，它计入总体令牌限制。 No
终结点 字符串 要使用的Azure搜索资源的绝对终结点路径。 Yes
index_name 字符串 要用作引用Azure搜索资源中可用索引的名称。 Yes
fields_mapping azureSearchIndexFieldMappingOptions 用于控制使用配置的Azure搜索资源时如何处理字段的可选设置。 No
query_type azureSearchQueryType Azure搜索检索查询的类型，应在将其用作 openAI 聊天扩展Azure时执行。 No
semantic_configuration 字符串 查询的其他语义配置。 No
筛选器 字符串 Search filter. No
embedding_dependency onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource No

azureSearchIndexFieldMappingOptions

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

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

azureSearchQueryType

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

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

Type: string

Default:

枚举名称：AzureSearchQueryType

Enum Values:

Value Description
simple 表示默认的简单查询分析器。
semantic 表示用于高级语义建模的语义查询分析器。
向量 表示对计算数据的矢量搜索。
vector_simple_hybrid 表示简单查询策略与矢量数据的组合。
vector_semantic_hybrid 表示语义搜索和矢量数据查询的组合。

azureCosmosDBChatExtensionConfiguration

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

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

azureCosmosDBChatExtensionParameters

在为 MongoDB vCore 使用 Azure Azure Cosmos DB 时配置 openAI On Your Data 聊天扩展时要使用的参数。

Name 类型 Description Required Default
身份验证 onYourDataConnectionStringAuthenticationOptions 使用连接字符串时Azure OpenAI On Your Data 的身份验证选项。 Yes
top_n_documents 整数 配置为用于配置查询的最多文档数。 No
in_scope boolean 是否应将查询限制为使用索引数据。 No
strictness 整数 搜索相关性筛选的配置严格性。 严格程度越高，精度越高，但对答案的召回率较低。 No
role_information 字符串 提供有关其行为方式以及生成响应时应引用的任何上下文的模型说明。 可以描述助手的个性，并告知其如何设置响应的格式。 有 100 个令牌限制，它计入总体令牌限制。 No
database_name 字符串 要用于Azure Cosmos DB的 MongoDB vCore 数据库名称。 Yes
container_name 字符串 Azure Cosmos DB资源容器的名称。 Yes
index_name 字符串 要用于Azure Cosmos DB的 MongoDB vCore 索引名称。 Yes
fields_mapping azureCosmosDBFieldMappingOptions 用于控制使用配置Azure Cosmos DB资源时如何处理字段的可选设置。 Yes
embedding_dependency onYourDataEndpointVectorizationSource 或 onYourDataDeploymentNameVectorizationSource Yes

azureCosmosDBFieldMappingOptions

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

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

onYourDataAuthenticationOptions

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

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

onYourDataAuthenticationType

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

Description：数据上的 Azure OpenAI 支持的身份验证类型。

Type: string

Default:

枚举名称：OnYourDataAuthenticationType

Enum Values:

Value Description
api_key 通过 API 密钥进行身份验证。
connection_string 通过连接字符串进行身份验证。
system_assigned_managed_identity 通过系统分配的托管标识进行身份验证。
user_assigned_managed_identity 通过用户分配的托管标识进行身份验证。

onYourDataApiKeyAuthenticationOptions

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

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

onYourDataConnectionStringAuthenticationOptions

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

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataUserAssignedManagedIdentityAuthenticationOptions

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

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

onYourDataVectorizationSource

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

Name 类型 Description Required Default
类型 onYourDataVectorizationSourceType 表示 OpenAI On Your Data 可用于配置要用于数据的向量化Azure的可用源
vector search.		 Yes

onYourDataVectorizationSourceType

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

Description：表示 OpenAI On Your Data 可以使用的可用 Azure源来配置要用于数据的向量化
vector search.

Type: string

Default:

枚举名称：OnYourDataVectorizationSourceType

Enum Values:

Value Description
终结点 表示由公共服务对 openAI 嵌入模型Azure执行的矢量化。
deployment_name 表示要使用的 Ada 模型部署名称。 此模型部署必须位于同一Azure OpenAI 资源中，但
在数据上，将通过内部调用而不是公共调用使用此模型部署，从而启用向量
即使在专用网络中搜索也是如此。

onYourDataDeploymentNameVectorizationSource

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

Name 类型 Description Required Default
类型 onYourDataVectorizationSourceType 表示 OpenAI On Your Data 可用于配置要用于数据的向量化Azure的可用源
vector search.		 Yes
deployment_name 字符串 指定要用于矢量化的模型部署的名称。 此模型部署必须位于同一Azure OpenAI 资源中，但 On Your Data 将通过内部调用而不是公共调用使用此模型部署，从而即使在专用网络中也能实现矢量搜索。 No

onYourDataEndpointVectorizationSource

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

Name 类型 Description Required Default
类型 onYourDataVectorizationSourceType 表示 OpenAI On Your Data 可用于配置要用于数据的向量化Azure的可用源
vector search.		 Yes
身份验证 onYourDataApiKeyAuthenticationOptions 使用 API 密钥时，Azure OpenAI On Your Data 的身份验证选项。 No
终结点 字符串 指定要用于矢量化的终结点。 此终结点必须位于同一Azure OpenAI 资源中，但 On Your Data 将通过内部调用而不是公共调用使用此终结点，从而即使在专用网络中也启用矢量搜索。 No

azureChatExtensionsMessageContext

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

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

citation

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

Name 类型 Description Required Default
内容 字符串 引文的内容。 Yes
title 字符串 引文的标题。 No
url 字符串 引文的 URL。 No
filepath 字符串 引文的文件路径。 No
chunk_id 字符串 引文的区块 ID。 No

chatCompletionMessageToolCall

Name 类型 Description Required Default
id 字符串 工具调用的 ID。 Yes
类型 toolCallType 工具调用的类型，在本例 function中。 Yes
函数 对象 模型调用的函数。 Yes

函数的属性

name

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

arguments

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

toolCallType

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

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

Type: string

Default:

枚举名称：ToolCallType

Enum Values:

Value Description
函数 工具调用类型为函数。

chatCompletionRequestMessageTool

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

chatCompletionRequestMessageFunction

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

createChatCompletionResponse

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

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

可以与请求参数结合使用 seed ，以了解后端更改何时发生可能影响确定性。
 No
对象 枚举 对象类型，始终 chat.completion为 .
可能的值：chat.completion		 Yes
使用情况 completionUsage 完成请求的使用情况统计信息。 No

createChatCompletionStreamResponse

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

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

chatCompletionStreamResponseDelta

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

Name 类型 Description Required Default
内容 字符串 区块消息的内容。 No
function_call 对象 已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。 No
tool_calls 数组 No
角色 枚举 此消息的作者的角色。
可能的值：系统、用户、助理、工具		 No
refusal 字符串 模型生成的拒绝消息。 No

function_call的属性

arguments

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

name

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

chatCompletionMessageToolCallChunk

Name 类型 Description Required Default
索引 整数 Yes
id 字符串 工具调用的 ID。 No
类型 枚举 工具的类型。 目前仅 function 支持。
可能的值：函数		 No
函数 对象 No

函数的属性

name

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

arguments

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

chatCompletionStreamOptions

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

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

chatCompletionChoiceLogProbs

记录所选的概率信息。

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

chatCompletionTokenLogprob

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

chatCompletionResponseMessage

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

Name 类型 Description Required Default
角色 chatCompletionResponseMessageRole 响应消息的作者的角色。 Yes
refusal 字符串 模型生成的拒绝消息。 Yes
内容 字符串 消息的内容。 Yes
tool_calls 数组 模型生成的工具调用，例如函数调用。 No
function_call chatCompletionFunctionCall 已弃用并替换为 tool_calls。 应调用的函数的名称和参数，由模型生成。 No
上下文 azureChatExtensionsMessageContext 涉及 openAI 聊天扩展Azure时可用的其他上下文信息的表示形式
在生成相应的聊天完成响应中。 此上下文信息仅在
使用配置为使用匹配扩展的 Azure OpenAI 请求。		 No

chatCompletionResponseMessageRole

响应消息的作者的角色。

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

Type: string

Default:

Enum Values:

  • 助手

chatCompletionToolChoiceOption

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

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

chatCompletionNamedToolChoice

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

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

函数的属性

name

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

ParallelToolCalls

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

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

chatCompletionMessageToolCalls

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

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

chatCompletionFunctionCall

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

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

completionUsage

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

Name 类型 Description Required Default
prompt_tokens 整数 提示符中的令牌数。 Yes
completion_tokens 整数 生成的完成中的令牌数。 Yes
total_tokens 整数 请求中使用的令牌总数（提示 + 完成）。 Yes
completion_tokens_details 对象 完成时使用的令牌明细。 No

completion_tokens_details的属性

reasoning_tokens

Name 类型 Description Default
reasoning_tokens 整数 由模型生成的令牌进行推理。

chatCompletionTool

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

FunctionParameters

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

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

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

FunctionObject

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

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

ResponseFormatText

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

ResponseFormatJsonObject

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

ResponseFormatJsonSchemaSchema

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

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

ResponseFormatJsonSchema

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

json_schema的属性

description

Name 类型 Description Default
description 字符串 模型使用响应格式的说明来确定如何以格式进行响应。

name

Name 类型 Description Default
name 字符串 响应格式的名称。 必须是 a-z、A-Z、0-9 或包含下划线和短划线，最大长度为 64。

架构

Name 类型 Description Default
架构 ResponseFormatJsonSchemaSchema 响应格式的架构，描述为 JSON 架构对象。

strict

Name 类型 Description Default
strict boolean 是否在生成输出时启用严格的架构遵循。 如果设置为 true，则模型将始终遵循字段中定义的 schema 确切架构。 仅当为 时stricttrue仅支持 JSON 架构的子集。 False

chatCompletionChoiceCommon

Name 类型 Description Required Default
索引 整数 No
finish_reason 字符串 No

createTranslationRequest

Translation request.

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

audioResponse

json response_format时的翻译或听录响应

Name 类型 Description Required Default
文本消息 字符串 已翻译或转录的文本。 Yes

audioVerboseResponse

response_format verbose_json时翻译或听录响应

Name 类型 Description Required Default
文本消息 字符串 已翻译或转录的文本。 Yes
任务 字符串 音频任务的类型。 No
语言 字符串 Language. No
duration number Duration. No
segments 数组 No

audioResponseFormat

定义输出的格式。

说明：定义输出的格式。

Type: string

Default:

Enum Values:

  • json
  • 文本消息
  • srt
  • verbose_json
  • vtt

createTranscriptionRequest

Transcription request.

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

audioSegment

听录或翻译段。

Name 类型 Description Required Default
id 整数 Segment identifier. No
seek number 段的偏移量。 No
start number 段开始偏移量。 No
end number 段结束偏移量。 No
文本消息 字符串 Segment text. No
tokens 数组 文本的标记。 No
temperature number Temperature. No
avg_logprob number 平均对数概率。 No
compression_ratio number Compression ratio. No
no_speech_prob number 的概率 。no speech No

imageQuality

将生成的图像的质量。

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

Type: string

Default: standard

枚举名称：质量

Enum Values:

Value Description
标准 标准质量创建具有标准质量的图像。
hd HD 质量可创建具有更精细的详细信息的图像，并在整个映像中保持更一致性。

imagesResponseFormat

返回生成的图像的格式。

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

Type: string

Default: url

枚举名称：ImagesResponseFormat

Enum Values:

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

imageSize

生成的图像的大小。

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

Type: string

Default: 1024x1024

枚举名称：大小

Enum Values:

Value Description
1792x1024 生成的图像的所需大小为 1792x1024 像素。
1024x1792 生成的图像的所需大小为 1024x1792 像素。
1024x1024 生成的图像的所需大小为 1024x1024 像素。

imageStyle

生成的图像的样式。

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

Type: string

Default: vivid

枚举名称：样式

Enum Values:

Value Description
vivid 生动地创造了超现实和戏剧性的图像。
natural 自然会创建更自然、更不现实的图像。

imageGenerationsRequest

Name 类型 Description Required Default
提示 字符串 所需图像的文本说明。 最大长度为 4,000 个字符。 Yes
n 整数 要生成的图像数。 No 1
size imageSize 生成的图像的大小。 No 1024x1024
response_format imagesResponseFormat 返回生成的图像的格式。 No url
用户 字符串 表示最终用户的唯一标识符，可帮助监视和检测滥用行为。 No
quality imageQuality 将生成的图像的质量。 No 标准
样式 imageStyle 生成的图像的样式。 No vivid

generateImagesResponse

Name 类型 Description Required Default
created 整数 创建操作时的 unix 时间戳。 Yes
数据 数组 操作的结果数据（如果成功） Yes

imageResult

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

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

Completions extensions

完成扩展不属于最新版本的 Azure OpenAI 数据平面推理规格。

Chatmessage

聊天消息对象不属于最新版本的 Azure OpenAI 数据平面推理规范。

文本转语音（预览版）

当前不属于最新 Azure OpenAI GA 版本的 Azure OpenAI 数据平面推理规格。请参阅此功能的最新 preview 版本。

Next steps

了解 模型，并使用 REST API 进行微调。 详细了解支持 OpenAI 的Azure模型。

  • Last updated on