Annuler la commande d'un composant prédéfini

Le composant prédéfini d'annulation de commande vérifie le niveau d'authentification d'un utilisateur. Une fois l'utilisateur authentifié, le composant fournit des informations sur ses commandes les plus récentes ou passées. L'utilisateur peut alors choisir d'annuler une commande entière ou des articles spécifiques d'une commande. Ce composant utilise le composant prédéfini Retail authentication (Authentification pour le commerce) pour authentifier les utilisateurs. Le composant utilise également des générateurs pour le résumé après l'appel.

Limites

En plus des limites communes des composants prédéfinis, ce composant prédéfini présente les limites suivantes :

• Ce composant ne chiffre aucune donnée.

Exemples de dialogues

Les exemples de boîtes de dialogue suivants illustrent des scénarios courants gérés par ce composant prédéfini. Les exemples de boîtes de dialogue illustrent le comportement lorsque le composant est appelé par téléphonie, ce qui déclenche l'intent de bienvenue par défaut et la première réponse de l'agent au début de la conversation.

Annuler un seul produit d'une commande récente

L'utilisateur final a déjà été authentifié. L'agent confirme les articles de la commande la plus récente qui doivent être annulés. L'agent vérifie le mode de paiement d'origine et confirme les détails de l'annulation avec l'utilisateur.

Entrée utilisateur	Réponse de l'agent
	Appelez-vous au sujet de votre commande la plus récente, dont le numéro se termine par 12978, contenant 5 bouteilles d'eau et 1 t-shirt, passée le 09/11/2023 à 20h00 ?
oui
	Nous avons trouvé des produits éligibles dans votre commande. Veuillez nous indiquer le produit que vous souhaitez annuler. Produit 1 : bouteille d'eau Google, Produit 2 : t-shirt Google. Veuillez énoncer ou saisir le numéro du produit que vous souhaitez sélectionner, ou dites "suivant" pour afficher d'autres produits.
suivant
	Nous n'avons trouvé aucun autre article dans nos dossiers. Veuillez choisir un produit dans la liste partagée. Produit 1 : bouteille d'eau Google, Produit 2 : t-shirt Google. Veuillez énoncer ou saisir le numéro du produit que vous souhaitez sélectionner, ou dites "suivant" pour afficher d'autres produits.
1
	Pour confirmer, vous souhaitez annuler la bouteille d'eau Google. Est-ce correct ?
oui
	Vous pouvez voir que la quantité disponible du produit que vous avez sélectionné est de 5. Veuillez indiquer la quantité de produits que vous souhaitez annuler.
4
	Veuillez indiquer le motif de l'annulation. Vous pouvez dire quelque chose comme : "J'ai changé d'avis", "Je n'en ai plus besoin", "Je voudrais acheter un autre article", "Livraison retardée", "Acheté par erreur", "Je veux changer de mode de paiement" ou autre chose.
Je souhaite acheter un autre article
	Merci de nous avoir prévenus. Souhaitez-vous annuler un autre produit ?
non
	Pour les achats effectués avec votre portefeuille, les remboursements sont crédités sur le portefeuille ou sur le compte de crédit Google Store. Il faudra compter trois à cinq jours ouvrés pour que votre remboursement apparaisse sur votre compte. Veuillez noter que le montant du remboursement n'inclura pas les frais de port et de gestion.

Annuler toute la commande

L'utilisateur final a déjà été authentifié. L'agent confirme que l'utilisateur souhaite annuler une commande spécifique, puis recueille le motif de l'annulation. L'agent vérifie le mode de paiement d'origine et confirme les détails de l'annulation avec l'utilisateur.

Entrée utilisateur	Réponse de l'agent
	Appelez-vous au sujet de votre commande la plus récente, dont le numéro se termine par 12345, contenant 1 chemise et passée le 10/11/2023 à 18h00 ?
non
	Souhaitez-vous annuler une autre commande ?
