EventHandler

candidates: 
  - object (StaticPromptCandidate)

object (StaticPromptCandidate)

A lista de possíveis prompts a serem enviados ao cliente. Cada comando tem um seletor para determinar quando pode ser usado. O primeiro seletor que corresponder a uma solicitação será enviado e o restante será ignorado.

selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)

object (Selector)

Opcional. Os critérios para determinar se esse comando corresponde a uma solicitação. Se o seletor estiver vazio, essa solicitação será sempre acionada.

object (StaticPromptResponse)

A resposta de solicitação associada ao seletor.

surfaceCapabilities: 
  object (SurfaceCapabilities)

object (SurfaceCapabilities)

O conjunto de recursos de superfície necessários.

capabilities: 
  - enum (Capability)

enum (Capability)

Obrigatório. Os recursos da superfície que faz uma solicitação à ação.

firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)

object (StaticSimplePrompt)

Opcional. A primeira resposta somente de voz e de texto.

object (StaticContentPrompt)

Opcional. Um conteúdo como um card, uma lista ou uma mídia para mostrar ao usuário.

object (StaticSimplePrompt)

Opcional. A última resposta somente de texto e voz.

object (Suggestion)

Opcional. São sugestões a serem exibidas para o usuário e sempre aparecem no final da resposta. Se o campo append no comando que contém for true, os títulos definidos neste campo serão adicionados àqueles definidos em qualquer solicitação de sugestão definida anteriormente, e os valores duplicados serão removidos.

object (StaticLinkPrompt)

Opcional. Um ícone de sugestão adicional que pode ser vinculado ao app ou site associado. O ícone será renderizado com o título "Abrir ". Máximo de 20 caracteres.

boolean

Opcional. Modo de como essas mensagens devem ser mescladas com mensagens definidas anteriormente. O true vai apagar todas as mensagens definidas anteriormente (a primeira e a última mensagem simples, conteúdo, link de sugestões e tela) e adicionar as mensagens definidas neste comando. O false vai adicionar as mensagens definidas nesse comando às mensagens definidas nas respostas anteriores. Definir este campo como false também vai ativar a anexação em alguns campos nos comandos simples, nas opções "Suggestions" e "Canvas", que são parte da instrução "Content". As mensagens "Conteúdo" e "Link" sempre serão substituídas se forem definidas no comando. O valor padrão é false.

object (StaticCanvasPrompt)

Uma resposta a ser usada para a experiência de tela interativa.

variants: 
  - object (Variant)

object (Variant)

Lista de possíveis variantes.

speech: string
text: string

string

Opcional. Representa a fala a ser falada ao usuário. Pode ser SSML ou conversão de texto em voz. Por padrão, a fala será anexada à fala do comando simples anterior. Se o campo override no comando que contém for true, a fala definida nesse campo vai substituir a fala do comando simples anterior.

string

Opcional. Texto a ser exibido no balão do chat. Se não for informado, será usada uma renderização de exibição do campo de fala acima. Limitado a 640 caracteres. Por padrão, o texto será anexado ao texto do comando simples anterior. Se o campo override no comando for true, o texto definido nesse campo vai substituir o texto do comando simples anterior.

# 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.

object (StaticCardPrompt)

Um cartão básico.

object (StaticImagePrompt)

Uma imagem.

object (StaticTablePrompt)

Card da tabela.

object (StaticMediaPrompt)

Resposta indicando um conjunto de mídia a ser reproduzido.

object (StaticListPrompt)

Um card para apresentar uma lista de opções.

object (StaticCollectionPrompt)

Um card com uma lista de opções para seleção.

object (StaticCollectionBrowsePrompt)

Um card que apresenta uma coleção de páginas da Web a serem abertas.

title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)

string

Opcional. Título geral do card.

string

Opcional. Subtítulo do card.

string

Obrigatório. Corpo de texto do card, que é necessário, a menos que haja uma imagem. Oferece suporte a um conjunto limitado de sintaxes de marcação para formatação.

object (StaticImagePrompt)

Opcional. Uma imagem principal para o cartão. A altura é fixada em 192 dp.

enum (ImageFill)

Opcional. Como o plano de fundo da imagem será preenchido.

object (StaticLinkPrompt)

Opcional. Um botão clicável que será mostrado no card.

url: string
alt: string
height: integer
width: integer

string

Obrigatório. O URL de origem da imagem. As imagens podem ser JPG, PNG e GIF (animadas ou não). Por exemplo,https://www.agentx.com/logo.png.

string

Obrigatório. Uma descrição de texto da imagem a ser usada para acessibilidade, por exemplo, e leitores de tela.

integer

Opcional. A altura da imagem, em pixels.

integer

Opcional. A largura da imagem, em pixels.

name: string
open: 
  object (OpenUrl)

string

Nome do link

object (OpenUrl)

Define o comportamento quando o usuário abre o link.

url: string
hint: enum (UrlHint)

string

O campo do URL, que pode ser qualquer um destes: URLs http/https para abrir um app vinculado a um app ou uma página da Web

enum (UrlHint)

Indica uma dica para o tipo de URL.

title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)

string

Opcional. Título geral da tabela. Precisa ser definido se o subtítulo estiver definido.

string

Opcional. Subtítulo da tabela.

object (StaticImagePrompt)

Opcional. Imagem associada à tabela.

object (TableColumn)

Opcional. Cabeçalhos e alinhamento de colunas.

object (TableRow)

