public sealed class Engine : IMessage<Engine>, IEquatable<Engine>, IDeepCloneable<Engine>, IBufferMessage, IMessageReference documentation and code samples for the Discovery Engine v1 API class Engine.
Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1.Engine].
Namespace
Google.Cloud.DiscoveryEngine.V1Assembly
Google.Cloud.DiscoveryEngine.V1.dll
Constructors
Engine()
public Engine()Engine(Engine)
public Engine(Engine other)| Parameter | |
|---|---|
| Name | Description |
other |
Engine |
Properties
ChatEngineConfig
public Engine.Types.ChatEngineConfig ChatEngineConfig { get; set; }Configurations for the Chat Engine. Only applicable if [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT].
| Property Value | |
|---|---|
| Type | Description |
EngineTypesChatEngineConfig |
|
ChatEngineMetadata
public Engine.Types.ChatEngineMetadata ChatEngineMetadata { get; set; }Output only. Additional information of the Chat Engine. Only applicable if [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT].
| Property Value | |
|---|---|
| Type | Description |
EngineTypesChatEngineMetadata |
|
CommonConfig
public Engine.Types.CommonConfig CommonConfig { get; set; }Common config spec that specifies the metadata of the engine.
| Property Value | |
|---|---|
| Type | Description |
EngineTypesCommonConfig |
|
CreateTime
public Timestamp CreateTime { get; set; }Output only. Timestamp the Recommendation Engine was created at.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|
DataStoreIds
public RepeatedField<string> DataStoreIds { get; }The data stores associated with this engine.
For [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH] and [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_RECOMMENDATION] type of engines, they can only associate with at most one data store.
If [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_CHAT], multiple [DataStore][google.cloud.discoveryengine.v1.DataStore]s in the same [Collection][google.cloud.discoveryengine.v1.Collection] can be associated here.
Note that when used in [CreateEngineRequest][google.cloud.discoveryengine.v1.CreateEngineRequest], one DataStore id must be provided as the system will use it for necessary initializations.
| Property Value | |
|---|---|
| Type | Description |
RepeatedFieldstring |
|
DisableAnalytics
public bool DisableAnalytics { get; set; }Optional. Whether to disable analytics for searches performed on this engine.
| Property Value | |
|---|---|
| Type | Description |
bool |
|
DisplayName
public string DisplayName { get; set; }Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
| Property Value | |
|---|---|
| Type | Description |
string |
|
EngineConfigCase
public Engine.EngineConfigOneofCase EngineConfigCase { get; }| Property Value | |
|---|---|
| Type | Description |
EngineEngineConfigOneofCase |
|
EngineMetadataCase
public Engine.EngineMetadataOneofCase EngineMetadataCase { get; }| Property Value | |
|---|---|
| Type | Description |
EngineEngineMetadataOneofCase |
|
EngineName
public EngineName EngineName { get; set; }EngineName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
EngineName |
|
IndustryVertical
public IndustryVertical IndustryVertical { get; set; }The industry vertical that the engine registers.
The restriction of the Engine industry vertical is based on
[DataStore][google.cloud.discoveryengine.v1.DataStore]: If unspecified,
default to GENERIC. Vertical on Engine has to match vertical of the
DataStore linked to the engine.
| Property Value | |
|---|---|
| Type | Description |
IndustryVertical |
|
Name
public string Name { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
SearchEngineConfig
public Engine.Types.SearchEngineConfig SearchEngineConfig { get; set; }Configurations for the Search Engine. Only applicable if [solution_type][google.cloud.discoveryengine.v1.Engine.solution_type] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1.SolutionType.SOLUTION_TYPE_SEARCH].
| Property Value | |
|---|---|
| Type | Description |
EngineTypesSearchEngineConfig |
|
SolutionType
public SolutionType SolutionType { get; set; }Required. The solutions of the engine.
| Property Value | |
|---|---|
| Type | Description |
SolutionType |
|
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Timestamp the Recommendation Engine was last updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp |
|