StaticPrompt

{
  "candidates": [
    {
      object (StaticPromptCandidate)
    }
  ]
}

object (StaticPromptCandidate)

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.

{
  "selector": {
    object (Selector)
  },
  "promptResponse": {
    object (StaticPromptResponse)
  }
}

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

object (StaticPromptResponse)

Réponse de l'invite associée au sélecteur.

{
  "surfaceCapabilities": {
    object (SurfaceCapabilities)
  }
}

object (SurfaceCapabilities)

Ensemble des fonctionnalités de surface requises.

{
  "capabilities": [
    enum (Capability)
  ]
}

enum (Capability)

Obligatoire. Capacités de la surface à envoyer 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 textuelle.

object (StaticContentPrompt)

Facultatif. Contenus (par exemple, 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, 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.

object (StaticLinkPrompt)

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 " (20 caractères au maximum).

boolean

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

object (StaticCanvasPrompt)

Réponse à utiliser pour l'expérience de canevas interactif.

{
  "variants": [
    {
      object (Variant)
    }
  ]
}

object (Variant)

Liste des variantes possibles.

{
  "speech": string,
  "text": string
}

string

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.

string

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.

{

  // Union field content can be only one of the following:
  "card": {
    object (StaticCardPrompt)
  },
  "image": {
    object (StaticImagePrompt)
  },
  "table": {
    object (StaticTablePrompt)
  },
  "media": {
    object (StaticMediaPrompt)
  },
  "list": {
    object (StaticListPrompt)
  },
  "collection": {
    object (StaticCollectionPrompt)
  }
  // End of list of possible types for union field content.
}

object (StaticCardPrompt)

Une carte basique

object (StaticImagePrompt)

Image.

object (StaticTablePrompt)

Fiche tableau.

object (StaticMediaPrompt)

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

object (StaticListPrompt)

Fiche présentant une liste d'options à sélectionner.

object (StaticCollectionPrompt)

Fiche présentant une liste d'options à sélectionner.

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

string

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.

object (StaticImagePrompt)

Facultatif. Une hero image pour la fiche. La hauteur est fixée à 192 dp.

enum (ImageFill)

Facultatif. Façon dont l'arrière-plan de l'image sera rempli.

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 (avec ou sans animation). Exemple : https://www.agentx.com/logo.png.

string

Obligatoire. Description textuelle de l'image à utiliser pour l'accessibilité, par exemple les 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 correspondre à: - URL http/https pour ouvrir une page Web ou une application associée à une application

enum (UrlHint)

Indique une indication concernant 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 du tableau. Doit être défini si sous-titre est défini.

string

Facultatif. Sous-titre de la table.

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

object (StaticLinkPrompt)

Facultatif. Bouton.

{
  "header": string,
  "align": enum (HorizontalAlignment)
}

string

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

enum (HorizontalAlignment)

Alignement horizontal du contenu par rapport à la colonne. Si aucune valeur n'est spécifiée, le contenu sera aligné sur le bord avant.

{
  "cells": [
    {
      object (TableCell)
    }
  ],
  "divider": boolean
}

object (TableCell)

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.

boolean

Indique si un séparateur doit être présent après chaque ligne.

{
  "text": string
}

string

Contenu textuel de la cellule.

{
  "mediaType": enum (MediaType),
  "startOffset": string,
  "optionalMediaControls": [
    enum (OptionalMediaControls)
  ],
  "mediaObjects": [
    {
      object (MediaObject)
    }
  ]
}

enum (MediaType)

Type de contenu 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 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).

object (MediaObject)

Liste des objets multimédias.

{
  "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 affichée à droite du titre Elle est redimensionnée au format 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 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.

string

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.

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

enum (ImageFill)

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

{
  "key": string,
  "title": string,
  "description": string,
  "image": {
    object (StaticImagePrompt)
  }
}

string

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.

string

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.

string

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

object (StaticImagePrompt)

Facultatif. Image de l'article.

{
  "title": string
}

string

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.

{
  "url": string,
  "data": [
    value
  ],
  "suppressMic": 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 "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.

boolean

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.