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

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

Конечные точки модели ИИ, развернутые в Azure OpenAI в модели Foundry , можно импортировать в экземпляр управления API в качестве REST API. Используйте политики шлюза ИИ и другие возможности в службе "Управление API", чтобы упростить интеграцию, улучшить наблюдаемость и повысить контроль над конечными точками модели.

В этой статье описываются два варианта импорта OpenAI API в Azure в экземпляр службы Azure API Management в качестве REST API.

Дополнительные сведения об управлении API LLM в службе управления API:

Предварительные условия

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

  • (Для импорта из Microsoft Foundry) Проект Microsoft Foundry с развернутой моделью Azure OpenAI. Дополнительные сведения о развертывании модели в Azure OpenAI см. в руководстве по развертыванию ресурсов.

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

  • Разрешения предоставляют доступ к ресурсу Azure OpenAI из экземпляра API Management.

Вариант 1. Импорт API OpenAI из Microsoft Foundry

Развертывание модели Azure OpenAI можно импортировать непосредственно из Microsoft Foundry в службу управления API. Дополнительные сведения см. в разделе "Импорт API Microsoft Foundry".

При импорте API:

  • Укажите службу Microsoft Foundry, в которую размещается развертывание модели Azure OpenAI.
  • Укажите параметр совместимости клиента Azure OpenAI . Этот параметр настраивает API системы управления API с конечной точкой /openai.

Вариант 2. Добавление спецификации OpenAPI в Управление API

Кроме того, вручную скачайте спецификацию OpenAPI для REST API Azure OpenAI и добавьте ее в Управление API в качестве API OpenAPI.

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

Скачайте спецификацию OpenAPI для REST API Azure OpenAI, например, версию GA от 2024-10-21.

  1. В текстовом редакторе откройте скачанный файл спецификации.

  2. В элементе servers спецификации замените имя вашей конечной точки Azure OpenAI в заполнителях url и default конечной точки. Например, если конечная точка Azure OpenAI имеет значение contoso.openai.azure.com, обновите элемент servers на следующие значения:

    • URL-адрес: https://contoso.openai.azure.com/openai
    • конечная точка по умолчанию:contoso.openai.azure.com
    [...]
    "servers": [
        {
          "url": "https://contoso.openai.azure.com/openai",
          "variables": {
            "endpoint": {
              "default": "contoso.openai.azure.com"
            }
          }
        }
      ],
    [...]
    
  3. Запишите значение API version в спецификации. Чтобы протестировать API, это вам понадобится. Пример: 2024-10-21.

Добавление спецификации OpenAPI в Управление API

  1. На портале Azure откройте экземпляр API Management.
  2. В меню слева выберите API>+ Добавить API.
  3. В разделе "Определение нового API" выберите OpenAPI. Введите отображаемое имя и имя для API.
  4. Введите суффикс URL-адреса API, заканчивающийся /openai, для доступа к конечным точкам API Azure OpenAI в экземпляре Управления API. Например: my-openai-api/openai.
  5. Нажмите кнопку создания.

Управление API импортирует API и отображает операции из спецификации OpenAPI.

Настройка проверки подлинности в API OpenAI Azure

Чтобы выполнить проверку подлинности в API Azure OpenAI, укажите ключ API или используйте управляемое удостоверение. Если вы импортировали API Azure OpenAI непосредственно из Microsoft Foundry, аутентификация с использованием управляемой идентичности экземпляра управления API настраивается автоматически.

Если вы добавили API Azure OpenAI из спецификации OpenAPI, необходимо настроить проверку подлинности. Дополнительные сведения о настройке проверки подлинности с помощью политик управления API см. в статье "Проверка подлинности и авторизация в API LLM".

Тест API Azure OpenAI

Чтобы убедиться, что API Azure OpenAI работает должным образом, протестируйте его в консоли тестирования управления API. Необходимо указать идентификатор развертывания модели (имя), настроенный в ресурсе проекта Microsoft Foundry, и версию API для тестирования API.

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

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

  3. Выберите операцию, совместимую с моделью, развернутой в ресурсе Azure OpenAI. На странице отображаются поля для параметров и заголовков.

  4. В параметрах шаблона введите следующие значения:

    • deployment-id — идентификатор развертывания модели Azure OpenAI в Microsoft Foundry
    • api-version — допустимая версия API OpenAI Azure, например версия API, выбранная при импорте API. Снимок экрана: тестирование API Azure OpenAI на портале.
  5. При необходимости введите другие параметры и заголовки. В зависимости от операции и модели может потребоваться настроить или обновить текст запроса. Например, ниже приведен основной текст запроса для операции завершения чата:

    {
      "model": "any",
      "messages": [
        {
          "role": "user",
          "content": "Help me plan a vacation trip to Paris."
        }
      ],
      "max_tokens": 100
    }
    

    Примечание.

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

  6. Выберите Отправить.

    При успешном выполнении теста серверная часть отвечает с помощью успешного кода HTTP-ответа и некоторых данных. Ответ включает данные об использовании токенов, которые помогают вам отслеживать и управлять потреблением токенов Azure OpenAI API.

    Снимок экрана данных об использовании токенов в ответе API на портале.