Felhasználói adatfunkciók meghívási kódjának generálása

Miután közzétette a Felhasználói adatokkal kapcsolatos függvényeket, meghívhatja őket Fabric elemekből vagy külső alkalmazásokból. Ahelyett, hogy a meghívási kódot az alapoktól írta, a Híváskód létrehozása funkcióval automatikusan létrehozhat használatra kész kódsablonokat.

Az integrációs forgatókönyv alapján válassza ki a kódgenerálási lehetőséget:

  • Fabric Notebooks-kód (Python) – Függvények beírására a Fabric Notebooksban, amely az egyik módja a Fabric-elemek integrálásának. Más Fabric-elemek, például a Pipeline-ok és az Activator esetében lásd az integrációs dokumentációt.
  • Ügyfélalkalmazás kódja (Python, C#, Node.js) – A függvények külső alkalmazásokból való meghívásához az egyes függvények által elérhetővé tett egyedi REST-végponton keresztül. Ez lehetővé teszi a webalkalmazásokkal, szolgáltatásokkal vagy a Fabricen kívüli rendszerekkel való integrációt.
  • OpenAPI-specifikáció (JSON, YAML) – API felügyeleti platformokhoz, AI-ügynökökhöz vagy ügyféloldali SDK-k létrehozásához. Ezzel integrálhatja a függvényeket az Azure API Managementtel, konfigurálhatja az AI-rendszereket, vagy kódtárakat hozhat létre külső alkalmazásokhoz.

Előfeltételek

A meghívási kód létrehozása előtt a következőkre van szüksége:

  • Közzétett Felhasználói adatfüggvények elem legalább egy függvénnyel
  • Hozzáférés a User Data Functions elemhez a Háló portálon
  • Legalább végrehajtási engedély a User Data Functions elemen a meghívási kód létrehozásához és használatához

Kód létrehozása Fabric jegyzetfüzetekhez

Ha a Fabric-elemekkel integrál, ezzel a beállítással meghívhatja a függvényeket a Hálójegyzetfüzetekből. A létrehozott kód a beépített mssparkutils.userDataFunction segédprogramot használja, amely egyszerű módot kínál a függvények meghívására hitelesítés vagy végpontok kezelése nélkül. Ez ideális adatfeldolgozási munkafolyamatokhoz, feltáró elemzésekhez és gépi tanulási folyamatokhoz a Fabric-környezetben.

  1. Nyissa meg a Felhasználói Adatfunkciók elemet a Fabric portálon.

  2. A Kezdőlap lapon válassza a Híváskód létrehozása ügyfélkód> létrehozása lehetőséget.

  3. A Hívás innen csoportban válassza a Jegyzetfüzet lehetőséget a legördülő listában.

  4. Válassza ki a meghívni kívánt függvénynevet.

  5. A kód automatikusan létrejön a Pythonban. (A Python az egyetlen elérhető nyelv a jegyzetfüzet-hívási kódhoz.)

    Képernyőkép a létrehozott Jegyzetfüzetek meghívási kódról.

  6. Másolja ki a létrehozott kódrészletet.

  7. Illessze be egy új cellába a Fabric Notebookban.

  8. Frissítse a függvényparamétereket a tényleges értékekkel. A létrehozott kód egy megjegyzést tartalmaz, amely bemutatja, hogy hol kell frissíteni:

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

  9. Futtassa a cellát a függvény meghívásához.

További információ: Fabric Notebook User Data Functions segédprogramok.

Kód létrehozása ügyfélalkalmazásokhoz

Ha külső alkalmazásokkal integrál, ezzel a beállítással meghívhatja a függvényeket az egyes függvények által elérhető egyedi REST-végponton keresztül. A létrehozott kód tartalmazza a Microsoft Entra-azonosítót használó hitelesítést, és kezeli a HTTP-kérések/válaszok folyamatát. Ez lehetővé teszi a Fabric-függvények meghívását webalkalmazásokból, mobilalkalmazásokból, mikroszolgáltatásokból vagy a Fabric-környezeten kívüli rendszerekből.

  1. Nyissa meg a Felhasználói Adatfunkciók elemet a Fabric portálon.

  2. A Kezdőlap lapon válassza a Híváskód létrehozása ügyfélkód> létrehozása lehetőséget.

  3. A Meghívás innen csoportban válassza az Ügyfélalkalmazás lehetőséget a legördülő listában.

  4. Válassza ki a meghívni kívánt függvénynevet.

  5. Válassza ki a programozási nyelvet:

    • Python
    • C#
    • Node.js

    Képernyőkép az ügyfélkód kimenetéről.

  6. Másolja ki a létrehozott kódot, és adja hozzá az alkalmazáshoz.

  7. Tekintse át a kód struktúráját:

    • Hitelesítés – Jogkivonat beszerzésére használ InteractiveBrowserCredential (csak fejlesztéshez/teszteléshez)
    • Végpont URL-címe – Az adott függvény egyedi REST-végpontja
    • Kérelem törzse – A függvény által várt bemeneti paramétereket tartalmazza

  8. Frissítse a szakaszt request_body a tényleges paraméterértékekkel. A létrehozott kód egy megjegyzést tartalmaz, amely bemutatja, hogy hol kell frissíteni:

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

  9. Éles alkalmazások esetén cserélje le a hitelesítési kódot a Microsoft Entra ID alkalmazás regisztrációjára. A létrehozott kód tartalmaz egy figyelmeztetést és egy hivatkozást a produktív hitelesítésre vonatkozó útmutatáshoz.

A teljes útmutatót, beleértve az éles környezetbeli hitelesítés beállítását, lásd: Felhasználói adatfüggvények meghívása Python-alkalmazásból.

OpenAPI-specifikáció létrehozása

Ha a függvényeket API felügyeleti platformokkal, AI-ügynökökkel vagy ügyféloldali SDK-k külső alkalmazásokhoz való létrehozásához szeretné integrálni, ezzel a beállítással hozzon létre egy OpenAPI-specifikációt. Az OpenAPI specifikáció gépileg olvasható leírást nyújt a függvény REST-végpontjairól, így az eszközök és rendszerek könnyen felderíthetik és integrálhatók a függvényekkel programozott módon.

  1. Nyissa meg a Felhasználói Adatfunkciók elemet a Fabric portálon.

  2. A Kezdőlap lapon válassza a Híváskód> létrehozásaOpenAPI-specifikáció lehetőséget.

  3. Az OpenAPI-specifikáció létrehozása párbeszédpanelen válassza ki a kimeneti formátumot:

    • JSON
    • YAML

    Képernyőkép az OpenAPI specifikációról.

  4. Másolja ki a létrehozott specifikációt. A specifikáció a következőket tartalmazza:

    • A Felhasználói adatfüggvények elem összes közzétett függvénye
    • Kérelem- és válaszsémák az egyes függvényekhez
    • Hitelesítési követelmények (tulajdonosi jogkivonat)
    • Standard HTTP-hibaválaszok (400, 401, 403, 408, 413, 500)
    • Függvényösszesítések és leírások (dokumentumokból)

Az OpenAPI-kimenet javítása docstrings használatával

Az OpenAPI-specifikáció minősége a függvénykód dokumentációjától függ. Amikor az Olyan rendszerek, mint az Azure API Management, az AI-ügynökök vagy az API dokumentációs eszközei az OpenAPI-specifikációt használják, egyértelmű leírásokra támaszkodnak a függvények működésének megértéséhez.

Az OpenAPI-generátor automatikusan kinyeri az információkat a függvények dokumentumaiból. Adja hozzá ezeket a tulajdonságokat a függvényekhez az átfogó API-dokumentáció létrehozásához:

  • Összefoglalás – Az API-katalógusokban és a magas szintű nézetekben megjelenő egysoros magyarázat
  • Leírás – Részletes magyarázat a függvény működéséről, a várt bemenetekről és a visszaadott adatokról

Példa egy megfelelően dokumentált függvényre:

@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()}!"

