Class FeatureView (1.48.0)

Version latest

• 1.48.0 (latest)
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.39.0
• 1.38.1
• 1.37.0
• 1.36.4
• 1.35.0
• 1.34.0
• 1.33.1
• 1.32.0
• 1.31.1
• 1.30.1
• 1.29.0
• 1.28.1
• 1.27.1
• 1.26.1
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.1
• 1.21.0
• 1.20.0
• 1.19.1
• 1.18.3
• 1.17.1
• 1.16.1
• 1.15.1
• 1.14.0
• 1.13.1
• 1.12.1
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.1
• 1.7.1
• 1.6.2
• 1.5.0
• 1.4.3
• 1.3.0
• 1.2.0
• 1.1.1
• 1.0.1
• 0.9.0
• 0.8.0
• 0.7.1
• 0.6.0
• 0.5.1
• 0.4.0
• 0.3.1

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

FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.

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
big_query_source	google.cloud.aiplatform_v1beta1.types.FeatureView.BigQuerySource Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore. This field is a member of oneof_ source.
feature_registry_source	google.cloud.aiplatform_v1beta1.types.FeatureView.FeatureRegistrySource Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore. This field is a member of oneof_ source.
name	str Identifier. Name of the FeatureView. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}
create_time	google.protobuf.timestamp_pb2.Timestamp Output only. Timestamp when this FeatureView was created.
update_time	google.protobuf.timestamp_pb2.Timestamp Output only. Timestamp when this FeatureView was last updated.
etag	str Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	MutableMapping[str, str] Optional. The labels with user-defined metadata to organize your FeatureViews. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information on and examples of labels. No more than 64 user labels can be associated with one FeatureOnlineStore(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
sync_config	google.cloud.aiplatform_v1beta1.types.FeatureView.SyncConfig Configures when data is to be synced/updated for this FeatureView. At the end of the sync the latest featureValues for each entityId of this FeatureView are made ready for online serving.
vector_search_config	google.cloud.aiplatform_v1beta1.types.FeatureView.VectorSearchConfig Optional. Deprecated: please use FeatureView.index_config instead.
index_config	google.cloud.aiplatform_v1beta1.types.FeatureView.IndexConfig Optional. Configuration for index preparation for vector search. It contains the required configurations to create an index from source data, so that approximate nearest neighbor (a.k.a ANN) algorithms search can be performed during online serving.
service_agent_type	google.cloud.aiplatform_v1beta1.types.FeatureView.ServiceAgentType Optional. Service agent type used during data sync. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureView within a project, a separate service account should be provisioned by setting this field to SERVICE_AGENT_TYPE_FEATURE_VIEW. This will generate a separate service account to access the BigQuery source table.
service_account_email	str Output only. A Service Account unique to this FeatureView. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to sync data to the online store.

Classes

BigQuerySource

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

FeatureRegistrySource

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

A Feature Registry source for features that need to be synced to Online Store.

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

IndexConfig

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

Configuration for vector indexing.

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

LabelsEntry

LabelsEntry(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.

ServiceAgentType

ServiceAgentType(value)

Service agent type used during data sync.

Values: SERVICE_AGENT_TYPE_UNSPECIFIED (0): By default, the project-level Vertex AI Service Agent is enabled. SERVICE_AGENT_TYPE_PROJECT (1): Indicates the project-level Vertex AI Service Agent (https://cloud.google.com/vertex-ai/docs/general/access-control#service-agents) will be used during sync jobs. SERVICE_AGENT_TYPE_FEATURE_VIEW (2): Enable a FeatureView service account to be created by Vertex AI and output in the field service_account_email. This service account will be used to read from the source BigQuery table during sync.

SyncConfig

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

Configuration for Sync. Only one option is set.

VectorSearchConfig

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

Deprecated. Use IndexConfig instead.

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

Methods

FeatureView

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

FeatureView is representation of values that the FeatureOnlineStore will serve based on its syncConfig.

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