Discovery Engine v1beta API - Class Engine (1.0.0-beta24) 

public sealed class Engine : IMessage<Engine>, IEquatable<Engine>, IDeepCloneable<Engine>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1beta API class Engine.

Metadata that describes the training and serving parameters of an [Engine][google.cloud.discoveryengine.v1beta.Engine].

Inheritance

object > Engine

Namespace

Google.Cloud.DiscoveryEngine.V1Beta

Assembly

Google.Cloud.DiscoveryEngine.V1Beta.dll

Constructors

Engine()

public Engine()

Engine(Engine)

public Engine(Engine other)
Parameter
Name Description
other Engine

Properties

AgentGatewaySetting

public AgentGatewaySetting AgentGatewaySetting { get; set; }

Optional. The agent gateway setting for the engine.

Property Value
Type Description
AgentGatewaySetting

AppType

public Engine.Types.AppType AppType { get; set; }

Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type.

Property Value
Type Description
EngineTypesAppType

ChatEngineConfig

public Engine.Types.ChatEngineConfig ChatEngineConfig { get; set; }

Configurations for the Chat Engine. Only applicable if [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.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.v1beta.Engine.solution_type] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT].

Property Value
Type Description
EngineTypesChatEngineMetadata

CmekConfig

public CmekConfig CmekConfig { get; set; }

Output only. CMEK-related information for the Engine.

Property Value
Type Description
CmekConfig

CommonConfig

public Engine.Types.CommonConfig CommonConfig { get; set; }

Common config spec that specifies the metadata of the engine.

Property Value
Type Description
EngineTypesCommonConfig

ConfigurableBillingApproach

public Engine.Types.ConfigurableBillingApproach ConfigurableBillingApproach { get; set; }

Optional. Configuration for configurable billing approach.

Property Value
Type Description
EngineTypesConfigurableBillingApproach

ConnectorTenantInfo

public MapField<string, string> ConnectorTenantInfo { get; }

Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent.

Property Value
Type Description
MapFieldstringstring

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; }

Optional. The data stores associated with this engine.

For [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH] and [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION] type of engines, they can only associate with at most one data store.

If [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] is [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_CHAT], multiple [DataStore][google.cloud.discoveryengine.v1beta.DataStore]s in the same [Collection][google.cloud.discoveryengine.v1beta.Collection] can be associated here.

Note that when used in [CreateEngineRequest][google.cloud.discoveryengine.v1beta.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

Features

public MapField<string, Engine.Types.FeatureState> Features { get; }

Optional. Feature config for the engine to opt in or opt out of features. Supported keys:

  • *: all features, if it's present, all other feature state settings are ignored.
  • agent-gallery
  • no-code-agent-builder
  • prompt-gallery
  • model-selector
  • notebook-lm
  • people-search
  • people-search-org-chart
  • bi-directional-audio
  • feedback
  • session-sharing
  • personalization-memory
  • personalization-suggested-highlights
  • mobile-app-access
  • disable-agent-sharing
  • disable-image-generation
  • disable-video-generation
  • disable-onedrive-upload
  • disable-talk-to-content
  • disable-google-drive-upload
  • disable-welcome-emails
  • disable-canvas
  • disable-canvas-workspace
  • disable-skills
  • enable-end-user-sharing-with-groups
  • single-agent-orchestration
  • multi-agent-orchestration
  • cross-product-intelligence
Property Value
Type Description
MapFieldstringEngineTypesFeatureState

IndustryVertical

public IndustryVertical IndustryVertical { get; set; }

Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on [DataStore][google.cloud.discoveryengine.v1beta.DataStore]: Vertical on Engine has to match vertical of the DataStore linked to the engine.

Property Value
Type Description
IndustryVertical

KnowledgeGraphConfig

public Engine.Types.KnowledgeGraphConfig KnowledgeGraphConfig { get; set; }

Optional. Configurations for the Knowledge Graph. Only applicable if [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_SEARCH].

Property Value
Type Description
EngineTypesKnowledgeGraphConfig

MarketplaceAgentVisibility

public Engine.Types.MarketplaceAgentVisibility MarketplaceAgentVisibility { get; set; }

Optional. The visibility of marketplace agents in the agent gallery.

Property Value
Type Description
EngineTypesMarketplaceAgentVisibility

MediaRecommendationEngineConfig

public Engine.Types.MediaRecommendationEngineConfig MediaRecommendationEngineConfig { get; set; }

Configurations for the Media Engine. Only applicable on the data stores with [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] [SOLUTION_TYPE_RECOMMENDATION][google.cloud.discoveryengine.v1beta.SolutionType.SOLUTION_TYPE_RECOMMENDATION] and [IndustryVertical.MEDIA][google.cloud.discoveryengine.v1beta.IndustryVertical.MEDIA] vertical.

Property Value
Type Description
EngineTypesMediaRecommendationEngineConfig

ModelConfigs

public MapField<string, Engine.Types.ModelState> ModelConfigs { get; }

Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin.

When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it.

Property Value
Type Description
MapFieldstringEngineTypesModelState

Name

public string Name { get; set; }

Immutable. Identifier. 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

ObservabilityConfig

public ObservabilityConfig ObservabilityConfig { get; set; }

Optional. Observability config for the engine.

Property Value
Type Description
ObservabilityConfig

ProcurementContactEmails

public RepeatedField<string> ProcurementContactEmails { get; }

Optional. The emails of the procurement contacts.

Property Value
Type Description
RepeatedFieldstring

SearchEngineConfig

public Engine.Types.SearchEngineConfig SearchEngineConfig { get; set; }

Configurations for the Search Engine. Only applicable if [solution_type][google.cloud.discoveryengine.v1beta.Engine.solution_type] is [SOLUTION_TYPE_SEARCH][google.cloud.discoveryengine.v1beta.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