- StaticPromptCandidate
- Sélecteur
- SurfaceCapabilities
- StaticPromptResponse
- StaticSimplePrompt
- Variante
- StaticContentPrompt
- StaticCardPrompt
- StaticImagePrompt
- StaticLinkPrompt
- OpenUrl
- StaticTablePrompt
- TableColumn
- TableRow
- TableCell
- StaticMediaPrompt
- MediaObject
- MediaImage
- StaticListPrompt
- ListItem
- StaticCollectionPrompt
- CollectionItem
- Suggestion
- StaticCanvasPrompt
Représente une liste d'invites candidates, dont l'une sera sélectionnée comme requête à afficher dans la réponse à l'utilisateur. Ce message peut être localisé.
Représentation JSON | |
---|---|
{
"candidates": [
{
object ( |
Champs | |
---|---|
candidates[] |
Liste des invites candidates à envoyer au client. Chaque invite dispose d'un sélecteur permettant de déterminer quand elle peut être utilisée. 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 JSON | |
---|---|
{ "selector": { object ( |
Champs | |
---|---|
selector |
Facultatif. Critères permettant de déterminer si cette invite correspond à une requête. Si le sélecteur est vide, cette invite se déclenchera systématiquement. |
promptResponse |
Réponse de l'invite associée au sélecteur. |
Sélecteur
Définit les critères de correspondance entre une requête et une requête.
Représentation JSON | |
---|---|
{
"surfaceCapabilities": {
object ( |
Champs | |
---|---|
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 JSON | |
---|---|
{
"capabilities": [
enum ( |
Champs | |
---|---|
capabilities[] |
Obligatoire. Capacités de la surface à envoyer une requête à l'action. |
StaticPromptResponse
Représente des réponses structurées à envoyer à l'utilisateur, telles que du texte, des conversations, des cartes, des données de canevas, des chips de suggestion, etc.
Représentation JSON | |
---|---|
{ "firstSimple": { object ( |
Champs | |
---|---|
firstSimple |
Facultatif. Première réponse vocale et textuelle. |
content |
Facultatif. Contenus (par exemple, une carte, une liste ou un contenu multimédia) à présenter à l'utilisateur. |
lastSimple |
Facultatif. Dernière réponse vocale et textuelle. |
suggestions[] |
Facultatif. Suggestions à présenter à l'utilisateur, qui apparaîtront toujours à la fin de la réponse. Si le champ "append" de la requête associée est défini sur "true", les titres définis dans ce champ seront ajoutés à ceux définis dans les invites de suggestions précédemment définies, et les valeurs en double seront supprimées. |
link |
Facultatif. Un chip de suggestion supplémentaire qui peut rediriger vers l'application ou le site associés. Le chip s'affiche avec le titre "Ouvrir |
override |
Facultatif. Mode de fusion de ces messages avec les messages précédemment définis. "true" efface tous les messages définis précédemment (premier et dernier élément simple, contenu, lien et canevas de suggestions) et ajoute les messages définis dans cette invite. "false" ajoutera les messages définis dans cette requête à ceux définis dans les réponses précédentes. Définir ce champ sur "false" activera également l'ajout à certains champs dans les invites simples, les invites de suggestions et l'invite Canvas (qui fait partie de l'invite de contenu). Les messages de contenu et de lien seront toujours remplacés s'ils sont définis dans l'invite. La valeur par défaut est "false". |
canvas |
Réponse à utiliser pour l'expérience de canevas interactif. |
StaticSimplePrompt
Représente une invite simple à envoyer à un utilisateur.
Représentation JSON | |
---|---|
{
"variants": [
{
object ( |
Champs | |
---|---|
variants[] |
Liste des variantes possibles. |
Variant
Représente une variante faisant partie de l'invite simple.
Représentation JSON | |
---|---|
{ "speech": string, "text": string } |
Champs | |
---|---|
speech |
Facultatif. Représente la voix à énoncer. Il peut s'agir d'un balisage SSML ou d'une synthèse vocale. Si le champ "append" de la requête associée est défini sur "true", les paroles définies dans ce champ sont ajoutées aux paroles prononcées de la requête simple précédente. |
text |
Facultatif. Texte à afficher dans la bulle de chat. Si ce champ n'est pas spécifié, le rendu du champ de saisie vocale ci-dessus sera utilisé à l'écran. Limité à 640 caractères. Si le champ "append" de la requête associée est défini sur "true", le texte défini dans ce champ sera ajouté au texte de la requête simple précédente. |
StaticContentPrompt
Espace réservé pour la partie "Contenu" d'une requête statique.
Représentation JSON | |
---|---|
{ // Union field |
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 |
Une carte basique |
|
image |
Image. |
|
table |
Fiche tableau. |
|
media |
Réponse indiquant un ensemble de contenus multimédias à lire. |
|
list |
Fiche présentant une liste d'options à sélectionner. |
|
collection |
Fiche présentant une liste d'options à sélectionner. |
StaticCardPrompt
Fiche de base permettant d'afficher certaines informations, par exemple une image et/ou du texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Champs | |
---|---|
title |
Facultatif. Titre général de la fiche. |
subtitle |
Facultatif. Sous-titre de la carte. |
text |
Obligatoire. Corps du texte de la carte (obligatoire, sauf si une image est présente). Accepte un ensemble limité de syntaxes Markdown pour la mise en forme. |
image |
Facultatif. Une hero image pour la fiche. La hauteur est fixée à 192 dp. |
imageFill |
Facultatif. Façon dont l'arrière-plan de l'image sera rempli. |
button |
Facultatif. Bouton cliquable à afficher dans la fiche. |
StaticImagePrompt
Image affichée dans la fiche.
Représentation JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Champs | |
---|---|
url |
Obligatoire. URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (avec ou sans animation). Exemple : |
alt |
Obligatoire. Description textuelle de l'image à utiliser pour l'accessibilité, par exemple les lecteurs d'écran. |
height |
Facultatif. Hauteur de l'image en pixels. |
width |
Facultatif. Largeur de l'image en pixels. |
StaticLinkPrompt
Définit un lien qui s'affiche sous la forme d'un chip de suggestion et peut être ouvert par l'utilisateur.
Représentation JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Champs | |
---|---|
name |
Nom du lien |
open |
Définit le comportement lorsque l'utilisateur ouvre le lien. |
OpenUrl
Définit le comportement lorsque l'utilisateur ouvre le lien.
Représentation JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Champs | |
---|---|
url |
Champ d'URL, qui peut correspondre à: - URL http/https pour ouvrir une page Web ou une application associée à une application |
hint |
Indique une indication concernant le type d'URL. |
StaticTablePrompt
Fiche de tableau permettant d'afficher un tableau de texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Champs | |
---|---|
title |
Facultatif. Titre général du tableau. Doit être défini si sous-titre est défini. |
subtitle |
Facultatif. Sous-titre de la table. |
image |
Facultatif. Image associée au tableau. |
columns[] |
Facultatif. En-têtes et alignement des colonnes. |
rows[] |
Facultatif. Données de ligne de la table. L'affichage des trois premières lignes est garanti, mais d'autres peuvent être coupées sur certaines surfaces. Effectuez un test avec le simulateur afin d'identifier les lignes qui 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 |
Facultatif. Bouton. |
TableColumn
Décrit une colonne de la table.
Représentation JSON | |
---|---|
{
"header": string,
"align": enum ( |
Champs | |
---|---|
header |
Texte de l'en-tête de la colonne. |
align |
Alignement horizontal du contenu par rapport à la colonne. Si aucune valeur n'est spécifiée, le contenu sera aligné sur le bord avant. |
TableRow
Décrit une ligne de la table.
Représentation JSON | |
---|---|
{
"cells": [
{
object ( |
Champs | |
---|---|
cells[] |
Cellules sur cette ligne. L'affichage des trois premières cellules est garanti, mais d'autres peuvent être coupées sur certaines surfaces. Effectuez un test avec le simulateur pour identifier les cellules qui seront affichées pour une surface donnée. |
divider |
Indique si un séparateur doit être présent après chaque ligne. |
TableCell
Décrit une cellule dans une ligne.
Représentation JSON | |
---|---|
{ "text": string } |
Champs | |
---|---|
text |
Contenu textuel de la cellule. |
StaticMediaPrompt
Contient des informations sur le support, telles que le nom, la description, l'URL, etc. Identifiant suivant: 9
Représentation JSON | |
---|---|
{ "mediaType": enum ( |
Champs | |
---|---|
mediaType |
Type de contenu de cette réponse. |
startOffset |
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 " |
optionalMediaControls[] |
Types de commandes multimédias facultatifs compatibles avec cette session de réponse multimédia. Si cette règle est définie, la demande sera envoyée aux 3p lorsqu'un événement multimédia spécifique se produit. Si cette règle n'est pas configurée, 3p doit tout de même gérer deux types de contrôle par défaut : FINISHED (Terminé) et FAILED (ÉCHEC). |
mediaObjects[] |
Liste des objets multimédias. |
MediaObject
Représente un seul objet multimédia.
Représentation JSON | |
---|---|
{
"name": string,
"description": string,
"url": string,
"image": {
object ( |
Champs | |
---|---|
name |
Nom de cet objet multimédia. |
description |
Description de cet objet multimédia. |
url |
URL pointant vers le contenu multimédia. |
image |
Image à afficher avec la fiche multimédia. |
MediaImage
Image à afficher dans un MediaPrompt.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union image . Un seul type d'élément MediaImage est autorisé. image ne peut être qu'un des éléments suivants : |
||
large |
Une grande image, comme la couverture de l'album, etc. |
|
icon |
Une petite icône d'image affichée à droite du titre Elle est redimensionnée au format 36 x 36 dp. |
StaticListPrompt
Fiche présentant une liste d'options à sélectionner.
Représentation JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Champs | |
---|---|
title |
Facultatif. Titre de la liste. |
subtitle |
Facultatif. Sous-titre de la liste. |
items[] |
Obligatoire. Éléments de liste. |
ListItem
Un élément de la liste.
Représentation JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée à nouveau sous la forme d'un paramètre d'option de sélection. |
title |
Obligatoire. Titre de l'article. Lorsque l'utilisateur appuie dessus, ce texte est republié dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi l'ensemble d'éléments. |
description |
Facultatif. Corps du texte de l'élément. |
image |
Facultatif. Image de l'article. |
StaticCollectionPrompt
Fiche présentant un ensemble d'options à sélectionner.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Champs | |
---|---|
title |
Facultatif. Titre de la collection. |
subtitle |
Facultatif. Sous-titre de la collection. |
items[] |
Obligatoire. Éléments de collection. |
imageFill |
Facultatif. Type d'option d'affichage d'image. |
CollectionItem
Élément de la collection.
Représentation JSON | |
---|---|
{
"key": string,
"title": string,
"description": string,
"image": {
object ( |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de clé d'entrée dans le type associé. Lorsque l'utilisateur appuie sur l'élément, cette clé est publiée à nouveau sous la forme d'un paramètre d'option de sélection. |
title |
Obligatoire. Titre de l'article. Lorsque l'utilisateur appuie dessus, ce texte est republié dans la conversation, comme si l'utilisateur l'avait saisi. Chaque titre doit être unique parmi l'ensemble d'éléments. |
description |
Facultatif. Corps du texte de l'élément. |
image |
Facultatif. Image de l'article. |
Suggestion
Représente un chip de suggestion, un élément d'interface utilisateur présenté à l'utilisateur pour plus de commodité.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
Obligatoire. Texte affiché dans le chip de suggestion. Lorsque l'utilisateur appuie dessus, ce texte est republié 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. Vous pouvez l'utiliser avec le champ "firstSimple" de l'invite associée pour communiquer avec l'utilisateur en plus d'afficher une réponse de canevas interactive.
Représentation JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean } |
Champs | |
---|---|
url |
Obligatoire. URL de la vue Web à charger. |
data[] |
Facultatif. Données JSON à transmettre à la page Web de l'expérience immersive en tant qu'événement. Si le champ "remplacer" dans l'invite associée est défini sur "false", les valeurs de données définies dans cette invite Canvas seront ajoutées après les valeurs de données définies dans les invites Canvas précédentes. |
suppressMic |
Facultatif. Si la valeur est "true", le micro n'est pas activé pour capturer l'entrée après que cette réponse immersive a été présentée à l'utilisateur. |