REST Resource: projects.locations.brands.channelConfigs

资源：ChannelConfig

渠道配置表示运营策略配置。渠道配置生命周期：* 草稿：如果配置没有关联的配置应用规则，并且未设置为品牌的默认配置，则该配置处于草稿状态。* 有效：如果配置与任何配置应用规则相关联，或者设置为品牌的默认配置，则该配置处于有效状态。* 处于有效状态时，运行时会将渠道配置应用于匹配的商店。为确保灵活性，渠道配置与配置应用规则之间的关系在每个资源级别都是一对多：* 在品牌级别，渠道配置与配置应用规则之间是一对多关系。* 在商店级别，渠道配置与配置应用规则之间存在另一种一对多关系。如果多个渠道配置适用，运行时会根据以下优先顺序确定要应用的配置（如果发生冲突，后者会覆盖前者）：1. 品牌级默认设置 2。品牌级绑定 3. 商店级默认值为 4。商店级绑定

JSON 表示法 
{
  "name": string,
  "displayName": string,
  "createTime": string,
  "updateTime": string,
  "operationsConfig": {
    object (OperationsConfig)
  },
  "state": enum (State),
  "type": enum (Type),
  "supplementalInstructions": {
    object (SupplementalInstructions)
  },
  "tone": enum (Tone),
  "configApplicationRules": [
    {
      object (ConfigApplicationRule)
    }
  ]
}
字段
name

string

标识符。渠道配置名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channelConfig}
displayName

string

可选。此渠道配置在界面中的可选显示名称。值不得超过 63 个字符。
createTime

string (Timestamp format)

仅限输出。相应渠道配置的创建时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

仅限输出。相应频道配置的上次更新时间。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
operationsConfig

object (OperationsConfig)

可选。渠道配置的运营策略。
state

enum (State)

仅限输出。频道配置的状态。
type

enum (Type)

必需。渠道配置的类型。
supplementalInstructions

object (SupplementalInstructions)

可选。有关渠道配置的补充说明。
tone

enum (Tone)

可选。代理的语气。
configApplicationRules[]

object (ConfigApplicationRule)

仅限输出。与此渠道配置关联的配置应用规则。

OperationsConfig

用于定义运营策略的配置。

JSON 表示法 
{
  "displayName": string,
  "description": string,
  "upsellStrategy": {
    object (UpsellStrategy)
  },
  "greetings": [
    {
      object (Greetings)
    }
  ],
  "defaultLanguageCode": string,
  "featuresConfig": {
    object (FeaturesConfig)
  },
  "interactionMode": enum (InteractionMode),
  "disambiguationStrategy": {
    object (DisambiguationStrategy)
  }
}
字段
displayName

string

可选。相应运营策略的名称。
description

string

可选。相应运营策略的说明。
upsellStrategy

object (UpsellStrategy)

可选。追加销售行为的配置。
greetings[]

object (Greetings)

可选。要使用的自定义问候语消息（按语言）。
defaultLanguageCode

string

可选。用于服务客户的默认语言。
featuresConfig

object (FeaturesConfig)

可选。代理功能配置。
interactionMode

enum (InteractionMode)

可选。代理的互动模式。
disambiguationStrategy

object (DisambiguationStrategy)

可选。消除歧义控制的策略配置。

UpsellStrategy

定义追加销售策略。

JSON 表示法 
{
  "maxUpsellOffers": integer,
  "maxUpsellDeclines": integer,
  "maxItemsInCart": integer,
  "upsells": [
    {
      object (UpsellConfig)
    }
  ],
  "cateringGuidelines": string
}
字段
maxUpsellOffers

integer

可选。每个会话中要展示的追加销售优惠的数量上限。
maxUpsellDeclines

integer

可选。在当前会话中，客户可以拒绝追加销售的次数上限，超过此上限后，系统将跳过后续的追加销售。
maxItemsInCart

integer

可选。购物车中允许的最大商品数量，超过此数量后，系统会在当前会话中跳过进一步的追加销售。
upsells[]

object (UpsellConfig)

可选。配置的追加销售。
cateringGuidelines

string

可选。表示一组文本，用于表示相应菜单的离线生成的投放计算结果和分组排序规则。由对话式 LLM 读取。

UpsellConfig

定义追加销售实例的配置。

