Azure OpenAI 服务 REST API 参考

您所在的位置：网站首页 › azure怎么看余额 › Azure OpenAI 服务 REST API 参考

Azure OpenAI 服务 REST API 参考

2023-09-09 22:03| 来源: 网络整理| 查看: 265

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

Azure OpenAI 服务 REST API 参考项目 09/04/2023

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

身份验证

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

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

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

REST API 版本控制

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

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2023-05-15 完成

通过完成操作，模型将根据提供的提示生成一个或多个预测完成。该服务还可以返回每个位置的替代令牌的概率。

创建完成

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/completions?api-version={api-version}

路径参数

参数类型必需？说明 your-resource-name 字符串必须 Azure OpenAI 资源的名称。 deployment-id 字符串必须部署模型时选择的部署名称。 api-version 字符串必须要用于此操作的 API 版本。它遵循 YYYY-MM-DD 格式。

支持的版本

2022-12-01Swagger spec 2023-03-15-previewSwagger spec 2023-05-15Swagger spec 2023-06-01-previewSwagger spec 2023-07-01-previewSwagger spec 2023-08-01-previewSwagger spec

请求正文

参数类型必需？默认说明 prompt 字符串或数组可选生成完成的提示，其编码为字符串或字符串数组。请注意，是模型在训练期间看到的文档分隔符，因此如果未指定提示，则模型将像从新文档的开头一样生成。 max_tokens integer 可选 16 在完成中生成的最大令牌数。提示加上 max_tokens 的令牌计数不能超过模型的上下文长度。除最新模型（它支持 4096 个令牌）外，大多数模型的上下文长度为 2048 个令牌。 temperature 数字可选 1 要使用的采样温度，介于 0 和 2 之间。较高的值意味着模型将承担更多风险。对于更具创意的应用程序，请尝试将值设为 0.9，对于具有明确定义答案的应用程序，将值设为 0 (argmax sampling) 。我们通常建议更改此设置或 top_p，但不要同时更改这两者。 top_p 数字可选 1 温度采样的替代方法，称为核采样，其中模型考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或温度，但不要同时更改这两者。 logit_bias map 可选 Null 修改指定令牌在完成中出现的可能性。接受 json 对象，该对象将令牌（由其在 GPT tokenizer 中的令牌 ID 指定）映射到从 -100 到 100 的关联偏差。可以使用此 tokenizer 工具（适用于 GPT-2 和 GPT-3）将文本转换为令牌 ID。在数学上，采样之前会将偏差添加到由模型生成的 logit 中。具体效果因模型而异，但 -1 和 1 之间的值会减少或增加选择的可能性；-100 或 100 等值会导致相关令牌的禁止或独占选择。例如，可以传递 {"50256": -100} 以防止生成令牌。 user 字符串可选表示最终用户的唯一标识符，可帮助监视和检测滥用行为 n integer 可选 1 要为每个提示生成的完成数。注意：由于此参数会生成许多完成，因此可能会快速消耗你的令牌配额。谨慎使用并确保对 max_tokens 和 stop 进行了合理的设置。 stream boolean 可选 False 是否流式传输回部分进度。如果设置，令牌将在可用时作为仅数据服务器发送的事件发送，流由数据终止：[DONE] 消息。 logprobs integer 可选 Null 包含有关 logprobs 最有可能的令牌和已选择的令牌的日志概率。例如，如果 logprobs 为 10，则 API 将返回包含 10 个最有可能的令牌的列表。 API 将始终返回采样令牌的 logprob，因此响应中可能最多有 logprobs+1 个元素。此参数不能与 gpt-35-turbo 一起使用。 suffix 字符串可选 Null 插入的文本完成后的后缀。 echo boolean 可选 False 除了完成之外，还要回显提示。此参数不能与 gpt-35-turbo 一起使用。 stop 字符串或数组可选 Null 最多四个序列，其中 API 将停止生成进一步的令牌。返回的文本不包含停止序列。 presence_penalty 数字可选 0 介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。 frequency_penalty 数字可选 0 介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。 best_of integer 可选 1 在服务器端生成 best_of 完成并返回“最佳”（每个令牌的日志概率最低的参数）。无法流式传输结果。与 n 一起使用时，best_of 控制候选完成数，n 指定返回的完成数，best_of 的值必须大于 n 的值。注意：由于此参数会生成许多完成，因此可能会快速消耗你的令牌配额。谨慎使用并确保对 max_tokens 和 stop 进行了合理的设置。此参数不能与 gpt-35-turbo 一起使用。示例请求 curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2023-05-15\ -H "Content-Type: application/json" \ -H "api-key: YOUR_API_KEY" \ -d "{ \"prompt\": \"Once upon a time\", \"max_tokens\": 5 }" 示例响应 { "id": "cmpl-4kGh7iXtjW4lc9eGhff6Hp8C7btdQ", "object": "text_completion", "created": 1646932609, "model": "ada", "choices": [ { "text": ", a dark line crossed", "index": 0, "logprobs": null, "finish_reason": "length" } ] }

