Azure OpenAI in Microsoft Foundry Models REST API 参考

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

API specs

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

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

每个API表面/规范都封装了一套不同的Azure OpenAI能力。 每个 API 都有其独特的预览版和稳定/普遍可用（GA）API 版本。 预览版目前通常按月发布。

Authentication

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 日期结构。 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 的 GA 版本。

如果你想查找最新预览API版本的文档，请参考 最新的预览数据平面推理API

Completions

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

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

URI Parameters

Request Header

Request Body

Content-Type: application/json

Responses

状态代码： 200

Description: OK

状态代码： 默认

描述：服务不可用

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

Request Header

Request Body

Content-Type: application/json

Responses

用途性质

prompt_tokens

total_tokens

状态代码： 200

Description: OK

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

Request Header

Request Body

Content-Type: application/json

Responses

状态代码： 200

Description: OK

状态代码： 默认

描述：服务不可用

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

Request Header

Request Body

Content-Type: multipart/form-data

Responses

状态代码： 200

Description: OK

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

Request Header

Request Body

Content-Type: multipart/form-data

Responses

状态代码： 200

Description: OK

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

Request Header

Request Body

Content-Type: application/json

Responses

状态代码： 200

Description: Ok

状态代码： 默认

描述：发生了错误。

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

errorBase

错误

innerError

内部错误，附加细节。

innerErrorCode

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

描述：内部错误对象的错误代码。

Type: string

Default:

枚举名称：InnerErrorCode

Enum Values:

dalleErrorResponse

dalleError

dalleInnerError

内部错误，附加细节。

contentFilterResultBase

contentFilterSeverityResult

contentFilterDetectedResult

contentFilterDetectedWithCitationResult

引用性质

URL

许可

contentFilterResultsBase

关于内容过滤结果的信息。

contentFilterPromptResults

关于内容过滤类别（仇恨、性、暴力、self_harm）、是否检测到，以及严重程度（very_low、低、中、高，决定有害内容的强度和风险等级），以及是否被过滤。 关于越狱内容和脏话的信息，是否被检测到，以及是否经过过滤。 还有客户黑名单的信息（如果被过滤过的话）和它的ID。

contentFilterChoiceResults

关于内容过滤类别（仇恨、性、暴力、self_harm）、是否检测到，以及严重程度（very_low、低、中、高，决定有害内容的强度和风险等级），以及是否被过滤。 关于第三方文本和脏话的信息，是否检测到，以及是否被过滤。 还有客户黑名单的信息（如果被过滤过的话）和它的ID。

promptFilterResult

请求中单个提示的内容过滤结果。

promptFilterResults

请求中零个或多个提示的内容过滤结果。 在流媒体请求中，不同提示的结果可能在不同时间或顺序出现。

该组件没有定义属性。

dalleContentFilterResults

关于内容过滤结果的信息。

dalleFilterResults

关于内容过滤类别（仇恨、性、暴力、self_harm）、是否检测到，以及严重程度（very_low、低、中、高，决定有害内容的强度和风险等级），以及是否被过滤。 关于越狱内容和脏话的信息，是否被检测到，以及是否经过过滤。 还有客户黑名单的信息（如果被过滤过的话）和它的ID。

chatCompletionsRequestCommon

createCompletionRequest

createCompletionResponse

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

createChatCompletionRequest

chatCompletionFunctions

chatCompletionFunctionCallOption

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

chatCompletionRequestMessage

该组成部分可以是以下之一：

chatCompletionRequestSystemMessage

chatCompletionRequestUserMessage

chatCompletionRequestAssistantMessage

function_call的性质

arguments

name

chatCompletionRequestToolMessage

chatCompletionRequestFunctionMessage

chatCompletionRequestSystemMessageContentPart

该组成部分可以是以下之一：

chatCompletionRequestUserMessageContentPart

该组成部分可以是以下之一：

chatCompletionRequestAssistantMessageContentPart

该组成部分可以是以下之一：

chatCompletionRequestToolMessageContentPart

该组成部分可以是以下之一：

chatCompletionRequestMessageContentPartText

chatCompletionRequestMessageContentPartImage

image_url性质

url

detail

chatCompletionRequestMessageContentPartRefusal

azureChatExtensionConfiguration

一个针对单个 Azure OpenAI 聊天扩展的配置数据表示。 这将被聊天完成请求使用，该请求应通过 Azure OpenAI 聊天扩展来增强响应行为。 该配置仅兼容 Azure OpenAI。

azureChatExtensionType

一个针对单个 Azure OpenAI 聊天扩展的配置数据表示。 这将被聊天完成请求使用，该请求应通过 Azure OpenAI 聊天扩展来增强响应行为。 该配置仅兼容 Azure OpenAI。

Description：单Azure OpenAI聊天扩展的配置数据表示。 这将被聊天完成请求使用，该请求应通过 Azure OpenAI 聊天扩展来增强响应行为。 该配置仅兼容 Azure OpenAI。

Type: string

Default:

Enum name： AzureChatExtensionType

Enum Values:

azureSearchChatExtensionConfiguration

这是使用 Azure 搜索作为 Azure OpenAI 聊天扩展时可配置选项的具体表示。

azureSearchChatExtensionParameters

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

azureSearchIndexFieldMappingOptions

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

azureSearchQueryType

当它作为 Azure OpenAI 聊天扩展使用时，应该执行的 Azure 搜索检索查询类型。

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

Type: string

Default:

Enum name： AzureSearchQueryType

Enum Values:

azureCosmosDBChatExtensionConfiguration

这是使用 Azure Cosmos DB 作为 Azure OpenAI 聊天扩展时可配置选项的具体表示。

azureCosmosDBChatExtensionParameters

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

azureCosmosDBFieldMappingOptions

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

