Δημιουργία κώδικα κλήσης για συναρτήσεις δεδομένων χρήστη

Αφού δημοσιεύσετε τις συναρτήσεις δεδομένων χρήστη, μπορείτε να τις καλέσετε από στοιχεία Fabric ή εξωτερικές εφαρμογές. Αντί να γράψετε τον κώδικα κλήσης από την αρχή, χρησιμοποιήστε τη δυνατότητα Δημιουργία κώδικα κλήσης για να δημιουργήσετε αυτόματα έτοιμα προς χρήση πρότυπα κώδικα.

Ορίστε την επιλογή δημιουργίας κώδικα με βάση το σενάριο ενσωμάτωσής σας:

  • Κώδικας σημειωματαρίων Fabric (Python) - Για την κλήση συναρτήσεων μέσα από σημειωματάρια Fabric, που είναι ένας τρόπος ενσωμάτωσης με στοιχεία Fabric. Για άλλα στοιχεία Fabric, όπως Διοχετεύσεις και Ενεργοποιητής, ανατρέξτε στην τεκμηρίωση ενοποίησης.
  • Κώδικας εφαρμογής πελάτη (Python, C#, Node.js) - Για την κλήση των συναρτήσεών σας από εξωτερικές εφαρμογές μέσω του μοναδικού τελικού σημείου REST που εκθέτει κάθε συνάρτηση. Αυτό επιτρέπει την ενοποίηση με εφαρμογές web, υπηρεσίες ή οποιοδήποτε σύστημα εκτός του Fabric.
  • Προδιαγραφή OpenAPI (JSON, YAML) - Για πλατφόρμες διαχείρισης API, πράκτορες AI ή δημιουργία SDK πελατών. Χρησιμοποιήστε το για να ενσωματώσετε τις λειτουργίες σας με τη Διαχείριση API Azure, να ρυθμίσετε τις παραμέτρους συστημάτων AI ή να δημιουργήσετε βιβλιοθήκες για εξωτερικές εφαρμογές.

Προαπαιτούμενα

Πριν δημιουργήσετε κώδικα κλήσης, χρειάζεστε τα εξής:

  • Ένα δημοσιευμένο στοιχείο συναρτήσεων δεδομένων χρήστη με τουλάχιστον μία συνάρτηση
  • Πρόσβαση στο στοιχείο Συναρτήσεις δεδομένων χρήστη στην πύλη Fabric
  • Τουλάχιστον άδεια εκτέλεσης στο στοιχείο Συναρτήσεις δεδομένων χρήστη για τη δημιουργία και χρήση κώδικα κλήσης

Δημιουργία κώδικα για σημειωματάρια Fabric

Κατά την ενοποίηση με στοιχεία Fabric, χρησιμοποιήστε αυτήν την επιλογή για να καλέσετε τις συναρτήσεις σας από σημειωματάρια Fabric. Ο κώδικας που δημιουργείται χρησιμοποιεί το ενσωματωμένο mssparkutils.userDataFunction βοηθητικό πρόγραμμα, το οποίο παρέχει έναν απλό τρόπο επίκλησης λειτουργιών χωρίς διαχείριση ελέγχου ταυτότητας ή τελικών σημείων. Αυτό είναι ιδανικό για ροές εργασιών επεξεργασίας δεδομένων, διερευνητική ανάλυση και διοχετεύσεις μηχανικής εκμάθησης στο περιβάλλον Fabric.

  1. Ανοίξτε το στοιχείο Συναρτήσεις δεδομένων χρήστη στην πύλη Fabric.

  2. Στην Κεντρική καρτέλα, επιλέξτε Δημιουργία κωδικού> κλήσηςΚωδικός προγράμματος-πελάτη.

  3. Στην περιοχή Κλήση από, επιλέξτε Σημειωματάριο από την αναπτυσσόμενη λίστα.

  4. Επιλέξτε το όνομα της συνάρτησης που θέλετε να καλέσετε.

  5. Ο κώδικας δημιουργείται αυτόματα στην Python. (Η Python είναι η μόνη διαθέσιμη γλώσσα για κώδικα κλήσης σημειωματάριου.)

    Στιγμιότυπο οθόνης που εμφανίζει τον κωδικό κλήσης σημειωματαρίων που δημιουργήθηκε.

  6. Αντιγράψτε το απόσπασμα κώδικα που δημιουργήθηκε.

  7. Επικολλήστε το σε ένα νέο κελί στο Σημειωματάριο Fabric.

  8. Ενημερώστε τις παραμέτρους της συνάρτησης με τις πραγματικές τιμές σας. Ο κώδικας που δημιουργείται περιλαμβάνει ένα σχόλιο που δείχνει πού να ενημερώσετε:

    # UPDATE BELOW: Update the request body based on the inputs to your function
    myFunctions.hello_fabric(name = "string")
    
  9. Εκτελέστε το κελί για να καλέσετε τη συνάρτησή σας.

Για περισσότερες πληροφορίες, ανατρέξτε στο θέμα Βοηθητικά προγράμματα λειτουργιών δεδομένων χρήστη σημειωματάριου Fabric.

Δημιουργία κώδικα για εφαρμογές-πελάτες

Κατά την ενοποίηση με εξωτερικές εφαρμογές, χρησιμοποιήστε αυτήν την επιλογή για να καλέσετε τις συναρτήσεις σας μέσω του μοναδικού τελικού σημείου REST που εκθέτει κάθε συνάρτηση. Ο κώδικας που δημιουργείται περιλαμβάνει ρύθμιση ελέγχου ταυτότητας με χρήση του Microsoft Entra ID και χειρίζεται τη ροή αίτησης/απόκρισης HTTP. Αυτό σας δίνει τη δυνατότητα να καλέσετε τις συναρτήσεις Fabric από εφαρμογές web, εφαρμογές για κινητές συσκευές, μικροϋπηρεσίες ή οποιοδήποτε σύστημα εκτός του περιβάλλοντος Fabric.

  1. Ανοίξτε το στοιχείο Συναρτήσεις δεδομένων χρήστη στην πύλη Fabric.

  2. Στην Κεντρική καρτέλα, επιλέξτε Δημιουργία κωδικού> κλήσηςΚωδικός προγράμματος-πελάτη.

  3. Στην περιοχή Κλήση από, επιλέξτε Εφαρμογή προγράμματος-πελάτη από την αναπτυσσόμενη λίστα.

  4. Επιλέξτε το όνομα της συνάρτησης που θέλετε να καλέσετε.

  5. Επιλέξτε τη γλώσσα προγραμματισμού σας:

    • Python
    • C#
    • Node.js

    Στιγμιότυπο οθόνης που δείχνει την έξοδο του κωδικού πελάτη.

  6. Αντιγράψτε τον κώδικα που δημιουργήθηκε και προσθέστε τον στην εφαρμογή σας.

  7. Ελέγξτε τη δομή του κώδικα:

    • Έλεγχος ταυτότητας - Χρησιμοποιείται InteractiveBrowserCredential για την απόκτηση διακριτικού (μόνο για ανάπτυξη/δοκιμή)
    • Διεύθυνση URL τελικού σημείου - Το μοναδικό τελικό σημείο REST για τη συγκεκριμένη λειτουργία σας
    • Σώμα αιτήματος - Περιέχει τις παραμέτρους εισόδου που αναμένει η συνάρτησή σας
  8. Ενημερώστε την ενότητα με τις request_body πραγματικές τιμές παραμέτρων. Ο κώδικας που δημιουργείται περιλαμβάνει ένα σχόλιο που δείχνει πού να ενημερώσετε:

    # UPDATE HERE: Update the request body based on the inputs to your function 
    request_body = {
        "name": "string"
    }
    
  9. Για εφαρμογές παραγωγής, αντικαταστήστε τον κωδικό ελέγχου ταυτότητας με την κατάλληλη καταχώρηση εφαρμογής Microsoft Entra ID. Ο κώδικας που δημιουργείται περιλαμβάνει μια προειδοποίηση και έναν σύνδεσμο προς οδηγίες για τον έλεγχο ταυτότητας παραγωγής.

Για μια πλήρη αναλυτική παρουσίαση, συμπεριλαμβανομένης της ρύθμισης ελέγχου ταυτότητας παραγωγής, ανατρέξτε στην ενότητα Κλήση συναρτήσεων δεδομένων χρήστη από μια εφαρμογή Python.

Δημιουργία προδιαγραφής OpenAPI

Όταν χρειάζεται να ενσωματώσετε τις λειτουργίες σας με πλατφόρμες διαχείρισης API, πράκτορες AI ή να δημιουργήσετε SDK πελατών για εξωτερικές εφαρμογές, χρησιμοποιήστε αυτήν την επιλογή για να δημιουργήσετε μια προδιαγραφή OpenAPI. Η προδιαγραφή OpenAPI παρέχει μια αναγνώσιμη από μηχανή περιγραφή των τελικών σημείων REST της συνάρτησής σας, διευκολύνοντας τα εργαλεία και τα συστήματα να ανακαλύψουν και να ενσωματωθούν με τις λειτουργίες σας μέσω προγραμματισμού.

  1. Ανοίξτε το στοιχείο Συναρτήσεις δεδομένων χρήστη στην πύλη Fabric.

  2. Στην Αρχική καρτέλα, επιλέξτε Δημιουργία προδιαγραφής OpenAPI κωδικού>κλήσης.

  3. Στο παράθυρο διαλόγου Δημιουργία προδιαγραφής OpenAPI , επιλέξτε τη μορφή εξόδου:

    • JSON
    • ΓΙΑΜ

    Στιγμιότυπο οθόνης που εμφανίζει την προδιαγραφή OpenAPI.

  4. Αντιγράψτε την προδιαγραφή που δημιουργήθηκε. Η προδιαγραφή περιλαμβάνει:

    • Όλες οι δημοσιευμένες συναρτήσεις στο στοιχείο Λειτουργίες δεδομένων χρήστη
    • Σχήματα αίτησης και απόκρισης για κάθε συνάρτηση
    • Απαιτήσεις ελέγχου ταυτότητας (διακριτικό κομιστή)
    • Τυπικές αποκρίσεις σφαλμάτων HTTP (400, 401, 403, 408, 413, 500)
    • Περιλήψεις και περιγραφές συναρτήσεων (από docstrings)

Βελτιώστε την έξοδο OpenAPI με docstrings

Η ποιότητα της προδιαγραφής OpenAPI εξαρτάται από την τεκμηρίωση στον κώδικα συνάρτησής σας. Όταν συστήματα όπως το Azure API Management, οι πράκτορες AI ή τα εργαλεία τεκμηρίωσης API καταναλώνουν τις προδιαγραφές OpenAPI, βασίζονται σε σαφείς περιγραφές για να κατανοήσουν τι κάνουν οι λειτουργίες σας.

Η γεννήτρια OpenAPI εξάγει αυτόματα πληροφορίες από τις συμβολοσειρές εγγράφων της συνάρτησής σας. Προσθέστε αυτές τις ιδιότητες στις συναρτήσεις σας για να δημιουργήσετε ολοκληρωμένη τεκμηρίωση API:

  • Περίληψη - Επεξήγηση μίας γραμμής που εμφανίζεται σε καταλόγους API και προβολές υψηλού επιπέδου
  • Περιγραφή - Λεπτομερής επεξήγηση του τι κάνει η συνάρτηση, ποιες εισόδους αναμένει και τι επιστρέφει

Παράδειγμα λειτουργίας με κατάλληλη τεκμηρίωση:

@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, αυτές οι τιμές docstring συμπληρώνουν τα summary πεδία και description στο σχήμα OpenAPI, διευκολύνοντας τους προγραμματιστές και τα συστήματα να κατανοήσουν πώς να χρησιμοποιούν τις συναρτήσεις σας.

Συνήθεις χρήσεις για παραγόμενο κώδικα

Αφού δημιουργήσετε τον κώδικα επίκλησής σας, μπορείτε να τον χρησιμοποιήσετε για να ενσωματώσετε τις συναρτήσεις σας σε διαφορετικά σενάρια:

Ενσωματώσεις αντικειμένων Fabric:

  • Λειτουργίες κλήσεων από σημειωματάρια για επεξεργασία δεδομένων, μηχανική εκμάθηση και διερευνητική ανάλυση
  • Ενορχήστρωση συναρτήσεων σε διοχετεύσεις για ροές εργασιών μετασχηματισμού δεδομένων
  • Ενεργοποιήστε συναρτήσεις από κανόνες ενεργοποιητή ως απόκριση σε συμβάντα σε πραγματικό χρόνο

Ενσωματώσεις εξωτερικών εφαρμογών:

  • Κλήση συναρτήσεων από εφαρμογές ιστού, εφαρμογές για κινητά ή μικροϋπηρεσίες χρησιμοποιώντας κώδικα εφαρμογής προγράμματος-πελάτη
  • Εισαγωγή προδιαγραφών OpenAPI στη Διαχείριση API Azure ή σε άλλες πύλες API για κεντρική διαχείριση
  • Δημιουργήστε SDK πελατών χρησιμοποιώντας το OpenAPI Generator για συνεπή ενοποίηση σε πολλά συστήματα
  • Διαμορφώστε πράκτορες AI για να ανακαλύψουν και να καλέσουν τις συναρτήσεις σας χρησιμοποιώντας την προδιαγραφή OpenAPI
  • Δοκιμάστε και επικυρώστε συναρτήσεις χρησιμοποιώντας εργαλεία όπως το Postman ή το Swagger UI