JSON 表示法 
{
  "displayName": string,
  "priority": integer,
  "skipOnMultiQuantityUpsoldFromItem": boolean,
  "skipOnPreviousTurnUpsell": boolean,
  "disabled": boolean,

  // Union field upsell_type_config can be only one of the following:
  "greetingOffer": {
    object (GreetingOffer)
  },
  "closingOffer": {
    object (ClosingOffer)
  },
  "celUpsell": {
    object (CelUpsell)
  }
  // End of list of possible types for union field upsell_type_config.
}
字段
displayName

string

可选。追加销售的名称。用于界面显示，以及指标汇总和分析。
priority

integer

必需。一个数字，表示相对于给定 UpsellStrategy 中的所有其他 UpsellConfig，追加销售配置的优先级顺序。系统会先尝试推销优先级较高的 UpsellConfig，然后再尝试推销优先级较低的 UpsellConfig。

  • 值可以介于 [1, inf) 范围内。
  • 值越小，优先级越高。例如，UpsellStrategy 中优先级为 1 的 UpsellConfig 将始终首先尝试。
  • 在 UpsellStrategy 中，每个 UpsellConfig 都必须具有唯一的优先级值（例如，只能有一个 UpsellConfig 的优先级为 3）。
  • 在 UpsellStrategy 中，优先级值不一定必须是连续的（例如，可以有优先级值为 {1, 2, 5, 6, 9} 的 UpsellConfig）。追加销售配置的优先级是相对确定的（从上一个示例来看：1 < 2 < 5 < 6 < 9）。
skipOnMultiQuantityUpsoldFromItem

boolean

可选。如果要追加销售的商品数量大于 1，是否跳过此追加销售。此配置仅适用于相关的追加销售类型：- 商品到套餐 - 套餐升级 - 添加加料项 - 套餐饮料 - 商品升级 - 套餐变体 - 商品触发
skipOnPreviousTurnUpsell

boolean

可选。如果之前的对话轮次是追加销售，是否跳过此追加销售。
disabled

boolean

可选。指示追加销售类型是否已停用。如果值为 true，则不会尝试追加销售。此配置可用于在配置应用规则替换中停用追加销售类型。
联合字段 upsell_type_config。追加销售的类型特定配置。upsell_type_config 只能是下列其中一项：
greetingOffer

object (GreetingOffer)

在代理欢迎辞中追加销售特定商品。
closingOffer

object (ClosingOffer)

在客户完成订单后，追加销售特定商品。
celUpsell

object (CelUpsell)

基于通用表达式语言 (CEL) 的动态评估追加销售规则。

GreetingOffer

在代理欢迎辞中追加销售特定商品。

JSON 表示法 
{
  "messages": [
    {
      object (OfferMessage)
    }
  ]
}
字段
messages[]

object (OfferMessage)

必需。要使用的问候语追加销售消息。

OfferMessage

问候语和结束语优惠消息的常见配置。

JSON 表示法 
{
  "displayName": string,
  "messageFrequency": number,
  "upsoldItems": [
    string
  ],
  "messageConfigs": [
    {
      object (MessageConfig)
    }
  ],
  "upsoldItemIds": [
    string
  ]
}
字段
displayName

string

可选。用于显示和分析的名称。
messageFrequency

number

可选。使用相应消息的时间所占的比例。示例：messageFrequency 为 0.2 表示此消息将用于 20% 的会话。如果所有 messageFrequency 值均未设置 (0.0)，则每条消息将用于 1/n 的会话，其中 n 是为相应优惠类型配置的 OfferMessage 数量。如果仅设置了部分 messageFrequency 值，则不会使用未设置 messageFrequency 值的 OfferMessages。
upsoldItems[]

string

可选。相应消息中追加销售的商品的名称。设置此参数或 upsoldItemIds，但不能同时设置这两者。
messageConfigs[]

object (MessageConfig)

必需。针对每种语言的追加销售消息。
upsoldItemIds[]

string

可选。相应消息中追加销售的商品的 ID。设置此参数或 upsoldItems，但不能同时设置这两者。

MessageConfig

用于追加销售的特定语言的消息。

JSON 表示法 
{
  "languageCode": string,
  "messageText": string
}
字段
languageCode

string

必需。要用于相应消息的语言的代码。BCP-47 语言代码，例如“en-US”或“fr-CA”。
messageText

string

必需。特定语言的消息文本。

ClosingOffer

在客户完成订单后，追加销售特定商品。

JSON 表示法 
{
  "closingMessages": [
    {
      object (ClosingMessage)
    }
  ]
}
字段
closingMessages[]

object (ClosingMessage)

必需。正在关闭要应用的优惠追加销售。

ClosingMessage

