- Ressource : ChannelConfig
- Représentation JSON
- OperationsConfig
- UpsellStrategy
- UpsellConfig
- GreetingOffer
- OfferMessage
- MessageConfig
- ClosingOffer
- ClosingMessage
- CelUpsell
- SuggestedModifierGroup
- Bonjour,
- FeaturesConfig
- OrderPickup
- OrderDineIn
- NameCollection
- GetOrderPrices
- EndSessionWithCheckoutRequest
- EnableAddressCollection
- SupportCashPayment
- InteractionMode
- DisambiguationStrategy
- DisambiguationMapping
- Type
- TargetItem
- TargetModifier
- État
- Type
- SupplementalInstructions
- Ton
- Méthodes
Ressource : ChannelConfig
Une configuration de canal représente une configuration de stratégie opérationnelle. Cycle de vie de la configuration du canal : * DRAFT : une configuration est à l'état de brouillon lorsqu'elle n'est associée à aucune règle d'application de configuration et qu'elle n'est pas définie comme configuration par défaut pour la marque. * ACTIVE : une configuration est active lorsqu'elle est associée à une règle d'application de configuration ou définie comme configuration par défaut de la marque. * Lorsqu'elle est active, l'exécution applique la configuration du canal aux magasins correspondants. Pour garantir la flexibilité, la relation entre la configuration du canal et la règle d'application de la configuration est de type un-à-plusieurs à chaque niveau de ressource : * Au niveau de la marque, il existe une relation un-à-plusieurs entre les configurations de canal et les règles d'application de la configuration. * Au niveau du magasin, il existe une autre relation de type un à plusieurs entre les configurations de canaux et les règles d'application de configuration. Lorsque plusieurs configurations de canal sont applicables, l'environnement d'exécution détermine la configuration à appliquer en fonction de l'ordre de priorité suivant (la dernière écrase la précédente en cas de conflit) : 1. Valeur par défaut au niveau de la marque 2. Liaison de niveau marque 3. Valeur par défaut au niveau du magasin : 4. Liaison au niveau du magasin
| Représentation JSON |
|---|
{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "operationsConfig": { object ( |
| Champs | |
|---|---|
name |
Identifiant. Nom de la configuration du canal. Format : projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channelConfig} |
displayName |
Facultatif. Nom à afficher facultatif pour cette configuration de canal pour les interfaces utilisateur. La valeur est limitée à 63 caractères. |
createTime |
Uniquement en sortie. Heure de création de cette configuration de canal. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
updateTime |
Uniquement en sortie. Heure de la dernière mise à jour de cette configuration de canal. Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : |
operationsConfig |
Facultatif. Stratégie opérationnelle pour la configuration du canal. |
state |
Uniquement en sortie. État de la configuration du canal. |
type |
Obligatoire. Type de configuration du canal. |
supplementalInstructions |
Facultatif. Instructions supplémentaires pour la configuration du canal. |
tone |
Facultatif. Le ton de l'agent. |
configApplicationRules[] |
Uniquement en sortie. Règles d'application de la configuration associées à cette configuration de canal. |
OperationsConfig
Configurations permettant de définir une stratégie opérationnelle.
| Représentation JSON |
|---|
{ "displayName": string, "description": string, "upsellStrategy": { object ( |
| Champs | |
|---|---|
displayName |
Facultatif. Nom de cette stratégie opérationnelle. |
description |
Facultatif. Description de cette stratégie opérationnelle. |
upsellStrategy |
Facultatif. Configuration du comportement de vente incitative. |
greetings[] |
Facultatif. Messages d'accueil personnalisés à utiliser (par langue). |
defaultLanguageCode |
Facultatif. Langue par défaut à utiliser pour servir les clients. |
featuresConfig |
Facultatif. Configuration des fonctionnalités de l'agent. |
interactionMode |
Facultatif. Mode d'interaction de l'agent. |
disambiguationStrategy |
Facultatif. Configuration de la stratégie pour le contrôle de désambiguïsation. |
UpsellStrategy
Définit la stratégie de vente incitative.
| Représentation JSON |
|---|
{
"maxUpsellOffers": integer,
"maxUpsellDeclines": integer,
"maxItemsInCart": integer,
"upsells": [
{
object ( |
| Champs | |
|---|---|
maxUpsellOffers |
Facultatif. Nombre maximal d'offres de vente incitative à présenter par session. |
maxUpsellDeclines |
Facultatif. Nombre maximal de fois qu'un client peut refuser une vente incitative avant que les ventes incitatives suivantes ne soient ignorées pour la session en cours. |
maxItemsInCart |
Facultatif. Nombre maximal d'articles autorisés dans le panier avant que les ventes incitatives supplémentaires ne soient ignorées pour la session en cours. |
upsells[] |
Facultatif. Les ventes incitatives configurées. |
cateringGuidelines |
Facultatif. Représente un ensemble de texte représentant les calculs de diffusion générés hors connexion et les règles de commande de groupe pour ce menu. Lu par le LLM conversationnel. |
UpsellConfig
Définit la configuration d'une instance de vente incitative.
| Représentation JSON |
|---|
{ "displayName": string, "priority": integer, "skipOnMultiQuantityUpsoldFromItem": boolean, "skipOnPreviousTurnUpsell": boolean, "disabled": boolean, // Union field |
| Champs | |
|---|---|
displayName |
Facultatif. Nom de la vente incitative. Il est utilisé pour l'affichage de l'UI, ainsi que pour l'agrégation et l'analyse des métriques. |
priority |
Obligatoire. Nombre représentant l'ordre de priorité de la configuration de vente incitative par rapport à toutes les autres UpsellConfigs d'une UpsellStrategy donnée. Les UpsellConfigs de priorité plus élevée seront tentés avant ceux de priorité plus faible.
|
skipOnMultiQuantityUpsoldFromItem |
Facultatif. Indique si cette vente incitative doit être ignorée si l'article à partir duquel elle est effectuée a une quantité supérieure à 1. Cette configuration ne s'applique qu'aux types de ventes incitatives pertinents : - Article vers menu - Menu plus grand - Ajout de modificateur - Boisson du menu - Article plus grand - Variante de menu - Déclenchement par article |
skipOnPreviousTurnUpsell |
Facultatif. Indique si cette vente incitative doit être ignorée si le tour de conversation précédent était une vente incitative. |
disabled |
Facultatif. Indique si le type de vente incitative est désactivé. Si la valeur est "true", la vente incitative ne sera pas tentée. Cette configuration est utile pour désactiver un type de vente incitative dans le cadre d'un remplacement de règle d'application de configuration. |
Champ d'union upsell_type_config. Configuration spécifique au type de vente incitative. upsell_type_config ne peut être qu'un des éléments suivants : |
|
greetingOffer |
Pratiquer la vente incitative sur des articles spécifiques dans le message de bienvenue de l'agent. |
closingOffer |
Pratiquez la vente incitative sur des articles spécifiques après qu'un client a finalisé sa commande. |
celUpsell |
Règle de vente incitative évaluée de manière dynamique en fonction du langage CEL (Common Expression Language). |
GreetingOffer
Pratiquer la vente incitative sur des articles spécifiques dans le message de bienvenue de l'agent.
| Représentation JSON |
|---|
{
"messages": [
{
object ( |
| Champs | |
|---|---|
messages[] |
Obligatoire. Messages d'accueil pour la vente incitative à utiliser. |
OfferMessage
Configuration commune pour les messages d'accueil et de clôture de l'offre.
| Représentation JSON |
|---|
{
"displayName": string,
"messageFrequency": number,
"upsoldItems": [
string
],
"messageConfigs": [
{
object ( |
| Champs | |
|---|---|
displayName |
Facultatif. Nom à utiliser pour l'affichage et l'analyse. |
messageFrequency |
Facultatif. Fraction de temps pendant laquelle utiliser ce message. Exemple : une valeur messageFrequency de 0,2 signifie que ce message sera utilisé pour 20 % des sessions. Si aucune valeur messageFrequency n'est définie (0.0), chaque message sera utilisé pour une proportion de 1/n des sessions, où n est le nombre d'OfferMessages configurés pour le type d'offre. Si seules certaines valeurs messageFrequency sont définies, les OfferMessages dont les valeurs messageFrequency ne sont pas définies ne seront pas utilisés. |
upsoldItems[] |
Facultatif. Noms des articles proposés en vente incitative dans ce message. Définissez ce paramètre OU upsoldItemIds, mais pas les deux. |
messageConfigs[] |
Obligatoire. Messages d'upsell par langue. |
upsoldItemIds[] |
Facultatif. ID des articles faisant l'objet d'une vente incitative dans ce message. Définissez ce paramètre OU upsoldItems, mais pas les deux. |
MessageConfig
Message spécifique à la langue à utiliser pour une vente incitative.
| Représentation JSON |
|---|
{ "languageCode": string, "messageText": string } |
| Champs | |
|---|---|
languageCode |
Obligatoire. Code de la langue à utiliser pour ce message. Code de langue BCP-47, tel que "en-US" ou "fr-CA". |
messageText |
Obligatoire. Texte du message spécifique à la langue. |
ClosingOffer
Pratiquez la vente incitative sur des articles spécifiques après qu'un client a finalisé sa commande.
| Représentation JSON |
|---|
{
"closingMessages": [
{
object ( |
| Champs | |
|---|---|
closingMessages[] |
Obligatoire. Ventes incitatives d'offres de clôture à appliquer. |
ClosingMessage
Configuration du message de vente incitative de clôture.
| Représentation JSON |
|---|
{
"offerMessage": {
object ( |
| Champs | |
|---|---|
offerMessage |
Obligatoire. Configuration du message d'offre. |
skipTerms[] |
Facultatif. Cette vente incitative sera ignorée si l'un de ces termes est présent dans le nom d'un article déjà inclus dans la commande du client. |
CelUpsell
Représente une règle précalculée qui définit les conditions contextuelles dans lesquelles un ensemble d'articles doit être proposé de manière proactive à l'utilisateur.
| Représentation JSON |
|---|
{
"conditionExpression": string,
"suggestedMenuItems": [
string
],
"triggerReason": string,
"priority": integer,
"suggestedModifiers": [
string
],
"suggestedModifierGroups": [
{
object ( |
| Champs | |
|---|---|
conditionExpression |
Obligatoire. Chaîne CEL (Common Expression Language) évaluée par rapport à l'état de la session en cours ( |
suggestedMenuItems[] |
Obligatoire. Noms sémantiques des éléments à suggérer si cette règle se déclenche. |
triggerReason |
Facultatif. Une instruction en langage naturel fournie au LLM conversationnel expliquant pourquoi cette vente incitative est effectuée, afin qu'il puisse formuler une vente incitative naturelle. Exemple : |
priority |
Facultatif. |
suggestedModifiers[] |
Facultatif. Noms sémantiques des modificateurs à suggérer si cette règle se déclenche. |
suggestedModifierGroups[] |
Facultatif. Groupes de modificateurs à suggérer si cette règle se déclenche. |
maxModifierPerGroup |
Facultatif. Nombre maximal de modificateurs à suggérer par groupe. |
suggestionOnly |
Facultatif. Il ne s'agit pas d'une véritable vente incitative, mais simplement de montrer les options suggérées à l'utilisateur. |
SuggestedModifierGroup
Groupe de modificateurs suggéré.
| Représentation JSON |
|---|
{ "name": string, "suggestedModifiers": [ string ] } |
| Champs | |
|---|---|
name |
Facultatif. Nom sémantique du groupe de modificateurs. |
suggestedModifiers[] |
Facultatif. Noms sémantiques des modificateurs à suggérer dans ce groupe. |
Messages d'accueil
Représente les messages d'accueil pour une langue spécifique.
| Représentation JSON |
|---|
{ "languageCode": string, "greetingPhrases": [ string ] } |
| Champs | |
|---|---|
languageCode |
Facultatif. Code de langue des phrases de salutation. Code de langue BCP-47, tel que "en-US" ou "fr-CA". |
greetingPhrases[] |
Facultatif. Liste de phrases de salutation dans la langue spécifiée. |
FeaturesConfig
Configurations des fonctionnalités de l'agent. Liste des flags de fonctionnalité utilisée pour générer les instructions et les outils personnalisés de l'agent.
| Représentation JSON |
|---|
{ "orderPickup": { object ( |
| Champs | |
|---|---|
orderPickup |
Facultatif. Configuration de la fonctionnalité de retrait des commandes. |
orderDineIn |
Facultatif. Configuration de la fonctionnalité "Commander sur place". |
nameCollection |
Facultatif. Configuration de la fonctionnalité de collecte de noms. |
confirmOrderInfoAtStart |
Facultatif. Indique si les informations de commande doivent être confirmées au début de la session. Obsolète : remplacé par confirmOrderInfoOnFinalize. |
confirmOrderInfoOnFinalize |
Facultatif. Indique s'il faut confirmer les informations de la commande lors de sa finalisation. |
getOrderPrices |
Facultatif. Obtenir la configuration de la fonctionnalité de prix des commandes. |
endSessionWithCheckoutRequest |
Facultatif. Terminez la session avec la configuration de la fonctionnalité de demande de paiement. |
enableAddressCollection |
Facultatif. Activez la configuration de la fonctionnalité de collecte des adresses de livraison. |
supportCashPayment |
Facultatif. Configurer la fonctionnalité de paiement en espèces. |
budgetBasedOrdering |
Facultatif. Indique si vous souhaitez activer la commande basée sur le budget. |
OrderPickup
Ce type ne comporte aucun champ.
Permet au client de commander des repas à emporter via l'agent.
OrderDineIn
Ce type ne comporte aucun champ.
Permet au client de commander des repas sur place via l'agent
NameCollection
Ce type ne comporte aucun champ.
Permet à l'agent de collecter le nom du client pendant la session.
GetOrderPrices
Ce type ne comporte aucun champ.
Permet à l'agent d'obtenir les prix des commandes auprès du point de vente.
EndSessionWithCheckoutRequest
Ce type ne comporte aucun champ.
Permet à l'agent de mettre fin à la session avec une demande de paiement.
EnableAddressCollection
Ce type ne comporte aucun champ.
Permet à l'agent de collecter l'adresse de livraison du client pendant la session.
SupportCashPayment
Ce type ne comporte aucun champ.
Permet à l'agent d'accepter les paiements en espèces.
InteractionMode
Mode d'interaction de l'agent.
| Enums | |
|---|---|
INTERACTION_MODE_UNSPECIFIED |
Le mode d'interaction n'est pas spécifié. |
ORDER_TAKING |
L'agent participe à une conversation bidirectionnelle pour prendre des commandes. |
LISTEN_ONLY |
L'agent ne fait qu'écouter et ne parle pas. |
DisambiguationStrategy
Configuration de la stratégie pour le contrôle de désambiguïsation.
| Représentation JSON |
|---|
{
"mappings": [
{
object ( |
| Champs | |
|---|---|
mappings[] |
Facultatif. Mappages de désambiguïsation configurés. |
DisambiguationMapping
Une règle de mappage pour corriger les termes non valides ou clarifier les éléments ambigus.
| Représentation JSON |
|---|
{ "type": enum ( |
| Champs | |
|---|---|
type |
Obligatoire. Type opérationnel de la règle de désambiguïsation. |
customerTerms[] |
Obligatoire. Énoncés du client ou chaînes de raccourcis. Chaque terme client est limité à 100 caractères. |
targets[] |
Obligatoire. Éléments de menu cibles entièrement structurés à suggérer ou à clarifier, y compris les modificateurs imbriqués. |
customInstruction |
Facultatif. Instructions de macro conditionnelles personnalisées ou conseils de formulation facultatifs. |
Type
Type opérationnel de la règle de désambiguïsation.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Type de règle non spécifié. |
SINGLE_TARGET |
Utilisé pour les mappages à cible unique (raccourcis, configurations de combinaisons personnalisées ou synonymes valides). |
INVALID_ITEM |
Utilisé pour les articles non valides, les articles en rupture de stock ou les produits de concurrents. |
DISAMBIGUATION |
Utilisé pour les entrées ambiguës nécessitant une clarification entre plusieurs options cibles valides. |
TargetItem
Cible alternative d'un élément structuré.
| Représentation JSON |
|---|
{
"itemName": string,
"modifiers": [
{
object ( |
| Champs | |
|---|---|
itemName |
Obligatoire. Nom de l'article dans le catalogue du menu. |
modifiers[] |
Facultatif. Modificateurs structurés à associer à cette cible. |
itemId |
Facultatif. Identifiant unique de l'élément dans le catalogue de menus (lien direct vers menu.proto). |
TargetModifier
Modificateur structuré à appliquer à l'élément cible.
| Représentation JSON |
|---|
{ "modifierName": string, "modifierGroupName": string, "modifierId": string, "modifierGroupId": string } |
| Champs | |
|---|---|
modifierName |
Obligatoire. Nom du modificateur correspondant directement à l'entrée du catalogue. |
modifierGroupName |
Facultatif. Nom du groupe de modificateurs facultatif auquel lier le modificateur. |
modifierId |
Facultatif. Identifiant unique du modificateur dans le catalogue du menu (associé directement à menu.proto). |
modifierGroupId |
Facultatif. Identifiant unique du groupe de modificateurs dans le catalogue du menu. |
État
État de la configuration du canal.
| Enums | |
|---|---|
STATE_UNSPECIFIED |
L'état n'est pas spécifié. |
DRAFT |
La configuration du canal est un brouillon et n'est pas encore prête à être utilisée. |
ACTIVE |
La configuration du canal est active et peut être utilisée. |
PROMOTED |
La configuration du canal est promue. |
Type
Type de configuration du canal.
| Enums | |
|---|---|
TYPE_UNSPECIFIED |
Le type n'est pas spécifié. |
UPSELL_STRATEGY |
La configuration du canal est destinée à la stratégie de vente incitative. |
AGENT_CUSTOMIZATION |
La configuration du canal permet de personnaliser l'agent. |
SupplementalInstructions
Configurations pour les instructions supplémentaires.
| Représentation JSON |
|---|
{ "freeformInstructions": string } |
| Champs | |
|---|---|
freeformInstructions |
Facultatif. Instructions de forme libre incluses dans la requête. |
Ton
Le ton de l'agent.
| Enums | |
|---|---|
TONE_UNSPECIFIED |
Le ton n'est pas spécifié. |
CONCISE_AND_DIRECT |
Le ton de l'agent est concis et direct. |
PROFESSIONAL_AND_FORMAL |
Le ton de l'agent est professionnel et formel. |
FRIENDLY |
Le ton de l'agent est amical. |
Méthodes |
|
|---|---|
|
Crée une ressource ChannelConfig. |
|
Supprime la ressource ChannelConfig spécifiée. |
|
Récupère une ressource ChannelConfig. |
|
Répertorie les ressources ChannelConfig. |
|
Met à jour la ressource ChannelConfig spécifiée. |
|
Promeut la configuration de canal spécifiée. |