Pregled API-ja za povzetek podatkov (predogled)

[Ta članek je del predizdajne dokumentacije in se lahko spremeni.]

Ustvarjalci uporabljajo API za povzemanje, da dodajo povzemanje vsebine strani z generativno umetno inteligenco. Power Pages Ta funkcija uporabnikom spletnega mesta omogoča pregled vsebine strani, ne da bi morali prebrati celotno stran. API je zgrajen na spletnem API-ju, ki omogoča povzemanje podatkov za tabele, ki se uporabljajo na straneh. Power Pages Dataverse

Pomembno

  • To je funkcija predogleda.
  • Predogledne različice funkcij niso za komercialno uporabo in njihovo delovanje je lahko omejeno. Za te funkcije veljajo dodatni pogoji uporabe in so na voljo pred uradno izdajo, da lahko stranke dostopajo do njih prej in podajo povratne informacije. ...

Zahteve

  • Omogočite nastavitve spletnega mesta za spletni API.
  • Za povzemanje so na voljo samo tabele, ki jih podpira spletni API. Power Pages Več o spletnem API-ju najdete v pregledu spletnega API-ja. Power Pages

Nastavitve mesta

Omogočite strani v svojem spletnem API-ju in nastavite naslednje nastavitve spletnega mesta za funkcijo API-ja za povzemanje.

Ime nastavitve mesta Description
Povzetek/Podatki/Omogoči Omogočite ali onemogočite funkcijo povzemanja.
Privzeto: false
Veljavne vrednosti: true, false
Povzetek/poziv/{any_identifier}

S temi nastavitvami zagotovite navodila za povzemanje.
Vrsta: niz

Primer:
Ime: Povzetek/poziv/povzetek_primera
Vrednost: Povzemite ključne podrobnosti in kritične informacije
Povzetek/Podatki/Omejitev velikosti vsebine Spremenite omejitev vhodne velikosti za vsebino povzetka.
Vrsta: celo število
Privzeto: 100000 znakov

Shema API

Metoda URI Vzorec JSON
POST [URI spletnega mesta]/_api/summarization/data/v1.0/name_nabora_tabel { "InstructionIdentifier":"", "RecommendationConfig":"" }
Ime lastnosti Description
Identifikator navodil Ta lastnost je neobvezna. Če želite posredovati dodatna navodila za povzemanje, uporabite nastavitve spletnega mesta za dodajanje poziva. Vedno navedite ime nastavitve spletnega mesta, kot je bilo prej določeno.
Konfiguracija priporočila Ta lastnost je neobvezna. S to lastnostjo posredujte poziv, ki ga priporoča API za povzemanje. Vrednost mora biti zgoščena in ostati nespremenjena.

opomba,

API sledi standardnim specifikacijam protokola Open Data Protocol (OData), ki jih podpira spletni API. Power Pages API za povzemanje podpira vse operacije branja , ki so na voljo v Power Pages spletnem API-ju.

Sample

Povzemite vrsto primera, zadevo, opis in zgodovino primera s poudarkom na ključnih podrobnostih in pomembnih informacijah.

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

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

Odgovor na povzetek vsebuje priporočene pozive za natančnejše nastavljanje povzetka. Če želite uporabiti ta priporočila, v telo zahteve posredujte konfiguracijsko vrednost brez lastnosti InstructionIdentifier .

Varnost

API za povzemanje spoštuje varnost na podlagi vlog, konfigurirano za dovoljenja za tabele in stolpce. Upošteva samo zapise, do katerih ima uporabnik dostop za povzetek.

Preverjanje pristnosti API-ja za povzemanje

Kode za preverjanje pristnosti ni treba vključiti, ker preverjanje pristnosti in avtorizacijo upravlja seja aplikacije. Vsi klici spletnega API-ja morajo vključevati žeton za zaščito pred ponarejanjem zahtev med spletnimi mesti (CSRF) .

Kode napak in sporočila

V naslednji tabeli so opisane različne kode napak in sporočila, na katere lahko naletite pri uporabi API-ja za povzemanje.

Koda stanja Koda napake Sporočilo o napaki
400 90041001 Funkcije generativne umetne inteligence so onemogočene
400 90041003 Povzemanje podatkov je za to spletno mesto onemogočeno. Omogoči uporabo nastavitve spletnega mesta.
400 90041004 Dolžina vsebine presega omejitev
400 90041005 Ni najdenih zapisov za povzetek
400 90041006 Pri povzemanju vsebine je prišlo do napake.

Pogosta vprašanja o API-ju za povzemanje podatkov

  • Last updated on