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.



3829
3830
3831
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3829

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

Instance Attribute Details

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

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

Returns:



3749
3750
3751
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3749

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:



3755
3756
3757
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3755

def chat_engine_metadata
  @chat_engine_metadata
end

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

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

Returns:



3760
3761
3762
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3760

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) 


3765
3766
3767
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3765

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


3775
3776
3777
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3775

def data_store_ids
  @data_store_ids
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) 


3781
3782
3783
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3781

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) 


3788
3789
3790
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3788

def industry_vertical
  @industry_vertical
end

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

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

Returns:



3793
3794
3795
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3793

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


3802
3803
3804
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3802

def name
  @name
end

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

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

Returns:



3807
3808
3809
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3807

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:



3812
3813
3814
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3812

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:



3817
3818
3819
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3817

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) 


3822
3823
3824
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3822

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) 


3827
3828
3829
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3827

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 3834

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