Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngine

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1beta/classes.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb,
lib/google/apis/discoveryengine_v1beta/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaEngine

Returns a new instance of GoogleCloudDiscoveryengineV1betaEngine.



24772
24773
24774
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24772

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#agent_gateway_setting ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaAgentGatewaySetting

Agent Gateway setting, which may be attached to Gemini Enterprise resources for egress control of Gemini Enterprise agents to agents and tools outside of Gemini Enterprise. Corresponds to the JSON property agentGatewaySetting

Returns:



24613
24614
24615
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24613

def agent_gateway_setting
  @agent_gateway_setting
end

#app_type ⇒ String

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. Corresponds to the JSON property appType

Returns:

  • (String) 


24620
24621
24622
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24620

def app_type
  @app_type
end

#associated_agent_registry ⇒ String

Optional. The Agent registry containing the agents, MCP servers and tools associated with this engine. Field is required if the engine has an Agent Gateway setting. Corresponds to the JSON property associatedAgentRegistry

Returns:

  • (String) 


24627
24628
24629
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24627

def associated_agent_registry
  @associated_agent_registry
end

#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig

Configurations for a Chat Engine. Corresponds to the JSON property chatEngineConfig

Returns:



24632
24633
24634
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24632

def chat_engine_config
  @chat_engine_config
end

#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata

Additional information of a Chat Engine. Fields in this message are output only. Corresponds to the JSON property chatEngineMetadata

Returns:



24638
24639
24640
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24638

def chat_engine_metadata
  @chat_engine_metadata
end

#cmek_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaCmekConfig

Configurations used to enable CMEK data encryption with Cloud KMS keys. Corresponds to the JSON property cmekConfig

Returns:



24643
24644
24645
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24643

def cmek_config
  @cmek_config
end

#common_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineCommonConfig

Common configurations for an Engine. Corresponds to the JSON property commonConfig

Returns:



24648
24649
24650
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24648

def common_config
  @common_config
end

#configurable_billing_approach ⇒ String

Optional. Configuration for configurable billing approach. Corresponds to the JSON property configurableBillingApproach

Returns:

  • (String) 


24653
24654
24655
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24653

def configurable_billing_approach
  @configurable_billing_approach
end

#connector_tenant_info ⇒ Hash<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. Corresponds to the JSON property connectorTenantInfo

Returns:

  • (Hash<String,String>) 


24660
24661
24662
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24660

def connector_tenant_info
  @connector_tenant_info
end

#create_time ⇒ String

Output only. Timestamp the Recommendation Engine was created at. Corresponds to the JSON property createTime

Returns:

  • (String) 


24665
24666
24667
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24665

def create_time
  @create_time
end

#data_store_ids ⇒ 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 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. Corresponds to the JSON property dataStoreIds

Returns:

  • (Array<String>) 


24675
24676
24677
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24675

def data_store_ids
  @data_store_ids
end

#disable_analytics ⇒ Boolean Also known as: disable_analytics?

Optional. Whether to disable analytics for searches performed on this engine. Corresponds to the JSON property disableAnalytics

Returns:

  • (Boolean) 


24680
24681
24682
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24680

def disable_analytics
  @disable_analytics
end

#display_name ⇒ String

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. Corresponds to the JSON property displayName

Returns:

  • (String) 


24687
24688
24689
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24687

def display_name
  @display_name
end

#features ⇒ Hash<String,String>

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 * canvas-workspace * disable-skills * enable-end-user-sharing-with-groups * single-agent-orchestration * multi-agent-orchestration * cross-product- intelligence * deep-research Corresponds to the JSON property features

Returns:

  • (Hash<String,String>) 


24703
24704
24705
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24703

def features
  @features
end

#industry_vertical ⇒ String

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. Corresponds to the JSON property industryVertical

Returns:

  • (String) 


24710
24711
24712
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24710

def industry_vertical
  @industry_vertical
end

#knowledge_graph_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineKnowledgeGraphConfig

Configuration message for the Knowledge Graph. Corresponds to the JSON property knowledgeGraphConfig

Returns:



24715
24716
24717
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24715

def knowledge_graph_config
  @knowledge_graph_config
end

