Package google.cloud.foodorderingaiagent.v1beta

索引

EvaluationRunService

EvaluationRunService 提供了一个用于运行评估用例的 API。

RunEvaluationCase

rpc RunEvaluationCase(RunEvaluationCaseRequest) returns (Operation)

运行评估用例。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

RunEvaluationDataset

rpc RunEvaluationDataset(RunEvaluationDatasetRequest) returns (Operation)

运行评估数据集。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

FoodOrderingService

FoodOrderingService 为订餐代理提供 API。

BidiProcessOrder

rpc BidiProcessOrder(BidiProcessOrderRequest) returns (BidiProcessOrderResponse)

一种双向流式传输 API,可处理多种模态(例如文本、音频)的持续客户端输入,并生成实时多模态输出流。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ProcessOrder

rpc ProcessOrder(ProcessOrderRequest) returns (ProcessOrderResponse)

执行单轮逻辑来处理用户输入并返回结果。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

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

AppendIngestionPhase

rpc AppendIngestionPhase(AppendIngestionPhaseRequest) returns (IngestionLog)

向提取日志附加提取阶段。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

BatchCreateEvaluationCases

rpc BatchCreateEvaluationCases(BatchCreateEvaluationCasesRequest) returns (BatchCreateEvaluationCasesResponse)

批量创建 EvaluationCase。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

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

BatchUpdateEvaluationCases

rpc BatchUpdateEvaluationCases(BatchUpdateEvaluationCasesRequest) returns (BatchUpdateEvaluationCasesResponse)

批量更新 EvaluationCase。

授权范围

需要以下 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

ComputeAnalyticsMetrics

rpc ComputeAnalyticsMetrics(ComputeAnalyticsMetricsRequest) returns (ComputeAnalyticsMetricsResponse)

计算指定时间段内指定品牌(可选商店过滤条件)的分析指标。

授权范围

需要以下 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

CreateDiscount

rpc CreateDiscount(CreateDiscountRequest) returns (Discount)

创建折扣。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

CreateEvaluationCase

rpc CreateEvaluationCase(CreateEvaluationCaseRequest) returns (EvaluationCase)

创建 EvaluationCase。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

CreateEvaluationContext

rpc CreateEvaluationContext(CreateEvaluationContextRequest) returns (EvaluationContext)

创建 EvaluationContext。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

CreateEvaluationDataset

rpc CreateEvaluationDataset(CreateEvaluationDatasetRequest) returns (EvaluationDataset)

创建 EvaluationDataset。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

CreateEvaluationMatcher

rpc CreateEvaluationMatcher(CreateEvaluationMatcherRequest) returns (EvaluationMatcher)

创建 EvaluationMatcher。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

CreateIngestionLog

rpc CreateIngestionLog(CreateIngestionLogRequest) returns (IngestionLog)

创建提取日志。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

CreateInventory

rpc CreateInventory(CreateInventoryRequest) returns (Inventory)

创建目录。

授权范围

需要以下 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

DeleteDiscount

rpc DeleteDiscount(DeleteDiscountRequest) returns (Empty)

删除指定的折扣。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteEvaluationCase

rpc DeleteEvaluationCase(DeleteEvaluationCaseRequest) returns (Empty)

删除指定的 EvaluationCase。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteEvaluationCaseResult

rpc DeleteEvaluationCaseResult(DeleteEvaluationCaseResultRequest) returns (Empty)

删除指定的 EvaluationCaseResult。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteEvaluationContext

rpc DeleteEvaluationContext(DeleteEvaluationContextRequest) returns (Empty)

删除指定的 EvaluationContext。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteEvaluationDataset

rpc DeleteEvaluationDataset(DeleteEvaluationDatasetRequest) returns (Empty)

删除指定的 EvaluationDataset。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteEvaluationDatasetResult

rpc DeleteEvaluationDatasetResult(DeleteEvaluationDatasetResultRequest) returns (Empty)

删除指定的 EvaluationDatasetResult。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteEvaluationMatcher

rpc DeleteEvaluationMatcher(DeleteEvaluationMatcherRequest) returns (Empty)

删除指定的 EvaluationMatcher。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteIngestionLog

rpc DeleteIngestionLog(DeleteIngestionLogRequest) returns (Empty)

删除指定的提取日志。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

DeleteInventory

rpc DeleteInventory(DeleteInventoryRequest) returns (Empty)

删除指定的媒体资源。

授权范围

需要以下 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

DeleteSessionRecord

rpc DeleteSessionRecord(DeleteSessionRecordRequest) returns (Empty)

删除 SessionRecord。注意:此操作会从 Spanner 数据库中移除会话详细信息。根据实现情况,系统可能还会移除 GCS 中的相关数据(例如录音)。

授权范围

需要以下 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

GetDiscount

rpc GetDiscount(GetDiscountRequest) returns (Discount)

获得折扣。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetEvaluationCase

rpc GetEvaluationCase(GetEvaluationCaseRequest) returns (EvaluationCase)

获取 EvaluationCase。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetEvaluationCaseResult

rpc GetEvaluationCaseResult(GetEvaluationCaseResultRequest) returns (EvaluationCaseResult)

获取 EvaluationCaseResult。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetEvaluationContext

rpc GetEvaluationContext(GetEvaluationContextRequest) returns (EvaluationContext)

获取 EvaluationContext。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetEvaluationDataset

rpc GetEvaluationDataset(GetEvaluationDatasetRequest) returns (EvaluationDataset)

获取 EvaluationDataset。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetEvaluationDatasetResult

rpc GetEvaluationDatasetResult(GetEvaluationDatasetResultRequest) returns (EvaluationDatasetResult)

获取 EvaluationDatasetResult。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetEvaluationMatcher

rpc GetEvaluationMatcher(GetEvaluationMatcherRequest) returns (EvaluationMatcher)

获取 EvaluationMatcher。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetIngestionLog

rpc GetIngestionLog(GetIngestionLogRequest) returns (IngestionLog)

获取提取日志。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

GetInventory

rpc GetInventory(GetInventoryRequest) returns (Inventory)

获取媒体文件。

授权范围

需要以下 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

GetSessionRecord

rpc GetSessionRecord(GetSessionRecordRequest) returns (SessionRecord)

获取特定的 SessionRecord。此方法会返回包含 audio_recording 字节的 SessionRecord(如果可用)。

授权范围

需要以下 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

ListBrandHistory

rpc ListBrandHistory(ListBrandHistoryRequest) returns (ListBrandHistoryResponse)

列出品牌的历史记录条目。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListBrandRevisions

rpc ListBrandRevisions(ListBrandRevisionsRequest) returns (ListBrandRevisionsResponse)

列出 BrandRevision。

授权范围

需要以下 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

ListDiscounts

rpc ListDiscounts(ListDiscountsRequest) returns (ListDiscountsResponse)

列出折扣。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListEvaluationCaseResults

rpc ListEvaluationCaseResults(ListEvaluationCaseResultsRequest) returns (ListEvaluationCaseResultsResponse)

列出 EvaluationCaseResults。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListEvaluationCases

rpc ListEvaluationCases(ListEvaluationCasesRequest) returns (ListEvaluationCasesResponse)

列出 EvaluationCase。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListEvaluationContexts

rpc ListEvaluationContexts(ListEvaluationContextsRequest) returns (ListEvaluationContextsResponse)

列出 EvaluationContext。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListEvaluationDatasetResults

rpc ListEvaluationDatasetResults(ListEvaluationDatasetResultsRequest) returns (ListEvaluationDatasetResultsResponse)

列出 EvaluationDatasetResults。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListEvaluationDatasets

rpc ListEvaluationDatasets(ListEvaluationDatasetsRequest) returns (ListEvaluationDatasetsResponse)

列出 EvaluationDataset。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListEvaluationMatchers

rpc ListEvaluationMatchers(ListEvaluationMatchersRequest) returns (ListEvaluationMatchersResponse)

列出 EvaluationMatcher。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListIngestionLogs

rpc ListIngestionLogs(ListIngestionLogsRequest) returns (ListIngestionLogsResponse)

列出提取日志。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

ListInventories

rpc ListInventories(ListInventoriesRequest) returns (ListInventoriesResponse)

列出广告资源。

授权范围

需要以下 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

ListSessionRecords

rpc ListSessionRecords(ListSessionRecordsRequest) returns (ListSessionRecordsResponse)

列出指定品牌的 SessionRecord。

授权范围

需要以下 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

UpdateDiscount

rpc UpdateDiscount(UpdateDiscountRequest) returns (Discount)

更新指定的折扣。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

UpdateEvaluationCase

rpc UpdateEvaluationCase(UpdateEvaluationCaseRequest) returns (EvaluationCase)

更新指定的 EvaluationCase。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

UpdateEvaluationContext

rpc UpdateEvaluationContext(UpdateEvaluationContextRequest) returns (EvaluationContext)

更新指定的 EvaluationContext。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

UpdateEvaluationDataset

rpc UpdateEvaluationDataset(UpdateEvaluationDatasetRequest) returns (EvaluationDataset)

更新指定的 EvaluationDataset。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

UpdateEvaluationMatcher

rpc UpdateEvaluationMatcher(UpdateEvaluationMatcherRequest) returns (EvaluationMatcher)

更新指定的 EvaluationMatcher。

授权范围

需要以下 OAuth 范围:

  • https://www.googleapis.com/auth/cloud-platform

