Del via

Oversigt over dataopsummerings-API (forhåndsversion)

[Denne artikel er til dokumentationen til den foreløbige udgivelse. Der kan forekomme ændringer.]

Udviklere bruger Power Pages-opsummerings-API til at tilføje sideindholdsopsummering med generativ AI. Med denne funktion kan webstedsbrugere få et overblik over en sides indhold uden at læse hele siden. API er bygget på web-API Power Pages, som giver dataopsummering for Dataverse tabeller, der bruges på sider.

Vigtigt!

  • Dette er en prøveversionsfunktion.
  • Prøveversionsfunktioner er ikke beregnet til produktionsformål og kan have begrænset funktionalitet. Disse funktioner er underlagt supplerende vilkår for anvendelse, og er tilgængelige før en officiel udgivelse, så kunderne kan få tidlig adgang og give feedback.

Forudsætninger

  • Aktivér webstedsindstillinger for Web API.
  • Det er kun tabeller, der understøttes af web-API Power Pages, der kan opsummeres. Få mere at vide om Power Pages Web API i oversigten over Web API.
  • Funktionen er ikke tilgængelige i GCC (Government Community Cloud), Government Community Cloud - High (GCC High) eller Department of Defense (DoD)-områder.

Indstillinger for websted

Enable sider i din web-API, og angiv følgende webstedsindstillinger for funktionen Opsummerings-API.

Navn på indstilling for websted Beskrivelse
Opsummering/Data/Aktivering Aktiver eller deaktiver funktionen Opsummering.
Standard: falsk
Gyldige værdier: sand, falsk
Opsummering/prompt/{any_identifier}

Brug disse indstillinger til at give instruktioner til opsummering.
Type: streng

Eksempel:
Navn: Summarization/prompt/case_summary
Value: Opsummer vigtige detaljer og vigtige oplysninger
Summarization/Data/ContentSizeLimit Rediger grænsen for inputstørrelse for opsummerende indhold.
Type: heltal
Standard: 100000 tegn

API-skema

Method URI JSON-eksempel
Indlæg [Websted-URI]/_api/opsummering/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Egenskabsnavn Beskrivelse
InstructionIdentifier Denne egenskab er valgfri. Hvis du vil give ekstra instruktioner til opsummering, skal du bruge webstedsindstillingerne til at tilføje prompten. Angiv altid navnet på webstedsindstillingen, som det tidligere blev defineret.
RecommendationConfig Denne egenskab er valgfri. Brug denne egenskab til at videregive den prompt, der anbefales af opsummerings-API. Værdien skal hash-mærkes og forblive uændret.

Bemærk!

API følger OData-standardspecifikationerne (Open Data Protocol), der understøttes af web-API Power Pages. Opsummerings-API understøtter alle læsehandlinger, der er tilgængelige i web-API Power Pages.

Sample

Opsummer sagstypen, emnet, beskrivelsen og sagshistorikken ved at fokusere på vigtige detaljer og vigtige oplysninger.

Anmodning

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

Respons

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

Opsummeringsresponsen indeholder anbefalede prompter til finjustering af oversigten. Hvis du vil bruge disse anbefalinger, skal du overføre konfigurationsværdien i anmodningsteksten uden egenskaben InstructionIdentifier.

Sikkerhed

Opsummerings-API respekterer rollebaseret sikkerhed, der er konfigureret for tabel- og kolonnetilladelser. Den tager kun hensyn til poster, som brugeren har adgang til med henblik på opsummering.

Godkendelse af opsummerings-API

Du behøver ikke at inkludere en godkendelseskode, da godkendelse og autorisation administreres af programsessionen. Alle Web-API-kald skal inkludere et Cross-Site Request Forgery (CSRF)-token.

Meddelelser og fejlkoder

Følgende tabel beskriver de forskellige fejlkoder og meddelelser, du kan få vist, når du bruger opsummerings-API'en.

Statuskode Fejlkode Error message
400 90041001 Generativ AI-funktioner er deaktiveret
400 90041003 Dataopsummering er deaktiveret for dette websted. Aktivér ved hjælp af webstedsindstillingen.
400 90041004 Indholdslængden overskrider grænsen
400 90041005 Der blev ikke fundet nogen poster, der skal opsummeres
400 90041006 Der opstod fejl under opsummering af indhold.

Ofte stillede spørgsmål om API til dataopsummering

  • Last updated on