Package google.cloud.foodorderingaiagent.v1beta

索引

• FoodOrderingService（接口）
• MenuService（接口）
• AgentAudio（消息）
• AgentEvent（消息）
• AgentText（消息）
• AudioInput（消息）
• Availability（消息）
• Availability.DaypartAvailability（消息）
• Availability.FulfillmentMethodAvailability（消息）
• Availability.MenuScheduleAvailability（消息）
• Availability.Status（枚举）
• BatchDeleteStoresRequest（消息）
• BatchGetMenuEntitiesRequest（消息）
• BatchGetMenuEntitiesResponse（消息）
• BatchUpdateStoresRequest（消息）
• BatchUpdateStoresResponse（消息）
• BidiProcessOrderRequest（消息）
• BidiProcessOrderResponse（消息）
• Brand（消息）
• BrandRevision（消息）
• ChannelConfig（消息）
• ChannelConfig.State（枚举）
• ChannelConfig.Tone（枚举）
• ChannelConfig.Type（枚举）
• ChannelConfigRevision（消息）
• ClientAppInfo（消息）
• ClientExecutionRequest（消息）
• ClientExecutionResult（消息）
• Config（消息）
• ConfigApplicationRule（消息）
• ConfigApplicationRuleRevision（消息）
• CreateBrandRequest（消息）
• CreateChannelConfigRequest（消息）
• CreateConfigApplicationRuleRequest（消息）
• CreateMenuRequest（消息）
• CreateStoreRequest（消息）
• DateRange（消息）
• DeleteBrandRequest（消息）
• DeleteBrandRevisionRequest（消息）
• DeleteChannelConfigRequest（消息）
• DeleteChannelConfigRevisionRequest（消息）
• DeleteConfigApplicationRuleRequest（消息）
• DeleteConfigApplicationRuleRevisionRequest（消息）
• DeleteMenuRequest（消息）
• DeleteStoreRequest（消息）
• DeleteStoreRevisionRequest（消息）
• EndSession（消息）
• EndSession.EndType（枚举）
• EventInput（消息）
• EventInput.CallerHangupEvent（消息）
• EventInput.ClientEscalationEvent（消息）
• EventInput.CrewInterjectionEvent（消息）
• EventInput.CustomizedInputEvent（消息）
• EventInput.DriveOffEvent（消息）
• EventInput.OrderStateUpdateEvent（消息）
• FeatureGate（消息）
• FinalizeOrderRequest（消息）
• FinalizeOrderResponse（消息）
• FulfillmentMethod（枚举）
• GetBrandRequest（消息）
• GetBrandRevisionRequest（消息）
• GetChannelConfigRequest（消息）
• GetChannelConfigRevisionRequest（消息）
• GetConfigApplicationRuleRequest（消息）
• GetConfigApplicationRuleRevisionRequest（消息）
• GetMenuRequest（消息）
• GetStoreRequest（消息）
• GetStoreRevisionRequest（消息）
• Image（消息）
• InterruptionSignal（消息）
• Item（消息）
• ItemIntegrationAttributes（消息）
• ItemIntegrationAttributes.StreamIntegrationAttributes（消息）
• ItemIntegrationAttributes.StreamIntegrationAttributes.Tax（消息）
• ItemIntegrationAttributes.ToastIntegrationAttributes（消息）
• ListBrandRevisionsRequest（消息）
• ListBrandRevisionsResponse（消息）
• ListBrandsRequest（消息）
• ListBrandsResponse（消息）
• ListChannelConfigRevisionsRequest（消息）
• ListChannelConfigRevisionsResponse（消息）
• ListChannelConfigsRequest（消息）
• ListChannelConfigsResponse（消息）
• ListConfigApplicationRuleRevisionsRequest（消息）
• ListConfigApplicationRuleRevisionsResponse（消息）
• ListConfigApplicationRulesRequest（消息）
• ListConfigApplicationRulesResponse（消息）
• ListMenusRequest（消息）
• ListMenusResponse（消息）
• ListStoreRevisionsRequest（消息）
• ListStoreRevisionsResponse（消息）
• ListStoresRequest（消息）
• ListStoresResponse（消息）
• LoyaltyAmount（消息）
• LoyaltyInfo（消息）
• Menu（消息）
• MenuCategory（消息）
• MenuLabel（消息）
• MenuSchedule（消息）
• MenuView（枚举）
• Modifier（消息）
• ModifierAction（消息）
• ModifierConstraints（消息）
• ModifierGroup（消息）
• ModifierGroupIntegrationAttributes（消息）
• ModifierGroupIntegrationAttributes.ToastModifierGroupIntegrationAttributes（消息）
• ModifierGroupReference（消息）
• ModifierGroupReference.DefaultModifierSelection（消息）
• ModifierIntegrationAttributes（消息）
• ModifierIntegrationAttributes.ToastModifierIntegrationAttributes（消息）
• Order（消息）
• OrderFulfillment（消息）
• OrderItem（消息）
• OrderMetadata（消息）
• OrderModifier（消息）
• OrderModifierAction（消息）
• OrderModifierGroup（消息）
• OrderPayment（消息）
• OrderPriceInfo（消息）
• OrderType（枚举）
• PastOrder（消息）
• PaymentInfo（消息）
• PaymentMethod（枚举）
• PromoteChannelConfigRequest（消息）
• PromoteChannelConfigResponse（消息）
• RecommendedOrder（消息）
• RecommendedOrders（消息）
• RestartOrder（消息）
• Schedule（消息）
• SentimentMeasurement（消息）
• SpeechRecognition（消息）
• Store（消息）
• StoreHours（消息）
• StoreMetadata（消息）
• StoreMetadata.Address（消息）
• StoreMetadata.Daypart（消息）
• StoreRevision（消息）
• StoreStatus（消息）
• StoreStatus.State（枚举）
• SubmitOrderRequest（消息）
• SubmitOrderResponse（消息）
• SuggestedItem（消息）
• SuggestedItems（消息）
• SuggestedModifier（消息）
• SuggestedModifiers（消息）
• SuggestedOptions（消息）
• TextInput（消息）
• TimeOfDayRange（消息）
• TippingInfo（消息）
• TurnCompleted（消息）
• UpdateBrandRequest（消息）
• UpdateChannelConfigRequest（消息）
• UpdateConfigApplicationRuleRequest（消息）
• UpdateStoreRequest（消息）
• UpdatedOrderState（消息）
• UserInfo（消息）

FoodOrderingService

FoodOrderingService 为订餐代理提供 API。

BidiProcessOrder
rpc BidiProcessOrder(BidiProcessOrderRequest) returns (BidiProcessOrderResponse) 一种双向流式传输 API，可处理多种模态（例如文本、音频）的持续客户端输入，并生成实时多模态输出流。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

MenuService

MenuService 提供用于管理品牌、商店和菜单相关资源的 API。

BatchDeleteStores
rpc BatchDeleteStores(BatchDeleteStoresRequest) returns (Empty) 批量删除商店。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

BatchGetMenuEntities
rpc BatchGetMenuEntities(BatchGetMenuEntitiesRequest) returns (BatchGetMenuEntitiesResponse) 批量获取菜单的实体。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

BatchUpdateStores
rpc BatchUpdateStores(BatchUpdateStoresRequest) returns (BatchUpdateStoresResponse) 批量更新商店。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateBrand
rpc CreateBrand(CreateBrandRequest) returns (Brand) 创建品牌。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateChannelConfig
rpc CreateChannelConfig(CreateChannelConfigRequest) returns (ChannelConfig) 创建 ChannelConfig。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateConfigApplicationRule
rpc CreateConfigApplicationRule(CreateConfigApplicationRuleRequest) returns (ConfigApplicationRule) 创建 ConfigApplicationRule。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateMenu
rpc CreateMenu(CreateMenuRequest) returns (Menu) 创建菜单。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

