- Representación YAML
- StaticPrompt
- StaticPromptCandidate
- Selector
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Sugerencia
- StaticCanvasPrompt
Define un controlador que se ejecutará después de un evento. Algunos ejemplos de eventos son los eventos basados en intención y condiciones en una escena.
Representación YAML | |
---|---|
webhookHandler: string # Union field |
Campos | ||
---|---|---|
webhookHandler |
Nombre del controlador de webhook que se llamará. |
|
Campo de unión prompt . Los mensajes se pueden intercalar o se puede hacer referencia a ellos por nombre. Las direcciones (prompt ) solo pueden ser una de las siguientes opciones: |
||
staticPrompt |
Mensaje estático intercalado. Puede contener referencias a recursos de cadenas en paquetes. |
|
staticPromptName |
Nombre del mensaje estático que se invocará. |
StaticPrompt
Representa una lista de mensajes candidatos, uno de los cuales se seleccionará como mensaje que se mostrará en la respuesta al usuario. Este mensaje se puede localizar.
Representación YAML | |
---|---|
candidates:
- object ( |
Campos | |
---|---|
candidates[] |
La lista de solicitudes candidatas 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 un candidato a un mensaje estático.
Representación YAML | |
---|---|
selector: object ( |
Campos | |
---|---|
selector |
Opcional. Los criterios para determinar si este mensaje coincide con una solicitud. Si el selector está vacío, este mensaje siempre se activará. |
promptResponse |
La respuesta a la solicitud asociada con el selector. |
Selector
Define los criterios para determinar si un mensaje coincide con una solicitud.
Representación YAML | |
---|---|
surfaceCapabilities:
object ( |
Campos | |
---|---|
surfaceCapabilities |
El conjunto de capacidades de superficie requeridas. |
SurfaceCapabilities
Representa la plataforma que usa el usuario para realizar una solicitud a la acción.
Representación YAML | |
---|---|
capabilities:
- enum ( |
Campos | |
---|---|
capabilities[] |
Obligatorio. Las capacidades de la superficie que realiza una solicitud a la Acción. |
StaticPromptResponse
Representa respuestas estructuradas que se enviarán al usuario, como texto, voz, tarjetas, datos de lienzo, chips de sugerencias, etcétera.
Representación YAML | |
---|---|
firstSimple: object ( |
Campos | |
---|---|
firstSimple |
Opcional. La primera respuesta de voz y solo de texto. |
content |
Opcional. Es un contenido, como una tarjeta, una lista o un contenido multimedia, para mostrarle al usuario. |
lastSimple |
Opcional. La última respuesta de voz y solo texto. |
suggestions[] |
Opcional. Sugerencias que se mostrarán al usuario y que siempre aparecerán al final de la respuesta. Si el campo |
link |
Opcional. Un chip de sugerencias adicional que se puede vincular a la app o al sitio asociado El chip se renderizará con el título “Abrir |
override |
Opcional. Modo de cómo se deben combinar estos mensajes con mensajes definidos previamente. |
canvas |
Una respuesta que se utilizará para la experiencia interactiva de lienzo. |
StaticSimplePrompt
Representa un mensaje simple que se enviará a un usuario.
Representación YAML | |
---|---|
variants:
- object ( |
Campos | |
---|---|
variants[] |
Lista de posibles variantes. |
Variant
Representa una variante que forma parte de un mensaje simple.
Representación YAML | |
---|---|
speech: string text: string |
Campos | |
---|---|
speech |
Opcional. Representa la voz que se dirá al usuario. Puede ser SSML o texto a voz. De forma predeterminada, la voz se agregará a la voz del mensaje simple anterior. Si el campo |
text |
Opcional. Texto que se mostrará en el cuadro de chat. Si no se proporciona, se usará una renderización de la pantalla del campo de voz anterior. Tiene un límite de 640 caracteres. De forma predeterminada, el texto se agregará al texto del mensaje simple anterior. Si el campo |
StaticContentPrompt
Es un marcador de posición para la parte Content de un StaticPrompt.
Representación YAML | |
---|---|
# Union field |
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 |
Una tarjeta básica. |
|
image |
Una imagen. |
|
table |
Tarjeta de tabla |
|
media |
Respuesta que indica un conjunto de contenido multimedia que se reproducirá. |
|
list |
Una tarjeta para presentar una lista de opciones para seleccionar. |
|
collection |
Una tarjeta que presenta una lista de opciones para seleccionar. |
|
collectionBrowse |
Una tarjeta que presenta una colección de páginas web para abrir. |
StaticCardPrompt
Una tarjeta básica para mostrar información, p.ej., una imagen o texto.
Representación YAML | |
---|---|
title: string subtitle: string text: string image: object ( |
Campos | |
---|---|
title |
Opcional. Título general de la tarjeta. |
subtitle |
Opcional. Subtítulo de la tarjeta. |
text |
Obligatorio. Texto del cuerpo de la tarjeta que es necesario, a menos que se incluya una imagen. Admite un conjunto limitado de sintaxis de Markdown para formatear. |
image |
Opcional. Una imagen principal de la tarjeta La altura se fija en 192 dp. |
imageFill |
Opcional. Cómo se rellenará el fondo de la imagen. |
button |
Opcional. Un botón en el que se puede hacer clic para que se muestre en la tarjeta |
StaticImagePrompt
Una imagen que se muestra en la tarjeta.
Representación YAML | |
---|---|
url: string alt: string height: integer width: integer |
Campos | |
---|---|
url |
Obligatorio. Es la URL de origen de la imagen. Las imágenes pueden ser JPG, PNG y GIF (animadas y no animadas). Por ejemplo, |
alt |
Obligatorio. Es una descripción de texto de la imagen que se usará para mejorar la accesibilidad, p.ej., lectores de pantalla. |
height |
Opcional. La altura de la imagen en píxeles. |
width |
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 YAML | |
---|---|
name: string
open:
object ( |
Campos | |
---|---|
name |
Nombre del vínculo |
open |
Define el comportamiento cuando el usuario abre el vínculo. |
OpenUrl
Define el comportamiento cuando el usuario abre el vínculo.
Representación YAML | |
---|---|
url: string
hint: enum ( |
Campos | |
---|---|
url |
El campo de URL, que puede ser cualquiera de las siguientes opciones: - URLs http/https para abrir una aplicación o una página web vinculadas a la aplicación |
hint |
Indica una sugerencia para el tipo de URL. |
StaticTablePrompt
Una tarjeta de tabla para mostrar una tabla de texto.
Representación YAML | |
---|---|
title: string subtitle: string image: object ( |
Campos | |
---|---|
title |
Opcional. Es el título general de la tabla. Debe establecerse si se configuró un subtítulo. |
subtitle |
Opcional. Subtítulo de la tabla. |
image |
Opcional. Imagen asociada con la tabla. |
columns[] |
Opcional. Encabezados y alineación de columnas. |
rows[] |
Opcional. Son los datos de la fila de la tabla. Se garantiza que se mostrarán las primeras 3 filas, pero es posible que otras se corten en ciertas superficies. Realiza pruebas con el simulador para ver qué filas se mostrarán en una superficie determinada. En las plataformas que admiten la función |
button |
Opcional. Botón. |
TableColumn
Describe una columna de la tabla.
Representación YAML | |
---|---|
header: string
align: enum ( |
Campos | |
---|---|
header |
Es el texto del encabezado de la columna. |
align |
Alineación horizontal de la columna de WRT de contenido Si no se especifica, el contenido se alineará con el extremo inicial. |
TableRow
Describe una fila de la tabla.
Representación YAML | |
---|---|
cells:
- object ( |
Campos | |
---|---|
cells[] |
Celdas en esta fila. Se garantiza que se mostrarán las primeras 3 celdas, pero es posible que otras se corten en ciertas superficies. Realiza una prueba con el simulador para ver qué celdas se mostrarán en una superficie determinada. |
divider |
Indica si debe haber un divisor después de cada fila. |
TableCell
Describe una celda en una fila.
Representación YAML | |
---|---|
text: string |
Campos | |
---|---|
text |
Contenido de texto de la celda. |
StaticMediaPrompt
Contiene información sobre el contenido multimedia, como el nombre, la descripción, la URL, etc. ID siguiente: 11
Representación YAML | |
---|---|
mediaType: enum ( |
Campos | |
---|---|
mediaType |
Es el tipo de medio de esta respuesta. |
startOffset |
Desplazamiento inicial del primer objeto multimedia. Es una duración en segundos con hasta nueve dígitos fraccionarios que termina en " |
optionalMediaControls[] |
Tipos de controles multimedia opcionales que puede admitir esta sesión de respuesta multimedia. Si se configura, la solicitud se hará a las 3p cuando se produzca un determinado evento multimedia. Si no se configura, 3p todavía debe manejar dos tipos de control predeterminados: FINISHED y FAILED. |
mediaObjects[] |
Lista de objetos multimedia. |
repeatMode |
Modo de repetición para la lista de objetos multimedia |
MediaObject
Representa un solo objeto multimedia.
Representación YAML | |
---|---|
name: string
description: string
url: string
image:
object ( |
Campos | |
---|---|
name |
Es el nombre de este objeto multimedia. |
description |
Es la descripción de este objeto multimedia. |
url |
URL que dirige al contenido multimedia. |
image |
Imagen para mostrar con la tarjeta multimedia. |
MediaImage
Imagen que se mostrará en un MediaPrompt.
Representación YAML | |
---|---|
# Union field |
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 |
Una imagen grande, como la portada del álbum, etc. |
|
icon |
Un ícono de imagen pequeña que aparece a la derecha del título. Se cambió el tamaño a 36 x 36 dp. |
StaticListPrompt
Una tarjeta para presentar una lista de opciones para seleccionar.
Representación YAML | |
---|---|
title: string
subtitle: string
items:
- object ( |
Campos | |
---|---|
title |
Opcional. Es el título de la lista. |
subtitle |
Opcional. Subtítulo de la lista. |
items[] |
Obligatorio. Elementos de lista. |
ListItem
Es un elemento de la lista.
Representación YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Campos | |
---|---|
key |
Obligatorio. La clave de CLN que coincide con el nombre de la clave de entrada en el tipo asociado. Cuando se presione el elemento, se volverá a publicar esta clave como parámetro de opción de selección. |
title |
Obligatorio. Es el título del artículo. Cuando se presiona, este texto se publica en la conversación textualmente como si el usuario lo hubiera escrito. Cada título debe ser único entre el conjunto de elementos. |
description |
Opcional. Es el texto del cuerpo del elemento. |
image |
Opcional. Imagen del artículo. |
StaticCollectionPrompt
Una tarjeta para presentar un conjunto de opciones para seleccionar.
Representación YAML | |
---|---|
title: string subtitle: string items: - object ( |
Campos | |
---|---|
title |
Opcional. Es el título de la colección. |
subtitle |
Opcional. Subtítulo de la colección. |
items[] |
Obligatorio. Elementos de la colección. |
imageFill |
Opcional. Es el tipo de opción de visualización de imágenes. |
CollectionItem
Es un elemento de la colección.
Representación YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Campos | |
---|---|
key |
Obligatorio. La clave de CLN que coincide con el nombre de la clave de entrada en el Type asociado. Cuando se presione el elemento, se volverá a publicar esta clave como parámetro de opción de selección. |
title |
Obligatorio. Es el título del artículo. Cuando se presiona, este texto se publica en la conversación textualmente como si el usuario lo hubiera escrito. Cada título debe ser único entre el conjunto de elementos. |
description |
Opcional. Es el texto del cuerpo del elemento. |
image |
Opcional. Imagen del artículo. |
StaticCollectionBrowsePrompt
Presenta un conjunto de documentos web como una colección de elementos de mosaicos grandes. Se pueden seleccionar elementos para abrir su documento web asociado en un visualizador web.
Representación YAML | |
---|---|
items: - object ( |
Campos | |
---|---|
items[] |
Elementos de la colección de exploración. El tamaño de la lista debe estar dentro del rango [2, 10]. |
imageFill |
Opción de visualización de imágenes para las imágenes de la colección. |
CollectionBrowseItem
Elemento de la colección.
Representación YAML | |
---|---|
title: string description: string footer: string image: object ( |
Campos | |
---|---|
title |
Obligatorio. Es el título del elemento de la colección. |
description |
Es la descripción del elemento de la colección. |
footer |
Es el texto del pie de página del elemento de la colección, que aparece debajo de la descripción. Línea única de texto truncada con puntos suspensivos |
image |
Imagen del elemento de la colección. |
openUriAction |
Obligatorio. Es el URI que se debe abrir si se selecciona el elemento. |
Sugerencia
Representa un chip de sugerencias, un elemento de la IU que se muestra al usuario para mayor comodidad.
Representación YAML | |
---|---|
title: string |
Campos | |
---|---|
title |
Obligatorio. El texto que se muestra en el chip de sugerencias. Cuando se presiona, este texto se publica en la conversación textualmente como si el usuario lo hubiera escrito. Cada título debe ser único en el conjunto de chips de sugerencias. 25 caracteres máx. |
StaticCanvasPrompt
Representa una respuesta de Interactive Canvas que se enviará al usuario. Se puede usar junto con el campo firstSimple
en el mensaje que lo contiene para hablar con el usuario además de mostrar una respuesta de lienzo interactiva.
Representación YAML | |
---|---|
url: string data: - value suppressMic: boolean sendStateDataToCanvasApp: boolean enableFullScreen: boolean continueTtsDuringTouch: boolean |
Campos | |
---|---|
url |
Obligatorio. URL de la vista web que se cargará. |
data[] |
Opcional. Los datos JSON que se pasarán a la página web de la experiencia envolvente como un evento Si el campo |
suppressMic |
Opcional. Un valor verdadero significa que no se abrirá el micrófono para capturar entradas después de que se presente esta respuesta envolvente al usuario. |
sendStateDataToCanvasApp |
Opcional. Si es |
enableFullScreen |
Opcional. Si es |
continueTtsDuringTouch |
Opcional. Si esta preferencia se establece como "true", los toques en la pantalla no detendrán la función de TTS durante toda la sesión de Canvas. Valor predeterminado: falso. |