Opcional. Dados de linha da tabela. As primeiras três linhas serão exibidas, mas outras poderão ser cortadas em determinadas superfícies. Teste com o simulador para saber quais linhas serão exibidas para uma determinada superfície. Em plataformas com suporte ao recurso WEB_BROWSER, você pode direcionar o usuário para uma página da Web com mais dados.

object (StaticLinkPrompt)

Opcional. Botão.

header: string
align: enum (HorizontalAlignment)

string

Texto do cabeçalho da coluna.

enum (HorizontalAlignment)

Alinhamento horizontal da coluna de texto do conteúdo. Se não for especificado, o conteúdo será alinhado à borda inicial.

cells: 
  - object (TableCell)
divider: boolean

object (TableCell)

Células nesta linha. As primeiras três células serão exibidas, mas outras poderão ser cortadas em determinadas superfícies. Faça o teste com o simulador para ver quais células serão exibidas em uma determinada superfície.

boolean

Indica se deve haver um divisor após cada linha.

text: string

string

Conteúdo de texto da célula.

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

enum (MediaType)

Tipo de mídia dessa resposta.

string (Duration format)

Deslocamento inicial do primeiro objeto de mídia.

Uma duração em segundos com até nove dígitos fracionários, encerrada por "s". Exemplo: "3.5s".

enum (OptionalMediaControls)

Tipos de controle de mídia opcionais compatíveis com esta sessão de resposta de mídia. Se definido, a solicitação será feita para 3p quando um determinado evento de mídia acontecer. Se não definido, 3p ainda deve lidar com dois tipos de controle padrão, FINISHED e FAILED.

object (MediaObject)

Lista de objetos de mídia.

enum (RepeatMode)

Modo de repetição para a lista de objetos de mídia.

name: string
description: string
url: string
image: 
  object (MediaImage)

string

Nome desse objeto de mídia.

string

Descrição desse objeto de mídia.

string

O URL que aponta para o conteúdo de mídia.

object (MediaImage)

Imagem a ser exibida com o card de mídia.

# 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.

object (StaticImagePrompt)

Uma imagem grande, como a capa do álbum etc.

object (StaticImagePrompt)

Um pequeno ícone de imagem exibido à direita do título. Ela é redimensionada para 36 x 36 dp.

title: string
subtitle: string
items: 
  - object (ListItem)

string

Opcional. Título da lista.

string

Opcional. Subtítulo da lista.

object (ListItem)

Obrigatório. Itens da lista.

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no tipo associado. Quando o item for tocado, essa chave será postada de volta como um parâmetro de opção de seleção.

string

Obrigatório. Título do item. Quando tocado, esse texto é postado de volta na conversa como se o usuário o tivesse digitado. Cada título precisa ser exclusivo entre o conjunto de itens.

string

Opcional. Corpo de texto do item.

object (StaticImagePrompt)

Opcional. Imagem do item.

title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)

string

Opcional. Título da coleção.

string

Opcional. Subtítulo da coleção.

object (CollectionItem)

Obrigatório. Itens da coleção

enum (ImageFill)

Opcional. Tipo de opção de exibição de imagem.

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no tipo associado. Quando o item for tocado, essa chave será postada de volta como um parâmetro de opção de seleção.

string

Obrigatório. Título do item. Quando tocado, esse texto é postado de volta na conversa como se o usuário o tivesse digitado. Cada título precisa ser exclusivo entre o conjunto de itens.

string

Opcional. Corpo de texto do item.

object (StaticImagePrompt)

Opcional. Imagem do item.

items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)

object (CollectionBrowseItem)

Itens da coleção "Procurar". O tamanho da lista deve estar no intervalo [2, 10].

enum (ImageFill)

Opção de exibição de imagens na coleção.

title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)

string

Obrigatório. Título do item da coleção.

string

Descrição do item da coleção.

string

Texto do rodapé do item da coleção, exibido abaixo da descrição. Linha única de texto, truncada com reticências.

object (StaticImagePrompt)

Imagem do item da coleção.

object (OpenUrl)

Obrigatório. URI a ser aberto se o item for selecionado.

title: string

string

Obrigatório. Texto mostrado no ícone de sugestão. Quando tocado, esse texto é postado de volta na conversa como se o usuário o tivesse digitado. Cada título precisa ser exclusivo entre o conjunto de ícones de sugestão. Máximo de 25 caracteres

url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean

string

Obrigatório. URL da visualização da Web a ser carregada.

value (Value format)

Opcional. Dados JSON a serem transmitidos para a página da Web da experiência imersiva como um evento. Se o campo override no comando tiver false, os valores de dados definidos neste comando da tela vão ser adicionados depois dos valores de dados definidos nos comandos anteriores.

boolean

Opcional. Um valor verdadeiro significa que o microfone não será aberto para capturar entradas depois que essa resposta imersiva for apresentada ao usuário.

boolean

Opcional. Se for true, os metadados relacionados à conversa serão incluídos e enviados de volta ao aplicativo de tela.

boolean

Opcional. Se true, o aplicativo de canvas ocupa a tela cheia e não tem um cabeçalho na parte de cima. Uma mensagem de aviso também vai aparecer na tela de carregamento com o nome de exibição da ação, o nome do desenvolvedor e instruções para sair dela. Valor padrão: false

boolean

Opcional. Se definida como verdadeira, os toques na tela não interromperão o TTS durante toda a sessão da tela. Valor padrão: falso.