EventHandler

Define um manipulador a ser executado após um evento. Exemplos de eventos são os eventos baseados em intent e condição em um cenário.

Representação 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.
Campos
webhookHandler

string

Nome do gerenciador de webhook a ser chamado.
Campo de união prompt. Os comandos podem ser inline ou referenciados por nome. prompt pode ser apenas de um dos tipos a seguir:
staticPrompt

object (StaticPrompt)

Comando estático inline. Pode conter referências a recursos de string em pacotes.
staticPromptName

string

Nome do prompt estático a ser invocado.

StaticPrompt

Representa uma lista de candidatos a prompts, sendo que um deles será selecionado como o comando a ser mostrado na resposta ao usuário. Esta mensagem pode ser localizada.

Representação YAML 
candidates: 
  - object (StaticPromptCandidate)
Campos
candidates[]

object (StaticPromptCandidate)

A lista de solicitações candidatas a serem enviadas ao cliente. Cada comando tem um seletor para determinar quando pode ser usado. O primeiro seletor que corresponde a uma solicitação é enviado e o restante é ignorado.

StaticPromptCandidate

Representa um candidato a comando estático.

Representação YAML 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Campos
selector

object (Selector)

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

object (StaticPromptResponse)

A resposta de solicitação associada ao seletor.

Seletor

Define os critérios que determinam se um comando corresponde a uma solicitação.

Representação YAML 
surfaceCapabilities: 
  object (SurfaceCapabilities)
Campos
surfaceCapabilities

object (SurfaceCapabilities)

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

SurfaceCapabilities

Representa a superfície que o usuário está usando para fazer uma solicitação para a ação.

Representação YAML 
capabilities: 
  - enum (Capability)
Campos
capabilities[]

enum (Capability)

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

StaticPromptResponse

Representa respostas estruturadas a serem enviadas ao usuário, como texto, fala, cartões, dados de tela, ícones de sugestão etc.

Representação YAML 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
Campos
firstSimple

object (StaticSimplePrompt)

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

object (StaticContentPrompt)

Opcional. Um conteúdo como um card, lista ou mídia que será exibido ao usuário.
lastSimple

object (StaticSimplePrompt)

Opcional. A última resposta de voz e somente texto.
suggestions[]

object (Suggestion)

Opcional. Sugestões a serem exibidas ao usuário que sempre aparecerão no final da resposta. Se o campo append no comando for true, os títulos definidos nele serão adicionados aos títulos definidos nas sugestões definidas anteriormente, e os valores duplicados serão removidos.
override

boolean

Opcional. Modo de como estas mensagens devem ser mescladas com mensagens definidas anteriormente. O true vai apagar todas as mensagens definidas anteriormente (primeira e última simples, conteúdo, link e tela de sugestões) e adicionar mensagens definidas neste comando. O false vai adicionar as mensagens definidas neste comando às mensagens definidas nas respostas anteriores. Definir este campo como false também ativa a anexação a alguns campos dentro de prompts simples, de Sugestões e do Canvas (parte do prompt de conteúdo). As mensagens de conteúdo e link sempre serão substituídas, se definidas no prompt. O valor padrão é false.
canvas

object (StaticCanvasPrompt)

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

StaticSimplePrompt

Representa um prompt simples a ser enviado a um usuário.

Representação YAML 
variants: 
  - object (Variant)
Campos
variants[]

object (Variant)

Lista de variantes possíveis.

Variante

Representa uma variante que faz parte do comando simples.

Representação YAML 
speech: string
text: string
Campos
speech

string

Opcional. Representa a fala a ser falada para o 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 o comando for true, a fala definida nesse campo vai substituir a fala da solicitação Simples anterior.
text

string

Opcional. Texto a ser exibido no balão do chat. Se não for fornecido, 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 prompt for true, o texto definido nesse campo vai substituir o texto do prompt simples anterior.

StaticContentPrompt