在示例响应中，finish_reason 等于 stop。如果 finish_reason 等于 content_filter，请参阅我们的内容筛选指南，了解发生此情况的原因。

嵌入

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

注意

OpenAI 目前允许使用 text-embedding-ada-002 输入更多的数组。对于 text-embedding-ada-002 (Version 2)，Azure OpenAI 目前支持最多 16 个输入数组。两者都要求此模型的每个 API 请求的最大输入令牌限制保持在 8191 之下。

创建嵌入

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/embeddings?api-version={api-version}

路径参数

参数类型必需？说明 your-resource-name 字符串必须 Azure OpenAI 资源的名称。 deployment-id 字符串必须模型部署的名称。必须先部署模型，然后才能进行调用 api-version 字符串必须要用于此操作的 API 版本。它遵循 YYYY-MM-DD 格式。

支持的版本

2022-12-01Swagger spec 2023-03-15-previewSwagger spec 2023-05-15Swagger spec 2023-06-01-previewSwagger spec 2023-07-01-previewSwagger spec 2023-08-01-previewSwagger spec

请求正文

参数类型必需？默认说明 input 字符串或数组是空值获取嵌入的输入文本，编码为数组或字符串。输入令牌的数量因所使用的模型而异。仅 text-embedding-ada-002 (Version 2) 支持数组输入。 user 字符串否 Null 表示最终用户的唯一标识符。这将帮助 Azure OpenAI 监视和检测滥用行为。不要传递 PII 标识符，而是使用伪名化值，例如 GUID 示例请求 curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/embeddings?api-version=2023-05-15 \ -H "Content-Type: application/json" \ -H "api-key: YOUR_API_KEY" \ -d "{\"input\": \"The food was delicious and the waiter...\"}" 示例响应 { "object": "list", "data": [ { "object": "embedding", "embedding": [ 0.018990106880664825, -0.0073809814639389515, .... (1024 floats total for ada) 0.021276434883475304, ], "index": 0 } ], "model": "text-similarity-babbage:001" } 聊天完成

使用 GPT-35-Turbo 和 GPT-4 模型创建聊天消息补全内容。

创建聊天完成

POST https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}

路径参数

支持的版本

2023-03-15-previewSwagger spec 2023-05-15Swagger spec 2023-06-01-previewSwagger spec 2023-07-01-previewSwagger spec 2023-08-01-previewSwagger spec 示例请求 curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2023-05-15 \ -H "Content-Type: application/json" \ -H "api-key: YOUR_API_KEY" \ -d '{"messages":[{"role": "system", "content": "You are a helpful assistant."},{"role": "user", "content": "Does Azure OpenAI support customer managed keys?"},{"role": "assistant", "content": "Yes, customer managed keys are supported by Azure OpenAI."},{"role": "user", "content": "Do other Azure AI services support this too?"}]}' 示例响应 {"id":"chatcmpl-6v7mkQj980V1yBec6ETrKPRqFjNw9", "object":"chat.completion","created":1679072642, "model":"gpt-35-turbo", "usage":{"prompt_tokens":58, "completion_tokens":68, "total_tokens":126}, "choices":[{"message":{"role":"assistant", "content":"Yes, other Azure AI services also support customer managed keys. Azure AI services offer multiple options for customers to manage keys, such as using Azure Key Vault, customer-managed keys in Azure Key Vault or customer-managed keys through Azure Storage service. This helps customers ensure that their data is secure and access to their services is controlled."},"finish_reason":"stop","index":0}]}

在示例响应中，finish_reason 等于 stop。如果 finish_reason 等于 content_filter，请参阅我们的内容筛选指南，了解发生此情况的原因。

