feature_groups

Creates, updates, deletes, gets or lists a feature_groups resource.

Overview

Name	feature_groups
Type	Resource
Id	google.aiplatform.feature_groups

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
bigQuery	object	Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named feature_timestamp. (id: GoogleCloudAiplatformV1FeatureGroupBigQuery)
createTime	string (google-datetime)	Output only. Timestamp when this FeatureGroup was created.
description	string	Optional. Description of the FeatureGroup.
etag	string	Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	Optional. The labels with user-defined metadata to organize your FeatureGroup. 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 FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
serviceAccountEmail	string	Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.
serviceAgentType	string	Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to SERVICE_AGENT_TYPE_FEATURE_GROUP. This will generate a separate service account to access the BigQuery source table.
updateTime	string (google-datetime)	Output only. Timestamp when this FeatureGroup was last updated.

list

Successful response

Name	Datatype	Description
name	string	Identifier. Name of the FeatureGroup. Format: projects/{project}/locations/{location}/featureGroups/{featureGroup}
bigQuery	object	Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named feature_timestamp. (id: GoogleCloudAiplatformV1FeatureGroupBigQuery)
createTime	string (google-datetime)	Output only. Timestamp when this FeatureGroup was created.
description	string	Optional. Description of the FeatureGroup.
etag	string	Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
labels	object	Optional. The labels with user-defined metadata to organize your FeatureGroup. 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 FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
serviceAccountEmail	string	Output only. A Service Account unique to this FeatureGroup. The role bigquery.dataViewer should be granted to this service account to allow Vertex AI Feature Store to access source data while running jobs under this FeatureGroup.
serviceAgentType	string	Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to SERVICE_AGENT_TYPE_FEATURE_GROUP. This will generate a separate service account to access the BigQuery source table.
updateTime	string (google-datetime)	Output only. Timestamp when this FeatureGroup was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, featureGroupsId		Gets details of a single FeatureGroup.
list	select	projectsId, locationsId	filter, pageSize, pageToken, orderBy	Lists FeatureGroups in a given project and location.
create	insert	projectsId, locationsId	featureGroupId	Creates a new FeatureGroup in a given project and location.
patch	update	projectsId, locationsId, featureGroupsId	updateMask	Updates the parameters of a single FeatureGroup.
delete	delete	projectsId, locationsId, featureGroupsId	force	Deletes a single FeatureGroup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
featureGroupsId	string
locationsId	string
projectsId	string
featureGroupId	string
filter	string
force	boolean
orderBy	string
pageSize	integer (int32)
pageToken	string
updateMask	string (google-fieldmask)

SELECT examples

get

Gets details of a single FeatureGroup.

SELECT
name,
bigQuery,
createTime,
description,
etag,
labels,
serviceAccountEmail,
serviceAgentType,
updateTime
FROM google.aiplatform.feature_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND featureGroupsId = '{{ featureGroupsId }}' -- required;

list

Lists FeatureGroups in a given project and location.

SELECT
name,
bigQuery,
createTime,
description,
etag,
labels,
serviceAccountEmail,
serviceAgentType,
updateTime
FROM google.aiplatform.feature_groups
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND orderBy = '{{ orderBy }}';

INSERT examples

create

Creates a new FeatureGroup in a given project and location.

INSERT INTO google.aiplatform.feature_groups (
data__bigQuery,
data__name,
data__etag,
data__labels,
data__description,
data__serviceAgentType,
projectsId,
locationsId,
featureGroupId
)
SELECT 
'{{ bigQuery }}',
'{{ name }}',
'{{ etag }}',
'{{ labels }}',
'{{ description }}',
'{{ serviceAgentType }}',
'{{ projectsId }}',
'{{ locationsId }}',
'{{ featureGroupId }}'
RETURNING
name,
done,
error,
metadata,
response
;

Manifest

# Description fields are for documentation purposes
- name: feature_groups
  props:
    - name: projectsId
      value: string
      description: Required parameter for the feature_groups resource.
    - name: locationsId
      value: string
      description: Required parameter for the feature_groups resource.
    - name: bigQuery
      value: object
      description: >
        Indicates that features for this group come from BigQuery Table/View. By default treats the source as a sparse time series source. The BigQuery source table or view must have at least one entity ID column and a column named `feature_timestamp`.
        
    - name: name
      value: string
      description: >
        Identifier. Name of the FeatureGroup. Format: `projects/{project}/locations/{location}/featureGroups/{featureGroup}`
        
    - name: etag
      value: string
      description: >
        Optional. Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
        
    - name: labels
      value: object
      description: >
        Optional. The labels with user-defined metadata to organize your FeatureGroup. 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 FeatureGroup(System labels are excluded)." System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
        
    - name: description
      value: string
      description: >
        Optional. Description of the FeatureGroup.
        
    - name: serviceAgentType
      value: string
      description: >
        Optional. Service agent type used during jobs under a FeatureGroup. By default, the Vertex AI Service Agent is used. When using an IAM Policy to isolate this FeatureGroup within a project, a separate service account should be provisioned by setting this field to `SERVICE_AGENT_TYPE_FEATURE_GROUP`. This will generate a separate service account to access the BigQuery source table.
        
      valid_values: ['SERVICE_AGENT_TYPE_UNSPECIFIED', 'SERVICE_AGENT_TYPE_PROJECT', 'SERVICE_AGENT_TYPE_FEATURE_GROUP']
    - name: featureGroupId
      value: string

UPDATE examples

patch

Updates the parameters of a single FeatureGroup.

UPDATE google.aiplatform.feature_groups
SET 
data__bigQuery = '{{ bigQuery }}',
data__name = '{{ name }}',
data__etag = '{{ etag }}',
data__labels = '{{ labels }}',
data__description = '{{ description }}',
data__serviceAgentType = '{{ serviceAgentType }}'
WHERE 
projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND featureGroupsId = '{{ featureGroupsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
done,
error,
metadata,
response;

DELETE examples

delete

Deletes a single FeatureGroup.

DELETE FROM google.aiplatform.feature_groups
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND featureGroupsId = '{{ featureGroupsId }}' --required
AND force = '{{ force }}';