- StaticPromptCandidate
- Selettore
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- Suggerimento
- StaticCanvasPrompt
Rappresenta un elenco di candidati, uno dei quali verrà selezionato come prompt da mostrare nella risposta all'utente. Questo messaggio è localizzabile.
Rappresentazione JSON | |
---|---|
{
"candidates": [
{
object ( |
Campi | |
---|---|
candidates[] |
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 JSON | |
---|---|
{ "selector": { object ( |
Campi | |
---|---|
selector |
(Facoltativo) Il criterio per determinare se questo prompt corrisponde a una richiesta. Se il selettore è vuoto, questo prompt verrà attivato sempre. |
promptResponse |
La risposta del prompt associata al selettore. |
Selettore
Definisce i criteri per stabilire se un prompt corrisponde a una richiesta.
Rappresentazione JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Campi | |
---|---|
surfaceCapabilities |
L'insieme di capacità di superficie richieste. |
SurfaceCapabilities
Rappresenta la piattaforma utilizzata dall'utente per inviare una richiesta all'azione.
Rappresentazione JSON | |
---|---|
{
"capabilities": [
enum ( |
Campi | |
---|---|
capabilities[] |
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 JSON | |
---|---|
{ "firstSimple": { object ( |
Campi | |
---|---|
firstSimple |
(Facoltativo) La prima risposta vocale e di solo testo. |
content |
(Facoltativo) Contenuti come una scheda, un elenco o contenuti multimediali da mostrare all'utente. |
lastSimple |
(Facoltativo) L'ultima risposta vocale e di solo testo. |
suggestions[] |
(Facoltativo) Suggerimenti da mostrare all'utente, che saranno sempre visualizzati alla fine della risposta. Se l'opzione "Aggiungi" il campo nel prompt contenitore è "true" i titoli definiti in questo campo verranno aggiunti ai titoli definiti in qualsiasi richiesta di suggerimenti definita in precedenza e i valori duplicati verranno rimossi. |
link |
(Facoltativo) Un chip di suggerimento aggiuntivo che può rimandare all'app o al sito associato. Il chip verrà visualizzato con il titolo "Apri |
override |
(Facoltativo) Modalità per unire questi messaggi a messaggi definiti in precedenza. "vero" cancellerà tutti i messaggi definiti in precedenza (primo e ultimo semplice, contenuti, link dei suggerimenti e canvas) e aggiungerà i messaggi definiti in questo prompt. "false" aggiungerà i messaggi definiti in questo prompt a quelli definiti nelle risposte precedenti. Se imposti questo campo su "false" attiverà anche l'aggiunta ad alcuni campi all'interno dei prompt semplici, del prompt Suggestions e del prompt Canvas (parte del prompt Content). I messaggi Contenuti e Link vengono sempre sovrascritti, se definiti nel prompt. Il valore predefinito è "false". |
canvas |
Una risposta da utilizzare per l'esperienza interattiva sulla tela. |
StaticSimplePrompt
Rappresenta un semplice prompt da inviare a un utente.
Rappresentazione JSON | |
---|---|
{
"variants": [
{
object ( |
Campi | |
---|---|
variants[] |
Elenco delle possibili varianti. |
Variante
Rappresenta una variante che fa parte del prompt semplice.
Rappresentazione JSON | |
---|---|
{ "speech": string, "text": string } |
Campi | |
---|---|
speech |
(Facoltativo) Rappresenta il discorso da pronunciare all'utente. Può essere SSML o sintesi vocale. Se l'opzione "Aggiungi" il campo nel prompt contenitore è "true" la voce definita in questo campo verrà aggiunta alla voce del prompt semplice precedente. |
text |
(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. Se l'opzione "Aggiungi" il campo nel prompt contenitore è "true" il testo definito in questo campo verrà aggiunto al testo del prompt semplice precedente. |
StaticContentPrompt
Un segnaposto per la parte relativa ai contenuti di un prompt statico.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo unione content . In un prompt può essere presente un solo tipo di contenuto. content può essere solo uno dei seguenti: |
||
card |
Una carta 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 che presenta un elenco di opzioni tra cui scegliere. |
StaticCardPrompt
Una scheda di base per visualizzare alcune informazioni, ad esempio un'immagine e/o del testo.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo generale della scheda. |
subtitle |
(Facoltativo) Sottotitolo della scheda. |
text |
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 |
(Facoltativo) Un'immagine hero per la carta. L'altezza è fissa a 192 dp. |
imageFill |
(Facoltativo) Il modo in cui lo sfondo dell'immagine verrà riempito. |
button |
(Facoltativo) Un pulsante cliccabile da mostrare nella scheda. |
StaticImagePrompt
Un'immagine visualizzata nella scheda.
Rappresentazione JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Campi | |
---|---|
url |
Obbligatorio. L'URL di origine dell'immagine. Le immagini possono essere in formato JPG, PNG e GIF (animate e non animate). Ad esempio, |
alt |
Obbligatorio. Una descrizione testuale dell'immagine da utilizzare per l'accessibilità, ad es. screen reader. |
height |
(Facoltativo) L'altezza dell'immagine in pixel. |
width |
(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 JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Campi | |
---|---|
name |
Nome del link |
open |
Definisce il comportamento quando l'utente apre il link. |
OpenUrl
Definisce il comportamento quando l'utente apre il link.
Rappresentazione JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Campi | |
---|---|
url |
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 |
Indica un suggerimento per il tipo di URL. |
StaticTablePrompt
Una scheda per visualizzare una tabella di testo.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo generale della tabella. Deve essere impostato se sono stati impostati i sottotitoli. |
subtitle |
(Facoltativo) Sottotitolo per la tabella. |
image |
(Facoltativo) Immagine associata alla tabella. |
columns[] |
(Facoltativo) Intestazioni e allineamento delle colonne. |
rows[] |
(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 |
(Facoltativo) Pulsante. |
TableColumn
Descrive una colonna della tabella.
Rappresentazione JSON | |
---|---|
{
"header": string,
"align": enum ( |
Campi | |
---|---|
header |
Testo dell'intestazione per la colonna. |
align |
Allineamento orizzontale dei contenuti rispetto alla colonna. Se non specificato, i contenuti verranno allineati al bordo iniziale. |
TableRow
Descrive una riga della tabella.
Rappresentazione JSON | |
---|---|
{
"cells": [
{
object ( |
Campi | |
---|---|
cells[] |
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 |
Indica se deve esserci un divisore dopo ogni riga. |
TableCell
Descrive una cella in una riga.
Rappresentazione JSON | |
---|---|
{ "text": string } |
Campi | |
---|---|
text |
Contenuto testuale della cella. |
StaticMediaPrompt
Contiene informazioni sul contenuto multimediale, come nome, descrizione, URL e così via. ID successivo: 9
Rappresentazione JSON | |
---|---|
{ "mediaType": enum ( |
Campi | |
---|---|
mediaType |
Tipo multimediale di questa risposta. |
startOffset |
Offset iniziale del primo oggetto multimediale. Durata in secondi con un massimo di nove cifre frazionarie, terminata da " |
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[] |
Elenco di oggetti multimediali. |
MediaObject
Rappresenta un singolo oggetto multimediale.
Rappresentazione JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Campi | |
---|---|
name |
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 dei contenuti multimediali. |
MediaImage
Immagine da mostrare all'interno di un MediaPrompt.
Rappresentazione JSON | |
---|---|
{ // Union field |
Campi | ||
---|---|---|
Campo unione image . È consentito un solo tipo di MediaImage. image può essere solo uno dei seguenti: |
||
large |
Un'immagine di grandi dimensioni, come la copertina dell'album e così via. |
|
icon |
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 JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo dell'elenco. |
subtitle |
(Facoltativo) Sottotitolo dell'elenco. |
items[] |
Obbligatorio. Voci dell'elenco. |
ListItem
Un elemento dell'elenco.
Rappresentazione JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campi | |
---|---|
key |
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 |
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 |
(Facoltativo) Corpo del testo dell'elemento. |
image |
(Facoltativo) Immagine elemento. |
StaticCollectionPrompt
Una scheda per presentare una raccolta di opzioni tra cui scegliere.
Rappresentazione JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Campi | |
---|---|
title |
(Facoltativo) Titolo della raccolta. |
subtitle |
(Facoltativo) Sottotitolo della raccolta. |
items[] |
Obbligatorio. Elementi della raccolta. |
imageFill |
(Facoltativo) Tipo di opzione di visualizzazione dell'immagine. |
CollectionItem
Un elemento nella raccolta.
Rappresentazione JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campi | |
---|---|
key |
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 |
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 |
(Facoltativo) Corpo del testo dell'elemento. |
image |
(Facoltativo) Immagine elemento. |
Suggerimento
Rappresenta un chip di suggerimento, un elemento UI mostrato all'utente per comodità.
Rappresentazione JSON | |
---|---|
{ "title": string } |
Campi | |
---|---|
title |
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" nel prompt contenente per parlare con l'utente oltre a visualizzare una risposta canvas interattiva.
Rappresentazione JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
Campi | |
---|---|
url |
Obbligatorio. URL della vista web da caricare. |
data[] |
(Facoltativo) Dati JSON da trasmettere alla pagina web dell'esperienza immersiva sotto forma di evento. Se l'opzione "override" il campo 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 |
(Facoltativo) Un valore reale indica che il microfono non si aprirà per acquisire l'input dopo aver presentato questa risposta immersiva all'utente. |