EventHandler

Definisce un gestore da eseguire dopo un evento. Esempi di eventi sono quelli basati su intenzione e condizione 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 webhook da chiamare.

Campo unione prompt. I prompt possono essere incorporati o indicati per nome. prompt può essere solo uno dei seguenti:
staticPrompt

object (StaticPrompt)

Prompt statico incorporato. Può contenere riferimenti a risorse stringa in bundle.

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 di prompt candidati da inviare al client. 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 di prompt statico.

Rappresentazione YAML
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Campi
selector

object (Selector)

(Facoltativo) Il criterio per determinare se questo prompt corrisponde a una richiesta. Se il selettore è vuoto, questo prompt verrà attivato sempre.

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 capacità di superficie richieste.

SurfaceCapabilities

Rappresenta la piattaforma utilizzata dall'utente per inviare una richiesta all'azione.

Rappresentazione YAML
capabilities: 
  - enum (Capability)
Campi
capabilities[]

enum (Capability)

Obbligatorio. Le capacità della superficie che effettua una richiesta all'Azione.

StaticPromptResponse

Rappresenta risposte strutturate da inviare all'utente, come testo, voce, 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)

(Facoltativo) La prima risposta vocale e di solo testo.

content

object (StaticContentPrompt)

(Facoltativo) Contenuti come una scheda, un elenco o contenuti multimediali da mostrare all'utente.

lastSimple

object (StaticSimplePrompt)

(Facoltativo) L'ultima risposta vocale e di solo testo.

suggestions[]

object (Suggestion)

(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 in qualsiasi prompt di suggerimenti definito in precedenza e i valori duplicati verranno rimossi.

override

boolean

(Facoltativo) Modalità per unire questi messaggi a messaggi definiti in precedenza. true cancellerà tutti i messaggi definiti in precedenza (primo e ultimo semplice, contenuti, link dei suggerimenti e canvas) e aggiungerà i messaggi definiti in questa richiesta. false aggiungerà i messaggi definiti in questo prompt a quelli definiti nelle risposte precedenti. Se questo campo viene impostato su false, verrà attivata anche l'aggiunta ad alcuni campi all'interno dei prompt semplici, del prompt Suggerimenti e del prompt di Canvas (parte del prompt di contenuto). I messaggi Contenuti e Link vengono sempre sovrascritti, se definiti nel prompt. Il valore predefinito è false.

canvas

object (StaticCanvasPrompt)

Una risposta da utilizzare per l'esperienza interattiva sulla 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

(Facoltativo) Rappresenta il discorso da pronunciare all'utente. Può essere SSML o sintesi vocale. Per impostazione predefinita, la voce verrà aggiunta alla voce del prompt semplice precedente. Se il campo override nel prompt contenente è true, la voce definita in questo campo sostituirà la voce del prompt semplice precedente.

text

string

(Facoltativo) Testo da visualizzare nel fumetto della chat. Se non viene specificato, verrà utilizzato il rendering del campo vocale riportato sopra. Limitato a 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 relativa ai contenuti 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 unione content. In un prompt può essere presente un solo tipo di contenuto. content può essere solo uno dei seguenti:
card

object (StaticCardPrompt)

Una carta 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 che presenta un elenco di opzioni tra cui scegliere.

collectionBrowse

object (StaticCollectionBrowsePrompt)

Una scheda con 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

(Facoltativo) Titolo generale della scheda.

subtitle

string

(Facoltativo) Sottotitolo della scheda.

text

string

Obbligatorio. Il 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)

(Facoltativo) Un'immagine hero per la carta. L'altezza è fissa a 192 dp.

imageFill

enum (ImageFill)

(Facoltativo) Il modo in cui lo sfondo dell'immagine verrà riempito.

button

object (StaticLinkPrompt)

(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 in formato 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 es. screen reader.

height

integer

(Facoltativo) L'altezza dell'immagine in pixel.

width

integer

(Facoltativo) La larghezza dell'immagine in pixel.

StaticLinkPrompt

Definisce un link che verrà visualizzato come chip di suggerimento e può essere aperto dall'utente.

Rappresentazione YAML
name: string
open: 
  object (OpenUrl)
Campi
name

string

Nome del link

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 url che può essere uno dei seguenti: - URL http/https per l'apertura di un'app collegata all'app o di una pagina web

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

(Facoltativo) Titolo generale della tabella. Deve essere impostato se sono stati impostati i sottotitoli.

subtitle

string

(Facoltativo) Sottotitolo per la tabella.

image

object (StaticImagePrompt)

(Facoltativo) Immagine associata alla tabella.

columns[]

object (TableColumn)

(Facoltativo) Intestazioni e allineamento delle colonne.

rows[]

object (TableRow)

(Facoltativo) Dati delle righe della tabella. È garantita la visualizzazione delle prime tre righe, ma altre potrebbero essere tagliate su determinate superfici. Esegui un test con il simulatore per vedere quali righe verranno visualizzate 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)

