Freigeben über

Übersicht über die API zur Datenzusammenfassung (Vorschauversion)

[Dieser Artikel ist Teil der Dokumentation zur Vorabversion und kann geändert werden.]

Erstellende verwenden die Power Pages-Zusammenfassungs-API, um Zusammenfassungen von Seiteninhalten mit generative KI hinzuzufügen. Mit dieser Funktion können sich Websitebenutzer einen Überblick über den Inhalt einer Seite verschaffen, ohne die gesamte Seite lesen zu müssen. Die API basiert auf der Power Pages-Web-API, die eine Datenzusammenfassung für Dataverse-Tabellen bereitstellt, die auf Seiten verwendet werden.

Wichtig

  • Dies ist eine Vorschauversion.
  • Funktionen in der Vorschauversion sind nicht für den Produktionseinsatz gedacht und können eine eingeschränkte Funktionalität aufweisen. Diese Funktionen unterliegen den ergänzenden Nutzungsbedingungen und stehen vor dem offiziellen Release zur Verfügung, damit die Kundschaft frühen Zugriff darauf erhalten und Feedback geben können.

Anforderungen

  • Aktivieren Sie die Websiteeinstellungen für die Web-API.
  • Nur Tabellen, die von der Power Pages-Web-API unterstützt werden, können zusammengefasst werden. Weitere Informationen über die Power Pages-Web-API finden Sie unter Web-API-Übersicht.
  • Diese Funktion ist in Government Community Cloud (GCC), Government Community Cloud - High (GCC High) oder Department of Defense (DoD)-Regionen nicht verfügbar.

Websiteeinstellungen

Aktivieren Sie Seiten in Ihrer Web-API, und legen Sie die folgenden Websiteeinstellungen für die Zusammenfassungs-API-Funktion fest.

Website-Einstellungsname Beschreibung
Summarization/Data/Enable Zusammenfassungsfeature aktivieren oder deaktiveren.
Standard: false
Gültige Werte: true, false
Summarization/prompt/{any_identifier}

Verwenden Sie diese Einstellungen, um Anweisungen für die Zusammenfassung bereitzustellen.
Typ: Zeichenfolge

Beispiel:
Name: Zusammenfassung/Eingabeaufforderung/Fallzusammenfassung
Wert: Wichtige Details und Informationen zusammenfassen
Zusammenfassung/Daten/ContentSizeLimit Ändern Sie die Eingabegrößenbeschränkung für Zusammenfassungsinhalte.
Typ: Integer
Standard: 100000 Zeichen

API-Schema

Methode URI JSON-Beispiel
NACHRICHT [Website-URI]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Name der Eigenschaft Beschreibung
InstructionIdentifier Diese Eigenschaft ist optional. Wenn Sie zusätzliche Anweisungen für die Zusammenfassung übergeben möchten, fügen Sie die Eingabeaufforderung in den Websiteeinstellungen hinzu. Geben Sie den Namen der Websiteeinstellung immer so an, wie er zuvor definiert wurde.
RecommendationConfig Diese Eigenschaft ist optional. Verwenden Sie diese Eigenschaft, um die von der Zusammenfassungs-API empfohlene Eingabeaufforderung zu übergeben. Der Wert muss gehasht werden und darf nicht geändert werden.

Anmerkung

Die API folgt den standardmäßigen Open-Data-Protocol-Spezifikationen (OData), die von der Power Pages-Web-API unterstützt werden. Die Zusammenfassungs-API unterstützt alle Lesevorgänge, die in der Power Pages-Web-API verfügbar sind.

Sample

Fassen Sie den Falltyp, den Betreff, die Beschreibung und den Vorgangsverlauf zusammen, indem Sie sich auf die wichtigsten Details und wichtigen Informationen konzentrieren.

Anfordern

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

Antworten

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

Die Antwort der Zusammenfassung enthält empfohlene Eingabeaufforderungen zur Feinabstimmung der Zusammenfassung. Um diese Empfehlungen zu verwenden, übergeben Sie den Konfigurationswert im Anforderungstext ohne die Eigenschaft InstructionIdentifier.

Sicherheit

Die Zusammenfassungs-API berücksichtigt die rollenbasierte Sicherheit, die für Tabellen- und Spaltenberechtigungen konfiguriert ist. Es werden nur Datensätze berücksichtigt, auf die der Benutzer zur Zusammenfassung zugreifen kann.

Authentifizierung der Zusammenfassungs-API

Sie müssen keinen Authentifizierungscode angeben, da die Anwendungssitzung die Authentifizierung und Autorisierung verwaltet. Alle Web-API-Aufrufe müssen ein Token für die websiteübergreifende Anforderungsfälschung (CSRF) enthalten.

Fehlercodes und -meldungen

Die folgende Tabelle beschreibt die verschiedenen Fehlercodes und Meldungen, die bei der Verwendung der Zusammenfassungs-API auftreten können.

Statuscode Fehlercode Fehlernachricht
400 90041001 Generative KI-Features sind deaktiviert
400 90041003 Die Datenzusammenfassung ist für diese Website deaktiviert. Aktivieren Sie die Option mithilfe der Websiteeinstellung.
400 90041004 Inhaltslänge überschreitet den Grenzwert
400 90041005 Es wurden keine Datensätze gefunden, die zusammengefasst werden können
400 90041006 Beim Zusammenfassen des Inhalts ist ein Fehler aufgetreten.

Häufig gestellte Fragen zur Datenzusammenfassungs-API

  • Last updated on