Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngine

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



2908
2909
2910
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2908

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

Instance Attribute Details

#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig

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

Returns:



2827
2828
2829
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2827

def chat_engine_config
  @chat_engine_config
end

#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata

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

Returns:



2833
2834
2835
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2833

def chat_engine_metadata
  @chat_engine_metadata
end

#common_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineCommonConfig

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

Returns:



2838
2839
2840
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2838

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) 


2843
2844
2845
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2843

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


2853
2854
2855
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2853

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) 


2859
2860
2861
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2859

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

Returns:

  • (String) 


2867
2868
2869
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2867

def industry_vertical
  @industry_vertical
end

#media_recommendation_engine_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig

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

Returns:



2872
2873
2874
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2872

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) 


2881
2882
2883
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2881

def name
  @name
end

#recommendation_metadata ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata

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

Returns:



2886
2887
2888
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2886

def recommendation_metadata
  @recommendation_metadata
end

#search_engine_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig

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

Returns:



2891
2892
2893
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2891

def search_engine_config
  @search_engine_config
end

#similar_documents_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig

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

Returns:



2896
2897
2898
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2896

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) 


2901
2902
2903
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2901

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) 


2906
2907
2908
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2906

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
 
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 2913

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