Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::FeatureView (v0.63.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::FeatureView.

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

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#big_query_source

def big_query_source() -> ::Google::Cloud::AIPlatform::V1::FeatureView::BigQuerySource

Returns

(::Google::Cloud::AIPlatform::V1::FeatureView::BigQuerySource) — Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.

Note: The following fields are mutually exclusive: big_query_source, feature_registry_source, vertex_rag_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#big_query_source=

def big_query_source=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::BigQuerySource

Parameter

value (::Google::Cloud::AIPlatform::V1::FeatureView::BigQuerySource) — Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.

Note: The following fields are mutually exclusive: big_query_source, feature_registry_source, vertex_rag_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::AIPlatform::V1::FeatureView::BigQuerySource) — Optional. Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.

Note: The following fields are mutually exclusive: big_query_source, feature_registry_source, vertex_rag_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this FeatureView was created.

#etag

def etag() -> ::String

Returns

(::String) — Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#etag=

def etag=(value) -> ::String

Parameter

value (::String) — Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

Returns

(::String) — Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

#feature_registry_source

def feature_registry_source() -> ::Google::Cloud::AIPlatform::V1::FeatureView::FeatureRegistrySource

Returns

(::Google::Cloud::AIPlatform::V1::FeatureView::FeatureRegistrySource) — Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.

Note: The following fields are mutually exclusive: feature_registry_source, big_query_source, vertex_rag_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#feature_registry_source=

def feature_registry_source=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::FeatureRegistrySource

Parameter

value (::Google::Cloud::AIPlatform::V1::FeatureView::FeatureRegistrySource) — Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.

Note: The following fields are mutually exclusive: feature_registry_source, big_query_source, vertex_rag_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::AIPlatform::V1::FeatureView::FeatureRegistrySource) — Optional. Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.

Note: The following fields are mutually exclusive: feature_registry_source, big_query_source, vertex_rag_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#index_config

def index_config() -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig

Returns

(::Google::Cloud::AIPlatform::V1::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.

#index_config=

def index_config=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::IndexConfig

Parameter

value (::Google::Cloud::AIPlatform::V1::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.

Returns

(::Google::Cloud::AIPlatform::V1::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.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String

Returns

(::String) — Identifier. Name of the FeatureView. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

#name=

def name=(value) -> ::String

Parameter

value (::String) — Identifier. Name of the FeatureView. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

Returns

(::String) — Identifier. Name of the FeatureView. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view}

#satisfies_pzi

def satisfies_pzi() -> ::Boolean

Returns

(::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean

Returns

(::Boolean) — Output only. Reserved for future use.

#service_account_email

def service_account_email() -> ::String

Returns

(::String) — 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.

#service_agent_type

def service_agent_type() -> ::Google::Cloud::AIPlatform::V1::FeatureView::ServiceAgentType

Returns

(::Google::Cloud::AIPlatform::V1::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_agent_type=

def service_agent_type=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::ServiceAgentType

Parameter

value (::Google::Cloud::AIPlatform::V1::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.

Returns

(::Google::Cloud::AIPlatform::V1::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.

#sync_config

def sync_config() -> ::Google::Cloud::AIPlatform::V1::FeatureView::SyncConfig

Returns

(::Google::Cloud::AIPlatform::V1::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.

#sync_config=

def sync_config=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::SyncConfig

Parameter

value (::Google::Cloud::AIPlatform::V1::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.

Returns

(::Google::Cloud::AIPlatform::V1::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.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Timestamp when this FeatureView was last updated.

#vertex_rag_source

def vertex_rag_source() -> ::Google::Cloud::AIPlatform::V1::FeatureView::VertexRagSource

Returns

(::Google::Cloud::AIPlatform::V1::FeatureView::VertexRagSource) — Optional. The Vertex RAG Source that the FeatureView is linked to.

Note: The following fields are mutually exclusive: vertex_rag_source, big_query_source, feature_registry_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

#vertex_rag_source=

def vertex_rag_source=(value) -> ::Google::Cloud::AIPlatform::V1::FeatureView::VertexRagSource

Parameter

value (::Google::Cloud::AIPlatform::V1::FeatureView::VertexRagSource) — Optional. The Vertex RAG Source that the FeatureView is linked to.

Note: The following fields are mutually exclusive: vertex_rag_source, big_query_source, feature_registry_source. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

(::Google::Cloud::AIPlatform::V1::FeatureView::VertexRagSource) — Optional. The Vertex RAG Source that the FeatureView is linked to.

Note: The following fields are mutually exclusive: vertex_rag_source, big_query_source, feature_registry_source. If a field in that set is populated, all other fields in the set will automatically be cleared.