Επισκόπηση API σύνοψης δεδομένων (έκδοση προεπισκόπησης)

[Αυτό το άρθρο αποτελεί τεκμηρίωση προέκδοσης και ενδέχεται να αλλάξει.]

Οι δημιουργοί χρησιμοποιούν το Power Pages API σύνοψης για να προσθέσουν σύνοψη περιεχομένου σελίδας με παραγωγικό AI. Αυτή η δυνατότητα επιτρέπει στους χρήστες της τοποθεσίας να έχουν μια επισκόπηση του περιεχομένου μιας σελίδας χωρίς να διαβάζουν ολόκληρη τη σελίδα. Το API βασίζεται στο Power Pages Web API, το οποίο παρέχει σύνοψη δεδομένων για Dataverse πίνακες που χρησιμοποιούνται σε σελίδες.

Σημαντικό

  • Αυτή είναι μια δυνατότητα προεπισκόπησης.
  • Οι λειτουργίες προεπισκόπησης δεν προορίζονται για παραγωγική χρήση και ενδέχεται να έχουν περιορισμένη λειτουργικότητα. Αυτές οι δυνατότητες υπόκεινται στους συμπληρωματικούς όρους χρήσης και είναι διαθέσιμες πριν την επίσημη κυκλοφορία ώστε οι πελάτες να έχουν πρόσβαση από νωρίς και να κάνουν σχόλια.

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

  • Ενεργοποιήστε τις ρυθμίσεις τοποθεσίας για το Web API.
  • Μόνο πίνακες που υποστηρίζονται από το Power Pages Web API είναι διαθέσιμοι για σύνοψη. Μάθετε περισσότερα σχετικά με το Web API Power Pages στην Επισκόπηση Web API.

Ρυθμίσεις τοποθεσίας

Ενεργοποιήστε σελίδες στο API web και ορίστε τις ακόλουθες ρυθμίσεις τοποθεσίας για τη δυνατότητα API σύνοψης.

Όνομα ρύθμισης τοποθεσίας Description
Σύνοψη/Δεδομένα/Ενεργοποίηση Ενεργοποίηση ή απενεργοποίηση της λειτουργίας σύνοψης.
Προεπιλογή: false
Έγκυρες τιμές: true, false
Σύνοψη/προτροπή/{any_identifier}

Χρησιμοποιήστε αυτές τις ρυθμίσεις για να δώσετε οδηγίες για σύνοψη.
Τύπος: Συμβολοσειρά

Παράδειγμα:
Όνομα: Summarization/prompt/case_summary
Τιμή: Σύνοψη βασικών λεπτομερειών και κρίσιμων πληροφοριών
Σύνοψη/Δεδομένα/ContentSizeLimit Τροποποιήστε το όριο μεγέθους εισόδου για το περιεχόμενο σύνοψης.
Τύπος: Ακέραιος
Προεπιλογή: 100000 χαρακτήρες

Σχήμα API

Μέθοδος URI Δείγμα JSON
POST [URI τοποθεσίας]/_api/σύνοψη/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Όνομα ιδιότητας Description
InstructionIdentifier Αυτή η ιδιότητα είναι προαιρετική. Για να δώσετε επιπλέον οδηγίες για σύνοψη, χρησιμοποιήστε τις ρυθμίσεις τοποθεσίας για να προσθέσετε την προτροπή. Να παρέχετε πάντα το όνομα ρύθμισης τοποθεσίας όπως είχε οριστεί προηγουμένως.
RecommendationConfig Αυτή η ιδιότητα είναι προαιρετική. Χρησιμοποιήστε αυτήν την ιδιότητα για να περάσετε την εντολή που συνιστάται από το API σύνοψης. Η αξία πρέπει να μετατραπεί σε hash και να παραμείνει αμετάβλητη.

Σημείωμα

Το API ακολουθεί τις τυπικές προδιαγραφές Open Data Protocol (OData) που υποστηρίζονται από το Power Pages Web API. Το API σύνοψης υποστηρίζει όλες τις λειτουργίες ανάγνωσης στο Power Pages Web API.

Δείγμα

Συνοψίστε τον τύπο υπόθεσης, το θέμα, την περιγραφή και το ιστορικό της υπόθεσης εστιάζοντας σε βασικές λεπτομέρειες και σημαντικές πληροφορίες.

Αίτημα

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

Body:
{
"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 Παρουσιάστηκε σφάλμα κατά τη σύνοψη του περιεχομένου.

Συνήθεις ερωτήσεις για το API σύνοψης δεδομένων

  • Last updated on