Επισκόπηση API σύνοψης δεδομένων (έκδοση προεπισκόπησης)
[Αυτό το άρθρο αποτελεί τεκμηρίωση προέκδοσης και ενδέχεται να αλλάξει.]
Το API σύνοψης Power Pages επιτρέπει στους δημιουργούς μια σύνοψη περιεχομένου σελίδας χρησιμοποιώντας παραγωγική AI που βοηθά τους χρήστες της τοποθεσίας να έχουν μια επισκόπηση χωρίς να επισκέπτονται ολόκληρη τη σελίδα. Το API έχει δημιουργηθεί με βάση το Web API Power Pages που παρέχει σύνοψη δεδομένων σε Dataverse πίνακες που χρησιμοποιούνται στις σελίδες.
Σημαντικό
- Αυτή είναι μια δυνατότητα προεπισκόπησης.
- Οι λειτουργίες προεπισκόπησης δεν προορίζονται για παραγωγική χρήση και ενδέχεται να έχουν περιορισμένη λειτουργικότητα. Αυτές οι δυνατότητες υπόκεινται στους συμπληρωματικούς όρους χρήσης και είναι διαθέσιμες πριν την επίσημη κυκλοφορία ώστε οι πελάτες να έχουν πρόσβαση από νωρίς και να κάνουν σχόλια.
Προϋποθέσεις
Πρέπει να ενεργοποιήσετε τις ρυθμίσεις τοποθεσίας για το Web API.
Μόνο οι πίνακες που υποστηρίζονται για το Web API σελίδων είναι διαθέσιμοι για σύνοψη. Μάθετε περισσότερα σχετικά με το Web API σελίδων στην Επισκόπηση Web API.
Η δυνατότητα δεν είναι διαθέσιμη σε Cloud Δημόσιες Κοινότητες (GCC), σε Cloud Δημόσιες Κοινότητες - High (GCC High) ή στο Υπουργείο Άμυνας (DoD).
Ρυθμίσεις τοποθεσίας
Ενεργοποιήστε τις σελίδες στο web API και ορίστε ρυθμίσεις τοποθεσίας για τη δυνατότητα API σύνοψης.
Όνομα ρύθμισης τοποθεσίας | Περιγραφή |
---|---|
Σύνοψη/Δεδομένα/Ενεργοποίηση | Ενεργοποιεί ή απενεργοποιεί τη δυνατότητα σύνοψης. Προεπιλογή: False Έγκυρες τιμές: True, False |
Σύνοψη/προτροπή/{any_identifier} | Χρησιμοποιήστε αυτές τις ρυθμίσεις για να δώσετε οποιαδήποτε οδηγία για σύνοψη Τύπος: συμβολοσειρά Παράδειγμα: Όνομα: Σύνοψη/προτροπή/case_summary Τιμή: Σύνοψη βασικών λεπτομερειών και κρίσιμων πληροφοριών |
Σύνοψη/Δεδομένα/ContentSizeLimit | Τροποποιήστε το όριο μεγέθους εισόδου για το περιεχόμενο σύνοψης Τύπος: ακέραιος Προεπιλογή: 100 K |
Σχήμα API
Method | URI |
---|---|
POST | [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" } |
Όνομα | Περιγραφή |
---|---|
InstructionIdentifier | Αυτή η ιδιότητα είναι προαιρετική. Εάν θέλετε να δώσετε οποιαδήποτε άλλη οδηγία για σύνοψη, χρησιμοποιήστε τις ρυθμίσεις τοποθεσίας για να προσθέσετε την προτροπή. Θα πρέπει πάντα να παρέχετε το όνομα της ρύθμισης τοποθεσίας όπως ορίστηκε προηγουμένως. |
RecommendationConfig | Αυτή η ιδιότητα είναι προαιρετική. Εάν περάσετε τη συνιστώμενη προτροπή που παρέχεται από το API σύνοψης, χρησιμοποιήστε αυτήν την παράμετρο για να περάσετε. Η τιμή πρέπει να κατακερματιστεί και όχι να τροποποιηθεί. |
Σημείωμα
Το API ακολουθεί τις τυπικές προδιαγραφές OData που υποστηρίζονται από το Power Pages Web API. Το API σύνοψης υποστηρίζει όλες τις λειτουργίες ανάγνωσης που υποστηρίζει το Power Pages API web.
Δείγμα
Συνοψίστε τον τύπο, το θέμα, την περιγραφή και το ιστορικό της υπόθεσης εστιάζοντας σε βασικές λεπτομέρειες και κρίσιμες πληροφορίες.
Αίτημα
POST [Power Pages URL]/_api/summarization/data/v1.0/incidents(aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb)?$select=description,title&$expand=incident_adx_portalcomments($select=description)
Content-Type: application/json; charset=utf-8
OData-MaxVersion: 4.0
OData-Version: 4.0
Accept: application/json
{
"InstructionIdentifier": "Summarization/prompt/case_summary"
}
Απάντηση
HTTP/1.1 200 OK
OData-Version: 4.0
{
"Summary": "The data results provide information…...",
"Recommendations": [
{
"Text": "would you like to know about…?",
"Config": "HSYmaicakjvIwTFYeCIjKOyC7nQ4RTSiDJ+/LBK56r4="
}
]
}
Η απόκριση σύνοψης παρέχει συνιστώμενες προτροπές για την τελειοποίηση της σύνοψης. Εάν θέλετε να χρησιμοποιήσετε αυτές τις συστάσεις, μεταβιβάστε την τιμή ρύθμισης παραμέτρων στο σώμα αίτησης χωρίς το InstructionIdentifier.
Ασφάλεια
Το API σύνοψης σέβεται την ασφάλεια βάσει ρόλων που έχει ρυθμιστεί για δικαιώματα πίνακα και στήλης. Λαμβάνει υπόψη μόνο τις καρτέλες στις οποίες έχει πρόσβαση ο χρήστης για σύνοψη.
API σύνοψης ελέγχου ταυτότητας
Δεν χρειάζεται να συμπεριλάβετε έναν κώδικα ελέγχου ταυτότητας, επειδή η διαχείριση του ελέγχου ταυτότητας και της εξουσιοδότησης γίνεται από την περίοδο λειτουργίας της εφαρμογής. Όλες οι κλήσεις Web API πρέπει να περιλαμβάνουν ένα διακριτικό πλαστής διατοποθεσιακής αίτησης (CSRF).
Κωδικοί και μηνύματα σφάλματος
Ο παρακάτω πίνακας περιλαμβάνει τους διαφορετικούς κωδικούς σφαλμάτων και τα μηνύματα που ενδέχεται να συναντήσετε κατά τη χρήση του API σύνοψης:
Κωδικός κατάστασης | Κωδικός σφάλματος | Μήνυμα σφάλματος |
---|---|---|
400 | 90041001 | Οι δυνατότητες παραγωγικής AI είναι απενεργοποιημένες |
400 | 90041003 | Η σύνοψη δεδομένων απενεργοποιήθηκε για αυτήν την τοποθεσία. Ενεργοποιήστε τη χρήση της ρύθμισης τοποθεσίας. |
400 | 90041004 | Το μήκος του περιεχομένου υπερβαίνει το όριο |
400 | 90041005 | Δεν βρέθηκαν καρτέλες για σύνοψη |
400 | 90041006 | Παρουσιάστηκε σφάλμα κατά τη σύνοψη του περιεχομένου. |