Översikt över APi för datasammanfattning (förhandsversion)

[Den här artikeln är förhandsdokumentation och kan komma att ändras.]

Tillverkare använder Power Pages sammanfattnings-API för att lägga till sammanfattning av sidinnehåll med generativ AI. Med den här funktionen kan webbplatsanvändare få en översikt över en sidas innehåll utan att läsa hela sidan. API:et är byggt på Power Pages webb-API, som tillhandahåller datasummering för Dataverse-tabeller som används på sidor.

Important

  • Det här är en förhandsgranskningsfunktion.
  • Förhandsgranskningsfunktioner ska inte användas i produktion och funktionerna kan komma att vara begränsade. Dessa funktioner är föremål för kompletterande användningsvillkor och görs tillgängliga före officiell lansering så att kunder kan få tidig tillgång och ge feedback.

Förutsättningar

Platsinställningar

Aktivera sidor i webb-API:et och ange följande webbplatsinställningar för sammanfattnings-API-funktionen.

Namn på webbplatsinställning Beskrivning
Sammanfattning/Data/Aktivera Aktivera eller inaktivera sammanfattningsfunktionen.
Standard: falsk
Giltiga värden: sant, falskt
Sammanfattning/prompt/{any_identifier}

Använd de här inställningarna för att ge instruktioner för sammanfattning.
Typ: sträng

Exempel:
Namn: Summarization/prompt/case_summary
Värde: Sammanfatta viktiga detaljer och viktig information
Sammanfattning/Data/Innehållsstorleksgräns Ändra storleksgränsen för indata för sammanfattningsinnehåll.
Typ: heltal
Standard: 100000 tecken

API-schema

Metod URI JSON-exempel
Posten [Webbplats-URI]/_api/sammanfattning/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Egenskapsnamn Beskrivning
InstructionIdentifier Den här egenskapen är valfri. Om du vill skicka extra instruktioner för sammanfattning använder du webbplatsinställningarna för att lägga till prompten. Ange alltid namnet på webbplatsinställningen så som det definierades tidigare.
RecommendationConfig Den här egenskapen är valfri. Använd den här egenskapen för att skicka prompten som rekommenderas av sammanfattnings-API:et. Värdet måste krypteras och förbli oförändrat.

Anmärkning

API:et följer standardspecifikationerna för Open Data Protocol (OData) som stöds av Power Pages webb-API:et. Sammanfattnings-API:et stöder alla läsåtgärder som är tillgängliga i Power Pages webb-API:et.

Exempel

Sammanfatta ärendetyp, ämne, beskrivning och ärendehistorik genom att fokusera på viktiga detaljer och viktig information.

Förfrågan

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

Svar

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

Sammanfattningssvaret innehåller rekommenderade uppmaningar för att finjustera sammanfattningen. Om du vill använda dessa rekommendationer skickar du konfigurationsvärdet i begärandetexten utan egenskapen InstructionIdentifier.

Säkerhet

Sammanfattnings-API:et respekterar rollbaserad säkerhet som konfigurerats för tabell- och kolumnbehörigheter. Den tar bara hänsyn till poster som användaren kan komma åt för sammanfattning.

Autentisera sammanfattnings-API:et

Du behöver inte ha med någon autentiseringskod, detta eftersom programsessionen hanterar autentisering och auktorisering. Alla webb-API-anrop måste innehålla en CSRF-token för skydd mot förfalskning av begäran mellan webbplatser.

Felkoder och varningsmeddelanden

I följande tabell beskrivs de olika felkoder och meddelanden som du kan stöta på när du använder sammanfattnings-API:et.

Statuskod Felkod Felmeddelande
400 90041001 Generativa AI-funktioner har inaktiverats
400 90041003 Sammanfattning av data har inaktiverats för den här webbplatsen. Aktivera användning av webbplatsinställningen.
400 90041004 Innehållslängden överskrider gränsen
400 90041005 Det gick inte att hitta några poster att sammanfatta
400 90041006 Ett fel uppstod när innehållet skulle sammanfattas.

Vanliga frågor och svar om API för datasammanfattning

  • Last updated on