Partajați prin

Prezentare generală a API-ului pentru rezumatul datelor (versiune preliminară)

  • Articol

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

Producătorii pot folosi Power Pages API-ul de rezumare pentru a adăuga o rezumare a conținutului paginii care utilizează IA generativă. În acest fel, utilizatorii site-ului pot obține o imagine de ansamblu asupra conținutului unei pagini fără a fi nevoie să parcurgă întreaga pagină. API-ul este construit pe API-ul Power Pages Web care oferă rezumat de date pe Dataverse tabelele care sunt utilizate în pagini.

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ții sunt supuse termenilor de utilizare suplimentari și sunt disponibile înainte de o lansare oficială, astfel încât clienții să poată obține acces anticipat și să ofere feedback.

Cerințe preliminare

  • Trebuie să activați setările site-ului pentru API-ul web.
  • Doar tabelele care sunt acceptate pentru Power Pages API-ul web sunt disponibile pentru rezumat. Aflați mai multe despre Power Pages Web API în Prezentare generală Web API.
  • Funcția nu este disponibilă în regiunile Government Community Cloud (GCC), Government Community Cloud - High (GCC High) sau Departamentul de Apărare (DoD).

Setări de site

Activați paginile din API-ul dvs. web și setați următoarele setări ale site-ului pentru caracteristica API-ului de rezumat.

Nume setare de site Descriere
Rezumat/Date/Activare Activați sau dezactivați caracteristica de rezumare.
Implicit: Fals
Valori valide: Adevărat, Fals
Rezumat/prompt/{any_identifier}

Utilizați aceste setări pentru a furniza orice instrucțiuni pentru rezumat.
Tastați: șir

Exemplu:
Nume: Rezumat/prompt/case_summary
Valoare: Rezumați detaliile cheie și informațiile esențiale
Rezumat/Date/ContentSizeLimit Modificați limita de dimensiune de intrare pentru conținutul rezumatului.
Tastați: întreg
Implicit: 100.000

Schemă API

Metodă URI Exemplu JSON
POST [URI site-ului]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Numele proprietății Descriere
InstructionIdentifier Această proprietate este opțională. Dacă doriți să transmiteți alte instrucțiuni pentru rezumare, utilizați setările site-ului pentru a adăuga solicitarea. Trebuie să furnizați întotdeauna numele setării site-ului așa cum a fost definit anterior.
RecomandationConfig Această proprietate este opțională. Dacă doriți să transmiteți solicitarea pe care o recomandă API-ul de rezumat, utilizați această proprietate pentru a o transmite. Valoarea ar trebui să fie indexată și nu modificată.

Notă

API-ul respectă specificațiile standard Open Data Protocol (OData) pe care le acceptă Power Pages Web API. API-ul de rezumat acceptă toate operațiunile de citire pe care Power Pages API-ul web le acceptă.

Sample

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

Request

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

Response

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

Rezumatul răspuns oferă solicitări recomandate pentru reglarea fină a rezumatului. Dacă doriți să utilizați aceste recomandări, transmiteți valoarea de configurare în corpul cererii, fără proprietatea InstructionIdentifier .

Securitatea

API-ul de rezumat respectă securitatea bazată pe roluri care este configurată pentru permisiunile de tabel și coloană. Doar înregistrările la care utilizatorul are acces sunt luate în considerare pentru rezumat.

Autentificarea API-ului de rezumat

Nu trebuie să includeți un cod de autentificare, deoarece sesiunea aplicației gestionează autentificarea și autorizarea. Toate apelurile Web API trebuie să includă un token de falsificare a cererii pe mai multe site-uri (CSRF).

Coduri de eroare și mesaje

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 rezumat.

Cod de stare Cod de eroare Mesaj de eroare
400 90041001 Funcțiile AI generative sunt dezactivate
400 90041003 Rezumatul datelor a fost dezactivat pentru acest site. Activați folosind setarea site-ului.
400 90041004 Lungimea conținutului depășește limita
400 90041005 Nu s-au găsit înregistrări pentru a rezuma
400 90041006 A apărut o eroare la rezumarea conținutului.

Întrebări frecvente pentru API-ul de rezumare a datelor