Class: Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngine
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngine
- 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
-
#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig
Configurations for a Chat Engine.
-
#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata
Additional information of a Chat Engine.
-
#common_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineCommonConfig
Common configurations for an Engine.
-
#create_time ⇒ String
Output only.
-
#data_store_ids ⇒ Array<String>
The data stores associated with this engine.
-
#display_name ⇒ String
Required.
-
#industry_vertical ⇒ String
The industry vertical that the engine registers.
-
#name ⇒ String
Immutable.
-
#search_engine_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
Configurations for a Search Engine.
-
#solution_type ⇒ String
Required.
-
#update_time ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaEngine
constructor
A new instance of GoogleCloudDiscoveryengineV1betaEngine.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudDiscoveryengineV1betaEngine
Returns a new instance of GoogleCloudDiscoveryengineV1betaEngine.
8481 8482 8483 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8481 def initialize(**args) update!(**args) end |
Instance Attribute Details
#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig
Configurations for a Chat Engine.
Corresponds to the JSON property chatEngineConfig
8415 8416 8417 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8415 def chat_engine_config @chat_engine_config end |
#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata
Additional information of a Chat Engine. Fields in this message are output
only.
Corresponds to the JSON property chatEngineMetadata
8421 8422 8423 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8421 def @chat_engine_metadata end |
#common_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineCommonConfig
Common configurations for an Engine.
Corresponds to the JSON property commonConfig
8426 8427 8428 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8426 def common_config @common_config end |
#create_time ⇒ String
Output only. Timestamp the Recommendation Engine was created at.
Corresponds to the JSON property createTime
8431 8432 8433 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8431 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
8441 8442 8443 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8441 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
8447 8448 8449 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8447 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
8455 8456 8457 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8455 def industry_vertical @industry_vertical 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 property
name`
8464 8465 8466 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8464 def name @name end |
#search_engine_config ⇒ Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
Configurations for a Search Engine.
Corresponds to the JSON property searchEngineConfig
8469 8470 8471 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8469 def search_engine_config @search_engine_config end |
#solution_type ⇒ String
Required. The solutions of the engine.
Corresponds to the JSON property solutionType
8474 8475 8476 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8474 def solution_type @solution_type end |
#update_time ⇒ String
Output only. Timestamp the Recommendation Engine was last updated.
Corresponds to the JSON property updateTime
8479 8480 8481 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8479 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
8486 8487 8488 8489 8490 8491 8492 8493 8494 8495 8496 8497 8498 |
# File 'lib/google/apis/discoveryengine_v1alpha/classes.rb', line 8486 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) @name = args[:name] if args.key?(:name) @search_engine_config = args[:search_engine_config] if args.key?(:search_engine_config) @solution_type = args[:solution_type] if args.key?(:solution_type) @update_time = args[:update_time] if args.key?(:update_time) end |