oui
	Pourriez-vous m'indiquer les cinq derniers chiffres de l'ID de la commande que vous souhaitez suivre ?
12346
	Les cinq derniers chiffres de l'ID de commande que nous avons reçu sont 12346. Est-ce correct ?
oui
	Nous avons bien enregistré l'ID de commande. Souhaitez-vous annuler l'intégralité de la commande ?
oui
	Veuillez indiquer le motif de l'annulation. Vous pouvez dire quelque chose comme : "J'ai changé d'avis", "Je n'en ai plus besoin", "Je voudrais acheter un autre article", "Livraison retardée", "Acheté par erreur", "Je veux changer de mode de paiement" ou autre chose.
plus nécessaire
	Merci de nous avoir prévenus. Votre demande d'annulation a été générée.

Conventions d'attribution de noms

Ce composant prédéfini utilise les conventions d'attribution de noms suivantes :

Fonctionnalité	Format	Exemple
Flow	[Component Name]	Annuler la commande
Type d'entité	prebuilt_components_[component_name]_[entity_type]	prebuilt_components_product_cancel_reason
Webhook	prebuilt_components_[component_name]:[webhook_action]	prebuilt_components_cancel_order:post_cancellation_details

Paramètres d'entrée

Les paramètres d'entrée sont des paramètres utilisés pour configurer certains comportements du composant. Les paramètres seront utilisés par une ou plusieurs conditions du flux pour déterminer le comportement du composant. Les paramètres limités au flux doivent être définis sur la page de démarrage du composant. Les paramètres de portée session peuvent être définis par un flux d'appel ou sur la page de démarrage de ce composant.

Ce composant prédéfini accepte les paramètres d'entrée suivants :

Nom du paramètre	Description	Format d'entrée
$session.params.phone_number	(Facultatif) Numéro de téléphone local de l'utilisateur, sans le code pays, utilisé pour identifier l'utilisateur.	string
$session.params.all_recent_order_id	(Facultatif) Ce paramètre liste les ID de commande associés à l'utilisateur authentifié, triés par date de commande dans l'ordre décroissant. Le premier élément du tableau représente la commande la plus récente. Si un utilisateur n'a pas de commande, la valeur de ce paramètre est null.	Liste (chaîne)
$session.params.email	(Facultatif) Adresse e-mail enregistrée avec le compte.	string
$session.params.user_first_name	(Facultatif) Prénom de l'utilisateur, utilisé pour l'accueillir et confirmer qu'il est bien le propriétaire du compte.	string

Ce composant prédéfini permet aux paramètres facultatifs suivants de configurer le comportement du composant, y compris les nouvelles tentatives.