如需了解详情,请参阅 Authentication Overview

UpdateInventory

rpc UpdateInventory(UpdateInventoryRequest) returns (Inventory)

更新指定的商品目录。

授权范围

需要以下 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

智能体提供的文字回答。

AnalyticsMetrics

表示指定时间段的分析指标,并与上一时间段进行比较。

字段
interval_metrics[]

IntervalMetrics

相应时间段的指标。

AppendIngestionPhaseRequest

MenuService.AppendIngestionPhase 的请求消息。

字段
name

string

必需。要附加阶段的提取日志的名称。格式:projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

ingestion_phase

IngestionPhase

必需。要附加的提取阶段。

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

必需。相应商品的配送方式。

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

字段
menu_schedule_ids[]

string

必需。此餐点可供订购的菜单时间表。

状态

可用性状态。

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

BatchCreateEvaluationCasesRequest

MenuService.BatchCreateEvaluationCases 的请求消息。

字段
parent

string

必需。所有正在创建的评估案例共享的父级资源。格式:projects/{project}/locations/{location}/brands/{brand} 如果设置了此字段,则 requests 中指定的所有评估案例的父级都必须与此字段匹配。

requests[]

CreateEvaluationCaseRequest

必需。指定要创建的资源的请求消息。一个批次最多可以创建 1,000 个评估案例。

BatchCreateEvaluationCasesResponse

MenuService.BatchCreateEvaluationCases 的响应消息。

字段
evaluation_cases[]

EvaluationCase

已创建 EvaluationCases。

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

所请求的类别。

BatchUpdateEvaluationCasesRequest

MenuService.BatchUpdateEvaluationCases 的请求消息。

字段
parent

string

必需。所有要更新的评估情形共享的父级资源。格式:projects/{project}/locations/{location}/brands/{brand} 如果设置了此字段,则 requests 中指定的所有评估案例的父级都必须与此字段匹配。

requests[]

UpdateEvaluationCaseRequest

必需。指定要更新的资源的请求消息。一个批次最多可以修改 1,000 个评估案例。

BatchUpdateEvaluationCasesResponse

MenuService.BatchUpdateEvaluationCases 的响应消息。

字段
evaluation_cases[]

EvaluationCase

已更新 EvaluationCases。

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
  • 轮次 2:
  • 客户输入 2
  • … 代理响应和订单状态消息
  • end_session
  • … 待处理的代理响应和订单状态消息
  • turn_completed
recommended_orders

RecommendedOrders

代理提供的建议订单。

Blob

表示对话中的 blob 输入或输出。

字段
mime_type

string

必需。来源数据的 IANA 标准 MIME 类型。

data

bytes

必需。相应 blob 的原始字节。

品牌

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

字段
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。

action

RevisionAction

仅限输出。创建相应修订版本的操作。

CelUpsell

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

字段
condition_expression

string

必需。针对当前会话状态(OrderClientSessionMetadata)评估的 CEL(通用表达式语言)字符串。如果评估结果为 True,则触发规则。示例:"context.weather_condition == 'HOT' && order.items.size() > 0"

suggested_menu_items[]

string

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

trigger_reason

string

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

priority

int32

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

suggested_modifiers[]

string

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

suggested_modifier_groups[]

SuggestedModifierGroup

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

max_modifier_per_group

int32

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

suggestion_only

bool

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

SuggestedModifierGroup

建议的修饰符组。

字段
name

string

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

suggested_modifiers[]

string

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

ChannelConfig

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

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

operations_config

OperationsConfig

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

state

State

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

type

Type

必需。渠道配置的类型。

supplemental_instructions

SupplementalInstructions

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

tone

Tone

可选。代理的语气。

config_application_rules[]

ConfigApplicationRule

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

频道配置的状态。

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

SupplementalInstructions

补充说明的配置。

字段
freeform_instructions

string

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

语气

代理的语气。

枚举
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。

action

RevisionAction

仅限输出。创建相应修订版本的操作。

ChannelType

用于客服人员沟通的渠道类型。渠道类型同时捕获界面(例如移动应用、Web 应用)和支持多种对话模式的界面的对话模式。对于移动设备和网络平台,裸值(例如 CHANNEL_TYPE_MOBILE_APP)表示语音对话模式,“_TEXT”变体表示文字(或多模态,例如点按即说)对话模式。此枚举未冻结,未来可能会添加新值。

枚举
CHANNEL_TYPE_UNSPECIFIED 未指定渠道类型。
CHANNEL_TYPE_DRIVE_THROUGH 通过渠道(语音)驾驶。
CHANNEL_TYPE_MOBILE_APP 使用语音对话模式的移动应用渠道。
CHANNEL_TYPE_PHONE_CALL 电话渠道(语音)。
CHANNEL_TYPE_WEB_APP 使用语音对话模式的 Web 应用渠道。
CHANNEL_TYPE_MOBILE_APP_TEXT 使用文本(或多模态,例如点按即说)对话模式的移动应用渠道。
CHANNEL_TYPE_WEB_APP_TEXT 使用文本(或多模态,例如点按即说)对话模式的 Web 应用渠道。

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

提交订单的请求。

order_prices_request

OrderPricesRequest

获取订单价格的请求。

validate_delivery_address_request

ValidateDeliveryAddressRequest

验证配送地址的请求。

order_status_request

OrderStatusRequest

获取订单状态的请求。

ClientExecutionResult

客户端执行请求的结果。

字段
execution_id

string

必需。相应结果所对应的执行请求的 ID。

联合字段 response。执行的具体结果。response 只能是下列其中一项:
finalize_order_response

FinalizeOrderResponse

完成订单的结果。

submit_order_response

SubmitOrderResponse

提交订单的结果。

order_prices_response

OrderPricesResponse

获取订单价格的结果。

validate_delivery_address_response

ValidateDeliveryAddressResponse

验证配送地址的结果。

order_status_response

OrderStatusResponse

获取订单状态的结果。

ClosingOffer

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

字段
closing_messages[]

ClosingMessage

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

ClosingMessage

关闭追加销售消息配置。

字段
offer_message

OfferMessage

必需。优惠消息配置。

skip_terms[]

string

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

ComputeAnalyticsMetricsRequest

MenuService.ComputeAnalyticsMetrics 的请求消息。

字段
brand

string

必需。要获取分析指标的品牌。格式:projects/{project}/locations/{location}/brands/{brand}

timestamps[]

Timestamp

必需。标记计算分析指标的每个时间间隔的开始时间的时间戳。

store_ids[]

string

可选。要获取分析指标的商店 ID 列表。如果未指定,则返回所有实体店的分析指标。需要按城市或州/省/自治区/直辖市进行查询。

analytics_types[]

AnalyticsType

可选。要计算的分析类型。如果为空或未指定,则会计算所有可用的分析类型。

feature_gate

FeatureGate

可选。功能门控。

AnalyticsType

要计算的分析类型。

枚举
ANALYTICS_TYPE_UNSPECIFIED 未指定的分析类型。
GENERIC 计算一般/总体指标(例如,订单数、升级数、追加销售数)。
DAILY 计算每日指标(例如,每日订单数和升级次数)。
PREDICTED_FAILURE_CATEGORIES 计算预测的故障类别指标(例如,预测的故障类别数量)。

FeatureGate

用于控制分析计算行为的特征门控。

字段
enable_aggregation_data

bool

可选。仅适用于部分品牌。如果已设置,则使用汇总数据计算分析指标。

ComputeAnalyticsMetricsResponse

MenuService.ComputeAnalyticsMetrics 的响应消息。

字段
analytics_metrics

AnalyticsMetrics

仅限输出。品牌的分析指标。

配置

会话和订餐属性的配置。在每次连接开始时,客户端必须先发送一条配置消息。必须在启动会话之前执行此操作。如果客户端断开连接,则在重新连接时应重复发送相同的配置消息。

字段
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

可选。有关客户端应用和设备环境的信息。

mode

SessionMode

可选。会话的模式。

channel_type

ChannelType

可选。用于客服人员沟通的渠道类型。

enable_listen_only_dual_channel

bool

可选。是否为会话启用仅收听双声道。如果启用,客户端应在 AudioInput 中提供 customer_audio 和 crew_audio,并且 CES 将在媒体处理服务器上执行 EAC 和求和。

test_session_start_time

Timestamp

可选。会话的开始时间,用于测试或评估。

SessionMode

会话的模式。

枚举
SESSION_MODE_UNSPECIFIED 未指定会话模式。
HYBRID 会话支持音频和文本。这是默认设置。
TEXT 此会话仅限文本。

TrafficType

相应会话的流量类型。用于标记监控、日志记录和可观测性指标。

枚举
TRAFFIC_TYPE_UNSPECIFIED 未指定流量类型。
EXTERNAL 流量来自外部客户端。
INTEGRATION_TEST 流量来自集成测试。
EVAL 流量来自评估工具。
PROBER 流量来自探测器。
MANUAL_TEST 流量来自手动测试。
INTERNAL_TOOL 流量来自内部工具。
CONSOLE 流量来自食品 AI 控制台。

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。

action

RevisionAction

仅限输出。创建相应修订版本的操作。

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 个字符。

CreateDiscountRequest

MenuService.CreateDiscount 的请求消息。

字段
parent

string

必需。拥有相应折扣集合的父级商店。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}

discount_id

string

可选。要用于折扣的折扣 ID,该 ID 将成为折扣资源名称的最后一个组成部分。

