Импорт API Azure OpenAI в качестве REST API

  • Статья

ОБЛАСТЬ ПРИМЕНЕНИЯ: все уровни Управление API

В этой статье показано, как импортировать API Azure OpenAI в экземпляр Azure Управление API из спецификации OpenAPI. После импорта API в качестве REST API вы можете управлять и защищать его, а также публиковать его разработчикам.

Необходимые компоненты

  • Существующий экземпляр Управления API. Создайте его, если у вас его нет.

  • Службе Azure OpenAI предоставлен доступ в требуемой подписке Azure Вы можете подать заявку на доступ к Azure OpenAI, выполнив форму по адресу https://aka.ms/oai/access. Если у вас возникли проблемы, создайте соответствующий запрос в этом репозитории, чтобы связаться с нами.

  • Ресурс Azure OpenAI с развернутой моделью. Дополнительные сведения о моделях развертывания Azure, см. в руководстве по развертыванию ресурсов.

    Запишите идентификатор развертывания (имя). Это потребуется при тестировании импортированного API в Управление API.

Загрузка спецификации OpenAPI

Скачайте спецификацию OpenAPI для конечной точки, которую поддерживает ваша модель. Например, скачайте спецификацию OpenAPI для конечной точки завершения чата моделей GPT-35-Turbo и GPT-4.

  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. Перейдите к экземпляру Управления API на портале Azure.
  2. В меню слева выберите API>+ Добавить API.
  3. В разделе "Определение нового API" выберите OpenAPI. Введите отображаемое имя и имя API и введите суффикс URL-адреса API.
  4. Нажмите кнопку создания.

API импортируется и отображает операции из спецификации OpenAPI.

Проверка нового API на портале

Операции можно вызывать непосредственно на портале, что позволяет администраторам просматривать и тестировать операции API.

  1. Выберите API, созданный на предыдущем шаге.

  2. Откройте вкладку Тест.

  3. Выберите операцию. На странице отобразятся поля для параметров запроса и для заголовков.

    Примечание.

    В тестовой консоли Управление API автоматически заполняет заголовок Ocp-Apim-Subscription-Key и настраивает ключ подписки встроенной подписки. Этот ключ обеспечивает доступ к каждому API в Управление API экземпляре. При необходимости отобразится заголовок Ocp-Apim-Subscription-Key, щелкнув значок "глаз" рядом с HTTP-запросом.

  4. В зависимости от операции введите значения параметров запроса, значения заголовков или текст запроса. Выберите Отправить.

    При успешном выполнении теста серверная часть отвечает с помощью успешного кода ОТВЕТА HTTP и некоторых данных.

    Совет

    По умолчанию тестовая консоль отправляет запрос на прокси-сервер CORS Управление API, который перенаправляет запрос в экземпляр Управление API, который затем перенаправляет его в серверную часть. Этот прокси-сервер использует общедоступный IP-адрес 13.91.254.72 и может получать доступ только к общедоступным конечным точкам. Если вы хотите отправить запрос непосредственно из браузера в службу Управление API, выберите "Обход прокси CORS". Используйте этот параметр, если вы хотите использовать тестовую консоль, а шлюз Управление API изолирован от сети или не разрешает трафик из прокси-сервера CORS.

Сведения об отладке API см. в руководстве по отладке API с помощью трассировки запросов.

Внимание

Для проверки подлинности в API OpenAI требуется ключ API или управляемое удостоверение. Сведения о настройке проверки подлинности с помощью политик Управление API см. в статье "Проверка подлинности и авторизация в API OpenAI Azure".

Связанный контент