Nom du paramètre	Description	Format
$flow.max_retry_another_account_counter	Spécifie le nombre de tentatives autorisées lorsque l'utilisateur choisit de continuer avec un autre compte. La valeur par défaut est 2.	entier
$flow.max_retry_order_number	Spécifie le nombre de tentatives autorisées pour fournir les cinq derniers chiffres d'un numéro de commande. La valeur par défaut est 2.	entier
$flow.max_retry_another_order	Spécifie le nombre de nouvelles tentatives autorisées lors de la sélection d'une autre commande si l'ID de commande est introuvable ou si la commande ne peut pas être annulée. La valeur par défaut est 2.	entier
$flow.max_retry_select_order_number	Spécifie le nombre de tentatives autorisées lorsque l'utilisateur fournit le numéro de commande complet dans les cas où plusieurs commandes partagent les cinq mêmes derniers chiffres. La valeur par défaut est 2.	entier
$flow.max_product_display_counter	Spécifie le nombre maximal de produits à présenter en une seule fois. La valeur par défaut est 2.	entier
$flow.max_product_display	Spécifie le nombre maximal de produits à présenter au cours de l'ensemble de la conversation. La valeur par défaut est 9.	entier
$flow.max_retry_product_number_counter	Spécifie le nombre maximal de tentatives autorisées lors de la sélection d'un produit à annuler. La valeur par défaut est 2.	entier
$flow.max_product_cancel_confirm_counter	Spécifie le nombre maximal de tentatives autorisées lors de la confirmation du produit sélectionné. La valeur par défaut est 2.	entier
$flow.max_retry_select_quantity	Spécifie le nombre maximal de tentatives autorisées lors de la sélection de la quantité de produits à annuler. La valeur par défaut est 2.	entier
$flow.order_product_cancel_reason_others	Spécifie la valeur de l'entité prebuilt_components_product_cancel_reason indiquant que l'utilisateur a sélectionné le motif d'annulation "Autres". La valeur par défaut est "others".	string
$flow.max_retry_cancel_reason	Spécifie le nombre de tentatives autorisées lors de la confirmation du motif d'annulation. La valeur par défaut est 2.	entier
$flow.order_payment_mode_COD	Spécifie la valeur du champ order_payment_mode renvoyé par le webhook get_order_details indiquant un mode de paiement à la livraison. La valeur par défaut est "COD".	string
$flow.order_payment_mode_store_credit	Spécifie la valeur du champ order_payment_mode renvoyé par le webhook get_order_details indiquant un mode de paiement par crédit Google Store. La valeur par défaut est "store_credit".	string

Pour configurer les paramètres d'entrée de ce composant, développez la section pour obtenir des instructions.

1. Ouvrez la console Dialogflow CX.
2. Choisissez votre projet Google Cloud.
3. Sélectionnez votre agent.
4. Sélectionnez l'onglet Compilation.
5. Cliquez sur le composant importé dans la section Flows (Flux).
6. Cliquez sur la page de démarrage dans la section Pages.
7. Cliquez sur la route true (vrai) sur la page d'accueil.
8. Dans la fenêtre "Route", modifiez les valeurs des préréglages des paramètres si nécessaire.
9. Cliquez sur Enregistrer.

Paramètres de sortie

Les paramètres de sortie sont des paramètres de session qui resteront actifs après la sortie du composant. Ces paramètres contiennent des informations importantes collectées par le composant. Ce composant prédéfini fournit des valeurs pour les paramètres de sortie suivants :

Nom du paramètre	Description	Format de sortie
phone_number	Numéro de téléphone local de l'utilisateur, sans le code pays, utilisé pour l'identifier.	string
all_recent_order_id	Ce paramètre liste les ID de commande associés à l'utilisateur authentifié, triés par date de commande dans l'ordre décroissant. Le premier élément du tableau représente la commande la plus récente. Si un utilisateur n'a pas de commande, la valeur de ce paramètre est null.	Liste (chaîne)
e-mail	L'adresse e-mail enregistrée avec le compte.	string
user_first_name	Prénom de l'utilisateur, utilisé pour l'accueillir et confirmer qu'il est bien le titulaire du compte.	string
transfer_reason	Ce paramètre indique la raison pour laquelle le flux s'est arrêté, s'il n'a pas abouti. La valeur renvoyée est l'une des suivantes : agent : l'utilisateur final a demandé un agent humain à un moment donné de la conversation. denial_of_information : l'utilisateur final a refusé de partager les informations demandées par le composant. max_no_input : la conversation a atteint le nombre maximal de nouvelles tentatives pour les événements sans entrée. Consultez Événements intégrés no-input. max_no_match : la conversation a atteint le nombre maximal de nouvelles tentatives pour les événements no-match. Consultez Événements intégrés sans correspondance. webhook_error : une erreur de webhook s'est produite. Consultez Événement intégré webhook.error. webhook_not_found : une URL de webhook était inaccessible. Consultez Événement intégré webhook.error.not-found.	string

Générateurs

Ce composant utilise des générateurs pour activer des parties spécifiques de la conversation.

Synthèse

Le générateur Summarization permet de générer un résumé après l'appel décrivant la conversation gérée par le composant.