此值只能包含小写字母、数字和连字符,第一个和最后一个字符必须是字母或数字,且长度不得超过 63 个字符。

discount

Discount

必需。要创建的折扣。

CreateEvaluationCaseRequest

MenuService.CreateEvaluationCase 的请求消息。

字段
parent

string

必需。拥有此评估案例集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

evaluation_case

EvaluationCase

必需。要创建的评估案例。

evaluation_case_id

string

可选。要用于评估案例的 ID,该 ID 将成为评估案例资源名称的最后一个组成部分。

此值只能包含小写字母、数字和连字符,第一个和最后一个字符必须是字母或数字,且长度不得超过 63 个字符。

CreateEvaluationContextRequest

MenuService.CreateEvaluationContext 的请求消息。

字段
parent

string

必需。拥有此评估上下文集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

evaluation_context

EvaluationContext

必需。要创建的评估上下文。

evaluation_context_id

string

可选。要用于评估上下文的 ID,该 ID 将成为评估上下文资源名称的最后一个组成部分。

此值只能包含小写字母、数字和连字符,第一个和最后一个字符必须是字母或数字,且长度不得超过 63 个字符。

CreateEvaluationDatasetRequest

MenuService.CreateEvaluationDataset 的请求消息。

字段
parent

string

必需。拥有此评估数据集集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

evaluation_dataset

EvaluationDataset

必需。要创建的评估数据集。

evaluation_dataset_id

string

可选。要用于评估数据集的 ID,该 ID 将成为评估数据集资源名称的最后一个组成部分。

CreateEvaluationMatcherRequest

MenuService.CreateEvaluationMatcher 的请求消息。

字段
parent

string

必需。拥有此评估匹配器集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

evaluation_matcher

EvaluationMatcher

必需。要创建的评估匹配器。

evaluation_matcher_id

string

可选。要用于评估匹配器的 ID,该 ID 将成为评估匹配器资源名称的最后一个组成部分。

此值只能包含小写字母、数字和连字符,第一个和最后一个字符必须是字母或数字,且长度不得超过 63 个字符。

CreateIngestionLogRequest

MenuService.CreateIngestionLog 的请求消息。

字段
parent

string

必需。将创建相应提取日志的父级资源。格式:projects/{project}/locations/{location}/brands/{brand}

ingestion_log

IngestionLog

必需。要创建的提取日志。

ingestion_log_id

string

必需。要用于提取日志的 ID,该 ID 将成为提取日志资源名称的最后一个组成部分。

CreateInventoryRequest

MenuService.CreateInventory 的请求消息。

字段
parent

string

必需。拥有相应库存集合的父级商店。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}

inventory_id

string

可选。要用于相应媒体资源的媒体资源 ID,该 ID 将成为相应媒体资源资源名称的最后一个组成部分。

此值只能包含小写字母、数字和连字符,第一个和最后一个字符必须是字母或数字,且长度不得超过 63 个字符。

inventory

Inventory

必需。要创建的影音平台。

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}

DeleteDiscountRequest

MenuService.DeleteDiscount 的请求消息。

字段
name

string

必需。要删除的折扣的名称。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

DeleteEvaluationCaseRequest

MenuService.DeleteEvaluationCase 的请求消息。

字段
name

string

必需。要删除的评估案例的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

DeleteEvaluationCaseResultRequest

MenuService.DeleteEvaluationCaseResult 的请求消息。

字段
name

string

必需。要删除的评估案例结果的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

DeleteEvaluationContextRequest

MenuService.DeleteEvaluationContext 的请求消息。

字段
name

string

必需。要删除的评估上下文的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

DeleteEvaluationDatasetRequest

MenuService.DeleteEvaluationDataset 的请求消息。

字段
name

string

必需。要删除的评估数据集的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

DeleteEvaluationDatasetResultRequest

MenuService.DeleteEvaluationDatasetResult 的请求消息。

字段
name

string

必需。要删除的评估数据集结果的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasetResults/{evaluation_dataset_result}

DeleteEvaluationMatcherRequest

MenuService.DeleteEvaluationMatcher 的请求消息。

字段
name

string

必需。要删除的评估匹配器的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationMatchers/{evaluation_matcher}

DeleteIngestionLogRequest

MenuService.DeleteIngestionLog 的请求消息。

字段
name

string

必需。要删除的提取日志的名称。格式:projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

DeleteInventoryRequest

MenuService.DeleteInventory 的请求消息。

字段
name

string

必需。要删除的媒体资源目录的名称。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

DeleteMenuRequest

MenuService.DeleteMenu 的请求消息。

字段
name

string

必需。要删除的菜单的名称。格式:projects/{project}/locations/{location}/menus/{menu}

DeleteSessionRecordRequest

针对 [SessionRecordService.DeleteSessionRecord][] 的请求消息。

字段
name

string

必需。要删除的会话记录的名称。格式:projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

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}

DeliveryAddress

订单的配送地址。可以是已保存或已收集的现有地址。

字段
address

PostalAddress

可选。配送地址。

validation_status

ValidationStatus

可选。地址的验证状态。

coordinates

LatLng

可选。相应地址的地理坐标。用于验证地址是否在商店的送货范围内。

ValidationStatus

配送地址的验证状态。它由特定于客户端的验证逻辑确定。

枚举
VALIDATION_STATUS_UNSPECIFIED 相应地址尚未通过验证。
VALIDATION_STATUS_VALID 地址有效。
VALIDATION_STATUS_INVALID 地址无效(不存在、无法解析等)
VALIDATION_STATUS_OUT_OF_RANGE 地址存在且已解析,但超出商店的配送范围。
VALIDATION_STATUS_INCOMPLETE_ADDRESS 地址缺少必需字段(缺少门牌号/街道名称、城市、州/省/自治区/直辖市、邮编等)

DisambiguationMapping

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

字段
type

Type

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

customer_terms[]

string

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

targets[]

TargetItem

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

custom_instruction

string

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

类型

消歧规则的运作类型。

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

DisambiguationStrategy

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

字段
mappings[]

DisambiguationMapping

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

折扣

可应用于商店订单的折扣。下一个 ID:16

字段
name

string

标识符。折扣名称。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

display_name

string

必需。面向用户的折扣名称(例如“订单八折优惠”)。

type

DiscountType

必需。所应用的折扣类型。

scope

Scope

必需。应用折扣的范围。

schedule

Schedule

可选。折扣生效的时间安排。

fixed_amount

Money

可选。折扣的固定货币价值或固定总价,具体取决于“类型”。

percent

float

可选。折扣的百分比值(0.0 到 100.0)。当“type”为 PERCENT_OFF 时设置。

max_discount_value

Money

可选。如果折扣类型为 PERCENT_OFF,我们可以设置用户可获得的最高折扣金额。

applied_items

ItemGroup

可选。折扣所适用的商品组。如果“scope”为 ITEM,则必须提供此值。例如,套装、混搭和买一送一优惠的 GET 部分在此处定义。

required_items

ItemGroup

可选。只有在折扣类型为“买一送一”时,才需要设置必须在购物车中存在的商品组才能激活折扣。例如,BOGO 折扣的“买”部分在此处定义。

auto_apply

bool

可选。如果值为 true,则在满足条件时自动应用折扣。

promo_code

string

可选。应用折扣所需的代码。

additional_constraint

Constraint

可选。应用此折扣的其他限制。

integration_attributes

DiscountIntegrationAttributes

可选。与此实体关联的元数据,用于下游集成。

image

Image

可选。要在界面中显示的相应折扣的图片。

限制条件

应用此折扣的其他限制。

字段
min_spend

Money

可选。应用此折扣所需的最低支出。

max_uses_per_order

int32

可选。相应折扣可用于每个订单的次数。

allowed_channels[]

ChannelType

可选。可应用此折扣的渠道。如果未设置,则折扣可应用于所有渠道。

requires_customer_signin

bool

可选。对于移动设备订单,如果需要客户登录才能享受此折扣。

is_stackable

bool

可选。相应折扣是否可以与其他折扣一起使用。

范围

定义应用折扣的级别。

枚举
SCOPE_UNSPECIFIED 未指定的范围。
ORDER 应用于整个订单。
ITEM 适用于特定商品。

DiscountIntegrationAttributes

与用于下游集成的折扣关联的元数据。

字段
custom_integration_attributes

Struct

可选。要与实体相关联的任意元数据,用于构建下游集成,例如用于构建订单以提交给第三方销售点 API 的标识符或架构信息。

DiscountType

折扣类型。

枚举
DISCOUNT_TYPE_UNSPECIFIED 未指定折扣类型。
BOGO 买 X,免费获赠 Y/立减 Z%/立省 Z 金额。
FIXED_OFF 固定金额折扣(例如,商品或订单优惠 5.00 美元)。
PERCENT_OFF 百分比折扣(例如,商品或订单八折优惠)。
FIXED_TOTAL 将折扣商品的最终价格设置为固定总价(例如,2 件商品 10.00 美元)。
FREE_DELIVERY 免除订单的配送费用。

EndSession

表示代理已终止会话,原因可能是成功完成(例如,用户说“再见!”)或智能体上报。

字段
type

EndType

结束会话事件的类型。

reason

string

结束会话的原因。

pos_response

string

可选。办理入住手续时来自 POS 的响应(可选)。这是一个表示 POS 交易状态的不透明字符串载荷。

agent_response

string

