Delen via

Overzicht van API voor gegevenssamenvatting (preview)

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

Makers gebruiken de Power Pages-samenvattings-API om samenvattingen van pagina-inhoud toe te voegen met generatieve AI. Met deze functie kunnen sitegebruikers een overzicht krijgen van de inhoud van een pagina zonder de hele pagina te hoeven lezen. De API is gebaseerd op de Power Pages-web-API, die gegevenssamenvattingen biedt voor 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

  • De site-instellingen inschakelen voor de web-API.
  • Alleen tabellen die door de Power Pages-web-API worden ondersteund, zijn beschikbaar voor samenvatting. Meer informatie over de Power Pages-web-API is te vinden in Overzicht van web-API.
  • Deze functie is niet beschikbaar in Government Community Cloud (GCC), Government Community Cloud - High (GCC High) en Department of Defense (DoD).

Site-instellingen

Schakel 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: false
Geldige waarden: true, false
Summarization/prompt/{any_identifier}

Gebruik deze instellingen om instructies voor het samenvatten te geven.
Type: tekenreeks

Voorbeeld:
Naam: Summarization/prompt/case_summary
Waarde: Vat de belangrijkste details en kritieke informatie samen
Summarization/Data/ContentSizeLimit Wijzig de invoergroottelimiet voor samenvattingsinhoud.
Type: geheel getal
Standaard: 100000 characters

API-schema

Wijze URI JSON-voorbeeld
POSTEN [Site URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Eigenschapsnaam Omschrijving
InstructionIdentifier Deze eigenschap is optioneel. Als u extra instructies voor de samenvatting wilt doorgeven, gebruikt u de site-instellingen om de prompt toe te voegen. Geef altijd de naam van de site-instelling op zoals deze eerder is gedefinieerd.
RecommendationConfig Deze eigenschap is optioneel. Gebruik deze eigenschap om de prompt door te geven die wordt aanbevolen door de samenvattings-API. De waarde moet gehasht worden en moet ongewijzigd blijven.

Notitie

De API volgt de standaard OData-specificaties (Open Data Protocol) die door de Power Pages-web-API worden ondersteund. De samenvattings-API ondersteunt alle leesbewerkingen die beschikbaar zijn in de Power Pages-web-API.

Sample

Vat het type zaak, het onderwerp, de beschrijving en de casusgeschiedenis samen, waarbij u zich concentreert op de belangrijkste details en belangrijke 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

Body:
{
"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 aanvraagbody zonder de eigenschap InstructionIdentifier.

Beveiliging

De samenvattings-API respecteert de op rollen gebaseerde beveiliging die is geconfigureerd voor tabel- en kolommachtigingen. Er wordt alleen rekening gehouden met records die de gebruiker kan raadplegen voor een samenvatting.

Authenticatie van de samenvatting-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

  • Last updated on