Azure OpenAI API'lerini içeri aktarma
UYGULANANLAR: Tüm API Management katmanları
Bu makalede, Bir Azure OpenAI Hizmeti API'sini Azure API Management örneğine REST API olarak içeri aktarmaya yönelik iki seçenek gösterilmektedir:
- Azure OpenAI API'lerini doğrudan Azure OpenAI Hizmetinden içeri aktarma
- Azure OpenAI için OpenAPI belirtimini indirip ekleyin ve API Management'a OpenAPI API'si olarak ekleyin.
Önkoşullar
Mevcut bir API Management örneği. Henüz oluşturmadıysanız bir tane oluşturun.
İstenen Azure aboneliğinde Azure OpenAI'ya erişim verilir. adresinden formu https://aka.ms/oai/accesstamamlayarak Azure OpenAI'ye erişim için başvurabilirsiniz. Sorun yaşıyorsanız bizimle iletişime geçmek için bu depoda bir sorun açın.
Modeli dağıtılan bir Azure OpenAI kaynağı. Model dağıtımı hakkında daha fazla bilgi için bkz. kaynak dağıtım kılavuzu.
Dağıtımın kimliğini (adını) not edin. İçeri aktarılan API'yi API Management'ta test ederken buna ihtiyacınız olacaktır.
API Management örneğinden Azure OpenAI kaynağına erişim izni verme izinleri.
1. Seçenek Azure OpenAI Hizmetinden API'leri içeri aktarma
Azure OpenAI API'sini Doğrudan Azure OpenAI Hizmeti'nden API Management'a aktarabilirsiniz. API'yi içeri aktardığınızda API Management şunları otomatik olarak yapılandırıyor:
- Azure OpenAI REST API uç noktalarının her biri için işlemler.
- Azure OpenAI kaynağına erişmek için gerekli izinlere sahip sistem tarafından atanan kimlik.
- API isteklerini Azure OpenAI Hizmeti uç noktasına yönlendiren bir arka uç kaynağı ve set-backend-service ilkesi.
- Örneğin sistem tarafından atanan kimliğini kullanarak Azure OpenAI kaynağında kimlik doğrulaması yapabilecek bir kimlik doğrulaması yönetilen kimlik ilkesi.
- (isteğe bağlı olarak) Azure OpenAI API'sinin belirteç tüketimini izlemenize ve yönetmenize yardımcı olacak ilkeler.
Azure OpenAI API'sini API Management'a aktarmak için:
Soldaki menüde, API'ler'in altında API'ler>+ API Ekle'yi seçin.
Azure kaynağından oluştur'un altında Azure OpenAI Hizmeti'ne tıklayın.
Temel Bilgiler sekmesinde:
İçeri aktarmak istediğiniz Azure OpenAI kaynağını seçin.
İsteğe bağlı olarak bir Azure OpenAI API sürümü seçin. Seçmezseniz, en son üretime hazır REST API sürümü varsayılan olarak kullanılır.
API için bir Görünen ad ve isteğe bağlı Bir Açıklama girin.
Temel URL'de API Management örneğinizin Azure OpenAI API uç noktalarına erişmek için kullandığı yolu ekleyin. OpenAI SDK uyumluluğunu sağlayın seçeneğini etkinleştirirseniz (önerilen),
/openai
temel URL'ye otomatik olarak eklenir.Örneğin, API Management ağ geçidi uç noktanız ise
https://contoso.azure-api.net
, gibihttps://contoso.azure-api.net/my-openai-api/openai
bir Temel URL ayarlayın.İsteğe bağlı olarak API ile ilişkilendirilecek bir veya daha fazla ürün seçin. İleri'yi seçin.
İlkeler sekmesinde, isteğe bağlı olarak Azure OpenAI API belirteci tüketimini izlemek ve yönetmek için ilkeleri etkinleştirin. Seçiliyse, API'niz için ve
azure-openai-emit-token-metric
ilkelerini tanımlayanazure-openai-token-limit
ayarları girin veya varsayılanları kabul edin. İlke yapılandırmasını daha sonra ayarlayabilir veya güncelleştirebilirsiniz. Gözden geçir + Oluştur’u seçin.Ayarlar doğrulandıktan sonra Oluştur'u seçin.
2. Seçenek API Management'a OpenAPI belirtimi ekleme
Alternatif olarak, Azure OpenAI REST API'si için OpenAPI belirtimini el ile indirin ve bunu OpenAPI API'si olarak API Management'a ekleyin.
OpenAPI belirtimini indirme
Azure OpenAI REST API'si için 2024-02-01 GA sürümü gibi OpenAPI belirtimini indirin.
Bir metin düzenleyicisinde indirdiğiniz belirtim dosyasını açın.
Belirtimdeki
servers
öğesinde, Azure OpenAI Hizmeti uç noktanızın adını belirtimdeki vedefault
uç noktasınınurl
yer tutucu değerleriyle değiştirin. Örneğin, Azure OpenAI Hizmeti uç noktanız isecontoso.openai.azure.com
öğesini aşağıdaki değerlerle güncelleştirinservers
:- Url:
https://contoso.openai.azure.com/openai
- varsayılan uç nokta:
contoso.openai.azure.com
[...] "servers": [ { "url": "https://contoso.openai.azure.com/openai", "variables": { "endpoint": { "default": "contoso.openai.azure.com" } } } ], [...]
- Url:
Api'nin
version
belirtimdeki değerini not edin. API'yi test etmek için buna ihtiyacınız olacaktır. Örnek:2024-02-01
.
API Management'a OpenAPI belirtimi ekleme
- Azure portalında API Management örneğine gidin.
- Sol menüde API'ler>+ API Ekle'yi seçin.
- Yeni API tanımla'nın altında OpenAPI'yi seçin. API için bir Görünen ad ve Ad girin.
- API Management örneğinizdeki Azure OpenAI API uç noktalarına erişmek için ile biten
/openai
bir API URL'si soneki girin. Örnek:my-openai-api/openai
. - Oluştur'u belirleyin.
API içeri aktarılır ve OpenAPI belirtiminden işlemleri görüntüler.
Azure OpenAI API'sinde kimlik doğrulamasını yapılandırma
Azure OpenAI API'sinde kimlik doğrulaması yapmak için bir API anahtarı veya yönetilen kimlik sağlayın. Azure OpenAI API'sini doğrudan API Management örneğine aktardıysanız, API Management örneğinin yönetilen kimliği kullanılarak kimlik doğrulaması otomatik olarak yapılandırılır.
Azure OpenAI API'sini OpenAPI belirtiminden eklediyseniz kimlik doğrulamasını yapılandırmanız gerekir. API Management ilkelerini kullanarak kimlik doğrulamasını yapılandırma hakkında daha fazla bilgi için bkz . Azure OpenAI API'sinde kimlik doğrulaması ve yetkilendirme.
Azure OpenAI API'sini test edin
Azure OpenAI API'nizin beklendiği gibi çalıştığından emin olmak için API Management test konsolunda test edin. API'yi test etmek için Azure OpenAI kaynağında yapılandırılmış bir model dağıtım kimliği (ad) sağlamanız gerekir.
Önceki adımda oluşturduğunuz API’yi seçin.
Test sekmesini seçin.
Azure OpenAI kaynağında dağıttığınız modelle uyumlu bir işlem seçin. Sayfada parametreler ve üst bilgiler için alanlar görüntülenir.
Şablon parametreleri'ne aşağıdaki değerleri girin:
Gerekirse diğer parametreleri ve üst bilgileri girin. İşleme bağlı olarak, bir İstek gövdesini yapılandırmanız veya güncelleştirmeniz gerekebilir.
Not
Test konsolunda API Management otomatik olarak bir Ocp-Apim-Subscription-Key üst bilgisini doldurur ve yerleşik tüm erişimli aboneliğin abonelik anahtarını yapılandırılır. Bu anahtar, API Management örneğindeki her API'ye erişim sağlar. İsteğe bağlı olarak HTTP İsteği'nin yanındaki "göz" simgesini seçerek Ocp-Apim-Subscription-Key üst bilgisini görüntüleyin.
Gönder'i seçin.
Test başarılı olduğunda, arka uç başarılı bir HTTP yanıt kodu ve bazı verilerle yanıt verir. Yanıtın sonuna, Azure OpenAI API tüketiminizi izlemenize ve yönetmenize yardımcı olacak belirteç kullanım verileri eklenir.
Azure OpenAI API'leri için Önbelleğe Alma ilkeleri
API Management, Azure OpenAI Hizmeti API'sini içeri aktarırken yapılandırabileceğiniz ve azure-openai-emit-token-metric
ilkelerine ek olarakazure-openai-token-limit
, Azure OpenAI API'leri için performansı iyileştirmenize ve gecikme süresini azaltmanıza yardımcı olmak için aşağıdaki önbelleğe alma ilkelerini sağlar:
azure-openai-semantic-cache-store
azure-openai-semantic-cache-lookup
İlgili içerik
- API Management ilke başvurusu
- Azure API Management ile merkezi bir özellik olarak Azure OpenAI Hizmeti
- Azure API Management - Azure OpenAI örneği
İlgili konular
- API içeri aktarma sınırlamaları
- OpenAPI belirtimini içeri aktarma
- SOAP API’sini içeri aktarma
- SOAP API'sini içeri aktarma ve REST’e dönüştürme
- App Service API'sini içeri aktarma
- Kapsayıcı Uygulama API'sini içeri aktarma
- WebSocket API'lerini içeri aktarma
- GraphQL API’sini içeri aktarma
- GraphQL şemasını içeri aktarma ve alan çözümleyicilerini ayarlama
- Azure İşlev Uygulamalarını içeri aktarma
- Azure Mantıksal Uygulamalarını içeri aktarma
- Service Fabric hizmetlerini içeri aktarma
- Azure OpenAI API'lerini içeri aktarma
- OData API'sini içeri aktarma
- SAP OData meta verilerini içeri aktarma
- gRPC API'lerini içeri aktarma
- API’yi düzenleme
Geri Bildirim
https://aka.ms/ContentUserFeedback.
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz.Gönderin ve geri bildirimi görüntüleyin