google.cloud.gcp_vertexai_feature_online_store_featureview_info module – List VertexAI.FeatureOnlineStoreFeatureview resources

Note

This module is part of the google.cloud collection (version 1.15.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install google.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: google.cloud.gcp_vertexai_feature_online_store_featureview_info.

Synopsis

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

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.8

  • requests >= 2.18.4

  • google-auth >= 2.25.1

Parameters

Parameter

Comments

access_token

string

The access token used to authenticate.

auth_kind

string / required

The type of credential used.

Choices:

  • "accesstoken"

  • "application"

  • "machineaccount"

  • "serviceaccount"

env_type

string

Specifies which Ansible environment you’re running this module within.

This should not be set unless you know what you’re doing.

This only alters the User Agent string for any API requests.

feature_online_store

string / required

The name of the FeatureOnlineStore to use for the featureview.

filters

list / elements=string

A list of filter expression strings used to filter the resources returned by the API.

Each string is a filter expression (e.g. some_field = "SOME_VALUE").

Multiple expressions are combined with a logical AND.

Refer to the filter topic documentation https://cloud.google.com/sdk/gcloud/reference/topic/filters.

Refer to the AIP-160 filter syntax documentation https://google.aip.dev/160.

project

string

The Google Cloud Platform project to use.

region

string / required

The region for the resource.

It should be the same as the featureonlinestore region.

scopes

list / elements=string

Array of scopes to be used.

service_account_contents

jsonarg

The contents of a Service Account JSON file,

either in a dictionary or as a JSON string that represents it.

service_account_email

string

An optional service account email address if machineaccount is

selected and the user does not wish to use the default email.

service_account_file

path

The path of a Service Account JSON file if serviceaccount

is selected as type.

Notes

Note

Examples

- name: List all gcp_vertexai_feature_online_store_featureview_info resources
  google.cloud.gcp_vertexai_feature_online_store_featureview_info:
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

- name: List gcp_vertexai_feature_online_store_featureview_info resources matching given filters
  google.cloud.gcp_vertexai_feature_online_store_featureview_info:
    filters:
      - display_name = "my-resource"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Whether any changes were made (always false for info modules).

Returned: always

resources

list / elements=dictionary

List of VertexAI.FeatureOnlineStoreFeatureview resources matching the supplied filters. May be empty, contain a single resource, or multiple resources.

Returned: always

bigQuerySource

dictionary

Configures how data is supposed to be extracted from a BigQuery source to be loaded onto the FeatureOnlineStore.

Returned: when set

entityIdColumns

list / elements=string

Columns to construct entityId / row keys.

Start by supporting 1 only.

Returned: always

uri

string

The BigQuery view URI that will be materialized on each sync trigger based on FeatureView.SyncConfig.

Returned: always

createTime

string

The timestamp of when the featureOnlinestore was created in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Returned: success

featureRegistrySource

dictionary

Configures the features from a Feature Registry source that need to be loaded onto the FeatureOnlineStore.

Returned: when set

featureGroups

list / elements=dictionary

List of features that need to be synced to Online Store.

Returned: always

featureGroupId

string

Identifier of the feature group.

Returned: always

featureIds

list / elements=string

Identifiers of features under the feature group.

Returned: always

projectNumber

string

The project number of the parent project of the feature Groups.

Returned: when set

labels

dictionary

A set of key/value label pairs to assign to this FeatureView.

**Note**: This field is non-authoritative, and will only manage the labels present in your configuration.

Returned: when set

syncConfig

dictionary

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.

Returned: when set

continuous

boolean

If true, syncs the FeatureView in a continuous manner to Online Store.

Returned: when set

cron

string

Cron schedule (https://en.wikipedia.org/wiki/Cron) to launch scheduled runs.

To explicitly set a timezone to the cron tab, apply a prefix in the cron tab: “CRON_TZ=${IANA_TIME_ZONE}” or “TZ=${IANA_TIME_ZONE}”.

Returned: when set

updateTime

string

The timestamp of when the featureOnlinestore was last updated in RFC3339 UTC “Zulu” format, with nanosecond resolution and up to nine fractional digits.

Returned: success

vectorSearchConfig

dictionary

Configuration 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.

Returned: when set

bruteForceConfig

dictionary

Configuration options for using brute force search, which simply implements the standard linear search in the database for each query.

It is primarily meant for benchmarking and to generate the ground truth for approximate search.

Returned: when set

crowdingColumn

string

Column of crowding.

This column contains crowding attribute which is a constraint on a neighbor list produced by nearest neighbor search requiring that no more than some value k’ of the k neighbors returned have the same value of crowdingAttribute.

Returned: when set

distanceMeasureType

string

The distance measure used in nearest neighbor search.

For details on allowed values, see the [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/projects.locations.featureOnlineStores.featureViews#DistanceMeasureType).

Returned: when set

embeddingColumn

string

Column of embedding.

This column contains the source data to create index for vector search.

Returned: always

embeddingDimension

integer

The number of dimensions of the input embedding.

Returned: when set

filterColumns

list / elements=string

Columns of features that are used to filter vector search results.

Returned: when set

treeAhConfig

dictionary

Configuration options for the tree-AH algorithm (Shallow tree + Asymmetric Hashing).

Please refer to this paper for more details: https://arxiv.org/abs/1908.10396.

Returned: when set

leafNodeEmbeddingCount

string

Number of embeddings on each leaf node.

The default value is 1000 if not set.

Returned: when set

Authors

  • Google Inc. (@googlecloudplatform)