Delen via

Aanroepcode genereren voor gebruikersgegevensfuncties

Zodra u uw functies voor gebruikersgegevens hebt gepubliceerd, kunt u ze aanroepen vanuit Fabric-items of externe toepassingen. In plaats van de aanroepcode helemaal zelf te schrijven, gebruikt u de functie Aanroepcode genereren om automatisch kant-en-klare codesjablonen te maken.

Kies de optie voor het genereren van code op basis van uw integratiescenario:

  • Fabric Notebooks-code (Python) - Voor het aanroepen van functies vanuit Fabric Notebooks, wat een manier is om te integreren met Fabric-items. Zie de integratiedocumentatie voor andere Fabric-items, zoals Pipelines en Activator.
  • Clienttoepassingscode (Python, C#, Node.js) - Voor het aanroepen van uw functies vanuit externe toepassingen via het unieke REST-eindpunt dat elke functie beschikbaar maakt. Dit maakt integratie mogelijk met web-apps, services of een systeem buiten Fabric.
  • OpenAPI-specificatie (JSON, YAML): voor API-beheerplatformen, AI-agents of het genereren van client-SDK's. Gebruik dit om uw functies te integreren met Azure API Management, AI-systemen te configureren of bibliotheken te genereren voor externe toepassingen.

Vereiste voorwaarden

Voordat u aanroepcode genereert, hebt u het volgende nodig:

  • Een gepubliceerd item User Data Functions met ten minste één functie
  • Toegang tot het item User Data Functions in de Fabric-portal
  • Ten minste machtiging uitvoeren voor het item User Data Functions om aanroepcode te genereren en te gebruiken

Code genereren voor Fabric Notebooks

Wanneer u Fabric-items integreert, gebruikt u deze optie om uw functies aan te roepen vanuit Fabric Notebooks. De gegenereerde code maakt gebruik van het ingebouwde mssparkutils.userDataFunction hulpprogramma, dat een eenvoudige manier biedt om functies aan te roepen zonder verificatie of eindpunten te beheren. Dit is ideaal voor gegevensverwerkingswerkstromen, verkennende analyses en machine learning-pijplijnen binnen de Fabric-omgeving.

  1. Open het item User Data Functions in de Fabric-portal.

  2. Selecteer op het tabblad Start, Genereren van aanroepcode> en Clientcode.

  3. Selecteer Notebook in de vervolgkeuzelijst onder Aanroepen vanuit.

  4. Selecteer de functienaam die u wilt aanroepen.

  5. De code wordt automatisch gegenereerd in Python. (Python is de enige taal die beschikbaar is voor aanroepcode voor notebooks.)

    Schermopname van de gegenereerde aanroepcode voor notebooks.

  6. Kopieer het gegenereerde codefragment.

  7. Plak deze in een nieuwe cel in uw Fabric Notebook.

  8. Werk de functieparameters bij met uw werkelijke waarden. De gegenereerde code bevat een opmerking die laat zien waar u het volgende moet bijwerken:

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

  9. Voer de cel uit om uw functie aan te roepen.

Zie hulpprogramma's voor gebruikersgegevensfuncties voor Fabric Notebook voor meer informatie.

Code genereren voor clienttoepassingen

Wanneer u integreert met externe toepassingen, gebruikt u deze optie om uw functies aan te roepen via het unieke REST-eindpunt dat elke functie beschikbaar maakt. De gegenereerde code bevat verificatie-instellingen met behulp van Microsoft Entra-id en verwerkt de HTTP-aanvraag-/antwoordstroom. Hiermee kunt u uw Fabric-functies aanroepen vanuit web-apps, mobiele apps, microservices of een systeem buiten de Fabric-omgeving.

  1. Open het item User Data Functions in de Fabric-portal.

  2. Selecteer op het tabblad Start de optie Aanroepcode genereren>Clientcode.

  3. Selecteer onder Aanroepen vanuitde clienttoepassing in de vervolgkeuzelijst.

  4. Selecteer de functienaam die u wilt aanroepen.

  5. Kies uw programmeertaal:

    • Python
    • C#
    • Node.js

    Schermopname van de uitvoer van de clientcode.

  6. Kopieer de gegenereerde code en voeg deze toe aan uw toepassing.

  7. Controleer de codestructuur:

    • Verificatie : wordt gebruikt InteractiveBrowserCredential om een token te verkrijgen (alleen voor ontwikkeling/testen)
    • Eindpunt-URL: het unieke REST-eindpunt voor uw specifieke functie
    • Aanvraagbody : bevat de invoerparameters die uw functie verwacht

  8. Werk de request_body sectie bij met de werkelijke parameterwaarden. De gegenereerde code bevat een opmerking die laat zien waar u het volgende moet bijwerken:

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

  9. Voor productietoepassingen vervangt u de verificatiecode door de juiste registratie van de Microsoft Entra ID-toepassing. De gegenereerde code bevat een waarschuwing en een koppeling naar richtlijnen voor productieverificatie.

Zie Gebruikersgegevensfuncties aanroepen vanuit een Python-toepassing voor een volledige stap-voor-stap handleiding, inclusief het instellen van productieverificatie.

OpenAPI-specificatie genereren

Wanneer u uw functies wilt integreren met API Management-platforms, AI-agents of client-SDK's voor externe toepassingen wilt genereren, gebruikt u deze optie om een OpenAPI-specificatie te maken. De OpenAPI-specificatie biedt een machineleesbare beschrijving van de REST-eindpunten van uw functie, waardoor hulpprogramma's en systemen eenvoudig programmatisch kunnen worden gedetecteerd en geïntegreerd met uw functies.

  1. Open het item User Data Functions in de Fabric-portal.

  2. Selecteer op het tabblad Start de optie Aanroepcode genereren>OpenAPI-specificatie.

  3. Selecteer uw uitvoerindeling in het dialoogvenster OpenAPI-specificatie genereren :

    • JSON
    • YAML

    Schermopname van de OpenAPI-specificatie.

  4. Kopieer de gegenereerde specificatie. De specificatie omvat:

    • Alle gepubliceerde functies in het item User Data Functions
    • Schema's voor aanvragen en antwoorden voor elke functie
    • Verificatievereisten (bearer-token)
    • Standaard HTTP-foutreacties (400, 401, 403, 408, 413, 500)
    • Functieoverzichten en -beschrijvingen (uit docstrings)

De OpenAPI-uitvoer verbeteren met docstrings

De kwaliteit van uw OpenAPI-specificatie is afhankelijk van de documentatie in uw functiecode. Wanneer systemen zoals Azure API Management, AI-agents of API-documentatiehulpprogramma's uw OpenAPI-specificatie gebruiken, zijn ze afhankelijk van duidelijke beschrijvingen om te begrijpen wat uw functies doen.

De OpenAPI-generator extraheert automatisch informatie uit uw functie-docstrings. Voeg deze eigenschappen toe aan uw functies om uitgebreide API-documentatie te maken:

  • Samenvatting : uitleg van één regel die wordt weergegeven in API-catalogi en weergaven op hoog niveau
  • Beschrijving - Gedetailleerde uitleg van wat de functie doet, welke invoer wordt verwacht en wat deze retourneert

Voorbeeldfunctie met de juiste documentatie:

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

Wanneer u de OpenAPI-specificatie genereert, vullen deze docstringwaarden de summary en description velden in het OpenAPI-schema, zodat ontwikkelaars en systemen gemakkelijker inzicht kunnen hebben in het gebruik van uw functies.

Algemene toepassingen voor gegenereerde code

Nadat u uw aanroepcode hebt gegenereerd, kunt u deze gebruiken om uw functies te integreren in verschillende scenario's:

Integraties van infrastructuuritems:

  • Functies uit notebooks aanroepen voor gegevensverwerking, machine learning en verkennende analyse
  • Funcies orkestreren in pijplijnen voor data-transformatiewerkstromen
  • Triggerfuncties van Activator-regels als reactie op realtimegebeurtenissen

Integraties van externe toepassingen:

  • Functies aanroepen vanuit web-apps, mobiele apps of microservices met behulp van clienttoepassingscode
  • OpenAPI-specificaties importeren in Azure API Management of andere API-gateways voor gecentraliseerd beheer
  • Client-SDK's genereren met behulp van OpenAPI Generator voor consistente integratie in meerdere systemen
  • AI-agents configureren om uw functies te detecteren en aan te roepen met behulp van de OpenAPI-specificatie
  • Functies testen en valideren met hulpprogramma's zoals Postman of Swagger UI

Verwante inhoud

  • Last updated on