CreateStore
rpc CreateStore(CreateStoreRequest) returns (Store) 创建存储区。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteBrand
rpc DeleteBrand(DeleteBrandRequest) returns (Empty) 删除指定的品牌。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteBrandRevision
rpc DeleteBrandRevision(DeleteBrandRevisionRequest) returns (Empty) 删除指定的 BrandRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteChannelConfig
rpc DeleteChannelConfig(DeleteChannelConfigRequest) returns (Empty) 删除指定的 ChannelConfig。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteChannelConfigRevision
rpc DeleteChannelConfigRevision(DeleteChannelConfigRevisionRequest) returns (Empty) 删除指定的 ChannelConfigRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteConfigApplicationRule
rpc DeleteConfigApplicationRule(DeleteConfigApplicationRuleRequest) returns (Empty) 删除指定的 ConfigApplicationRule。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteConfigApplicationRuleRevision
rpc DeleteConfigApplicationRuleRevision(DeleteConfigApplicationRuleRevisionRequest) returns (Empty) 删除指定的 ConfigApplicationRuleRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteMenu
rpc DeleteMenu(DeleteMenuRequest) returns (Empty) 删除指定的菜单。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteStore
rpc DeleteStore(DeleteStoreRequest) returns (Empty) 删除指定的商店。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

DeleteStoreRevision
rpc DeleteStoreRevision(DeleteStoreRevisionRequest) returns (Empty) 删除指定的 StoreRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetBrand
rpc GetBrand(GetBrandRequest) returns (Brand) 获取品牌。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetBrandRevision
rpc GetBrandRevision(GetBrandRevisionRequest) returns (BrandRevision) 获取 BrandRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetChannelConfig
rpc GetChannelConfig(GetChannelConfigRequest) returns (ChannelConfig) 获取 ChannelConfig。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetChannelConfigRevision
rpc GetChannelConfigRevision(GetChannelConfigRevisionRequest) returns (ChannelConfigRevision) 获取 ChannelConfigRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetConfigApplicationRule
rpc GetConfigApplicationRule(GetConfigApplicationRuleRequest) returns (ConfigApplicationRule) 获取 ConfigApplicationRule。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetConfigApplicationRuleRevision
rpc GetConfigApplicationRuleRevision(GetConfigApplicationRuleRevisionRequest) returns (ConfigApplicationRuleRevision) 获取 ConfigApplicationRuleRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetMenu
rpc GetMenu(GetMenuRequest) returns (Menu) 获取菜单。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetStore
rpc GetStore(GetStoreRequest) returns (Store) 获取商店。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

GetStoreRevision
rpc GetStoreRevision(GetStoreRevisionRequest) returns (StoreRevision) 获取 StoreRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListBrandRevisions
rpc ListBrandRevisions(ListBrandRevisionsRequest) returns (ListBrandRevisionsResponse) 列出 BrandRevisions。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListBrands
rpc ListBrands(ListBrandsRequest) returns (ListBrandsResponse) 列出品牌。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListChannelConfigRevisions
rpc ListChannelConfigRevisions(ListChannelConfigRevisionsRequest) returns (ListChannelConfigRevisionsResponse) 列出 ChannelConfigRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListChannelConfigs
rpc ListChannelConfigs(ListChannelConfigsRequest) returns (ListChannelConfigsResponse) 列出 ChannelConfig。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListConfigApplicationRuleRevisions
rpc ListConfigApplicationRuleRevisions(ListConfigApplicationRuleRevisionsRequest) returns (ListConfigApplicationRuleRevisionsResponse) 列出 ConfigApplicationRuleRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListConfigApplicationRules
rpc ListConfigApplicationRules(ListConfigApplicationRulesRequest) returns (ListConfigApplicationRulesResponse) 列出 ConfigApplicationRule。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListMenus
rpc ListMenus(ListMenusRequest) returns (ListMenusResponse) 列出菜单。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListStoreRevisions
rpc ListStoreRevisions(ListStoreRevisionsRequest) returns (ListStoreRevisionsResponse) 列出 StoreRevision。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

ListStores
rpc ListStores(ListStoresRequest) returns (ListStoresResponse) 列出商店。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

PromoteChannelConfig
rpc PromoteChannelConfig(PromoteChannelConfigRequest) returns (PromoteChannelConfigResponse) 提升指定渠道配置的级别。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

UpdateBrand
rpc UpdateBrand(UpdateBrandRequest) returns (Brand) 更新指定的品牌。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

UpdateChannelConfig
rpc UpdateChannelConfig(UpdateChannelConfigRequest) returns (ChannelConfig) 更新指定的 ChannelConfig。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

UpdateConfigApplicationRule
rpc UpdateConfigApplicationRule(UpdateConfigApplicationRuleRequest) returns (ConfigApplicationRule) 更新指定的 ConfigApplicationRule。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

UpdateStore
rpc UpdateStore(UpdateStoreRequest) returns (Store) 更新指定的商店。 授权范围 需要以下 OAuth 范围： https://www.googleapis.com/auth/cloud-platform 如需了解详情，请参阅 Authentication Overview。

AgentAudio

代理的音频回答。

字段
agent_audio	bytes 来自代理的音频数据。

AgentEvent

来自代理的特别活动，需要客户端采取行动。

字段
联合字段 event。来自代理的事件。event 只能是下列其中一项：
restart_order	RestartOrder 客户请求重新开始订单。

AgentText

代理的文本回答。

字段
text	string 代理的文本回答。

AudioInput

来自客户端的音频输入。输入音频可能包含多个声道，分别用于客户、机组人员等。这些声道应全部同步，并且采用配置中指定的格式。不得包含音频标题。默认情况下，音频应使用 16 位线性 PCM 音频编码和 16000 Hz 采样率。所有渠道的总字节数应小于 25,600 字节。

字段
customer_audio	bytes 必需。客户音频数据。
crew_audio	bytes 可选。机组人员音频数据。这是与客户位于同一车道的乘务员的可选音频渠道，用作回声消除的参考音频。

可用性

定义商品或加项的供应情况。

字段
daypart_availability	DaypartAvailability 可选。相应商品的日内时段级提供情况信息。如果省略，系统会忽略基于时段的有效性。
menu_schedule_availability	MenuScheduleAvailability 可选。相应商品的菜单时间表级提供情况信息。如果省略，则忽略基于菜单时间表的可用性。
status	Status 可选。表示导致商品无法使用的状态，或表示商品可供使用。如果省略，则默认情况下该商品处于有效状态。
fulfillment_availability	FulfillmentMethodAvailability 可选。相应商品的配送方式。如果省略，则表示该商品适用于所有配送方式。

DaypartAvailability

将相应实体的可用性限制为指定的时间段。

字段
daypart_ids[]	string 必需。相应商品可供购买的时段。

FulfillmentMethodAvailability

将相应实体的可用性限制为指定的配送方式。

字段
fulfillment_methods[]	FulfillmentMethod 必需。相应商品的配送方式。

MenuScheduleAvailability

将相应实体的供应情况限制为指定的菜单时间表。

字段
menu_schedule_ids[]	string 必需。此商品可供购买的菜单时间表。

状态

可用性状态。

枚举
STATUS_UNSPECIFIED	状态无效。如果任何商品或修饰符具有此状态，CreateMenu 将失败。
STATUS_AVAILABLE	表示相应商品可供购买。
STATUS_UNAVAILABLE	表示商品因原因不明而无法提供。
STATUS_OUT_OF_STOCK	表示商品目前缺货，但可能很快就会有货。
STATUS_DISCONTINUED	表示相应商品已停产，在可预见的未来将一直处于缺货状态。

BatchDeleteStoresRequest

MenuService.BatchDeleteStores 的请求消息。

字段
parent	string 必需。所有实体店共享的父级资源。格式：projects/{project}/locations/{location}/brands/{brand}
names[]	string 必需。要删除的商店的名称。您最多可以批量删除 1,000 家商店。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}

BatchGetMenuEntitiesRequest

MenuService.BatchGetMenuEntities 的请求消息。

字段
parent	string 必需。要从中检索实体的菜单的名称。格式：projects/{project}/locations/{location}/menus/{menu}
item_ids[]	string 可选。要检索的商品的 ID。
modifier_ids[]	string 可选。要检索的修饰符的 ID。
modifier_group_ids[]	string 可选。要检索的修饰符组的 ID。
category_ids[]	string 可选。要检索的类别的 ID。

BatchGetMenuEntitiesResponse

MenuService.BatchGetMenuEntities 的响应消息。

字段
items[]	Item 所请求的商品。
modifiers[]	Modifier 所请求的修饰符。
modifier_groups[]	ModifierGroup 所请求的修饰符组。
categories[]	MenuCategory 所请求的类别。

BatchUpdateStoresRequest

MenuService.BatchUpdateStores 的请求消息。

