Kullanıcı Verileri İşlevleri için çağırma kodu oluşturma

Kullanıcı Verileri İşlevlerinizi yayımladıktan sonra, bunları Doku öğelerinden veya dış uygulamalardan çağırabilirsiniz. Çağırma kodunu sıfırdan yazmak yerine çağırma kodu oluştur özelliğini kullanarak otomatik olarak kullanıma hazır kod şablonları oluşturun.

Tümleştirme senaryonuza göre kod oluşturma seçeneğini belirleyin:

  • Doku Not Defterleri kodu (Python) - Doku öğeleriyle tümleştirmenin bir yolu olan Doku Not Defterleri'nin içinden işlevleri çağırmak için. Pipelines ve Activator gibi diğer Fabric öğeleri için entegrasyon belgelerine bakın.
  • İstemci uygulama kodu (Python, C#, Node.js) - İşlevlerinizi dış uygulamalardan çağırmak için her işlevin kullanıma açık olduğu benzersiz REST uç noktası üzerinden. Bu, web uygulamaları, hizmetler veya Doku dışındaki herhangi bir sistemle entegrasyonu etkinleştirir.
  • OpenAPI belirtimi (JSON, YAML) - API yönetim platformları, yapay zeka aracıları veya istemci SDK'ları oluşturma için. İşlevlerinizi Azure API Management ile tümleştirmek, yapay zeka sistemlerini yapılandırmak veya dış uygulamalar için kitaplıklar oluşturmak için bunu kullanın.

Önkoşullar

Çağırma kodu oluşturmadan önce şunları yapmanız gerekir:

  • En az bir işlevi olan yayımlanmış bir Kullanıcı Verileri İşlevleri öğesi
  • Fabric portalında Kullanıcı Verileri İşlevleri öğesine erişim
  • Yürütme izni gereklidir, çağırma kodu oluşturup kullanmak için Kullanıcı Verileri İşlevleri öğesinde en azından.

Kumaş Defterleri için kod oluşturma

Doku öğeleriyle tümleştirme yaparken, doku not defterlerinden işlevlerinizi çağırmak için bu seçeneği kullanın. Oluşturulan kod, kimlik doğrulamasını veya uç noktaları yönetmeden işlevleri çağırmak için basit bir yol sağlayan yerleşik mssparkutils.userDataFunction yardımcı programını kullanır. Bu, Doku ortamındaki veri işleme iş akışları, keşif analizi ve makine öğrenmesi işlem hatları için idealdir.

  1. Fabric portalında sizin Kullanıcı Veri Fonksiyonlarınızı açın.

  2. Giriş sekmesinde çağırma kodu oluştur İstemci kodu'nu> seçin.

  3. Çağır'ın altında açılan listeden Not Defteri'ni seçin.

  4. Çağırmak istediğiniz işlev adını seçin.

  5. Kod Python'da otomatik olarak oluşturulur. (Python, not defteri çağırma kodu için kullanılabilen tek dildir.)

    Oluşturulan Not Defterleri çağırma kodunu gösteren ekran görüntüsü.

  6. Oluşturulan kod parçacığını kopyalayın.

  7. Fabric Notebook'unuzdaki yeni bir hücreye yapıştırın.

  8. İşlev parametrelerini gerçek değerlerinizle güncelleştirin. Oluşturulan kod, güncelleştirilecek yeri gösteren bir açıklama içerir:

    # UPDATE BELOW: Update the request body based on the inputs to your function
myFunctions.hello_fabric(name = "string")

  9. İşlevinizi çağırmak için hücreyi çalıştırın.

Daha fazla bilgi için bkz. Doku Not Defteri Yardımcı Programlar: Kullanıcı Verileri Fonksiyonları.

İstemci uygulamaları için kod oluşturma

Dış uygulamalarla tümleştirme yaparken, işlevlerinizi her işlevin kullanıma açık olduğu benzersiz REST uç noktası aracılığıyla çağırmak için bu seçeneği kullanın. Oluşturulan kod, Microsoft Entra Kimliği kullanılarak kimlik doğrulaması kurulumunu içerir ve HTTP isteği/yanıt akışını işler. Bu, Doku işlevlerinizi web uygulamalarından, mobil uygulamalardan, mikro hizmetlerden veya Doku ortamının dışındaki herhangi bir sistemden çağırmanızı sağlar.

  1. Fabric portalında sizin Kullanıcı Veri Fonksiyonlarınızı açın.

  2. Giriş sekmesinde çağırma kodu oluştur İstemci kodu'nu> seçin.

  3. Çalıştırma kaynağı olarak, açılan listeden İstemci uygulaması seçin.

  4. Çağırmak istediğiniz işlev adını seçin.

  5. Programlama dilinizi seçin:

    • Python
    • C#
    • Node.js

    İstemci kodu çıkışını gösteren ekran görüntüsü.

  6. Oluşturulan kodu kopyalayın ve uygulamanıza ekleyin.

  7. Kod yapısını gözden geçirin:

    • Kimlik Doğrulaması - InteractiveBrowserCredential kullanarak bir belirteç alır (yalnızca geliştirme/test için)
    • Uç Nokta URL'si - Özel işleviniz için benzersiz REST uç noktası
    • İstek gövdesi - İşlevinizin beklediği giriş parametrelerini içerir

  8. request_body Bölümünü gerçek parametre değerlerinizle güncelleştirin. Oluşturulan kod, güncelleştirilecek yeri gösteren bir açıklama içerir:

    # UPDATE HERE: Update the request body based on the inputs to your function 
request_body = {
    "name": "string"
}

  9. Üretim uygulamaları için kimlik doğrulama kodunu uygun Microsoft Entra ID uygulama kaydıyla değiştirin. Oluşturulan kod bir uyarı ve üretim kimlik doğrulaması yönergelerine bağlantı içerir.

Üretim kimlik doğrulaması kurulumu da dahil olmak üzere tam bir izlenecek yol için bkz. Python uygulamasından Kullanıcı Verileri İşlevlerini Çağırma.

OpenAPI belirtimi oluşturma

İşlevlerinizi API yönetim platformlarıyla, yapay zeka aracılarıyla tümleştirmeniz veya dış uygulamalar için istemci SDK'ları oluşturmanız gerektiğinde, openAPI belirtimi oluşturmak için bu seçeneği kullanın. OpenAPI belirtimi, işlevinizin REST uç noktalarının makine tarafından okunabilir bir açıklamasını sağlayarak araçların ve sistemlerin işlevlerinizi program aracılığıyla keşfetmesini ve tümleştirmesini kolaylaştırır.

  1. Fabric portalında sizin Kullanıcı Veri Fonksiyonlarınızı açın.

  2. Ana Sayfa sekmesinde Çağırma kodu oluştur>OpenAPI belirtimini seçin.

  3. OpenAPI belirtimi oluştur iletişim kutusunda çıkış biçiminizi seçin:

    • JSON
    • YAML

    OpenAPI belirtimini gösteren ekran görüntüsü.

  4. Oluşturulan spesifikasyonu kopyalayın. Belirtim şunları içerir:

    • Kullanıcı Verileri İşlevleri öğesindeki tüm yayımlanan işlevler
    • Her işlev için istek ve yanıt şemaları
    • Kimlik doğrulama gereksinimleri (taşıyıcı belirteci)
    • Standart HTTP hata yanıtları (400, 401, 403, 408, 413, 500)
    • İşlev özetleri ve açıklamaları (docstrings'ten)

Docstrings ile OpenAPI çıktısını geliştirme

OpenAPI belirtiminizin kalitesi, işlev kodunuzdaki belgelere bağlıdır. Azure API Management, AI aracıları veya API belge araçları gibi sistemler OpenAPI belirtiminizi tükettiğinde, işlevlerinizin ne yaptığını anlamak için açık açıklamalardan yararlanırlar.

OpenAPI oluşturucu, işlev belgelerinizdeki bilgileri otomatik olarak ayıklar. Kapsamlı API belgeleri oluşturmak için işlevlerinize şu özellikleri ekleyin:

  • Özet - API kataloglarında ve üst düzey görünümlerde görünen tek satırlık açıklama
  • Açıklama - İşlevin ne yaptığını, hangi girişleri beklediğini ve ne döndürdüğüne ilişkin ayrıntılı açıklama

Uygun belgelere sahip örnek işlev:

@udf.function()
def hello_fabric(name: str) -> str:
    """
    Summary: A Python function that prints your name and the time.
    Description: This function takes a string input and concatenates it with the current time 
    to give you a warm welcome to User Data Functions. Returns a string and provides a log entry.
    """
    logging.info('Python UDF trigger function processed a request.')
    return f"Welcome to Fabric Functions, {name}, at {datetime.datetime.now()}!"

OpenAPI belirtimini oluşturduğunuzda, bu docstring değerleri OpenAPI şemasındaki summary ve description alanlarını doldurarak geliştiricilerin işlevlerinizi nasıl kullanacaklarını anlamalarını kolaylaştırır.

Oluşturulan kod için yaygın kullanımlar

Çağırma kodunuzu oluşturduktan sonra işlevlerinizi farklı senaryolarla tümleştirmek için kullanabilirsiniz:

Doku öğesi tümleştirmeleri:

  • Veri işleme, makine öğrenmesi ve keşif analizi için Not Defterleri'nden işlevleri çağırma
  • Veri dönüştürme iş akışları için işlem hatlarında işlevleri düzenleme
  • Gerçek zamanlı olaylara yanıt olarak Etkinleştirici kurallarından işlevleri tetikleme

Dış uygulama tümleştirmeleri:

  • İstemci uygulama kodunu kullanarak web uygulamalarından, mobil uygulamalardan veya mikro hizmetlerden işlevleri çağırma
  • OpenAPI belirtimlerini merkezi yönetim için Azure API Management'a veya diğer API ağ geçitlerine aktarma
  • Birden çok sistem arasında tutarlı tümleştirme için OpenAPI Oluşturucu kullanarak istemci SDK'ları oluşturma
  • OpenAPI belirtimini kullanarak işlevlerinizi keşfetmek ve çağırmak için yapay zeka aracılarını yapılandırma
  • Postman veya Swagger kullanıcı arabirimi gibi araçları kullanarak işlevleri test edin ve doğrulayın

İlgili içerik

  • Last updated on