Class Engine (0.13.3)

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
`similar_documents_config`	`google.cloud.discoveryengine_v1alpha.types.Engine.SimilarDocumentsEngineConfig` Additional config specs for a `similar-items` engine. This field is a member of `oneof`_ `engine_config`.
`chat_engine_config`	`google.cloud.discoveryengine_v1alpha.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_v1alpha.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_v1alpha.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`.
`recommendation_metadata`	`google.cloud.discoveryengine_v1alpha.types.Engine.RecommendationMetadata` Output only. Additional information of a recommendation engine. Only applicable if solution_type is SOLUTION_TYPE_RECOMMENDATION. This field is a member of `oneof`_ `engine_metadata`.
`chat_engine_metadata`	`google.cloud.discoveryengine_v1alpha.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. 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`	`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]` 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_v1alpha.types.SolutionType` Required. The solutions of the engine.
`industry_vertical`	`google.cloud.discoveryengine_v1alpha.types.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.
`common_config`	`google.cloud.discoveryengine_v1alpha.types.Engine.CommonConfig` Common config spec that specifies the metadata of the engine.

Classes

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.

MediaRecommendationEngineConfig

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

Additional config specs for a Media Recommendation engine.

RecommendationMetadata

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

Additional information of a recommendation engine.

SearchEngineConfig

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

Configurations for a Search Engine.

SimilarDocumentsEngineConfig

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

Additional config specs for a similar-items engine.