字段
parent	string 必需。所有正在更新的实体店共享的父级资源。格式：projects/{project}/locations/{location}/brands/{brand} 如果设置了此字段，则 requests 中指定的所有商店的父级都必须与此字段匹配。
requests[]	UpdateStoreRequest 必需。指定要更新的资源的请求消息。一个批次最多可以修改 1,000 家商店。

BatchUpdateStoresResponse

MenuService.BatchUpdateStores 的响应消息。

字段
stores[]	Store 商店已更新。

BidiProcessOrderRequest

客户端为 FoodOrderingService.BidiProcessOrder 方法发送的顶级消息。

字段
联合字段 message。来自客户端的消息。客户端必须先发送配置消息，然后再发送任何其他消息。message 只能是下列其中一项：
config	Config 会话和订餐属性的配置。
text_input	TextInput 来自客户端的文本输入。
audio_input	AudioInput 来自客户端的音频输入。客户端必须使用文本或音频输入，但不能同时使用这两种输入。
event_input	EventInput 来自客户端的事件输入。
client_execution_result	ClientExecutionResult 客户端执行请求的结果。

BidiProcessOrderResponse

从 FoodOrderingService.BidiProcessOrder 方法返回的顶级消息。

字段
联合字段 response。代理的回答。response 只能是下列其中一项：
agent_audio	AgentAudio 代理的音频回答。
speech_recognition	SpeechRecognition 来自代理的语音识别结果。
legacy_order_state_response	Struct 会话的旧版订单状态响应。
interruption_signal	InterruptionSignal 检测到音频输入中的中断信号。
agent_event	AgentEvent 来自代理的事件。
client_execution_request	ClientExecutionRequest 将请求转发给客户端以供执行。用于客户端执行，例如向订单添加代码。
updated_order_state	UpdatedOrderState 表示订单状态的更新。包含订单的完整状态。
agent_text	AgentText 代理的文本回答。
suggested_options	SuggestedOptions 可向客户建议的选项。
sentiment_measurement	SentimentMeasurement 针对此轮对话测量的实时情感得分。
turn_completed	TurnCompleted “Turn Completed”消息。
end_session	EndSession 表示会话即将结束，并且这是最后一轮对话。 代理将完成发送当前回合的所有待处理响应，然后发送最终的 turn_completed 消息。代理不会开始任何新的对话轮次。例如，一个 2 轮会话将如下所示： 第 1 回合 客户输入 1 … 代理响应和订单状态消息 turn_completed Turn 2 客户输入 2 … 代理响应和订单状态消息 end_session ... 待处理的代理响应和订单状态消息 turn_completed
recommended_orders	RecommendedOrders 代理提供的推荐顺序。

品牌

品牌，可以是连锁餐厅，也可以是单家餐厅。

字段
name	string 标识符。品牌名称。格式：projects/{project}/locations/{location}/brands/{brand}
display_name	string 可选。（可选）此品牌在用户界面中显示的人类可读显示名称。
create_time	Timestamp 仅限输出。相应品牌的创建时间。
update_time	Timestamp 仅限输出。相应品牌的上次更新时间。

BrandRevision

品牌修订。

字段
name	string 标识符。品牌修订版本的资源名称。格式：projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}
snapshot	Brand 仅限输出。相应修订版本中的品牌资源的状态。
create_time	Timestamp 仅限输出。修订版本的创建时间。
created_by	string 仅限输出。最近创建相应资源的用户所用的电子邮件地址。
alternate_ids[]	string 仅限输出。相应修订版本的备用 ID。

ChannelConfig

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

字段
name	string 标识符。渠道配置名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}
display_name	string 可选。此渠道配置在界面中的可选显示名称。值不得超过 63 个字符。
create_time	Timestamp 仅限输出。相应渠道配置的创建时间。
update_time	Timestamp 仅限输出。相应频道配置的上次更新时间。
state	State 仅限输出。频道配置的状态。
type	Type 必需。渠道配置的类型。
tone	Tone 可选。代理的语气。
config_application_rules[]	ConfigApplicationRule 仅限输出。与此渠道配置关联的配置应用规则。

州

频道配置的状态。

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

语气

代理的语气。

枚举
TONE_UNSPECIFIED	语气未指定。
CONCISE_AND_DIRECT	智能体的语气简洁明了。
PROFESSIONAL_AND_FORMAL	客服人员的语气专业且正式。
FRIENDLY	客服人员的语气很友好。

类型

渠道配置的类型。

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

ChannelConfigRevision

频道配置的修订版本。

字段
name	string 标识符。渠道配置修订版本的资源名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}
snapshot	ChannelConfig 仅限输出。相应修订版本中渠道配置资源的状态。
create_time	Timestamp 仅限输出。修订版本的创建时间。
created_by	string 仅限输出。最近创建相应资源的用户所用的电子邮件地址。
alternate_ids[]	string 仅限输出。相应修订版本的备用 ID。

ClientAppInfo

有关客户端应用和设备环境的信息。这主要用于日志记录、分析和调试。

字段
device_model	string 可选。客户端的设备型号（例如“iPhone 13”“Pixel 7”“Kiosk v2”）。
os_version	string 可选。客户端的操作系统版本（例如“iOS 16.1”“Android 13”）。
sdk_version	string 可选。客户端 SDK 或应用软件的版本。

ClientExecutionRequest

请求客户端执行命令。

字段
execution_id	string 必需。相应执行请求的唯一 ID。
联合字段 request。要执行的具体请求。request 只能是下列其中一项：
finalize_order_request	FinalizeOrderRequest 用于最终确定订单的请求。
submit_order_request	SubmitOrderRequest 提交订单的请求。

ClientExecutionResult

客户端执行请求的结果。

字段
execution_id	string 必需。相应结果所对应的执行请求的 ID。
联合字段 response。执行的具体结果。response 只能是下列其中一项：
finalize_order_response	FinalizeOrderResponse 完成订单的结果。
submit_order_response	SubmitOrderResponse 提交订单的结果。

配置

会话和订餐属性的配置。在每次连接开始时，客户端必须先发送一条配置消息。此请求必须在任何其他用于启动会话的请求之前发送。如果客户端断开连接，则在重新连接时应重复发送相同的配置消息。

字段
session	string 必需。相应订单的会话。格式：projects/{project}/locations/{location}/sessions/{session}
store	string 必需。要下单的商店。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}
lane_id	string 可选。特定驾车通道的 ID。
enable_echo_cancellation	bool 可选。是否为会话启用回声消除功能。如果启用，客户端应在 AudioInput 中提供 customer_audio 和 crew_audio。
daypart_id	string 可选。食品菜单的餐段，包括早餐、午餐、晚餐等。用于确定订单所用的菜单。
user_info	UserInfo 可选。与代理分享的最终用户的个人信息。
order_type (deprecated)	OrderType 此项已弃用！ 可选。已弃用：请改用 initial_order.fulfillment.fulfillment_type。要下的订单类型。
initial_order	Order 可选。开始代理会话之前的初始订单。如果提供，代理将使用它作为初始订单状态。
feature_gate	FeatureGate 可选。相应会话的功能门控。用于为会话启用或停用功能。
initial_utterance	string 可选。客户为启动对话而说的第一句话。如果提供，代理将使用此内容作为用户的第一个话语，而不会从问候消息开始。
client_app_info	ClientAppInfo 可选。有关客户端应用和设备环境的信息。

ConfigApplicationRule

表示何时应用代理配置的规则。

字段
name	string 标识符。配置应用规则名称。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}
display_name	string 可选。此配置应用规则在界面中的可选显示名称。值不得超过 63 个字符。
create_time	Timestamp 仅限输出。相应配置应用规则的创建时间。
update_time	Timestamp 仅限输出。相应配置应用规则的上次更新时间。

ConfigApplicationRuleRevision

配置应用规则的修订版本。

字段
name	string 标识符。配置应用规则修订版本的资源名称。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}
snapshot	ConfigApplicationRule 仅限输出。相应修订版本中的配置应用规则资源的状态。
create_time	Timestamp 仅限输出。修订版本的创建时间。
created_by	string 仅限输出。最近创建相应资源的用户所用的电子邮件地址。
alternate_ids[]	string 仅限输出。相应修订版本的备用 ID。

CreateBrandRequest

MenuService.CreateBrand 的请求消息。

