EventHandler

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 prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
Campi
webhookHandler

string

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

object (StaticPrompt)

Prompt statico incorporato. Può contenere riferimenti a risorse stringa nei pacchetti.
staticPromptName

string

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 (StaticPromptCandidate)
Campi
candidates[]

object (StaticPromptCandidate)

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 (Selector)
promptResponse: 
  object (StaticPromptResponse)
Campi
selector

object (Selector)

Campo facoltativo. I criteri per stabilire se questo prompt corrisponde a una richiesta. Se il selettore è vuoto, verrà sempre attivato questo messaggio.
promptResponse

object (StaticPromptResponse)

La risposta del prompt associata al selettore.

Selettore

Definisce i criteri per stabilire se un prompt corrisponde a una richiesta.

Rappresentazione YAML 
surfaceCapabilities: 
  object (SurfaceCapabilities)
Campi
surfaceCapabilities

object (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 (Capability)
Campi
capabilities[]

enum (Capability)

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 (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
Campi
firstSimple

object (StaticSimplePrompt)

Campo facoltativo. La prima risposta vocale e di solo testo.
content

object (StaticContentPrompt)

Campo facoltativo. Contenuti come una scheda, un elenco o un contenuto multimediale da mostrare all'utente.
lastSimple

object (StaticSimplePrompt)

Campo facoltativo. L'ultima risposta vocale e di solo testo.
suggestions[]

object (Suggestion)

Campo facoltativo. Suggerimenti da mostrare all'utente, che saranno sempre visualizzati alla fine della risposta. Se il campo append nel prompt contenente è true, i titoli definiti in questo campo verranno aggiunti ai titoli definiti nei prompt di suggerimenti definiti in precedenza e i valori duplicati verranno rimossi.
override

boolean

Campo facoltativo. Modalità per l'unione di questi messaggi a quelli definiti in precedenza. true cancellerà tutti i messaggi definiti in precedenza (primo e ultimo semplice, contenuti, link ai suggerimenti e canvas) e aggiungerà i messaggi definiti in questo prompt. false aggiungerà i messaggi definiti in questa richiesta ai messaggi definiti nelle risposte precedenti. Se imposti questo campo su false, consenti anche l'aggiunta ad alcuni campi all'interno dei prompt semplici, del prompt dei suggerimenti e di Canvas (parte del prompt dei contenuti). I messaggi relativi ai contenuti e ai link verranno sempre sovrascritti, se definiti nel prompt. Il valore predefinito è false.
canvas

object (StaticCanvasPrompt)

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 (Variant)
Campi
variants[]

object (Variant)

Elenco delle possibili varianti.

Variante

Rappresenta una variante che fa parte del prompt semplice.

Rappresentazione YAML 
speech: string
text: string
Campi
speech

string

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 override nel prompt contenente è true, la voce definita in questo campo sostituirà quella del prompt semplice precedente.
text

string

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 override nel prompt contenente è true, il testo definito in questo campo sostituirà il testo del prompt semplice precedente.

StaticContentPrompt

Un segnaposto per la parte Contenuto di un prompt statico.

Rappresentazione YAML 
# Union field content can be only one of the following:
card: 
  object (StaticCardPrompt)
image: 
  object (StaticImagePrompt)
table: 
  object (StaticTablePrompt)
media: 
  object (StaticMediaPrompt)
list: 
  object (StaticListPrompt)
collection: 
  object (StaticCollectionPrompt)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.
Campi
Campo di unione content. In un prompt può essere presente un solo tipo di contenuto. content può essere solo uno dei seguenti:
card

object (StaticCardPrompt)

Una scheda di base.
image

object (StaticImagePrompt)

Un'immagine.
table

object (StaticTablePrompt)

Scheda tabella.
media

object (StaticMediaPrompt)

Risposta che indica un insieme di contenuti multimediali da riprodurre.
list

object (StaticListPrompt)

Una scheda per presentare un elenco di opzioni tra cui scegliere.
collection

object (StaticCollectionPrompt)

Una scheda con un elenco di opzioni tra cui scegliere.
collectionBrowse

object (StaticCollectionBrowsePrompt)

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 (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
Campi
title

string

Campo facoltativo. Titolo generale della scheda.
subtitle

string

Campo facoltativo. Sottotitolo della scheda.
text

string

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

object (StaticImagePrompt)

Campo facoltativo. Un'immagine promozionale per la scheda. L'altezza è fissa a 192 dp.
imageFill

enum (ImageFill)

Campo facoltativo. Il modo in cui verrà riempito lo sfondo dell'immagine.
button

object (StaticLinkPrompt)

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

string

Obbligatorio. L'URL di origine dell'immagine. Le immagini possono essere JPG, PNG e GIF (animate e non animate). Ad esempio,https://www.agentx.com/logo.png.
alt

string

Obbligatorio. Una descrizione testuale dell'immagine da utilizzare per l'accessibilità, ad esempio screen reader.
height

integer

Campo facoltativo. L'altezza dell'immagine in pixel.
width

integer

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 (OpenUrl)
Campi
name

string

Nome del collegamento
open

object (OpenUrl)

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 (UrlHint)
Campi
url

string

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

enum (UrlHint)

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 (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
Campi
title

string

Campo facoltativo. Titolo generale della tabella. Deve essere impostato se è impostato un sottotitolo.
subtitle

string

Campo facoltativo. Sottotitolo della tabella.
image

object (StaticImagePrompt)

Campo facoltativo. Immagine associata alla tabella.
columns[]

object (TableColumn)

Campo facoltativo. Intestazioni e allineamento delle colonne.
rows[]

object (TableRow)

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à WEB_BROWSER, puoi indirizzare l'utente a una pagina web con più dati.
button

object (StaticLinkPrompt)

Campo facoltativo. Pulsante.

TableColumn

Descrive una colonna nella tabella.

Rappresentazione YAML 
header: string
align: enum (HorizontalAlignment)
Campi
header

string

Testo dell'intestazione per la colonna.
align

enum (HorizontalAlignment)

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 (TableCell)
divider: boolean
Campi
cells[]

object (TableCell)

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

boolean

Indica se dopo ogni riga deve essere presente un divisore.

TableCell

Descrive una cella in una riga.

Rappresentazione YAML 
text: string
Campi
text

string

Contenuti testuali della cella.

StaticMediaPrompt

Contiene informazioni sui contenuti multimediali, come nome, descrizione, URL e così via. ID successivo: 11

Rappresentazione YAML 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
Campi
mediaType

enum (MediaType)

Tipo multimediale di questa risposta.
startOffset

string (Duration format)

Offset iniziale del primo oggetto multimediale.

Una durata in secondi con un massimo di nove cifre frazionarie, terminata da "s". Esempio: "3.5s".
optionalMediaControls[]

enum (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[]

object (MediaObject)

Elenco di oggetti multimediali.
repeatMode

enum (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 (MediaImage)
Campi
name

string

Il nome dell'oggetto multimediale.
description

string

Descrizione di questo oggetto multimediale.
url

string

L'URL che rimanda ai contenuti multimediali.
image

object (MediaImage)

Immagine da mostrare con la scheda Contenuti multimediali.

MediaImage

Immagine da visualizzare all'interno di un MediaPrompt.

Rappresentazione YAML 
# Union field image can be only one of the following:
large: 
  object (StaticImagePrompt)
icon: 
  object (StaticImagePrompt)
# End of list of possible types for union field image.
Campi
Campo di unione image. È consentito un solo tipo di MediaImage. image può essere solo uno dei seguenti:
large

object (StaticImagePrompt)

Un'immagine di grandi dimensioni, ad esempio la copertina dell'album e così via.
icon

object (StaticImagePrompt)

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 (ListItem)
Campi
title

string

Campo facoltativo. Titolo dell'elenco.
subtitle

string

Campo facoltativo. Sottotitolo dell'elenco.
items[]

object (ListItem)

Obbligatorio. Voci dell'elenco.

ListItem

Un elemento dell'elenco.

Rappresentazione YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Campi
key

string

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

string

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

string

Campo facoltativo. Corpo del testo dell'elemento.
image

object (StaticImagePrompt)

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 (CollectionItem)
imageFill: enum (ImageFill)
Campi
title

string

Campo facoltativo. Titolo della raccolta.
subtitle

string

Campo facoltativo. Sottotitolo della raccolta.
items[]

object (CollectionItem)

Obbligatorio. Elementi della raccolta.
imageFill

enum (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 (StaticImagePrompt)
Campi
key

string

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

string

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

string

Campo facoltativo. Corpo del testo dell'elemento.
image

object (StaticImagePrompt)

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 (CollectionBrowseItem)
imageFill: enum (ImageFill)
Campi
items[]

object (CollectionBrowseItem)

Elementi nella raccolta Sfoglia. La dimensione dell'elenco deve essere compresa nell'intervallo [2, 10].
imageFill

enum (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 (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Campi
title

string

Obbligatorio. Titolo dell'elemento della raccolta.
description

string

Descrizione dell'elemento della raccolta.
footer

string

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

object (StaticImagePrompt)

Immagine per l'elemento della raccolta.
openUriAction

object (OpenUrl)

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

string

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

string

Obbligatorio. URL della visualizzazione web da caricare.
data[]

value (Value format)

Campo facoltativo. Dati JSON da trasmettere alla pagina web dell'esperienza immersiva sotto forma di evento. Se il campo override nel prompt contenitore è false, i valori dei dati definiti in questo prompt di Canvas verranno aggiunti dopo i valori dei dati definiti nei prompt di Canvas precedenti.
suppressMic

boolean

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

boolean

Campo facoltativo. Se true, i metadati relativi alla conversazione sono inclusi e vengono inviati nuovamente all'applicazione canvas.
enableFullScreen

boolean

Campo facoltativo. Se true l'applicazione canvas occupa lo schermo intero e non avrà un'intestazione nella parte superiore. Nella schermata di caricamento verrà inoltre visualizzato un avviso popup che include il nome visualizzato dell'Azione, il nome dello sviluppatore e le istruzioni per uscire dall'Azione. Valore predefinito: false.
continueTtsDuringTouch

boolean

Campo facoltativo. Se il valore è true, i tocchi sullo schermo non interromperanno la sintesi vocale per l'intera sessione di canvas. Valore predefinito: false.