Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngine

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/discoveryengine_v1/classes.rb,
lib/google/apis/discoveryengine_v1/representations.rb,
lib/google/apis/discoveryengine_v1/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.



10644
10645
10646
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10644

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

Instance Attribute Details

#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig

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

Returns:



10558
10559
10560
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10558

def chat_engine_config
  @chat_engine_config
end

#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata

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

Returns:



10564
10565
10566
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10564

def chat_engine_metadata
  @chat_engine_metadata
end

#common_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig

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

Returns:



10569
10570
10571
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10569

def common_config
  @common_config
end

#create_time ⇒ String

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

Returns:

  • (String) 


10574
10575
10576
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10574

def create_time
  @create_time
end

#data_store_ids ⇒ Array<String>

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


10584
10585
10586
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10584

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) 


10589
10590
10591
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10589

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) 


10596
10597
10598
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10596

def display_name
  @display_name
end

#industry_vertical ⇒ String

The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to GENERIC. Vertical on Engine has to match vertical of the DataStore linked to the engine. Corresponds to the JSON property industryVertical

Returns:

  • (String) 


10603
10604
10605
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10603

def industry_vertical
  @industry_vertical
end

#media_recommendation_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig

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

Returns:



10608
10609
10610
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10608

def media_recommendation_engine_config
  @media_recommendation_engine_config
end

#name ⇒ String

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


10617
10618
10619
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10617

def name
  @name
end

#recommendation_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata

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

Returns:



10622
10623
10624
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10622

def recommendation_metadata
  @recommendation_metadata
end

#search_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig

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

Returns:



10627
10628
10629
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10627

def search_engine_config
  @search_engine_config
end

#similar_documents_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig

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

Returns:



10632
10633
10634
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10632

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) 


10637
10638
10639
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10637

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) 


10642
10643
10644
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10642

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
 
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 10649

def update!(**args)
  @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)
  @common_config = args[:common_config] if args.key?(:common_config)
  @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)
  @industry_vertical = args[:industry_vertical] if args.key?(:industry_vertical)
  @media_recommendation_engine_config = args[:media_recommendation_engine_config] if args.key?(:media_recommendation_engine_config)
  @name = args[:name] if args.key?(:name)
  @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