Delen via

Een Azure OpenAI-API importeren

  • Artikel

VAN TOEPASSING OP: Alle API Management-lagen

In dit artikel worden twee opties beschreven voor het importeren van een Azure OpenAI-service-API in een Azure API Management-exemplaar als een REST API:

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 id (naam) van de implementatie. U hebt deze nodig wanneer u de geïmporteerde API test in API Management.

  • Machtigingen voor het verlenen van toegang tot de Azure OpenAI-resource vanuit het API Management-exemplaar.

Optie 1. API importeren uit Azure OpenAI-service

U kunt een Azure OpenAI-API rechtstreeks importeren in API Management vanuit de Azure OpenAI-service. Wanneer u de API importeert, configureert API Management het volgende automatisch:

  • Bewerkingen voor elk van de Azure OpenAI REST API-eindpunten.
  • Een door het systeem toegewezen identiteit met de benodigde machtigingen voor toegang tot de Azure OpenAI-resource.
  • Een back-endresource en set-backend-servicebeleid waarmee API-aanvragen worden doorgestuurd naar het Azure OpenAI-service-eindpunt.
  • Een door verificatie beheerd identiteitsbeleid dat kan worden geverifieerd bij de Azure OpenAI-resource met behulp van de door het systeem toegewezen identiteit van het exemplaar.
  • (optioneel) Beleid voor het bewaken en beheren van tokenverbruik door de Azure OpenAI-API.

Een Azure OpenAI-API importeren in API Management:

  1. Blader in Azure Portal naar uw API Management-exemplaar.

  2. Selecteer API's+ API's toevoegen in het linkermenu onder API's>.

  3. Selecteer azure OpenAI-service onder Maken vanuit Azure-resource.

    Schermopname van het maken van een API vanuit de Azure OpenAI-service in de portal.

  4. Op het tabblad Basis:

    1. Selecteer de Azure OpenAI-resource die u wilt importeren.

    2. Selecteer desgewenst een Azure OpenAI API-versie. Als u er geen selecteert, wordt de nieuwste rest API-versie die gereed is voor productie standaard gebruikt.

    3. Voer een weergavenaam en een optionele beschrijving voor de API in.

    4. Voeg in de basis-URL een pad toe dat uw API Management-exemplaar gebruikt voor toegang tot de Azure OpenAI API-eindpunten. Als u Ervoor zorgen dat openAI SDK-compatibiliteit (aanbevolen) is ingeschakeld, /openai wordt automatisch toegevoegd aan de basis-URL.

      Als uw API Management-gatewayeindpunt bijvoorbeeld is, stelt u een basis-URL in die vergelijkbaar is https://contoso.azure-api.netmet https://contoso.azure-api.net/my-openai-api/openai.

    5. Selecteer eventueel een of meer producten die u aan de API wilt koppelen. Selecteer Volgende.

  5. Schakel op het tabblad Beleid eventueel beleidsregels in om het verbruik van azure OpenAI API-token te bewaken en te beheren. Als deze optie is geselecteerd, voert u instellingen in of accepteert u de standaardinstellingen die het azure-openai-token-limit beleid voor azure-openai-emit-token-metric uw API definiëren. U kunt de beleidsconfiguratie ook later instellen of bijwerken. Selecteer Controleren + maken.

  6. Nadat de instellingen zijn gevalideerd, selecteert u Maken.

Optie 2. Een OpenAPI-specificatie toevoegen aan API Management

U kunt ook handmatig de OpenAPI-specificatie voor de Azure OpenAI REST API downloaden en deze als openAPI-API toevoegen aan API Management.

De OpenAPI-specificatie downloaden

Download de OpenAPI-specificatie voor de Azure OpenAI REST API, zoals de GA-versie 2024-02-01.

  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-service-eindpunt in de tijdelijke aanduidingswaarden van url en default het eindpunt in de specificatie. Als uw Azure OpenAI-service-eindpunt bijvoorbeeld is contoso.openai.azure.com, werkt u het servers element bij met de volgende waarden:

    • Url: https://contoso.openai.azure.com/openai
    • standaardeindpunt: contoso.openai.azure.com
    [...]
"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: 2024-02-01.

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.
  4. Voer een API-URL-achtervoegsel in /openai dat eindigt op toegang tot de Azure OpenAI API-eindpunten in uw API Management-exemplaar. Voorbeeld: my-openai-api/openai.
  5. Selecteer Maken.

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

Verificatie configureren voor Azure OpenAI-API

Als u zich wilt verifiëren bij de Azure OpenAI-API, geeft u een API-sleutel of een beheerde identiteit op. Als u de Azure OpenAI-API rechtstreeks hebt geïmporteerd in uw API Management-exemplaar, wordt verificatie met behulp van de beheerde identiteit van het API Management-exemplaar automatisch geconfigureerd.

Als u de Azure OpenAI-API hebt toegevoegd vanuit de OpenAPI-specificatie, moet u verificatie configureren. Zie Verifiëren en autoriseren voor Azure OpenAI API voor meer informatie over het configureren van verificatie met API Management-beleid.

De Azure OpenAI-API testen

Test deze in de API Management-testconsole om ervoor te zorgen dat uw Azure OpenAI-API werkt zoals verwacht. U moet een modelimplementatie-id (naam) opgeven die is geconfigureerd in de Azure OpenAI-resource om de API te testen.

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

  2. Selecteer het tabblad Testen.

  3. Selecteer een bewerking die compatibel is met het model dat u hebt geïmplementeerd in de Azure OpenAI-resource. Op de pagina worden velden voor parameters en headers weergegeven.

  4. Voer in sjabloonparameters de volgende waarden in:

    • deployment-id - de id van een implementatie in de Azure OpenAI-service
    • api-version - een geldige Azure OpenAI API-versie, zoals de API-versie die u hebt geselecteerd toen u de API hebt geïmporteerd. Schermopname van het testen van een Azure OpenAI Service-API in de portal.

  5. Voer indien nodig andere parameters en headers in. Afhankelijk van de bewerking moet u mogelijk een aanvraagbody configureren of bijwerken.

    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.

  6. Selecteer Verzenden.

    Wanneer de test is geslaagd, reageert de back-end met een geslaagde HTTP-antwoordcode en enkele gegevens. Toegevoegd aan het antwoord zijn tokengebruiksgegevens om u te helpen bij het bewaken en beheren van uw Azure OpenAI API-verbruik. Schermopname van tokengebruiksgegevens in API-antwoord in de portal.

Cachebeleidsregels voor Azure OpenAI-API's

Naast de azure-openai-token-limit beleidsregels en azure-openai-emit-token-metric beleidsregels die u kunt configureren bij het importeren van een Azure OpenAI-service-API, biedt API Management het volgende cachebeleid waarmee u de prestaties kunt optimaliseren en latentie voor Azure OpenAI-API's kunt verminderen:

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

Gerelateerde inhoud