Een Azure OpenAI-API importeren als een REST API

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

In dit artikel wordt beschreven hoe u een Azure OpenAI-API importeert in een Azure API Management-exemplaar vanuit de OpenAPI-specificatie. Nadat u de API als EEN REST API hebt geïmporteerd, kunt u deze beheren en beveiligen en publiceren naar ontwikkelaars.

Vereisten

  • Een bestaand API Management-exemplaar. Maak er een als u dat nog niet hebt gedaan.

  • Toegang verleend tot Azure OpenAI in het gewenste Azure abonnement. U kunt toegang tot Azure OpenAI aanvragen door het formulier in te vullen op https://aka.ms/oai/access. Open een probleem op deze opslagplaats om contact met ons op te stellen als u een probleem hebt.

  • Een Azure OpenAI-resource met een model dat is geïmplementeerd. Zie de gids implementatiemodellen voor meer informatie over de implementatiemodellen.

    Noteer de implementatie-id (naam). U hebt deze nodig wanneer u de geïmporteerde API test in API Management.

De OpenAPI-specificatie downloaden

Download de OpenAPI-specificatie voor een eindpunt dat door uw model wordt ondersteund. Download bijvoorbeeld de OpenAPI-specificatie voor het voltooiingseindpunt van de GPT-35-Turbo- en GPT-4-modellen.

  1. Open in een teksteditor het specificatiebestand dat u hebt gedownload.
  2. Vervang in het servers element in de specificatie de naam van uw Azure OpenAI-resource-eindpunt door de tijdelijke aanduidingswaarden in de specificatie. Het volgende voorbeeldelement servers wordt bijgewerkt met het contoso.openai.azure.com resource-eindpunt. 
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]
  3. Noteer de waarde van de API version in de specificatie. U hebt deze nodig om de API te testen. Voorbeeld: 2023-05-15.

OpenAPI-specificatie toevoegen aan API Management

  1. Blader in Azure Portal naar uw API Management-exemplaar.
  2. Selecteer API's+ API's> toevoegen in het linkermenu.
  3. Selecteer OpenAPI onder Een nieuwe API definiëren. Voer een weergavenaam en -naam in voor de API en voer een API-URL-achtervoegsel in.
  4. Selecteer Maken.

De API wordt geïmporteerd en geeft bewerkingen weer uit de OpenAPI-specificatie.

De nieuwe API testen in de portal

Bewerkingen kunnen rechtstreeks vanuit de portal worden aangeroepen, zodat beheerders de bewerkingen van een API kunnen bekijken en testen.

  1. Selecteer de API die u in de vorige stap hebt gemaakt.

  2. Selecteer het tabblad Testen.

  3. Selecteer een bewerking. De pagina geeft velden weer voor queryparameters en velden voor de headers.

    Notitie

    In de testconsole vult API Management automatisch een Ocp-Apim-Subscription-Key-header in en configureert de abonnementssleutel van het ingebouwde abonnement voor alle toegang. Met deze sleutel hebt u toegang tot elke API in het API Management-exemplaar. U kunt desgewenst de header Ocp-Apim-Subscription-Key weergeven door het pictogram 'oog' naast de HTTP-aanvraag te selecteren.

  4. Voer, afhankelijk van de bewerking, queryparameterwaarden, headerwaarden of aanvraagbody in. Selecteer Verzenden.

    Wanneer de test is geslaagd, reageert de back-end met een geslaagde HTTP-antwoordcode en enkele gegevens.

    Tip

    De testconsole verzendt standaard een aanvraag naar de CORS-proxy van API Management, die de aanvraag doorstuurt naar het API Management-exemplaar, dat deze vervolgens doorstuurt naar de back-end. Deze proxy gebruikt openbaar IP-adres 13.91.254.72 en kan alleen openbare eindpunten bereiken. Als u een aanvraag rechtstreeks vanuit de browser naar de API Management-service wilt verzenden, selecteert u CORS-proxy overslaan. Gebruik deze optie als u de testconsole wilt gebruiken en uw API Management-gateway netwerkisoleert of geen verkeer van de CORS-proxy toestaat.

Als u fouten in een API wilt opsporen, raadpleegt u zelfstudie: Fouten opsporen in uw API's met behulp van aanvraagtracering.

Belangrijk

Verificatie voor de OpenAI-API vereist een API-sleutel of een beheerde identiteit. Zie Verifiëren en autoriseren voor Azure OpenAI-API om verificatie te configureren met BEHULP van API Management-beleid.

Gerelateerde inhoud