Freigeben über

Übersicht über die API zur Datenzusammenfassung (Vorschauversion)

  • Artikel

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

Mit der Power Pages-Zusammenfassungs-API können Ersteller mithilfe generativer KI eine Zusammenfassung von Seiteninhalten hinzufügen, die Websitebenutzern hilft, sich einen Überblick zu verschaffen, ohne die gesamte Seite durchzulesen. Die API baut auf der Web-API auf, die Power Pages eine Datenzusammenfassung für Dataverse die auf den Seiten verwendeten Tabellen bereitstellt.

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 Pages-Web-API unterstützt werden, stehen für die Zusammenfassung zur Verfügung. Weitere Informationen zur Pages-Web-API finden Sie unter 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 Seiteneinstellungen für das Zusammenfassungs-API-Feature fest.

Name der Website-Einstellung Description
Zusammenfassung/Daten/Aktivieren Aktiviert oder deaktiviert die Zusammenfassungsfeature.
Standardwert: False
Gültige Werte: True, False
Zusammenfassung/Eingabeaufforderung/{any_identifier} Verwenden Sie diese Einstellungen, um Anweisungen für die Zusammenfassung bereitzustellen
Typ: Zeichenfolge
Beispiel:
Name: Zusammenfassung/Eingabeaufforderung/case_summary
Wert: Wichtige Details und wichtige Informationen zusammenfassen
Zusammenfassung/Daten/ContentSizeLimit Ändern Sie die Eingabegrößenbeschränkung für den Zusammenfassungsinhalt
Typ: integer
Standardwert: 100 K

API-Schema

Method URI
NACHRICHT [Site URI]/_api/summarization/data/v1.0/tablename{ "InstructionIdentifier":"", "RecommendationConfig":"" }
Name des Dataflows Description
InstructionIdentifier Diese Eigenschaft ist optional. Wenn Sie eine weitere Anweisung an die Zusammenfassung übergeben möchten, verwenden Sie die Websiteeinstellungen, um die Aufforderung hinzuzufügen.
Sie sollten immer den Namen der Websiteeinstellung wie zuvor definiert angeben.
RecommendationConfig Diese Eigenschaft ist optional. Wenn Sie die von der Zusammenfassungs-API bereitgestellte empfohlene Eingabeaufforderung übergeben, verwenden Sie dafür diesen Parameter. Der Wert sollte gehasht und nicht geändert werden.

Anmerkung

Die API folgt den OData-Standardspezifikationen, die von der Power Pages Web-API unterstützt sind. Die Zusammenfassungs-API unterstützt alle Lesevorgänge , die auch von der Power Pages Web-API unterstützt werden.

Beispiel

Fassen Sie Falltyp, Betreff, Beschreibung und 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
{
"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 den InstructionIdentifier.

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 Benutzer für die Zusammenfassung Zugriff hat.

Authentifizieren der Zusammenfassungs-API

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

Fehlercodes und -meldungen

Die folgende Tabelle enthält die verschiedenen Fehlercodes und Meldungen, die bei der Verwendung der Zusammenfassungs-API auftreten können:

Statuscode Fehlercode Fehlermeldung
400 90041001 Generative KI-Funktionen sind deaktiviert
400 90041003 Die Datenzusammenfassung ist für diese Website deaktiviert. Aktivieren Sie die Option mithilfe der Site-Einstellung.
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