Configuration de base

Pour configurer ce composant prédéfini :

1. Importez le composant prédéfini.
2. Configurez les webhooks flexibles fournis avec une configuration décrivant vos services externes. Consultez la section "Configuration des webhooks".

Configuration du webhook

Pour utiliser ce composant, vous devez configurer les webhooks flexibles inclus afin de récupérer les informations nécessaires auprès de vos services externes.

Authentification

Si vous n'avez pas encore configuré les services externes requis pour l'authentification, vous devrez les configurer pour permettre l'authentification des utilisateurs pour ce composant. Pour obtenir des instructions détaillées, consultez Configurer le webhook d'authentification Retail.

Obtenir les détails des commandes

Le webhook prebuilt_components_cancel_order:get_order_details est utilisé par le composant pour récupérer les détails d'une commande spécifiée.

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées de la requête API.

Nom du paramètre	Description	Format d'entrée
$flow.order_id	ID de commande pour lequel récupérer les détails.	string

Paramètres de réponse de l'API

Les paramètres suivants sont extraits de la réponse de l'API pour être utilisés par le composant.

Nom du paramètre	Description	Format de sortie
order_date	Date à laquelle la commande a été passée, au format YYYY-MM-DD.	string
order_time	Date et heure auxquelles la commande a été passée, au format HH:MM.	string
order_product_count	Nombre de produits uniques dans une commande.	entier
order_payment_mode	Indique le mode de paiement utilisé lors de la commande.	string
cancelable_product_id	Liste des identifiants produit des produits annulables de la commande.	Liste (chaîne)
cancelable_product_name	Liste des noms des produits annulables de la commande.	Liste (chaîne)
cancelable_product_brand_name	Liste des noms de marques des produits annulables de la commande.	Liste (chaîne)
cancelable_product_quantity	Liste des quantités de produits annulables dans la commande.	Liste (chaîne)

Pour configurer le webhook "Obtenir les détails de la commande" pour ce composant, développez pour afficher les instructions.

1. Ouvrez la console Dialogflow CX.
2. Choisissez votre projet Google Cloud.
3. Sélectionnez votre agent.
4. Sélectionnez l'onglet Gérer.
5. Cliquez sur Webhooks.
6. Sélectionnez le webhook prebuilt_components_cancel_order:get_order_details.
7. Remplacez l'URL dans le champ URL du webhook de Dialogflow CX par le point de terminaison du service que vous souhaitez intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
8. Examinez et mettez à jour le corps de la requête pour créer le format de requête approprié pour votre webhook.
9. Examinez et mettez à jour la configuration de la réponse pour extraire des champs spécifiques de la réponse de votre webhook. Ne modifiez pas les noms des paramètres, car ils sont requis par le composant pour accéder aux valeurs de champ renvoyées.
10. Vérifiez et modifiez les paramètres d'authentification si nécessaire.
11. Cliquez sur Enregistrer.

Obtenir les détails d'une commande en double

Le webhook prebuilt_components_retail_services:get_duplicate_order_details est utilisé par le composant pour récupérer des informations détaillées afin de distinguer les commandes lorsque plusieurs numéros de commande ont les cinq mêmes derniers chiffres.

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées de la requête API.

Nom du paramètre	Description	Format d'entrée
$flow.duplicate_order_id	Liste contenant les cinq derniers chiffres des numéros de commande partagés entre une ou plusieurs commandes de l'utilisateur.	Liste (chaîne)

Paramètres de réponse de l'API

Les paramètres suivants sont extraits de la réponse de l'API pour être utilisés par le composant.

Nom du paramètre	Description	Format de sortie
all_order_date	Liste des dates de commande pour les commandes en double avec les cinq derniers chiffres spécifiés au format YYYY-MM-DD. Chaque élément de ce tableau correspond au même élément du tableau all_order_time.	Liste (chaîne)
all_order_time	Liste des heures de commande pour les commandes en double avec les cinq derniers chiffres spécifiés au format HH:MM. Chaque élément de ce tableau correspond au même élément du tableau all_order_date.	Liste (chaîne)

