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 JSON 
{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}
Campos
candidates[]

object (StaticPromptCandidate)

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 JSON 
{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}
Campos
selector

object (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

object (StaticPromptResponse)

La respuesta a la solicitud asociada con el selector.

Selector

Define los criterios para determinar si un mensaje coincide con una solicitud.

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

object (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 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 que se enviarán 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 voz y solo de texto.
content

object (StaticContentPrompt)

Opcional. Es un contenido, como una tarjeta, una lista o un contenido multimedia, para mostrarle al usuario.
lastSimple

object (StaticSimplePrompt)

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

object (Suggestion)

Opcional. Sugerencias que se mostrarán al usuario y que siempre aparecerán al final de la respuesta. Si el campo "agregar" del mensaje que lo contiene es "verdadero", los títulos definidos en este campo se agregarán a los títulos definidos en las sugerencias de sugerencias previamente definidas y se quitarán los valores duplicados.
override

boolean

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

object (StaticCanvasPrompt)

Una respuesta que se utilizará para la experiencia interactiva de lienzo.

StaticSimplePrompt

Representa un mensaje simple que se enviará a un usuario.

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

object (Variant)

Lista de posibles variantes.

Variant

Representa una variante que forma parte de un mensaje simple.

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

string

Opcional. Representa la voz que se dirá al usuario. Puede ser SSML o texto a voz. Si el campo "agregar" del mensaje que lo contiene es "verdadero", la voz definida en este campo se agregará a la voz del mensaje de Simple anterior.
text

string

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. Si el campo "append" de la instrucción que lo contiene es "true", 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 Content 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 que se reproducirá.
list

object (StaticListPrompt)

Una tarjeta para presentar una lista de opciones para seleccionar.
collection

object (StaticCollectionPrompt)

Una tarjeta que presenta una lista de opciones para seleccionar.

StaticCardPrompt

Una tarjeta básica para mostrar 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 se incluya una imagen. Admite un conjunto limitado de sintaxis de Markdown para formatear.
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

Una imagen que se muestra 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. Es una descripción de texto de la imagen que se usará para mejorar la 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, 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

enum (UrlHint)

Indica una sugerencia para el tipo de URL.

StaticTablePrompt

Una tarjeta de tabla 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. Es el título general de la tabla. Debe establecerse si se configuró un subtítulo.
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. 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 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

Es el texto del encabezado de la columna.
align

enum (HorizontalAlignment)

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 JSON 
{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}
Campos
cells[]

object (TableCell)

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

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 el contenido multimedia, como el nombre, la descripción, la URL, etc. ID siguiente: 9

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

enum (MediaType)

Es el 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 fraccionarios que termina en "s". Ejemplo: "3.5s".
optionalMediaControls[]

enum (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[]

object (MediaObject)

Lista de objetos multimedia.

MediaObject

Representa un solo objeto multimedia.

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

string

Es el nombre de este objeto multimedia.
description

string

Es la descripción de este objeto multimedia.
url

string

URL que dirige al contenido multimedia.
image

object (MediaImage)

Imagen para mostrar con la tarjeta multimedia.

MediaImage

Imagen que se mostrará en 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.
icon

object (StaticImagePrompt)

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

Es un elemento de la lista.

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

string

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

string

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

string

Opcional. Es el texto del cuerpo del elemento.
image

object (StaticImagePrompt)

Opcional. Imagen del artículo.

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. Es el tipo de opción de visualización de imágenes.

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

string

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

string

Opcional. Es el texto del cuerpo del elemento.
image

object (StaticImagePrompt)

Opcional. Imagen del artículo.

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. 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 la instrucción contenedora para hablar con el 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 la experiencia envolvente como un evento Si el campo "override" del mensaje que lo contiene es "false", los valores de datos definidos en este mensaje de Canvas se agregarán después de los valores de datos definidos en mensajes de Canvas anteriores.
suppressMic

boolean

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.