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

将 Azure OpenAI API 作为 REST API 导入

  • 项目

适用于：所有 API 管理层级

本文介绍如何从 OpenAPI 规范将 Azure OpenAI API 导入 Azure API 管理实例。 将 API 作为 REST API 导入后，可对其进行管理和保护，并将其发布给开发人员。

先决条件

  • 现有的 API 管理实例。 如果还没有实例，请创建一个。

  • 已在所需的 Azure 订阅中授予对 Azure OpenAI 的访问权限。 可以通过在 https://aka.ms/oai/access 上填写表单来申请对 Azure OpenAI 的访问权限。 如果有任何问题，请在此存储库上提出问题以联系我们。

  • 已部署模型的 Azure OpenAI 资源。 有关模型部署的详细信息，请参阅资源部署指南。

    记下部署 ID（名称）。 在 API 管理中测试导入的 API 时，需要用到它。

下载 OpenAPI 规范

下载模型支持的终结点的 OpenAPI 规范。 例如，下载 GPT-35-Turbo 和 GPT-4 模型的聊天完成终结点的 OpenAPI 规范。

  1. 在文本编辑器中，打开下载的规范文件。
  2. 在规范中的 servers 元素中，用你的 Azure OpenAI 资源终结点的名称替换规范中的占位符值。 以下示例 servers 元素使用 contoso.openai.azure.com 资源终结点进行更新。 
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]
  3. 记下规范中 API version 的值。 需要它以测试 API。 示例：2023-05-15。

将 OpenAPI 规范添加到 API 管理

  1. 在 Azure 门户，导航到 API 管理实例。
  2. 在左侧菜单中，选择“API”>“+ 添加 API”。
  3. 在“定义新的 API”下，选择“OpenAPI”。 输入 API 的“显示名称”和“名称”，并输入“API URL 后缀”。
  4. 选择创建。

API 导入并显示 OpenAPI 规范中的操作。

在门户中测试新的 API

可直接从管理门户调用操作，这为管理员查看和测试 API 的操作提供了一种方便的方式。

  1. 选择上一步中创建的 API。

  2. 选择“测试”选项卡。

  3. 选择操作。 该页将显示查询参数的字段和标头的字段。

    注意

    在测试控制台中，API 管理自动填充 Ocp-Apim-Subscription-Key 标头，并配置内置全访问订阅的订阅密钥。 此密钥允许访问 API 管理实例中的每个 API。 可选择性地通过选择 HTTP 请求旁的“眼睛”图标来显示 Ocp-Apim-Subscription-Key 标头。

  4. 根据操作，输入查询参数值、标头值或请求正文。 选择“发送”。

    当测试成功时，后端会使用成功的 HTTP 响应代码和某些数据进行响应。

    提示

    默认情况下，测试控制台会将请求发送到 API 管理的 CORS 代理，该代理将请求转发到 API 管理实例，后者又将请求转发到后端。 此代理使用公共 IP 地址 13.91.254.72，并且只能访问公共终结点。 如果要将请求直接从浏览器发送到API 管理服务，请选择“绕过 CORS 代理”。 如果要使用测试控制台，并且 API 管理网关与网络隔离或不允许来自 CORS 代理的流量，请使用此选项。

若要调试 API，请参阅教程：使用请求跟踪调试 API。

重要

对 OpenAI API 进行身份验证需要 API 密钥或托管标识。 若要使用 API 管理策略配置身份验证，请参阅对 Azure OpenAI API 进行身份验证和授权。

相关内容