Udostępnij za pośrednictwem

Importowanie interfejsu API usługi Azure OpenAI

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule przedstawiono dwie opcje importowania interfejsu API usługi Azure OpenAI Service do wystąpienia usługi Azure API Management jako interfejsu API REST:

Wymagania wstępne

  • Istniejące wystąpienie usługi API Management. Utwórz go, jeśli jeszcze tego nie zrobiono.

  • Dostęp jest udzielany usłudze Azure OpenAI w żądanej subskrypcji platformy Azure. Możesz ubiegać się o dostęp do usługi Azure OpenAI, wypełniając formularz pod adresem https://aka.ms/oai/access. Otwórz problem w tym repozytorium, aby skontaktować się z nami, jeśli masz problem.

  • Zasób usługi Azure OpenAI z wdrożonym modelem. Aby uzyskać więcej informacji na temat modeli wdrażania, zobacz przewodnik po modelach wdrażania).

    Zanotuj identyfikator (nazwę) wdrożenia. Będzie ona potrzebna podczas testowania zaimportowanych interfejsów API w usłudze API Management.

  • Uprawnienia do udzielania dostępu do zasobu usługi Azure OpenAI z wystąpienia usługi API Management.

Sposób 1. Importowanie interfejsu API z usługi Azure OpenAI Service

Interfejs API usługi Azure OpenAI można zaimportować bezpośrednio do usługi API Management z usługi Azure OpenAI. Podczas importowania interfejsu API usługa API Management automatycznie konfiguruje:

  • Operacje dla każdego z punktów końcowych interfejsu API REST usługi Azure OpenAI.
  • Tożsamość przypisana przez system z niezbędnymi uprawnieniami dostępu do zasobu usługi Azure OpenAI.
  • Zasób zaplecza i zasady set-backend-service, które kierują żądania interfejsu API do punktu końcowego usługi Azure OpenAI Service.
  • Zasady tożsamości zarządzanej uwierzytelniania, które mogą uwierzytelniać się w zasobie usługi Azure OpenAI przy użyciu tożsamości przypisanej przez system wystąpienia.
  • (opcjonalnie) Zasady ułatwiające monitorowanie użycia tokenów i zarządzanie nim za pomocą interfejsu API usługi Azure OpenAI.

Aby zaimportować interfejs API usługi Azure OpenAI do usługi API Management:

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.

  2. W menu po lewej stronie w obszarze Interfejsy API wybierz pozycję Interfejsy> API+ Dodaj interfejs API.

  3. W obszarze Tworzenie z zasobu platformy Azure wybierz pozycję Azure OpenAI Service.

    Zrzut ekranu przedstawiający tworzenie interfejsu API z poziomu usługi Azure OpenAI Service w portalu.

  4. Na karcie Ustawienia podstawowe:

    1. Wybierz zasób Azure OpenAI, który chcesz zaimportować.

    2. Opcjonalnie wybierz wersję interfejsu API usługi Azure OpenAI. Jeśli go nie wybierzesz, domyślnie jest używana najnowsza wersja interfejsu API REST gotowego do produkcji.

    3. Wprowadź nazwę wyświetlaną i opcjonalny opis interfejsu API.

    4. W polu Podstawowy adres URL dołącz ścieżkę używaną przez wystąpienie usługi API Management do uzyskiwania dostępu do punktów końcowych interfejsu API usługi Azure OpenAI. Jeśli włączysz opcję Upewnij się, że zestaw OpenAI SDK jest /openai automatycznie dołączany do podstawowego adresu URL.

      Jeśli na przykład punkt końcowy bramy usługi API Management to https://contoso.azure-api.net, ustaw podstawowy adres URL podobny do https://contoso.azure-api.net/my-openai-api/openai.

    5. Opcjonalnie wybierz co najmniej jeden produkt do skojarzenia z interfejsem API. Wybierz Dalej.

  5. Na karcie Zasady opcjonalnie włącz zasady do monitorowania użycia tokenów interfejsu API usługi Azure OpenAI i zarządzania nimi. W przypadku wybrania wprowadź ustawienia lub zaakceptuj wartości domyślne, które definiują zasady i azure-openai-emit-token-metric dla interfejsu azure-openai-token-limit API. Konfigurację zasad można również ustawić lub zaktualizować później. Wybierz pozycję Przejrzyj i utwórz.

  6. Po zweryfikowaniu ustawień wybierz pozycję Utwórz.

Sposób 2. Dodawanie specyfikacji interfejsu OpenAPI do usługi API Management

Alternatywnie ręcznie pobierz specyfikację interfejsu OpenAPI dla interfejsu API REST usługi Azure OpenAI i dodaj ją do usługi API Management jako interfejs API OpenAPI.

Pobieranie specyfikacji interfejsu OpenAPI