关闭追加销售消息配置。

JSON 表示法 
{
  "offerMessage": {
    object (OfferMessage)
  },
  "skipTerms": [
    string
  ]
}
字段
offerMessage

object (OfferMessage)

必需。优惠消息配置。
skipTerms[]

string

可选。如果客户订单中已有商品的名称中包含上述任何字词，系统将跳过此追加销售。

CelUpsell

表示一个预先计算的规则，用于定义在哪些情境条件下应主动向用户推销一组商品。

JSON 表示法 
{
  "conditionExpression": string,
  "suggestedMenuItems": [
    string
  ],
  "triggerReason": string,
  "priority": integer,
  "suggestedModifiers": [
    string
  ],
  "suggestedModifierGroups": [
    {
      object (SuggestedModifierGroup)
    }
  ],
  "maxModifierPerGroup": integer,
  "suggestionOnly": boolean
}
字段
conditionExpression

string

必需。针对当前会话状态（Order 和 ClientSessionMetadata）评估的 CEL（通用表达式语言）字符串。如果评估结果为 True，则触发规则。示例："context.weather_condition == 'HOT' && order.items.size() > 0"
suggestedMenuItems[]

string

必需。如果此规则触发，要建议的商品的语义名称。
triggerReason

string

可选。提供给对话式 LLM 的自然语言指令，用于说明为何要进行此追加销售，以便 LLM 制定自然的追加销售方案。示例："Suggest a cold drink because it is a hot day."
priority

integer

可选。相应规则的 priority。数字越大，优先级越高。如果触发了多条规则，系统会优先显示优先级最高的规则的建议。如果省略，priority 默认值为 0。
suggestedModifiers[]

string

可选。如果触发此规则，要建议的修饰符的语义名称。
suggestedModifierGroups[]

object (SuggestedModifierGroup)

可选。如果触发此规则，要建议的调节系数组。
maxModifierPerGroup

integer

可选。每个组要建议的修饰符数量上限。
suggestionOnly

boolean

可选。不是真正的追加销售，只是向用户显示建议的选项。

SuggestedModifierGroup

建议的修饰符组。

JSON 表示法 
{
  "name": string,
  "suggestedModifiers": [
    string
  ]
}
字段
name

string

可选。修饰符组的语义名称。
suggestedModifiers[]

string

可选。要在此组中建议的修饰符的语义名称。

问候语

表示特定语言的问候消息。

JSON 表示法 
{
  "languageCode": string,
  "greetingPhrases": [
    string
  ]
}
字段
languageCode

string

可选。问候语的语言代码。BCP-47 语言代码，例如“en-US”或“fr-CA”。
greetingPhrases[]

string

可选。指定语言的问候语列表。

FeaturesConfig

代理功能的配置。用于生成代理的自定义指令和工具的功能标志列表。

JSON 表示法 
{
  "orderPickup": {
    object (OrderPickup)
  },
  "orderDineIn": {
    object (OrderDineIn)
  },
  "nameCollection": {
    object (NameCollection)
  },
  "confirmOrderInfoAtStart": boolean,
  "confirmOrderInfoOnFinalize": boolean,
  "getOrderPrices": {
    object (GetOrderPrices)
  },
  "endSessionWithCheckoutRequest": {
    object (EndSessionWithCheckoutRequest)
  },
  "enableAddressCollection": {
    object (EnableAddressCollection)
  },
  "supportCashPayment": {
    object (SupportCashPayment)
  },
  "budgetBasedOrdering": boolean
}
字段
orderPickup

object (OrderPickup)

可选。“下单自取”功能配置。
orderDineIn

object (OrderDineIn)

可选。“点餐”功能的配置。
nameCollection

object (NameCollection)

可选。命名集合功能配置。
confirmOrderInfoAtStart
(deprecated)

boolean

可选。是否在会话开始时确认订单信息。已弃用：已替换为 confirmOrderInfoOnFinalize。
confirmOrderInfoOnFinalize

boolean

可选。在完成订单时是否确认订单信息。
getOrderPrices

object (GetOrderPrices)

可选。获取订单价格功能配置。
endSessionWithCheckoutRequest

object (EndSessionWithCheckoutRequest)

可选。结束会话并配置结账请求功能。
enableAddressCollection

object (EnableAddressCollection)

可选。启用配送地址收集功能配置。
supportCashPayment

object (SupportCashPayment)

可选。支持现金付款功能配置。
budgetBasedOrdering

boolean

可选。是否启用基于预算的排序。

