Azure OpenAI API'sini REST API olarak içeri aktarma

UYGULANANLAR: Tüm API Management katmanları

Foundry Modellerinde Azure OpenAI'de dağıtılan yapay zeka modeli uç noktalarını API Management örneğinize REST API olarak aktarabilirsiniz. Tümleştirmeyi basitleştirmek, gözlemlenebilirliği geliştirmek ve model uç noktaları üzerinde denetimi geliştirmek için API Management'taki yapay zeka ağ geçidi ilkelerini ve diğer özellikleri kullanın.

Bu makalede, Azure OpenAI API'sini Bir Azure API Management örneğine REST API olarak içeri aktarmaya yönelik iki seçenek gösterilmektedir:

API Management'ta LLM API'lerini yönetme hakkında daha fazla bilgi edinin:

Önkoşullar

  • Mevcut bir API Management örneği. Henüz oluşturmadıysanız bir tane oluşturun.

  • (Microsoft Foundry'den içeri aktarma için) Azure OpenAI modeli dağıtılan bir Microsoft Foundry projesi. Azure OpenAI'de model dağıtımı hakkında daha fazla bilgi için kaynak dağıtım kılavuzuna bakın.

    Dağıtımın kimlik numarasını (adını) kaydedin. İçeri aktarılan API'yi API Management'ta test ederken buna ihtiyacınız vardır.

  • API Management örneğinden Azure OpenAI kaynağına erişim izni verme izinleri.

1. Seçenek Microsoft Foundry'den OpenAI API'sini içeri aktarma

Azure OpenAI model dağıtımlarını doğrudan Microsoft Foundry'den API Management'a aktarabilirsiniz. Ayrıntılar için bkz. Microsoft Foundry API'sini içeri aktarma.

API'yi içeri aktardığınızda:

  • Azure OpenAI model dağıtımını barındıran Microsoft Foundry hizmetini belirtin.
  • Azure OpenAI istemci uyumluluğu seçeneğini belirtin. Bu seçenek API Management API'sini bir /openai uç noktayla yapılandırıyor.

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-10-21 GA sürümü gibi OpenAPI belirtimini indirin.

  1. Bir metin düzenleyicisinde indirdiğiniz belirtim dosyasını açın.

  2. Belirlemedeki servers öğesinde, url ve default uç noktalarının yer tutucu değerlerine Azure OpenAI uç noktanızın adını ekleyin. Örneğin, Azure OpenAI uç noktanız ise contoso.openai.azure.comöğesini aşağıdaki değerlerle güncelleştirin servers :

    • 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"
            }
          }
        }
      ],
    [...]
    
  3. API'nin spesifikasyondaki değerini not edin. API'yi test etmek için buna ihtiyacınız vardır. Örnek: 2024-10-21.

API Management'a OpenAPI belirtimi ekleme

  1. Azure portalında API Management örneğine gidin.
  2. Sol menüde API'ler> Ekle'yi seçin.
  3. Yeni API tanımla'nın altında OpenAPI'yi seçin. API için bir Görünen ad ve Ad girin.
  4. API Management örneğinizdeki Azure OpenAI API uç noktalarına erişmek için, API URL eki/openai ile biten bir URL girin. Örneğin: my-openai-api/openai.
  5. Oluştur'u belirleyin.

API Management, API'yi içeri aktarı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ı sağlayın veya yönetilen kimlik kullanın. Azure OpenAI API'sini doğrudan Microsoft Foundry'den içeri 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. LLM API'lerinin kimliğini doğrulama 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 Microsoft Foundry proje kaynağında ve API sürümünde yapılandırdığınız bir model dağıtım kimliği (ad) sağlamanız gerekir.

  1. Önceki adımda oluşturduğunuz API’yi seçin.

  2. Test sekmesini seçin.

  3. 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.

  4. Şablon parametreleri'ne aşağıdaki değerleri girin:

    • deployment-id - Microsoft Foundry'de Azure OpenAI modeli dağıtımının kimliği
    • api-version - API'yi içeri aktarırken seçtiğiniz API sürümü gibi geçerli bir Azure OpenAI API sürümü. Portalda Azure OpenAI API'sini test etme işleminin ekran görüntüsü.
  5. Gerekirse diğer parametreleri ve üst bilgileri girin. İşleme ve modele bağlı olarak, bir İstek gövdesini yapılandırmanız veya güncelleştirmeniz gerekebilir. Örneğin, sohbet tamamlama işlemi için temel bir istek gövdesi aşağıda verilmiştir:

    {
      "model": "any",
      "messages": [
        {
          "role": "user",
          "content": "Help me plan a vacation trip to Paris."
        }
      ],
      "max_tokens": 100
    }
    

    Not

    Test konsolunda API Management otomatik olarak bir Ocp-Apim-Subscription-Key üst bilgisi ekler ve yerleşik tüm erişimli abonelik için abonelik anahtarını ayarlar. Bu anahtar, API Management örneğindeki her API'ye erişim sağlar. İsteğe bağlı olarak Ocp-Apim-Subscription-Key üst bilgisini görüntülemek için HTTP İsteği'nin yanındaki "göz" simgesini seçin.

  6. 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, Azure OpenAI API belirteci tüketiminizi izlemenize ve yönetmenize yardımcı olacak belirteç kullanım verilerini içerir.

    Portaldaki API yanıtında belirteç kullanım verilerinin ekran görüntüsü.