Class: Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngine
- Inherits:
-
Object
- Object
- Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngine
- 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
-
#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig
Configurations for a Chat Engine.
-
#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata
Additional information of a Chat Engine.
-
#common_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineCommonConfig
Common configurations for an Engine.
-
#create_time ⇒ String
Output only.
-
#data_store_ids ⇒ Array<String>
The data stores associated with this engine.
-
#disable_analytics ⇒ Boolean
(also: #disable_analytics?)
Optional.
-
#display_name ⇒ String
Required.
-
#industry_vertical ⇒ String
The industry vertical that the engine registers.
-
#name ⇒ String
Immutable.
-
#search_engine_config ⇒ Google::Apis::DiscoveryengineV1::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.
15680 15681 15682 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15680 def initialize(**args) update!(**args) end |
Instance Attribute Details
#chat_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineChatEngineConfig
Configurations for a Chat Engine.
Corresponds to the JSON property chatEngineConfig
15609 15610 15611 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15609 def chat_engine_config @chat_engine_config end |
#chat_engine_metadata ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineChatEngineMetadata
Additional information of a Chat Engine. Fields in this message are output
only.
Corresponds to the JSON property chatEngineMetadata
15615 15616 15617 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15615 def @chat_engine_metadata end |
#common_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineCommonConfig
Common configurations for an Engine.
Corresponds to the JSON property commonConfig
15620 15621 15622 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15620 def common_config @common_config end |
#create_time ⇒ String
Output only. Timestamp the Recommendation Engine was created at.
Corresponds to the JSON property createTime
15625 15626 15627 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15625 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
15635 15636 15637 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15635 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
15640 15641 15642 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15640 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
15647 15648 15649 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15647 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
15654 15655 15656 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15654 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/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`
15663 15664 15665 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15663 def name @name end |
#search_engine_config ⇒ Google::Apis::DiscoveryengineV1::GoogleCloudDiscoveryengineV1betaEngineSearchEngineConfig
Configurations for a Search Engine.
Corresponds to the JSON property searchEngineConfig
15668 15669 15670 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15668 def search_engine_config @search_engine_config end |
#solution_type ⇒ String
Required. The solutions of the engine.
Corresponds to the JSON property solutionType
15673 15674 15675 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15673 def solution_type @solution_type end |
#update_time ⇒ String
Output only. Timestamp the Recommendation Engine was last updated.
Corresponds to the JSON property updateTime
15678 15679 15680 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15678 def update_time @update_time end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
15685 15686 15687 15688 15689 15690 15691 15692 15693 15694 15695 15696 15697 15698 |
# File 'lib/google/apis/discoveryengine_v1/classes.rb', line 15685 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) @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 |