可选。要向用户朗读/显示的最终代理响应消息(可选)。

store_schedule

Schedule

可选。商店时间表。仅当结束类型为 STORE_CLOSED 时设置。

EndType

结束会话事件的类型。

枚举
END_TYPE_UNSPECIFIED 未指定结束类型。
DRIVE_OFF 客户开车离开了。
AGENT_ESCALATION 智能客服已将对话升级为人工客服。
CREW_INTERJECTION 一名队员在会话中插话。
ORDER_COMPLETED 订单已成功完成,无需采取进一步行动。
PAYMENT_FLOW_SUCCESS 付款流程已成功完成,无需采取进一步操作。
PAYMENT_FLOW_FAILURE 付款流程失败。
CLIENT_ESCALATION 客户将对话升级为人工客服会话。
CALLER_HANGUP 客户过早挂断了电话。
REQUESTED_CHECKOUT 客户请求结账。
REQUESTED_ORDER_STATUS 客户询问了订单状态。
STORE_CLOSED 商店已停业。

EvaluationCase

单个评估用例。

字段
name

string

标识符。评估案例的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

display_name

string

必需。评估用例的简明易懂的名称。

description

string

可选。评估用例的说明。

evaluation_context

string

必需。与相应测试用例关联的评估上下文的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

evaluation_matchers[]

string

可选。用于评估情形的评估匹配器列表。评估在 BidiProcessOrder 会话结束时执行一次。每个匹配器都会生成一个布尔值结果,指明评估匹配器是通过还是失败。

联合字段 test_case。用于评估用例的测试用例。test_case 只能是下列其中一项:
static_text_turn_case

StaticTextTurnCase

可选。用户和代理文本轮次为静态的测试用例。

dynamic_text_turn_case

DynamicTextTurnCase

可选。一种测试用例,其中用户文本输入是使用 LLM 和排序指令动态生成的。

DynamicTextTurnCase

一种评估情形,其中用户输入是使用 LLM 和排序指令动态生成的。

字段
ordering_instruction

string

必需。用户与订餐代理互动的订购说明。LLM 会根据排序指令动态生成用户文本输入。这可能包括要订购的目标商品、用户的偏好和限制,以及用户应告知订购代理的具体操作。

StaticTextTurnCase

一种评估情形,其中用户输入是静态文本输入。

字段
text_turns[]

TextTurn

必需。评估案例中的文本对话轮次列表。

TextTurn

评估用例中的单个文本轮次,由用户输入和代理回答组成。

字段
user_text_input

string

必需。相应轮次的用户文本输入。

example_agent_response

string

可选。相应轮次的代理回答示例。请注意,这并非实际的智能体回答。实际的代理回答可能与此示例回答有所不同。示例回答不用于评估,仅用于显示,以便更轻松地理解评估案例。

EvaluationCaseResult

评估用例结果。

字段
name

string

标识符。评估案例结果的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

evaluation_case

EvaluationCase

仅限输出。相应结果所关联的评估案例。

evaluation_context

EvaluationContext

仅限输出。相应结果关联的评估上下文。

evaluation_dataset

string

仅限输出。与此结果关联的评估数据集引用。如果未设置,则表示测试用例作为独立测试运行,而不是作为评估数据集的一部分运行。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

session_record

string

仅限输出。相应结果所关联的会话记录的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

status

Status

仅限输出。评估案例的状态。

matcher_results[]

MatcherResult

仅限输出。评估用例的评估匹配器结果列表。评估匹配器的结果。

create_time

Timestamp

仅限输出。评估用例结果的创建时间。

MatcherResult

评估匹配器的结果。

字段
evaluation_matcher

EvaluationMatcher

仅限输出。相应结果关联的评估匹配器。

联合字段 result。评估匹配器的结果。result 只能是下列其中一项:
order_result_matcher_result

OrderResultMatcherResult

仅限输出。顺序结果匹配器的结果。

agent_utterance_string_matcher_result

AgentUtteranceStringMatcherResult

仅限输出。代理话语字符串匹配器的结果。

llm_judgement_matcher_result

LLMJudgementMatcherResult

仅限输出。代理话语 LLM 判断匹配器的结果。

AgentUtteranceStringMatcherResult

代理话语字符串匹配器的结果。

字段
match

bool

仅限输出。代理话语字符串匹配器是否通过。

LLMJudgementMatcherResult

代理话语 LLM 判断匹配器的结果。

字段
match

bool

仅限输出。代理话语 LLM 判断匹配器是否通过。

reasoning

string

仅限输出。说明 LLM 判断匹配或失败的原因。

OrderResultMatcherResult

顺序结果匹配器的结果。

字段
match

bool

仅限输出。订单结果匹配器是否通过。

difference

string

仅限输出。以 (-want +got) 格式显示订单结果匹配器中预期顺序与实际顺序之间的美观打印差异。

状态

评估案例的状态。

枚举
STATUS_UNSPECIFIED 状态无效。
PASS 所有评估匹配器均已满足。
FAIL 至少有一个评估匹配条件未满足。
ERROR 出现错误,导致 BidiProcessOrder 会话意外终止,无法完成评估。

EvaluationContext

评估套件或测试用例的评估上下文。

字段
name

string

标识符。评估上下文的完整资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

display_name

string

必需。评估情境的直观易懂的名称。

description

string

可选。评估上下文的说明。

store

string

必需。用于评估案例的商店的完整资源名称。格式:projects/{project_id}/locations/{location}/brands/{brand_id}/stores/{store_id}

menu

string

可选。用于评估上下文的可选菜单。如果未提供,则使用商店的默认菜单。格式:projects/{project_id}/locations/{location}/brands/{brand_id}/menus/{menu_id}

test_session_start_time

Timestamp

可选。订餐会话的可选注入开始时间。如果设置,评估会话将假定测试会话在此时间开始。用于模拟一天中特定时间段的订购行为。如果未设置,评估会话将使用当前时间作为开始时间。

mock_client_executions[]

MockClientExecution

可选。在评估会话期间,食品订购服务发送的客户端执行请求的可选模拟客户端执行响应。

daypart_id

string

可选。用于评估上下文的可选时段 ID。如果提供,代理将在建立流程顺序配置时使用此时段 ID。

EvaluationDataset

评估案例的数据集。

字段
name

string

标识符。评估数据集的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

display_name

string

必需。评估数据集的直观易懂的名称。

description

string

可选。评估数据集的说明。

evaluation_cases[]

string

可选。相应数据集的评估案例参考列表。每个测试用例的格式如下:projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

evaluation_context

string

可选。用于评估数据集的可选评估上下文。如果设置,此值会替换各个评估情形中设置的评估上下文。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

EvaluationDatasetResult

评估数据集结果。

字段
name

string

标识符。评估数据集结果的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasetResults/{evaluation_dataset_result}

evaluation_dataset

string

仅限输出。与此结果关联的评估数据集引用。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

evaluation_case_results[]

string

仅限输出。评估数据集的评估情形结果列表。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

EvaluationMatcher

评估匹配器。

字段
name

string

标识符。评估匹配器的资源名称。

display_name

string

必需。评估匹配器的直观易懂的名称。

description

string

可选。评估匹配器的说明。

联合字段 matcher。用于评估匹配器的匹配器。匹配器必须生成一个布尔值结果,指明评估匹配器是否通过。matcher 只能是下列其中一项:
order_result_matcher

OrderResultMatcher

可选。订单结果的评估匹配器。

agent_utterance_string_matcher

AgentUtteranceStringMatcher

可选。用于代理话语字符串的评估匹配器。

llm_judgement_matcher

LLMJudgementMatcher

可选。一种使用 LLM 判断的评估匹配器。

AgentUtteranceStringMatcher

用于代理话语字符串的评估匹配器。

字段
invert

bool

可选。如果为 true,则匹配条件会反转(例如,“不包含”或“不匹配”)。

联合字段 match_pattern

match_pattern 只能是下列其中一项:

contains

string

可选。代理话语应包含此子字符串。

regex

string

可选。代理话语应与此正则表达式匹配。

LLMJudgementMatcher

一种使用 LLM 判断的评估匹配器,提示如下:“你是一名乐于助人的助理,可以帮助用户在餐厅下单。您将获得用户输入和智能体回答。你的任务是确定代理回答是否满足以下条件:{criteria}”

字段
criteria

string

必需。LLM 在考虑代理回答是否通过检查时所依据的标准。

invert

bool

可选。如果为 true,则匹配条件会反转(例如,“不包含”)。

OrderResultMatcher

订单结果的评估匹配器。

字段
expected_order

Order

必需。要匹配的预期顺序。归一化后,实际顺序必须与此预期顺序一致。如果所有字段和数量都匹配,则评估通过。在比较过程中,系统会忽略默认数量 1,以确保字段省略处理方式的一致性。

expected_legacy_order

Struct

可选。要匹配的预期旧版订单状态。当评估上下文的 use_legacy_order_state 设置为 true 时使用。

EventInput

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

字段
联合字段 event。下一个 ID:10 要触发的事件。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

可选。来电者挂断电话事件。

pos_error_input

PosErrorEvent

可选。POS 错误事件。

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

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

PosErrorEvent

特定于销售终端 (POS) 的故障。

字段
error_messages[]

string

可选。直观易懂的错误说明列表。如果同时出现多个问题(例如,多件商品缺货),或者为了更详细地分解单个复杂故障,可以提供多条错误消息。代理可能会使用这些消息来通知客户或用于日志记录。