已为易读性调整输出格式，实际输出是一个没有换行符的单个文本块。

参数类型必需？默认说明 messages array 必需与此聊天补全请求关联的上下文消息的集合。典型的用法从系统角色的聊天消息开始，该消息提供有关助手行为的说明，然后是“用户”和“助手”角色之间的交替消息。 temperature 数字可选 1 要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中，更具确定性。我们通常建议更改此设置或 top_p，但不能同时更改两者。 n integer 可选 1 要为每个输入消息生成的聊天完成选项数。 stream boolean 可选 false 如果设置此选项，将发送部分消息增量，如在 ChatGPT 中一样。令牌将在可用时作为仅数据服务器发送的事件发送，流由 data: [DONE] 消息终止。 stop 字符串或数组可选 Null 最多四个序列，其中 API 将停止生成更多令牌。 max_tokens integer 可选 inf 生成的答案允许的最大令牌数。默认情况下，模型可返回的标记数将为（4096 - 提示标记）。 presence_penalty 数字可选 0 介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。 frequency_penalty 数字可选 0 介于 -2.0 和 2.0 之间的数字。正值会根据它们到目前为止在文本中的现有频率来惩罚新令牌，从而降低模型逐字重复同一行的可能性。 logit_bias 对象 (object) 可选 Null 修改指定令牌在完成中出现的可能性。接受 json 对象，该对象将标记（由 tokenizer 中的标记 ID 指定）映射到从 -100 到 100 的相关偏差值。在数学上，采样之前会将偏差添加到由模型生成的 logit 中。具体效果因模型而异，但 -1 和 1 之间的值会减少或增加选择的可能性；-100 或 100 等值会导致相关令牌的禁止或独占选择。 user 字符串可选表示最终用户的唯一标识符，可帮助 Azure OpenAI 监视和检测滥用行为。 function_call 可选控制模型如何响应函数调用。 “none”表示模型不调用函数，并对最终用户做出响应。 “auto”表示模型可以在最终用户或调用函数之间进行选择。通过 {"name": "my_function"} 指定特定函数会强制模型调用该函数。当不存在任何函数时，“none”是默认值。如果存在函数，则“auto”是默认值。此参数需要 API 版本 2023-07-01-preview functions FunctionDefinition[] 可选模型可能为其生成 JSON 输入的函数的列表。此参数需要 API 版本 2023-07-01-preview ChatMessage

聊天补全交互中的单个角色属性化消息。

名称类型描述内容字符串与此消息有效负载关联的文本。 function_call FunctionCall 应调用的函数的名称和参数，由模型生成。 name 字符串此消息的作者的 name。如果角色为 function，则 name 为必填项，并且它应该是其响应在 content 中的函数的名称。可能包含 a-z、A-Z、0-9 和下划线，最大长度为 64 个字符。 role ChatRole 与此消息有效负载关联的角色 ChatRole

聊天补全交互中消息的预期用途的说明。

名称类型说明 assistant 字符串对系统指示的用户提示输入做出响应的角色。 function string 为聊天补全提供函数结果的角色。 system 字符串指示或设置助手行为的角色。 user 字符串为聊天补全提供输入的角色。 FunctionCall

应调用的函数的名称和参数，由模型生成。这需要 API 版本 2023-07-01-preview

名称类型说明参数 string 用于调用函数的参数，由模型以 JSON 格式生成。请注意，该模型并非始终生成有效的 JSON，并且可能会构造函数架构未定义的参数。在调用函数之前验证代码中的参数。 name 字符串要调用的函数名称。 FunctionDefinition

调用方指定的函数的定义，聊天补全可能会调用该函数以响应匹配的用户输入。这需要 API 版本 2023-07-01-preview

名称类型说明 description 字符串函数操作的说明。当选择函数并解释其参数时，模型将使用此说明。 name 字符串要调用的函数的名称。 parameters 函数接受的参数，被描述为 JSON 架构对象。完成扩展

聊天完成的扩展，例如数据上的 Azure OpenAI。

使用聊天完成扩展

POST {your-resource-name}/openai/deployments/{deployment-id}/extensions/chat/completions?api-version={api-version}

路径参数

支持的版本

