Share via

Importowanie interfejsu API usługi Azure OpenAI jako interfejsu API REST

  • Artykuł

DOTYCZY: Wszystkie warstwy usługi API Management

W tym artykule pokazano, jak zaimportować interfejs API usługi Azure OpenAI do wystąpienia usługi Azure API Management ze specyfikacji interfejsu OpenAPI. Po zaimportowaniu interfejsu API jako interfejsu API REST możesz zarządzać nim i zabezpieczać go oraz publikować go dla deweloperów.

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 wdrożenia (nazwę). Będzie ona potrzebna podczas testowania zaimportowanych interfejsów API w usłudze API Management.

Pobieranie specyfikacji interfejsu OpenAPI

Pobierz specyfikację interfejsu OpenAPI dla punktu końcowego obsługiwanego przez model. Na przykład pobierz specyfikację interfejsu OpenAPI dla punktu końcowego uzupełniania czatu modeli GPT-35-Turbo i GPT-4.

  1. W edytorze tekstów otwórz pobrany plik specyfikacji.
  2. W elemecie servers w specyfikacji zastąp nazwę punktu końcowego zasobu usługi Azure OpenAI dla wartości zastępczych w specyfikacji. Poniższy przykładowy servers element jest aktualizowany przy użyciu punktu końcowego contoso.openai.azure.com zasobu. 
    [...]
"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: 2023-05-15.

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, a następnie wprowadź sufiks adresu URL interfejsu API.
  4. Wybierz pozycję Utwórz.

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

Testowanie nowego interfejsu API w portalu

Operacje można wywoływać bezpośrednio z portalu, co zapewnia wygodny sposób wyświetlania i testowania operacji interfejsu API przez administratorów.

  1. Wybierz interfejs API utworzony w poprzednim kroku.

  2. Wybierz kartę Test.

  3. Wybierz operację. Na stronie zostaną wyświetlone pola parametrów zapytania i pola nagłówków.

    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.

  4. W zależności od operacji wprowadź wartości parametrów zapytania, wartości nagłówka lub treść żądania. Wybierz Wyślij.

    Po pomyślnym zakończeniu testu zaplecze odpowiada z pomyślnym kodem odpowiedzi HTTP i pewnymi danymi.

    Napiwek

    Domyślnie konsola testowa wysyła żądanie do serwera proxy CORS usługi API Management, który przekazuje żądanie do wystąpienia usługi API Management, które następnie przekazuje je do zaplecza. Ten serwer proxy używa publicznego adresu IP 13.91.254.72 i może uzyskiwać dostęp tylko do publicznych punktów końcowych. Jeśli chcesz wysłać żądanie bezpośrednio z przeglądarki do usługi API Management, wybierz pozycję Pomiń serwer proxy CORS. Użyj tej opcji, jeśli chcesz użyć konsoli testowej, a brama usługi API Management jest odizolowana od sieci lub nie zezwala na ruch z serwera proxy CORS.

Aby debugować interfejs API, zobacz Samouczek: debugowanie interfejsów API przy użyciu śledzenia żądań.

Ważne

Uwierzytelnianie w interfejsie API openAI wymaga klucza interfejsu API lub tożsamości zarządzanej. Aby skonfigurować uwierzytelnianie przy użyciu zasad usługi API Management, zobacz Uwierzytelnianie i autoryzacja do interfejsu API usługi Azure OpenAI.

Powiązana zawartość