Бөлісу құралы:

Импорт API OpenAI Azure

  • Мақала

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

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

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

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

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

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

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

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

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

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

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

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

  1. Перейдите к экземпляру Управления API на портале Azure.

  2. В меню слева в разделе API выберите API>+ Добавить API.

  3. В разделе "Создание из ресурса Azure" выберите Службу Azure OpenAI.

    Снимок экрана: создание API из Службы Azure OpenAI на портале.

  4. На вкладке Основные сведения сделайте следующее.

    1. Выберите ресурс Azure OpenAI, который требуется импортировать.

    2. При необходимости выберите версию API OpenAI Для Azure. Если вы не выберете его, по умолчанию используется последняя версия REST 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. Выберите Далее.

  5. На вкладке "Политики" при необходимости включите политики для мониторинга потребления маркеров Azure OpenAI и управления ими. Если выбрано, введите параметры или примите значения по умолчанию, определяющие azure-openai-token-limit и azure-openai-emit-token-metric политики для API. Вы также можете задать или обновить конфигурацию политики позже. Выберите Review + Create (Просмотреть и создать).

  6. После проверки параметров нажмите кнопку "Создать".

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

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

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

Скачайте спецификацию OpenAPI для REST API Azure OpenAI, например версию общедоступной версии 2024-02-01.

  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-02-01.

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

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

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 тестовой консоли. Для тестирования API необходимо указать идентификатор развертывания модели (имя), настроенный в ресурсе Azure OpenAI.

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

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

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

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

    • deployment-id — идентификатор развертывания в службе Azure OpenAI
    • api-version — допустимая версия API OpenAI Azure, например версия API, выбранная при импорте API. Снимок экрана: тестирование API службы Azure OpenAI на портале.

  5. При необходимости введите другие параметры и заголовки. В зависимости от операции может потребоваться настроить или обновить текст запроса.

    Примечание.

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

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

    При успешном выполнении теста серверная часть отвечает с помощью успешного кода ОТВЕТА HTTP и некоторых данных. Добавлен к ответу данные об использовании маркеров, которые помогут вам отслеживать потребление API OpenAI Azure и управлять ими. Снимок экрана: данные об использовании маркеров в ответе 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

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