REST Resource: projects.locations.collections.engines

• 资源：Engine
  • JSON 表示法
• ChatEngineConfig
  • JSON 表示法
• AgentCreationConfig
  • JSON 表示法
• SearchEngineConfig
  • JSON 表示法
• SearchTier
• SearchAddOn
• MediaRecommendationEngineConfig
  • JSON 表示法
• OptimizationObjectiveConfig
  • JSON 表示法
• TrainingState
• EngineFeaturesConfig
  • JSON 表示法
• RecommendedForYouFeatureConfig
  • JSON 表示法
• MostPopularFeatureConfig
  • JSON 表示法
• ChatEngineMetadata
  • JSON 表示法
• CommonConfig
  • JSON 表示法
• AppType
• FeatureState
• ConfigurableBillingApproach
• 方法

资源：引擎

描述 Engine 的训练和部署参数的元数据。

JSON 表示法

{ "name": string, "displayName": string, "createTime": string, "updateTime": string, "dataStoreIds": [ string ], "solutionType": enum (SolutionType), "industryVertical": enum (IndustryVertical), "commonConfig": { object (CommonConfig) }, "appType": enum (AppType), "disableAnalytics": boolean, "features": { string: enum (FeatureState), ... }, "configurableBillingApproach": enum (ConfigurableBillingApproach), // Union field engine_config can be only one of the following: "chatEngineConfig": { object (ChatEngineConfig) }, "searchEngineConfig": { object (SearchEngineConfig) }, "mediaRecommendationEngineConfig": { object (MediaRecommendationEngineConfig) } // End of list of possible types for union field engine_config. // Union field engine_metadata can be only one of the following: "chatEngineMetadata": { object (ChatEngineMetadata) } // End of list of possible types for union field engine_metadata. }

字段
name	string 不可变。标识符。引擎的完全限定资源名称。 此字段必须是采用 UTF-8 编码的字符串，长度上限为 1024 个字符。 格式：projects/{project}/locations/{location}/collections/{collection}/engines/{engine} 引擎应为 1-63 个字符，有效字符为 /[a-z0-9][a-z0-9-_]*/。否则，系统会返回 INVALID_ARGUMENT 错误。
displayName	string 必需。引擎的显示名称。应采用人类可读懂的格式。UTF-8 编码的字符串，长度上限为 1024 个字符。
createTime	string (Timestamp format) 仅限输出。创建推荐引擎时的时间戳。 采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
updateTime	string (Timestamp format) 仅限输出。上次更新 Recommendation Engine 时的时间戳。 采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"
dataStoreIds[]	string 可选。与此引擎关联的数据存储区。 对于 SOLUTION_TYPE_SEARCH 和 SOLUTION_TYPE_RECOMMENDATION 类型的引擎，它们最多只能与一个数据存储区相关联。 如果 solutionType 为 SOLUTION_TYPE_CHAT，则可以在此处关联同一 Collection 中的多个 DataStore。 请注意，在 CreateEngineRequest 中使用时，必须提供一个 DataStore ID，因为系统会使用它进行必要的初始化。
solutionType	enum (SolutionType) 必需。引擎的解决方案。
industryVertical	enum (IndustryVertical) 可选。引擎注册的行业纵向市场。引擎行业垂直领域的限制基于 DataStore：引擎上的垂直领域必须与链接到引擎的 DataStore 的垂直领域相匹配。
commonConfig	object (CommonConfig) 指定引擎元数据的通用配置规范。
appType	enum (AppType) 可选。不可变。相应引擎资源所代表的应用类型。注意：这是一个独立于现有行业垂直领域或解决方案类型的新概念。
disableAnalytics	boolean 可选。是否针对在此引擎上执行的搜索停用分析功能。
features	map (key: string, value: enum (FeatureState)) 可选。供引擎选择启用或停用功能的特征配置。支持的密钥： *：所有功能，如果存在，则忽略所有其他功能状态设置。 agent-gallery no-code-agent-builder prompt-gallery model-selector notebook-lm people-search people-search-org-chart bi-directional-audio feedback session-sharing personalization-memory disable-agent-sharing disable-image-generation disable-video-generation disable-onedrive-upload disable-talk-to-content disable-google-drive-upload
configurableBillingApproach	enum (ConfigurableBillingApproach) 可选。可配置结算方式的配置。
联合字段 engine_config。定义引擎行为的其他配置规范。engine_config 只能是下列其中一项：
chatEngineConfig	object (ChatEngineConfig) 聊天引擎的配置。仅在 solutionType 为 SOLUTION_TYPE_CHAT 时适用。
searchEngineConfig	object (SearchEngineConfig) 搜索引擎的配置。仅在 solutionType 为 SOLUTION_TYPE_SEARCH 时适用。
mediaRecommendationEngineConfig	object (MediaRecommendationEngineConfig) 媒体引擎的配置。仅适用于具有 solutionType SOLUTION_TYPE_RECOMMENDATION 和 IndustryVertical.MEDIA 垂直行业的数据存储区。
联合字段 engine_metadata。用于监控引擎状态的引擎元数据。engine_metadata 只能是下列其中一项：
chatEngineMetadata	object (ChatEngineMetadata) 仅限输出。有关 Chat Engine 的其他信息。仅在 solutionType 为 SOLUTION_TYPE_CHAT 时适用。

ChatEngineConfig

聊天引擎的配置。

JSON 表示法
{ "agentCreationConfig": { object (AgentCreationConfig) }, "dialogflowAgentToLink": string, "allowCrossRegion": boolean }

字段
agentCreationConfig	object (AgentCreationConfig) 用于生成与此引擎关联的 Dialogflow 代理的配置。 请注意，这些配置由 Dialogflow 服务一次性使用并传递给该服务。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。
dialogflowAgentToLink	string 要与此 Chat Engine 关联的现有 Dialogflow 代理的资源名称。客户可以提供 agentCreationConfig 来创建代理，也可以提供将代理与 Chat 引擎相关联的代理名称。 格式：projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。 请注意，dialogflowAgentToLink 由 Dialogflow 服务一次性消耗并传递给该服务。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。在创建 Engine 后，使用 ChatEngineMetadata.dialogflow_agent 进行实际的代理关联。
allowCrossRegion	boolean 可选。如果该标志设置为 true，则允许代理和引擎位于不同的位置；否则，代理和引擎必须位于同一位置。该标志默认设置为 false。 请注意，allowCrossRegion 由 EngineService.CreateEngine 一次性消耗并传递给 EngineService.CreateEngine。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。

AgentCreationConfig

用于生成 Dialogflow 代理的配置。

请注意，这些配置由 Dialogflow 服务一次性使用并传递给该服务。这意味着，在创建引擎后，无法使用 EngineService.GetEngine 或 EngineService.ListEngines API 检索这些数据。

JSON 表示法
{ "business": string, "defaultLanguageCode": string, "timeZone": string, "location": string }

字段
business	string 代理人所代表的公司、组织或其他实体的名称。用于知识连接器 LLM 提示和知识搜索。
defaultLanguageCode	string 必需。代理的默认语言，采用语言代码的形式表示。请参阅语言支持以获取当前支持的语言代码列表。
timeZone	string 必需。根据时区数据库确定的代理时区，例如 America/New_York、Europe/Paris。
location	string 创建代理时使用的代理位置，支持的值：global/us/eu。如果未提供，美国引擎将默认使用 us-central-1 创建代理；欧盟引擎将默认使用 eu-west-1 创建代理。

SearchEngineConfig

搜索引擎的配置。

JSON 表示法
{ "searchTier": enum (SearchTier), "searchAddOns": [ enum (SearchAddOn) ] }

字段
searchTier	enum (SearchTier) 相应引擎的搜索功能层级。 不同层级的价格可能不同。如需了解详情，请参阅价格文档。 如果未指定，则默认为 SearchTier.SEARCH_TIER_STANDARD。
searchAddOns[]	enum (SearchAddOn) 相应搜索引擎启用的插件。

SearchTier

搜索功能层级。不同层级的价格可能不同。如需了解详情，请参阅价格文档。

枚举
SEARCH_TIER_UNSPECIFIED	未指定枚举时的默认值。此功能无法使用。
SEARCH_TIER_STANDARD	标准层级。
SEARCH_TIER_ENTERPRISE	Enterprise 层级。

SearchAddOn

可为搜索提供额外功能的插件。

枚举
SEARCH_ADD_ON_UNSPECIFIED	未指定枚举时的默认值。此功能无法使用。
SEARCH_ADD_ON_LLM	大语言模型加购项。

MediaRecommendationEngineConfig

媒体推荐引擎的其他配置规范。

JSON 表示法
{ "type": string, "optimizationObjective": string, "optimizationObjectiveConfig": { object (OptimizationObjectiveConfig) }, "trainingState": enum (TrainingState), "engineFeaturesConfig": { object (EngineFeaturesConfig) } }

字段
type	string 必需。引擎类型。例如，recommended-for-you。 此字段与 optimizationObjective 一起描述了用于控制引擎训练和服务的引擎元数据。 目前支持的值：recommended-for-you、others-you-may-like、more-like-this、most-popular-items。
optimizationObjective	string 优化目标。例如，cvr。 此字段与 optimizationObjective 一起描述了用于控制引擎训练和服务的引擎元数据。 目前支持的值：ctr、cvr。 如果未指定，我们会根据引擎类型选择默认值。默认值取决于建议类型： recommended-for-you => ctr others-you-may-like => ctr
optimizationObjectiveConfig	object (OptimizationObjectiveConfig) 以提高转化率为优化目标的自定义阈值的名称和值。对于 targetField watch-time，target_field_value 必须是一个整数值，表示媒体进度时间（以秒为单位），介于 (0, 86400] 之间（不包括 0，包括 86400）（例如，90）。对于 targetField watch-percentage，target_field_value 必须是介于 (0, 1.0] 之间的有效浮点值（不含 0，含 1.0）（例如，0.5）。
trainingState	enum (TrainingState) 引擎所处的训练状态（例如 TRAINING 或 PAUSED）。 由于运行服务的部分费用取决于训练频率，因此可以使用此参数来确定何时训练引擎，以便控制费用。如果未指定：engines.create 方法的默认值为 TRAINING。engines.patch 方法的默认值是保持状态与之前相同。
engineFeaturesConfig	object (EngineFeaturesConfig) 可选。其他引擎功能配置。

OptimizationObjectiveConfig

cvr 优化目标的自定义阈值。

JSON 表示法
{ "targetField": string, "targetFieldValueFloat": number }

字段
targetField	string 必需。要定位的字段的名称。目前支持的值：watch-percentage、watch-time。
targetFieldValueFloat	number 必需。要应用于目标的阈值（例如，0.5）。

TrainingState

引擎的训练状态。

枚举
TRAINING_STATE_UNSPECIFIED	未指定训练状态。
PAUSED	引擎训练已暂停。
TRAINING	引擎正在训练。

EngineFeaturesConfig

所选引擎类型的更多功能配置。

JSON 表示法
{ // Union field type_dedicated_config can be only one of the following: "recommendedForYouConfig": { object (RecommendedForYouFeatureConfig) }, "mostPopularConfig": { object (MostPopularFeatureConfig) } // End of list of possible types for union field type_dedicated_config. }

字段
联合字段 type_dedicated_config。应用于特定类型的媒体建议引擎的相关功能配置。type_dedicated_config 只能是下列其中一项：
recommendedForYouConfig	object (RecommendedForYouFeatureConfig) 建议的引擎功能配置。
mostPopularConfig	object (MostPopularFeatureConfig) 最受欢迎的引擎功能配置。

RecommendedForYouFeatureConfig

用于创建 recommended-for-you 引擎的其他功能配置。

JSON 表示法
{ "contextEventType": string }

字段
contextEventType	string 在预测时查询引擎所用的事件类型。如果设置为 generic，则在引擎训练中，只有 view-item、media-play 和 media-complete 会用作 context-event。如果设置为 view-home-page，则 view-home-page 还将用作 context-events，此外还会用作 view-item、media-play 和 media-complete。目前支持 recommended-for-you 引擎。目前支持的值：view-home-page、generic。

MostPopularFeatureConfig

创建“最受欢迎”引擎所需的功能配置。

JSON 表示法
{ "timeWindowDays": string }

字段
timeWindowDays	string (int64 format) 在训练和预测时查询引擎的时间窗口。只能是正整数。该值表示过去 X 天的事件。目前是 most-popular-items 引擎的必需参数。

ChatEngineMetadata

聊天引擎的其他信息。此消息中的字段仅限输出。

JSON 表示法
{ "dialogflowAgent": string }

字段
dialogflowAgent	string 此 Chat Engine 所引用的 Dialogflow 代理的资源名称。 格式：projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>。

CommonConfig

引擎的常见配置。

JSON 表示法
{ "companyName": string }

字段
companyName	string 与引擎关联的公司、企业或实体的名称。设置此项有助于改进 LLM 相关功能。

AppType

引擎的应用。

枚举
APP_TYPE_UNSPECIFIED	所有未指定的应用。
APP_TYPE_INTRANET	用于内网搜索和 Agentspace 的应用类型。

FeatureState

引擎的功能状态。

枚举
FEATURE_STATE_UNSPECIFIED	未指定功能状态。
FEATURE_STATE_ON	此功能已开启，可供使用。
FEATURE_STATE_OFF	该功能已关闭，无法使用。

ConfigurableBillingApproach

可配置结算方式的配置。

枚举
CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED	默认值。适用于 Spark 和非 Spark 不可配置的结算方式。一般价格模式。
CONFIGURABLE_BILLING_APPROACH_ENABLED	结算方式遵循客户指定的配置。

方法
create	创建 Engine。
delete	删除 Engine。
get	获取 Engine。
list	列出与项目关联的所有 Engine。
patch	更新 Engine
pause	暂停现有引擎的训练。
resume	恢复现有引擎的训练。
tune	调整现有引擎。