Pobierz specyfikację interfejsu OpenAPI dla interfejsu API REST usługi Azure OpenAI, taką jak wersja ogólnie dostępna 2024-02-01.

  1. W edytorze tekstów otwórz pobrany plik specyfikacji.

  2. W elemecie servers w specyfikacji zastąp nazwę punktu końcowego usługi Azure OpenAI Service wartościami zastępczymi url i default punktem końcowym w specyfikacji. Jeśli na przykład punkt końcowy usługi Azure OpenAI to contoso.openai.azure.com, zaktualizuj servers element przy użyciu następujących wartości:

    • Adres url: https://contoso.openai.azure.com/openai
    • domyślny punkt końcowy: contoso.openai.azure.com
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]

  3. Zanotuj wartość interfejsu API version w specyfikacji. Będzie on potrzebny do przetestowania interfejsu API. Przykład: 2024-02-01.

Dodawanie specyfikacji interfejsu OpenAPI do usługi API Management

  1. W witrynie Azure Portal przejdź do wystąpienia usługi API Management.
  2. W menu po lewej stronie wybierz pozycję Interfejsy> API+ Dodaj interfejs API.
  3. W obszarze Definiowanie nowego interfejsu API wybierz pozycję OpenAPI. Wprowadź nazwę wyświetlaną i nazwę interfejsu API.
  4. Wprowadź sufiks adresu URL interfejsu API kończący /openai się na końcu, aby uzyskać dostęp do punktów końcowych interfejsu API OpenAI w wystąpieniu usługi API Management. Przykład: my-openai-api/openai.
  5. Wybierz pozycję Utwórz.

Interfejs API jest importowany i wyświetla operacje ze specyfikacji interfejsu OpenAPI.

Konfigurowanie uwierzytelniania w interfejsie API usługi Azure OpenAI

Aby uwierzytelnić się w interfejsie API usługi Azure OpenAI, należy podać klucz interfejsu API lub tożsamość zarządzaną. Jeśli zaimportowano interfejs API usługi Azure OpenAI bezpośrednio do wystąpienia usługi API Management, uwierzytelnianie przy użyciu tożsamości zarządzanej wystąpienia usługi API Management zostanie automatycznie skonfigurowane.

Jeśli interfejs API usługi Azure OpenAI został dodany ze specyfikacji interfejsu OpenAPI, musisz skonfigurować uwierzytelnianie. Aby uzyskać więcej informacji na temat konfigurowania uwierzytelniania przy użyciu zasad usługi API Management, zobacz Uwierzytelnianie i autoryzacja do interfejsu API usługi Azure OpenAI.

Testowanie interfejsu API usługi Azure OpenAI

Aby upewnić się, że interfejs API usługi Azure OpenAI działa zgodnie z oczekiwaniami, przetestuj go w konsoli testowej usługi API Management. Aby przetestować interfejs API, musisz podać identyfikator wdrożenia modelu (nazwa) skonfigurowany w zasobie usługi Azure OpenAI.

  1. Wybierz interfejs API utworzony w poprzednim kroku.

  2. Wybierz kartę Test.

  3. Wybierz operację zgodną z modelem wdrożonym w zasobie Azure OpenAI. Na stronie są wyświetlane pola parametrów i nagłówków.

  4. W obszarze Parametry szablonu wprowadź następujące wartości:

    • deployment-id — identyfikator wdrożenia w usłudze Azure OpenAI
    • api-version — prawidłowa wersja interfejsu API usługi Azure OpenAI, taka jak wersja interfejsu API wybrana podczas importowania interfejsu API. Zrzut ekranu przedstawiający testowanie interfejsu API usługi Azure OpenAI Service w portalu.

  5. Wprowadź inne parametry i nagłówki zgodnie z potrzebami. W zależności od operacji może być konieczne skonfigurowanie lub zaktualizowanie treści żądania.

    Uwaga

    W konsoli testowej usługa API Management automatycznie wypełnia nagłówek Ocp-Apim-Subscription-Key i konfiguruje klucz subskrypcji wbudowanej subskrypcji typu all-access. Ten klucz umożliwia dostęp do każdego interfejsu API w wystąpieniu usługi API Management. Opcjonalnie wyświetl nagłówek Ocp-Apim-Subscription-Key , wybierając ikonę "oko" obok żądania HTTP.

  6. Wybierz Wyślij.

    Po pomyślnym zakończeniu testu zaplecze odpowiada z pomyślnym kodem odpowiedzi HTTP i pewnymi danymi. Dołączono do odpowiedzi dane użycia tokenu, które ułatwiają monitorowanie użycia interfejsu API usługi Azure OpenAI i zarządzanie nim. Zrzut ekranu przedstawiający dane użycia tokenu w odpowiedzi interfejsu API w portalu.

Buforowanie zasad dla interfejsów API usługi Azure OpenAI

Oprócz azure-openai-token-limit zasad i azure-openai-emit-token-metric , które można skonfigurować podczas importowania interfejsu API usługi Azure OpenAI Service, usługa API Management udostępnia następujące zasady buforowania, które ułatwiają optymalizowanie wydajności i zmniejszenie opóźnienia interfejsów API usługi Azure OpenAI:

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

Powiązana zawartość