OrderPickup

此类型没有字段。

允许客户通过代理订购外卖，然后到店自取。

OrderDineIn

此类型没有字段。

允许客户通过代理预订堂食

NameCollection

此类型没有字段。

允许客服人员在会话期间收集客户姓名。

GetOrderPrices

此类型没有字段。

使代理能够从 POS 获取订单价格。

EndSessionWithCheckoutRequest

此类型没有字段。

允许代理通过结账请求结束会话。

EnableAddressCollection

此类型没有字段。

使客服人员能够在对话期间收集客户的配送地址。

SupportCashPayment

此类型没有字段。

使代理能够支持现金支付。

InteractionMode

代理的互动模式。

枚举
INTERACTION_MODE_UNSPECIFIED 互动模式未指定。
ORDER_TAKING 代理参与双向对话以接收订单。
LISTEN_ONLY 智能体只会聆听，不会说话。

DisambiguationStrategy

消除歧义控制的策略配置。

JSON 表示法 
{
  "mappings": [
    {
      object (DisambiguationMapping)
    }
  ]
}
字段
mappings[]

object (DisambiguationMapping)

可选。已配置的消歧映射。

DisambiguationMapping

用于更正无效字词或明确模糊不清的商品的映射规则。

JSON 表示法 
{
  "type": enum (Type),
  "customerTerms": [
    string
  ],
  "targets": [
    {
      object (TargetItem)
    }
  ],
  "customInstruction": string
}
字段
type

enum (Type)

必需。消歧规则的运作类型。
customerTerms[]

string

必需。客户话语或快捷字符串。每个客户条款不得超过 100 个字符。
targets[]

object (TargetItem)

必需。用于建议或澄清的全结构化目标菜单项，包括嵌套的修饰符。
customInstruction

string

可选。可选的自定义条件宏指令或措辞提示。

类型

消歧规则的运作类型。

枚举
TYPE_UNSPECIFIED 未指定规则类型。
SINGLE_TARGET 用于单目标映射（快捷方式、自定义组合配置或有效同义词）。
INVALID_ITEM 用于无效商品、缺货商品或竞争对手的产品。
DISAMBIGUATION 用于需要从多个有效目标选项中进行澄清的模糊输入。

TargetItem

结构化商品替代目标。

JSON 表示法 
{
  "itemName": string,
  "modifiers": [
    {
      object (TargetModifier)
    }
  ],
  "itemId": string
}
字段
itemName

string

必需。菜单目录中的商品名称。
modifiers[]

object (TargetModifier)

可选。要附加到相应目标结构的修饰符。
itemId

string

可选。菜单目录中商品的唯一 ID（直接关联到 menu.proto）。

TargetModifier

要应用于目标商品的结构化修饰符。

JSON 表示法 
{
  "modifierName": string,
  "modifierGroupName": string,
  "modifierId": string,
  "modifierGroupId": string
}
字段
modifierName

string

必需。与目录条目直接匹配的修饰符名称。
modifierGroupName

string

可选。用于绑定调节系数的可选调节系数组名称。
modifierId

string

可选。菜单目录中修饰符的唯一 ID（直接关联到 menu.proto）。
modifierGroupId

string

可选。菜单目录中修饰符组的唯一 ID。

州

频道配置的状态。

枚举
STATE_UNSPECIFIED 状态未指定。
DRAFT 频道配置为草稿，尚未准备就绪，无法使用。
ACTIVE 渠道配置处于有效状态，可以使用。
PROMOTED 渠道配置已升级。

类型

渠道配置的类型。

枚举
TYPE_UNSPECIFIED 类型未指定。
UPSELL_STRATEGY 渠道配置适用于追加销售策略。
AGENT_CUSTOMIZATION 渠道配置用于代理自定义。

SupplementalInstructions

补充说明的配置。

JSON 表示法 
{
  "freeformInstructions": string
}
字段
freeformInstructions

string

可选。提示中包含的自由格式指令。

语气

代理的语气。

枚举
TONE_UNSPECIFIED 语气未指定。
CONCISE_AND_DIRECT 智能体的语气简洁明了。
PROFESSIONAL_AND_FORMAL 智能体的语气专业且正式。
FRIENDLY 代理的语气友好。

方法

create

 创建 ChannelConfig。

delete

 删除指定的 ChannelConfig。

get

 获取 ChannelConfig。

list

 列出 ChannelConfig。

patch

 更新指定的 ChannelConfig。

promote

 提升指定渠道配置的级别。