字段
parent	string 必需。拥有此品牌集合的父级。格式：projects/{project}/locations/{location}
brand	Brand 必需。要创建的品牌。
brand_id	string 可选。要用于品牌的 ID，该 ID 将成为品牌资源名称的最后一个组成部分。 此值只能包含小写字母、数字和连字符，第一个和最后一个字符必须是字母或数字，且长度不得超过 63 个字符。

CreateChannelConfigRequest

MenuService.CreateChannelConfig 的请求消息。

字段
parent	string 必需。拥有此频道配置集合的父品牌。格式：projects/{project}/locations/{location}/brands/{brand}
channel_config	ChannelConfig 必需。要创建的渠道配置。
channel_config_id	string 可选。要用于渠道配置的 ID，该 ID 将成为渠道配置资源名称的最后一个组成部分。 此值应仅包含小写字母、数字和连字符，且长度不得超过 63 个字符。第一个字符必须是字母，最后一个字符必须是字母或数字。

CreateConfigApplicationRuleRequest

MenuService.CreateConfigApplicationRule 的请求消息。

字段
parent	string 必需。拥有此配置应用规则集合的父品牌。格式：projects/{project}/locations/{location}/brands/{brand}
config_application_rule	ConfigApplicationRule 必需。要创建的配置应用规则。
config_application_rule_id	string 可选。要用于配置应用规则的 ID，该 ID 将成为配置应用规则资源名称的最后一个组成部分。 此值只能包含小写字母、数字和连字符，第一个和最后一个字符必须是字母或数字，且长度不得超过 63 个字符。

CreateMenuRequest

MenuService.CreateMenu 的请求消息。

字段
parent	string 必需。拥有此菜单集合的父级。格式：projects/{project}/locations/{location}
menu_id	string 可选。要用于菜单的 ID，该 ID 将成为菜单资源名称的最后一个组成部分。 此值只能包含小写字母、数字和连字符，第一个和最后一个字符必须是字母或数字，且长度不得超过 63 个字符。
menu	Menu 必需。要创建的菜单。

CreateStoreRequest

MenuService.CreateStore 的请求消息。

字段
parent	string 必需。拥有此商店集合的父品牌。格式：projects/{project}/locations/{location}/brands/{brand}
store_id	string 可选。要用于存储区的存储区 ID，该 ID 将成为存储区资源名称的最后一个组成部分。 此值只能包含小写字母、数字和连字符，第一个和最后一个字符必须是字母或数字，且长度不得超过 63 个字符。
store	Store 必需。要创建的商店。

DateRange

表示一个日期范围，包括开始日期和结束日期。

字段
start_date	Date 必需。范围的开始日期（含）。
end_date	Date 必需。范围的结束日期（含）。

DeleteBrandRequest

MenuService.DeleteBrand 的请求消息。

字段
name	string 必需。要删除的品牌的名称。格式：projects/{project}/locations/{location}/brands/{brand}

DeleteBrandRevisionRequest

MenuService.DeleteBrandRevision 的请求消息。

字段
name	string 必需。要删除的品牌修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

DeleteChannelConfigRequest

MenuService.DeleteChannelConfig 的请求消息。

字段
name	string 必需。要删除的渠道配置的名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

DeleteChannelConfigRevisionRequest

MenuService.DeleteChannelConfigRevision 的请求消息。

字段
name	string 必需。要删除的渠道配置修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

DeleteConfigApplicationRuleRequest

MenuService.DeleteConfigApplicationRule 的请求消息。

字段
name	string 必需。要删除的配置应用规则的名称。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

DeleteConfigApplicationRuleRevisionRequest

MenuService.DeleteConfigApplicationRuleRevision 的请求消息。

字段
name	string 必需。要删除的配置应用规则修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

DeleteMenuRequest

MenuService.DeleteMenu 的请求消息。

字段
name	string 必需。要删除的菜单的名称。格式：projects/{project}/locations/{location}/menus/{menu}

DeleteStoreRequest

MenuService.DeleteStore 的请求消息。

字段
name	string 必需。要删除的存储区的名称。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}

DeleteStoreRevisionRequest

MenuService.DeleteStoreRevision 的请求消息。

字段
name	string 必需。要删除的商店修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

EndSession

表示客服人员已终止会话，原因可能是成功完成（例如，用户说“再见！”）或智能体升级。

字段
type	EndType 结束会话事件的类型。
reason	string 结束会话的原因。

EndType

结束会话事件的类型。

枚举
END_TYPE_UNSPECIFIED	未指定结束类型。
DRIVE_OFF	客户开车离开了。
AGENT_ESCALATION	客服人员将对话上报给了人工客服。
CREW_INTERJECTION	有队员在会话中插话。
ORDER_COMPLETED	订单已成功完成，无需采取进一步行动。
PAYMENT_FLOW_SUCCESS	付款流程已成功完成，无需采取进一步操作。
PAYMENT_FLOW_FAILURE	付款流程失败。
CLIENT_ESCALATION	客户将对话升级为人工客服会话。
CALLER_HANGUP	客户过早挂断了电话。

EventInput

来自客户端的事件输入。用于触发代理中的特定事件。

字段
联合字段 event。Next ID: 9 要触发的事件。event 只能是下列其中一项：
drive_off_event	DriveOffEvent 驶离事件。
crew_interjection_event	CrewInterjectionEvent 乘务员插话事件。
update_order_state_event	OrderStateUpdateEvent 对订单状态的客户端更新。
client_escalation_event	ClientEscalationEvent 客户端升级事件。
customized_input_event	CustomizedInputEvent 自定义输入事件。
caller_hangup_event	CallerHangupEvent 可选。来电者挂断电话事件。

CallerHangupEvent

此类型没有字段。

表示客户过早挂断了电话（例如，对 AI 感到反感）。

ClientEscalationEvent

表示客户端正在将对话升级到人工客服。

字段
reason	string 可选。客户升级的原因，例如“payment-declined”“pos-error”“integration-error”等。

CrewInterjectionEvent

机组人员插话事件。这表示有剧组人员在会话中插话。此活动结束后，会话将关闭。

字段
mode	string 可选。机组人员插话的模式，例如“耳机”“POS”。

CustomizedInputEvent

此字段可让 Food AI 客户端向代理发送自定义事件。默认情况下，它是一个空操作。请与客户支持团队联系以启用此功能。

字段
input	Struct 必需。客户端向代理提供的输入内容。

DriveOffEvent

驶离事件。表示客户已驾车离开。此事件发生后，会话将关闭。

字段
reason	string 可选。驶离的原因，例如“订单完成”“意外驶离”。

OrderStateUpdateEvent

更新订单状态请求。当订单在客户端更新时（例如通过传统触摸界面添加或移除商品时），应发送此事件。

字段
order	Order 必需。与相应会话关联的订单的更新状态。

FeatureGate

相应会话的功能门控。用于为会话启用或停用功能。

字段
trigger_offer_engine_on_demand	bool 可选。仅限有限的受众群体，如果设置了此值，则在付款流程中，优惠引擎将是可选的，并且仅在用户请求时触发。
trigger_loyalty_on_demand	bool 可选。仅限部分受众群体，如果设置了此值，则在付款流程中，会员奖励将是可选的，并且仅在用户请求时触发。
trigger_order_media_assistant_on_demand	bool 可选。仅限小范围受众群体，如果设置，订购媒体助理将是可选的，并且仅在用户提出请求时触发。
menu_response_enabled	bool 可选。如果已设置，则以 BidiProcessOrderResponse 形式将菜单数据返回给客户端。
revamped_payment_flow_enabled	bool 可选。仅限部分受众群体，如果设置，将使用改版后的付款流程。

FinalizeOrderRequest

此类型没有字段。

用于最终确定订单的请求。

FinalizeOrderResponse

完成订单的结果。

字段
payment_flow_enabled	bool 可选。是否在代理中启用付款处理流程。
payment_info	PaymentInfo 可选。客户的支付信息。如果 payment_flow_enabled 为 false，则不执行任何操作。
total_amount_due	Money 可选。订单的应付总金额。

FulfillmentMethod

订单的履单方式。

枚举
FULFILLMENT_METHOD_UNSPECIFIED	未指定配送方式。
FULFILLMENT_METHOD_DINE_IN	客户在实体店中消费的订单。
FULFILLMENT_METHOD_PICKUP	客户将在实体店自提的订单。
FULFILLMENT_METHOD_DRIVE_THRU	在汽车餐厅下订单。
FULFILLMENT_METHOD_DELIVERY	将交付给客户的订单。
FULFILLMENT_METHOD_CURBSIDE	路边自取订单。客户将车停在商店外的指定地点，然后等待工作人员将订单送出。