affected_item_uids[]

string

可选。由订餐 AI 智能体生成的导致错误的唯一商品 UID。对应于 UpdatedOrderState.OrderItem.uid

affected_external_ids[]

string

可选。导致错误的外部 ID(来自菜单)的列表。应与 POS 中的实际代表相同,这些代表通常位于 menu.proto 中的集成属性下(例如,在 ItemIntegrationAttributesModifierIntegrationAttributes 中)。

metadata

map<string, string>

可选。用于调试或品牌专用信号的自由格式元数据。可用于传递特定于品牌的错误代码或类别(例如,{"BRAND_ERROR_CODE": "OUT_OF_STOCK"})。

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

可选。仅限部分受众群体,如果设置,将使用改版后的付款流程。

updated_order_state_enabled

bool

可选。如果已设置,则返回 updated_order_state,而不是 legacy_order_state_response。

enable_order_status_retrieval

bool

可选。如果设置,代理将支持检索订单状态。

FeaturesConfig

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

字段
order_pickup

OrderPickup

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

order_dine_in

OrderDineIn

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

name_collection

NameCollection

可选。命名集合功能配置。

confirm_order_info_at_start
(deprecated)

bool

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

confirm_order_info_on_finalize

bool

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

get_order_prices

GetOrderPrices

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

end_session_with_checkout_request

EndSessionWithCheckoutRequest

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

enable_address_collection

EnableAddressCollection

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

support_cash_payment

SupportCashPayment

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

budget_based_ordering

bool

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

EnableAddressCollection

此类型没有字段。

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

EndSessionWithCheckoutRequest

此类型没有字段。

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

GetOrderPrices

此类型没有字段。

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

NameCollection

此类型没有字段。

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

OrderDineIn

此类型没有字段。

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

OrderPickup

此类型没有字段。

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

SupportCashPayment

此类型没有字段。

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

FinalizeOrderRequest

此类型没有字段。

用于最终确定订单的请求。当客户表示已完成下单并想要付款时,客服人员通常会发送此消息。

FinalizeOrderResponse

完成订单的结果。

字段
payment_flow_enabled

bool

可选。是否在代理中启用付款处理流程。

payment_info

PaymentInfo

可选。客户的支付信息。如果 payment_flow_enabled 为 false,则不执行任何操作。

total_amount_due

Money

可选。订单的应付总金额。

order_price_info

OrderPriceInfo

可选。订单的详细价格信息。

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}

GetDiscountRequest

MenuService.GetDiscount 的请求消息。

字段
name

string

必需。要检索的折扣的名称。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

GetEvaluationCaseRequest

MenuService.GetEvaluationCase 的请求消息。

字段
name

string

必需。要检索的评估案例的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

GetEvaluationCaseResultRequest

MenuService.GetEvaluationCaseResult 的请求消息。

字段
name

string

必需。要检索的评估案例结果的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

GetEvaluationContextRequest

MenuService.GetEvaluationContext 的请求消息。

字段
name

string

必需。要检索的评估上下文的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

GetEvaluationDatasetRequest

MenuService.GetEvaluationDataset 的请求消息。

字段
name

string

必需。要检索的评估数据集的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

GetEvaluationDatasetResultRequest

MenuService.GetEvaluationDatasetResult 的请求消息。

字段
name

string

必需。要检索的评估数据集结果的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasetResults/{evaluation_dataset_result}

GetEvaluationMatcherRequest

MenuService.GetEvaluationMatcher 的请求消息。

字段
name

string

必需。要检索的评估匹配器的名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationMatchers/{evaluation_matcher}

GetIngestionLogRequest

MenuService.GetIngestionLog 的请求消息。

字段
name

string

必需。要检索的提取日志的名称。格式:projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

GetInventoryRequest

MenuService.GetInventory 的请求消息。

字段
name

string

必需。要检索的媒体资源的名称。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

GetMenuRequest

MenuService.GetMenu 的请求消息。

字段
name

string

必需。要检索的菜单的名称。格式:projects/{project}/locations/{location}/menus/{menu}

GetSessionRecordRequest

针对 [SessionRecordService.GetSessionRecord][] 的请求消息。

字段
name

string

必需。要检索的会话记录的名称。格式:projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

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}

GreetingOffer

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

字段
messages[]

OfferMessage

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

问候语

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

字段
language_code

string

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

greeting_phrases[]

string

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

HistoryEntry

资源修订版本的历史记录条目。

字段
commit_time

Timestamp

修订版本的创建时间。

created_by

string

创建修订版本的用户或服务。

revision_name

string

修订版本的完整资源名称。

resource_type

string

基础资源的类型(例如“品牌”“商店”“ChannelConfig”)。

action

RevisionAction

创建相应修订版本的操作。

联合字段 resource_revision。资源修订版本。resource_revision 只能是下列其中一项:
brand

Brand

提交时的品牌。

store

Store

提交时的存储区。

channel_config

ChannelConfig

提交时的渠道配置。

config_application_rule

ConfigApplicationRule

提交时的配置应用规则。

图片

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

字段
source_uri

string

必需。图片的来源 URI。

sources[]

ImageSource

可选。不同分辨率的图片来源。

ImageSource

具有分辨率的图片 URI。

字段
uri

string

可选。图片的 URI。

width

int32

可选。图片的宽度。

height

int32

可选。图片的高度。

IngestionLog

菜单提取运行记录。

字段
name

string

标识符。提取日志的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/ingestionLogs/{ingestion_log}

store

string

可选。用于提取数据的商店的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}

state

State

仅限输出。有关当前提取状态的数据。

start_time

Timestamp

仅限输出。注入作业开始的时间。

end_time

Timestamp

仅限输出。提取作业完成的时间。

phases[]

IngestionPhase

仅限输出。阶段运行时列表。

提取运行的状态。

枚举
STATE_UNSPECIFIED 状态未指定。
SUCCEEDED 注入成功。
FAILED 注入失败。
PROCESSING 正在处理注入。

IngestionPhase

提取运行的阶段。

字段
phase

Phase

必需。阶段的名称。

start_time

Timestamp

可选。阶段的开始时间。

end_time

Timestamp

可选。阶段的结束时间。

state

State

可选。阶段的状态。由调用者在附加时设置,因此是输入,而不是资源状态。

details

string

可选。阶段的详细信息。

阶段

阶段名称的枚举。

枚举
PHASE_UNSPECIFIED 阶段未指定。
READ_SOURCE_MENU 正在读取来源菜单。
PARSE_SOURCE_MENU 正在解析源菜单。
BRAND_SPECIFIC_VALIDATION 验证特定于品牌的配置。
BRAND_AGNOSTIC_VALIDATION 验证品牌无关配置。
CREATE_MENU 创建菜单。

阶段的执行状态。

枚举
STATE_UNSPECIFIED 状态未指定。
SUCCEEDED 相应阶段已成功完成。
FAILED 相应阶段失败。

互动

表示对话中一个回合中的单次互动。

字段
turn_position

int64

仅限输出。在对话中轮流发言。

联合字段 interaction。互动类型。interaction 只能是下列其中一项:
user_utterance

UserUtterance

用户话语。

agent_utterance

AgentUtterance

智能体话语。

resolve_order

ResolveOrder

代理执行的 ResolveOrder 调用

submit_order

SubmitOrder

由代理执行的 SubmitOrder 调用

match_intent

MatchIntent

智能体执行的 MatchIntent 调用

client_execution

ClientExecution

智能体执行的 ClientExecution 调用

client_order_update

ClientOrderUpdate

由客户端启动的订单状态更新

AgentUtterance

智能体话语。

字段
text

string

代理话语的文本。

create_time

Timestamp

仅限输出。代理话语发生时的时间戳。

ClientExecution

客户端执行互动。

字段
tool_name

string

客户端执行互动的工具名称。

input

ClientExecutionInput

客户端执行互动的输入。

output

ClientExecutionOutput

客户端执行互动的输出。

ClientExecutionInput

客户端执行互动的输入。

字段
payload

Struct

客户端执行互动输入的载荷。

ClientExecutionOutput

客户端执行互动的输出。

字段
payload

Struct

客户端执行互动输出的载荷。

ClientOrderUpdate

由客户端发起的订单状态更新。

字段
order

Order

由客户端发送的订单状态更新。

MatchIntent

匹配意图互动。

字段
input

MatchIntentInput

匹配意图互动的输入。

output

MatchIntentOutput

匹配意图互动的输出。

MatchIntentInput

匹配意图互动的输入。

字段
payload

Struct

匹配 intent 互动输入的载荷。

MatchIntentOutput

匹配意图互动的输出。

字段
payload

Struct

匹配意图互动输出的载荷。

ResolveOrder

解决订单互动。

字段
input

ResolveOrderInput

用于解决订单操作的输入。

output

ResolveOrderOutput

解决顺序操作的输出。

ResolveOrderInput

用于解决订单交互的输入。

字段
payload

Struct

用于解决订单互动问题的载荷。

ResolveOrderOutput

解决订单互动时的输出。

字段
payload

Struct

用于解决订单互动输出的载荷。

SubmitOrder

此类型没有字段。

提交订单互动。

UserUtterance

用户话语。

字段
text

string

用户话语的文本。

create_time

Timestamp

仅限输出。用户话语发生时的时间戳。

InteractionMode

代理的互动模式。

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

InterruptionSignal

