Class GoogleCloudDiscoveryengineV1alphaEngine
Metadata that describes the training and serving parameters of an Engine.
Implements
Inherited Members
Namespace: Google.Apis.DiscoveryEngine.v1beta.Data
Assembly: Google.Apis.DiscoveryEngine.v1beta.dll
Syntax
public class GoogleCloudDiscoveryengineV1alphaEngine : IDirectResponseSchema
Properties
ChatEngineConfig
Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
Declaration
[JsonProperty("chatEngineConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig ChatEngineConfig { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaEngineChatEngineConfig |
ChatEngineMetadata
Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT.
Declaration
[JsonProperty("chatEngineMetadata")]
public virtual GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata ChatEngineMetadata { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaEngineChatEngineMetadata |
CommonConfig
Common config spec that specifies the metadata of the engine.
Declaration
[JsonProperty("commonConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaEngineCommonConfig CommonConfig { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaEngineCommonConfig |
CreateTime
object representation of CreateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
CreateTimeDateTimeOffset
DateTimeOffset representation of CreateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
CreateTimeRaw
Output only. Timestamp the Recommendation Engine was created at.
Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |
DataStoreIds
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.
Declaration
[JsonProperty("dataStoreIds")]
public virtual IList<string> DataStoreIds { get; set; }
Property Value
Type | Description |
---|---|
IList<string> |
DisableAnalytics
Optional. Whether to disable analytics for searches performed on this engine.
Declaration
[JsonProperty("disableAnalytics")]
public virtual bool? DisableAnalytics { get; set; }
Property Value
Type | Description |
---|---|
bool? |
DisplayName
Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string |
ETag
The ETag of the item.
Declaration
public virtual string ETag { get; set; }
Property Value
Type | Description |
---|---|
string |
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.
Declaration
[JsonProperty("industryVertical")]
public virtual string IndustryVertical { get; set; }
Property Value
Type | Description |
---|---|
string |
MediaRecommendationEngineConfig
Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical.
Declaration
[JsonProperty("mediaRecommendationEngineConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig MediaRecommendationEngineConfig { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig |
Name
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*/. Otherwise, an INVALID_ARGUMENT error is returned.
Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type | Description |
---|---|
string |
RecommendationMetadata
Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION.
Declaration
[JsonProperty("recommendationMetadata")]
public virtual GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata RecommendationMetadata { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaEngineRecommendationMetadata |
SearchEngineConfig
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
Declaration
[JsonProperty("searchEngineConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig SearchEngineConfig { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaEngineSearchEngineConfig |
SimilarDocumentsConfig
Additional config specs for a similar-items
engine.
Declaration
[JsonProperty("similarDocumentsConfig")]
public virtual GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig SimilarDocumentsConfig { get; set; }
Property Value
Type | Description |
---|---|
GoogleCloudDiscoveryengineV1alphaEngineSimilarDocumentsEngineConfig |
SolutionType
Required. The solutions of the engine.
Declaration
[JsonProperty("solutionType")]
public virtual string SolutionType { get; set; }
Property Value
Type | Description |
---|---|
string |
UpdateTime
object representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type | Description |
---|---|
object |
UpdateTimeDateTimeOffset
DateTimeOffset representation of UpdateTimeRaw.
Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type | Description |
---|---|
DateTimeOffset? |
UpdateTimeRaw
Output only. Timestamp the Recommendation Engine was last updated.
Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type | Description |
---|---|
string |