StaticPrompt

Representa una lista de instrucciones candidatas, una de las cuales se seleccionará como la instrucción que se mostrará en la respuesta que recibirá el usuario. Este mensaje se puede localizar.

Representación JSON 
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Campos
candidates[]

object (StaticPromptCandidate)

La lista de mensajes candidatos que se enviarán al cliente. Cada instrucción tiene un selector para determinar cuándo se puede usar. Se enviará el primer selector que coincida con una solicitud y se ignorará el resto.

StaticPromptCandidate

Representa una sugerencia de instrucción estática.

Representación JSON 
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Campos
selector

object (Selector)

Opcional. Los criterios que determinan si este mensaje coincide con una solicitud. Si el selector está vacío, este mensaje se activará siempre.
promptResponse

object (StaticPromptResponse)

La respuesta de mensaje asociada con el selector.

Selector

Define los criterios para determinar si una instrucción coincide con una solicitud.

Representación JSON 
{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}
Campos
surfaceCapabilities

object (SurfaceCapabilities)

El conjunto de capacidades de superficie requeridas.

SurfaceCapabilities

Representa la superficie que utiliza el usuario para realizar una solicitud a la acción.

Representación JSON 
{
  "capabilities": [
    enum (Capability)
  ]
}
Campos
capabilities[]

enum (Capability)

Obligatorio. Las capacidades de la superficie que realiza una solicitud a la acción.

StaticPromptResponse

Representa respuestas estructuradas para enviar al usuario, como texto, voz, tarjetas, datos de lienzo, chips de sugerencias, etcétera.

