EventHandler

candidates: 
  - object (StaticPromptCandidate)

object (StaticPromptCandidate)

Liste des invites candidates à envoyer au client. Chaque requête est associée à un sélecteur pour déterminer quand l'utiliser. Le premier sélecteur qui correspond à une requête est envoyé, et les autres sont ignorés.

selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)

object (Selector)

Facultatif. Critères pour déterminer si cette requête correspond à une requête. Si le sélecteur est vide, cette invite est toujours déclenchée.

object (StaticPromptResponse)

Réponse d'invite associée au sélecteur.

surfaceCapabilities: 
  object (SurfaceCapabilities)

object (SurfaceCapabilities)

Ensemble des fonctionnalités de surface requises.

capabilities: 
  - enum (Capability)

enum (Capability)

Obligatoire. Les capacités de la surface qui envoie une requête à l'action.

firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)

object (StaticSimplePrompt)

Facultatif. Première réponse vocale et texte uniquement.

object (StaticContentPrompt)

Facultatif. Contenu tel qu'une carte, une liste ou un contenu multimédia à présenter à l'utilisateur.

object (StaticSimplePrompt)

Facultatif. Dernière réponse vocale et textuelle.

object (Suggestion)

Facultatif. Suggestions à présenter à l'utilisateur et apparaîtront toujours à la fin de la réponse. Si le champ append de l'invite associée est défini sur true, les titres définis dans ce champ seront ajoutés aux titres définis dans les invites de suggestions précédemment définies et les valeurs en double seront supprimées.

object (StaticLinkPrompt)

Facultatif. Chip de suggestion supplémentaire pouvant rediriger les utilisateurs vers l'application ou le site associé. Le chip s'affichera avec le titre "Ouvrir ". Max. 20 caractères.

boolean

Facultatif. Mode de fusion des messages avec des messages définis précédemment. true effacera tous les messages précédemment définis (premier et dernier message simple, contenu, lien de suggestions et canevas) et ajoutera les messages définis dans cette invite. false ajoutera les messages définis dans cette requête aux messages définis dans les réponses précédentes. Si vous définissez ce champ sur false, vous pourrez également ajouter certains champs dans les invites simples, les invites Suggestions et l'invite Canvas (qui fait partie de l'invite Contenu). Les messages Content et Link seront toujours écrasés s'ils sont définis dans l'invite. La valeur par défaut est false.

object (StaticCanvasPrompt)

Réponse à utiliser pour l'expérience interactive sur le canevas.

variants: 
  - object (Variant)

object (Variant)

Liste des variantes possibles.

speech: string
text: string

string

Facultatif. Représente le discours à prononcer à l'utilisateur. Il peut s'agir de messages SSML ou de synthèse vocale. Par défaut, les paroles sont ajoutées à celles de la requête Simple précédente. Si le champ override de la requête associée est true, la voix définie dans ce champ remplace celle de la requête Simple précédente.

string

Facultatif. Texte à afficher dans la bulle de chat. S'il n'est pas fourni, un rendu par affichage du champ vocal ci-dessus sera utilisé. Limité à 640 caractères. Par défaut, le texte est ajouté au texte de la requête Simple précédente. Si le champ override de la requête associée est true, le texte défini dans ce champ remplace le texte de la requête Simple précédente.

# 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)
collectionBrowse: 
  object (StaticCollectionBrowsePrompt)
# End of list of possible types for union field content.

object (StaticCardPrompt)

Une carte basique.

object (StaticImagePrompt)

Image.

object (StaticTablePrompt)

Fiche du tableau.

object (StaticMediaPrompt)

Réponse indiquant un ensemble de contenus multimédias à lire.

object (StaticListPrompt)

Fiche présentant une liste d'options disponibles.

object (StaticCollectionPrompt)

Fiche présentant une liste d'options disponibles.

object (StaticCollectionBrowsePrompt)

Fiche présentant un ensemble de pages Web à ouvrir.

title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)

string

Facultatif. Titre général de la fiche.

string

Facultatif. Sous-titre de la fiche.

string

Obligatoire. Corps du texte de la carte, qui est nécessaire à moins qu'une image ne soit présente. Accepte un ensemble limité de syntaxes Markdown pour la mise en forme.

object (StaticImagePrompt)

Facultatif. Une image héros pour la carte. La hauteur est fixe à 192 dp.

enum (ImageFill)

Facultatif. Mode de remplissage de l'arrière-plan de l'image.

object (StaticLinkPrompt)

Facultatif. Bouton cliquable à afficher dans la fiche.

url: string
alt: string
height: integer
width: integer

string

Obligatoire. URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (animé ou non). Exemple : https://www.agentx.com/logo.png.

string

Obligatoire. Description textuelle de l'image à utiliser pour l'accessibilité, par exemple avec des lecteurs d'écran.

integer

Facultatif. Hauteur de l'image en pixels.

integer

Facultatif. Largeur de l'image en pixels.

name: string
open: 
  object (OpenUrl)

string

Nom du lien

object (OpenUrl)

Définit le comportement lorsque l'utilisateur ouvre le lien.

url: string
hint: enum (UrlHint)

string

Champ d'URL qui peut contenir l'un des éléments suivants: - URL http/https permettant d'ouvrir une application associée à une application ou une page Web

enum (UrlHint)

Indique une indication pour le type d'URL.

title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)

string

Facultatif. Titre général de la table. Doit être défini si sous-titre est défini.

string

Facultatif. Sous-titre du tableau.

object (StaticImagePrompt)

Facultatif. Image associée au tableau.

object (TableColumn)

Facultatif. En-têtes et alignement des colonnes.

