Class: Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngine

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) ⇒ GoogleCloudDiscoveryengineV1alphaEngine

Returns a new instance of GoogleCloudDiscoveryengineV1alphaEngine.



11890
11891
11892
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11890

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

Instance Attribute Details

#agent_gateway_setting ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaAgentGatewaySetting

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:



11721
11722
11723
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11721

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) 


11728
11729
11730
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11728

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) 


11735
11736
11737
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11735

def associated_agent_registry
  @associated_agent_registry
end

#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig

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

Returns:



11740
11741
11742
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11740

def chat_engine_config
  @chat_engine_config
end

#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata

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

Returns:



11746
11747
11748
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11746

def chat_engine_metadata
  @chat_engine_metadata
end

#cmek_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaCmekConfig

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

Returns:



11751
11752
11753
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11751

def cmek_config
  @cmek_config
end

#common_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig

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

Returns:



11756
11757
11758
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11756

def common_config
  @common_config
end

#configurable_billing_approach ⇒ String

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

Returns:

  • (String) 


11761
11762
11763
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11761

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


11768
11769
11770
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11768

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) 


11773
11774
11775
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11773

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


11783
11784
11785
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11783

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) 


11788
11789
11790
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11788

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) 


11795
11796
11797
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11795

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


11811
11812
11813
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11811

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) 


11818
11819
11820
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11818

def industry_vertical
  @industry_vertical
end

#knowledge_graph_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineKnowledgeGraphConfig

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

Returns:



11823
11824
11825
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11823

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) 


11828
11829
11830
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11828

def marketplace_agent_visibility
  @marketplace_agent_visibility
end

#media_recommendation_engine_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig

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

Returns:



11833
11834
11835
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11833

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


11844
11845
11846
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11844

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) 


11853
11854
11855
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11853

def name
  @name
end

#observability_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaObservabilityConfig

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

Returns:



11858
11859
11860
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11858

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


11863
11864
11865
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11863

def procurement_contact_emails
  @procurement_contact_emails
end

#recommendation_metadata ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata

Additional information of a recommendation engine. Corresponds to the JSON property recommendationMetadata

Returns:



11868
11869
11870
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11868

def recommendation_metadata
  @recommendation_metadata
end

#search_engine_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig

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

Returns:



11873
11874
11875
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11873

def search_engine_config
  @search_engine_config
end

#similar_documents_config ⇒ Google::Apis::DiscoveryengineV1beta::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig

Additional config specs for a similar-items engine. Corresponds to the JSON property similarDocumentsConfig

Returns:



11878
11879
11880
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11878

def similar_documents_config
  @similar_documents_config
end

#solution_type ⇒ String

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

Returns:

  • (String) 


11883
11884
11885
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11883

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) 


11888
11889
11890
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11888

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 11895

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)
  @recommendation_metadata = args[:recommendation_metadata] if args.key?(:recommendation_metadata)
  @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config)
  @similar_documents_config = args[:similar_documents_config] if args.key?(:similar_documents_config)
  @solution_type = args[:solution_type] if args.key?(:solution_type)
  @update_time = args[:update_time] if args.key?(:update_time)
end