此类型没有字段。

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

IntervalMetrics

表示特定时间间隔的分析指标。

字段
interval

Interval

这些指标反映的开始 / 结束时间。

total_order_count

int64

仅限输出。订单总数。

success_order_count

int64

仅限输出。成功订单的数量。

avg_order_duration_ms

int64

仅限输出。平均订单时长(以毫秒为单位)。

upsell_success_rate

double

仅限输出。追加销售成功率。

upsell_revenue

Money

仅限输出。追加销售收入。

escalation_count

int64

仅限输出。升级结果组数量。

predicted_failure_category_counts[]

PredictedFailureCategoryCount

仅限输出。预测的故障类别数量。

invalid_order_count

int64

仅限输出。无效订单的总数。

crew_escalation_count

int64

仅限输出。乘务员升级订单的数量。

PredictedFailureCategoryCount

预测的故障类别数量。

字段
category

string

仅限输出。预测的故障类别。

count

int64

仅限输出。相应类别的会话次数。

库存

商店的商品目录资源。

字段
name

string

标识符。相应媒体资源的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

item_id

string

必需。相应广告资源所属的商品 ID。

modifier_id

string

可选。相应广告资源所属的加价幅度 ID。

pos_id

string

可选。与相应商品目录相关联的销售终端 (POS) ID。

quantity

int32

可选。商品/加项的库存数量。

status

Status

可选。库存状态。

状态

媒体文件的可用性状态。

枚举
STATUS_UNSPECIFIED 未指定状态。
IN_STOCK 商品/加项有货。
OUT_OF_STOCK 相应商品/修饰项缺货。

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

字段
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 应用于此项的修饰符。

ItemGroup

菜单中的一组商品,由选择条件定义,用于指定折扣所需的商品或适用的商品。下一个 ID:6

字段
name

string

可选。商品组的名称。

联合字段 type。商品组的类型。type 只能是下列其中一项:
select_items

SelectItems

匹配器列表。如果商品满足以下任一 ItemMatcher 条件(OR 逻辑),则视为匹配。

all_of

AllOf

表示子组的逻辑 AND。

any_of

AnyOf

表示子组的逻辑 OR。

AllOf

表示子组的逻辑 AND。

字段
groups[]

ItemGroup

必需。子组组件。

AnyOf

表示子组的逻辑 OR。

字段
groups[]

ItemGroup

必需。子组组件。

SelectItems

定义一项要求,即选择特定数量的商品,其中每件商品都符合所提供的任何 ItemCriteria。

字段
matches[]

ItemMatcher

必需。商品的匹配器。

min_quantity

int32

可选。匹配所需的最低数量。

max_quantity

int32

可选。允许的匹配数量上限。

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。

ItemMatcher

定义匹配单个商品的条件。所有指定的字段都使用 AND 进行组合。下一个 ID:5

字段
item_id

string

可选。要匹配的商品 ID。

modifier_id

string

可选。要匹配的修饰符 ID。

category_id

string

可选。要匹配的类别 ID。

modifier_matcher

ModifierMatcher

可选。定义修饰符的条件,以便与商品匹配。

ModifierMatcher

定义匹配调节系数的条件。

字段
allowed_modifier_ids[]

string

可选。应用折扣所需的修饰符 ID。

min_modifiers

int32

可选。匹配所需的最小修饰符数量。如果设置了 required_modifier_ids,则只会统计列表中的修饰符。

max_modifiers

int32

可选。一次匹配允许的修饰符数量上限。如果设置了 required_modifier_ids,则只会统计列表中的修饰符。

ListBrandHistoryRequest

MenuService.ListBrandHistory 的请求消息。

字段
parent

string

必需。要列出历史记录的品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的最大历史记录条目数。

page_token

string

可选。从之前的 ListBrandHistory 调用中收到的页面令牌。

filter

string

可选。用于过滤结果的过滤表达式。支持的过滤条件:- user:按创建者用户过滤。- timestamp:按提交时间过滤。- resource_type:按资源类型过滤。

ListBrandHistoryResponse

MenuService.ListBrandHistory 的响应消息。

字段
brand_history[]

HistoryEntry

历史记录条目。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。

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 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListDiscountsRequest

MenuService.ListDiscounts 的请求消息。

字段
parent

string

必需。拥有相应折扣集合的父级商店。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}

page_size

int32

可选。要返回的折扣数量上限。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListDiscounts 调用接收的页面令牌。利用其进行后续页面检索。

filter

string

可选。基于 AIP-160 的过滤表达式。

ListDiscountsResponse

MenuService.ListDiscounts 的响应消息。

字段
discounts[]

Discount

指定集合中的折扣。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEvaluationCaseResultsRequest

MenuService.ListEvaluationCaseResults 的请求消息。

字段
parent

string

必需。拥有此评估案例结果集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的评估案例结果数上限。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListEvaluationCaseResults 调用接收的页面令牌。利用其进行后续页面检索。

filter

string

可选。仅检索与过滤条件匹配的评估案例结果。目前仅支持按 evaluation_case 进行过滤,例如 evaluation_case="projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{case_id}"

ListEvaluationCaseResultsResponse

MenuService.ListEvaluationCaseResults 的响应消息。

字段
evaluation_case_results[]

EvaluationCaseResult

