Prezentare generală a API-ului de sumarizare a datelor (previzualizare)

[Acest articol este documentație de prelansare și poate suferi modificări.]

Creatorii folosesc API-ul de sumarizare pentru a adăuga sumarizarea conținutului paginii cu ajutorul inteligenței artificiale generative. Power Pages Această funcție permite utilizatorilor site-ului să obțină o imagine de ansamblu asupra conținutului unei pagini fără a o citi în întregime. API-ul este construit pe API-ul web, care oferă o sumarizare a datelor pentru tabelele utilizate pe pagini. Power Pages Dataverse

Important

  • Aceasta este o caracteristică de previzualizare.
  • Caracteristicile în regim de previzualizare nu sunt destinate utilizării în producție și pot avea funcționalități restricționate. Aceste funcționalități sunt supuse termeni suplimentari de utilizare și sunt disponibile înainte de o lansare oficială, astfel încât clienții să poată primi access timpuriu și să ofere feedback.

Cerințe preliminare

  • Activați setările site-ului pentru API-ul web. ...
  • Doar tabelele acceptate de API-ul web sunt disponibile pentru sumarizare. Power Pages Aflați mai multe despre Power Pages API-ul Web în Prezentarea generală a API-ului Web.

Setări de site

Activați paginile în API-ul web și setați următoarele setări ale site-ului pentru funcția API de sumarizare.

Nume setare de site Descriere
Sumarizare/Date/Activare Activați sau dezactivați funcția de sumarizare.
Implicit: false
Valori valide: adevărat, fals
Rezumat/solicitare/{any_identifier}

Folosește aceste setări pentru a oferi instrucțiuni pentru sumarizare.
Tip: șir de caractere

Exemplu:
Nume: Sumarizare/solicitare/rezumat_caz
Valoare: Rezumați detaliile cheie și informațiile critice
Sumarizare/Date/Limită de dimensiune a conținutului Modificați limita de dimensiune a datelor de intrare pentru conținutul rezumat.
Tastați: întreg
Implicit: 100000 de caracteristici

Schemă API

Metodă URI Exemplu JSON
POSTARE [URI site]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Numele proprietății Descriere
Identificator de instrucțiuni Această proprietate este opțională. Pentru a transmite instrucțiuni suplimentare pentru sumarizare, utilizați setările site-ului pentru a adăuga solicitarea. Furnizați întotdeauna numele setării site-ului așa cum a fost definit anterior.
Configurare recomandări Această proprietate este opțională. Folosește această proprietate pentru a transmite promptul recomandat de API-ul de sumarizare. Valoarea trebuie să fie hashată și să rămână nemodificată.

Notă

API-ul respectă specificațiile standard Open Data Protocol (OData) acceptate de API-ul Web. Power Pages API-ul de sumarizare acceptă toate operațiunile de citire disponibile în API-ul web. Power Pages

Sample

Rezumați tipul cazului, subiectul, descrierea și istoricul cazului, concentrându-vă pe detaliile cheie și informațiile importante.

Solicitare

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"
}

Răspuns

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="
    }
  ]
}

Răspunsul la sumarizare oferă recomandări pentru ajustarea fină a sumarizării. Pentru a utiliza aceste recomandări, transmiteți valoarea de configurare în corpul cererii fără proprietatea InstructionIdentifier .

Securitate

API-ul de sumarizare respectă securitatea bazată pe roluri configurată pentru permisiunile de tabel și coloană. Se ia în considerare doar înregistrările la care utilizatorul poate accesa pentru sumarizare.

Autentificarea API-ului de sumarizare

Nu este nevoie să includeți un cod de autentificare, deoarece sesiunea aplicației gestionează autentificarea și autorizarea. Toate apelurile API-ului Web trebuie să includă un token de falsificare a cererilor între site-uri (CSRF).

Coduri și mesaje de eroare

Următorul tabel descrie diferitele coduri de eroare și mesaje pe care le puteți întâlni atunci când utilizați API-ul de sumarizare.

Cod de stare Cod de eroare Mesaj de eroare
400 90041001 Funcțiile de inteligență artificială generativă sunt dezactivate
400 90041003 Sumarizarea datelor este dezactivată pentru acest site. Activați folosind setările site-ului.
400 90041004 Lungimea conținutului depășește limita
400 90041005 Nu s-au găsit înregistrări pentru rezumat
400 90041006 A apărut o eroare la rezumarea conținutului.

Întrebări frecvente despre API-ul de sumarizare a datelor

  • Last updated on