GetBrandRequest

MenuService.GetBrand 的请求消息。

字段
name	string 必需。要检索的品牌的名称。格式：projects/{project}/locations/{location}/brands/{brand}

GetBrandRevisionRequest

MenuService.GetBrandRevision 的请求消息。

字段
name	string 必需。要检索的品牌修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/revisions/{revision}

GetChannelConfigRequest

MenuService.GetChannelConfig 的请求消息。

字段
name	string 必需。要检索的渠道配置的名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}

GetChannelConfigRevisionRequest

MenuService.GetChannelConfigRevision 的请求消息。

字段
name	string 必需。要检索的渠道配置修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}/revisions/{revision}

GetConfigApplicationRuleRequest

MenuService.GetConfigApplicationRule 的请求消息。

字段
name	string 必需。要检索的配置应用规则的名称。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}

GetConfigApplicationRuleRevisionRequest

MenuService.GetConfigApplicationRuleRevision 的请求消息。

字段
name	string 必需。要检索的配置应用规则修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}/revisions/{revision}

GetMenuRequest

MenuService.GetMenu 的请求消息。

字段
name	string 必需。要检索的菜单的名称。格式：projects/{project}/locations/{location}/menus/{menu}

GetStoreRequest

MenuService.GetStore 的请求消息。

字段
name	string 必需。要检索的商店的名称。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}

GetStoreRevisionRequest

MenuService.GetStoreRevision 的请求消息。

字段
name	string 必需。要检索的商店修订版本的名称。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}

图片

要为菜单实体显示的图片。

字段
source_uri	string 必需。图片的来源 URI。

InterruptionSignal

此类型没有字段。

表示代理的音频回答已被中断（例如被最终用户抢先发言）。客户端应立即停止播放。

项

商品表示菜单实体，仅在订单中作为顶级商品有效。商品可以代表单个食品、饮料、服务、促销活动或套餐，这些商品可以通过各种选项进行修改。

字段
id	string 必需。相应项的标识符，在菜单中是唯一的。
semantic_name	string 可选。简明直观的名称，可清晰明确地标识相应商品。在菜单中的商品之间应该是唯一的。
display_name	string 必需。要在界面中使用的相应商品的人类可读名称。
category_ids[]	string 可选。商品的类别。
description	string 可选。人类可读的说明。
image	Image 可选。要在界面中为此商品显示的图片。
availability	Availability 可选。推荐项的可用性。
base_price	Money 可选。商品的基本价格。这可能会受到所选修饰符的影响。
integration_attributes	ItemIntegrationAttributes 可选。与此实体关联的元数据，用于下游集成。
modifier_groups[]	ModifierGroupReference 可选。适用于相应商品的修饰符组的引用。
modifier_constraints	ModifierConstraints 可选。限制了可 / 必须跨引用的 ModifierGroup 应用于此项的修饰符。

ItemIntegrationAttributes

与用于下游集成的商品关联的元数据。

字段
custom_integration_attributes	Struct 可选。要与实体关联的任意元数据，用于构建下游集成，即用于构建订单以提交给第三方销售终端 API 的标识符或架构信息。
stream_attributes	StreamIntegrationAttributes 可选。表示与此项相关联的元数据，用于 Stream 集成。如果商店未启用 Stream 集成，系统会忽略此字段。
toast_attributes	ToastIntegrationAttributes 可选。表示与此项关联的元数据，用于 Toast 集成。如果商店未启用 Toast 集成，则系统会忽略此字段。

StreamIntegrationAttributes

表示来自 Stream 菜单的商品的属性。

字段
taxes[]	Tax 可选。表示适用于相应商品的税率。
item_family_id	string 可选。表示 Stream 菜单中包含相应商品款式的商品系列。

税费

与相应商品相关联的税率信息。

字段
stream_id	string 必需。Stream 菜单中的税费 ID。
is_inclusive	bool 可选。确定税费金额是否已包含在商品价格中
rate	float 必需。税率（以百分比表示）。
display_name	string 可选。税费的名称。
is_default	bool 可选。相应税费是否为默认税费。

ToastIntegrationAttributes

表示 Toast 菜单中商品的属性。

字段
menu_group_guid	string 可选。表示 Toast 菜单中相应项的菜单组 GUID。

ListBrandRevisionsRequest

MenuService.ListBrandRevisions 的请求消息。

字段
parent	string 必需。拥有此修订版本集合的父品牌。格式：projects/{project}/locations/{location}/brands/{brand}
page_size	int32 可选。要返回的修订版本数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListBrandRevisions 调用接收的页面令牌。利用其进行后续页面检索。

ListBrandRevisionsResponse

MenuService.ListBrandRevisions 的响应消息。

字段
brand_revisions[]	BrandRevision 指定集合中的品牌修订版本。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListBrandsRequest

MenuService.ListBrands 的请求消息。

字段
parent	string 必需。拥有此品牌集合的父级。格式：projects/{project}/locations/{location}
page_size	int32 可选。要返回的品牌数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListBrands 调用接收的页面令牌。利用其进行后续页面检索。

ListBrandsResponse

MenuService.ListBrands 的响应消息。

字段
brands[]	Brand 指定集合中的品牌。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListChannelConfigRevisionsRequest

MenuService.ListChannelConfigRevisions 的请求消息。

字段
parent	string 必需。拥有相应修订版本集合的父渠道配置。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}
page_size	int32 可选。要返回的修订版本数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListChannelConfigRevisions 调用接收的页面令牌。利用其进行后续页面检索。

ListChannelConfigRevisionsResponse

MenuService.ListChannelConfigRevisions 的响应消息。

字段
channel_config_revisions[]	ChannelConfigRevision 指定集合中的渠道配置修订版本。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListChannelConfigsRequest

MenuService.ListChannelConfigs 的请求消息。

字段
parent	string 必需。拥有此频道配置集合的父品牌。格式：projects/{project}/locations/{location}/brands/{brand}
page_size	int32 可选。要返回的渠道配置数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListChannelConfigs 调用接收的页面令牌。利用其进行后续页面检索。
filter	string 可选。用于过滤结果的过滤表达式。有关表达式语法的文档，请参阅 https://google.aip.dev/160。 支持以下字段：- type 示例：- type="AGENT_CUSTOMIZATION"

ListChannelConfigsResponse

MenuService.ListChannelConfigs 的响应消息。

字段
channel_configs[]	ChannelConfig 指定集合中的渠道配置。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListConfigApplicationRuleRevisionsRequest

MenuService.ListConfigApplicationRuleRevisions 的请求消息。

字段
parent	string 必需。拥有此修订版本集合的父级配置应用规则。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}
page_size	int32 可选。要返回的修订版本数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListConfigApplicationRuleRevisions 调用接收的页面令牌。利用其进行后续页面检索。

ListConfigApplicationRuleRevisionsResponse

MenuService.ListConfigApplicationRuleRevisions 的响应消息。

字段
config_application_rule_revisions[]	ConfigApplicationRuleRevision 指定集合中的配置应用规则修订版本。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListConfigApplicationRulesRequest

MenuService.ListConfigApplicationRules 的请求消息。

字段
parent	string 必需。拥有此配置应用规则集合的父品牌。格式：projects/{project}/locations/{location}/brands/{brand}
page_size	int32 可选。要返回的配置应用规则的最大数量。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListConfigApplicationRules 调用接收的页面令牌。利用其进行后续页面检索。

ListConfigApplicationRulesResponse

MenuService.ListConfigApplicationRules 的响应消息。

字段
config_application_rules[]	ConfigApplicationRule 指定集合中的配置应用规则。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListMenusRequest

MenuService.ListMenus 的请求消息。

字段
parent	string 必需。拥有此菜单集合的父级。格式：projects/{project}/locations/{location}
page_size	int32 可选。要返回的菜单数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListMenus 调用接收的页面令牌。利用其进行后续页面检索。
filter	string 可选。用于过滤结果的过滤表达式。有关表达式语法的文档，请参阅 https://google.aip.dev/160。 支持以下字段：- store store=projects/my-project/locations/us-central1/brands/my-brand/stores/my-store
view	MenuView 可选。要为菜单返回的视图。

ListMenusResponse

MenuService.ListMenus 的响应消息。