Representación JSON 
{
  "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. La primera respuesta de solo texto y voz.
content

object (StaticContentPrompt)

Opcional. Es un contenido como una tarjeta, una lista o contenido multimedia que se le mostrará al usuario.
lastSimple

object (StaticSimplePrompt)

Opcional. La última respuesta de solo texto y voz.
suggestions[]

object (Suggestion)

Opcional. Sugerencias para mostrarle al usuario que siempre aparecerán al final de la respuesta. Si el botón "agregar" en la instrucción que lo contiene es "verdadero" Los títulos definidos en este campo se agregarán a los títulos definidos en los mensajes de sugerencias definidos previamente y se quitarán los valores duplicados.
override

boolean

Opcional. Modo de cómo se deben combinar estos mensajes con los mensajes definidos con anterioridad. “verdadero” Se borrarán todos los mensajes definidos previamente (el primer y el último simple, el contenido, los vínculos de sugerencias y el lienzo) y se agregarán los que se hayan definido en esta instrucción. "falso" agregará los mensajes definidos en esta instrucción a los mensajes definidos en respuestas anteriores. Configura este campo como "false" También permitirá agregar datos a algunos campos dentro de los mensajes simples, las sugerencias y el mensaje de Canvas (parte de la solicitud de contenido). Los mensajes de contenido y vínculo siempre se reemplazarán si se definen en la instrucción. El valor predeterminado es "false".
canvas

object (StaticCanvasPrompt)

Una respuesta que se usará para la experiencia de lienzo interactivo.

StaticSimplePrompt

Representa una instrucción simple que se enviará a un usuario.

Representación JSON 
{
  "variants": [
    {
      object (Variant)
    }
  ]
}
Campos
variants[]

object (Variant)

Es una lista de variantes posibles.

Variante

Representa una variante que forma parte de una instrucción simple.

Representación JSON 
{
  "speech": string,
  "text": string
}
Campos
speech

string

Opcional. Representa la voz que se hablará al usuario. Puede ser SSML o texto a voz. Si el botón "agregar" en la instrucción que lo contiene es "verdadero" La voz definida en este campo se agregará a la voz de la instrucción simple anterior.
text

string

Opcional. Texto que se mostrará en el cuadro de chat. Si no se proporciona, se usará una renderización de pantalla del campo de voz anterior. Tiene un límite de 640 caracteres. Si el botón "agregar" en la instrucción que lo contiene es "verdadero" El texto definido en este campo se agregará al texto de la instrucción Simple anterior.

StaticContentPrompt

Es un marcador de posición para la parte Contenido de un StaticPrompt.

Representación JSON 
{

  // 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.
}
Campos
Campo de unión content. Solo puede haber un tipo de contenido en una instrucción. Las direcciones (content) solo pueden ser una de las siguientes opciones:
card

object (StaticCardPrompt)

Una tarjeta básica.
image

object (StaticImagePrompt)

Una imagen.
table

object (StaticTablePrompt)

Tarjeta de tabla.
media

object (StaticMediaPrompt)

Respuesta que indica un conjunto de contenido multimedia para reproducir.
list

object (StaticListPrompt)

Una tarjeta para presentar una lista de opciones que se pueden seleccionar.
collection

object (StaticCollectionPrompt)

Una tarjeta en la que se presenta una lista de opciones para seleccionar.

StaticCardPrompt

Una tarjeta básica para mostrar cierta información, p.ej., una imagen o texto.

Representación JSON 
{
  "title": string,
  "subtitle": string,
  "text": string,
  "image": {
    object (StaticImagePrompt)
  },
  "imageFill": enum (ImageFill),
  "button": {
    object (StaticLinkPrompt)
  }
}
Campos
title

string

Opcional. Título general de la tarjeta.
subtitle

string

Opcional. Subtítulo de la tarjeta.
text

string

Obligatorio. Texto del cuerpo de la tarjeta que es necesario, a menos que haya una imagen. Admite un conjunto limitado de sintaxis de Markdown para el formato.
image

object (StaticImagePrompt)

Opcional. Una imagen principal de la tarjeta. La altura se fija en 192 dp.
imageFill

enum (ImageFill)

Opcional. Cómo se rellenará el fondo de la imagen.
button

object (StaticLinkPrompt)

Opcional. Un botón en el que se puede hacer clic para que se muestre en la Tarjeta.

StaticImagePrompt

Se muestra una imagen en la tarjeta.

Representación JSON 
{
  "url": string,
  "alt": string,
  "height": integer,
  "width": integer
}
Campos
url

string

Obligatorio. Es la URL de origen de la imagen. Las imágenes pueden ser JPG, PNG y GIF (animadas y no animadas). Por ejemplo,https://www.agentx.com/logo.png.
alt

string

Obligatorio. Una descripción de texto de la imagen que se usará con fines de accesibilidad, p.ej., lectores de pantalla.
height

integer

Opcional. La altura de la imagen en píxeles.
width

integer

Opcional. El ancho de la imagen en píxeles.

StaticLinkPrompt

Define un vínculo que se mostrará como un chip de sugerencias y que el usuario puede abrir.

Representación JSON 
{
  "name": string,
  "open": {
    object (OpenUrl)
  }
}
Campos
name

string

Nombre del vínculo
open

object (OpenUrl)

Define el comportamiento cuando el usuario abre el vínculo.

OpenUrl

Define el comportamiento cuando el usuario abre el vínculo.

Representación JSON 
{
  "url": string,
  "hint": enum (UrlHint)
}
Campos
url

string

El campo de URL puede ser cualquiera de los siguientes: - URLs HTTP/HTTPS para abrir una aplicación vinculada a la aplicación o una página web
hint

enum (UrlHint)

Indica una sugerencia para el tipo de URL.

StaticTablePrompt

Una tarjeta para mostrar una tabla de texto.

Representación JSON 
{
  "title": string,
  "subtitle": string,
  "image": {
    object (StaticImagePrompt)
  },
  "columns": [
    {
      object (TableColumn)
    }
  ],
  "rows": [
    {
      object (TableRow)
    }
  ],
  "button": {
    object (StaticLinkPrompt)
  }
}
Campos
title

string

Opcional. Título general de la tabla. Se debe establecer si se configuraron los subtítulos.
subtitle

string

Opcional. Subtítulo de la tabla.
image

object (StaticImagePrompt)

Opcional. Imagen asociada con la tabla.
columns[]

object (TableColumn)

Opcional. Encabezados y alineación de columnas.
rows[]

object (TableRow)

Opcional. Datos de las filas de la tabla. Se garantiza que se mostrarán las primeras 3 filas, pero es posible que otras se corten en ciertas superficies. Realiza una prueba con el simulador para ver qué filas se mostrarán en una superficie determinada. En las plataformas compatibles con la función WEB_BROWSER, puedes dirigir al usuario a una página web con más datos.
button

object (StaticLinkPrompt)

Opcional. Botón.

TableColumn

Describe una columna de la tabla.

Representación JSON 
{
  "header": string,
  "align": enum (HorizontalAlignment)
}
Campos
header

string

Texto del encabezado de la columna.
align

enum (HorizontalAlignment)

Alineación horizontal de la columna de contenido w.r.t. Si no se especifica, el contenido se alineará con el borde inicial.

Fila de la tabla

Describe una fila en la tabla.

Representación JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Campos
cells[]

object (TableCell)

Celdas de esta fila. Se garantiza que se mostrarán las primeras 3 celdas, pero es posible que otras estén cortadas en ciertas superficies. Prueba con el simulador para ver qué celdas se mostrarán en una superficie determinada.
divider

boolean

Indica si debe haber un divisor después de cada fila.

TableCell

Describe una celda en una fila.

Representación JSON 
{
  "text": string
}
Campos
text

string

Contenido de texto de la celda.

StaticMediaPrompt

Contiene información sobre los medios, como el nombre, la descripción, la URL, etc. Siguiente ID: 9

Representación JSON 
{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}
Campos
mediaType

enum (MediaType)

Tipo de medio de esta respuesta.
startOffset

string (Duration format)

Desplazamiento inicial del primer objeto multimedia.

Es una duración en segundos con hasta nueve dígitos decimales que termina en "s". Ejemplo: "3.5s".
optionalMediaControls[]

enum (OptionalMediaControls)

Tipos opcionales de control multimedia que admite esta sesión de respuesta multimedia. Si la estableces, se realizará la solicitud a 3p cuando ocurra un evento multimedia determinado. Si no la estableces, 3p debe seguir controlando dos tipos de control predeterminados: FINISHED y FAILED.
mediaObjects[]

object (MediaObject)

Lista de objetos multimedia.

MediaObject

Representa un objeto multimedia único.

Representación JSON 
{
  "name": string,
  "description": string,
  "url": string,
  "image": {
    object (MediaImage)
  }
}
Campos
name

string

Es el nombre de este objeto multimedia.
description

string

Descripción de este objeto multimedia.
url

string

Es la URL que dirige al contenido multimedia.
image

object (MediaImage)

Imagen para mostrar con la tarjeta multimedia.

MediaImage

Imagen que se mostrará dentro de un MediaPrompt.

Representación JSON 
{

  // 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ón image. Solo se permite un tipo de MediaImage. Las direcciones (image) solo pueden ser una de las siguientes opciones:
large

object (StaticImagePrompt)

Una imagen grande, como la portada del álbum, etcétera
icon

object (StaticImagePrompt)

Un ícono de imagen pequeño que aparece a la derecha del título Se cambió a 36 x 36 dp.

StaticListPrompt

Una tarjeta para presentar una lista de opciones que se pueden seleccionar.

Representación JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (ListItem)
    }
  ]
}
Campos
title

