- Rappresentazione YAML
- StaticPrompt
- StaticPromptCandidate
- Selettore
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Suggerimento
- StaticCanvasPrompt
Definisce un gestore da eseguire dopo un evento. Esempi di eventi sono quelli basati su intent e condizioni in una scena.
Rappresentazione YAML | |
---|---|
webhookHandler: string # Union field |
Campi | ||
---|---|---|
webhookHandler |
Nome del gestore del webhook da chiamare. |
|
Campo di unione prompt . I prompt possono essere incorporati o far riferimento al nome. prompt può essere solo uno dei seguenti: |
||
staticPrompt |
Prompt statico incorporato. Può contenere riferimenti a risorse stringa nei pacchetti. |
|
staticPromptName |
Nome del prompt statico da richiamare. |
StaticPrompt
Rappresenta un elenco di candidati, uno dei quali verrà selezionato come prompt da mostrare nella risposta all'utente. Questo messaggio è localizzabile.
Rappresentazione YAML | |
---|---|
candidates:
- object ( |
Campi | |
---|---|
candidates[] |
L'elenco dei prompt dei candidati da inviare al cliente. Ogni prompt ha un selettore per determinare quando può essere utilizzato. Verrà inviato il primo selettore che corrisponde a una richiesta, mentre il resto verrà ignorato. |
StaticPromptCandidate
Rappresenta un candidato del prompt statico.
Rappresentazione YAML | |
---|---|
selector: object ( |
Campi | |
---|---|
selector |
Campo facoltativo. I criteri per stabilire se questo prompt corrisponde a una richiesta. Se il selettore è vuoto, verrà sempre attivato questo messaggio. |
promptResponse |
La risposta del prompt associata al selettore. |
Selettore
Definisce i criteri per stabilire se un prompt corrisponde a una richiesta.
Rappresentazione YAML | |
---|---|
surfaceCapabilities:
object ( |
Campi | |
---|---|
surfaceCapabilities |
L'insieme di funzionalità delle piattaforme richieste. |
SurfaceCapabilities
Rappresenta la piattaforma utilizzata dall'utente per effettuare una richiesta all'Azione.
Rappresentazione YAML | |
---|---|
capabilities:
- enum ( |
Campi | |
---|---|
capabilities[] |
Obbligatorio. Le funzionalità della piattaforma che effettua una richiesta all'Azione. |
StaticPromptResponse
Rappresenta le risposte strutturate da inviare all'utente, ad esempio testo, discorsi, schede, dati canvas, chip di suggerimenti e così via.
Rappresentazione YAML | |
---|---|
firstSimple: object ( |
Campi | |
---|---|
firstSimple |
Campo facoltativo. La prima risposta vocale e di solo testo. |
content |
Campo facoltativo. Contenuti come una scheda, un elenco o un contenuto multimediale da mostrare all'utente. |
lastSimple |
Campo facoltativo. L'ultima risposta vocale e di solo testo. |
suggestions[] |
Campo facoltativo. Suggerimenti da mostrare all'utente, che saranno sempre visualizzati alla fine della risposta. Se il campo |
link |
Campo facoltativo. Un chip di suggerimenti aggiuntivo che può rimandare all'app o al sito associati. Il chip verrà visualizzato con il titolo "Apri |
override |
Campo facoltativo. Modalità per l'unione di questi messaggi a quelli definiti in precedenza. |
canvas |
Una risposta da utilizzare per l'esperienza interattiva della stampa su tela. |
StaticSimplePrompt
Rappresenta un semplice prompt da inviare a un utente.
Rappresentazione YAML | |
---|---|
variants:
- object ( |
Campi | |
---|---|
variants[] |
Elenco delle possibili varianti. |
Variante
Rappresenta una variante che fa parte del prompt semplice.
Rappresentazione YAML | |
---|---|
speech: string text: string |
Campi | |
---|---|
speech |
Campo facoltativo. Rappresenta il parlato che verrà detto all'utente. Può essere SSML o sintesi vocale. Per impostazione predefinita, la voce verrà aggiunta a quella del prompt semplice precedente. Se il campo |
text |
Campo facoltativo. Testo da visualizzare nel fumetto della chat. Se non viene specificato, verrà utilizzato il rendering visualizzato del campo vocale qui sopra. Limite: 640 caratteri. Per impostazione predefinita, il testo verrà aggiunto al testo del prompt semplice precedente. Se il campo |
StaticContentPrompt
Un segnaposto per la parte Contenuto di un prompt statico.
Rappresentazione YAML | |
---|---|
# Union field |
Campi | ||
---|---|---|
Campo di unione content . In un prompt può essere presente un solo tipo di contenuto. content può essere solo uno dei seguenti: |
||
card |
Una scheda di base. |
|
image |
Un'immagine. |
|
table |
Scheda tabella. |
|
media |
Risposta che indica un insieme di contenuti multimediali da riprodurre. |
|
list |
Una scheda per presentare un elenco di opzioni tra cui scegliere. |
|
collection |
Una scheda con un elenco di opzioni tra cui scegliere. |
|
collectionBrowse |
Una scheda che presenta una raccolta di pagine web da aprire. |
StaticCardPrompt
Una scheda di base per visualizzare alcune informazioni, ad esempio un'immagine e/o del testo.
Rappresentazione YAML | |
---|---|
title: string subtitle: string text: string image: object ( |
Campi | |
---|---|
title |
Campo facoltativo. Titolo generale della scheda. |
subtitle |
Campo facoltativo. Sottotitolo della scheda. |
text |
Obbligatorio. Corpo del testo della scheda necessario, a meno che non sia presente un'immagine. Supporta un insieme limitato di sintassi di markdown per la formattazione. |
image |
Campo facoltativo. Un'immagine promozionale per la scheda. L'altezza è fissa a 192 dp. |
imageFill |
Campo facoltativo. Il modo in cui verrà riempito lo sfondo dell'immagine. |
button |
Campo facoltativo. Un pulsante cliccabile da mostrare nella scheda. |
StaticImagePrompt
Un'immagine visualizzata nella scheda.
Rappresentazione YAML | |
---|---|
url: string alt: string height: integer width: integer |
Campi | |
---|---|
url |
Obbligatorio. L'URL di origine dell'immagine. Le immagini possono essere JPG, PNG e GIF (animate e non animate). Ad esempio, |
alt |
Obbligatorio. Una descrizione testuale dell'immagine da utilizzare per l'accessibilità, ad esempio screen reader. |
height |
Campo facoltativo. L'altezza dell'immagine in pixel. |
width |
Campo facoltativo. La larghezza dell'immagine in pixel. |
StaticLinkPrompt
Definisce un link che verrà visualizzato come chip di suggerimenti e può essere aperto dall'utente.
Rappresentazione YAML | |
---|---|
name: string
open:
object ( |
Campi | |
---|---|
name |
Nome del collegamento |
open |
Definisce il comportamento quando l'utente apre il link. |
OpenUrl
Definisce il comportamento quando l'utente apre il link.
Rappresentazione YAML | |
---|---|
url: string
hint: enum ( |
Campi | |
---|---|
url |
Il campo dell'URL, che può essere uno dei seguenti: - URL http/https per aprire un'app o una pagina web collegate all'app |
hint |
Indica un suggerimento per il tipo di URL. |
StaticTablePrompt
Una scheda per visualizzare una tabella di testo.
Rappresentazione YAML | |
---|---|
title: string subtitle: string image: object ( |
Campi | |
---|---|
title |
Campo facoltativo. Titolo generale della tabella. Deve essere impostato se è impostato un sottotitolo. |
subtitle |
Campo facoltativo. Sottotitolo della tabella. |
image |
Campo facoltativo. Immagine associata alla tabella. |
columns[] |
Campo facoltativo. Intestazioni e allineamento delle colonne. |
rows[] |
Campo facoltativo. Dati delle righe della tabella. È garantito che vengano mostrate le prime 3 righe, ma altre potrebbero essere tagliate su alcune superfici. Fai una prova con il simulatore per vedere quali righe verranno mostrate per una determinata superficie. Sulle piattaforme che supportano la funzionalità |
button |
Campo facoltativo. Pulsante. |
TableColumn
Descrive una colonna nella tabella.
Rappresentazione YAML | |
---|---|
header: string
align: enum ( |
Campi | |
---|---|
header |
Testo dell'intestazione per la colonna. |
align |
Allineamento orizzontale della colonna dei contenuti in alto. Se non specificati, i contenuti verranno allineati al bordo iniziale. |
TableRow
Descrive una riga della tabella.
Rappresentazione YAML | |
---|---|
cells:
- object ( |
Campi | |
---|---|
cells[] |
Celle in questa riga. È garantito che le prime 3 celle vengano visualizzate, ma altre potrebbero essere tagliate su determinate superfici. Fai una prova con il simulatore per vedere quali celle verranno mostrate per una determinata superficie. |
divider |
Indica se dopo ogni riga deve essere presente un divisore. |
TableCell
Descrive una cella in una riga.
Rappresentazione YAML | |
---|---|
text: string |
Campi | |
---|---|
text |
Contenuti testuali della cella. |
StaticMediaPrompt
Contiene informazioni sui contenuti multimediali, come nome, descrizione, URL e così via. ID successivo: 11
Rappresentazione YAML | |
---|---|
mediaType: enum ( |
Campi | |
---|---|
mediaType |
Tipo multimediale di questa risposta. |
startOffset |
Offset iniziale del primo oggetto multimediale. Una durata in secondi con un massimo di nove cifre frazionarie, terminata da " |
optionalMediaControls[] |
Tipi di controlli multimediali facoltativi supportati da questa sessione di risposte multimediali. Se impostato, la richiesta verrà effettuata a 3p quando si verifica un determinato evento multimediale. Se non viene configurato, 3p deve comunque gestire due tipi di controllo predefiniti, FINISHED e FAILED. |
mediaObjects[] |
Elenco di oggetti multimediali. |
repeatMode |
Modalità di ripetizione per l'elenco di oggetti multimediali. |
MediaObject
Rappresenta un singolo oggetto multimediale.
Rappresentazione YAML | |
---|---|
name: string
description: string
url: string
image:
object ( |
Campi | |
---|---|
name |
Il nome dell'oggetto multimediale. |
description |
Descrizione di questo oggetto multimediale. |
url |
L'URL che rimanda ai contenuti multimediali. |
image |
Immagine da mostrare con la scheda Contenuti multimediali. |
MediaImage
Immagine da visualizzare all'interno di un MediaPrompt.
Rappresentazione YAML | |
---|---|
# Union field |
Campi | ||
---|---|---|
Campo di unione image . È consentito un solo tipo di MediaImage. image può essere solo uno dei seguenti: |
||
large |
Un'immagine di grandi dimensioni, ad esempio la copertina dell'album e così via. |
|
icon |
Una piccola icona con un'immagine visualizzata sulla destra del titolo. Viene ridimensionato a 36 x 36 dp. |
StaticListPrompt
Una scheda per presentare un elenco di opzioni tra cui scegliere.
Rappresentazione YAML | |
---|---|
title: string
subtitle: string
items:
- object ( |
Campi | |
---|---|
title |
Campo facoltativo. Titolo dell'elenco. |
subtitle |
Campo facoltativo. Sottotitolo dell'elenco. |
items[] |
Obbligatorio. Voci dell'elenco. |
ListItem
Un elemento dell'elenco.
Rappresentazione YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Campi | |
---|---|
key |
Obbligatorio. La chiave NLU che corrisponde al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene riportata come parametro di opzione di selezione. |
title |
Obbligatorio. Titolo dell'elemento. Una volta toccato, il testo viene pubblicato nuovamente nella conversazione, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco nell'insieme di elementi. |
description |
Campo facoltativo. Corpo del testo dell'elemento. |
image |
Campo facoltativo. Immagine dell'elemento. |
StaticCollectionPrompt
Una scheda per presentare una raccolta di opzioni tra cui scegliere.
Rappresentazione YAML | |
---|---|
title: string subtitle: string items: - object ( |
Campi | |
---|---|
title |
Campo facoltativo. Titolo della raccolta. |
subtitle |
Campo facoltativo. Sottotitolo della raccolta. |
items[] |
Obbligatorio. Elementi della raccolta. |
imageFill |
Campo facoltativo. Tipo di opzione di visualizzazione dell'immagine. |
CollectionItem
Un elemento della raccolta.
Rappresentazione YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Campi | |
---|---|
key |
Obbligatorio. La chiave NLU che corrisponde al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene riportata come parametro di opzione di selezione. |
title |
Obbligatorio. Titolo dell'elemento. Una volta toccato, il testo viene pubblicato nuovamente nella conversazione, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco nell'insieme di elementi. |
description |
Campo facoltativo. Corpo del testo dell'elemento. |
image |
Campo facoltativo. Immagine dell'elemento. |
StaticCollectionBrowsePrompt
Presenta un insieme di documenti web come una raccolta di elementi di grandi dimensioni. È possibile selezionare gli elementi per avviare il documento web associato in un visualizzatore web.
Rappresentazione YAML | |
---|---|
items: - object ( |
Campi | |
---|---|
items[] |
Elementi nella raccolta Sfoglia. La dimensione dell'elenco deve essere compresa nell'intervallo [2, 10]. |
imageFill |
Opzione di visualizzazione delle immagini per le immagini della raccolta. |
CollectionBrowseItem
Elemento nella raccolta.
Rappresentazione YAML | |
---|---|
title: string description: string footer: string image: object ( |
Campi | |
---|---|
title |
Obbligatorio. Titolo dell'elemento della raccolta. |
description |
Descrizione dell'elemento della raccolta. |
footer |
Testo a piè di pagina per l'elemento della raccolta, visualizzato sotto la descrizione. Singola riga di testo, troncata con i puntini di sospensione. |
image |
Immagine per l'elemento della raccolta. |
openUriAction |
Obbligatorio. URI da aprire se l'elemento è selezionato. |
Suggerimento
Rappresenta un chip di suggerimenti, un elemento UI mostrato all'utente per praticità.
Rappresentazione YAML | |
---|---|
title: string |
Campi | |
---|---|
title |
Obbligatorio. Il testo mostrato nel chip di suggerimento. Una volta toccato, il testo viene pubblicato nuovamente nella conversazione, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco nell'insieme di chip di suggerimenti. Massimo 25 caratteri |
StaticCanvasPrompt
Rappresenta una risposta Interactive Canvas da inviare all'utente. Questa opzione può essere utilizzata in combinazione con il campo firstSimple
nel prompt contenitore per parlare con l'utente, oltre a visualizzare una risposta canvas interattiva.
Rappresentazione YAML | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
Campi | |
---|---|
url |
Obbligatorio. URL della visualizzazione web da caricare. |
data[] |
Campo facoltativo. Dati JSON da trasmettere alla pagina web dell'esperienza immersiva sotto forma di evento. Se il campo |
suppressMic |
Campo facoltativo. Un valore true indica che il microfono non verrà aperto per acquisire l'input dopo che questa risposta immersiva viene presentata all'utente. |
sendStateDataToCanvasApp |
Campo facoltativo. Se |
enableFullScreen |
Campo facoltativo. Se |
continueTtsDuringTouch |
Campo facoltativo. Se il valore è true, i tocchi sullo schermo non interromperanno la sintesi vocale per l'intera sessione di canvas. Valore predefinito: false. |