Reference documentation and code samples for the Discovery Engine V1BETA API class Google::Cloud::DiscoveryEngine::V1beta::Engine.
Metadata that describes the training and serving parameters of an Engine.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#chat_engine_config
def chat_engine_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig- (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig) — Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
#chat_engine_config=
def chat_engine_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig- value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig) — Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
- (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineConfig) — Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
#chat_engine_metadata
def chat_engine_metadata() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata- (::Google::Cloud::DiscoveryEngine::V1beta::Engine::ChatEngineMetadata) — Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
#common_config
def common_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig- (::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.
#common_config=
def common_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig- value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.
- (::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. Timestamp the Recommendation Engine was created at.
#data_store_ids
def data_store_ids() -> ::Array<::String>-
(::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][google.cloud.discoveryengine.v1beta.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.
#data_store_ids=
def data_store_ids=(value) -> ::Array<::String>-
value (::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][google.cloud.discoveryengine.v1beta.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.
-
(::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][google.cloud.discoveryengine.v1beta.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.
#disable_analytics
def disable_analytics() -> ::Boolean- (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.
#disable_analytics=
def disable_analytics=(value) -> ::Boolean- value (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.
- (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.
#display_name
def display_name() -> ::String- (::String) — Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
#display_name=
def display_name=(value) -> ::String- value (::String) — Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
- (::String) — Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
#industry_vertical
def industry_vertical() -> ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical-
(::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — 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.
#industry_vertical=
def industry_vertical=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical-
value (::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — 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.
-
(::Google::Cloud::DiscoveryEngine::V1beta::IndustryVertical) — 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.
#name
def name() -> ::String-
(::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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
#name=
def name=(value) -> ::String-
value (::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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
-
(::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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
#search_engine_config
def search_engine_config() -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig- (::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
#search_engine_config=
def search_engine_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig- value (::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
- (::Google::Cloud::DiscoveryEngine::V1beta::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
#solution_type
def solution_type() -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType- (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. The solutions of the engine.
#solution_type=
def solution_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1beta::SolutionType- value (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. The solutions of the engine.
- (::Google::Cloud::DiscoveryEngine::V1beta::SolutionType) — Required. The solutions of the engine.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp- (::Google::Protobuf::Timestamp) — Output only. Timestamp the Recommendation Engine was last updated.