Class: Google::Cloud::DiscoveryEngine::V1beta::Engine

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1beta::Engine

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1beta/engine.rb

Overview

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

Defined Under Namespace

Modules: AppType, ConfigurableBillingApproach, FeatureState, MarketplaceAgentVisibility, ModelState Classes: ChatEngineConfig, ChatEngineMetadata, CommonConfig, ConnectorTenantInfoEntry, FeaturesEntry, KnowledgeGraphConfig, MediaRecommendationEngineConfig, ModelConfigsEntry, SearchEngineConfig

Instance Attribute Summary

• #agent_gateway_setting ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting

  Optional.

• #app_type ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::AppType

  Optional.

• #chat_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig

  Configurations for the Chat Engine.

• #chat_engine_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata readonly

  Output only.

• #cmek_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig readonly

  Output only.

• #common_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig

  Common config spec that specifies the metadata of the engine.

• #configurable_billing_approach ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach

  Optional.

• #connector_tenant_info ⇒ ::Google::Protobuf::Map{::String => ::String}

  Optional.

• #create_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

• #data_store_ids ⇒ ::Array<::String>

  Optional.

• #disable_analytics ⇒ ::Boolean

  Optional.

• #display_name ⇒ ::String

  Required.

• #features ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState}

  Optional.

• #industry_vertical ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical

  Optional.

• #knowledge_graph_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig

  Optional.

• #marketplace_agent_visibility ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MarketplaceAgentVisibility

  Optional.

• #media_recommendation_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig

  Configurations for the Media Engine.

• #model_configs ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState}

  Optional.

• #name ⇒ ::String

  Immutable.

• #observability_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig

  Optional.

• #procurement_contact_emails ⇒ ::Array<::String>

  Optional.

• #search_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig

  Configurations for the Search Engine.

• #solution_type ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType

  Required.

• #update_time ⇒ ::Google::Protobuf::Timestamp readonly

  Output only.

Instance Attribute Details

#agent_gateway_setting ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting

Returns Optional. The agent gateway setting for the engine.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::AgentGatewaySetting) —

  Optional. The agent gateway setting for the engine.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#app_type ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::AppType

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#chat_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#chat_engine_metadata ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata (readonly)

Returns Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata) —

  Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#cmek_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig (readonly)

Returns Output only. CMEK-related information for the Engine.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::CmekConfig) —

  Output only. CMEK-related information for the Engine.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#common_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#configurable_billing_approach ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach

Returns Optional. Configuration for configurable billing approach.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ConfigurableBillingApproach) —

  Optional. Configuration for configurable billing approach.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#connector_tenant_info ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the Recommendation Engine was created at.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. Timestamp the Recommendation Engine was created at.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#data_store_ids ⇒ ::Array<::String>

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#disable_analytics ⇒ ::Boolean

Returns Optional. Whether to disable analytics for searches performed on this engine.

Returns:

• (::Boolean) —

  Optional. Whether to disable analytics for searches performed on this engine.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#display_name ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#features ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState}

Returns 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

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#industry_vertical ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#knowledge_graph_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#marketplace_agent_visibility ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MarketplaceAgentVisibility

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#media_recommendation_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#model_configs ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState}

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#name ⇒ ::String

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#observability_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig

Returns Optional. Observability config for the engine.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::ObservabilityConfig) —

  Optional. Observability config for the engine.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#procurement_contact_emails ⇒ ::Array<::String>

Returns Optional. The emails of the procurement contacts.

Returns:

• (::Array<::String>) —

  Optional. The emails of the procurement contacts.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#search_engine_config ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig

Returns 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.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#solution_type ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType

Returns Required. The solutions of the engine.

Returns:

• (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) —

  Required. The solutions of the engine.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. Timestamp the Recommendation Engine was last updated.

Returns:

• (::Google::Protobuf::Timestamp) —

  Output only. Timestamp the Recommendation Engine was last updated.

