Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class Engine.
Metadata that describes the training and serving parameters of an Engine .
Generated from protobuf message google.cloud.discoveryengine.v1.Engine
Namespace
Google \ Cloud \ DiscoveryEngine \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ chat_engine_config
Google\Cloud\DiscoveryEngine\V1\Engine\ChatEngineConfig
Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT .
↳ search_engine_config
Google\Cloud\DiscoveryEngine\V1\Engine\SearchEngineConfig
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH .
↳ chat_engine_metadata
Google\Cloud\DiscoveryEngine\V1\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
↳ update_time
↳ 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 DataStore s 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 linked to the engine.
↳ common_config
Google\Cloud\DiscoveryEngine\V1\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 .
hasChatEngineConfig
setChatEngineConfig
Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT .
$this
getSearchEngineConfig
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH .
hasSearchEngineConfig
setSearchEngineConfig
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH .
$this
getChatEngineMetadata
Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT .
hasChatEngineMetadata
setChatEngineMetadata
Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT .
$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.
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.
var
string
$this
getDisplayName
Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
string
setDisplayName
Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
var
string
$this
getCreateTime
Output only. Timestamp the Recommendation Engine was created at.
hasCreateTime
clearCreateTime
setCreateTime
Output only. Timestamp the Recommendation Engine was created at.
$this
getUpdateTime
Output only. Timestamp the Recommendation Engine was last updated.
hasUpdateTime
clearUpdateTime
setUpdateTime
Output only. Timestamp the Recommendation Engine was last updated.
$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 DataStore s 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.
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 DataStore s 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.
var
string[]
$this
getSolutionType
Required. The solutions of the engine.
int
setSolutionType
Required. The solutions of the engine.
var
int
$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 linked to the engine.
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 linked to the engine.
var
int
$this
getCommonConfig
Common config spec that specifies the metadata of the engine.
hasCommonConfig
clearCommonConfig
setCommonConfig
Common config spec that specifies the metadata of the engine.
$this
getEngineConfig
string
getEngineMetadata
string