Az OpenAPI-specifikáció létrehozásakor ezek a dokumentumírási értékek kitöltik az summary OpenAPI-séma mezőit és description mezőit, így a fejlesztők és a rendszerek könnyebben megérthetik a függvények használatát.

A generált kód gyakori felhasználási módjai

Miután létrehozta a meghívási kódot, használhatja a függvények különböző forgatókönyvekbe való integrálására:

Hálóelem-integrációk:

  • Jegyzetfüzetekből függvények hívása adatfeldolgozáshoz, gépi tanuláshoz és elemzéshez.
  • Függvények vezénylése Pipeline-ekben adatátalakítási munkafolyamatokhoz
  • Activator-szabályok alapján funkciók kiváltása valós idejű eseményekre reagálva

Külső alkalmazásintegrációk:

  • Függvények meghívása webalkalmazásokból, mobilalkalmazásokból vagy mikroszolgáltatásokból ügyfélalkalmazás-kód használatával
  • OpenAPI-specifikációk importálása az Azure API Managementbe vagy más API-átjárókba központosított felügyelet céljából
  • Ügyféloldali SDK-k létrehozása az OpenAPI Generator használatával a több rendszer közötti konzisztens integráció érdekében
  • Az AI-ügynökök konfigurálása a függvények felderítésére és meghívására az OpenAPI-specifikáció használatával
  • Függvények tesztelése és ellenőrzése olyan eszközökkel, mint a Postman vagy a Swagger felhasználói felülete

Kapcsolódó tartalom

  • Last updated on