# File 'proto_docs/google/cloud/discoveryengine/v1beta/engine.rb', line 197

class Engine
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Configurations for a Search Engine.
  # @!attribute [rw] search_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchTier]
  #     The search feature tier of this engine.
  #
  #     Different tiers might have different
  #     pricing. To learn more, check the pricing documentation.
  #
  #     Defaults to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
  #     if not specified.
  # @!attribute [rw] required_subscription_tier
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::SubscriptionTier]
  #     Optional. The required subscription tier of this engine.
  #
  #     They cannot be modified after engine creation. If the required
  #     subscription tier is search, user with higher license tier like assist
  #     can still access the standalone app associated with this engine.
  # @!attribute [rw] search_add_ons
  #   @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchAddOn>]
  #     The add-on that this search engine enables.
  class SearchEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Additional config specs for a Media Recommendation engine.
  # @!attribute [rw] type
  #   @return [::String]
  #     Required. The type of engine. e.g., `recommended-for-you`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#optimization_objective optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported values: `recommended-for-you`, `others-you-may-like`,
  #     `more-like-this`, `most-popular-items`.
  # @!attribute [rw] optimization_objective
  #   @return [::String]
  #     The optimization objective. e.g., `cvr`.
  #
  #     This field together with
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig#type optimization_objective}
  #     describe engine metadata to use to control engine training and serving.
  #
  #     Currently supported
  #     values: `ctr`, `cvr`.
  #
  #      If not specified, we choose default based on engine type.
  #     Default depends on type of recommendation:
  #
  #     `recommended-for-you` => `ctr`
  #
  #     `others-you-may-like` => `ctr`
  # @!attribute [rw] optimization_objective_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::OptimizationObjectiveConfig]
  #     Name and value of the custom threshold for cvr optimization_objective.
  #     For target_field `watch-time`, target_field_value must be an integer
  #     value indicating the media progress time in seconds between (0, 86400]
  #     (excludes 0, includes 86400) (e.g., 90).
  #     For target_field `watch-percentage`, the target_field_value must be a
  #     valid float value between (0, 1.0] (excludes 0, includes 1.0) (e.g.,
  #     0.5).
  # @!attribute [rw] training_state
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::TrainingState]
  #     The training state that the engine is in (e.g.
  #     `TRAINING` or `PAUSED`).
  #
  #     Since part of the cost of running the service
  #     is frequency of training - this can be used to determine when to train
  #     engine in order to control cost. If not specified: the default value for
  #     `CreateEngine` method is `TRAINING`. The default value for
  #     `UpdateEngine` method is to keep the state the same as before.
  # @!attribute [rw] engine_features_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::EngineFeaturesConfig]
  #     Optional. Additional engine features config.
  class MediaRecommendationEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Custom threshold for `cvr` optimization_objective.
    # @!attribute [rw] target_field
    #   @return [::String]
    #     Required. The name of the field to target. Currently supported
    #     values: `watch-percentage`, `watch-time`.
    # @!attribute [rw] target_field_value_float
    #   @return [::Float]
    #     Required. The threshold to be applied to the target (e.g., 0.5).
    class OptimizationObjectiveConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # More feature configs of the selected engine type.
    # @!attribute [rw] recommended_for_you_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::RecommendedForYouFeatureConfig]
    #     Recommended for you engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `recommended_for_you_config`, `most_popular_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    # @!attribute [rw] most_popular_config
    #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::MediaRecommendationEngineConfig::MostPopularFeatureConfig]
    #     Most popular engine feature config.
    #
    #     Note: The following fields are mutually exclusive: `most_popular_config`, `recommended_for_you_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
    class EngineFeaturesConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Additional feature configurations for creating a `recommended-for-you`
    # engine.
    # @!attribute [rw] context_event_type
    #   @return [::String]
    #     The type of event with which the engine is queried at prediction time.
    #     If set to `generic`, only `view-item`, `media-play`,and
    #     `media-complete` will be used as `context-event` in engine training. If
    #     set to `view-home-page`, `view-home-page` will also be used as
    #     `context-events` in addition to `view-item`, `media-play`, and
    #     `media-complete`. Currently supported for the `recommended-for-you`
    #     engine. Currently supported values: `view-home-page`, `generic`.
    class RecommendedForYouFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # Feature configurations that are required for creating a Most Popular
    # engine.
    # @!attribute [rw] time_window_days
    #   @return [::Integer]
    #     The time window of which the engine is queried at training and
    #     prediction time. Positive integers only. The value translates to the
    #     last X days of events. Currently required for the `most-popular-items`
    #     engine.
    class MostPopularFeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end

    # The training state of the engine.
    module TrainingState
      # Unspecified training state.
      TRAINING_STATE_UNSPECIFIED = 0

      # The engine training is paused.
      PAUSED = 1

      # The engine is training.
      TRAINING = 2
    end
  end

  # Configurations for a Chat Engine.
  # @!attribute [rw] agent_creation_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig::AgentCreationConfig]
  #     The configurationt generate the Dialogflow agent that is associated to
  #     this Engine.
  #
  #     Note that these configurations are one-time consumed by
  #     and passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  # @!attribute [rw] dialogflow_agent_to_link
  #   @return [::String]
  #     The resource name of an exist Dialogflow agent to link to this Chat
  #     Engine. Customers can either provide `agent_creation_config` to create
  #     agent or provide an agent name that links the agent with the Chat engine.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  #
  #     Note that the `dialogflow_agent_to_link` are one-time consumed by and
  #     passed to Dialogflow service. It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation. Use
  #     {::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
  #     for actual agent association after Engine is created.
  # @!attribute [rw] allow_cross_region
  #   @return [::Boolean]
  #     Optional. If the flag set to true, we allow the agent and engine are in
  #     different locations, otherwise the agent and engine are required to be in
  #     the same location. The flag is set to false by default.
  #
  #     Note that the `allow_cross_region` are one-time consumed by and
  #     passed to
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#create_engine EngineService.CreateEngine}.
  #     It means they cannot be retrieved using
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
  #     or
  #     {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
  #     API after engine creation.
  class ChatEngineConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Configurations for generating a Dialogflow agent.
    #
    # Note that these configurations are one-time consumed by
    # and passed to Dialogflow service. It means they cannot be retrieved using
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#get_engine EngineService.GetEngine}
    # or
    # {::Google::Cloud::DiscoveryEngine::V1beta::EngineService::Client#list_engines EngineService.ListEngines}
    # API after engine creation.
    # @!attribute [rw] business
    #   @return [::String]
    #     Name of the company, organization or other entity that the agent
    #     represents. Used for knowledge connector LLM prompt and for knowledge
    #     search.
    # @!attribute [rw] default_language_code
    #   @return [::String]
    #     Required. The default language of the agent as a language tag.
    #     See [Language
    #     Support](https://cloud.google.com/dialogflow/docs/reference/language)
    #     for a list of the currently supported language codes.
    # @!attribute [rw] time_zone
    #   @return [::String]
    #     Required. The time zone of the agent from the [time zone
    #     database](https://www.iana.org/time-zones), e.g., America/New_York,
    #     Europe/Paris.
    # @!attribute [rw] location
    #   @return [::String]
    #     Agent location for Agent creation, supported values: global/us/eu.
    #     If not provided, us Engine will create Agent using us-central-1 by
    #     default; eu Engine will create Agent using eu-west-1 by default.
    class AgentCreationConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Common configurations for an Engine.
  # @!attribute [rw] company_name
  #   @return [::String]
  #     The name of the company, business or entity that is associated with the
  #     engine. Setting this may help improve LLM related features.
  class CommonConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Configuration message for the Knowledge Graph.
  # @!attribute [rw] enable_cloud_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Cloud Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] cloud_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] enable_private_knowledge_graph
  #   @return [::Boolean]
  #     Whether to enable the Private Knowledge Graph for the engine.
  #
  #     Defaults to false if not specified.
  # @!attribute [rw] private_knowledge_graph_types
  #   @return [::Array<::String>]
  #     Specify entity types to support.
  # @!attribute [rw] feature_config
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::KnowledgeGraphConfig::FeatureConfig]
  #     Optional. Feature config for the Knowledge Graph.
  class KnowledgeGraphConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Feature config for the Knowledge Graph.
    # @!attribute [rw] disable_private_kg_query_understanding
    #   @return [::Boolean]
    #     Whether to disable the private KG query understanding for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_enrichment
    #   @return [::Boolean]
    #     Whether to disable the private KG enrichment for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_auto_complete
    #   @return [::Boolean]
    #     Whether to disable the private KG auto complete for the engine.
    #
    #     Defaults to false if not specified.
    # @!attribute [rw] disable_private_kg_query_ui_chips
    #   @return [::Boolean]
    #     Whether to disable the private KG for query UI chips.
    #
    #     Defaults to false if not specified.
    class FeatureConfig
      include ::Google::Protobuf::MessageExts
      extend ::Google::Protobuf::MessageExts::ClassMethods
    end
  end

  # Additional information of a Chat Engine.
  # Fields in this message are output only.
  # @!attribute [rw] dialogflow_agent
  #   @return [::String]
  #     The resource name of a Dialogflow agent, that this Chat Engine refers
  #     to.
  #
  #     Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
  #     ID>`.
  class ChatEngineMetadata
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::FeatureState]
  class FeaturesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::ModelState]
  class ModelConfigsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class ConnectorTenantInfoEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The app of the engine.
  module AppType
    # All non specified apps.
    APP_TYPE_UNSPECIFIED = 0

    # App type for intranet search and Agentspace.
    APP_TYPE_INTRANET = 1
  end

  # The state of the feature for the engine.
  module FeatureState
    # The feature state is unspecified.
    FEATURE_STATE_UNSPECIFIED = 0

    # The feature is turned on to be accessible.
    FEATURE_STATE_ON = 1

    # The feature is turned off to be inaccessible.
    FEATURE_STATE_OFF = 2
  end

  # Configuration for configurable billing approach.
  module ConfigurableBillingApproach
    # Default value. For Spark and non-Spark non-configurable billing approach.
    # General pricing model.
    CONFIGURABLE_BILLING_APPROACH_UNSPECIFIED = 0

    # The billing approach follows configurations specified by customer.
    CONFIGURABLE_BILLING_APPROACH_ENABLED = 1
  end

  # The status of the model for the engine.
  module ModelState
    # The model state is unspecified.
    MODEL_STATE_UNSPECIFIED = 0

    # The model is enabled by admin.
    MODEL_ENABLED = 1

    # The model is disabled by admin.
    MODEL_DISABLED = 2
  end

  # Represents which marketplace agents are visible to any users in agent
  # gallery.
  module MarketplaceAgentVisibility
    # Defaults to `MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED`.
    MARKETPLACE_AGENT_VISIBILITY_UNSPECIFIED = 0

    # Only agents that are currently available for use by the user are visible.
    SHOW_AVAILABLE_AGENTS_ONLY = 1

    # Show marketplace agents that the user does not yet have access to but
    # are integrated into the engine. This level also includes all agents
    # visible with `SHOW_AVAILABLE_AGENTS_ONLY`.
    SHOW_AGENTS_ALREADY_INTEGRATED = 2

    # Show all agents visible with `SHOW_AGENTS_ALREADY_INTEGRATED`, plus
    # agents that have already been purchased by the project/organization, even
    # if they are not currently integrated into the engine.
    SHOW_AGENTS_ALREADY_PURCHASED = 3

    # All agents in the marketplace are visible, regardless of access or
    # purchase status. This level encompasses all agents shown in the previous
    # levels.
    SHOW_ALL_AGENTS = 4
  end
end