Delen via

Overzicht van API voor gegevenssamenvatting (preview)

  • Artikel

[Dit artikel maakt deel uit van de voorlopige documentatie en kan nog veranderen.]

Makers kunnen de Power Pages-samenvattings-API gebruiken om samenvattingen van pagina-inhoud toe te voegen die gebruikmaken van generatieve AI. Op deze manier kunnen gebruikers van de site een overzicht krijgen van de inhoud van een pagina, zonder dat ze de hele pagina hoeven te doorlopen. De API is gebaseerd op de Power Pages Web API, die gegevenssamenvattingen biedt over de Dataverse tabellen die op pagina's worden gebruikt.

Belangrijk

  • Dit is een preview-functie.
  • Preview-functies zijn niet bedoeld voor productiegebruik en bieden mogelijk beperkte functionaliteit. Voor deze functies gelden aanvullende gebruiksvoorwaarden. Bovendien zijn ze beschikbaar vóór een officiële release zodat klanten vroeg toegang kunnen krijgen en feedback kunnen geven.

Voorwaarden

  • U moet de site-instellingen voor de web-API inschakelen.
  • Alleen tabellen die worden ondersteund voor de Power Pages Web API zijn beschikbaar voor samenvatting. Meer informatie over de Power Pages Web API vindt u in Web API-overzicht.
  • De functie is niet beschikbaar in Government Community Cloud (GCC), Government Community Cloud - High (GCC High) of Ministerie van Defensie (DoD).

Site-instellingen

Schakel de pagina's in uw web-API in en stel de volgende site-instellingen in voor de samenvattings-API-functie.

Naam van site-instelling Omschrijving
Summarization/Data/Enable Schakle de samenvattingsfunctie voor in of uit.
Standaardwaarde: Onwaar
Geldige waarden: Waar, Onwaar
Summarization/prompt/{any_identifier}

Gebruik deze instellingen om instructies voor de samenvatting op te geven.
Type: tekenreeks

Voorbeeld:
Naam: Samenvatting/prompt/case_summary
Waarde: Samenvatting van de belangrijkste details en kritische informatie
Summarization/Data/ContentSizeLimit Wijzig de invoergroottelimiet voor de samenvattingsinhoud.
Type: geheel getal
Standaardwaarde: 100.000

API-schema

Wijze URI JSON-voorbeeld
POSTEN [Site-URI]/_api/summarization/data/v1.0/tabelsetnaam { "InstructionIdentifier":"", "RecommendationConfig":"" }
Eigenschapsnaam Omschrijving
InstructionIdentifier Deze eigenschap is optioneel. Als u andere instructies voor samenvatting wilt doorgeven, gebruikt u de site-instellingen om de prompt toe te voegen. U dient altijd de naam van de site-instelling op te geven zoals eerder gedefinieerd.
RecommendationConfig Deze eigenschap is optioneel. Als u de prompt wilt doorgeven die de samenvattings-API aanbeveelt, gebruikt u deze eigenschap om dit te doen. De waarde moet worden gehasht en niet worden gewijzigd.

Notitie

De API volgt de standaard Open Data Protocol (OData)-specificaties die de Power Pages Web API ondersteunt. De API voor samenvatting ondersteunt alle leesbewerkingen die de web-API van Power Pages ondersteunt.

Sample

Vat het type casus, het onderwerp, de beschrijving en de casusgeschiedenis samen door u te concentreren op de belangrijkste details en cruciale informatie.

Aanvragen

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

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

De samenvattingsrespons bevat aanbevolen prompts voor het verfijnen van het overzicht. Als u deze aanbevelingen wilt gebruiken, geeft u de configuratiewaarde door in de aanvraagtekst, zonder de eigenschap InstructionIdentifier .

Beveiliging

De samenvattings-API respecteert de op rollen gebaseerde beveiliging die is geconfigureerd voor tabel- en kolommachtigingen. Alleen records waartoe de gebruiker toegang heeft, worden in aanmerking genomen voor samenvatting.

Authenticatie van de samenvattings-API

U hoeft geen verificatiecode op te nemen, omdat verificatie en autorisatie worden beheerd door de toepassingssessie. Alle web-API-aanroepen moeten een CSRF-token (Cross-Site Request Forgery) bevatten.

Foutcodes en -berichten

De volgende tabel bevat de verschillende foutcodes en berichten die u kunt tegenkomen wanneer u de samenvattings-API gebruikt:

Statuscode Foutcode Foutmelding
400 90041001 Generatieve AI-functies zijn uitgeschakeld
400 90041003 Gegevenssamenvatting uitgeschakeld voor deze site. Schakel het gebruik van de site-instelling in.
400 90041004 De lengte van de inhoud overschrijdt de limiet
400 90041005 Geen records gevonden om samen te vatten
400 90041006 Er is een fout opgetreden bij het samenvatten van de inhoud.

Veelgestelde vragen over API voor gegevenssamenvatting