字段
menus[]	Menu 指定集合中的菜单。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListStoreRevisionsRequest

MenuService.ListStoreRevisions 的请求消息。

字段
parent	string 必需。拥有相应修订版本集合的父级商店。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}
page_size	int32 可选。要返回的修订版本数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListStoreRevisions 调用接收的页面令牌。利用其进行后续页面检索。

ListStoreRevisionsResponse

MenuService.ListStoreRevisions 的响应消息。

字段
store_revisions[]	StoreRevision 指定集合中的商店修订版本。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

ListStoresRequest

MenuService.ListStores 的请求消息。

字段
parent	string 必需。拥有此商店集合的父品牌。格式：projects/{project}/locations/{location}/brands/{brand}
page_size	int32 可选。要返回的菜单数量上限。服务返回的值可能小于此值。
page_token	string 可选。从之前的 ListMenus 调用接收的页面令牌。利用其进行后续页面检索。
filter	string 可选。基于 AIP-160 的过滤表达式。允许根据各种属性过滤商店。支持的过滤字段： status（字符串）：商店的状态。运算符：=、!= 示例：status = "ACTIVE"（枚举值） update_time（时间戳）：商店的上次更新时间。时间戳应采用 RFC-3339 格式的字符串（例如 2012-04-21T11:30:00-04:00）。支持 UTC 时差运算符：=、!=、>、>=、<、<= 示例：update_time >= "2025-10-01T00:00:00Z" 标签（字符串）：与商店关联的标签。运算符：: (HAS) 示例：tags:"store-tag" city（字符串）：商店所在的城市。运算符：=、!= 示例：city = "Mountain View" 州/省/自治区（字符串）：商店地址的州/省/自治区。运算符：=、!= 示例：state = "CA" 逻辑运算符： 可以使用 AND、OR 和 NOT 组合条件。可以使用英文括号 () 对表达式进行分组，以控制评估顺序。示例：status = "ACTIVE" AND state = "CA"。

ListStoresResponse

MenuService.ListStores 的响应消息。

字段
stores[]	Store 指定集合中的商店。
next_page_token	string 可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段，则不存在后续页面。

LoyaltyAmount

表示客户的忠诚度金额。

字段
units	int64 必需。积分。

LoyaltyInfo

表示客户的会员信息。

字段
loyalty_amount	LoyaltyAmount 必需。会员积分金额。可以是会员积分余额，也可以是已消耗的会员积分。

菜单

定义可从餐厅订购的菜单。

字段
name	string 标识符。菜单名称。格式：projects/{project}/locations/{location}/menus/{menu}
store	string 可选。相应菜单所关联的商店的资源名称。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}
display_name	string 可选。（可选）此菜单在界面中显示的人类可读名称。
items[]	Item 可选。相应菜单中的项。
modifiers[]	Modifier 可选。此菜单中的商品修饰符。
modifier_groups[]	ModifierGroup 可选。此菜单中的修饰符组。
categories[]	MenuCategory 可选。相应菜单中的菜单类别。
create_time	Timestamp 仅限输出。相应菜单的创建时间。
update_time	Timestamp 仅限输出。相应菜单的上次更新时间。
labels[]	MenuLabel 可选。相应菜单的标签。
menu_schedules[]	MenuSchedule 可选。此菜单中的菜单时间表。

MenuCategory

定义包含商品或修饰符的类别。类别用于在界面中整理商品，并用于语义分组，以便代理理解。

字段
id	string 必需。相应菜单类别的标识符，在菜单中必须是唯一的。
display_name	string 可选。要在界面中使用的相应菜单类别的人类可读名称。
description	string 可选。人类可读的说明。
parent_id	string 可选。父级菜单类别 ID。如果为空，则表示这是顶级类别。

MenuLabel

用于在界面中描述菜单的字符串标签。

字段
name	string 必需。标签的名称。

MenuSchedule

定义商品和修饰符的菜单时间表。

字段
id	string 可选。时间表 ID，例如“BREAKFAST”“LUNCH”等。
schedules[]	Schedule 可选。安排活跃时间。
display_name	string 可选。为此时间表指定可选的显示名称。

MenuView

指定要返回的菜单的详细程度。

枚举
MENU_VIEW_UNSPECIFIED	默认值 / 未设置的值。该 API 将默认使用 FULL 视图。
MENU_VIEW_BASIC	包含有关菜单的基本元数据。
MENU_VIEW_NAME_ONLY	仅包含菜单名称
MENU_VIEW_FULL	包含所有内容。这是默认值。

修饰符

通过 ModifierGroup 定义的关系，定义在商品或其他修饰符内进行的修改选项。

字段
id	string 必需。相应功能变量的标识符，在菜单中必须唯一。
display_name	string 必需。要在界面中使用的相应商品的人类可读名称。
description	string 可选。人类可读的说明。
image	Image 可选。要在界面中为此商品显示的图片。
semantic_name	string 可选。简明易懂的名称，可清晰明确地标识相应修饰符。在包含相应修饰符的 ModifierGroup 中，应具有唯一性。
category_ids[]	string 可选。调节系数的类别。
availability	Availability 可选。相应调节系数的适用范围。
price_adjustment	Money 可选。选择此修饰符后，系统会向顶级商品的价格应用加性调整。如果相应调节器不影响价格，则留空。
integration_attributes	ModifierIntegrationAttributes 可选。与此实体关联的元数据，用于下游集成。
modifier_groups[]	ModifierGroupReference 可选。适用于相应修饰符的修饰符组的引用。
modifier_constraints	ModifierConstraints 可选。限制了哪些修饰符可以 / 必须应用于所引用 ModifierGroup 中的此修饰符。

ModifierAction

定义可对修饰符执行的操作。

字段
name	string 必需。修饰符操作名称，例如“NO”“SIDE”“ADD”“EXTRA”。

ModifierConstraints

限制可或必须应用于引用 ModifierGroups 的实体的修饰符。

字段
min_quantity	int32 可选。必须在直接引用的 ModifierGroup 中应用的修饰符的最小数量。如果未指定，则不强制执行任何下限。
max_quantity	int32 可选。可应用于直接引用的 ModifierGroup 的修饰符数量上限。如果未指定，则不会强制执行上限。

ModifierGroup

定义一组可供选择的修饰符。

字段
id	string 必需。相应功能组的标识符，在相应菜单中必须是唯一的。
display_name	string 必需。修饰符组名称，例如“配料（三明治）”或“中份套餐的配菜”。
semantic_name	string 可选。加项组名称，例如“配料（三明治）”或“套餐中的配菜”。
modifier_ids[]	string 必需。相应组中的修饰符 ID。
modifier_actions[]	ModifierAction 可选。可对相应组中的修饰符执行的操作。
min_selection_count	int32 可选。为了使商品有效，必须从所引用的组中选择的修饰符的最小数量。如果未设置，则没有下限。对于需要正好选择一个选项的群组，此值应为 1。
max_selection_count	int32 可选。可选择的引用组中修饰符的总数上限。如果未设置，则没有上限。对于需要正好选择一个选项的群组，此值应为 1。
max_selection_count_per_modifier	int32 可选。限制每个修饰符在此组中可应用的次数。如果未设置，则默认值为 1。
integration_attributes	ModifierGroupIntegrationAttributes 可选。与此实体关联的元数据，用于下游集成。

ModifierGroupIntegrationAttributes

与用于下游集成的修饰符组关联的元数据。

字段
custom_integration_attributes	Struct 可选。要与实体关联的任意元数据，用于构建下游集成，即用于构建订单以提交给第三方销售终端 API 的标识符或架构信息。
toast_attributes	ToastModifierGroupIntegrationAttributes 可选。表示与此修饰符组关联的元数据，用于 Toast 集成。如果商店未启用 Toast 集成，则系统会忽略此字段。

ToastModifierGroupIntegrationAttributes

表示来自 Toast 菜单的 ModifierGroup 的属性。

字段
guid	string 可选。表示 Toast 菜单中相应项的菜单组 GUID。
is_pre_modifier_group	bool 可选。如果为 true，则此修饰符组表示 Toast PreModifierGroup。

ModifierGroupReference

对修饰符组的引用。

