Bendrinti naudojant

Duomenų apibendrinimo API apžvalga (peržiūros versija)

  • Straipsnis

[Šis straipsnis yra negalutinio leidimo dokumentacija ir gali keistis.]

Kūrėjai gali naudoti suvestinės API, Power Pages kad pridėtų puslapio turinio santrauką, naudojančią generacinį AI. Tokiu būdu svetainės vartotojai gali gauti puslapio turinio apžvalgą neperžiūrėdami viso puslapio. API sukurta naudojant Power Pages žiniatinklio API, kuri teikia duomenų apibendrinimą puslapiuose naudojamose Dataverse lentelėse.

Svarbu

  • Tai yra peržiūros versijos funkcija.
  • Peržiūros versijos funkcijos nėra skirtos naudoti gamybai ir gali būti apribotas jų funkcionalumas. Šioms funkcijoms taikomos papildomos naudojimo sąlygos ir jos pasiekiamos prieš oficialų išleidimą, kad klientai galėtų gauti išankstinę prieigą ir pateikti atsiliepimų.

Būtinosios sąlygos

  • Turite įgalinti žiniatinklio API svetainės parametrus .
  • Apibendrinti galima tik tas lenteles, kurios palaikomos Power Pages žiniatinklio API. Sužinokite daugiau apie Power Pages žiniatinklio API žiniatinklio API apžvalgoje.
  • Ši funkcija nepasiekiama "Government Community Cloud" (GCC), "Government Community Cloud – High" (GCC High) arba Gynybos departamento (DoD) regionuose.

Svetainės parametrai

Įgalinkite žiniatinklio API puslapius ir nustatykite toliau nurodytus suvestinės API funkcijos svetainės parametrus.

Svetainės pavadinimo nustatymas Aprašą
Apibendrinimas/Duomenys/Įgalinti Įjunkite arba išjunkite apibendrinimo funkciją.
Numatytoji reikšmė: Klaidinga
Leistinos reikšmės: teisinga,klaidinga
Apibendrinimas/raginimas/{any_identifier}

Naudokite šiuos parametrus, kad pateiktumėte visas apibendrinimo instrukcijas.
Tipas: eilutė

Pavyzdys:
Pavadinimas: Summarization/prompt/case_summary
Reikšmė: apibendrinkite pagrindinę išsamią informaciją ir svarbią informaciją
Apibendrinimas/Duomenys/ContentSizeLimit Modifikuokite suvestinės turinio įvesties dydžio apribojimą.
Tipas: sveikasis skaičius
Numatytoji reikšmė: 100 000

API schema

Būdas URI JSON Pavyzdys
SKELBTI [Svetainės URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Ypatybės pavadinimas Aprašą
InstructionIdentifier Ši ypatybė yra neprivaloma. Jei norite perduoti kitas apibendrinimo instrukcijas, naudokite svetainės parametrus, kad pridėtumėte raginimą. Visada turėtumėte pateikti svetainės parametro pavadinimą, kaip jis buvo apibrėžtas anksčiau.
RekomendacijaKonfigūravimas Ši ypatybė yra neprivaloma. Jei norite perduoti raginimą, kurį rekomenduoja apibendrinimo API, naudokite šią ypatybę, kad ją perduotumėte. Reikšmė turėtų būti maišoma ir nekeičiama.

Pastaba.

API atitinka standartines atvirųjų duomenų protokolo (OData) specifikacijas, Power Pages kurias palaiko žiniatinklio API. Suvestinės API palaiko visas skaitymo operacijas , Power Pages kurias palaiko žiniatinklio API.

Sample

Apibendrinkite atvejo tipą, temą, aprašą ir atvejo istoriją, sutelkdami dėmesį į pagrindinę informaciją ir svarbią informaciją.

Prašyti

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

Atsakas

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

Apibendrinimo atsakymas pateikiami rekomenduojami raginimai patikslinti santrauką. Jei norite naudoti šias rekomendacijas, perduokite konfigūracijos reikšmę užklausos tekste be InstructionIdentifier ypatybės.

Sauga

Suvestinės API atsižvelgia į vaidmenimis pagrįstą saugą, sukonfigūruotą lentelės ir stulpelio teisėms. Į apibendrinimą įtraukiami tik tie įrašai, prie kurių vartotojas turi prieigą.

Suvestinės API autentifikavimas

Jums nereikia įtraukti autentifikavimo kodo, nes programos seansas valdo autentifikavimą ir autorizavimą. Visuose žiniatinklio API skambučiuose turi būti kelių svetainių užklausų klastojimo (CSRF) atpažinimo ženklas.

Klaidų kodai ir pranešimai

Šioje lentelėje aprašomi skirtingi klaidų kodai ir pranešimai, su kuriais galite susidurti naudodami suvestinės API.

Būsenos kodas Klaidos kodas Klaidos pranešimas
400 90041001 Generatyvinės AI funkcijos yra išjungtos
400 90041003 Šioje svetainėje išjungtas duomenų apibendrinimas. Įgalinkite naudodami svetainės parametrą.
400 90041004 Turinio trukmė viršija ribą
400 90041005 Nerasta jokių įrašų, kuriuos būtų galima apibendrinti
400 90041006 Apibendrinant turinį įvyko klaida.

DUK apie duomenų apibendrinimo API