2023-06-01-previewSwagger spec 2023-07-01-previewSwagger spec 2023-08-01-previewSwagger spec 示例请求 curl -i -X POST YOUR_RESOURCE_NAME/openai/deployments/YOUR_DEPLOYMENT_NAME/extensions/chat/completions?api-version=2023-06-01-preview \ -H "Content-Type: application/json" \ -H "api-key: YOUR_API_KEY" \ -d \ ' { "temperature": 0, "max_tokens": 1000, "top_p": 1.0, "dataSources": [ { "type": "AzureCognitiveSearch", "parameters": { "endpoint": "'YOUR_AZURE_COGNITIVE_SEARCH_ENDPOINT'", "key": "'YOUR_AZURE_COGNITIVE_SEARCH_KEY'", "indexName": "'YOUR_AZURE_COGNITIVE_SEARCH_INDEX_NAME'" } } ], "messages": [ { "role": "user", "content": "What are the differences between Azure Machine Learning and Azure AI services?" } ] } ' 示例响应 { "id": "12345678-1a2b-3c4e5f-a123-12345678abcd", "model": "", "created": 1684304924, "object": "chat.completion", "choices": [ { "index": 0, "messages": [ { "role": "tool", "content": "{\"citations\": [{\"content\": \"\\nAzure AI services are cloud-based artificial intelligence (AI) services...\", \"id\": null, \"title\": \"What is Azure AI services\", \"filepath\": null, \"url\": null, \"metadata\": {\"chunking\": \"orignal document size=250. Scores=0.4314117431640625 and 1.72564697265625.Org Highlight count=4.\"}, \"chunk_id\": \"0\"}], \"intent\": \"[\\\"Learn about Azure AI services.\\\"]\"}", "end_turn": false }, { "role": "assistant", "content": " \nAzure AI services are cloud-based artificial intelligence (AI) services that help developers build cognitive intelligence into applications without having direct AI or data science skills or knowledge. [doc1]. Azure Machine Learning is a cloud service for accelerating and managing the machine learning project lifecycle. [doc1].", "end_turn": true } ] } ] } 参数类型必需？默认说明 messages array 必须 Null 要以聊天格式为其生成聊天完成的消息。 dataSources array 必须要用于数据功能上 Azure OpenAI 的数据源。 temperature 数字可选 0 要使用的采样温度，介于 0 和 2 之间。较高的值（如 0.8）将使输出更随机，而较小的值（如 0.2）将使输出更集中且更具确定性我们通常建议更改此设置或 top_p，但不要同时更改两者。 top_p 数字可选 1 温度采样的替代方法，称为核心采样，其中模型将考虑具有 top_p 概率质量的令牌的结果。所以 0.1 意味着只考虑包含前 10% 概率质量的令牌。我们通常建议更改此设置或温度，但不要同时更改这两者。 stream boolean 可选 false 如果设置此选项，将发送部分消息增量，如在 ChatGPT 中一样。令牌将在可用时作为仅限数据的服务器发送的事件发送，并且流式传输由 "messages": [{"delta": {"content": "[DONE]"}, "index": 2, "end_turn": true}] 消息终止。 stop 字符串或数组可选 Null 最多 2 个序列，其中 API 将停止生成更多令牌。 max_tokens integer 可选 1000 生成的答案允许的最大令牌数。默认情况下，模型可返回的令牌数为 4096 - prompt_tokens。

以下参数可用于 dataSources 中的 parameters 字段内。

参数类型必需？默认说明 type 字符串必须 Null 要用于数据功能上 Azure OpenAI 的数据源。对于 Azure 认知搜索，该值为 AzureCognitiveSearch。 endpoint string 必须 Null 数据源终结点。 key 字符串必须 Null 适用于服务的 Azure 认知搜索管理密钥之一。 indexName 字符串必须 Null 要使用的搜索索引。 fieldsMapping dictionary 可选 Null 索引数据列映射。 inScope boolean 可选是如果设置此值，此值将限制特定于基础数据内容的响应。 topNDocuments 数字可选 5 需要为实现文档扩充而提取的文档数。 queryType string 可选简单指示将用于Azure 认知搜索的查询选项。 semanticConfiguration string 可选 Null 语义搜索配置。仅在 queryType 设置为 semantic 时可用。 roleInformation string 可选 Null 为模型提供有关它应该如何运行以及在生成响应时应引用的上下文的说明。对应于 Azure OpenAI Studio 中的“系统消息”。有关详细信息，请参阅使用你的数据。存在 100 个令牌的限制，并将计入整体令牌限制。 filter 字符串可选 Null 用于限制对敏感文档的访问的筛选器模式 embeddingEndpoint 字符串可选 Null Ada 嵌入模型部署的终结点 URL。用于矢量搜索。 embeddingKey 字符串可选 Null Ada 嵌入模型部署的 API 密钥。用于矢量搜索。图像生成请求生成的映像