object (TableRow)

Facultatif. Données de ligne de la table. L'affichage des trois premières lignes est garanti, mais d'autres peuvent être coupés sur certaines surfaces. Effectuez un test avec le simulateur pour voir quelles lignes seront affichées pour une surface donnée. Sur les surfaces compatibles avec la fonctionnalité WEB_BROWSER, vous pouvez rediriger l'utilisateur vers une page Web contenant plus de données.

object (StaticLinkPrompt)

Facultatif. Bouton.

header: string
align: enum (HorizontalAlignment)

string

Texte de l'en-tête de la colonne.

enum (HorizontalAlignment)

Alignement horizontal de la colonne de pondération du contenu. S'il n'est pas spécifié, le contenu sera aligné sur le bord initial.

cells: 
  - object (TableCell)
divider: boolean

object (TableCell)

Cellules de cette ligne. L'affichage des trois premières cellules est garanti, mais d'autres peuvent être coupés sur certaines surfaces. Effectuez un test avec le simulateur pour voir quelles cellules seront affichées pour une surface donnée.

boolean

Indique s'il doit y avoir un séparateur après chaque ligne.

text: string

string

Contenu textuel de la cellule.

mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)

enum (MediaType)

Type de support de cette réponse.

string (Duration format)

Décalage de début du premier objet multimédia.

Durée en secondes avec neuf chiffres au maximum après la virgule. Se termine par "s". Example : "3.5s".

enum (OptionalMediaControls)

Types de commandes multimédias facultatives compatibles avec cette session de réponse multimédia. Si cette règle est définie, la requête est envoyée à 3p lorsqu'un événement multimédia donné se produit. Si cette règle n'est pas configurée, 3p doit tout de même gérer deux types de commandes par défaut : FINISHED et FAILED.

object (MediaObject)

Liste des objets multimédias.

enum (RepeatMode)

Mode de répétition pour la liste des objets Media.

name: string
description: string
url: string
image: 
  object (MediaImage)

string

Nom de cet objet multimédia.

string

Description de cet objet multimédia.

string

URL pointant vers le contenu multimédia.

object (MediaImage)

Image à afficher avec la fiche multimédia.

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

object (StaticImagePrompt)

Une grande image, comme la couverture de l'album, etc.

object (StaticImagePrompt)

Une petite icône d'image s'affiche à droite du titre. Elle est redimensionnée à 36 x 36 dp.

title: string
subtitle: string
items: 
  - object (ListItem)

string

Facultatif. Titre de la liste.

string

Facultatif. Sous-titre de la liste.

object (ListItem)

Obligatoire. Éléments de liste.

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

Obligatoire. Clé NLU correspondant au nom de la clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée en tant que paramètre d'option de sélection.

string

Obligatoire. Titre de l'article. Lorsque l'utilisateur appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi l'ensemble d'éléments.

string

Facultatif. Corps du texte de l'élément.

object (StaticImagePrompt)

Facultatif. Image de l'article.

title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)

string

Facultatif. Titre de la collection.

string

Facultatif. Sous-titre de la collection.

object (CollectionItem)

Obligatoire. Éléments de la collection.

enum (ImageFill)

Facultatif. Type d'option d'affichage de l'image.

key: string
title: string
description: string
image: 
  object (StaticImagePrompt)

string

Obligatoire. Clé NLU correspondant au nom de la clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée en tant que paramètre d'option de sélection.

string

Obligatoire. Titre de l'article. Lorsque l'utilisateur appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi l'ensemble d'éléments.

string

Facultatif. Corps du texte de l'élément.

object (StaticImagePrompt)

Facultatif. Image de l'article.

items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)

object (CollectionBrowseItem)

Éléments de la collection "Parcourir". La taille de la liste doit être comprise dans la plage [2, 10].

enum (ImageFill)

Option d'affichage des images de la collection.

title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)

string

Obligatoire. Titre de l'élément de la collection.

string

Description de l'élément de la collection.

string

Texte de pied de page de l'élément de la collection, affiché sous la description. Une seule ligne de texte, tronquée par des points de suspension.

object (StaticImagePrompt)

Image de l'élément de collection.

object (OpenUrl)

Obligatoire. URI à ouvrir si l'élément est sélectionné.

title: string

string

Obligatoire. Texte affiché dans le chip de suggestion. Lorsque l'utilisateur appuiera sur ce texte, il sera publié tel quel dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi les chips de suggestion. 25 caractères max.

url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean

string

Obligatoire. URL de la vue Web à charger.

value (Value format)

Facultatif. Données JSON à transmettre à la page Web de l'expérience immersive en tant qu'événement. Si le champ override de la requête associée est défini sur false, les valeurs de données définies dans cette requête Canvas seront ajoutées après les valeurs de données définies dans les requêtes Canvas précédentes.

boolean

Facultatif. La valeur "true" signifie que le micro ne sera pas activé pour la capture d'entrée une fois que cette réponse immersive aura été présentée à l'utilisateur.

boolean

Facultatif. Si la valeur est true, les métadonnées liées aux conversations sont incluses et renvoyées à l'application de canevas.

boolean

Facultatif. Si la valeur est true, l'application de canevas occupe la totalité de l'écran et ne comporte pas d'en-tête en haut. Un toast s'affiche également sur l'écran de chargement. Il inclut le nom à afficher de l'action, le nom du développeur, ainsi que des instructions pour quitter l'action. Valeur par défaut : false.

boolean

Facultatif. Si la valeur est "true", les tapotements sur l'écran n'arrêtent pas la synthèse vocale pendant toute la session de canevas. Valeur par défaut : "false".