Azure OpenAI API importálása
A KÖVETKEZŐRE VONATKOZIK: Minden API Management-szint
Ez a cikk két lehetőséget mutat be az Azure OpenAI Service API REST API-ként való importálására egy Azure API Management-példányba:
- Azure OpenAI API importálása közvetlenül az Azure OpenAI szolgáltatásból
- Töltse le és adja hozzá az Azure OpenAI OpenAPI-specifikációját , és adja hozzá az API Managementhez OpenAPI API-ként.
Előfeltételek
Egy meglévő API Management-példány. Hozzon létre egyet, ha még nem tette meg.
Azure OpenAI-erőforrás üzembe helyezett modellel. A modellek üzembe helyezéséről a modellek üzembe helyezésének ismertetőjében talál további információt.
Jegyezze fel az üzembe helyezés azonosítóját (nevét). Szüksége lesz rá, amikor teszteli az importált API-t az API Managementben.
Engedélyek az Azure OpenAI-erőforráshoz való hozzáférés engedélyezéséhez az API Management-példányból.
1. lehetőség: API importálása az Azure OpenAI Szolgáltatásból
Az Azure OpenAI API-t közvetlenül az Azure OpenAI Szolgáltatásból importálhatja az API Managementbe.
Feljegyzés
Ez a funkció jelenleg nem érhető el a munkaterületeken.
Az API importálásakor az API Management automatikusan konfigurálja a következőket:
- Műveletek az Egyes Azure OpenAI REST API-végpontokhoz.
- Rendszer által hozzárendelt identitás az Azure OpenAI-erőforrás eléréséhez szükséges engedélyekkel.
- Háttérerőforrás és set-backend-service szabályzat, amely az API-kéréseket az Azure OpenAI szolgáltatásvégpontra irányítja.
- Hitelesítéssel felügyelt identitásházirend , amely a példány rendszer által hozzárendelt identitásával hitelesíthető az Azure OpenAI-erőforrásban.
- (opcionálisan) Szabályzatok, amelyek segítenek monitorozni és kezelni a jogkivonat-használatot az Azure OpenAI API-val.
Azure OpenAI API importálása az API Managementbe:
Az Azure Portalon keresse meg az API Management-példányt.
A bal oldali menü API-k alatt válassza az API-k>+ API hozzáadása lehetőséget.
Az Azure-erőforrás létrehozása területen válassza az Azure OpenAI-szolgáltatást.
Az Alapszintű beállítások lapon:
Válassza ki az importálni kívánt Azure OpenAI-erőforrást.
Igény szerint válasszon egy Azure OpenAI API-verziót. Ha nem választ egyet, a rendszer alapértelmezés szerint a legújabb éles üzemre kész REST API-verziót használja.
Adja meg az API megjelenítendő nevét és opcionális leírását .
Az alap URL-címben fűzze hozzá az API Management-példány által az Azure OpenAI API-végpontokhoz való hozzáféréshez használt elérési utat. Ha engedélyezi az OpenAI SDK kompatibilitásának biztosítását (ajánlott),
/openai
a rendszer automatikusan hozzáfűzi az alap URL-címet.Ha például az API Management-átjáró végpontja,
https://contoso.azure-api.net
állítsa be a következőhözhttps://contoso.azure-api.net/my-openai-api/openai
hasonló alap URL-címet.Igény szerint válasszon ki egy vagy több, az API-hoz társítandó terméket. Válassza a Tovább lehetőséget.
A Szabályzatok lapon engedélyezheti a szabályzatok számára az Azure OpenAI API-jogkivonat-használat monitorozását és kezelését. Ha be van jelölve, adja meg a beállításokat, vagy fogadja el az
azure-openai-token-limit
API-hoz tartozó szabályzatokat ésazure-openai-emit-token-metric
szabályzatokat meghatározó alapértelmezett beállításokat. A szabályzatkonfigurációt később is beállíthatja vagy frissítheti. Válassza a Felülvizsgálat és létrehozás lehetőséget.A beállítások érvényesítése után válassza a Létrehozás lehetőséget.
2. lehetőség: OpenAPI-specifikáció hozzáadása az API Managementhez
Másik lehetőségként töltse le manuálisan az Azure OpenAI REST API OpenAPI-specifikációját, és adja hozzá az API Managementhez OpenAPI API-ként.
Az OpenAPI specifikációjának letöltése
Töltse le az Azure OpenAI REST API OpenAPI-specifikációját, például a 2024-02-01 GA-verziót.
Egy szövegszerkesztőben nyissa meg a letöltött specifikációs fájlt.
servers
A specifikáció elemében cserélje le az Azure OpenAI-szolgáltatásvégpont nevét a specifikáció helyőrző értékeireurl
ésdefault
végpontjára. Ha például az Azure OpenAI-szolgáltatás végpontja azcontoso.openai.azure.com
, frissítse az elemet aservers
következő értékekkel:- URL-cím:
https://contoso.openai.azure.com/openai
- alapértelmezett végpont:
contoso.openai.azure.com
[...] "servers": [ { "url": "https://contoso.openai.azure.com/openai", "variables": { "endpoint": { "default": "contoso.openai.azure.com" } } } ], [...]
- URL-cím:
Jegyezze fel az API
version
értékét a specifikációban. Az API teszteléséhez szüksége lesz rá. Példa:2024-02-01
OpenAPI-specifikáció hozzáadása az API Managementhez
- Az Azure Portalon keresse meg az API Management-példányt.
- A bal oldali menüben válassza az API-k>+ API hozzáadása lehetőséget.
- Az Új API definiálása területen válassza az OpenAPI lehetőséget. Adja meg az API megjelenítendő nevét és nevét .
- Adjon meg egy API URL-utótagot , amely
/openai
az Azure OpenAI API-végpontok eléréséhez ér véget az API Management-példányban. Példa:my-openai-api/openai
- Válassza a Létrehozás lehetőséget.
Az API importálva van, és az OpenAPI-specifikációból jeleníti meg a műveleteket.
Hitelesítés konfigurálása az Azure OpenAI API-ra
Az Azure OpenAI API hitelesítéséhez meg kell adnia egy API-kulcsot vagy egy felügyelt identitást. Ha az Azure OpenAI API-t közvetlenül az API Management-példányba importálta, a rendszer automatikusan konfigurálja az API Management-példány felügyelt identitását használó hitelesítést.
Ha az Azure OpenAI API-t az OpenAPI-specifikációból adta hozzá, konfigurálnia kell a hitelesítést. A hitelesítés API Management-szabályzatok használatával történő konfigurálásáról további információt az Azure OpenAI API hitelesítése és engedélyezése című témakörben talál.
Az Azure OpenAI API tesztelése
Annak érdekében, hogy az Azure OpenAI API a várt módon működjön, tesztelje azt az API Management tesztkonzolon. Meg kell adnia egy modell üzembehelyezési azonosítóját (nevét) az Azure OpenAI-erőforrásban az API teszteléséhez.
Válassza ki az előző lépésben létrehozott API-t.
Kattintson a Teszt fülre.
Válasszon ki egy olyan műveletet, amely kompatibilis az Azure OpenAI-erőforrásban üzembe helyezett modellel. A lapon a paraméterek és fejlécek mezői láthatók.
A sablonparaméterekben adja meg a következő értékeket:
Szükség szerint adjon meg más paramétereket és fejléceket. A művelettől függően előfordulhat, hogy konfigurálnia vagy frissítenie kell egy kérelemtörzset.
Feljegyzés
A tesztkonzolon az API Management automatikusan feltölt egy Ocp-Apim-Subscription-Key fejlécet, és konfigurálja a beépített teljes hozzáférésű előfizetés előfizetési kulcsát. Ez a kulcs lehetővé teszi az API Management-példány összes API-jának elérését. Az Ocp-Apim-Subscription-Key fejlécet igény szerint a HTTP-kérés melletti "szem" ikonra kattintva jelenítheti meg.
Válassza az Küldés lehetőséget.
Ha a teszt sikeres, a háttérrendszer egy sikeres HTTP-válaszkóddal és néhány adattal válaszol. A válaszhoz hozzáfűzve a jogkivonat-használati adatok segítenek az Azure OpenAI API-használat figyelésében és kezelésében.
Gyorsítótárazási szabályzatok az Azure OpenAI API-khoz
Az Azure OpenAI Service API importálása során konfigurálható szabályzatok mellett azure-openai-emit-token-metric
az azure-openai-token-limit
API Management a következő gyorsítótárazási szabályzatokat is biztosítja az Azure OpenAI API-k teljesítményének optimalizálásához és a késés csökkentéséhez:
azure-openai-semantic-cache-store
azure-openai-semantic-cache-lookup
Kapcsolódó tartalom
- API Management házirend-referencia
- Az Azure OpenAI Szolgáltatás mint központi képesség az Azure API Management használatával
- Azure API Management – Azure OpenAI-minta
Kapcsolódó témakörök
- API-importálási korlátozások
- OpenAPI-specifikáció importálása
- SOAP API importálása
- SOAP API importálása és konvertálása REST-té
- App Service API importálása
- Container App API importálása
- WebSocket API importálása
- GraphQL API-k importálása
- GraphQL-sémák importálása és mezőfeloldók beállítása
- Azure-függvényalkalmazás importálása
- Azure Logic App-alkalmazás importálása
- Service Fabric-szolgáltatás importálása
- Azure OpenAI API importálása
- OData API importálása
- SAP OData-metaadatok importálása
- GRPC API importálása
- API szerkesztése