- Requête HTTP
- Paramètres de chemin d'accès
- Corps de la requête
- Corps de la réponse
- UserInput
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- InputType
- DeviceProperties (Propriétés de l'appareil)
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Surface
- Emplacement
- LatLng
- Résultat
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Dessin
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Requête
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Simple
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Contenu
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Carte
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Image
- ImageFill
- Lien
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- OpenUrl
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- UrlHint
- Table
- TableColumn
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- HorizontalAlignment
- TableRow
- TableCell
- Multimédia
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaType
- OptionalMediaControls
- MediaObject
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- MediaImage
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Collection
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- CollectionItem
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Liste
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ListItem
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Suggestion
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Diagnostic
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ExecutionEvent
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ExecutionState
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- Emplacements
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SlotFillingStatus
- Encoche
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SlotMode
- SlotStatus
- Status
- UserConversationInput
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- IntentMatch
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- ConditionsEvaluated
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- État
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- OnSceneEnter
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- WebhookRequest
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- WebhookResponse
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- WebhookInitiatedTransition
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SlotMatch
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SlotRequested
<ph type="x-smartling-placeholder">
- </ph>
- Représentation JSON
- SlotValidated
- FormFilled
- WaitingForUserInput
- EndConversation
Lit un tour de la conversation.
Requête HTTP
POST https://actions.googleapis.com/v2/{project=projects/*}:sendInteraction
L'URL utilise la syntaxe de transcodage gRPC.
Paramètres de chemin d'accès
Paramètres | |
---|---|
project |
Obligatoire. Le projet testé, indiqué par l'ID du projet. Format: projects/{project} |
Corps de la requête
Le corps de la requête contient des données présentant la structure suivante :
Représentation JSON | |
---|---|
{ "input": { object ( |
Champs | |
---|---|
input |
Obligatoire. Entrée fournie par l'utilisateur. |
deviceProperties |
Obligatoire. Propriétés de l'appareil utilisé pour interagir avec l'action. |
conversationToken |
Jeton opaque qui doit être transmis comme reçu de SendInteractionResponse lors de l'interaction précédente. Vous pouvez ne pas la définir afin de démarrer une nouvelle conversation, soit en tant que première interaction d'une session de test, soit pour abandonner une conversation précédente et en démarrer une nouvelle. |
Corps de la réponse
Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :
Réponse à une série de conversations
Représentation JSON | |
---|---|
{ "output": { object ( |
Champs | |
---|---|
output |
Résultat fourni à l'utilisateur. |
diagnostics |
Informations de diagnostic expliquant comment la requête a été traitée. |
conversationToken |
Jeton opaque à définir sur SendInteractionRequest lors du prochain appel RPC afin de poursuivre la même conversation. |
UserInput
Entrée utilisateur fournie lors d'une conversation.
Représentation JSON | |
---|---|
{
"query": string,
"type": enum ( |
Champs | |
---|---|
query |
Contenu de l'entrée envoyée par l'utilisateur. |
type |
Type de l'entrée. |
InputType
Indique la source d'entrée, la requête saisie ou la requête vocale.
Enums | |
---|---|
INPUT_TYPE_UNSPECIFIED |
Source d'entrée non spécifiée. |
TOUCH |
Requête à partir d'une interaction IUG. |
VOICE |
Requête vocale. |
KEYBOARD |
Requête saisie. |
URL |
L'action a été déclenchée par un lien URL. |
Propriétés de l'appareil
Propriétés de l'appareil pertinentes pour une conversation.
Représentation JSON | |
---|---|
{ "surface": enum ( |
Champs | |
---|---|
surface |
Surface utilisée pour interagir avec l'action. |
location |
Position de l'appareil (latitude, longitude, adresse formatée, etc.). |
locale |
Paramètres régionaux tels qu'ils sont définis sur l'appareil. Le format doit respecter la norme BCP 47: https://tools.ietf.org/html/bcp47 Exemples: en, en-US, es-419 (d'autres exemples sont disponibles sur https://tools.ietf.org/html/bcp47#appendix-A). |
timeZone |
Fuseau horaire défini sur l'appareil. Le format doit respecter celui de la base de données des fuseaux horaires de l'IANA, par exemple "America/New_York" : https://www.iana.org/time-zones |
Surface
Surfaces possibles utilisées pour interagir avec l'action. D'autres valeurs pourront être ajoutées ultérieurement.
Enums | |
---|---|
SURFACE_UNSPECIFIED |
Valeur par défaut. Cette valeur n'est pas utilisée. |
SPEAKER |
Enceinte (par exemple, Google Home) |
PHONE |
Téléphone. |
ALLO |
Allo Chat. |
SMART_DISPLAY |
Écran connecté. |
KAI_OS |
KaiOS |
Lieu
Conteneur qui représente un emplacement.
Représentation JSON | |
---|---|
{
"coordinates": {
object ( |
Champs | |
---|---|
coordinates |
Coordonnées géographiques Nécessite [DEVICE_PRECISE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
formattedAddress |
Adresse affichée (par exemple, "1600 Amphitheatre Pkwy, Mountain View, CA 94043", États-Unis Nécessite [DEVICE_PRECISE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION]. |
zipCode |
Code postal. Nécessite [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
city |
Ville. Nécessite [DEVICE_PRECISE_LOCATION] [google.actions.v2.Permission.DEVICE_PRECISE_LOCATION] ou [DEVICE_COARSE_LOCATION] Autorisation [google.actions.v2.Permission.DEVICE_COARSE_LOCATION]. |
LatLng
Objet représentant une paire latitude/longitude. Elle est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.
Représentation JSON | |
---|---|
{ "latitude": number, "longitude": number } |
Champs | |
---|---|
latitude |
Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0]. |
longitude |
Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0]. |
Sortie
Sortie visible par l'utilisateur dans la conversation.
Représentation JSON | |
---|---|
{ "text": string, "speech": [ string ], "canvas": { object ( |
Champs | |
---|---|
text |
Réponse vocale envoyée à l'utilisateur sous forme de chaîne brute. |
speech[] |
Contenu vocal produit par l'action. Cela peut inclure des éléments de balisage tels que SSML. |
canvas |
Contenu Interactive Canvas. |
actionsBuilderPrompt |
État de l'invite à la fin de la conversation. En savoir plus sur la requête: https://developers.google.com/assistant/conversational/prompts |
Canevas
Représente une réponse Interactive Canvas à envoyer à l'utilisateur. Elle peut être utilisée en conjonction avec la méthode "firstSimple" dans l'invite associée pour parler à l'utilisateur en plus d'afficher une réponse de canevas interactive. La taille maximale de la réponse est de 50 000 octets.
Représentation JSON | |
---|---|
{ "url": string, "data": [ value ], "suppressMic": boolean, "enableFullScreen": boolean } |
Champs | |
---|---|
url |
URL de l'application Web du canevas interactif à charger. Si cette règle n'est pas configurée, l'URL du canevas actif actuel sera réutilisée. |
data[] |
Facultatif. Données JSON à transmettre à la page Web de l'expérience immersive en tant qu'événement. Si la fonction de "remplacement" dans la requête associée est "false" les valeurs de données définies dans cette requête Canvas seront ajoutées après celles définies dans les requêtes Canvas précédentes. |
suppressMic |
Facultatif. Valeur par défaut : "false". |
enableFullScreen |
Si la valeur est |
Requête
Représente une réponse à un utilisateur.
Représentation JSON | |
---|---|
{ "append": boolean, "override": boolean, "firstSimple": { object ( |
Champs | |
---|---|
append |
Facultatif. Mode de fusion des messages avec des messages définis précédemment. "faux" efface tous les messages précédemment définis (premier et dernier message simple, contenu, lien de suggestions et canevas) et ajoute les messages définis dans cette invite. "vrai" ajoute les messages définis dans cette requête aux messages définis dans les réponses précédentes. Définir ce champ sur "true" activera également l'ajout à certains champs dans les invites simples, les invites "Suggestion" et "Canvas" (qui font 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". |
override |
Facultatif. Mode de fusion des messages avec des messages définis précédemment. "vrai" efface tous les messages précédemment définis (premier et dernier message simple, contenu, lien de suggestions et canevas) et ajoute les messages définis dans cette invite. "faux" ajoute les messages définis dans cette requête à ceux définis dans les réponses précédentes. Laisser ce champ sur "false" permet également d'ajouter des champs dans les invites simples, les invites Suggestions et les invites Canvas (une partie de l'invite Contenu). Les messages "Content" (Contenu) et "Link" (Lien) sont toujours écrasés s'ils sont définis dans l'invite. La valeur par défaut est "false". |
firstSimple |
Facultatif. Première réponse vocale et texte uniquement. |
content |
Facultatif. Contenu tel qu'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 et apparaîtront toujours à la fin de la réponse. Si la fonction de "remplacement" dans la requête associée est "false", 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. |
link |
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 |
canvas |
Facultatif. Représente une réponse Interactive Canvas à envoyer à l'utilisateur. |
Simple
Représente une requête simple à envoyer à un utilisateur.
Représentation JSON | |
---|---|
{ "speech": string, "text": string } |
Champs | |
---|---|
speech |
Facultatif. Représente le discours à prononcer à l'utilisateur. Il peut s'agir de messages SSML ou de synthèse vocale. Si la fonction de "remplacement" 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 |
Texte facultatif à 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. Si la fonction de "remplacement" de la requête associée est "true", le texte défini dans ce champ est remplacé par le texte de la requête Simple précédente. |
Contenu
Contenu à afficher.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union content . Contenu. content ne peut être qu'un des éléments suivants : |
||
card |
Une carte basique. |
|
image |
Image. |
|
table |
Fiche du tableau. |
|
media |
Réponse indiquant un ensemble de contenus multimédias à lire. |
|
canvas |
Réponse à utiliser pour l'expérience interactive sur le canevas. |
|
collection |
Fiche présentant un ensemble d'options disponibles. |
|
list |
Fiche présentant une liste d'options disponibles. |
Fiche
Une carte basique permettant d'afficher certaines informations (par exemple, une image et/ou un texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "text": string, "image": { object ( |
Champs | |
---|---|
title |
Titre général de la fiche. Facultatif. |
subtitle |
Facultatif. |
text |
Corps du texte de la carte. Accepte un ensemble limité de syntaxes Markdown pour la mise en forme. Obligatoire, sauf si une image est présente. |
image |
Une image héros pour la carte. La hauteur est fixe à 192 dp. Facultatif. |
imageFill |
Mode de remplissage de l'arrière-plan de l'image. Facultatif. |
button |
Bouton. Facultatif. |
Image
Une image affichée dans la carte.
Représentation JSON | |
---|---|
{ "url": string, "alt": string, "height": integer, "width": integer } |
Champs | |
---|---|
url |
URL source de l'image. Les images peuvent être au format JPG, PNG et GIF (animé ou non). Exemple : |
alt |
Description textuelle de l'image à utiliser pour l'accessibilité, par exemple avec des lecteurs d'écran. Obligatoire. |
height |
Hauteur de l'image en pixels. Facultatif. |
width |
Largeur de l'image en pixels. Facultatif. |
ImageFill
Options d'affichage possibles pour modifier la présentation de l'image. Utilisez cette option lorsque les proportions de l'image ne correspondent pas à celles du conteneur de l'image.
Enums | |
---|---|
UNSPECIFIED |
Remplissage de l'image non spécifié. |
GRAY |
Utilisez des barres grises pour combler les espaces entre l'image et le conteneur de l'image. |
WHITE |
Utilisez des barres blanches pour remplir les espaces entre l'image et le conteneur de l'image. |
CROPPED |
L'image est mise à l'échelle de sorte que sa largeur et sa hauteur correspondent ou dépassent les dimensions du conteneur. Cela peut recadrer le haut et le bas de l'image si la hauteur de l'image mise à l'échelle est supérieure à celle du conteneur, ou recadrer l'image à gauche et à droite si la largeur de l'image mise à l'échelle est supérieure à celle du conteneur. Semblable au mode Zoom sur un téléviseur grand écran lors de la lecture d'une vidéo 4:3. |
Lien
Associer le contenu.
Représentation JSON | |
---|---|
{
"name": string,
"open": {
object ( |
Champs | |
---|---|
name |
Nom du lien |
open |
Que se passe-t-il lorsqu'un utilisateur ouvre le lien ? |
OpenUrl
Action effectuée lorsqu'un utilisateur ouvre un lien.
Représentation JSON | |
---|---|
{
"url": string,
"hint": enum ( |
Champs | |
---|---|
url |
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 |
Indique une indication pour le type d'URL. |
UrlHint
Différents types d'indications d'URL.
Enums | |
---|---|
LINK_UNSPECIFIED |
Non spécifié |
AMP |
URL qui redirige directement vers un contenu AMP ou vers une URL canonique faisant référence à du contenu AMP via . |
Tableau
Fiche du tableau permettant d'afficher un tableau de texte.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "image": { object ( |
Champs | |
---|---|
title |
Titre général de la table. Facultatif, mais doit être défini si "Sous-titre" est défini. |
subtitle |
Sous-titre du tableau. Facultatif. |
image |
Image associée au tableau. Facultatif. |
columns[] |
En-têtes et alignement des colonnes. |
rows[] |
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 davantage de données. |
button |
Bouton. |
TableColumn
Décrit une colonne d'une table.
Représentation JSON | |
---|---|
{
"header": string,
"align": enum ( |
Champs | |
---|---|
header |
Texte de l'en-tête de la colonne. |
align |
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. |
HorizontalAlignment
Alignement du contenu dans la cellule.
Enums | |
---|---|
UNSPECIFIED |
Alignement horizontal non spécifié. |
LEADING |
Bord initial de la cellule. Il s'agit de la valeur par défaut. |
CENTER |
Le contenu est aligné au centre de la colonne. |
TRAILING |
Le contenu est aligné sur le bord final de la colonne. |
Ligne de tableau
Décrit une ligne du tableau.
Représentation JSON | |
---|---|
{
"cells": [
{
object ( |
Champs | |
---|---|
cells[] |
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 |
Indique s'il doit y avoir un séparateur après chaque ligne. |
TableCell
Décrit une cellule dans une ligne.
Représentation JSON | |
---|---|
{ "text": string } |
Champs | |
---|---|
text |
Contenu textuel de la cellule. |
Multimédia
Représente un objet multimédia. Contient des informations sur le contenu multimédia, telles que le nom, la description, l'URL, etc.
Représentation JSON | |
---|---|
{ "mediaType": enum ( |
Champs | |
---|---|
mediaType |
Type de support. |
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 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[] |
Liste des objets Media |
MediaType
Type de support de cette réponse.
Enums | |
---|---|
MEDIA_TYPE_UNSPECIFIED |
Type de support non spécifié. |
AUDIO |
Fichier audio. |
MEDIA_STATUS_ACK |
Réponse pour accuser réception d'un rapport d'état du contenu multimédia. |
OptionalMediaControls
Types de commandes multimédias facultatifs compatibles avec la réponse multimédia
Enums | |
---|---|
OPTIONAL_MEDIA_CONTROLS_UNSPECIFIED |
Valeur non spécifiée |
PAUSED |
Événement mis en veille. Déclenchement lorsque l'utilisateur met le contenu multimédia en pause. |
STOPPED |
Événement arrêté. Déclenchement lorsque l'utilisateur quitte la session 3p pendant la lecture d'un contenu multimédia. |
MediaObject
Représente un objet multimédia unique.
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 avec la fiche multimédia.
Représentation JSON | |
---|---|
{ // Union field |
Champs | ||
---|---|---|
Champ d'union image . Image. 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 s'affiche à droite du titre. Elle est redimensionnée à 36 x 36 dp. |
Collection
Fiche présentant un ensemble d'options disponibles.
Représentation JSON | |
---|---|
{ "title": string, "subtitle": string, "items": [ { object ( |
Champs | |
---|---|
title |
Titre de la collection. Facultatif. |
subtitle |
Sous-titre de la collection. Facultatif. |
items[] |
min: 2 max: 10 |
imageFill |
Manière dont l'arrière-plan des images des éléments de la collection sera rempli. Facultatif. |
CollectionItem
Un élément de la collection
Représentation JSON | |
---|---|
{ "key": string } |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de la clé d'entrée dans le type associé. |
Liste
Fiche présentant une liste d'options disponibles.
Représentation JSON | |
---|---|
{
"title": string,
"subtitle": string,
"items": [
{
object ( |
Champs | |
---|---|
title |
Titre de la liste. Facultatif. |
subtitle |
Sous-titre de la liste. Facultatif. |
items[] |
min: 2 max: 30 |
ListItem
Un élément de la liste
Représentation JSON | |
---|---|
{ "key": string } |
Champs | |
---|---|
key |
Obligatoire. Clé NLU correspondant au nom de la clé d'entrée dans le type associé. |
Suggestion
Suggestion de saisie à présenter à l'utilisateur.
Représentation JSON | |
---|---|
{ "title": string } |
Champs | |
---|---|
title |
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. |
Diagnostic
Informations de diagnostic liées à l'échange.
Représentation JSON | |
---|---|
{
"actionsBuilderEvents": [
{
object ( |
Champs | |
---|---|
actionsBuilderEvents[] |
Liste des événements avec des détails sur le traitement de la conversation à travers les étapes du modèle d'interaction Actions Builder. Renseigné pour Actions Builder et Applications SDK Actions uniquement. |
ExecutionEvent
Contient des informations sur l'événement d'exécution qui s'est produit lors du traitement de la requête de conversation Actions Builder. Pour obtenir un aperçu des étapes d'une demande de conversation, consultez la page https://developers.google.com/assistant/conversational/actions.
Représentation JSON | |
---|---|
{ "eventTime": string, "executionState": { object ( |
Champs | ||
---|---|---|
eventTime |
Code temporel du moment où l'événement s'est produit Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : |
|
executionState |
État de l'exécution au cours de cet événement. |
|
status |
État obtenu pour une étape d'exécution particulière. |
|
warningMessages[] |
Liste des avertissements générés lors de l'exécution de cet événement. Les avertissements sont des conseils destinés au développeur découvert lors de la demande de conversation. Ils ne sont généralement pas critiques et n'interrompent pas l'exécution de la requête. Par exemple, un avertissement peut être généré lorsque le webhook tente de remplacer un type personnalisé qui n'existe pas. Les erreurs sont signalées sous la forme d'un code d'état "Échec", mais des avertissements peuvent s'afficher même si l'état est correct. |
|
Champ d'union EventData . Informations détaillées spécifiques aux différents événements pouvant être impliqués dans le traitement d'une conversation. Le champ défini ici définit le type d'événement. EventData ne peut être qu'un des éléments suivants : |
||
userInput |
Événement de traitement des entrées utilisateur. |
|
intentMatch |
Événement de mise en correspondance d'intent. |
|
conditionsEvaluated |
Événement d'évaluation de l'état. |
|
onSceneEnter |
Événement d'exécution OnSceneEnter. |
|
webhookRequest |
Événement d'envoi de requête de webhook. |
|
webhookResponse |
Événement de confirmation de réponse du webhook. |
|
webhookInitiatedTransition |
Événement de transition initié par le webhook. |
|
slotMatch |
Événement de correspondance d'emplacement. |
|
slotRequested |
Événement de demande d'emplacement. |
|
slotValidated |
Événement de validation d'emplacement. |
|
formFilled |
Événement de remplissage de formulaire. |
|
waitingUserInput |
En attente de l'événement d'entrée utilisateur. |
|
endConversation |
Événement de fin de conversation. |
ExecutionState
État actuel de l'exécution.
Représentation JSON | |
---|---|
{ "currentSceneId": string, "sessionStorage": { object }, "slots": { object ( |
Champs | |
---|---|
currentSceneId |
ID de la scène actuellement active. |
sessionStorage |
État du stockage de session: https://developers.google.com/assistant/conversational/storage-session |
slots |
État du remplissage d'emplacements, le cas échéant: https://developers.google.com/assistant/conversational/scenes#slot_filling |
promptQueue[] |
File d'attente d'invites: https://developers.google.com/assistant/conversational/prompts |
userStorage |
État de l'espace de stockage utilisateur: https://developers.google.com/assistant/conversational/storage-user |
householdStorage |
État de l'espace de stockage de la maison: https://developers.google.com/assistant/conversational/storage-home |
Emplacements
Représente l'état actuel des emplacements d'une scène.
Représentation JSON | |
---|---|
{ "status": enum ( |
Champs | |
---|---|
status |
État actuel du remplissage de cases. |
slots |
Emplacements associés à la scène actuelle. Objet contenant une liste de paires |
SlotFillingStatus
Représente l'état actuel du remplissage d'emplacements.
Enums | |
---|---|
UNSPECIFIED |
Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné. |
INITIALIZED |
Les emplacements ont été initialisés, mais le remplissage d'emplacements n'a pas commencé. |
COLLECTING |
Les valeurs des emplacements sont en cours de collecte. |
FINAL |
Toutes les valeurs des espaces publicitaires sont définitives et ne peuvent pas être modifiées. |
Encoche
Représente un espace publicitaire.
Représentation JSON | |
---|---|
{ "mode": enum ( |
Champs | |
---|---|
mode |
Mode de l'emplacement (obligatoire ou facultatif). Peut être défini par le développeur. |
status |
État du créneau. |
value |
Valeur de l'emplacement. La modification de cette valeur dans la réponse modifiera la valeur du remplissage de cases. |
updated |
Indique si la valeur de l'emplacement a été collectée lors du dernier tour. Ce champ est en lecture seule. |
prompt |
Facultatif. Cette invite est envoyée à l'utilisateur lorsqu'il doit remplir un emplacement obligatoire. Cette requête remplace l'invite existante définie dans la console. Ce champ n'est pas inclus dans la requête webhook. |
SlotMode
Représente le mode d'un emplacement, s'il est requis ou non.
Enums | |
---|---|
MODE_UNSPECIFIED |
Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné. |
OPTIONAL |
Indique que l'emplacement n'est pas nécessaire pour terminer le remplissage d'emplacements. |
REQUIRED |
Indique que l'emplacement est requis pour terminer le remplissage d'emplacements. |
SlotStatus
Représente l'état d'un espace publicitaire.
Enums | |
---|---|
SLOT_UNSPECIFIED |
Valeur de remplacement lorsque le champ d'utilisation n'est pas renseigné. |
EMPTY |
Indique que l'emplacement ne comporte aucune valeur. Cet état ne peut pas être modifié via la réponse. |
INVALID |
Indique que la valeur de l'emplacement n'est pas valide. Cet état peut être défini via la réponse. |
FILLED |
Indique que l'emplacement a une valeur. Cet état ne peut pas être modifié via la réponse. |
État
Le type Status
définit un modèle d'erreur logique adapté aux différents environnements de programmation, y compris les API REST et RPC. Il est utilisé par le protocole gRPC. Chaque message Status
contient trois éléments de données : un code d'erreur, un message d'erreur et les détails de l'erreur.
Pour en savoir plus sur ce modèle d'erreur et sur son utilisation, consultez le Guide de conception d'API.
Représentation JSON | |
---|---|
{ "code": integer, "message": string, "details": [ { "@type": string, field1: ..., ... } ] } |
Champs | |
---|---|
code |
Code d'état, qui doit être une valeur d'énumération de |
message |
Message d'erreur destiné au développeur, qui doit être en anglais. Tout message d'erreur destiné aux utilisateurs doit être localisé et envoyé dans le champ |
details[] |
Liste de messages comportant les détails de l'erreur. Il existe un ensemble commun de types de message utilisable par les API. Objet contenant des champs d'un type arbitraire. Un champ supplémentaire |
UserConversationInput
Informations liées aux entrées utilisateur.
Représentation JSON | |
---|---|
{ "type": string, "originalQuery": string } |
Champs | |
---|---|
type |
Type d'entrée utilisateur. Exemple : le clavier, les commandes vocales, les commandes tactiles, etc. |
originalQuery |
Entrée de texte originale de l'utilisateur. |
IntentMatch
Informations sur la correspondance d'intent déclenchée (monde entier ou dans une scène): https://developers.google.com/assistant/conversational/intents
Représentation JSON | |
---|---|
{
"intentId": string,
"intentParameters": {
string: {
object ( |
Champs | |
---|---|
intentId |
ID de l'intent qui a déclenché cette interaction. |
intentParameters |
Paramètres de l'intent ayant déclenché cette interaction. Objet contenant une liste de paires |
handler |
Nom du gestionnaire associé à cette interaction. |
nextSceneId |
Scène à laquelle mène cette interaction. |
ConditionsEvaluated
Résultats de l'évaluation des conditions: https://developers.google.com/assistant/conversational/scenes#conditions
Représentation JSON | |
---|---|
{ "failedConditions": [ { object ( |
Champs | |
---|---|
failedConditions[] |
Liste des conditions qui ont été évaluées comme "faux". |
successCondition |
Première condition évaluée à la valeur "true", le cas échéant. |
Condition
Condition évaluée.
Représentation JSON | |
---|---|
{ "expression": string, "handler": string, "nextSceneId": string } |
Champs | |
---|---|
expression |
Expression spécifiée dans cette condition. |
handler |
Nom du gestionnaire spécifié dans la condition d'évaluation. |
nextSceneId |
Scène de destination spécifiée dans une condition d'évaluation. |
OnSceneEnter
Informations sur l'exécution de l'étape onSceneEnter: https://developers.google.com/assistant/conversational/scenes#onEnter
Représentation JSON | |
---|---|
{ "handler": string } |
Champs | |
---|---|
handler |
Nom du gestionnaire spécifié dans l'événement onSceneEnter. |
WebhookRequest
Informations sur une requête envoyée au webhook d'action: https://developers.google.com/assistant/conversational/webhooks#payloads
Représentation JSON | |
---|---|
{ "requestJson": string } |
Champs | |
---|---|
requestJson |
Charge utile de la requête webhook. |
WebhookResponse
Informations sur une réponse reçue du webhook Action: https://developers.google.com/assistant/conversational/webhooks#payloads
Représentation JSON | |
---|---|
{ "responseJson": string } |
Champs | |
---|---|
responseJson |
Charge utile de la réponse webhook. |
WebhookInitiatedTransition
Événement déclenché par une scène de destination renvoyée par le webhook: https://developers.google.com/assistant/conversational/webhooks#transition_scenes
Représentation JSON | |
---|---|
{ "nextSceneId": string } |
Champs | |
---|---|
nextSceneId |
ID de la scène vers laquelle la transition mène. |
SlotMatch
Informations sur le ou les emplacements correspondants : https://developers.google.com/assistant/conversational/scenes#slot_filling
Représentation JSON | |
---|---|
{
"nluParameters": {
string: {
object ( |
Champs | |
---|---|
nluParameters |
Paramètres extraits par NLU d'une entrée utilisateur. Objet contenant une liste de paires |
SlotRequested
Informations sur le créneau actuellement demandé: https://developers.google.com/assistant/conversational/scenes#slot_filling
Représentation JSON | |
---|---|
{
"slot": string,
"prompt": {
object ( |
Champs | |
---|---|
slot |
Nom de l'emplacement demandé. |
prompt |
Invite d'emplacement. |
SlotValidated
Événement qui se produit une fois la validation du webhook terminée pour le ou les emplacements : https://developers.google.com/assistant/conversational/scenes#slot_filling
FormFilled
Événement qui se produit lorsque le formulaire est entièrement rempli: https://developers.google.com/assistant/conversational/scenes#slot_filling
WaitingForUserInput
Événement qui se produit lorsque le système nécessite une action de la part de l'utilisateur: https://developers.google.com/assistant/conversational/scenes#input
EndConversation
Événement indiquant que la conversation avec l'agent a été terminée.