Del via

Oversikt over datasammendrags-API (forhåndsversjon)

  • Artikkel

[Denne artikkelen inneholder dokumentasjon for forhåndsversjonen og kan bli endret.]

Utviklere kan bruke API-en for Power Pages oppsummering til å legge til sammendrag av sideinnhold som bruker generativ kunstig intelligens. På denne måten kan nettstedbrukere få en oversikt over innholdet på en side uten å måtte gå gjennom hele siden. API-en er bygget på toppen av nett-API-en Power Pages som gir datasammendrag på tabellene Dataverse som brukes på sider.

Viktig!

  • Dette er forhåndsversjonsfunksjon.
  • Forhåndsversjonsfunksjonene er ikke ment for produksjonsbruk og kan ha begrenset funksjonalitet. Disse funksjonene er underlagt tilleggsvilkår for bruk og er tilgjengelige før en offisielle utgivelse, slik at kunder kan få tidlig tilgang og gi tilbakemeldinger.

Forutsetning

  • Du må aktivere områdeinnstillingene for nett-API-en .
  • Bare tabeller som støttes for nett-API-en for Power Pages, er tilgjengelige for sammendrag. Finn ut mer om nett-API-en Power Pages i Oversikt over nett-API.
  • Funksjonen er ikke tilgjengelig i regionene Government Community Cloud (GCC), Government Community Cloud - High (GCC High), eller Department of Defense (DoD).

Områdeinnstillinger

Aktiver sidene i nett-API-en, og angi følgende områdeinnstillinger for funksjonen for API for oppsummering.

Navn på nettstedinnstilling Description
Sammendrag/Data/Aktiver Aktiver eller deaktiver sammendragsfunksjonen.
Standard: False
Gyldige verdier: True, False
Sammendrag/spørring/{any_identifier}

Bruk disse innstillingene til å angi instruksjoner for sammendrag.
Type: streng

Eksempel:
Navn: Sammendrag/ledetekst/case_summary
Verdi: Oppsummere viktige detaljer og kritisk informasjon
Sammendrag/Data/ContentSizeLimit Endre grensen for inndatastørrelse for sammendragsinnholdet.
Type: heltall
Standard: 100 000

API-skjema

Metode URI JSON-eksempel
POST [Nettsteds-URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Egenskapsnavn Description
InstructionIdentifier Denne egenskapen er valgfri. Hvis du vil sende andre instruksjoner for sammendrag, bruker du områdeinnstillingene til å legge til ledeteksten. Du bør alltid angi navnet på områdeinnstillingen slik det ble definert tidligere.
RecommendationConfig Denne egenskapen er valgfri. Hvis du vil sende spørringen som API-en for sammendrag anbefaler, bruker du denne egenskapen til å sende den. Verdien skal hashes og ikke endres.

Notat

API-en følger standard OData-spesifikasjoner (Open Data Protocol) som web-API-en Power Pages støtter. API-en for sammendrag støtter alle leseoperasjoner som nett-API-en for Power Pages støtter.

Sample

Oppsummer sakstype, emne, beskrivelse og sakshistorikk ved å fokusere på nøkkeldetaljer og kritisk informasjon.

Forespørsel

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

Sammendragssvaret gir anbefalte spørringer om finjustering av sammendraget. Hvis du vil bruke disse anbefalingene, sender du konfigurasjonsverdien i forespørselsteksten uten egenskapen InstructionIdentifier .

Sikkerhet

API-en for oppsummering respekterer den rollebaserte sikkerheten som er konfigurert for tabell- og kolonnetillatelser. Bare oppføringer som brukeren har tilgang til, vurderes for sammendrag.

Autentisering av API-en for sammendrag

Du trenger ikke å ta med en godkjenningskode, fordi programøkten administrerer godkjenning og autorisasjon. Alle nett-API-oppkall må inneholde et CSRF-token (forfalskning av forespørsler på tvers av nettsteder).

Feilkoder og -meldinger

Tabellen nedenfor beskriver de ulike feilkodene og -meldingene som kan oppstå når du bruker API-en for oppsummering.

Statuskode Feilkode Error message
400 90041001 Generative KI-funksjoner er deaktivert
400 90041003 Datasammendrag er deaktivert for dette nettstedet. Aktiver bruk av områdeinnstillingen.
400 90041004 Innholdslengden overskrider grensen
400 90041005 Finner ingen oppføringer som kan summeres
400 90041006 Det oppstod en feil under summering av innholdet.

Vanlige spørsmål om datasammendrags-API