Pour configurer le webhook "Obtenir les détails de la commande en double" pour ce composant, développez pour afficher les instructions.

1. Ouvrez la console Dialogflow CX.
2. Choisissez votre projet Google Cloud.
3. Sélectionnez votre agent.
4. Sélectionnez l'onglet Gérer.
5. Cliquez sur Webhooks.
6. Sélectionnez le webhook prebuilt_components_retail_services:get_duplicate_order_details.
7. Remplacez l'URL dans le champ URL du webhook de Dialogflow CX par le point de terminaison du service que vous souhaitez intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
8. Examinez et mettez à jour le corps de la requête pour créer le format de requête approprié pour votre webhook.
9. Examinez et mettez à jour la configuration de la réponse pour extraire des champs spécifiques de la réponse de votre webhook. Ne modifiez pas les noms des paramètres, car ils sont requis par le composant pour accéder aux valeurs de champ renvoyées.
10. Vérifiez et modifiez les paramètres d'authentification si nécessaire.
11. Cliquez sur Enregistrer.

Détails de l'annulation du post

Le webhook prebuilt_components_cancel_order:post_cancellation_details est utilisé par le composant pour envoyer une demande d'annulation.

Paramètres de requête API

Les paramètres suivants sont fournis par le composant en tant qu'entrées de la requête API.

Nom du paramètre	Description	Format d'entrée
$session.params.phone_number	Numéro de téléphone local de l'utilisateur, sans le code pays, utilisé pour l'identifier.	string
$flow.order_id	ID de commande (Order ID) pour laquelle vous souhaitez envoyer une demande.	string
$flow.cancel_product_id_list	Liste des ID produit que l'utilisateur souhaite annuler.	Liste (chaîne)
$flow.cancel_product_quantity_list	Liste des quantités de produits que l'utilisateur souhaite annuler, correspondant à chaque élément de $flow.cancel_product_id_list.	Liste (chaîne)
$flow.cancel_reason_list	Liste des motifs d'annulation pour chaque produit annulé, correspondant à chaque élément de $flow.cancel_product_id_list.	Liste (chaîne)
$flow.order_refund_mode	Mode de paiement pour le remboursement. Les valeurs valides sont définies par l'entité prebuilt_components_cancel_mode_of_refund.	string

Paramètres de réponse de l'API

Les paramètres suivants sont extraits de la réponse de l'API pour être utilisés par le composant.

Nom du paramètre	Description	Format de sortie
order_cancellation_ticket_id	ID de la demande d'annulation envoyée.	string

Pour configurer le webhook "Détails après annulation" pour ce composant, développez pour afficher les instructions.

1. Ouvrez la console Dialogflow CX.
2. Choisissez votre projet Google Cloud.
3. Sélectionnez votre agent.
4. Sélectionnez l'onglet Gérer.
5. Cliquez sur Webhooks.
6. Sélectionnez le webhook prebuilt_components_cancel_order:post_cancellation_details.
7. Remplacez l'URL dans le champ URL du webhook de Dialogflow CX par le point de terminaison du service que vous souhaitez intégrer. Sélectionnez la méthode appropriée dans le menu déroulant.
8. Examinez et mettez à jour le corps de la requête pour créer le format de requête approprié pour votre webhook.
9. Examinez et mettez à jour la configuration de la réponse pour extraire des champs spécifiques de la réponse de votre webhook. Ne modifiez pas les noms des paramètres, car ils sont requis par le composant pour accéder aux valeurs de champ renvoyées.
10. Vérifiez et modifiez les paramètres d'authentification si nécessaire.
11. Cliquez sur Enregistrer.

Terminé

Votre agent et ses webhooks devraient maintenant être configurés et prêts à être testés.