Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::Engine (v1.3.0)

Version latest

• 1.3.0 (latest)
• 1.2.0
• 1.1.0
• 1.0.2
• 0.9.0
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.2
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::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::V1::Engine::ChatEngineConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::V1::Engine::ChatEngineConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig) — Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::V1::Engine::ChatEngineMetadata

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::V1::Engine::CommonConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.

#common_config=

def common_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig) — Common config spec that specifies the metadata of the engine.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp the Recommendation Engine was created at.

#data_store_ids

def data_store_ids() -> ::Array<::String>

Returns

• (::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.v1.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>

Parameter

• 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.v1.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.

Returns

• (::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.v1.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

Returns

• (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.

#disable_analytics=

def disable_analytics=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.

Returns

• (::Boolean) — Optional. Whether to disable analytics for searches performed on this engine.

#display_name

def display_name() -> ::String

Returns

• (::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

Parameter

• value (::String) — Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

Returns

• (::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::V1::IndustryVertical

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::V1::IndustryVertical

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::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.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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

Returns

• (::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

Parameter

• 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.

Returns

• (::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::V1::Engine::SearchEngineConfig

Returns

• (::Google::Cloud::DiscoveryEngine::V1::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::V1::Engine::SearchEngineConfig

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::Engine::SearchEngineConfig) — Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

#solution_type

def solution_type() -> ::Google::Cloud::DiscoveryEngine::V1::SolutionType

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SolutionType) — Required. The solutions of the engine.

#solution_type=

def solution_type=(value) -> ::Google::Cloud::DiscoveryEngine::V1::SolutionType

Parameter

• value (::Google::Cloud::DiscoveryEngine::V1::SolutionType) — Required. The solutions of the engine.

Returns

• (::Google::Cloud::DiscoveryEngine::V1::SolutionType) — Required. The solutions of the engine.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Output only. Timestamp the Recommendation Engine was last updated.