指定集合中的评估案例结果。[(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEvaluationCasesRequest

MenuService.ListEvaluationCases 的请求消息。

字段
parent

string

必需。拥有此评估案例集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的评估案例数量上限。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListEvaluationCases 调用接收的页面令牌。利用其进行后续页面检索。

ListEvaluationCasesResponse

MenuService.ListEvaluationCases 的响应消息。

字段
evaluation_cases[]

EvaluationCase

指定集合中的评估案例。[(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEvaluationContextsRequest

MenuService.ListEvaluationContexts 的请求消息。

字段
parent

string

必需。拥有此评估上下文集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的评估上下文数量上限。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListEvaluationContexts 调用接收的页面令牌。利用其进行后续页面检索。

ListEvaluationContextsResponse

MenuService.ListEvaluationContexts 的响应消息。

字段
evaluation_contexts[]

EvaluationContext

指定集合中的评估上下文。[(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEvaluationDatasetResultsRequest

MenuService.ListEvaluationDatasetResults 的请求消息。

字段
parent

string

必需。拥有此评估数据集结果集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的评估数据集结果数上限。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListEvaluationDatasetResults 调用接收的页面令牌。利用其进行后续页面检索。

ListEvaluationDatasetResultsResponse

MenuService.ListEvaluationDatasetResults 的响应消息。

字段
evaluation_dataset_results[]

EvaluationDatasetResult

指定集合的评估数据集结果。[(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEvaluationDatasetsRequest

MenuService.ListEvaluationDatasets 的请求消息。

字段
parent

string

必需。拥有此评估数据集集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的评估数据集数量上限。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListEvaluationDatasets 调用接收的页面令牌。利用其进行后续页面检索。

ListEvaluationDatasetsResponse

MenuService.ListEvaluationDatasets 的响应消息。

字段
evaluation_datasets[]

EvaluationDataset

指定集合中的评估数据集。[(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListEvaluationMatchersRequest

MenuService.ListEvaluationMatchers 的请求消息。

字段
parent

string

必需。拥有此评估匹配器集合的父品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的评估匹配器数量上限。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListEvaluationMatchers 调用接收的页面令牌。利用其进行后续页面检索。

ListEvaluationMatchersResponse

MenuService.ListEvaluationMatchers 的响应消息。

字段
evaluation_matchers[]

EvaluationMatcher

指定集合中的评估匹配器。[(google.api.field_policy).auditing = "AUDIT_SIZE"];

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListIngestionLogsRequest

MenuService.ListIngestionLogs 的请求消息。

字段
parent

string

必需。拥有此提取日志集合的父级资源。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的提取日志数量上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个提取日志。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。

page_token

string

可选。从之前的 ListIngestionLogs 调用接收的页面令牌。利用其进行后续页面检索。

进行分页时,提供给 ListIngestionLogs 的所有其他参数必须与提供页面令牌的调用匹配。

filter

string

可选。用于限制返回的提取日志的过滤表达式。

ListIngestionLogsResponse

MenuService.ListIngestionLogs 的响应消息。

字段
ingestion_logs[]

IngestionLog

指定集合的提取日志。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListInventoriesRequest

MenuService.ListInventories 的请求消息。

字段
parent

string

必需。拥有相应库存集合的父级商店。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}

page_size

int32

可选。要返回的最大商品目录数。服务返回的值可能小于此值。

page_token

string

可选。从之前的 ListInventories 调用接收的页面令牌。利用其进行后续页面检索。

filter

string

可选。基于 AIP-160 的过滤表达式。

ListInventoriesResponse

MenuService.ListInventories 的响应消息。

字段
inventories[]

Inventory

指定集合中的媒体文件。

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 - brand

store=projects/my-project/locations/us-central1/brands/my-brand/stores/my-store - brand=projects/my-project/locations/us-central1/brands/my-brand

view

MenuView

可选。要为菜单返回的视图。

ListMenusResponse

MenuService.ListMenus 的响应消息。

字段
menus[]

Menu

指定集合中的菜单。

next_page_token

string

可作为 page_token 发送并用于检索下一页的令牌。如果省略此字段,则不存在后续页面。

ListSessionRecordsRequest

针对 [SessionRecordService.ListSessionRecords][] 的请求消息。

字段
parent

string

必需。要列出订单会话的品牌。格式:projects/{project}/locations/{location}/brands/{brand}

page_size

int32

可选。要返回的会话记录数上限。服务返回的值可能小于此值。如果未指定,则最多返回 50 个会话。最大值为 1,000;大于 1,000 的值将被强制转换为 1,000。

page_token

string

可选。从之前的 ListSessionRecords 调用接收的页面令牌。利用其进行后续页面检索。

filter

string

可选。基于 AIP-160 的过滤表达式。此字段允许根据各种属性过滤会话记录。

支持的过滤字段:

  • session_id(字符串):会话的 ID。运算符:= 示例:session_id = "session-123"

  • store_id(字符串):商店的 ID。运算符:=、!= 示例:store_id = "store-123"

  • store_ids(字符串):以英文逗号分隔的商店 ID 列表。运算符:=、!=、: 示例:store_ids = "store-123,store-456"

  • session_start_time(时间戳):会话的开始时间。时间戳应采用 RFC-3339 格式的字符串(例如 2012-04-21T11:30:00-04:00)。支持 UTC 偏移量运算符:=、!=、

    、>=、<、<= 示例:session_start_time >= "2025-10-01T00:00:00Z"

  • outcome_label(字符串):会话的最终结果标签。运算符:=、!= 示例:outcome_label = "SUCCESS"

  • outcome_group_label(字符串):会话结果的组标签。运算符:=、!= 示例:outcome_group_label = "SUCCESS"

  • predicted_failure_category(字符串):干预分析得出的会话的预测失败类别。运算符:=、!= 示例:predicted_failure_category = "Menu"

  • agent_utterances(字符串):智能体说出的文本。运算符::(包含词元/全文搜索)示例:agent_utterances:"anything else"

  • user_utterances(字符串):用户所说的文本。运算符::(包含词元/全文搜索)示例:user_utterances:"burger"

逻辑运算符:

可以使用 ANDORNOT 组合条件。您可以使用英文括号 () 对表达式进行分组,以控制评估顺序。示例:(user_utterances:"help" OR agent_utterances:"issue") AND store_id != "test-store" 示例:user_utterances:"order" AND session_start_time >= "2025-10-03T00:00:00Z"

ListSessionRecordsResponse

针对 [SessionRecordService.ListSessionRecords][] 的响应消息。

字段
session_records[]

SessionRecord

会话记录的列表。

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"

  • tags(字符串):与商店关联的标记。运算符::(包含)示例:tags:"store-tag"

  • city(字符串):商店所在的城市。运算符:=、!= 示例:city = "Mountain View"

  • 州(字符串):商店地址的州。运算符:=、!= 示例:state = "CA"

逻辑运算符:

可以使用 ANDORNOT 组合条件。您可以使用英文括号 () 对表达式进行分组,以控制评估顺序。示例: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

可选。此菜单中的菜单时间表。

定义包含商品或加项的类别。类别用于在界面中整理商品,并用于智能体的语义分组。

字段
id

string

必需。相应菜单类别的标识符,在菜单中必须是唯一的。

display_name

string

可选。要在界面中使用的相应菜单类别的人类可读名称。

description

string

可选。人类可读的说明。

parent_id

string

可选。父级菜单类别 ID。如果为空,则表示这是顶级类别。

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

字段
name

string

必需。标签的名称。

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

字段
id

string

可选。时间表 ID,例如“BREAKFAST”“LUNCH”等。

schedules[]

Schedule

可选。安排活跃时间。

display_name

string

可选。为此时间表指定可选的显示名称。

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

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

MessageConfig

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

字段
language_code

string

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

message_text

string

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

MockClientExecution

表示模拟的客户端执行请求和响应对。如果评估运行中食品订购服务发送的请求与模拟请求匹配,则系统会将模拟响应返回给该服务。请注意,在匹配过程中,系统会忽略 request.execution_id,因为它特定于会话。

字段
raw_json_request

Struct

可选。模拟客户端执行的请求。

raw_json_response

Struct

可选。模拟客户端执行的响应。

修饰符

通过 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。

OfferMessage

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

字段
display_name

string

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

message_frequency

float

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

upsold_items[]

string

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

message_configs[]

MessageConfig

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

upsold_item_ids[]

string

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

OperationsConfig

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

字段
display_name

string

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

description

string

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

upsell_strategy

UpsellStrategy

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

greetings[]

Greetings

可选。要使用的自定义问候语消息(按语言)。

default_language_code

string

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

features_config

FeaturesConfig

可选。代理功能配置。

interaction_mode

InteractionMode

可选。代理的互动模式。

disambiguation_strategy

DisambiguationStrategy

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

订单

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

字段
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

可选。相应商品在订单中的数量。

total_price

Money

仅限输出。相应订单项的总价,包括所选的加项,反映了商品数量,但不含税。用于显示每个商品的购物袋。

category_ids[]

string

仅限输出。相应菜单项所属的类别 ID。镜像菜单的 Item.category_ids,以便客户端可以按菜单类别对订购的商品进行分组。

OrderMetadata

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

字段
collected_customer_name

string

可选。在接单时收集的客户姓名。仅当代理配置为收集客户姓名时才会填充。此类数据可能通过口头收集,可能包含拼写错误或转写错误,因此在向用户显示时应谨慎处理,并且不应将其视为可信信息(例如支付信息)。

caller_phone_number

string

可选。下单客户的手机号码。

delivery_address

DeliveryAddress

可选。如果订单是配送订单,则为配送地址。

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

可选。应用于此修饰符的嵌套修饰符组。

is_default

bool

仅限输出。相应修饰符是否是其修饰符组的默认选择。需要此属性,以便客户端可以计算准确的选择差异。

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

可选。订单中应用的税费金额。

discount

Money

可选。应用于订单的总折扣

saving

Money

可选。已将优惠节省金额应用于订单

fees

Money

可选。订单的总费用

OrderPricesRequest

获取订单价格的请求。

字段
order

Order

可选。要获取价格的订单。如果未指定,我们可以假设请求是针对会话中的现有订单/购物车。

OrderPricesResponse

获取订单价格的结果。

字段
success

bool

必需。是否已成功检索订单价格。

order_price_info

OrderPriceInfo

可选。应用所有折扣、费用、税费等后的订单总价

OrderStatusRequest

此类型没有字段。

获取订单状态的请求。

OrderStatusResponse

获取订单状态的结果。

字段
success

bool

必需。是否成功检索到订单状态。

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 信用卡。
PAYMENT_METHOD_CASH 现金。

ProcessOrderRequest

FoodOrderingService.ProcessOrder 的请求消息。

字段
config

Config

必需。会话和订餐属性的配置。

turn_type

TurnType

可选。明确指示请求在会话生命周期中的位置。允许客户端确定性地控制何时注入初次会话设置变量。

联合字段 input。来自客户端的输入。input 只能是下列其中一项:
text_input

TextInput

来自客户端的文本输入。

audio_input

AudioInput

来自客户端的音频输入。

event_input

EventInput

来自客户端的事件输入。

client_execution_result

ClientExecutionResult

客户端执行请求的结果。

blob_input

Blob

通用二进制数据输入。镜像 http://google3/google/cloud/ces/v1main/session_service.proto?l=720

TurnType

表示会话中一元请求的生命周期位置。

枚举
TURN_TYPE_UNSPECIFIED 未指定转弯类型。
INITIALIZE 明确指示此请求以一元模式初始化会话。设置后,初始会话变量(例如,商店元数据和菜单)会注入到 CES 中。
SUBSEQUENT 明确指示后续对话轮次或会话中更新。设置后,系统会省略初次会话变量,以防止输入令牌爆炸。

ProcessOrderResponse

针对 FoodOrderingService.ProcessOrder 的响应消息。在功能上包含 BidiProcessOrderResponse 中的字段,但不包含流式传输专用字段。

字段
responses[]

BidiProcessOrderResponse

仅限输出。针对请求的代理响应列表,按顺序返回。

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

客服人员正在请客户确认重启请求。

RevisionAction

创建修订版本的操作。

枚举
REVISION_ACTION_UNSPECIFIED 未指定的操作。
CREATE 修订版本是因资源创建而创建的。
UPDATE 修订版本是因资源更新而创建的。

RunEvaluationCaseMetadata

针对 EvaluationRunService.RunEvaluationCase 的元数据消息。

字段
evaluation_case

EvaluationCase

仅限输出。正在运行的评估用例。

create_time

Timestamp

仅限输出。操作的开始时间。

RunEvaluationCaseRequest

EvaluationRunService.RunEvaluationCase 的请求消息。

字段
name

string

必需。要运行的评估用例的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

RunEvaluationCaseResponse

EvaluationRunService.RunEvaluationCase 的响应消息。

字段
result

EvaluationCaseResult

仅限输出。评估用例运行的结果。

RunEvaluationDatasetMetadata

针对 EvaluationRunService.RunEvaluationDataset 的元数据消息。

字段
evaluation_dataset

EvaluationDataset

仅限输出。正在运行的评估数据集。

completed_cases_count

int32

仅限输出。已完成执行的评估用例数。

passed_cases_count

int32

仅限输出。到目前为止已通过的评估案例数。

create_time

Timestamp

仅限输出。相应操作的创建时间。

completed_case_details[]

CompletedCase

仅限输出。已完成执行的测试用例。

CompletedCase

已完成执行的测试用例。

字段
evaluation_case

string

仅限输出。评估案例的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

evaluation_case_result

string

仅限输出。评估案例结果的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCaseResults/{evaluation_case_result}

RunEvaluationDatasetRequest

EvaluationRunService.RunEvaluationDataset 的请求消息。

字段
name

string

必需。要运行的评估数据集的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

RunEvaluationDatasetResponse

EvaluationRunService.RunEvaluationDataset 的响应消息。

字段
result

EvaluationDatasetResult

仅限输出。评估数据集运行的结果。

时间表

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

字段
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

可选。情感的强度,无论得分如何。

SessionRecord

表示单个会话记录。

字段
name

string

标识符。SessionRecord 的资源名称。格式:projects/{project}/locations/{location}/brands/{brand}/sessionRecords/{session_record}

session_start_time

Timestamp

仅限输出。会话开始时的时间戳。

store_id

string

不可变。下单的商店的 ID。

lane_id

string

不可变。订单会话的通道 ID。

interactions[]

Interaction

仅限输出。话题回合。

outcome_label

string

仅限输出。订单的最终结果标签。

outcome_group_label

string

仅限输出。相应结果的组标签。

audio_recording_path

string

仅限输出。完整录音的路径。

order

Order

仅限输出。与会话记录关联的订单。

session_duration

Duration

仅限输出。会话的总时长。

upsell_attempt_records[]

UpsellAttemptRecord

仅限输出。在会话期间执行的追加销售。

audio_recording

bytes

仅限输出。会话的录音。仅在调用 GetSessionRecord 时,系统才会填充此字段。

traffic_type

TrafficType

仅限输出。相应会话的流量类型。

channel_type

ChannelType

仅限输出。会话所用的渠道类型(例如,得来速、移动应用、手机)。

SpeechRecognition

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

字段
transcript

string

以检测到的语言转写的音频输入内容。

language_code

string

转写的语言代码。语言代码应采用 BCP-47 格式,例如“en-US”。

is_final

bool

指示相应转写是否为相应轮次的最终转写。

存储

品牌的单个商店。

字段
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

可选。商店在指定 fulfillment_method 下的营业时间。

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。

action

RevisionAction

仅限输出。创建相应修订版本的操作。

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

要向客户推荐的商品。

SuggestedModGroup

要向客户建议的修饰符组。

字段
modifier_group_id

string

菜单中修饰符组的 ID。

display_name

string

修饰符组的显示名称。

modifiers[]

SuggestedModifier

相应组中的修饰符。

max_selection_count

int32

可从相应组中选择的修饰符数量上限。

min_selection_count

int32

必须从相应组中选择的修饰符数量下限。

max_selection_count_per_modifier

int32

限制每个修饰符在此组中可应用的次数。

SuggestedModifier

要向客户建议的修饰符。

字段
modifier_id

string

菜单中修饰符的 ID。

modifier_group_id

string

如果建议被接受,相应修饰符应添加到的修饰符组的 ID。

modifier_group_display_name

string

相应修饰符所属的修饰符组的显示名称。

display_name

string

要在界面上显示的相应项的人类可读名称。

image

Image

要在界面中为此商品显示的图片。

price_adjustment

Money

与此修饰符关联的价格调整(如果有)。这是相应修饰符的单价。

integration_attributes

ModifierIntegrationAttributes

与此实体关联的元数据,用于下游集成。

already_included

bool

相应修饰符是否已包含在订单中。

SuggestedModifierGroups

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

字段
modifier_groups[]

SuggestedModGroup

要向客户建议的加购项组。

SuggestedModifiers

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

字段
modifiers[]

SuggestedModifier

要向客户建议的修饰符。

parent_uid

string

要应用修饰符的父商品/修饰符的唯一标识符。

SuggestedOptions

可向客户建议的选项。

字段
suggested_modifier_groups

SuggestedModifierGroups

一组建议的修饰符。

联合字段 suggested_options。建议的选项。suggested_options 只能是下列其中一项:
suggested_items

SuggestedItems

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

suggested_modifiers

SuggestedModifiers

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

TargetItem

结构化商品替代目标。

字段
item_name

string

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

modifiers[]

TargetModifier

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

item_id

string

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

TargetModifier

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

字段
modifier_name

string

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

modifier_group_name

string

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

modifier_id

string

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

modifier_group_id

string

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

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

可选。要更新的字段列表

UpdateDiscountRequest

MenuService.UpdateDiscount 的请求消息。

字段
discount

Discount

必需。要更新的折扣。

折扣的 name 字段用于标识要更新的折扣。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/discounts/{discount}

update_mask

FieldMask

可选。要更新的字段列表

allow_missing

bool

可选。如果设置为 true,并且未找到折扣,则系统会创建新的折扣。在这种情况下,系统会忽略 update_mask

UpdateEvaluationCaseRequest

MenuService.UpdateEvaluationCase 的请求消息。

字段
evaluation_case

EvaluationCase

必需。要更新的评估案例。

评估用例的 name 字段用于标识要更新的评估用例。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationCases/{evaluation_case}

update_mask

FieldMask

可选。要更新的字段列表

allow_missing

bool

可选。如果设置为 true,并且未找到评估情形,则系统会创建新的评估情形。在这种情况下,系统会忽略 update_mask

UpdateEvaluationContextRequest

MenuService.UpdateEvaluationContext 的请求消息。

字段
evaluation_context

EvaluationContext

必需。要更新的评估上下文。

评估上下文的 name 字段用于标识要更新的评估上下文。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationContexts/{evaluation_context}

update_mask

FieldMask

可选。要更新的字段列表

UpdateEvaluationDatasetRequest

MenuService.UpdateEvaluationDataset 的请求消息。

字段
evaluation_dataset

EvaluationDataset

必需。要更新的评估数据集。

评估数据集的 name 字段用于标识要更新的评估数据集。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationDatasets/{evaluation_dataset}

update_mask

FieldMask

可选。要更新的字段列表

UpdateEvaluationMatcherRequest

MenuService.UpdateEvaluationMatcher 的请求消息。

字段
evaluation_matcher

EvaluationMatcher

必需。要更新的评估匹配器。

评估匹配器的 name 字段用于标识要更新的评估匹配器。格式:projects/{project}/locations/{location}/brands/{brand}/evaluationMatchers/{evaluation_matcher}

update_mask

FieldMask

可选。要更新的字段列表

UpdateInventoryRequest

MenuService.UpdateInventory 的请求消息。

字段
inventory

Inventory

必需。要更新的商品目录。

相应广告资源的 name 字段用于标识要更新的广告资源。格式:projects/{project}/locations/{location}/brands/{brand}/stores/{store}/inventories/{inventory}

update_mask

FieldMask

可选。要更新的字段列表

allow_missing

bool

可选。如果设置为 true,并且未找到相应广告资源,则系统会创建新的广告资源。在这种情况下,系统会忽略 update_mask

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

与相应会话关联的订单的更新状态。

changed

bool

仅限输出。订单状态是否有更新。

UpsellAttemptRecord

表示追加销售尝试。此数据用于在控制台订单历史记录中显示追加销售信息,即追加销售类型、turn id 和追加销售是否被接受,并且根据处理后的日志从 Spanner 中填充。

字段
turn_id

int32

仅限输出。出现追加销售机会的对话轮次的 ID。

upsell_type

string

仅限输出。追加销售事件的类型。

accepted

bool

仅限输出。追加销售是否已被接受。

UpsellConfig

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

字段
display_name

string

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

priority

int32

必需。一个数字,表示相对于给定 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)。
skip_on_multi_quantity_upsold_from_item

bool

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

skip_on_previous_turn_upsell

bool

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

disabled

bool

可选。指示追加销售类型是否已停用。如果值为 true,则不会尝试追加销售。此配置可用于在配置应用规则替换中停用追加销售类型。

联合字段 upsell_type_config。追加销售的类型特定配置。upsell_type_config 只能是下列其中一项:
greeting_offer

GreetingOffer

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

closing_offer

ClosingOffer

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

cel_upsell

CelUpsell

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

UpsellStrategy

定义追加销售策略。

字段
max_upsell_offers

int32

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

max_upsell_declines

int32

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

max_items_in_cart

int32

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

upsells[]

UpsellConfig

可选。配置的追加销售。

catering_guidelines

string

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

UserInfo

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

字段
preferred_name

string

可选。代理应使用哪个用户的名称来称呼用户。Food AI 客户端负责根据用户个人资料选择首选名称,并确保其符合品牌惯例,例如使用名字或全名。

payment_info

PaymentInfo

可选。用户的支付信息。

delivery_address
(deprecated)

string

可选。已弃用:请改用 saved_delivery_address。用户的已保存配送地址。

past_orders[]

PastOrder

可选。用户的订单历史记录。

loyalty_info

LoyaltyInfo

可选。用户的会员信息。

phone_number

string

可选。用户的手机号码。

user_id

string

可选。用户在客户系统中的唯一标识符。

saved_delivery_address

DeliveryAddress

可选。用户的已保存配送地址。将替换现有的字符串 delivery_address 字段。

ValidateDeliveryAddressRequest

用于验证在会话期间收集的配送地址的请求。

字段
delivery_address

DeliveryAddress

必需。要验证的配送地址。

ValidateDeliveryAddressResponse

验证配送地址的结果。

字段
success

bool

必需。验证是否已完成且未出错。

validation_status

ValidationStatus

必需。配送地址的验证状态。