Freigeben über

Übersicht über die API zur Datenzusammenfassung (Vorschauversion)

  • Artikel

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

Ersteller können die Power Pages Zusammenfassungs-API verwenden, um eine Zusammenfassung von Seiteninhalten hinzuzufügen, die generative KI verwendet. Auf diese Weise können sich die Benutzer der Website einen Überblick über den Inhalt einer Seite verschaffen, ohne die gesamte Seite durchgehen zu müssen. Die API baut auf der Power Pages-Web-API auf, die Datenzusammenfassung für die Dataverse-Tabellen bereitstellt, die in 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

  • Sie müssen die Websiteeinstellungen für die Web-API aktivieren.
  • Nur Tabellen, die für die Power Pages-Web-API unterstützt werden, stehen für die Zusammenfassung zur Verfügung. Weitere Informationen zur Web-API finden Sie in Power Pages der Web-API – Übersicht.
  • Dieses Feature ist in den Regionen Government Community Cloud (GCC), Government Community Cloud - High (GCC High) oder Department of Defense (DoD) nicht verfügbar.

Websiteeinstellungen

Aktivieren Sie die 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: Summarization/prompt/case_summary
Wert: Fassen Sie wichtige Details und wichtige Informationen zusammen
Zusammenfassung/Daten/ContentSizeLimit Ändern Sie den Grenzwert für die Eingabegröße für den Zusammenfassungsinhalt.
Typ: Integer
Standard: 100.000

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 weitere Anweisungen für die Zusammenfassung übergeben möchten, verwenden Sie die Websiteeinstellungen, um die Eingabeaufforderung hinzuzufügen. Sie sollten immer den Namen der Websiteeinstellung wie zuvor festgelegt angeben.
RecommendationConfig Diese Eigenschaft ist optional. Wenn Sie die von der Zusammenfassungs-API empfohlene Eingabeaufforderung übergeben möchten, verwenden Sie diese Eigenschaft, um sie zu übergeben. Der Wert sollte gehasht und nicht geändert werden.

Anmerkung

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

Sample

Fassen Sie den Falltyp, den Betreff, die Beschreibung und den Verlauf des Vorgangs 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
{
"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. Wenn Sie diese Empfehlungen verwenden möchten, übergeben Sie den Konfigurationswert im Anforderungstext ohne die InstructionIdentifier-Eigenschaft.

Sicherheit

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

Authentifizierung der Zusammenfassungs-API

Sie brauchen keinen Authentifizierungscode anzugeben, 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