#marketplace_agent_visibility ⇒ String

Optional. The visibility of marketplace agents in the agent gallery. Corresponds to the JSON property marketplaceAgentVisibility

Returns:

  • (String) 


24720
24721
24722
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24720

def marketplace_agent_visibility
  @marketplace_agent_visibility
end

#media_recommendation_engine_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineMediaRecommendationEngineConfig

Additional config specs for a Media Recommendation engine. Corresponds to the JSON property mediaRecommendationEngineConfig

Returns:



24725
24726
24727
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24725

def media_recommendation_engine_config
  @media_recommendation_engine_config
end

#model_configs ⇒ Hash<String,String>

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. Corresponds to the JSON property modelConfigs

Returns:

  • (Hash<String,String>) 


24736
24737
24738
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24736

def model_configs
  @model_configs
end

#name ⇒ 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*/. Otherwise, an INVALID_ARGUMENT error is returned. Corresponds to the JSON propertyname`

Returns:

  • (String) 


24745
24746
24747
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24745

def name
  @name
end

#observability_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaObservabilityConfig

Observability config for a resource. Corresponds to the JSON property observabilityConfig

Returns:



24750
24751
24752
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24750

def observability_config
  @observability_config
end

#procurement_contact_emails ⇒ Array<String>

Optional. The emails of the procurement contacts. Corresponds to the JSON property procurementContactEmails

Returns:

  • (Array<String>) 


24755
24756
24757
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24755

def procurement_contact_emails
  @procurement_contact_emails
end

#search_engine_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig

Configurations for a Search Engine. Corresponds to the JSON property searchEngineConfig

Returns:



24760
24761
24762
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24760

def search_engine_config
  @search_engine_config
end

#solution_type ⇒ String

Required. The solutions of the engine. Corresponds to the JSON property solutionType

Returns:

  • (String) 


24765
24766
24767
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24765

def solution_type
  @solution_type
end

#update_time ⇒ String

Output only. Timestamp the Recommendation Engine was last updated. Corresponds to the JSON property updateTime

Returns:

  • (String) 


24770
24771
24772
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24770

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



24777
24778
24779
24780
24781
24782
24783
24784
24785
24786
24787
24788
24789
24790
24791
24792
24793
24794
24795
24796
24797
24798
24799
24800
24801
24802
24803
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 24777

def update!(**args)
  @agent_gateway_setting = args[:agent_gateway_setting] if args.key?(:agent_gateway_setting)
  @app_type = args[:app_type] if args.key?(:app_type)
  @associated_agent_registry = args[:associated_agent_registry] if args.key?(:associated_agent_registry)
  @chat_engine_config = args[:chat_engine_config] if args.key?(:chat_engine_config)
  @chat_engine_metadata = args[:chat_engine_metadata] if args.key?(:chat_engine_metadata)
  @cmek_config = args[:cmek_config] if args.key?(:cmek_config)
  @common_config = args[:common_config] if args.key?(:common_config)
  @configurable_billing_approach = args[:configurable_billing_approach] if args.key?(:configurable_billing_approach)
  @connector_tenant_info = args[:connector_tenant_info] if args.key?(:connector_tenant_info)
  @create_time = args[:create_time] if args.key?(:create_time)
  @data_store_ids = args[:data_store_ids] if args.key?(:data_store_ids)
  @disable_analytics = args[:disable_analytics] if args.key?(:disable_analytics)
  @display_name = args[:display_name] if args.key?(:display_name)
  @features = args[:features] if args.key?(:features)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @knowledge_graph_config = args[:knowledge_graph_config] if args.key?(:knowledge_graph_config)
  @marketplace_agent_visibility = args[:marketplace_agent_visibility] if args.key?(:marketplace_agent_visibility)
  @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
  @model_configs = args[:model_configs] if args.key?(:model_configs)
  @name = args[:name] if args.key?(:name)
  @observability_config = args[:observability_config] if args.key?(:observability_config)
  @procurement_contact_emails = args[:procurement_contact_emails] if args.key?(:procurement_contact_emails)
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
  @solution_type = args[:solution_type] if args.key?(:solution_type)
  @update_time = args[:update_time] if args.key?(:update_time)
end