onYourDataAuthenticationOptions

关于Azure OpenAI在你数据上的认证选项。

onYourDataAuthenticationType

Azure OpenAI 在你的数据上支持的认证类型。

Description：OpenAI 对您的数据支持Azure认证类型。

Type: string

Default:

枚举名称：OnYourDataAuthenticationType

Enum Values:

onYourDataApiKeyAuthenticationOptions

使用 API 密钥时，Azure OpenAI 在你的数据上的认证选项。

onYourDataConnectionStringAuthenticationOptions

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

onYourDataSystemAssignedManagedIdentityAuthenticationOptions

使用系统分配的管理身份时，针对 Azure OpenAI On Your Data 的认证选项。

onYourDataUserAssignedManagedIdentityAuthenticationOptions

使用用户分配的管理身份时，Azure OpenAI 对你的数据的认证选项。

onYourDataVectorizationSource

Azure OpenAI 在你的数据上提供向量搜索的向量化源的抽象表示。

onYourDataVectorizationSourceType

代表 Azure OpenAI On Your Data 可用来配置数据矢量化以配合矢量搜索的来源。

Description：表示 OpenAI 在你的数据上可用Azure配置数据矢量化以用于
vector search.

Type: string

Default:

枚举名：OnYourDataVectorizationSourceType

Enum Values:

onYourDataDeploymentNameVectorizationSource

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

onYourDataEndpointVectorizationSource

Azure OpenAI 在应用向量搜索时使用的矢量化源的详细信息，基于公开的 Azure OpenAI 端点嵌入调用。

azureChatExtensionsMessageContext

这是当Azure OpenAI聊天扩展参与生成对应聊天完成响应时，可用额外上下文信息的表示。 这些上下文信息只有在使用 Azure OpenAI 请求并配置为匹配扩展时才会被填充。

citation

聊天完成回复消息的引用信息。

chatCompletionMessageToolCall

函数性质

name

arguments

toolCallType

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

描述：工具调用的类型，在此例 function中为 。

Type: string

Default:

枚举名称：ToolCallType

Enum Values:

chatCompletionRequestMessageTool

chatCompletionRequestMessageFunction

createChatCompletionResponse

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

createChatCompletionStreamResponse

表示模型根据提供的输入返回的聊天完成响应的流式片段。

chatCompletionStreamResponseDelta

由流式模型响应生成的聊天完成差异。

function_call的性质

arguments

name

chatCompletionMessageToolCallChunk

函数性质

name

arguments

chatCompletionStreamOptions

流式响应选项。 只有在你设置 stream: true时才会设置这个。

chatCompletionChoiceLogProbs

记录选择的概率信息。

chatCompletionTokenLogprob

chatCompletionResponseMessage

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

chatCompletionResponseMessageRole

回复信息作者的角色。

描述：回复消息作者的角色。

Type: string

Default:

Enum Values:

• 助手

chatCompletionToolChoiceOption

控制模型调用的（如果有）工具。 none 意味着模型不会调用任何工具，而是生成一条消息。 auto 这意味着模型可以选择生成消息或调用一个或多个工具。 required 意味着模型必须调用一个或多个工具。 通过指定特定工具 {"type": "function", "function": {"name": "my_function"}} 会强制模型调用该工具。 none 当没有工具时，是默认的。 auto 如果有工具，则是默认设置。

该组成部分可以是以下之一：

chatCompletionNamedToolChoice

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

函数性质

name

ParallelToolCalls

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

该组件没有定义属性。

chatCompletionMessageToolCalls

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

该组件没有定义属性。

chatCompletionFunctionCall

已被弃用并被 tool_calls取代。 应调用的函数名称和参数，由模型生成。

completionUsage

完成请求的使用统计数据。

completion_tokens_details的性质

reasoning_tokens

chatCompletionTool

FunctionParameters

函数接受的参数，描述为 JSON Schema 对象。 示例请参见指南 ，以及关于格式的文档参考 JSON Schema 。

省略 parameters 定义了一个参数列表为空的函数。

该组件没有定义属性。

FunctionObject

ResponseFormatText

ResponseFormatJsonObject

ResponseFormatJsonSchemaSchema

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

该组件没有定义属性。

ResponseFormatJsonSchema

json_schema的性质

description

name

架构

strict

chatCompletionChoiceCommon

createTranslationRequest

Translation request.

audioResponse

当response_format为json时，翻译或转录响应

audioVerboseResponse

response_format verbose_json翻译或转录反应

audioResponseFormat

定义输出格式。

描述：定义输出格式。

Type: string

Default:

Enum Values:

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

createTranscriptionRequest

Transcription request.

audioSegment

转录或翻译片段。

imageQuality

生成图像的质量。

描述：将生成的图像质量。

Type: string

Default: standard

枚举名称：质量

Enum Values:

imagesResponseFormat

生成图像返回的格式。

描述：生成图像返回的格式。

Type: string

Default: url

枚举名称：ImagesResponseFormat

Enum Values:

imageSize

生成图像的大小。

描述：生成图像的大小。

Type: string

Default: 1024x1024

枚库名称：大小

Enum Values:

imageStyle

生成图像的风格。

描述：生成图像的风格。

Type: string

Default: vivid

枚举名称：样式

Enum Values:

imageGenerationsRequest

generateImagesResponse

imageResult

如果成功，则显示图片网址或编码图像，否则为错误。

Completions extensions

完成扩展不包含在最新GA版本的Azure OpenAI数据平面推理规范中。

Chatmessage

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

文本转语音（预览）

目前不包含在最新的Azure OpenAI GA版本Azure OpenAI数据平面推断规范中。请参阅最新的preview版本以了解此功能。

Next steps

学习模型 知识，以及用REST API进行微调。 详细了解支持 OpenAI 的Azure模型。