feature_views
Creates, updates, deletes, gets or lists a feature_views
resource.
Overview
Name | feature_views |
Type | Resource |
Id | google.aiplatform.feature_views |
Fields
Name | Datatype | Description |
---|---|---|
name | string | Identifier. Name of the FeatureView. Format: projects/{project}/locations/{location}/featureOnlineStores/{feature_online_store}/featureViews/{feature_view} |
bigQuerySource | object | |
createTime | string | Output only. Timestamp when this FeatureView was created. |
etag | string | Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
featureRegistrySource | object | A Feature Registry source for features that need to be synced to Online Store. |
indexConfig | object | Configuration for vector indexing. |
labels | object | 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. |
satisfiesPzi | boolean | Output only. Reserved for future use. |
satisfiesPzs | boolean | Output only. Reserved for future use. |
syncConfig | object | Configuration for Sync. Only one option is set. |
updateTime | string | Output only. Timestamp when this FeatureView was last updated. |
vertexRagSource | object | A Vertex Rag source for features that need to be synced to Online Store. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | featureOnlineStoresId, featureViewsId, locationsId, projectsId | Gets details of a single FeatureView. |
list | SELECT | featureOnlineStoresId, locationsId, projectsId | Lists FeatureViews in a given FeatureOnlineStore. |
create | INSERT | featureOnlineStoresId, locationsId, projectsId | Creates a new FeatureView in a given FeatureOnlineStore. |
delete | DELETE | featureOnlineStoresId, featureViewsId, locationsId, projectsId | Deletes a single FeatureView. |
patch | UPDATE | featureOnlineStoresId, featureViewsId, locationsId, projectsId | Updates the parameters of a single FeatureView. |
search_nearest_entities | EXEC | featureOnlineStoresId, featureViewsId, locationsId, projectsId | Search the nearest entities under a FeatureView. Search only works for indexable feature view; if a feature view isn't indexable, returns Invalid argument response. |
sync | EXEC | featureOnlineStoresId, featureViewsId, locationsId, projectsId | Triggers on-demand sync for the FeatureView. |
SELECT
examples
Lists FeatureViews in a given FeatureOnlineStore.
SELECT
name,
bigQuerySource,
createTime,
etag,
featureRegistrySource,
indexConfig,
labels,
satisfiesPzi,
satisfiesPzs,
syncConfig,
updateTime,
vertexRagSource
FROM google.aiplatform.feature_views
WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new feature_views
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO google.aiplatform.feature_views (
featureOnlineStoresId,
locationsId,
projectsId,
bigQuerySource,
indexConfig,
name,
etag,
vertexRagSource,
labels,
featureRegistrySource,
syncConfig
)
SELECT
'{{ featureOnlineStoresId }}',
'{{ locationsId }}',
'{{ projectsId }}',
'{{ bigQuerySource }}',
'{{ indexConfig }}',
'{{ name }}',
'{{ etag }}',
'{{ vertexRagSource }}',
'{{ labels }}',
'{{ featureRegistrySource }}',
'{{ syncConfig }}'
;
- name: your_resource_model_name
props:
- name: bigQuerySource
value:
- name: entityIdColumns
value:
- string
- name: uri
value: string
- name: indexConfig
value:
- name: treeAhConfig
value:
- name: leafNodeEmbeddingCount
value: string
- name: crowdingColumn
value: string
- name: bruteForceConfig
value: []
- name: distanceMeasureType
value: string
- name: embeddingDimension
value: integer
- name: embeddingColumn
value: string
- name: filterColumns
value:
- string
- name: name
value: string
- name: etag
value: string
- name: satisfiesPzi
value: boolean
- name: vertexRagSource
value:
- name: uri
value: string
- name: ragCorpusId
value: string
- name: labels
value: object
- name: updateTime
value: string
- name: satisfiesPzs
value: boolean
- name: featureRegistrySource
value:
- name: projectNumber
value: string
- name: featureGroups
value:
- - name: featureIds
value:
- string
- name: featureGroupId
value: string
- name: syncConfig
value:
- name: cron
value: string
- name: createTime
value: string
UPDATE
example
Updates a feature_views
resource.
/*+ update */
UPDATE google.aiplatform.feature_views
SET
bigQuerySource = '{{ bigQuerySource }}',
indexConfig = '{{ indexConfig }}',
name = '{{ name }}',
etag = '{{ etag }}',
vertexRagSource = '{{ vertexRagSource }}',
labels = '{{ labels }}',
featureRegistrySource = '{{ featureRegistrySource }}',
syncConfig = '{{ syncConfig }}'
WHERE
featureOnlineStoresId = '{{ featureOnlineStoresId }}'
AND featureViewsId = '{{ featureViewsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';
DELETE
example
Deletes the specified feature_views
resource.
/*+ delete */
DELETE FROM google.aiplatform.feature_views
WHERE featureOnlineStoresId = '{{ featureOnlineStoresId }}'
AND featureViewsId = '{{ featureViewsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';