EventHandler

Définit un gestionnaire à exécuter après un événement. Les événements basés sur des intents et des conditions dans une scène sont des exemples d'événements.

Représentation YAML 
webhookHandler: string

# Union field prompt can be only one of the following:
staticPrompt: 
  object (StaticPrompt)
staticPromptName: string
# End of list of possible types for union field prompt.
Champs
webhookHandler

string

Nom du gestionnaire de webhooks à appeler.
Champ d'union prompt. Les requêtes peuvent être intégrées ou référencées par leur nom. prompt ne peut être qu'un des éléments suivants :
staticPrompt

object (StaticPrompt)

Requête statique intégrée. Peut contenir des références à des ressources de chaîne dans les bundles.
staticPromptName

string

Nom de la requête statique à appeler.

StaticPrompt

Représente une liste de propositions d'invites, dont l'une sera sélectionnée en tant qu'invite à afficher dans la réponse à l'utilisateur. Ce message peut être localisé.

Représentation YAML 
candidates: 
  - object (StaticPromptCandidate)
Champs
candidates[]

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.

StaticPromptCandidate

Représente une requête statique candidate.

Représentation YAML 
selector: 
  object (Selector)
promptResponse: 
  object (StaticPromptResponse)
Champs
selector

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

object (StaticPromptResponse)

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

Sélecteur

Définit les critères pour déterminer si une requête correspond à une requête.

Représentation YAML 
surfaceCapabilities: 
  object (SurfaceCapabilities)
Champs
surfaceCapabilities

object (SurfaceCapabilities)

Ensemble des fonctionnalités de surface requises.

SurfaceCapabilities

Représente la surface utilisée par l'utilisateur pour envoyer une requête à l'action.

Représentation YAML 
capabilities: 
  - enum (Capability)
Champs
capabilities[]

enum (Capability)

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

StaticPromptResponse

Représente les réponses structurées à envoyer à l'utilisateur, telles que du texte, des conversations, des fiches, des données de canevas, des chips de suggestion, etc.

Représentation YAML 
firstSimple: 
  object (StaticSimplePrompt)
content: 
  object (StaticContentPrompt)
lastSimple: 
  object (StaticSimplePrompt)
suggestions: 
  - object (Suggestion)
link: 
  object (StaticLinkPrompt)
override: boolean
canvas: 
  object (StaticCanvasPrompt)
Champs
firstSimple

object (StaticSimplePrompt)

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

object (StaticContentPrompt)

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

object (StaticSimplePrompt)

Facultatif. Dernière réponse vocale et textuelle.
suggestions[]

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

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

object (StaticCanvasPrompt)

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

StaticSimplePrompt

Représente une requête simple à envoyer à un utilisateur.

Représentation YAML 
variants: 
  - object (Variant)
Champs
variants[]

object (Variant)

Liste des variantes possibles.

Variant

Représente une variante qui fait partie de la requête simple.

Représentation YAML 
speech: string
text: string
Champs
speech

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

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.

StaticContentPrompt

Espace réservé pour la partie "Contenu" d'une requête statique.

Représentation YAML 
# 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.
Champs
Champ d'union content. Une requête ne peut contenir qu'un seul type de contenu. content ne peut être qu'un des éléments suivants :
card

object (StaticCardPrompt)

Une carte basique.
image

object (StaticImagePrompt)

Image.
table

object (StaticTablePrompt)

Fiche du tableau.
media

object (StaticMediaPrompt)

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

object (StaticListPrompt)

Fiche présentant une liste d'options disponibles.
collection

object (StaticCollectionPrompt)

Fiche présentant une liste d'options disponibles.
collectionBrowse

object (StaticCollectionBrowsePrompt)

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

StaticCardPrompt

Une carte basique permettant d'afficher certaines informations (par exemple, une image et/ou un texte.

Représentation YAML 
title: string
subtitle: string
text: string
image: 
  object (StaticImagePrompt)
imageFill: enum (ImageFill)
button: 
  object (StaticLinkPrompt)
Champs
title

string

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

string

Facultatif. Sous-titre de la fiche.
text

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

object (StaticImagePrompt)

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

enum (ImageFill)

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

object (StaticLinkPrompt)

Facultatif. Bouton cliquable à afficher dans la fiche.

StaticImagePrompt

Une image affichée dans la carte.

Représentation YAML 
url: string
alt: string
height: integer
width: integer
Champs
url

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

string

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

integer

Facultatif. Hauteur de l'image en pixels.
width

integer

Facultatif. Largeur de l'image en pixels.

StaticLinkPrompt

Définit un lien qui s'affichera sous forme de chip de suggestion et peut être ouvert par l'utilisateur.

Représentation YAML 
name: string
open: 
  object (OpenUrl)
Champs
name

string

Nom du lien
open

object (OpenUrl)

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

OpenUrl

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

Représentation YAML 
url: string
hint: enum (UrlHint)
Champs
url

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
hint

enum (UrlHint)

Indique une indication pour le type d'URL.

StaticTablePrompt

Fiche du tableau permettant d'afficher un tableau de texte.