Um marcador para a parte Content de um StaticPrompt.

Representação 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.
Campos
Campo de união content. Somente um tipo de conteúdo pode estar presente em um comando. content pode ser apenas de um dos tipos a seguir:
card

object (StaticCardPrompt)

Um cartão básico.
image

object (StaticImagePrompt)

Uma imagem.
table

object (StaticTablePrompt)

Card de tabela.
media

object (StaticMediaPrompt)

Resposta indicando um conjunto de mídias a serem reproduzidas.
list

object (StaticListPrompt)

Um card para apresentar uma lista de opções disponíveis.
collection

object (StaticCollectionPrompt)

Um card com uma lista de opções disponíveis.
collectionBrowse

object (StaticCollectionBrowsePrompt)

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

StaticCardPrompt

Um card básico para exibir algumas informações, por exemplo, uma imagem e/ou texto.

Representação YAML 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
Campos
title

string

Opcional. Título geral do card.
subtitle

string

Opcional. Subtítulo do cartão.
text

string

Obrigatório. Corpo de texto do cartão que é necessário, a menos que imagem esteja presente. Oferece suporte a um conjunto limitado de sintaxe markdown para formatação.
image

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

Opcional. Um botão clicável a ser exibido no card.

StaticImagePrompt

Uma imagem exibida no card.

Representação YAML 
url: string
alt: string
height: integer
width: integer
Campos
url

string

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

string

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

integer

Opcional. A altura da imagem, em pixels.
width

integer

Opcional. A largura da imagem, em pixels.

StaticLinkPrompt

Define um link que será exibido como um ícone de sugestão e poderá ser aberto pelo usuário.

Representação YAML 
name: string
open: 
  object (OpenUrl)
Campos
name

string

Nome do link
open

object (OpenUrl)

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

OpenUrl

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

Representação YAML 
url: string
hint: enum (UrlHint)
Campos
url

string

O campo de URL, que pode ser qualquer uma das seguintes opções: - URLs http/https para abrir um app vinculado ao app ou uma página da Web
hint

enum (UrlHint)

Indica uma dica para o tipo de URL.

StaticTablePrompt

Um card de tabela para exibir uma tabela de texto.

Representação YAML 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
Campos
title

string

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

string

Opcional. Subtítulo da tabela.
image

object (StaticImagePrompt)

Opcional. Imagem associada à tabela.
columns[]

object (TableColumn)

Opcional. Cabeçalhos e alinhamento de colunas.
rows[]

object (TableRow)

Opcional. Dados de linha da tabela. As três primeiras linhas certamente serão mostradas, mas as outras podem ser cortadas em determinadas superfícies. Teste com o simulador para saber quais linhas vão ser mostradas para uma determinada superfície. Em plataformas com suporte ao recurso WEB_BROWSER, é possível direcionar o usuário para uma página da Web com mais dados.
button

object (StaticLinkPrompt)

Opcional. Botão.

TableColumn

Descreve uma coluna na tabela.

Representação YAML 
header: string
align: enum (HorizontalAlignment)
Campos
header

string

Texto do cabeçalho da coluna.
align

enum (HorizontalAlignment)

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

TableRow

Descreve uma linha na tabela.

Representação YAML 
cells: 
  - object (TableCell)
divider: boolean
Campos
cells[]

object (TableCell)

Células nesta linha. As três primeiras células vão aparecer, mas as outras podem ser cortadas em determinadas superfícies. Teste com o simulador para ver quais células vão ser mostradas para uma determinada superfície.
divider

boolean

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

TableCell

Descreve uma célula em uma linha.

Representação YAML 
text: string
Campos
text

string

Conteúdo do texto da célula.

StaticMediaPrompt

Contém informações sobre a mídia, como nome, descrição, URL etc. Próximo ID: 11

Representação YAML 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
Campos
mediaType

enum (MediaType)

