Dela via

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

  • Artikel

[Den här artikeln är en förhandsversion av dokumentationen och kan ändras.]

Tillverkare kan använda sammanfattnings-API för att lägga till sammanfattning av Power Pages sidinnehåll som använder generativ AI. På så sätt kan webbplatsanvändare få en överblick över en sidas innehåll utan att behöva gå igenom hela sidan. API:et bygger på webb-API:et Power Pages som ger datasammanfattning för de Dataverse tabeller som används på sidor.

Viktigt

  • Detta är en förhandsversion.
  • Förhandsversionsfunktioner ska inte användas i produktion och funktionerna kan vara begränsade. Funktionerna är föremål för kompletterande användningsvillkor så att kunder kan få tidig tillgång och ge feedback.

Förutsättningar

  • Du måste aktivera webbplatsinställningarna för webb-API:et.
  • Endast tabeller som stöds för webb-API Power Pages är tillgängliga för sammanfattning. Läs mer om Power Pages webb-API i Översikt över webb-API.
  • Funktionen är inte tillgänglig i Government Community Cloud (GCC)-, Government Community Cloud – High (GCC High)- eller Department of Defense (DoD)-regioner.

Webbplatsinställningar

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

Namn på webbplatsinställning Description
Sammanfattning/Data/Aktivera Aktivera eller inaktivera sammanfattningsfunktionen.
Standard: Falskt
Giltiga värden: Sant, Falskt
Sammanfattning/prompt/{any_identifier}

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

Exempel:
Namn: Sammanfattning/prompt/case_summary
Värde: Sammanfatta viktiga detaljer och viktig information
Sammanfattning/Data/ContentSizeLimit Ändra storleksgränsen för indata för sammanfattningsinnehållet.
Typ: heltal
Standard: 100 000

API-schema

Metod URI JSON-exempel
POST [Webbplats-URI]/_api/sammanfattning/data/v1.0/tabellnamn { "InstructionIdentifier":"", "RecommendationConfig":"" }
Egenskapsnamn Description
InstructionIdentifier Den här egenskapen är valfri. Om du vill skicka andra instruktioner för sammanfattning använder du webbplatsinställningarna för att lägga till prompten. Du bör alltid ange namnet på webbplatsinställningen så som det definierades tidigare.
RecommendationConfig Den här egenskapen är valfri. Om du vill skicka prompten som sammanfattnings-API:et rekommenderar använder du den här egenskapen för att skicka den. Värdet ska ”hashas” och inte ändras.

Obs

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

Sample

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

Begär

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

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 den rollbaserade säkerhet som har konfigurerats för tabell- och kolumnbehörigheter. Endast poster som användaren har åtkomst till beaktas 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 token för förfalskning av begäran mellan webbplatser (CSRF).

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 Error message
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