Condividi tramite

Panoramica dell'API di riepilogo dei dati (anteprima)

  • Articolo

[Questo articolo fa parte della documentazione non definitiva, pertanto è soggetto a modifiche.]

Gli autori possono usare l'API Power Pages di riepilogo per aggiungere il riepilogo del contenuto della pagina che utilizza l'intelligenza artificiale generativa. In questo modo, gli utenti del sito possono ottenere una panoramica del contenuto di una pagina senza dover passare attraverso l'intera pagina. L'API si basa sull'API Web di Power Pages che fornisce un riepilogo dei dati nelle tabelle Dataverse utilizzate nelle pagine.

Importante

  • Questa è una funzionalità di anteprima.
  • Le funzionalità di anteprima non sono destinate ad essere utilizzate per la produzione e sono soggette a restrizioni. Queste funzionalità sono soggette a condizioni per l'utilizzo supplementari e sono disponibili prima di una versione ufficiale in modo che i clienti possano ottenere l'accesso iniziale e fornire feedback.

Prerequisiti

  • È necessario abilitare le impostazioni del sito per l'API Web.
  • Solo le tabelle supportate dall'API Web di Power Pages sono disponibili per il riepilogo. Ulteriori informazioni sulla API Web di Power Pages in Panoramica dell'API Web
  • La funzionalità non è disponibile nelle aree Government Community Cloud (GCC), Government Community Cloud (GCC High) e Department of Defense (DoD).

Impostazioni sito

Abilita le pagine nell'API Web e configura le seguenti impostazioni del sito per la funzionalità dell'API di riepilogo.

Nome impostazione sito Descrzione
Riepilogo/Dati/Abilita Abilita o disabilita la funzionalità di riepilogo.
Impostazione predefinita: False
Valori validi: True, False
Summarization/prompt/{any_identifier}

Utilizzare queste impostazioni per fornire istruzioni per il riepilogo.
Tipo: stringa

Esempio:
Nome: Riepilogo/prompt/case_summary
Valore: Riassumere i dettagli chiave e le informazioni critiche
Summarization/Data/ContentSizeLimit Modificare il limite delle dimensioni di input per il contenuto di riepilogo.
Tipop: intero
Predefinito: 100.000

Schema API

metodo URI Esempio JSON
POST [URI sito]/_api/summarization/data/v1.0/tablesetname { "InstructionIdentifier":"", "RecommendationConfig":"" }
Nome proprietà Descrzione
InstructionIdentifier Questa proprietà è facoltativa. Se desideri passare altre istruzioni al riepilogo, utilizza le impostazioni del sito per aggiungere il prompt. Dovresti sempre fornire il nome dell'impostazione del sito come definito in precedenza.
RecommendationConfig Questa proprietà è facoltativa. Se desideri passare il prompt fornito dall'API di riepilogo, utilizza questa proprietà per passarlo. Il valore deve essere sottoposto a hash e non modificato.

Nota

L'API segue le specifiche OData (Open Data Protocol) standard supportate dall'API Power Pages Web. L'API di riepilogo supporta tutte le operazioni di lettura supportate dall'API Web di Power Pages.

Sample

Riassumi il tipo di caso, l'oggetto, la descrizione e la cronologia del caso concentrandosi sui dettagli chiave e sulle informazioni critiche.

Richiedi

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

Response

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

La risposta del riepilogo fornisce suggerimenti consigliati per perfezionare il riepilogo. Se vuoi usare queste raccomandazioni, passa il valore di configurazione nel corpo della richiesta, senza la InstructionIdentifier proprietà.

Sicurezza

L'API di riepilogo rispetta la sicurezza basata sui ruoli configurata per le autorizzazioni di tabelle e colonne. Per il riepilogo vengono presi in considerazione solo i record a cui l'utente ha accesso.

Autenticazione dell'API di riepilogo

Non è necessario includere un codice di autenticazione, perché la sessione dell'applicazione gestisce l'autenticazione e l'autorizzazione. Tutte le chiamate API Web devono includere un token CSRF (Cross-Site Request Forgery, richiesta intersito falsa).

Codici e messaggi di errore

La tabella seguente descrive i diversi codici di errore e messaggi che potresti incontrare quando utilizzi l'API di riepilogo.

Codice di stato Codice errore Messaggio d'errore
400 90041001 Le funzionalità di intelligenza artificiale generativa sono disabilitate
400 90041003 Riepilogo dati disabilitato per questo sito. Abilita tramite le impostazioni del sito.
400 90041004 La lunghezza del contenuto supera il limite
400 90041005 Nessun record trovato da riepilogare
400 90041006 Si è verificato un errore durante la sintesi del contenuto.

Domande frequenti per l'API di riepilogo dei dati