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.



2286
2287
2288
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2286

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

Instance Attribute Details

#allow_multiple_data_stores_search_engine ⇒ Boolean Also known as: allow_multiple_data_stores_search_engine?

Whether the search engine can associate with multiple data stores. If true, the generic search engine can associate with one or more data stores. This is an input-only field. Corresponds to the JSON property allowMultipleDataStoresSearchEngine

Returns:

  • (Boolean) 


2199
2200
2201
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2199

def allow_multiple_data_stores_search_engine
  @allow_multiple_data_stores_search_engine
end

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

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

Returns:



2205
2206
2207
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2205

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:



2211
2212
2213
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2211

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:



2216
2217
2218
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2216

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) 


2221
2222
2223
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2221

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


2231
2232
2233
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2231

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) 


2237
2238
2239
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2237

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) 


2245
2246
2247
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2245

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:



2250
2251
2252
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2250

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) 


2259
2260
2261
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2259

def name
  @name
end

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

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

Returns:



2264
2265
2266
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2264

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:



2269
2270
2271
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2269

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:



2274
2275
2276
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2274

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) 


2279
2280
2281
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2279

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) 


2284
2285
2286
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2284

def update_time
  @update_time
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
 
# File 'lib/google/apis/discoveryengine_v1beta/classes.rb', line 2291

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