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

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

Kūrėjai naudoja apibendrinimo API, Power Pages kad pridėtų puslapio turinio santrauką naudodami generacinį AI. Ši funkcija leidžia svetainės vartotojams gauti puslapio turinio apžvalgą neperskaičius viso puslapio. API sukurta naudojant Power Pages žiniatinklio API, kuri pateikia puslapiuose naudojamų lentelių duomenų santrauką Dataverse .

Svarbu

  • Tai yra peržiūros 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ų leidimą, kad klientai galėtų iš anksto gauti access ir pateikti atsiliepimų.

Būtinosios sąlygos

Svetainės parametrai

Įgalinkite puslapius savo žiniatinklio API 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 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
Numatytasis: 100000 simbolių

API schema

Metodas URI JSON Pavyzdys
SKELBTI [Svetainės URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Ypatybės pavadinimas Aprašą
InstructionIdentifier Ši ypatybė yra neprivaloma. Norėdami perduoti papildomas apibendrinimo instrukcijas, naudokite svetainės parametrus, kad įtrauktumėte raginimą. Visada pateikite svetainės parametro pavadinimą, kaip jis buvo apibrėžtas anksčiau.
RekomendacijaKonfigūravimas Ši ypatybė yra neprivaloma. Naudokite šią ypatybę, kad perduotumėte suvestinės API rekomenduojamą raginimą. Reikšmė turi būti pakeista maiša ir likti nepakeista.

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 pasiekiamas žiniatinklio API.

Sample

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

Prašymas

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

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

Santraukos atsakyme pateikiami rekomenduojami raginimai patikslinti santrauką. Norėdami naudoti šias rekomendacijas, perduokite konfigūracijos reikšmę užklausos tekste be ypatybės InstructionIdentifier .

Sauga

Suvestinės API atsižvelgia į vaidmenimis pagrįstą saugą, sukonfigūruotą lentelės ir stulpelio teisėms. Jame atsižvelgiama tik į tuos įrašus, kuriuos vartotojas gali pasiekti apibendrinimui.

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

  • Last updated on