Discovery Engine V1BETA API - Class Google::Cloud::DiscoveryEngine::V1beta::Engine (v0.28.0)

0.28.0 (latest) 0.27.0 0.26.0 0.25.0 0.24.0 0.23.1 0.22.0 0.21.0 0.20.1 0.19.1 0.18.0 0.17.0 0.16.0 0.15.0 0.14.2 0.13.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.2 0.6.0 0.5.0 0.4.0 0.3.0 0.2.1 0.1.0

Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Engine.

Metadata that describes the training and serving parameters of an Engine.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#agent_gateway_setting

def agent_gateway_setting() -> ::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting) — Optional. The agent gateway setting for the engine.

#agent_gateway_setting=

def agent_gateway_setting=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting) — Optional. The agent gateway setting for the engine.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting) — Optional. The agent gateway setting for the engine.

#app_type

def app_type() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::AppType

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::AppType) — Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.

#app_type=

def app_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::AppType

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::AppType) — Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::AppType) — Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.

#chat_engine_config

def chat_engine_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig) — Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

  Note: The following fields are mutually exclusive: chat_engine_config, search_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#chat_engine_config=

def chat_engine_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig) — Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

  Note: The following fields are mutually exclusive: chat_engine_config, search_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig) — Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

  Note: The following fields are mutually exclusive: chat_engine_config, search_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#chat_engine_metadata

def chat_engine_metadata() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata) — Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

#cmek_config

def cmek_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig) — Output only. CMEK-related information for the Engine.

#common_config

def common_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.

#common_config=

def common_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.

#configurable_billing_approach

def configurable_billing_approach() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach) — Optional. Configuration for configurable billing approach.

#configurable_billing_approach=

def configurable_billing_approach=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach) — Optional. Configuration for configurable billing approach.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach) — Optional. Configuration for configurable billing approach.

#connector_tenant_info

def connector_tenant_info() -> ::Google::Protobuf::Map{::String => ::String}

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

#connector_tenant_info=

def connector_tenant_info=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

• value (::Google::Protobuf::Map{::String => ::String}) — Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

Returns

• (::Google::Protobuf::Map{::String => ::String}) — Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp the Recommendation Engine was created at.

#data_store_ids

def data_store_ids() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. The data stores associated with this engine.

  For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

  If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be associated here.

  Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

#data_store_ids=

def data_store_ids=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. The data stores associated with this engine.

  For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

  If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be associated here.

  Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

Returns

• (::Array<::String>) — Optional. The data stores associated with this engine.

  For SOLUTION_TYPE_SEARCH and SOLUTION_TYPE_RECOMMENDATION type of engines, they can only associate with at most one data store.

  If solution_type is SOLUTION_TYPE_CHAT, multiple DataStores in the same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be associated here.

  Note that when used in CreateEngineRequest, one DataStore id must be provided as the system will use it for necessary initializations.

#disable_analytics

def disable_analytics() -> ::Boolean

Returns

• (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.

#disable_analytics=

def disable_analytics=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.

Returns

• (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.

#display_name

def display_name() -> ::String

Returns

• (::String) — Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

#display_name=

def display_name=(value) -> ::String

Parameter

• value (::String) — Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

Returns

• (::String) — Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

#features

def features() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState}) —

  Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

  • *: all features, if it's present, all other feature state settings are ignored.
  • 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
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • disable-canvas-workspace
  • disable-skills
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence

#features=

def features=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState}) —

  Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

  • *: all features, if it's present, all other feature state settings are ignored.
  • 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
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • disable-canvas-workspace
  • disable-skills
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState}) —

  Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

  • *: all features, if it's present, all other feature state settings are ignored.
  • 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
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • disable-canvas-workspace
  • disable-skills
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence

#industry_vertical

def industry_vertical() -> ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.

#industry_vertical=

def industry_vertical=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.

#knowledge_graph_config

def knowledge_graph_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig) — Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

#knowledge_graph_config=

def knowledge_graph_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig) — Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig) — Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

#marketplace_agent_visibility

def marketplace_agent_visibility() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MarketplaceAgentVisibility

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::MarketplaceAgentVisibility) — Optional. The visibility of marketplace agents in the agent gallery.

#marketplace_agent_visibility=

def marketplace_agent_visibility=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MarketplaceAgentVisibility

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::MarketplaceAgentVisibility) — Optional. The visibility of marketplace agents in the agent gallery.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::MarketplaceAgentVisibility) — Optional. The visibility of marketplace agents in the agent gallery.

#media_recommendation_engine_config

def media_recommendation_engine_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig) — Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

  Note: The following fields are mutually exclusive: media_recommendation_engine_config, chat_engine_config, search_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#media_recommendation_engine_config=

def media_recommendation_engine_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig) — Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

  Note: The following fields are mutually exclusive: media_recommendation_engine_config, chat_engine_config, search_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig) — Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.

  Note: The following fields are mutually exclusive: media_recommendation_engine_config, chat_engine_config, search_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#model_configs

def model_configs() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState}) — Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

  When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

#model_configs=

def model_configs=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState}) — Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

  When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState}) — Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

  When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

#name

def name() -> ::String

Returns

• (::String) — Immutable. Identifier. The fully qualified resource name of the engine.

  This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

#name=

def name=(value) -> ::String

Parameter

• value (::String) — Immutable. Identifier. The fully qualified resource name of the engine.

  This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Returns

• (::String) — Immutable. Identifier. The fully qualified resource name of the engine.

  This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine} engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

#observability_config

def observability_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig) — Optional. Observability config for the engine.

#observability_config=

def observability_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig) — Optional. Observability config for the engine.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig) — Optional. Observability config for the engine.

#procurement_contact_emails

def procurement_contact_emails() -> ::Array<::String>

Returns

• (::Array<::String>) — Optional. The emails of the procurement contacts.

#procurement_contact_emails=

def procurement_contact_emails=(value) -> ::Array<::String>

Parameter

• value (::Array<::String>) — Optional. The emails of the procurement contacts.

Returns

• (::Array<::String>) — Optional. The emails of the procurement contacts.

#search_engine_config

def search_engine_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

  Note: The following fields are mutually exclusive: search_engine_config, chat_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#search_engine_config=

def search_engine_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

  Note: The following fields are mutually exclusive: search_engine_config, chat_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

  Note: The following fields are mutually exclusive: search_engine_config, chat_engine_config, media_recommendation_engine_config. If a field in that set is populated, all other fields in the set will automatically be cleared.

#solution_type

def solution_type() -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. The solutions of the engine.

#solution_type=

def solution_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. The solutions of the engine.

Returns

• (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. The solutions of the engine.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp the Recommendation Engine was last updated.