Tipo de mídia dessa resposta.
startOffset

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".
optionalMediaControls[]

enum (OptionalMediaControls)

Tipos de controle de mídia opcionais compatíveis com a 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 precisa lidar com dois tipos de controle padrão, FINISHED e FAILED.
mediaObjects[]

object (MediaObject)

Lista de objetos de mídia.
repeatMode

enum (RepeatMode)

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

MediaObject

Representa um único objeto de mídia.

Representação YAML 
name: string
description: string
url: string
image: 
  object (MediaImage)
Campos
name

string

Nome desse objeto de mídia.
description

string

Descrição desse objeto de mídia.
url

string

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

object (MediaImage)

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

MediaImage

Imagem a ser mostrada dentro de um MediaPrompt.

Representação 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.
Campos
Campo de união image. Somente um tipo de MediaImage é permitido. image pode ser apenas de um dos tipos a seguir:
large

object (StaticImagePrompt)

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

object (StaticImagePrompt)

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

StaticListPrompt

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

Representação YAML 
title: string
subtitle: string
items: 
  - object (ListItem)
Campos
title

string

Opcional. Título da lista.
subtitle

string

Opcional. Subtítulo da lista.
items[]

object (ListItem)

Obrigatório. Itens de lista.

ListItem

Um item na lista.

Representação YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Campos
key

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no tipo associado. Quando o item é tocado, essa chave é postada novamente como um parâmetro de opção selecionada.
title

string

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

string

Opcional. Texto do corpo do item.
image

object (StaticImagePrompt)

Opcional. Imagem do item.

StaticCollectionPrompt

Um card que apresenta uma coleção de opções disponíveis.

Representação YAML 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
Campos
title

string

Opcional. Título da coleção.
subtitle

string

Opcional. Subtítulo da coleção.
items[]

object (CollectionItem)

Obrigatório. Itens da coleção.
imageFill

enum (ImageFill)

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

CollectionItem

Um item na coleção.

Representação YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Campos
key

string

Obrigatório. A chave PLN que corresponde ao nome da chave de entrada no Tipo associado. Quando o item é tocado, essa chave é postada novamente como um parâmetro de opção selecionada.
title

string

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

string

Opcional. Texto do corpo do item.
image

object (StaticImagePrompt)

Opcional. Imagem do item.

StaticCollectionBrowsePrompt

Apresenta um conjunto de documentos da Web como uma coleção de itens de blocos grandes. Os itens podem ser selecionados para iniciar o documento da Web associado em um visualizador da Web.

Representação YAML 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
Campos
items[]

object (CollectionBrowseItem)

Itens na coleção Procurar. O tamanho da lista precisa estar no intervalo [2, 10].
imageFill

enum (ImageFill)

Opção de exibição de imagens para as imagens da coleção.

CollectionBrowseItem

Item na coleção.

Representação YAML 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Campos
title

string

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

string

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

string

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

object (StaticImagePrompt)

Imagem do item da coleção.
openUriAction

object (OpenUrl)

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

Sugestão

Representa um chip de sugestão, um elemento de interface mostrado ao usuário por conveniência.

Representação YAML 
title: string
Campos
title

string

Obrigatório. O texto mostrado no ícone de sugestão. Quando tocado, esse texto será postado de volta na conversa literalmente, como se o usuário o tivesse digitado. Cada título precisa ser único no conjunto de ícones de sugestão. Até 25 caracteres

StaticCanvasPrompt

Representa uma resposta de tela interativa a ser enviada ao usuário. Isso pode ser usado em conjunto com o campo firstSimple na solicitação que contém o comando para falar com o usuário, além de exibir uma resposta de tela interativa.

Representação YAML 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
Campos
url

string

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

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 que o contém for false, os valores de dados definidos neste comando do Canvas serão adicionados após os valores de dados definidos nas solicitações anteriores do Canvas.
suppressMic

boolean

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

boolean

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

boolean

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

boolean

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