openai openai_api_base的进一步展开说明

目录

• Azure OpenAI 服务 REST API 参考
• 认证
• REST API 版本控制
• 公共硬件常见问题和解答
• 聊天生成
• 图片生成
• 表情符号生成
• 模型管理

Azure OpenAI 服务 REST API 参考

Azure OpenAI 服务提供了一组 REST API，用于与 Azure OpenAI 进行交互。通过这些 API，您可使用 Azure OpenAI 强大的模型进行文本生成、聊天对话和图象生成等任务。本文档提供了有关怎样使用这些 API 的详细信息，包括身份验证、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⑴5

聊天生成

使用聊天生成操作，模型将基于提供的提示生成一个或多个预测完成。服务还可以返回每一个位置上备用标记的几率。下面是生成聊天完成的示例要求：

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

路径参数

参数说明

类型	会不会一定要	描写
your-resource-name	string	是	您的 Azure OpenAI 资源名称。
deployment-id	string	是	部署模型时选择的部署名称。
api-version	string	是	要使用的 API 版本。该版本的格式与 YYYY-MM-DD 相同。

要求主体

参数说明

参数说明

类型	会不会一定要	默许值	描写
prompt	string 或 array	可选的 <|endoftext|>	要为其生成完成的提示（作为字符串或字符串数组进行编码）。 注意，<|endoftext|> 是模型在训练进程中视察到的文档分隔符，因此如果未指定提示，则模型将生成重新文档的开头开始的完成。
max_tokens	整数	可选的 16	要生成的完成中的最大标记数。您的提示标记数加上 max_tokens 的总和不得超过模型的上下文长度。 大多数模型的上下文长度为 2048 标记（除最新的支持 4096 标记的模型）。此参数不能与 gpt⑶5-turbo 一起使用。
temperature	数值	可选的 1	要使用的采样温度，介于 0 和 2 之间。值越高，模型冒的风险越大。 尝试 0.9 进行更具创意的利用，和 0（argmax 采样）进行有明确答案的利用。 我们通常建议修改这个参数或 top_p，而不是二者都修改。

示例要求

curl https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/completions?api-version=2023-05⑴5 
  -H "Content-Type: application/json" 
  -H "api-key: YOUR_API_KEY" 
  -d "{
    "prompt": "Once upon a time",
    "max_tokens": 5
  }"

示例响应

{
  "id": "cmpl⑷kGh7iXtjW4lc9eGhff6Hp8C7btdQ",
  "object": "text_completion",
  "created": 1646932609,
  "model": "ada",
  "choices": [
    {
      "text": ", a dark line crossed",
      "index": 0,
      "logprobs": null,
      "finish_reason": "length"
    }
  ]
}

处理聊天生成响应示例：
示例响应示例完成原文等等

openai openai_api_base的常见问答Q&A