Freigeben über

Importieren einer Azure OpenAI-API

GILT FÜR: Alle API Management-Ebenen

Sie können KI-Modellendpunkte, die in Azure OpenAI Service bereitgestellt werden, in Ihre API-Verwaltungsinstanz als REST-API importieren. Verwenden Sie KI-Gatewayrichtlinien und andere Funktionen in der API-Verwaltung, um die Integration zu vereinfachen, die Observierbarkeit zu verbessern und die Kontrolle über die Modellendpunkte zu verbessern.

Dieser Artikel enthält zwei Optionen zum Importieren einer Azure OpenAI-API in eine Azure API-Verwaltungsinstanz als REST-API:

Weitere Informationen zum Verwalten von KI-APIs in der API-Verwaltung:

Voraussetzungen

Option 1: Importieren der API aus dem Azure OpenAI Service

Sie können eine Azure OpenAI-API direkt aus dem Azure OpenAI-Dienst in die API-Verwaltung importieren.

Hinweis

Diese Funktion ist derzeit in Arbeitsbereichen nicht verfügbar.

Wenn Sie die API importieren, konfiguriert API Management automatisch Folgendes:

  • Vorgänge für alle Azure OpenAI REST-API-Endpunkte
  • Eine systemseitig zugewiesene Identität mit den erforderlichen Berechtigungen für den Zugriff auf die Azure OpenAI-Ressource
  • Eine Backend-Ressource und eine Set-Backend-Dienstrichtlinie, die API-Anforderungen an den Azure OpenAI-Dienstendpunkt leitet.
  • Authentifizierung beim Azure OpenAI-Back-End mithilfe der vom System zugewiesenen verwalteten Identität der Instanz.
  • (optional) Richtlinien, mit denen Sie die Azure OpenAI-API überwachen und verwalten können.

So importieren Sie eine Azure OpenAI-API in API Management:

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.

  2. Wählen Sie im linken Menü unter APIs die Option APIs>+ API hinzufügen aus.

  3. Wählen Sie unter Aus Azure-Ressource erstellen die Option Azure OpenAI Service aus.

    Screenshot: Erstellen einer API aus Azure OpenAI Service im Portal

  4. Gehen Sie auf der Registerkarte Grundlagen wie folgt vor:

    1. Wählen Sie die Azure OpenAI-Ressource aus, die Sie importieren möchten.

    2. Wählen Sie optional eine Azure OpenAI-API-Version aus. Wenn Sie keine Version auswählen, wird standardmäßig die neueste produktionsfähige REST-API-Version verwendet. Notieren Sie sich die ausgewählte Version. Sie benötigen sie, um die API zu testen.

    3. Geben Sie einen Anzeigenamen und optional eine Beschreibung für die API ein.

    4. Fügen Sie in Basis-URL einen Pfad an, den Ihre API Management-Instanz für den Zugriff auf die Azure OpenAI-API-Endpunkte verwendet. Wenn Sie OpenAI SDK-Kompatibilität sicherstellen aktivieren (empfohlen), wird /openai automatisch an die Basis-URL angefügt.

      Wenn Ihr API Management-Gatewayendpunkt beispielsweise https://contoso.azure-api.net lautet, legen Sie eine Basis-URL wie https://contoso.azure-api.net/my-openai-api/openai fest.

    5. Wählen Sie optional ein oder mehrere Produkte aus, die mit der API verknüpft werden sollen. Wählen Sie Weiter aus.

  5. Auf der Registerkarte "Richtlinien" können Sie optional Richtlinien aktivieren, um die API zu überwachen und zu verwalten. Sie können Richtlinien auch später festlegen oder bearbeiten.

    Wenn diese Option ausgewählt ist, geben Sie Einstellungen ein, oder akzeptieren Sie Standardeinstellungen, die die folgenden Richtlinien definieren (siehe verknüpfte Artikel zu Voraussetzungen und Konfigurationsdetails):

    Klicken Sie auf Überprüfen + erstellen.

  6. Wählen Sie nach der Überprüfung Ihrer Einstellungen Erstellen aus.

Option 2. Hinzufügen der OpenAPI-Spezifikation zu API Management

Alternativ können Sie die OpenAPI-Spezifikation für die Azure OpenAI REST-API manuell herunterladen und API Management als OpenAPI-API hinzufügen.

Herunterladen der OpenAPI-Spezifikation