Représentation YAML 
title: string
subtitle: string
image: 
  object (StaticImagePrompt)
columns: 
  - object (TableColumn)
rows: 
  - object (TableRow)
button: 
  object (StaticLinkPrompt)
Champs
title

string

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

string

Facultatif. Sous-titre du tableau.
image

object (StaticImagePrompt)

Facultatif. Image associée au tableau.
columns[]

object (TableColumn)

Facultatif. En-têtes et alignement des colonnes.
rows[]

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

object (StaticLinkPrompt)

Facultatif. Bouton.

TableColumn

Décrit une colonne de la table.

Représentation YAML 
header: string
align: enum (HorizontalAlignment)
Champs
header

string

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

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.

Ligne de tableau

Décrit une ligne du tableau.

Représentation YAML 
cells: 
  - object (TableCell)
divider: boolean
Champs
cells[]

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

boolean

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

TableCell

Décrit une cellule dans une ligne.

Représentation YAML 
text: string
Champs
text

string

Contenu textuel de la cellule.

StaticMediaPrompt

Contient des informations sur le contenu multimédia, telles que le nom, la description, l'URL, etc. Identifiant suivant: 11

Représentation YAML 
mediaType: enum (MediaType)
startOffset: string
optionalMediaControls: 
  - enum (OptionalMediaControls)
mediaObjects: 
  - object (MediaObject)
repeatMode: enum (RepeatMode)
Champs
mediaType

enum (MediaType)

Type de support de cette réponse.
startOffset

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".
optionalMediaControls[]

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.
mediaObjects[]

object (MediaObject)

Liste des objets multimédias.
repeatMode

enum (RepeatMode)

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

MediaObject

Représente un objet multimédia unique.

Représentation YAML 
name: string
description: string
url: string
image: 
  object (MediaImage)
Champs
name

string

Nom de cet objet multimédia.
description

string

Description de cet objet multimédia.
url

string

URL pointant vers le contenu multimédia.
image

object (MediaImage)

Image à afficher avec la fiche multimédia.

MediaImage

Image à afficher dans une MediaPrompt.

Représentation YAML 
# 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.
Champs
Champ d'union image. Un seul type est autorisé pour MediaImage. image ne peut être qu'un des éléments suivants :
large

object (StaticImagePrompt)

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

object (StaticImagePrompt)

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

StaticListPrompt

Fiche présentant une liste d'options disponibles.

Représentation YAML 
title: string
subtitle: string
items: 
  - object (ListItem)
Champs
title

string

Facultatif. Titre de la liste.
subtitle

string

Facultatif. Sous-titre de la liste.
items[]

object (ListItem)

Obligatoire. Éléments de liste.

ListItem

Élément dans la liste.

Représentation YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Champs
key

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

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

string

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

object (StaticImagePrompt)

Facultatif. Image de l'article.

StaticCollectionPrompt

Fiche présentant un ensemble d'options disponibles.

Représentation YAML 
title: string
subtitle: string
items: 
  - object (CollectionItem)
imageFill: enum (ImageFill)
Champs
title

string

Facultatif. Titre de la collection.
subtitle

string

Facultatif. Sous-titre de la collection.
items[]

object (CollectionItem)

Obligatoire. Éléments de la collection.
imageFill

enum (ImageFill)

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

CollectionItem

Un élément de la collection.

Représentation YAML 
key: string
title: string
description: string
image: 
  object (StaticImagePrompt)
Champs
key

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

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

string

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

object (StaticImagePrompt)

Facultatif. Image de l'article.

StaticCollectionBrowsePrompt

Présente un ensemble de documents Web sous la forme d'une collection d'éléments de grande taille. Les éléments peuvent être sélectionnés pour lancer le document Web associé dans un lecteur Web.

Représentation YAML 
items: 
  - object (CollectionBrowseItem)
imageFill: enum (ImageFill)
Champs
items[]

object (CollectionBrowseItem)

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

enum (ImageFill)

Option d'affichage des images de la collection.

CollectionBrowseItem

Élément de la collection.

Représentation YAML 
title: string
description: string
footer: string
image: 
  object (StaticImagePrompt)
openUriAction: 
  object (OpenUrl)
Champs
title

string

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

string

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

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

object (StaticImagePrompt)

Image de l'élément de collection.
openUriAction

object (OpenUrl)

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

Suggestion

Représente un chip de suggestion, un élément d'interface utilisateur présenté à l'utilisateur pour plus de commodité.

Représentation YAML 
title: string
Champs
title

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.

StaticCanvasPrompt

Représente une réponse Interactive Canvas à envoyer à l'utilisateur. Cette option peut être utilisée en conjonction avec le champ firstSimple dans l'invite associée pour parler à l'utilisateur en plus d'afficher une réponse interactive du canevas.

Représentation YAML 
url: string
data: 
  - value
suppressMic: boolean
sendStateDataToCanvasApp: boolean
enableFullScreen: boolean
continueTtsDuringTouch: boolean
Champs
url

string

Obligatoire. URL de la vue Web à charger.
data[]

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

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

boolean

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

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

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