字段
id	string 必需。修饰符组 ID。
default_modifiers[]	DefaultModifierSelection 可选。默认应用的一组修饰符。
min_selection_count	int32 可选。必须从所引用的 ModifierGroup 中选择的修饰符的最小数量。如果 ModifierGroupReference 和 ModifierGroup 中都设置了此值，则会同时强制执行这两个限制条件。如果未设置，则没有下限。
max_selection_count	int32 可选。可选择的引用组中修饰符的总数上限。如果 ModifierGroupReference 和 ModifierGroup 中都设置了此值，则会同时强制执行这两个限制条件。如果未设置，则没有上限。

DefaultModifierSelection

指定 ModifierGroup 中修饰符的默认选择。

字段
id	string 必需。修饰符 ID。
quantity	int32 可选。要应用的相应调节系数的数量。如果省略，则将参考的 quantity 视为 1。

ModifierIntegrationAttributes

与用于下游集成的修饰符关联的元数据。

字段
custom_integration_attributes	Struct 可选。要与实体关联的任意元数据，用于构建下游集成，即用于构建订单以提交给第三方销售终端 API 的标识符或架构信息。
toast_attributes	ToastModifierIntegrationAttributes 可选。表示与此修饰符关联的元数据，用于 Toast 集成。如果商店未启用 Toast 集成，则系统会忽略此字段。

ToastModifierIntegrationAttributes

表示来自 Toast 菜单的修饰符的属性。

字段
guid	string 可选。表示 Toast 菜单中商品的修饰符选项 GUID。
is_pre_modifier	bool 可选。如果值为 true，则此修饰符表示 Toast PreModifier。

订单

订单表示用户正在进行或已完成的订单的内容。

字段
items[]	OrderItem 可选。订单中的商品。
metadata	OrderMetadata 可选。在订单期间收集或推断出的其他元数据。
fulfillment	OrderFulfillment 可选。相应订单的履单信息。
price_info	OrderPriceInfo 可选。订单的价格信息。
external_order_id	string 仅限输出。相应订单的外部标识符。仅在启用销售终端集成时填充。
order_payment	OrderPayment 可选。与相应订单关联的付款状态。

OrderFulfillment

OrderFulfillment 包含有关订单履单的信息。

字段
fulfillment_method	FulfillmentMethod 可选。订单的配送方式。
create_time	Timestamp 仅限输出。创建订单的时间。
target_fulfillment_time	Timestamp 可选。订单安排的履单时间，用于“提前下单”。如果未提供，则假定订单为“尽快”订单。

OrderItem

OrderItem 用于指定属于订单的商品的状态。

字段
uid	string 可选。系统为相应商品分配的唯一标识符。
item_id	string 必需。菜单中某个项的标识符，在相应菜单中必须是唯一的。
display_name	string 仅限输出。此订单项的人类可读名称，将显示在界面上。
image	Image 仅限输出。要在界面中为此商品显示的图片。
base_price	Money 仅限输出。商品的基本价格。这可能会受到所选修饰符的影响。这是商品的单价。
integration_attributes	ItemIntegrationAttributes 仅限输出。与此实体关联的元数据，用于下游集成。
modifier_groups[]	OrderModifierGroup 可选。应用于此商品的 ModifierGroups。
quantity	int32 可选。相应商品在订单中的数量。

OrderMetadata

OrderMetadata 包含在订单期间收集或推断的其他元数据。

字段
collected_customer_name	string 可选。在接单时收集的客户姓名。仅当代理配置为收集客户姓名时才会填充。此类数据可能通过口头收集，并且可能包含拼写错误或转写错误，因此在向用户显示此类数据时应谨慎处理，并且不应将其视为可信数据（例如支付信息）。
caller_phone_number	string 可选。下单客户的手机号码。

OrderModifier

OrderModifier 用于指定属于 OrderModifierGroup 的 Modifier 的状态。

字段
uid	string 可选。系统为此修饰符分配的唯一标识符。
modifier_id	string 必需。相应功能变量的标识符，在菜单中必须唯一。
display_name	string 仅限输出。要在界面上显示的修饰符显示名称。
price_adjustment	Money 仅限输出。与此修饰符关联的价格调整（如果有）。这是相应修饰符的每单位价格。
quantity	int32 可选。应用此修饰符操作的数量。
modifier_action	OrderModifierAction 可选。应用于相应修饰符的修饰符操作。
image	Image 仅限输出。要在界面中为此修饰符显示的图片。
integration_attributes	ModifierIntegrationAttributes 仅限输出。与此实体关联的元数据，用于下游集成。
modifier_groups[]	OrderModifierGroup 可选。应用于相应修饰符的嵌套修饰符组。

OrderModifierAction

OrderModifierAction 用于指定与已应用的 OrderModifier 关联的 ModifierAction。

字段
name	string 可选。修饰符操作名称，例如“NO”“SIDE”“ADD”“EXTRA”。

OrderModifierGroup

OrderModifierGroup 用于指定属于 OrderItem 的 ModifierGroup 的状态。

字段
modifier_group_id	string 必需。相应功能组的标识符，在相应菜单中必须是唯一的。
display_name	string 仅限输出。修饰符组名称，例如“配料（三明治）”或“中份套餐的配菜”。
integration_attributes	ModifierGroupIntegrationAttributes 仅限输出。与此实体关联的元数据，用于下游集成。
modifiers[]	OrderModifier 可选。应用于相应修饰符组的修饰符。

OrderPayment

订单的付款相关信息。

字段
tipping_info	TippingInfo 可选。小费信息。
loyalty_consumed	LoyaltyAmount 可选。用于付款的会员积分金额。
payment_info	PaymentInfo 可选。所用支付方式的相关信息。

OrderPriceInfo

OrderPriceInfo 封装了订单的各种价格组成部分。

字段
total_price	Money 可选。应用所有税费和折扣后的最终总价。
subtotal_price	Money 可选。所有商品和修饰符的小计价格（不含税、折扣）。
tax_price	Money 可选。订单中应用的税费金额。

OrderType

要下的订单类型。

枚举
ORDER_TYPE_UNSPECIFIED	未指定订单类型。
ORDER_TYPE_DRIVE_THROUGH	订单是外带的。
ORDER_TYPE_CARRY_OUT	订单是外带订单。
ORDER_TYPE_DELIVERY	订单是送货订单。

PastOrder

用户的历史订单。

字段
order	Order 必需。原始的 Food AI 订单。

PaymentInfo

用户的支付信息。

字段
credit_card_last_four_digits	string 可选。信用卡的后四位数字。此属性用于在付款阶段验证信用卡号。
credit_card_cvv	string 可选。信用卡的 CVV。
payment_method	PaymentMethod 可选。所用支付方式的类型。

PaymentMethod

支付方式的类型。

枚举
PAYMENT_METHOD_UNSPECIFIED	未指定的付款方式。
PAYMENT_METHOD_CREDIT_CARD	信用卡。

PromoteChannelConfigRequest

MenuService.PromoteChannelConfig 的请求消息。

字段
name	string 必需。要升级的渠道配置的名称。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}
destination_brand	string 可选。要将渠道配置推广到的目标品牌。格式：projects/{project}/locations/{location}/brands/{brand} 如果提供了 destination_brand 且与 name 中的品牌不同，则会在 destination_brand 中创建频道配置的副本。否则，系统不会进行复制。

PromoteChannelConfigResponse

MenuService.PromoteChannelConfig 的响应消息。

字段
channel_config	ChannelConfig 推荐频道配置。

RecommendedOrder

代理向用户推荐的订单。

字段
order	Order 建议向用户显示的顺序。

RecommendedOrders

代理向用户推荐的订单列表。

字段
recommended_orders[]	RecommendedOrder 要向用户显示的推荐订单。

RestartOrder

客户请求重新开始下单。

字段
confirmation_step	bool 客服人员正在请客户确认重启请求。

时间表

可配置为每周一天或特定日期的日程。

字段
days[]	DayOfWeek 可选。应用相应时间表的星期。
date_ranges[]	DateRange 可选。应用时间表的日期范围。如果设置了此属性，则时间表仅在这些特定日期范围内处于有效状态。如果同时设置了 days 和 date_ranges，则只有在同时满足这两个条件时，相应安排才会处于有效状态。例如，如果 days 为 [MONDAY]，date_ranges 为 [2026-01-01, 2026-01-31]，则相应安排在 1 月份的所有星期一生效。
time_ranges[]	TimeOfDayRange 可选。应用时间表的时间范围。如果设置了此属性，相应安排仅在这些时间范围内有效。

SentimentMeasurement

针对此轮对话测量的实时情感得分。

