Google Cloud Discovery Engine V1beta Client - Class Engine (0.11.2)

Version latest

• 0.11.2 (latest)
• 0.11.1
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.1

Beta

This library is covered by the Pre-GA Offerings Terms of the Terms of Service. Pre-GA libraries might have limited support, and changes to pre-GA libraries might not be compatible with other pre-GA versions. For more information, see the launch stage descriptions.

Reference documentation and code samples for the Google Cloud Discovery Engine V1beta Client class Engine.

Metadata that describes the training and serving parameters of an Engine.

Generated from protobuf message google.cloud.discoveryengine.v1beta.Engine

Namespace

Google \ Cloud \ DiscoveryEngine \ V1beta

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ chat_engine_config	Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineConfig Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
↳ search_engine_config	Google\Cloud\DiscoveryEngine\V1beta\Engine\SearchEngineConfig Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
↳ chat_engine_metadata	Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineMetadata Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
↳ 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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
↳ display_name	string Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
↳ create_time	Google\Protobuf\Timestamp Output only. Timestamp the Recommendation Engine was created at.
↳ update_time	Google\Protobuf\Timestamp Output only. Timestamp the Recommendation Engine was last updated.
↳ data_store_ids	array 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.
↳ solution_type	int Required. The solutions of the engine.
↳ industry_vertical	int 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.
↳ common_config	Google\Cloud\DiscoveryEngine\V1beta\Engine\CommonConfig Common config spec that specifies the metadata of the engine.

getChatEngineConfig

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineConfig|null

hasChatEngineConfig

setChatEngineConfig

Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineConfig

Returns
Type	Description
$this

getSearchEngineConfig

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\Engine\SearchEngineConfig|null

hasSearchEngineConfig

setSearchEngineConfig

Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\Engine\SearchEngineConfig

Returns
Type	Description
$this

getChatEngineMetadata

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineMetadata|null

hasChatEngineMetadata

setChatEngineMetadata

Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\Engine\ChatEngineMetadata

Returns
Type	Description
$this

getName

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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Returns
Type	Description
string

setName

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][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getDisplayName

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

Returns
Type	Description
string

setDisplayName

Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getCreateTime

Output only. Timestamp the Recommendation Engine was created at.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Timestamp the Recommendation Engine was created at.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

Output only. Timestamp the Recommendation Engine was last updated.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

Output only. Timestamp the Recommendation Engine was last updated.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getDataStoreIds

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.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setDataStoreIds

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.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getSolutionType

Required. The solutions of the engine.

Returns
Type	Description
int

setSolutionType

Required. The solutions of the engine.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getIndustryVertical

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.

Returns
Type	Description
int

setIndustryVertical

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.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCommonConfig

Common config spec that specifies the metadata of the engine.

Returns
Type	Description
Google\Cloud\DiscoveryEngine\V1beta\Engine\CommonConfig|null

hasCommonConfig

clearCommonConfig

setCommonConfig

Common config spec that specifies the metadata of the engine.

Parameter
Name	Description
var	Google\Cloud\DiscoveryEngine\V1beta\Engine\CommonConfig

Returns
Type	Description
$this

getEngineConfig

Returns
Type	Description
string

getEngineMetadata

Returns
Type	Description
string