- 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 condición en una escena.
Representación YAML | |
---|---|
webhookHandler: string # Union field |
Campos | ||
---|---|---|
webhookHandler |
Nombre del controlador de webhook al que se llamará. |
|
Campo de unión prompt . Las instrucciones pueden estar intercaladas o se pueden hacer referencia a ellas por su 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 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 YAML | |
---|---|
candidates:
- object ( |
Campos | |
---|---|
candidates[] |
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 YAML | |
---|---|
selector: object ( |
Campos | |
---|---|
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 |
La respuesta de mensaje asociada con el selector. |
Selector
Define los criterios para determinar si una instrucción coincide con una solicitud.
Representación YAML | |
---|---|
surfaceCapabilities:
object ( |
Campos | |
---|---|
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 YAML | |
---|---|
capabilities:
- enum ( |
Campos | |
---|---|
capabilities[] |
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 YAML | |
---|---|
firstSimple: object ( |
Campos | |
---|---|
firstSimple |
Opcional. La primera respuesta de solo texto y voz. |
content |
Opcional. Es un contenido como una tarjeta, una lista o contenido multimedia que se le mostrará al usuario. |
lastSimple |
Opcional. La última respuesta de solo texto y voz. |
suggestions[] |
Opcional. Sugerencias para mostrarle al usuario que siempre aparecerán al final de la respuesta. Si el campo |
link |
Opcional. Es un chip de sugerencias adicional que puede vincularse a la app o el sitio asociados. El chip se renderizará con el título "Abrir |
override |
Opcional. Modo de cómo se deben combinar estos mensajes con los mensajes definidos con anterioridad. |
canvas |
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 YAML | |
---|---|
variants:
- object ( |
Campos | |
---|---|
variants[] |
Es una lista de variantes posibles. |
Variante
Representa una variante que forma parte de una instrucción simple.
Representación YAML | |
---|---|
speech: string text: string |
Campos | |
---|---|
speech |
Opcional. Representa la voz que se hablará al usuario. Puede ser SSML o texto a voz. De forma predeterminada, la voz se agregará a la voz de la instrucción 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 pantalla del campo de voz anterior. Tiene un límite de 640 caracteres. De forma predeterminada, el texto se agregará al texto anterior de la instrucción simple. Si el campo |
StaticContentPrompt
Es un marcador de posición para la parte Contenido 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 para reproducir. |
|
list |
Una tarjeta para presentar una lista de opciones que se pueden seleccionar. |
|
collection |
Una tarjeta en la que se 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 cierta 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 haya una imagen. Admite un conjunto limitado de sintaxis de Markdown para el formato. |
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
Se muestra una imagen 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. Una descripción de texto de la imagen que se usará con fines de 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 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 |
Indica una sugerencia para el tipo de URL. |
StaticTablePrompt
Una tarjeta para mostrar una tabla de texto.
Representación YAML | |
---|---|
title: string subtitle: string image: object ( |
Campos | |
---|---|
title |
Opcional. Título general de la tabla. Se debe establecer si se configuraron los subtítulos. |
subtitle |
Opcional. Subtítulo de la tabla. |
image |
Opcional. Imagen asociada con la tabla. |
columns[] |
Opcional. Encabezados y alineación de columnas. |
rows[] |
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 que admiten la capability |
button |
Opcional. Botón. |
TableColumn
Describe una columna de la tabla.
Representación YAML | |
---|---|
header: string
align: enum ( |
Campos | |
---|---|
header |
Texto del encabezado de la columna. |
align |
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 YAML | |
---|---|
cells:
- object ( |
Campos | |
---|---|
cells[] |
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 |
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 los medios, como el nombre, la descripción, la URL, etc. Siguiente ID: 11
Representación YAML | |
---|---|
mediaType: enum ( |
Campos | |
---|---|
mediaType |
Tipo de medio de esta respuesta. |
startOffset |
Desplazamiento inicial del primer objeto multimedia. Es una duración en segundos con hasta nueve dígitos decimales que termina en " |
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[] |
Lista de objetos multimedia. |
repeatMode |
Es el modo de repetición para la lista de objetos multimedia. |
MediaObject
Representa un objeto multimedia único.
Representación YAML | |
---|---|
name: string
description: string
url: string
image:
object ( |
Campos | |
---|---|
name |
Es el nombre de este objeto multimedia. |
description |
Descripción de este objeto multimedia. |
url |
Es la URL que dirige al contenido multimedia. |
image |
Imagen para mostrar con la tarjeta multimedia. |
MediaImage
Imagen que se mostrará dentro de 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étera |
|
icon |
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 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
Un elemento de la lista.
Representación YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Campos | |
---|---|
key |
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 |
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 |
Opcional. Es el texto del cuerpo del elemento. |
image |
Opcional. Imagen del elemento. |
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. Tipo de opción de visualización de la imagen. |
CollectionItem
Es un elemento de la colección.
Representación YAML | |
---|---|
key: string
title: string
description: string
image:
object ( |
Campos | |
---|---|
key |
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 |
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 |
Opcional. Es el texto del cuerpo del elemento. |
image |
Opcional. Imagen del elemento. |
StaticCollectionBrowsePrompt
Presenta un conjunto de documentos web como una colección de elementos de mosaicos grandes. Se pueden seleccionar elementos para iniciar su documento web asociado en un visualizador web.
Representación YAML | |
---|---|
items: - object ( |
Campos | |
---|---|
items[] |
Elementos de la colección que exploras. El tamaño de la lista debe estar entre [2, 10]. |
imageFill |
Opción de visualización 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 |
Descripción del elemento de la colección. |
footer |
Texto del pie de página del elemento de la colección, que se muestra debajo de la descripción. Una sola línea de texto, truncada con puntos suspensivos |
image |
Imagen del elemento de la colección. |
openUriAction |
Obligatorio. Es el URI que se abrirá si se seleccionó 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. 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. Se puede usar junto con el campo firstSimple
en la instrucción que lo contiene para hablarle al 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 experiencia envolvente como un evento. Si el campo |
suppressMic |
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. |
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 el TTS durante toda la sesión de lienzo. Valor predeterminado: falso. |