字段
score	float 可选。情感得分介于 -1.0（负面情绪）与 1.0（正面情绪）之间。
magnitude	float 可选。情感的程度，无论得分如何。

SpeechRecognition

来自代理的语音识别结果。

字段
transcript	string 以检测到的语言转写的音频输入内容。
language_code	string 转写的语言代码。语言代码应采用 BCP-47 格式，例如“en-US”。

存储

品牌的单个商店。

字段
name	string 标识符。商店名称。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}
create_time	Timestamp 仅限输出。相应商店的创建时间。
update_time	Timestamp 仅限输出。相应商店上次更新的时间。
status	StoreStatus 必需。商店的状态。
time_zone	TimeZone 必需。商店的时区。此属性用于确定在给定时间应为商店使用哪个菜单时段，以及任何基于时间的替换项。
store_metadata	StoreMetadata 可选。商店的元数据。
tags[]	string 可选。与商店关联的标记。

StoreHours

商店的营业时间。

字段
fulfillment_method	FulfillmentMethod 可选。营业时间的履单方式，例如“自提”“送货”等。如果未指定，则假定营业时间适用于所有履单方式。
schedules[]	Schedule 可选。商店在指定履单方式下的营业时间。

StoreMetadata

商店的元数据。

字段
display_name	string 可选。要在界面和面向客户的元素中使用的商店的显示名称。
contact_email	string 可选。要向客户提供的商店的电子邮件地址。
address	Address 可选。商店的地址信息。
store_hours[]	StoreHours 可选。商店的营业时间。
dayparts[]	Daypart 可选。为商店定义的时间段。
phone_number	string 可选。商店的主要手机号码，用于接单、咨询餐饮服务、进行一般咨询和预订。

地址

商店的地址信息。

字段
street_address	string 可选。商店的街道地址。
city	string 可选。商店所在的城市。
state	string 可选。商店的状态。
country	string 可选。商店所在的国家/地区。
postal_code	string 可选。商店的邮政编码。
latitude	double 可选。商店的纬度。
longitude	double 可选。商店的经度。
google_maps_url	string 可选。商店的 Google 地图网址。

广告时段

商店的营业时段。

字段
id	string 可选。一天中的时段 ID，例如“BREAKFAST”“LUNCH”等。
schedules[]	Schedule 可选。不同时段的活跃小时数。
display_name	string 可选。为此时段指定可选的显示名称。

StoreRevision

商店的修订版本。

字段
name	string 标识符。商店修订版本的资源名称。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}/revisions/{revision}
snapshot	Store 仅限输出。相应修订版本中商店资源的状态。
create_time	Timestamp 仅限输出。修订版本的创建时间。
created_by	string 仅限输出。最近创建相应资源的用户所用的电子邮件地址。
alternate_ids[]	string 仅限输出。相应修订版本的备用 ID。

StoreStatus

商店的状态。

字段
state	State 可选。商店的状态。

州

商店的状态。

枚举
STATE_UNSPECIFIED	商店处于未指定状态。
ACTIVE	商店处于有效状态。
DISABLED	商店已停用。

SubmitOrderRequest

提交订单的请求，其中包含从客户处收集的所有必需支付信息。

字段
payment_info	PaymentInfo 必需。相应订单的支付信息。
loyalty_info	LoyaltyInfo 可选。相应订单消耗的积分。
tip_amount	Money 可选。相应订单的小费金额。

SubmitOrderResponse

提交订单的结果。

字段
success	bool 必需。订单是否已成功提交。
estimated_ready_duration	Duration 可选。订单准备就绪的预计时长。

SuggestedItem

要向客户推荐的商品。

字段
item_id	string 菜单中商品的 ID。
display_name	string 要在界面上显示的相应项的人类可读名称。
image	Image 要在界面中为此商品显示的图片。
base_price	Money 商品的基本价格。这可能会受到所选修饰符的影响。这是商品的单价。
integration_attributes	ItemIntegrationAttributes 与此实体关联的元数据，用于下游集成。

SuggestedItems

要向客户推荐的商品列表。

字段
items[]	SuggestedItem 要向客户推荐的商品。

SuggestedModifier

要向客户建议的修饰符。

字段
modifier_id	string 菜单中修饰符的 ID。
modifier_group_id	string 如果接受建议，此修饰符应添加到的修饰符组的 ID。
display_name	string 要在界面上显示的相应项的人类可读名称。
image	Image 要在界面中为此商品显示的图片。
price_adjustment	Money 与此修饰符关联的价格调整（如果有）。这是相应修饰符的每单位价格。
integration_attributes	ModifierIntegrationAttributes 与此实体关联的元数据，用于下游集成。

SuggestedModifiers

要向客户建议的修饰符列表。

字段
modifiers[]	SuggestedModifier 要向客户建议的修饰符。
parent_uid	string 要应用相应加项的父商品/加项的唯一标识符。

SuggestedOptions

可向客户建议的选项。

字段
联合字段 suggested_options。建议的选项。suggested_options 只能是下列其中一项：
suggested_items	SuggestedItems 要向客户推荐的商品列表。
suggested_modifiers	SuggestedModifiers 要向客户建议的修饰符列表。

TextInput

客户端的文本输入。除了音频之外，客户端还可以向智能体发送文本输入。客户端必须使用文本或音频输入，不能同时使用两者。

字段
text	string 必需。客户端的文本话语。

TimeOfDayRange

表示未指定日期中两个时间点之间的时间段。例如，营业时间为 09:00 至 17:00。

字段
start_time	TimeOfDay 必需。时间范围的起始值（含边界值）。
end_time	TimeOfDay 必需。时间范围的结束时间（不含）。如果 end_time 早于 start_time，则表示 end_time 是次日的时间。

TippingInfo

有关小费的信息。

字段
联合字段 tip_type。小费金额或百分比。tip_type 只能是下列其中一项：
amount	Money 可选。小费的具体金额。
percentage_bps	int32 可选。以基点表示的百分比，例如 450 = 4.5%。

TurnCompleted

此类型没有字段。

表示 Food AI 智能体已检测到当前对话轮的结束，并且不会再针对此轮提供任何输出。

UpdateBrandRequest

MenuService.UpdateBrand 的请求消息。

字段
brand	Brand 必需。要更新的品牌。 品牌的 name 字段用于标识要更新的品牌。格式：projects/{project}/locations/{location}/brands/{brand}
update_mask	FieldMask 可选。要更新的字段列表

UpdateChannelConfigRequest

MenuService.UpdateChannelConfig 的请求消息。

字段
channel_config	ChannelConfig 必需。要更新的渠道配置。 渠道配置的 name 字段用于标识要更新的渠道配置。格式：projects/{project}/locations/{location}/brands/{brand}/channelConfigs/{channel_config}
update_mask	FieldMask 可选。要更新的字段列表

UpdateConfigApplicationRuleRequest

MenuService.UpdateConfigApplicationRule 的请求消息。

字段
config_application_rule	ConfigApplicationRule 必需。要更新的配置应用规则。 配置应用规则的 name 字段用于标识要更新的配置应用规则。格式：projects/{project}/locations/{location}/brands/{brand}/configApplicationRules/{config_application_rule}
update_mask	FieldMask 可选。要更新的字段列表

UpdateStoreRequest

MenuService.UpdateStore 的请求消息。

字段
store	Store 必需。要更新的商店。 商店的 name 字段用于标识要更新的商店。格式：projects/{project}/locations/{location}/brands/{brand}/stores/{store}
update_mask	FieldMask 可选。要更新的字段列表
allow_missing	bool 可选。如果设置为 true，并且未找到存储区，则系统会创建新的存储区。在这种情况下，系统会忽略 update_mask。

UpdatedOrderState

由代理返回的事件，表示订单状态的更新。

字段
order	Order 与相应会话关联的订单的更新状态。

UserInfo

与 Food AI 智能体分享的最终用户的个人信息。

字段
preferred_name	string 可选。代理应使用哪个用户的名称来称呼用户。Food AI 客户端负责根据用户个人资料选择首选名称，并确保其符合品牌惯例，例如使用名字或全名。
payment_info	PaymentInfo 可选。用户的支付信息。
delivery_address	string 可选。用户的已保存配送地址。
past_orders[]	PastOrder 可选。用户的订单历史记录。
loyalty_info	LoyaltyInfo 可选。用户的会员信息。
phone_number	string 可选。用户的手机号码。