Del via

Oversigt over dataopsummerings-API (forhåndsversion)

  • Artikel

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

Udviklere kan bruge Power Pages-opsummerings-API'en til at tilføje opsummering af sideindhold, der bruger generativ kunstig intelligens. På denne måde kan webstedsbrugere få et overblik over en sides indhold uden at skulle gennemgå hele siden. Denne API er bygget oven på Power Pages Web-API'en, der leverer dataopsummering på Dataverse-tabeller, der bruges på sider.

Vigtige oplysninger

  • Dette er en forhåndsversion af funktionen.
  • Forhåndsversionsfunktionerne 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

  • Du skal aktivere webstedsindstillingerne for web-API'en.
  • Det er kun tabeller, der understøttes for web-API'en 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).

Indstillinger for websted

Aktivér siderne i din Web-API, og angiv følgende webstedsindstillinger for funktionen til opsummerings-API.

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

Brug disse indstillinger til at angive instruktioner til opsummering.
Type: string

Eksempel:
Navn: Summarization/prompt/case_summary
Værdi: Opsummer vigtige detaljer og vigtige oplysninger
Summarization/Data/ContentSizeLimit Rediger grænsen for inputstørrelsen for opsummerende indhold.
Type: integer
Standard: 100.000

API-skema

Metode URI JSON-eksempel
Indlæg [URI for websted]/_api/opsummering/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Egenskabsnavn Beskrivelse
InstructionIdentifier Denne egenskab er valgfri. Hvis du vil videregive andre instruktioner til opsummering, skal du bruge webstedsindstillingerne til at tilføje prompten. Du skal altid angive navnet på webstedsindstillingen, som det er defineret tidligere.
RecommendationConfig Denne egenskab er valgfri. Hvis du vil sende den prompt, som opsummerings-API'en anbefaler, skal du bruge denne egenskab til at videregive den. Værdien skal hashes og ikke ændres.

Bemærk

API'en følger OData-standardspecifikationerne (Open Data Protocol), som web-API'en Power Pages understøtter. Opsummerings-API'en understøtter alle læseoperationer, som web-API'en til Power Pages understøtter.

Sample

Opsummer sagstype, emne, beskrivelse og sagshistorik ved at fokusere på vigtige detaljer og vigtige oplysninger.

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
{
"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'en respekterer den rollebaserede sikkerhed, der er konfigureret for tabel- og kolonnetilladelser. Den tager kun hensyn til de poster, som brugeren har adgang til, med henblik på opsummering.

Godkendelse af opsummerings-API'en

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 Generative 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