Class Engine (0.20.1) 

Engine(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes
Name Description
chat_engine_config google.cloud.discoveryengine_v1beta.types.Engine.ChatEngineConfig
Configurations for the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. This field is a member of oneof_ engine_config.
search_engine_config google.cloud.discoveryengine_v1beta.types.Engine.SearchEngineConfig
Configurations for the Search Engine. Only applicable if solution_type is SOLUTION_TYPE_SEARCH. This field is a member of oneof_ engine_config.
media_recommendation_engine_config google.cloud.discoveryengine_v1beta.types.Engine.MediaRecommendationEngineConfig
Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. This field is a member of oneof_ engine_config.
chat_engine_metadata google.cloud.discoveryengine_v1beta.types.Engine.ChatEngineMetadata
Output only. Additional information of the Chat Engine. Only applicable if solution_type is SOLUTION_TYPE_CHAT. This field is a member of oneof_ engine_metadata.
name str
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.
display_name str
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_pb2.Timestamp
Output only. Timestamp the Recommendation Engine was created at.
update_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp the Recommendation Engine was last updated.
data_store_ids MutableSequence[str]
Optional. 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 google.cloud.discoveryengine_v1beta.types.SolutionType
Required. The solutions of the engine.
industry_vertical google.cloud.discoveryengine_v1beta.types.IndustryVertical
Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine.
common_config google.cloud.discoveryengine_v1beta.types.Engine.CommonConfig
Common config spec that specifies the metadata of the engine.
knowledge_graph_config google.cloud.discoveryengine_v1beta.types.Engine.KnowledgeGraphConfig
Optional. Configurations for the Knowledge Graph. Only applicable if solution_type is SOLUTION_TYPE_SEARCH.
app_type google.cloud.discoveryengine_v1beta.types.Engine.AppType
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.
disable_analytics bool
Optional. Whether to disable analytics for searches performed on this engine.
features MutableMapping[str, google.cloud.discoveryengine_v1beta.types.Engine.FeatureState]
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
cmek_config google.cloud.discoveryengine_v1beta.types.CmekConfig
Output only. CMEK-related information for the Engine.
configurable_billing_approach google.cloud.discoveryengine_v1beta.types.Engine.ConfigurableBillingApproach
Optional. Configuration for configurable billing approach.
model_configs MutableMapping[str, google.cloud.discoveryengine_v1beta.types.Engine.ModelState]
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.
observability_config google.cloud.discoveryengine_v1beta.types.ObservabilityConfig
Optional. Observability config for the engine.
connector_tenant_info MutableMapping[str, str]
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.
agent_gateway_setting google.cloud.discoveryengine_v1beta.types.AgentGatewaySetting
Optional. The agent gateway setting for the engine.
marketplace_agent_visibility google.cloud.discoveryengine_v1beta.types.Engine.MarketplaceAgentVisibility
Optional. The visibility of marketplace agents in the agent gallery.
procurement_contact_emails MutableSequence[str]
Optional. The emails of the procurement contacts.

Classes

AppType

AppType(value)

The app of the engine.

ChatEngineConfig

ChatEngineConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configurations for a Chat Engine.

ChatEngineMetadata

ChatEngineMetadata(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Additional information of a Chat Engine. Fields in this message are output only.

CommonConfig

CommonConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Common configurations for an Engine.

ConfigurableBillingApproach

ConfigurableBillingApproach(value)

Configuration for configurable billing approach.

ConnectorTenantInfoEntry

ConnectorTenantInfoEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

FeatureState

FeatureState(value)

The state of the feature for the engine.

FeaturesEntry

FeaturesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

KnowledgeGraphConfig

KnowledgeGraphConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configuration message for the Knowledge Graph.

MarketplaceAgentVisibility

MarketplaceAgentVisibility(value)

Represents which marketplace agents are visible to any users in agent gallery.

MediaRecommendationEngineConfig

MediaRecommendationEngineConfig(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Additional config specs for a Media Recommendation engine.

ModelConfigsEntry

ModelConfigsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name Description
kwargs dict

Keys and values corresponding to the fields of the message.
mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.
ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

ModelState

ModelState(value)

The status of the model for the engine.

SearchEngineConfig

SearchEngineConfig(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Configurations for a Search Engine.