- StaticPromptCandidate
- Seletor
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- Sugestão
- StaticCanvasPrompt
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 JSON | |
---|---|
{
"candidates": [
{
object ( |
Campos | |
---|---|
candidates[] |
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 JSON | |
---|---|
{ "selector": { object ( |
Campos | |
---|---|
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 |
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 JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Campos | |
---|---|
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 JSON | |
---|---|
{
"capabilities": [
enum ( |
Campos | |
---|---|
capabilities[] |
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 JSON | |
---|---|
{ "firstSimple": { object ( |
Campos | |
---|---|
firstSimple |
Opcional. A primeira resposta de voz e somente texto. |
content |
Opcional. Um conteúdo como um card, lista ou mídia que será exibido ao usuário. |
lastSimple |
Opcional. A última resposta de voz e somente texto. |
suggestions[] |
Opcional. Sugestões a serem exibidas ao usuário que sempre aparecerão no final da resposta. Se o campo "Anexar" no comando que o contém for "true", os títulos definidos nele serão adicionados aos títulos definidos nas sugestões de prompts definidos anteriormente, e os valores duplicados serão removidos. |
link |
Opcional. Um chip de sugestão adicional que pode ser vinculado ao app ou site associado. O ícone será renderizado com o título "Abrir |
override |
Opcional. Modo de como estas mensagens devem ser mescladas com mensagens definidas anteriormente. "true" limpa todas as mensagens definidas anteriormente (primeira e última simples, conteúdo, link e tela de sugestões) e adiciona mensagens definidas no comando. A opção "false" adiciona as mensagens definidas neste comando às definidas nas respostas anteriores. Definir este campo como "false" também permitirá anexar 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 é "falso". |
canvas |
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 JSON | |
---|---|
{
"variants": [
{
object ( |
Campos | |
---|---|
variants[] |
Lista de variantes possíveis. |
Variante
Representa uma variante que faz parte do comando simples.
Representação JSON | |
---|---|
{ "speech": string, "text": string } |
Campos | |
---|---|
speech |
Opcional. Representa a fala a ser falada para o usuário. Pode ser SSML ou conversão de texto em voz. Se o campo "append" no prompt contido for "true", a fala definida nesse campo será anexada à fala da solicitação Simples anterior. |
text |
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. Se o campo "append" no prompt que contém o prompt for "true", o texto definido nesse campo será anexado ao texto do prompt Simples anterior. |
StaticContentPrompt
Um marcador para a parte Content de um StaticPrompt.
Representação JSON | |
---|---|
{ // Union field |
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 |
Um cartão básico. |
|
image |
Uma imagem. |
|
table |
Card de tabela. |
|
media |
Resposta indicando um conjunto de mídias a serem reproduzidas. |
|
list |
Um card para apresentar uma lista de opções disponíveis. |
|
collection |
Um card com uma lista de opções disponíveis. |
StaticCardPrompt
Um card básico para exibir algumas informações, por exemplo, uma imagem e/ou texto.
Representação JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Campos | |
---|---|
title |
Opcional. Título geral do card. |
subtitle |
Opcional. Subtítulo do cartão. |
text |
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 |
Opcional. Uma imagem principal para o cartão. A altura é fixa em 192 dp. |
imageFill |
Opcional. Como o plano de fundo da imagem será preenchido. |
button |
Opcional. Um botão clicável a ser exibido no card. |
StaticImagePrompt
Uma imagem exibida no card.
Representação JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Campos | |
---|---|
url |
Obrigatório. O URL de origem da imagem. As imagens podem ser JPG, PNG e GIF (animadas e não animadas). Por exemplo, |
alt |
Obrigatório. Uma descrição de texto da imagem a ser usada para acessibilidade, por exemplo, leitores de tela. |
height |
Opcional. A altura da imagem, em pixels. |
width |
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 JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Campos | |
---|---|
name |
Nome do link |
open |
Define o comportamento quando o usuário abre o link. |
OpenUrl
Define o comportamento quando o usuário abre o link.
Representação JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Campos | |
---|---|
url |
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 |
Indica uma dica para o tipo de URL. |
StaticTablePrompt
Um card de tabela para exibir uma tabela de texto.
Representação JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Campos | |
---|---|
title |
Opcional. Título geral da tabela. Precisa ser definido se o subtítulo estiver definido. |
subtitle |
Opcional. Subtítulo da tabela. |
image |
Opcional. Imagem associada à tabela. |
columns[] |
Opcional. Cabeçalhos e alinhamento de colunas. |
rows[] |
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. Nas plataformas compatíveis com o recurso WEB_BROWSER, é possível direcionar o usuário para uma página da Web com mais dados. |
button |
Opcional. Botão. |
TableColumn
Descreve uma coluna na tabela.
Representação JSON | |
---|---|
{
"header": string,
"align": enum ( |
Campos | |
---|---|
header |
Texto do cabeçalho da coluna. |
align |
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 JSON | |
---|---|
{
"cells": [
{
object ( |
Campos | |
---|---|
cells[] |
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 |
Indica se deve haver um divisor após cada linha. |
TableCell
Descreve uma célula em uma linha.
Representação JSON | |
---|---|
{ "text": string } |
Campos | |
---|---|
text |
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: 9
Representação JSON | |
---|---|
{ "mediaType": enum ( |
Campos | |
---|---|
mediaType |
Tipo de mídia dessa resposta. |
startOffset |
Deslocamento inicial do primeiro objeto de mídia. Uma duração em segundos com até nove dígitos fracionários, encerrada por " |
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[] |
Lista de objetos de mídia. |
MediaObject
Representa um único objeto de mídia.
Representação JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Campos | |
---|---|
name |
Nome desse objeto de mídia. |
description |
Descrição desse objeto de mídia. |
url |
O URL que aponta para o conteúdo de mídia. |
image |
Imagem a ser exibida com o card de mídia. |
MediaImage
Imagem a ser mostrada dentro de um MediaPrompt.
Representação JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de união image . Somente um tipo de MediaImage é permitido. image pode ser apenas de um dos tipos a seguir: |
||
large |
Uma imagem grande, como a capa do álbum etc. |
|
icon |
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 JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Campos | |
---|---|
title |
Opcional. Título da lista. |
subtitle |
Opcional. Subtítulo da lista. |
items[] |
Obrigatório. Itens de lista. |
ListItem
Um item na lista.
Representação JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campos | |
---|---|
key |
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 |
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 |
Opcional. Texto do corpo do item. |
image |
Opcional. Imagem do item. |
StaticCollectionPrompt
Um card que apresenta uma coleção de opções disponíveis.
Representação JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Campos | |
---|---|
title |
Opcional. Título da coleção. |
subtitle |
Opcional. Subtítulo da coleção. |
items[] |
Obrigatório. Itens da coleção. |
imageFill |
Opcional. Tipo de opção de exibição de imagem. |
CollectionItem
Um item na coleção.
Representação JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Campos | |
---|---|
key |
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 |
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 |
Opcional. Texto do corpo do item. |
image |
Opcional. Imagem do item. |
Sugestão
Representa um chip de sugestão, um elemento de interface mostrado ao usuário por conveniência.
Representação JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
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" no prompt contendo para falar com o usuário, além de exibir uma resposta de tela interativa.
Representação JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
Campos | |
---|---|
url |
Obrigatório. URL da visualização da Web a ser carregada. |
data[] |
Opcional. Dados JSON a serem transmitidos para a página da Web da experiência imersiva como um evento. Se o campo "substituir" no comando for "falso", os valores de dados definidos neste comando do Canvas vão ser adicionados após os valores de dados definidos nas solicitações anteriores. |
suppressMic |
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. |