从文本描述文字生成一批图像。

POST https://{your-resource-name}.openai.azure.com/openai/images/generations:submit?api-version={api-version}

路径参数

参数类型必需？说明 your-resource-name 字符串必须 Azure OpenAI 资源的名称。 api-version 字符串必须要用于此操作的 API 版本。它遵循 YYYY-MM-DD 格式。

支持的版本

2023-06-01-previewSwagger spec 2023-07-01-previewSwagger spec 2023-08-01-previewSwagger spec

请求正文

参数类型必需？默认说明 prompt 字符串必须所需图像的文本说明。最大长度为 1000 个字符。 n integer 可选 1 要生成的图像数。必须介于 1 和 5 之间。 size 字符串可选 1024x1024 生成的图像的大小。必须是 256x256、512x512 或 1024x1024。示例请求 curl -X POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/images/generations:submit?api-version=2023-06-01-preview \ -H "Content-Type: application/json" \ -H "api-key: YOUR_API_KEY" \ -d '{ "prompt": "An avocado chair", "size": "512x512", "n": 3 }' 示例响应

操作返回 202 状态代码和 GenerateImagesResponse JSON 对象，其中包含操作的 ID 和状态。

{ "id": "f508bcf2-e651-4b4b-85a7-58ad77981ffa", "status": "notRunning" } 获取生成的图像结果

使用此 API 检索图像生成操作的结果。映像生成目前仅适用于 api-version=2023-06-01-preview。

GET https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version={api-version}

路径参数

参数类型必需？说明 your-resource-name 字符串必须 Azure OpenAI 资源的名称。 operation-id 字符串必须标识原始图像生成请求的 GUID。

支持的版本

2023-06-01-previewSwagger spec 2023-07-01-previewSwagger spec 2023-08-01-previewSwagger spec 示例请求 curl -X GET "https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version=2023-06-01-preview" -H "Content-Type: application/json" -H "Api-Key: {api key}" 示例响应

成功后，操作将返回 200 状态代码和 OperationResponse JSON 对象。 status 字段可以是 "notRunning"（任务已排队但尚未启动）、"running"、"succeeded"、"canceled"（任务已超时）、"failed" 或 "deleted"。 succeeded 状态表示生成的图像可在给定 URL 处下载。如果生成了多个图像，则它们的 URL 全部在 result.data 字段中返回。

{ "created": 1685064331, "expires": 1685150737, "id": "4b755937-3173-4b49-bf3f-da6702a3971a", "result": { "data": [ { "url": "" }, { "url": "" }, ... ] }, "status": "succeeded" } 从服务器中删除生成的图像

可以使用请求返回的操作 ID 从 Azure 服务器中删除相应的图像。默认情况下，生成的图像会在 24 小时后自动删除，但如果需要，可以提前触发删除操作。

DELETE https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version={api-version}

路径参数

参数类型必需？说明 your-resource-name 字符串必须 Azure OpenAI 资源的名称。 operation-id 字符串必须标识原始图像生成请求的 GUID。

支持的版本

2023-06-01-previewSwagger spec 2023-07-01-previewSwagger spec 2023-08-01-previewSwagger spec 示例请求 curl -X DELETE "https://{your-resource-name}.openai.azure.com/openai/operations/images/{operation-id}?api-version=2023-06-01-preview" -H "Content-Type: application/json" -H "Api-Key: {api key}" 响应

如果成功，操作将返回 204 状态代码。仅当操作处于结束状态（不是 running）时，此 API 才会成功。

管理 API

Azure OpenAI 作为 Azure AI 服务的一部分进行部署。所有 Azure AI 服务都依赖于同一组管理 API 来执行创建、更新和删除操作。管理 API 还用于在 OpenAI 资源中部署模型。

管理 API 参考文档

后续步骤

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

【本文地址】

公司简介

联系我们

今日新闻

推荐新闻

专题文章