- Representación JSON
- ConfigFiles
- ConfigFile
- Manifiesto
- Acciones
- CustomAction
- Participación
- PushNotification
- DailyUpdate
- ActionLink
- AssistantLink
- Configuración
- Categoría
- SurfaceRequirements
- CapabilityRequirement
- SurfaceCapability
- LocalizedSettings
- ThemeCustomization
- ImageCornerStyle
- AccountLinking
- LinkingType
- AuthGrantType
- Webhook
- Controlador
- HttpsEndpoint
- InlineCloudFunction
- Intención
- IntentParameter
- ClassReference
- EntitySetReferences
- EntitySetReference
- Tipo
- SynonymType
- MatchType
- Entity
- EntityDisplay
- RegularExpressionType
- Entity
- FreeTextType
- EntitySet
- Entity
- GlobalIntentEvent
- EventHandler
- StaticPrompt
- StaticPromptCandidate
- Selector
- SurfaceCapabilities
- Capacidad
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- ImageFill
- StaticLinkPrompt
- OpenUrl
- UrlHint
- StaticTablePrompt
- TableColumn
- HorizontalAlignment
- TableRow
- TableCell
- StaticMediaPrompt
- MediaType
- OptionalMediaControls
- MediaObject
- MediaImage
- RepeatMode
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- StaticCollectionBrowsePrompt
- CollectionBrowseItem
- Sugerencia
- StaticCanvasPrompt
- Escena
- IntentEvent
- ConditionalEvent
- Ranura
- PromptSettings
- CommitBehavior
- DefaultValue
- DataFiles
- DataFile
Wrapper para una lista de archivos.
Representación JSON | |
---|---|
{ // Union field |
Campos | ||
---|---|---|
Campo de unión file_type . Solo se puede enviar un tipo de archivos a la vez al servidor, archivos de configuración o archivos de datos. Las direcciones (file_type ) solo pueden ser una de las siguientes opciones: |
||
configFiles |
Lista de archivos de configuración. Esto incluye el manifiesto, la configuración, los paquetes de recursos del modelo de interacción y mucho más. |
|
dataFiles |
Lista de archivos de datos. Esto incluye imágenes, archivos de audio y código fuente de Cloud Functions. |
ConfigFiles
Wrapper para archivos de configuración repetidos. Los campos repetidos no pueden existir en uno de ellos.
Representación JSON | |
---|---|
{
"configFiles": [
{
object ( |
Campos | |
---|---|
configFiles[] |
Varios archivos de configuración. |
ConfigFile
Representa un archivo único que contiene datos estructurados. Los desarrolladores pueden definir la mayor parte de sus proyectos con parámetros de configuración estructurados que incluyen acciones, configuración y entrega.
Representación JSON | |
---|---|
{ "filePath": string, // Union field |
Campos | ||
---|---|---|
filePath |
Es la ruta de acceso relativa del archivo de configuración desde la raíz del proyecto en la estructura de archivos del SDK. Cada uno de los siguientes tipos de archivos tiene una ruta de archivo permitida. P. ej.: settings/settings.yaml |
|
Campo de unión file . Cada tipo de archivo de configuración debe tener un campo correspondiente. Las direcciones (file ) solo pueden ser una de las siguientes opciones: |
||
manifest |
Archivo de manifiesto único Ruta de archivo permitida: |
|
actions |
Archivo de acciones único con todas las acciones definidas. Rutas de acceso a archivos permitidas: |
|
settings |
Configuración única que incluye parámetros de configuración no localizables y los ajustes de la configuración regional predeterminada del proyecto (si se especifica). En el caso de un archivo de anulación de configuración regional, solo se propagará el campo localizedSettings. Rutas de acceso a archivos permitidas: |
|
webhook |
Definición de webhook único. Ruta de archivo permitida: |
|
intent |
Definición de intent único. Rutas de acceso a archivos permitidas: |
|
type |
Definición de tipo único. Rutas de acceso a archivos permitidas: |
|
entitySet |
Definición de conjunto de entidades únicas. Rutas de acceso a archivos permitidas: |
|
globalIntentEvent |
Definición de evento de intent global único. Rutas de acceso de archivos permitidas: |
|
scene |
Definición de una sola escena. Rutas de acceso a archivos permitidas: |
|
staticPrompt |
Definición de instrucción estática única. Rutas de acceso a archivos permitidas: |
|
accountLinkingSecret |
Metadatos correspondientes al secreto del cliente que se usa en la vinculación de cuentas. Ruta de archivo permitida: |
|
resourceBundle |
Paquete de recursos único, que es un mapa de una cadena a una cadena o una lista de cadenas. Los paquetes de recursos se podrían usar para localizar cadenas en instrucciones estáticas. Rutas de acceso a archivos permitidas: |
Manifiesto
Contiene información que es "transportable" es decir, no son específicos para ningún proyecto y pueden moverse entre proyectos.
Representación JSON | |
---|---|
{ "version": string } |
Campos | |
---|---|
version |
Es la versión del formato de archivo. La versión del formato de archivo actual es 1.0. Por ejemplo, “1.0” |
Acciones
Representa la lista de acciones definidas en un proyecto.
Representación JSON | |
---|---|
{
"custom": {
string: {
object ( |
Campos | |
---|---|
custom |
Asigna los intents a acciones personalizadas para configurar la invocación del proyecto. Los intents de invocación pueden ser intents del sistema o personalizados definidos en la columna "custom/intents/" . Todos los intents definidos aquí (intents de sistema y personalizados) deben tener un archivo de intent correspondiente en el campo "custom/global/" . Es un objeto que contiene una lista de pares |
CustomAction
Son los detalles relacionados con una acción personalizada.
Representación JSON | |
---|---|
{
"engagement": {
object ( |
Campos | |
---|---|
engagement |
Mecanismos de participación asociados con la acción para ayudar a los usuarios finales a suscribirse a notificaciones push y actualizaciones diarias. Ten en cuenta que el nombre del intent especificado en la configuración de ranuras de notificaciones push o actualizaciones diarias debe coincidir con el intent correspondiente a esta acción para que los usuarios finales se suscriban a estas actualizaciones. |
Participación
Define los mecanismos de interacción asociados con esta acción. Esto permite que los usuarios finales se suscriban a las notificaciones push y las actualizaciones diarias.
Representación JSON | |
---|---|
{ "title": string, "pushNotification": { object ( |
Campos | |
---|---|
title |
El título de la interacción que se enviará a los usuarios finales para solicitar su permiso para recibir actualizaciones. La instrucción que se envía a los usuarios finales para obtener actualizaciones diarias se verá así: "¿A qué hora quieres que te envíe tu {title}" diario. En el caso de las notificaciones push, aparecerá un mensaje similar a "Is it ok if I send push notifications for {title}". Este campo se puede localizar. |
pushNotification |
La configuración de notificaciones push que admite esta participación. |
actionLink |
Configuración de vínculos para una acción que determina si el uso compartido de vínculos está habilitado para la acción y, de ser así, contiene un nombre visible fácil de usar para el vínculo. ActionLink dejó de estar disponible. En su lugar, usa AssistantLink. |
assistantLink |
Configuración de vínculos para una acción que determina si el uso compartido de vínculos está habilitado para la acción y, de ser así, contiene un nombre visible fácil de usar para el vínculo. |
dailyUpdate |
Configuración de actualizaciones diarias que admite esta interacción. |
PushNotification
Define la configuración de notificaciones push que admite esta participación.
DailyUpdate
Define la configuración de actualizaciones diarias que admite esta interacción.
ActionLink
Indica si el uso compartido de vínculos está habilitado para esta acción y la configuración correspondiente. Los vínculos de acción se usan para vincular directamente a un usuario con una acción específica. ActionLink dejó de estar disponible. En su lugar, usa AssistantLink.
Representación JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
Es el título visible fácil de usar para el vínculo. |
AssistantLink
Indica si el uso compartido de vínculos está habilitado para esta acción y la configuración correspondiente. Los vínculos de Asistente se usan para vincular directamente a un usuario con una acción específica.
Representación JSON | |
---|---|
{ "title": string } |
Campos | |
---|---|
title |
Es el título visible fácil de usar para el vínculo. |
Configuración
Representa la configuración de un proyecto de acciones que no es específica de una configuración regional. Siguiente etiqueta: 22
Representación JSON | |
---|---|
{ "projectId": string, "defaultLocale": string, "enabledRegions": [ string ], "disabledRegions": [ string ], "category": enum ( |
Campos | |
---|---|
projectId |
ID del proyecto de acciones. |
defaultLocale |
Es la configuración regional predeterminada del proyecto. Para todos los archivos, excepto en |
enabledRegions[] |
Representa las regiones en las que los usuarios pueden invocar tus acciones, según la ubicación de presencia del usuario. No se puede establecer si se establece |
disabledRegions[] |
Representa las regiones en las que se bloquean tus acciones, según la ubicación de presencia del usuario. No se puede establecer si se establece |
category |
La categoría de este proyecto de acciones. |
usesTransactionsApi |
Indica si las acciones pueden usar transacciones (por ejemplo, hacer reservas, tomar pedidos, etcétera). Si es falso, los intentos de usar las APIs de Transactions fallarán. |
usesDigitalPurchaseApi |
Si Actions puede realizar transacciones de artículos digitales |
usesInteractiveCanvas |
Indica si las acciones usan Interactive Canvas. |
usesHomeStorage |
Indica si las Acciones usan la función de almacenamiento de la casa. |
designedForFamily |
Si el contenido de Actions está diseñado para familias (DFF) |
containsAlcoholOrTobaccoContent |
Si Acciones incluye contenido relacionado con las bebidas alcohólicas o el tabaco. |
keepsMicOpen |
Si el parámetro Acciones puede dejar el micrófono abierto sin un mensaje explícito durante la conversación. |
surfaceRequirements |
Los requisitos de superficie que debe admitir una plataforma de cliente para invocar acciones en este proyecto. |
testingInstructions |
Instrucciones de prueba en formato libre para el revisor de Actions (por ejemplo, instrucciones de vinculación de cuentas). |
localizedSettings |
Configuración localizada para la configuración regional predeterminada del proyecto. Cada configuración regional adicional debe tener su propio archivo de configuración en su propio directorio. |
accountLinking |
Permite que los usuarios creen o vinculen cuentas mediante el Acceso con Google o tu propio servicio de OAuth. |
selectedAndroidApps[] |
Apps para Android seleccionadas para acceder a las compras de Google Play y las transacciones Esta es una selección de las apps para Android conectadas al proyecto de acciones para verificar la propiedad de la marca y habilitar funciones adicionales. Para obtener más información, consulta https://developers.google.com/assistant/console/brand-verification. |
Categoría
Las opciones de categoría para un proyecto de acciones.
Enumeraciones | |
---|---|
CATEGORY_UNSPECIFIED |
Desconocido / Sin especificar. |
BUSINESS_AND_FINANCE |
Categoría de negocios y finanzas. |
EDUCATION_AND_REFERENCE |
Categoría Educación y referencia. |
FOOD_AND_DRINK |
Categoría de comida y bebida. |
GAMES_AND_TRIVIA |
Juegos y preguntas y respuestas. |
HEALTH_AND_FITNESS |
Salud y fitness. |
KIDS_AND_FAMILY |
Niños y familia. |
LIFESTYLE |
Categoría de estilo de vida. |
LOCAL |
Categoría local. |
MOVIES_AND_TV |
Categoría de películas y TV. |
MUSIC_AND_AUDIO |
Categoría Música y audio. |
NEWS |
categoría de noticias, |
NOVELTY_AND_HUMOR |
Categoría Novedades y humor. |
PRODUCTIVITY |
Categoría de productividad. |
SHOPPING |
Categoría de compras. |
SOCIAL |
Categoría social. |
SPORTS |
Categoría de deportes. |
TRAVEL_AND_TRANSPORTATION |
Categoría Viajes y transporte. |
UTILITIES |
Categoría de servicios públicos. |
WEATHER |
Categoría de clima. |
HOME_CONTROL |
Categoría Control del hogar. |
SurfaceRequirements
Contiene un conjunto de requisitos que la plataforma de cliente debe admitir para invocar Actions en tu proyecto.
Representación JSON | |
---|---|
{
"minimumRequirements": [
{
object ( |
Campos | |
---|---|
minimumRequirements[] |
El conjunto mínimo de capacidades necesarias para invocar las acciones en tu proyecto. Si a la superficie le falta alguno de estos elementos, no se activará la acción. |
CapabilityRequirement
Representa un requisito sobre la disponibilidad de una función determinada.
Representación JSON | |
---|---|
{
"capability": enum ( |
Campos | |
---|---|
capability |
Es el tipo de capacidad. |
SurfaceCapability
Conjunto posible de capacidades de superficie.
Enumeraciones | |
---|---|
SURFACE_CAPABILITY_UNSPECIFIED |
Desconocido / Sin especificar. |
AUDIO_OUTPUT |
La superficie admite salida de audio. |
SCREEN_OUTPUT |
La superficie admite resultados visuales o de pantalla. |
MEDIA_RESPONSE_AUDIO |
La superficie admite audio de respuesta multimedia. |
WEB_BROWSER |
Surface admite navegadores web. |
ACCOUNT_LINKING |
Surface admite la vinculación de cuentas. |
INTERACTIVE_CANVAS |
La superficie es compatible con Interactive Canvas. |
HOME_STORAGE |
Surface admite el almacenamiento en casa. |
LocalizedSettings
Representa la configuración de un proyecto de acciones que es específica de una configuración regional del usuario. En este caso, usuario se refiere al usuario final que invoca tus Acciones. Este mensaje se puede localizar.
Representación JSON | |
---|---|
{
"displayName": string,
"pronunciation": string,
"shortDescription": string,
"fullDescription": string,
"smallLogoImage": string,
"largeBannerImage": string,
"developerName": string,
"developerEmail": string,
"termsOfServiceUrl": string,
"voice": string,
"voiceLocale": string,
"privacyPolicyUrl": string,
"sampleInvocations": [
string
],
"themeCustomization": {
object ( |
Campos | |
---|---|
displayName |
Obligatorio. El nombre visible predeterminado de este proyecto de acciones (si no hay una traducción disponible) |
pronunciation |
Obligatorio. La pronunciación del nombre visible para invocarlo en un contexto de voz (sonido). |
shortDescription |
Obligatorio. La descripción breve predeterminada del proyecto de acciones (si no hay una traducción disponible). Límite de 80 caracteres. |
fullDescription |
Obligatorio. La descripción larga predeterminada del proyecto de acciones (si no hay una traducción disponible). Límite de 4,000 caracteres. |
smallLogoImage |
Obligatorio. Imagen cuadrada pequeña de 192 x 192 px Se debe especificar como referencia a la imagen correspondiente en el directorio |
largeBannerImage |
Opcional. Imagen horizontal grande (1920 x 1080 px) Se debe especificar como referencia a la imagen correspondiente en el directorio |
developerName |
Obligatorio. El nombre del desarrollador que se mostrará a los usuarios. |
developerEmail |
Obligatorio. Es la dirección de correo electrónico de contacto del desarrollador. |
termsOfServiceUrl |
Opcional. La URL de las Condiciones del Servicio. |
voice |
Obligatorio. El tipo de voz de Asistente de Google que escuchan los usuarios cuando interactúan con tus Acciones. Los valores admitidos son "male_1", "male_2", "female_1" y "female_2". |
voiceLocale |
Opcional. Es la configuración regional de la voz especificada. Si no se especifica, se resuelve en la configuración regional del Asistente del usuario. Si se especifica, la configuración regional de la voz debe tener el mismo idioma raíz que la configuración regional especificada en LocalizedSettings. |
privacyPolicyUrl |
Obligatorio. Es la URL de la política de privacidad. |
sampleInvocations[] |
Opcional. Frases de invocación de muestra que se muestran como parte de la descripción de tu proyecto de Acciones en el directorio del Asistente. Esto ayudará a los usuarios a aprender a usarlo. |
themeCustomization |
Opcional. Personalizaciones de temas para componentes visuales de tus acciones. |
ThemeCustomization
Estilos que se aplican a las tarjetas que se presentan a los usuarios
Representación JSON | |
---|---|
{
"backgroundColor": string,
"primaryColor": string,
"fontFamily": string,
"imageCornerStyle": enum ( |
Campos | |
---|---|
backgroundColor |
Color de fondo de las tarjetas Actúa como un resguardo si los desarrolladores no proporcionan |
primaryColor |
El color principal del tema de la acción se usará para establecer el color del texto del título y el color de fondo del elemento de acción para las tarjetas de Actions on Google. Ejemplo de uso: #FAFAFA |
fontFamily |
La familia de fuentes que se utilizará para el título de las tarjetas. Fuentes compatibles: - Sans Serif - Sans Serif Medium - Sans Serif Bold - Sans Serif Black - Sans Serif condensed - Sans Serif condensed Medium - Serif - Serif Bold - Monospace - Cursiva - Sans Serif Smallcaps |
imageCornerStyle |
Estilo del borde de la imagen de tarjetas en primer plano. Por ejemplo, se puede aplicar en la imagen en primer plano de una tarjeta básica o de carrusel. |
landscapeBackgroundImage |
Modo horizontal (mínimo de 1,920 x 1,200 píxeles). Se debe especificar como referencia a la imagen correspondiente en el directorio |
portraitBackgroundImage |
Modo Retrato (mínimo de 1,200 x 1,920 píxeles) Se debe especificar como referencia a la imagen correspondiente en el directorio |
ImageCornerStyle
Describe cómo se deben renderizar los bordes de las imágenes.
Enumeraciones | |
---|---|
IMAGE_CORNER_STYLE_UNSPECIFIED |
No definido / No especificado. |
CURVED |
Esquina redondeada para la imagen. |
ANGLED |
Esquina rectangular de la imagen. |
AccountLinking
AccountLinking permite que Google guíe al usuario para que acceda a los servicios web de la app.
Para los tipos de vinculación de Acceso con Google y OAuth + Acceso con Google, Google genera un ID de cliente que identifica tu app ante Google ("ID de cliente emitido por Google a tus Acciones" en la IU de la consola). Este campo es de solo lectura y se puede verificar navegando a la página de Vinculación de cuentas de la IU de Console. Consulta: https://developers.google.com/assistant/identity/google-sign-in
Nota: Para todos los tipos de configuración de vinculación de cuentas (excepto para Acceso con Google), debes proporcionar un nombre de usuario y una contraseña para una cuenta de prueba en Settings.testing_instructions para que el equipo de revisión revise la app (los usuarios no podrán verlas).
Representación JSON | |
---|---|
{ "enableAccountCreation": boolean, "linkingType": enum ( |
Campos | |
---|---|
enableAccountCreation |
Obligatorio. Si es |
linkingType |
Obligatorio. El tipo de vinculación que se usará. Consulta https://developers.google.com/assistant/identity para obtener más detalles sobre los tipos de vinculación. |
authGrantType |
Opcional. Indica el tipo de autenticación para OAUTH LinkingType. |
appClientId |
Opcional. ID de cliente que su aplicación emite a Google. Este es el ID de cliente de OAuth2 que identifica a Google en tu servicio. Solo se configura cuando se usa OAuth. |
authorizationUrl |
Opcional. Extremo para tu página web de acceso que admite código OAuth2 o flujos implícitos. La URL debe usar HTTPS. Solo se configura cuando se usa OAuth. |
tokenUrl |
Opcional. Extremo OAuth2 para el intercambio de tokens. La URL debe usar HTTPS. Esto no se establece cuando solo se usa OAuth con la concesión IMPLICIT como tipo de vinculación. Solo se configura cuando se usa OAuth. |
scopes[] |
Opcional. Es la lista de permisos que el usuario debe aceptar para usar tu servicio. Solo se configura cuando se usa OAuth. Asegúrate de proporcionar las Condiciones del Servicio en la información del directorio, en la sección LocalizedSettings.terms_of_service_url, si especificas este campo. |
learnMoreUrl |
Opcional. Esta es la página web de tu servicio y describe los permisos que el usuario le otorga a Google. Solo se configura si se usa OAuth y Acceso con Google. Asegúrate de proporcionar las Condiciones del Servicio en la información del directorio, en la sección LocalizedSettings.terms_of_service_url, si especificas este campo. |
useBasicAuthHeader |
Opcional. Si esta preferencia se establece como verdadera, permitir que Google transmita el secreto y el ID de cliente a través del encabezado de autenticación básica HTTP. De lo contrario, Google utilizará el ID de cliente y el secreto del cuerpo de la entrada. Solo se configura cuando se usa OAuth. Asegúrate de proporcionar las Condiciones del Servicio en la información del directorio, en la sección LocalizedSettings.terms_of_service_url, si especificas este campo. |
LinkingType
Es el tipo de vinculación de cuentas que se debe realizar.
Enumeraciones | |
---|---|
LINKING_TYPE_UNSPECIFIED |
Sin especificar. |
GOOGLE_SIGN_IN |
Tipo de vinculación de Acceso con Google. Si usas este tipo de vinculación, no es necesario establecer ningún campo relacionado con OAuth a continuación. |
OAUTH_AND_GOOGLE_SIGN_IN |
Tipo de vinculación de OAuth y Acceso con Google. |
OAUTH |
Tipo de vinculación de OAuth. |
AuthGrantType
El tipo de otorgamiento de OAuth2 que usa Google para guiar al usuario a fin de que acceda al servicio web de tu app.
Enumeraciones | |
---|---|
AUTH_GRANT_TYPE_UNSPECIFIED |
Sin especificar. |
AUTH_CODE |
Otorgamiento del código de autorización. Requiere que proporciones una URL de autenticación y una URL de token de acceso. |
IMPLICIT |
Otorgamiento de código implícito Solo requiere que proporciones una URL de autenticación. |
Webhook
Metadatos para diferentes tipos de webhooks Si usas inlineCloudFunction
, tu código fuente debe estar en un directorio con el mismo nombre que el valor de la clave executeFunction
. Por ejemplo, un valor de my_webhook
para la clave executeFunction
tendría una estructura de código como la siguiente: - /webhooks/my_webhook.yaml
- /webhooks/my_webhook/index.js
- /webhooks/my_webhook/package.json
Representación JSON | |
---|---|
{ "handlers": [ { object ( |
Campos | ||
---|---|---|
handlers[] |
Lista de controladores para este webhook. |
|
Campo de unión webhook_type . Solo se admite un tipo de webhook. Las direcciones (webhook_type ) solo pueden ser una de las siguientes opciones: |
||
httpsEndpoint |
Extremo HTTPS de webhook personalizado. |
|
inlineCloudFunction |
Metadatos de la Cloud Function implementada a partir del código en la carpeta de webhooks. |
Handler
Declara el nombre del controlador de webhooks. Un webhook puede tener varios controladores registrados. Se puede llamar a estos controladores desde varios lugares en tu proyecto de acciones.
Representación JSON | |
---|---|
{ "name": string } |
Campos | |
---|---|
name |
Obligatorio. Nombre del controlador. Debe ser único entre todos los controladores del proyecto de acciones. Puedes verificar el nombre de este controlador para invocar la función correcta en tu código fuente de entrega. |
HttpsEndpoint
Extremo de REST para notificar si no estás usando el editor directo.
Representación JSON | |
---|---|
{ "baseUrl": string, "httpHeaders": { string: string, ... }, "endpointApiVersion": integer } |
Campos | |
---|---|
baseUrl |
La URL base HTTPS de tu extremo de entrega (HTTP no es compatible). Los nombres de los controladores se agregan a la ruta de URL base después de los dos puntos (según la guía de estilo en https://cloud.google.com/apis/design/custom_methods). Por ejemplo, una URL base de “https://gactions.service.com/api” recibirían solicitudes con la URL "https://gactions.service.com/api:{method}". |
httpHeaders |
Mapa de los parámetros HTTP que se incluirán en la solicitud POST. Es un objeto que contiene una lista de pares |
endpointApiVersion |
Versión del protocolo que usa el extremo. Este es el protocolo que comparten todos los tipos de entrega y no es específico del tipo de entrega de Google. |
InlineCloudFunction
Contiene los metadatos de una Cloud Function intercalada que se implementó desde la carpeta de webhooks.
Representación JSON | |
---|---|
{ "executeFunction": string } |
Campos | |
---|---|
executeFunction |
El nombre del punto de entrada de Cloud Function. El valor de este campo debe coincidir con el nombre del método exportado desde el código fuente. |
Intent
Los intents asignan entradas de usuario abiertas a objetos estructurados. Las frases habladas se asocian con intents de comprensión del lenguaje natural (CLN) de Google. Las coincidencias de intents pueden activar eventos en el diseño de tu conversación para hacer avanzar la conversación del usuario. El nombre del intent se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{
"parameters": [
{
object ( |
Campos | |
---|---|
parameters[] |
La lista de parámetros dentro de las frases de entrenamiento. Se deben definir todos los parámetros aquí para que se usen en la frase de entrenamiento. |
trainingPhrases[] |
Las frases de entrenamiento permiten que la CLN de Google haga coincidir automáticamente los intents con las entradas del usuario. Cuantas más frases únicas se proporcionen, más probabilidades hay de que se detecte una coincidencia con este intent. A continuación, se muestra el formato de la parte de la frase de entrenamiento que están anotadas. Ten en cuenta que el campo |
IntentParameter
Definición de un parámetro que puede usarse dentro de las frases de entrenamiento.
Representación JSON | |
---|---|
{ "name": string, // Union field |
Campos | ||
---|---|---|
name |
Obligatorio. Es el nombre único del parámetro del intent. Se puede usar en condiciones y respuestas para hacer referencia a los parámetros de intent extraídos por CLN con $intent.params.[name].resolved. |
|
Campo de unión parameter_type . El tipo de parámetro del intent. Las direcciones (parameter_type ) solo pueden ser una de las siguientes opciones: |
||
type |
Opcional. Declara el tipo de datos de este parámetro. No se debe configurar para intents integrados. |
|
entitySetReferences |
Opcional. Referencias a los conjuntos de entidades permitidas para este parámetro de intent. Solo es válido para los parámetros de un intent integrado. Estas referencias apuntan a conjuntos de entidades en el bucket . |
ClassReference
Es una referencia a una clase que se usa para declarar el tipo de un campo o un valor que se muestra. Las enumeraciones también son un tipo de clase a la que se puede hacer referencia con ClassReference.
Representación JSON | |
---|---|
{ "name": string, "list": boolean } |
Campos | |
---|---|
name |
Obligatorio. El nombre de un tipo integrado o un tipo personalizado del parámetro. Ejemplos: |
list |
Opcional. Indica si el tipo de datos representa una lista de valores. |
EntitySetReferences
Referencias de conjunto de entidades para un parámetro de intent.
Representación JSON | |
---|---|
{
"entitySetReferences": [
{
object ( |
Campos | |
---|---|
entitySetReferences[] |
Obligatorio. Referencias de conjunto de entidades para un parámetro de intent. |
EntitySetReference
Es una referencia al conjunto de entidades permitidas para este parámetro de intent.
Representación JSON | |
---|---|
{ "entitySet": string } |
Campos | |
---|---|
entitySet |
Obligatorio. Identifica el conjunto específico de entidades que se considerarán para un parámetro determinado. La definición del conjunto de entidades correspondiente debe estar presente en el directorio custom/entitySets/. |
Tipo
Declaración de un tipo personalizado, a diferencia de los tipos integrados Se pueden asignar tipos a ranuras en una escena o parámetros de frases de entrenamiento de un intent. En la práctica, los tipos se pueden considerar como enumeraciones. Ten en cuenta que el nombre del tipo se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{ "exclusions": [ string ], // Union field |
Campos | ||
---|---|---|
exclusions[] |
Conjunto de palabras o frases excepcionales que no deberían coincidir por tipo. Nota: Si el tipo coincide con una palabra o frase, pero aparece como una exclusión, no se mostrará en el resultado de la extracción de parámetros. Este campo se puede localizar. |
|
Campo de unión sub_type . Selección de un subtipo según el tipo de coincidencia que se realizará. Las direcciones (sub_type ) solo pueden ser una de las siguientes opciones: |
||
synonym |
Sinónimos, que es, básicamente, una enumeración. |
|
regularExpression |
Tipo de regex, permite la coincidencia de expresiones regulares. |
|
freeText |
Tipo FreeText. |
SynonymType
Tipo que coincide con el texto por conjunto de sinónimos.
Representación JSON | |
---|---|
{ "matchType": enum ( |
Campos | |
---|---|
matchType |
Opcional. El tipo de concordancia para el sinónimo. |
acceptUnknownValues |
Opcional. Cuando se establece como verdadero, se generan coincidencias con palabras o frases desconocidas según la entrada de su entorno y los datos de entrenamiento de intents, como los artículos que se podrían agregar a una lista de compras. |
entities |
Obligatorio. Mapa con nombre de entidades de sinónimos. Es un objeto que contiene una lista de pares |
MatchType
El tipo de coincidencia que usarán las entradas de este tipo. Esto garantizará que todos los tipos usen el mismo método de coincidencia y permitirá la variación de la coincidencia para la coincidencia de sinónimos (es decir, difusa o exacta). Si el valor es UNSPECIFIED
, se establecerá como EXACT_MATCH
de forma predeterminada.
Enumeraciones | |
---|---|
UNSPECIFIED |
La configuración predeterminada es EXACT_MATCH . |
EXACT_MATCH |
Busca una concordancia exacta del sinónimo o del nombre. |
FUZZY_MATCH |
Más baja que EXACT_MATCH . Busca coincidencias similares y exactas. |
Entidad
Representa un campo de entidad de sinónimos que contiene los detalles de una sola entrada dentro del tipo.
Representación JSON | |
---|---|
{
"display": {
object ( |
Campos | |
---|---|
display |
Opcional. Los detalles visibles de la entidad |
synonyms[] |
Opcional. La lista de sinónimos de la entidad. Este campo se puede localizar. |
EntityDisplay
Son elementos que se mostrarán en el recuadro una vez que se extraiga una entidad de un tipo en particular de una consulta. Solo es pertinente para las apps habilitadas para Canvas. Este mensaje se puede localizar.
Representación JSON | |
---|---|
{ "iconTitle": string, "iconUrl": string } |
Campos | |
---|---|
iconTitle |
Opcional. Es el título del ícono. |
iconUrl |
Obligatorio. Es la URL del ícono. |
RegularExpressionType
Tipo que coincide con el texto mediante expresiones regulares. Este mensaje se puede localizar.
Representación JSON | |
---|---|
{
"entities": {
string: {
object ( |
Campos | |
---|---|
entities |
Obligatorio. Mapa con nombre de entidades que contienen cadenas de regex. Es un objeto que contiene una lista de pares |
Entidad
Representa un objeto de entidad que contiene la expresión regular que se usa para la comparación.
Representación JSON | |
---|---|
{
"display": {
object ( |
Campos | |
---|---|
display |
Opcional. Son elementos que se mostrarán en el recuadro una vez que se extraiga una entidad de una consulta. Solo es pertinente para las apps habilitadas para Canvas. |
regularExpressions[] |
Obligatorio. Usa la sintaxis de regex RE2 (para obtener más información, consulta https://github.com/google/re2/wiki/Syntax) |
FreeTextType
Tipo que coincide con cualquier texto si el contexto de las palabras cercanas se acerca a los ejemplos de entrenamiento proporcionados.
Representación JSON | |
---|---|
{
"display": {
object ( |
Campos | |
---|---|
display |
Opcional. Son elementos que se mostrarán en el recuadro una vez que se extraiga una entidad de una consulta. Solo es pertinente para las apps habilitadas para Canvas. |
EntitySet
Los conjuntos de entidades describen el conjunto predefinido de entidades de las que pueden provenir los valores de los parámetros de intents integrados. Se puede hacer referencia a los conjuntos de entidades desdeEntitySet en los parámetros de intents integrados.
Representación JSON | |
---|---|
{
"entities": [
{
object ( |
Campos | |
---|---|
entities[] |
Obligatorio. Es la lista de entidades que admite este conjunto de entidades. |
Entidad
Una entidad de la que puede provenir un valor del parámetro de intent integrado.
Representación JSON | |
---|---|
{ "id": string } |
Campos | |
---|---|
id |
Obligatorio. Es el ID de la entidad. Para obtener una lista de los parámetros de intents integrados y sus entidades compatibles, consulta https://developers.google.com/assistant/conversational/build/built-in-intents. |
GlobalIntentEvent
Define un controlador de intents global. Los eventos de intents globales tienen alcance para todo el proyecto de acciones y los controladores de intents en una escena pueden anularlos. Los nombres de los intents deben ser únicos dentro de un proyecto de acciones.
Se pueden detectar coincidencias con intents globales en cualquier momento de una sesión, lo que permite a los usuarios acceder a flujos comunes, como "obtener ayuda". o "volver a la pantalla principal". También se pueden usar para vincular directamente a los usuarios a flujos específicos cuando invocan una acción.
Ten en cuenta que el nombre del intent se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{
"transitionToScene": string,
"handler": {
object ( |
Campos | |
---|---|
transitionToScene |
Opcional. Escena de destino a la que debe saltar la conversación. El estado de la escena actual se destruye durante la transición. |
handler |
Opcional. Controlador de eventos que se activa cuando coincide el intent Se debe ejecutar antes de hacer la transición a la escena de destino. Son útiles para generar instrucciones en respuesta a eventos. |
EventHandler
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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{
"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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{
"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 JSON | |
---|---|
{
"capabilities": [
enum ( |
Campos | |
---|---|
capabilities[] |
Obligatorio. Las capacidades de la superficie que realiza una solicitud a la acción. |
Función
Funciones que admite la superficie del dispositivo al momento de la solicitud.
Enumeraciones | |
---|---|
UNSPECIFIED |
Capacidad de superficie no especificada. |
SPEECH |
El dispositivo puede hablarle al usuario a través de la función de texto a voz o SSML. |
RICH_RESPONSE |
El dispositivo puede mostrar respuestas enriquecidas, como tarjetas, listas y tablas. |
LONG_FORM_AUDIO |
El dispositivo puede reproducir contenido multimedia de audio de formato largo, como música y podcasts. |
INTERACTIVE_CANVAS |
El dispositivo puede mostrar una respuesta de lienzo interactiva. |
WEB_LINK |
El dispositivo puede usar vínculos web en respuestas enriquecidas para abrir un navegador web. |
HOME_STORAGE |
El dispositivo puede permitir guardar y recuperar almacenamiento de la casa. |
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 ( |
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 JSON | |
---|---|
{
"variants": [
{
object ( |
Campos | |
---|---|
variants[] |
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 |
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 JSON | |
---|---|
{ // 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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{ "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. |
ImageFill
Es posible que las opciones de visualización de imágenes afecten su presentación. Se debe usar cuando la relación de aspecto de la imagen no coincide con la del contenedor de la imagen.
Enumeraciones | |
---|---|
UNSPECIFIED |
ImageFill sin especificar. |
GRAY |
Rellena los espacios entre la imagen y el contenedor de imágenes con barras grises. |
WHITE |
Rellena los espacios entre la imagen y el contenedor de imágenes con barras blancas. |
CROPPED |
La imagen se ajusta de modo que su ancho y alto coincidan o superen las dimensiones del contenedor. Esto puede recortar la parte superior e inferior de la imagen si la altura de la imagen ajustada es mayor que la altura del contenedor, o bien recortar la parte izquierda y derecha de la imagen si el ancho es mayor que el ancho del contenedor. Esto es similar al "modo de zoom" en una TV de pantalla panorámica cuando se reproduce un video 4:3. |
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 ( |
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 JSON | |
---|---|
{
"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. |
UrlHint
Diferentes tipos de sugerencias de URL.
Enumeraciones | |
---|---|
HINT_UNSPECIFIED |
Sin especificar |
AMP |
URL que dirige directamente al contenido de AMP o a una URL canónica que hace referencia al contenido de AMP mediante <link rel="amphtml"> . |
StaticTablePrompt
Una tarjeta para mostrar una tabla de texto.
Representación JSON | |
---|---|
{ "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 JSON | |
---|---|
{
"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. |
HorizontalAlignment
Es la alineación del contenido dentro de la celda.
Enumeraciones | |
---|---|
UNSPECIFIED |
HorizontalAlignment sin especificar. |
LEADING |
Borde inicial de la celda. Esta es la opción predeterminada. |
CENTER |
El contenido se alinea con el centro de la columna. |
TRAILING |
El contenido se alinea con el borde final de la columna. |
Fila de la tabla
Describe una fila en la tabla.
Representación JSON | |
---|---|
{
"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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{ "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. |
MediaType
Tipo de medio de esta respuesta.
Enumeraciones | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Valor UNSPECIFIED |
AUDIO |
Archivo de audio. |
MEDIA_STATUS_ACK |
Respuesta para confirmar un informe de estado de contenido multimedia. |
OptionalMediaControls
Tipos de controles multimedia que la respuesta multimedia admite opcionalmente
Enumeraciones | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Valor sin especificar |
PAUSED |
Evento pausado. Se activa cuando el usuario pausa el contenido multimedia. |
STOPPED |
Se detuvo el evento. Se activa cuando el usuario sale de la sesión de terceros durante la reproducción de contenido multimedia. |
MediaObject
Representa un objeto multimedia único.
Representación JSON | |
---|---|
{
"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 JSON | |
---|---|
{ // 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. |
RepeatMode
Son los tipos de modo de repetición para una lista de objetos multimedia.
Enumeraciones | |
---|---|
REPEAT_MODE_UNSPECIFIED |
Equivale a DESACTIVADA. |
OFF |
Finaliza la sesión multimedia al final del último objeto multimedia. |
ALL |
Establece un bucle al principio del primer objeto multimedia cuando se alcance el final del último. |
StaticListPrompt
Una tarjeta para presentar una lista de opciones que se pueden seleccionar.
Representación JSON | |
---|---|
{
"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 JSON | |
---|---|
{
"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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{
"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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{ "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 JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "sendStateDataToCanvasApp": boolean, "enableFullScreen": 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 |
Scene
La escena es la unidad básica de flujo de control cuando se diseña una conversación. Se pueden encadenar con otras escenas, generar solicitudes para el usuario final y definir ranuras. El nombre de la escena se especifica en el nombre del archivo.
Representación JSON | |
---|---|
{ "onEnter": { object ( |
Campos | |
---|---|
onEnter |
Controlador que se invocará durante la transición a esta escena. |
intentEvents[] |
Es la lista de eventos que se activan en función de los intents. Estos eventos se pueden activar en cualquier momento después de que se haya llamado al controlador on_load. Importante: Estos eventos definen el conjunto de intents específicos de esta escena y tendrán prioridad sobre cualquier evento definido globalmente que tenga los mismos intents o sus frases de activación. Los nombres de los intents deben ser únicos dentro de una escena. |
conditionalEvents[] |
La lista de eventos que se activarán en función de sentencias condicionales. Estas actividades se evalúan una vez que se completa el formulario o inmediatamente después de on_load si la escena no tiene uno (la evaluación solo se realiza una vez). Solo se activará el primer evento coincidente. |
slots[] |
Lista ordenada de ranuras. Cada ranura define el tipo de datos que resolverá y la configuración para personalizar la experiencia de esta resolución (p.ej., instrucciones). |
onSlotUpdated |
Se llama al controlador cuando se produce un cambio en el estado de un espacio que no se debe a actualizaciones dentro de otro controlador. De esta manera, se pueden invalidar los horarios disponibles, invalidar la escena o hacer otros cambios en el estado de la escena. |
IntentEvent
Registra los eventos que se activan como resultado de una coincidencia de intent.
Representación JSON | |
---|---|
{
"intent": string,
"transitionToScene": string,
"handler": {
object ( |
Campos | |
---|---|
intent |
Obligatorio. Es el intent que activa el evento. |
transitionToScene |
Opcional. Escena de destino a la que debe saltar la conversación. El estado de la escena actual se destruye durante la transición. |
handler |
Opcional. Controlador de eventos que se activa cuando coincide el intent Se debe ejecutar antes de hacer la transición a la escena de destino. Son útiles para generar instrucciones en respuesta a eventos. |
ConditionalEvent
Registra los eventos que se activan como resultado de una condición verdadera.
Representación JSON | |
---|---|
{
"condition": string,
"transitionToScene": string,
"handler": {
object ( |
Campos | |
---|---|
condition |
Obligatorio. Es la condición de filtro para que se active este evento. Si la condición se evalúa como verdadera, se activará la |
transitionToScene |
Opcional. Escena de destino a la que debe saltar la conversación cuando la condición asociada se evalúa como verdadera. El estado de la escena actual se destruye durante la transición. |
handler |
Opcional. Controlador de eventos que se activa cuando la condición asociada se evalúa como |
Ranura
Configuración de una ranura. Los espacios publicitarios son unidades de datos únicas que se pueden completar a través del lenguaje natural (es decir, parámetros de intents), parámetros de sesión y otras fuentes.
Representación JSON | |
---|---|
{ "name": string, "type": { object ( |
Campos | |
---|---|
name |
Obligatorio. Es el nombre de la ranura. |
type |
Obligatorio. Declara el tipo de datos de esta ranura. |
required |
Opcional. Indica si es necesario completar el espacio antes de avanzar. Los espacios obligatorios que no estén completados activarán un mensaje personalizable para el usuario. |
promptSettings |
Opcional. Registra los mensajes para diferentes etapas del llenado de ranuras. |
commitBehavior |
Opcional. Comportamiento de confirmación asociado con la ranura. |
config |
Opcional. Configuración adicional asociada con el espacio que se utiliza para llenar el espacio. El formato de la configuración es específico del tipo de ranura. Las referencias de recursos al parámetro de usuario o sesión se pueden agregar a esta configuración. Esta configuración es necesaria para completar ranuras relacionadas con las transacciones y la participación de los usuarios. Ejemplo: Para un espacio del tipo actions.type.CompletePurchaseValue, la siguiente configuración propone un pedido digital con una referencia a un parámetro de sesión { "@type": "type.googleapis.com/ google.actions.transactions.v3.CompletePurchaseValueSpec", "skuId": { "skuType": "SKU_TYPE_IN_APP", "id": "$session.params.userSelectedSkuId", "packageName": "com.example.company" }. |
defaultValue |
Opcional. Configuración para propagar un valor predeterminado para este espacio. |
PromptSettings
Un solo lugar donde se definen los mensajes de ranura.
Representación JSON | |
---|---|
{ "initialPrompt": { object ( |
Campos | |
---|---|
initialPrompt |
Solicita el valor del espacio. Ejemplo: "¿De qué tamaño querías?". |
noMatchPrompt1 |
Es el mensaje que se debe proporcionar cuando la entrada del usuario no coincide con el tipo de valor esperado para el espacio por primera vez. Ejemplo: "Lo siento, no entendí". |
noMatchPrompt2 |
Es el mensaje que se debe proporcionar cuando la entrada del usuario no coincide con el tipo de valor esperado para el espacio por segunda vez. Ejemplo: "Lo siento, no entendí". |
noMatchFinalPrompt |
Es el mensaje que se debe proporcionar cuando la entrada del usuario no coincide con el tipo de valor esperado para el espacio por última vez. Ejemplo: "Lo siento, no entendí". |
noInputPrompt1 |
Es la instrucción que se debe dar cuando el usuario no proporciona una entrada por primera vez. Ejemplo: "Lo siento, no entendí". |
noInputPrompt2 |
Es la instrucción que se debe dar cuando el usuario no proporciona una entrada por segunda vez. Ejemplo: "Lo siento, no entendí". |
noInputFinalPrompt |
Es la instrucción que se debe dar cuando el usuario no proporciona una entrada por última vez. Ejemplo: "Lo siento, no entendí". |
CommitBehavior
Mensaje que describe el comportamiento de confirmación asociado con el espacio publicitario después de que se completó correctamente.
Representación JSON | |
---|---|
{ "writeSessionParam": string } |
Campos | |
---|---|
writeSessionParam |
El parámetro de sesión para escribir el valor del espacio después de que se completa. Ten en cuenta que, por el momento, las rutas anidadas no son compatibles. “$$” se usa para escribir el valor del espacio en un parámetro de sesión con el mismo nombre que el espacio. P. ej.: writeSessionParam = "fruit" corresponde a "$session.params.fruit". writeSessionParam = "ticket" corresponde a "$session.params.ticket". |
DefaultValue
Configuración para propagar un valor predeterminado para este espacio.
Representación JSON | |
---|---|
{ "sessionParam": string, "constant": value } |
Campos | |
---|---|
sessionParam |
Opcional. El parámetro de sesión que se utiliza para inicializar el valor de ranura, si tiene un valor que no está vacío. El tipo del valor debe coincidir con el tipo de ranura. Ten en cuenta que, por el momento, las rutas anidadas no son compatibles. P. ej., |
constant |
Opcional. Valor predeterminado constante para la ranura. Solo se usará si no se propagó un valor para este espacio a través del |
DataFiles
Wrapper para archivo de datos repetido. Los campos repetidos no pueden existir en uno de ellos.
Representación JSON | |
---|---|
{
"dataFiles": [
{
object ( |
Campos | |
---|---|
dataFiles[] |
Varios archivos de datos. |
DataFile
Representa un archivo único que contiene datos no estructurados. Entre los ejemplos, se incluyen archivos de imagen, archivos de audio y código fuente de Cloud Function.
Representación JSON | |
---|---|
{ "filePath": string, "contentType": string, "payload": string } |
Campos | |
---|---|
filePath |
Es la ruta de acceso relativa del archivo de datos desde la raíz del proyecto en la estructura de archivos del SDK. Rutas de acceso a archivos permitidas: - Imágenes: |
contentType |
Obligatorio. El tipo de contenido de este activo. Ejemplo: |
payload |
Contenido del archivo de datos. Algunos ejemplos son los bytes sin procesar de imágenes, los archivos de audio o el formato ZIP de una Cloud Function. Hay un límite estricto de 10 MB para el tamaño de la carga útil. String codificada en base64. |