(Facoltativo) Pulsante.

TableColumn

Descrive una colonna della tabella.

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

string

Testo dell'intestazione per la colonna.

align

enum (HorizontalAlignment)

Allineamento orizzontale dei contenuti rispetto alla colonna. Se non specificato, 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. È garantita la visualizzazione delle prime 3 celle, ma le altre potrebbero essere tagliate su determinate superfici. Esegui un test con il simulatore per vedere quali celle verranno visualizzate per una determinata superficie.

divider

boolean

Indica se deve esserci un divisore dopo ogni riga.

TableCell

Descrive una cella in una riga.

Rappresentazione YAML
text: string
Campi
text

string

Contenuto testuale della cella.

StaticMediaPrompt

Contiene informazioni sui contenuti multimediali, come nome, descrizione, URL e così via. Next id: 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.

Durata in secondi con un massimo di nove cifre frazionarie, terminata da "s". Esempio: "3.5s".

optionalMediaControls[]

enum (OptionalMediaControls)

Tipi facoltativi di controlli multimediali supportati da questa sessione di risposte multimediali. Se impostato, la richiesta verrà effettuata a terze parti 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

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 dei contenuti multimediali.

MediaImage

Immagine da mostrare 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 unione image. È consentito un solo tipo di MediaImage. image può essere solo uno dei seguenti:
large

object (StaticImagePrompt)

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

icon

object (StaticImagePrompt)

Una piccola icona immagine visualizzata a destra rispetto al 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

(Facoltativo) Titolo dell'elenco.

subtitle

string

(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 corrispondente al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene pubblicata come parametro di opzione di selezione.

title

string

Obbligatorio. Titolo dell'articolo. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere unico nell'insieme di elementi.

description

string

(Facoltativo) Corpo del testo dell'elemento.

image

object (StaticImagePrompt)

(Facoltativo) Immagine 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

(Facoltativo) Titolo della raccolta.

subtitle

string

(Facoltativo) Sottotitolo della raccolta.

items[]

object (CollectionItem)

Obbligatorio. Elementi della raccolta.

imageFill

enum (ImageFill)

(Facoltativo) Tipo di opzione di visualizzazione dell'immagine.

CollectionItem

Un elemento nella raccolta.

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

string

Obbligatorio. La chiave NLU corrispondente al nome della chiave di accesso nel tipo associato. Quando l'elemento viene toccato, questa chiave viene pubblicata come parametro di opzione di selezione.

title

string

Obbligatorio. Titolo dell'articolo. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere unico nell'insieme di elementi.

description

string

(Facoltativo) Corpo del testo dell'elemento.

image

object (StaticImagePrompt)

(Facoltativo) Immagine elemento.

StaticCollectionBrowsePrompt

Presenta un insieme di documenti web come raccolta di elementi di grandi dimensioni. Gli elementi possono essere selezionati 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 nella raccolta.

CollectionBrowseItem

Elemento della 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. Una 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 suggerimento, un elemento UI mostrato all'utente per comodità.

Rappresentazione YAML
title: string
Campi
title

string

Obbligatorio. Il testo mostrato nel chip di suggerimento. Se toccato, il testo viene pubblicato nella conversazione parola per parola, come se l'utente lo avesse digitato. Ogni titolo deve essere univoco tra l'insieme di chip di suggerimento. Massimo 25 caratteri

StaticCanvasPrompt

Rappresenta una risposta di Canvas interattiva da inviare all'utente. Può essere utilizzato in combinazione con il campo firstSimple nella richiesta contenente di 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 vista web da caricare.

data[]

value (Value format)

(Facoltativo) Dati JSON da trasmettere alla pagina web dell'esperienza immersiva sotto forma di evento. Se il campo override nel prompt contenente è 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

(Facoltativo) Un valore reale indica che il microfono non si aprirà per acquisire l'input dopo aver presentato questa risposta immersiva all'utente.

sendStateDataToCanvasApp

boolean

(Facoltativo) Se true, i metadati relativi alla conversazione vengono inclusi e inviati all'applicazione canvas.

enableFullScreen

boolean

(Facoltativo) Se true l'applicazione canvas occupa l'intero schermo e non avrà un'intestazione nella parte superiore. Sulla schermata di caricamento verrà visualizzato anche un messaggio toast che include il nome visualizzato dell'azione, il nome dello sviluppatore e le istruzioni per uscire dall'azione. Valore predefinito: false.

continueTtsDuringTouch

boolean

(Facoltativo) Se il valore è true, i tocchi sullo schermo non interromperanno la sintesi vocale per l'intera sessione su tela. Valore predefinito: false.