string

Opcional. Es el título de la lista.
subtitle

string

Opcional. Subtítulo de la lista.
items[]

object (ListItem)

Obligatorio. Elementos de lista.

ListItem

Un elemento de la lista.

Representación JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Campos
key

string

Obligatorio. La clave CLN que coincide con el nombre de la clave de entrada en el tipo asociado Cuando se presione el elemento, esta clave se publicará como un parámetro de opción de selección.
title

string

Obligatorio. Es el título del artículo. Cuando se presiona, este texto se vuelve a publicar en la conversación tal como si el usuario lo hubiera escrito. Cada título debe ser único entre el conjunto de elementos.
description

string

Opcional. Es el texto del cuerpo del elemento.
image

object (StaticImagePrompt)

Opcional. Imagen del elemento.

StaticCollectionPrompt

Una tarjeta para presentar un conjunto de opciones para seleccionar.

Representación JSON 
{
  "title": string,
  "subtitle": string,
  "items": [
    {
      object (CollectionItem)
    }
  ],
  "imageFill": enum (ImageFill)
}
Campos
title

string

Opcional. Es el título de la colección.
subtitle

string

Opcional. Subtítulo de la colección.
items[]

object (CollectionItem)

Obligatorio. Elementos de la colección.
imageFill

enum (ImageFill)

Opcional. Tipo de opción de visualización de la imagen.

CollectionItem

Es un elemento de la colección.

Representación JSON 
{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}
Campos
key

string

Obligatorio. La clave CLN que coincide con el nombre de la clave de entrada en el tipo asociado Cuando se presione el elemento, esta clave se publicará como un parámetro de opción de selección.
title

string

Obligatorio. Es el título del artículo. Cuando se presiona, este texto se vuelve a publicar en la conversación tal como si el usuario lo hubiera escrito. Cada título debe ser único entre el conjunto de elementos.
description

string

Opcional. Es el texto del cuerpo del elemento.
image

object (StaticImagePrompt)

Opcional. Imagen del elemento.

Sugerencia

Representa un chip de sugerencias, un elemento de la IU que se muestra al usuario para mayor comodidad.

Representación JSON 
{
  "title": string
}
Campos
title

string

Obligatorio. Es el texto que se muestra en el chip de sugerencias. Cuando se presiona, este texto se vuelve a publicar en la conversación tal como si el usuario lo hubiera escrito. Cada título debe ser único en el conjunto de chips de sugerencias. Máx. 25 caracteres

StaticCanvasPrompt

Representa una respuesta de Interactive Canvas que se enviará al usuario. Esto se puede usar junto con el conjunto de registros “firstSimple” en la instrucción que lo contiene para hablarle al usuario, además de mostrar una respuesta de lienzo interactiva.

Representación JSON 
{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": boolean
}
Campos
url

string

Obligatorio. URL de la vista web que se cargará.
data[]

value (Value format)

Opcional. Los datos JSON que se pasarán a la página web de experiencia envolvente como un evento. Si el botón de "anular" en la instrucción que lo contiene es "falso" Los valores de datos definidos en este mensaje de Canvas se agregarán después de los valores de datos definidos en los mensajes de Canvas anteriores.
suppressMic

boolean

Opcional. Un valor verdadero significa que el micrófono no se abrirá para capturar la entrada después de que se presente esta respuesta envolvente al usuario.