Dela via

Importera ett Azure OpenAI-API

  • Artikel

GÄLLER FÖR: Alla API Management-nivåer

Den här artikeln visar två alternativ för att importera ett Azure OpenAI-tjänst-API till en Azure API Management-instans som ett REST-API:

Förutsättningar

  • En befintlig API Management-instans. Skapa en om du inte redan har gjort det.

  • En Azure OpenAI-resurs med en distribuerad modell. Mer information om distributionsmodellerna finns i Förstå distributionsmodeller.

    Anteckna distributionens ID (namn). Du behöver det när du testar det importerade API:et i API Management.

  • Behörigheter för att bevilja åtkomst till Azure OpenAI-resursen från API Management-instansen.

Alternativ 1. Importera API från Azure OpenAI-tjänsten

Du kan importera ett Azure OpenAI API direkt från Azure OpenAI Service till API Management.

Kommentar

För närvarande är den här funktionen inte tillgänglig på arbetsytor.

När du importerar API:et konfigurerar API Management automatiskt:

  • Åtgärder för var och en av Azure OpenAI REST API-slutpunkterna.
  • En systemtilldelad identitet med de behörigheter som krävs för att få åtkomst till Azure OpenAI-resursen.
  • En serverdelsresurs och en set-backend-service-princip som dirigerar API-begäranden till Azure OpenAI-tjänstens slutpunkt.
  • En autentiseringshanterad identitetsprincip som kan autentisera till Azure OpenAI-resursen med hjälp av instansens systemtilldelade identitet.
  • (valfritt) Principer som hjälper dig att övervaka och hantera tokenförbrukning av Azure OpenAI-API:et.

Så här importerar du ett Azure OpenAI-API till API Management:

  1. I Azure Portal navigerar du till din API Management-instans.

  2. I den vänstra menyn går du till API:er och väljer API:er>+ Lägg till API.

  3. Under Skapa från Azure-resurs väljer du Azure OpenAI Service.

    Skärmbild av att skapa ett API från Azure OpenAI-tjänsten i portalen.

  4. På fliken Grunder:

    1. Välj den Azure OpenAI-resurs som du vill importera.

    2. Du kan också välja en Azure OpenAI API-version. Om du inte väljer någon används den senaste rest-API-versionen i produktion som standard.

    3. Ange ett visningsnamn och en valfri beskrivning för API:et.

    4. I Bas-URL lägger du till en sökväg som din API Management-instans använder för att komma åt Azure OpenAI API-slutpunkterna. Om du aktiverar Se till att OpenAI SDK-kompatibilitet (rekommenderas) /openai läggs automatiskt till i bas-URL:en.

      Om din API Management-gatewayslutpunkt till exempel är https://contoso.azure-api.netanger du en bas-URL som liknar https://contoso.azure-api.net/my-openai-api/openai.

    5. Du kan också välja en eller flera produkter som ska associeras med API:et. Välj Nästa.

  5. På fliken Principer kan du aktivera principer för att övervaka och hantera förbrukning av Azure OpenAI API-token. Om du väljer det anger du inställningar eller accepterar standardvärden som definierar azure-openai-token-limit principerna och azure-openai-emit-token-metric för ditt API. Du kan också ange eller uppdatera principkonfigurationen senare. Välj Granska + skapa.

  6. När inställningarna har verifierats väljer du Skapa.

Alternativ 2. Lägga till en OpenAPI-specifikation i API Management

Alternativt kan du manuellt ladda ned OpenAPI-specifikationen för Azure OpenAI REST API och lägga till den i API Management som ett OpenAPI-API.

Ladda ned OpenAPI-specifikationen

Ladda ned OpenAPI-specifikationen för Azure OpenAI REST API, till exempel 2024-02-01 GA-versionen.

  1. Öppna specifikationsfilen som du laddade ned i en textredigerare.

  2. I elementet servers i specifikationen ersätter du namnet på din Azure OpenAI-tjänstslutpunkt i platshållarvärdena url för och default slutpunkten i specifikationen. Om din Azure OpenAI-tjänstslutpunkt till exempel är contoso.openai.azure.comuppdaterar du elementet servers med följande värden:

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

  3. Anteckna värdet för API version :et i specifikationen. Du behöver det för att testa API:et. Exempel: 2024-02-01.

Lägga till OpenAPI-specifikation i API Management

  1. I Azure Portal navigerar du till din API Management-instans.
  2. I den vänstra menyn väljer du API:er>+ Lägg till API.
  3. Under Definiera ett nytt API väljer du OpenAPI. Ange ett visningsnamn och namn för API:et.
  4. Ange ett API URL-suffix som slutar med /openai att få åtkomst till Azure OpenAI API-slutpunkterna i DIN API Management-instans. Exempel: my-openai-api/openai.
  5. Välj Skapa.

API:et importeras och visar åtgärder från OpenAPI-specifikationen.

Konfigurera autentisering till Azure OpenAI API

Om du vill autentisera till Azure OpenAI API anger du en API-nyckel eller en hanterad identitet. Om du importerade Azure OpenAI API direkt till din API Management-instans konfigureras autentisering med API Management-instansens hanterade identitet automatiskt.

Om du har lagt till Azure OpenAI API från dess OpenAPI-specifikation måste du konfigurera autentisering. Mer information om hur du konfigurerar autentisering med API Management-principer finns i Autentisera och auktorisera till Azure OpenAI API.

Testa Azure OpenAI-API:et

För att säkerställa att ditt Azure OpenAI-API fungerar som förväntat testar du det i API Management-testkonsolen. Du måste ange ett modelldistributions-ID (namn) som konfigurerats i Azure OpenAI-resursen för att testa API:et.

  1. Välj det API som du skapade i föregående steg.

  2. Välj fliken Test.

  3. Välj en åtgärd som är kompatibel med den modell som du distribuerade i Azure OpenAI-resursen. Sidan visar fält för parametrar och rubriker.

  4. I Mallparametrar anger du följande värden:

    • deployment-id – ID för en distribution i Azure OpenAI-tjänsten
    • api-version – en giltig Azure OpenAI API-version, till exempel den API-version som du valde när du importerade API:et. Skärmbild av testning av ett Azure OpenAI-tjänst-API i portalen.

  5. Ange andra parametrar och rubriker efter behov. Beroende på åtgärden kan du behöva konfigurera eller uppdatera en begärandetext.

    Kommentar

    I testkonsolen fyller API Management automatiskt i huvudet Ocp-Apim-Subscription-Key och konfigurerar prenumerationsnyckeln för den inbyggda all-access-prenumerationen. Den här nyckeln ger åtkomst till varje API i API Management-instansen. Du kan också visa huvudet Ocp-Apim-Subscription-Key genom att välja "öga"-ikonen bredvid HTTP-begäran.

  6. Välj Skicka.

    När testet lyckas svarar serverdelen med en lyckad HTTP-svarskod och vissa data. Tillagt i svaret är tokenanvändningsdata som hjälper dig att övervaka och hantera din Azure OpenAI API-förbrukning. Skärmbild av tokenanvändningsdata i API-svar i portalen.

Cachelagringsprinciper för Azure OpenAI-API:er

Förutom de azure-openai-token-limit principer och azure-openai-emit-token-metric principer som du kan konfigurera när du importerar ett Azure OpenAI-tjänst-API tillhandahåller API Management följande cachelagringsprinciper som hjälper dig att optimera prestanda och minska svarstiden för Azure OpenAI-API:er:

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

Relaterat innehåll