Импорт API OpenAI Azure

Статья
2025-04-01

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

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

Импортировать API Azure OpenAI непосредственно из службы Azure OpenAI (рекомендуется)
Скачайте и добавьте спецификацию OpenAPI для Azure OpenAI и добавьте ее в Управление API в качестве API OpenAPI.

Узнайте больше об управлении AI API в API Management.

Возможности шлюза генеративного ИИ в Управлении API Azure

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

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

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

Примечание.

Политики управления API, такие как azure-openai-token-limit и azure-openai-emit-token-metric , поддерживаются для определенных конечных точек API, предоставляемых с помощью определенных моделей службы Azure OpenAI. Дополнительные сведения см. в статье "Поддерживаемые модели службы OpenAI Azure".
Разрешения на предоставление доступа к ресурсу Azure OpenAI из экземпляра Управление API.

Вариант 1. Импорт API из Службы Azure OpenAI

Api OpenAI Azure можно импортировать непосредственно из службы Azure OpenAI в Управление API.

Примечание.

В настоящее время эта функция недоступна в рабочих областях.

При импорте API Управление API автоматически настраивает:

Операции для каждой конечной точки Azure OpenAI REST API.
Назначаемое системой удостоверение с необходимыми разрешениями для доступа к ресурсу Azure OpenAI.
Ресурс серверной части и политика set-backend-service, которые направляют запросы API к узлу службы Azure OpenAI.
Проверка подлинности в серверной части Azure OpenAI с помощью назначаемого системой управляемого удостоверения экземпляра.
(необязательно) Политики, помогающие отслеживать API Azure OpenAI и управлять ими.

Чтобы импортировать API Azure OpenAI в Управление API, выполните следующие действия.

Перейдите к экземпляру Управления API на портале Azure.
В меню слева в разделе API выберите API>+ Добавить API.
В разделе "Создание из ресурса Azure" выберите Службу Azure OpenAI.
На вкладке Основные сведения сделайте следующее.
1. Выберите ресурс Azure OpenAI, который требуется импортировать.
2. По желанию выберите версию Azure OpenAI API. Если вы не выберете его, по умолчанию используется последняя версия REST API, готовая к рабочей среде. Запишите выбранную версию. Вам это понадобится для тестирования API.
3. Введите отображаемое имя и необязательное описание для API.
4. В базовом URL-адресе добавьте путь, который экземпляр Управление API использует для доступа к конечным точкам API Azure OpenAI. Если включить совместимость пакета SDK OpenAI (рекомендуется), /openai автоматически добавляется к базовому URL-адресу.
  
  Например, если конечная точка вашего шлюза Управления API имеет значение https://contoso.azure-api.net, задайте базовый URL-адрес, аналогичный https://contoso.azure-api.net/my-openai-api/openai.
5. При необходимости выберите один или несколько продуктов для связывания с API. Выберите Далее.
На вкладке "Политики" при необходимости включите политики для отслеживания и управления потреблением токенов Azure OpenAI. Вы также можете задать или изменить политики позже.

Если выбрано, введите параметры или примите значения по умолчанию, определяющие следующие политики (см. связанные статьи о предварительных требованиях и сведениях о конфигурации):
- Управление потреблением токенов
- Отслеживание использования маркеров
Выберите Просмотреть и создать.
После проверки параметров нажмите кнопку "Создать".

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

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

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

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

В текстовом редакторе откройте скачанный файл спецификации.
В элементе 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"
        }
      }
    }
  ],
[...]
```
Запишите значение API version в спецификации. Вам потребуется его, чтобы протестировать API. Пример: 2024-10-21.

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

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

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

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

Чтобы пройти проверку подлинности в API OpenAI Azure, вы предоставляете ключ API или управляемое удостоверение. При импорте API Azure OpenAI непосредственно в экземпляр Управления API настройка проверки подлинности с использованием управляемого ключа доступа экземпляра управления API производится автоматически.

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

Тестирование API OpenAI Для Azure

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

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

Примечание.

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

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

Политики кэширования для API-интерфейсов Azure OpenAI

Помимо политик azure-openai-token-limit и azure-openai-emit-token-metric, которые вы можете настроить при импорте API службы Azure OpenAI, Управление API предоставляет следующие политики кэширования для оптимизации производительности и уменьшения задержки API Azure OpenAI.

azure-openai-semantic-cache-store
azure-openai-semantic-cache-lookup