StaticPrompt

{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}

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.

{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}

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.

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 fazem 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 de voz e somente texto.

object (StaticContentPrompt)

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

object (StaticSimplePrompt)

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

object (Suggestion)

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.

object (StaticLinkPrompt)

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 ". Máximo de 20 caracteres.

boolean

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

object (StaticCanvasPrompt)

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

{
  "variants": [
    {
      object (Variant)
    }
  ]
}

object (Variant)

Lista de variantes possíveis.

{
  "speech": string,
  "text": string
}

string

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.

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

{

  // 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)
  }
  // End of list of possible types for union field content.
}

object (StaticCardPrompt)

Um cartão básico.

object (StaticImagePrompt)

Uma imagem.

object (StaticTablePrompt)

Card de tabela.

object (StaticMediaPrompt)

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

object (StaticListPrompt)

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

object (StaticCollectionPrompt)

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

{
  "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 cartão.

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.

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

Opcional. Um botão clicável a ser exibido 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 e não animadas). 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, 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 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

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

object (StaticLinkPrompt)

Opcional. Botão.

{
  "header": string,
  "align": enum (HorizontalAlignment)
}

string

Texto do cabeçalho da coluna.

enum (HorizontalAlignment)

Alinhamento horizontal da coluna de 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 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.

boolean

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

{
  "text": string
}

string

Conteúdo do texto da célula.

{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}

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

object (MediaObject)

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. Ele é redimensionado 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 de 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 é tocado, essa chave é postada novamente como um parâmetro de opção selecionada.

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.

string

Opcional. Texto do corpo 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 é tocado, essa chave é postada novamente como um parâmetro de opção selecionada.

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.

string

Opcional. Texto do corpo do item.

object (StaticImagePrompt)

Opcional. Imagem do item.

{
  "title": string
}

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

{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": 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 "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.

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.