Kopīgot, izmantojot

Pārskats par datu summēšanas API (priekšskatījums)

  • Raksts

[Šis raksts ir pirmsizlaides dokumentācija, kas var mainīties.]

Veidotāji var izmantot Power Pages summēšanas API, lai pievienotu lapas satura summēšanu, kas izmanto ģeneratīvo AI. Tādā veidā vietnes lietotāji var iegūt pārskatu par lapas saturu, neizejot cauri visai lapai. API ir veidots uz tīmekļa API bāzes Power Pages , kas nodrošina datu apkopošanu lapās izmantotajās Dataverse tabulās.

Svarīgi

  • Šis ir priekšskatījuma līdzeklis.
  • Priekšskatījuma līdzekļi nav paredzēti komerciālai lietošanai, un to funkcionalitāte var būt ierobežota. Uz šiem līdzekļiem attiecas papildu lietošanas noteikumi, un tie ir pieejami pirms oficiālā laidiena, lai klienti varētu iegūt agrīnu piekļuvi un sniegt atsauksmes.

Priekšnoteikumi

  • Jums ir jāiespējo vietnes iestatījumi tīmekļa API.
  • Apkopošanai ir pieejamas tikai tās tabulas, kas tiek atbalstītas Power Pages tīmekļa API. Uzziniet vairāk par Power Pages tīmekļa API tīmekļa API pārskatā.
  • Šis līdzeklis nav pieejams Government Community Cloud (GCC), Government Community Cloud — High (GCC High) vai Aizsardzības departamenta (DoD) reģionos.

Vietnes iestatījumi

Iespējojiet lapas savā tīmekļa API un iestatiet tālāk norādītos vietnes iestatījumus summēšanas API līdzeklim.

Vietnes iestatījuma nosaukums Apraksts
Summēšana/dati/iespējošana Iespējojiet vai atspējojiet summēšanas līdzekli.
Noklusējums: Aplams
Derīgas vērtības: Patiess,Aplams
Summēšana/uzvedne/{any_identifier}

Izmantojiet šos iestatījumus, lai sniegtu jebkādus norādījumus par summēšanu.
Tips: virkne

Piemērs:
Nosaukums: Summēšana/uzvedne/case_summary
Vērtība: Apkopojiet galveno informāciju un kritisko informāciju
Summēšana/Dati/ContentSizeLimit Modificējiet ievades lieluma ierobežojumu summēšanas saturam.
tips: vesels skaitlis
Noklusējums: 100 000

API shēma

Metode URI JSON Paraugs
POST [Vietnes URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Rekvizīta nosaukums Apraksts
InstructionIdentifier Šis rekvizīts nav obligāts. Ja vēlaties sniegt citus kopsavilkuma norādījumus, izmantojiet vietnes iestatījumus, lai pievienotu uzvedni. Jums vienmēr jānorāda vietnes iestatījuma nosaukums, kā tas tika definēts iepriekš.
RecommendationConfig Šis rekvizīts nav obligāts. Ja vēlaties nodot kopsavilkuma API ieteikto uzvedni, izmantojiet šo rekvizītu, lai to nodotu. Vērtība ir jājauc, nevis jāmaina.

Piezīmes

API atbilst standarta atvērto datu protokola (Open Data Protocol — OData) specifikācijām, Power Pages ko atbalsta tīmekļa API. Summēšanas API atbalsta visas lasīšanas darbības , Power Pages ko atbalsta tīmekļa API.

Sample

Apkopojiet pieteikuma tipu, tēmu, aprakstu un pieteikumu vēsturi, koncentrējoties uz galveno informāciju un kritisko informāciju.

Pieprasīt

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

Summēšanas atbilde sniedz ieteicamās uzvednes kopsavilkuma precizēšanai. Ja vēlaties izmantot šos ieteikumus, nododiet konfigurācijas vērtību pieprasījuma pamattekstā bez rekvizīta InstructionIdentifier .

Drošība

Summēšanas API ievēro uz lomām balstītu drošību, kas ir konfigurēta tabulu un kolonnu atļaujām. Summēšanai tiek ņemti vērā tikai tie ieraksti, kuriem lietotājam ir piekļuve.

Summēšanas API autentificēšana

Autentifikācijas kods nav jāiekļauj, jo lietojumprogrammas sesija pārvalda autentifikāciju un autorizāciju. Visos tīmekļa API izsaukumos ir jāiekļauj starpvietņu pieprasījumu viltošanas (CSRF) marķieris.

Kļūdu kodi un ziņojumi

Tālāk esošajā tabulā ir aprakstīti dažādi kļūdu kodi un ziņojumi, kas var rasties, izmantojot summēšanas API.

Statusa kods Kļūdas kods Kļūdas paziņojums
400 90041001 Ģeneratīvās AI funkcijas ir atspējotas
400 90041003 Datu summēšana šai vietnei ir atspējota. Iespējot, izmantojot vietnes iestatījumu.
400 90041004 Satura garums pārsniedz ierobežojumu
400 90041005 Nav atrasti ieraksti, kas apkopotu
400 90041006 Kļūda radās, apkopojot saturu.

Bieži uzdotie jautājumi par datu summēšanas API