Laden Sie die OpenAPI-Spezifikation für die Azure OpenAI REST-API herunter, z. B. die Ga-Version 2024-10-21.

  1. Öffnen Sie in einem Text-Editor die von Ihnen heruntergeladene Spezifikationsdatei.

  2. Ersetzen Sie im servers-Element in der Spezifikation den Namen Ihres Azure OpenAI Service-Endpunkts in den Platzhalterwerte für url und default-Endpunkt in der Spezifikation. Wenn Ihr Azure OpenAI Service-Endpunkt beispielsweise contoso.openai.azure.com lautet, aktualisieren Sie das servers-Element mit den folgenden Werten:

    • URL: https://contoso.openai.azure.com/openai
    • Standardendpunkt : contoso.openai.azure.com
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]

  3. Notieren Sie sich den Wert der API version in der Spezifikation. Sie benötigen sie, um die API zu testen. Beispiel: 2024-10-21.

Importieren der OpenAPI-Spezifikation in API Management

  1. Navigieren Sie im Azure-Portal zu Ihrer API Management-Instanz.
  2. Wählen Sie im linken Menü APIs>+ API hinzufügen aus.
  3. Wählen Sie unter Neue API definieren die Option OpenAPI aus. Geben Sie einen Anzeigenamen und einen Namen für die API ein.
  4. Geben Sie ein API-URL-Suffix ein, das mit /openai endet, um auf die Azure OpenAI-API-Endpunkte in Ihrer API Management-Instanz zuzugreifen. Beispiel: my-openai-api/openai.
  5. Klicken Sie auf Erstellen.

Die API wird importiert und zeigt Vorgänge aus der OpenAPI-Spezifikation an.

Konfigurieren der Authentifizierung bei der Azure OpenAI-API

Um sich bei der Azure OpenAI-API zu authentifizieren, geben Sie einen API-Schlüssel oder eine verwaltete Identität an. Wenn Sie die Azure OpenAI-API direkt in Ihre API Management-Instanz importiert haben, wird die Authentifizierung mit der verwalteten Identität der API Management-Instanz automatisch konfiguriert.

Wenn Sie die Azure OpenAI-API aus der OpenAPI-Spezifikation hinzugefügt haben, müssen Sie die Authentifizierung konfigurieren. Weitere Informationen über das Konfigurieren der Authentifizierung mithilfe von API Management-Richtlinien finden Sie unter Authentifizieren und Autorisieren der Azure OpenAI-API.

Testen der Azure OpenAI-API

Um sicherzustellen, dass Ihre Azure OpenAI-API erwartungsgemäß funktioniert, testen Sie sie in der API Management-Testkonsole. Sie müssen eine Modellbereitstellungs-ID (Name) bereitstellen, die in der Azure OpenAI-Ressource und der API-Version konfiguriert ist, um die API zu testen.

  1. Wählen Sie die API aus, die Sie im vorherigen Schritt erstellt haben.

  2. Wählen Sie die Registerkarte Testen aus.

  3. Wählen Sie einen Vorgang aus, der mit dem in der Azure OpenAI-Ressource implementierten Modell kompatibel ist. Auf der Seite werden Felder für Parameter und Header angezeigt.

  4. Geben Sie in Vorlagenparameter die folgenden Werte ein:

    • deployment-id: die ID einer Bereitstellung im Azure OpenAI Service
    • api-version: eine gültige Azure OpenAI-API-Version, z. B. die API-Version, die Sie beim Importieren der API ausgewählt haben. Screenshot: Testen einer Azure OpenAI Service-API im Portal

  5. Geben Sie bei Bedarf weitere Parameter und Header ein. Je nach Vorgang müssen Sie möglicherweise einen Anforderungstext konfigurieren oder aktualisieren.

    Hinweis

    In der Testkonsole füllt API Management automatisch einen Ocp-Apim-Subscription-Key-Header auf und konfiguriert den Abonnementschlüssel des integrierten All-Access-Abonnements. Dieser Schlüssel ermöglicht den Zugriff auf jede API in der API Management-Instanz. Optional können Sie den Ocp-Apim-Subscription-Key-Header anzeigen, indem Sie das Augensymbol neben der HTTP-Anforderung auswählen.

  6. Wählen Sie Send (Senden) aus.

    Wenn der Test erfolgreich ist, antwortet das Back-End mit einem erfolgreichen HTTP-Antwortcode und einigen Daten. An die Antwort angefügt sind Tokennutzungsdaten, die Ihnen helfen, Ihre Azure OpenAI-API-Tokennutzung zu überwachen und zu verwalten.

    Screenshot: Tokennutzungsdaten in der API-Antwort im Portal

Zugehöriger Inhalt