модуль google.cloud.gcp_vertexai_feature_online_store_featureview — создание ресурса GCP VertexAI.FeatureOnlineStoreFeatureview
Примечание
Этот модуль входит в коллекцию google.cloud (версия 1.13.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: google.cloud.gcp_vertexai_feature_online_store_featureview.
Краткое описание
- FeatureView представляет значения, которые FeatureOnlineStore будет предоставлять в соответствии с его syncConfig.
Требования
Следующие требования необходимы на хосте, где выполняется этот модуль.
- python >= 3.8
- requests >= 2.18.4
- google-auth >= 2.25.1
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Токен доступа, используемый для аутентификации. |
auth_kind строка / обязательный | Тип используемых учётных данных. Варианты:
|
big_query_source словарь | Настраивает извлечение данных из источника BigQuery для загрузки в FeatureOnlineStore. |
|
entity_id_columns список / элементы=строка / обязательный |
Столбцы для формирования entityId / ключей строк. Изначально поддерживается только одно значение. |
|
uri строка / обязательный |
URI представления BigQuery, которое будет материализовано при каждом запуске синхронизации на основе FeatureView.SyncConfig. |
env_type строка | Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте это значение, если не знаете, что делаете. Это значение изменяет только строку User Agent для запросов к API. |
feature_online_store строка / обязательный | Имя FeatureOnlineStore, используемого для FeatureView. |
feature_registry_source словарь | Настраивает загрузку в FeatureOnlineStore признаков из источника Feature Registry. |
|
feature_groups список / элементы=словарь / обязательный |
Список признаков, которые необходимо синхронизировать с Online Store. |
|
feature_group_id строка / обязательный |
Идентификатор группы признаков. |
|
feature_ids список / элементы=строка / обязательный |
Идентификаторы признаков в группе признаков. |
|
project_number строка |
Номер родительского проекта для групп признаков. |
labels словарь | Набор пар «ключ/значение» меток, назначаемых этому FeatureView. |
name строка | Имя FeatureView. Длина этого значения не должна превышать 60 символов; допустимые символы: [a-z0-9_]. Первый символ не может быть цифрой. |
project строка | Проект Google Cloud Platform, который будет использоваться. |
region строка / обязательный | Регион ресурса. Он должен совпадать с регионом featureonlinestore. |
scopes список / элементы=строка | Массив используемых областей доступа. |
service_account_contents аргумент json | Содержимое JSON-файла учётной записи службы, представленное в виде словаря или строки JSON. |
service_account_email строка | Необязательный адрес электронной почты учётной записи службы, если выбран machineaccount и пользователь не хочет использовать адрес по умолчанию. |
service_account_file путь | Путь к JSON-файлу учётной записи службы, если в качестве типа выбран serviceaccount. |
state строка | Должен ли ресурс существовать в GCP. Варианты:
|
sync_config словарь | Настраивает время синхронизации/обновления данных для этого FeatureView. По завершении синхронизации последние значения признаков featureValues для каждого entityId этого FeatureView становятся доступны для онлайн-обслуживания. |
|
continuous логическое значение |
Если значение равно true, FeatureView непрерывно синхронизируется с Online Store. Варианты:
|
|
cron строка |
Расписание Cron (https://en.wikipedia.org/wiki/Cron) для запуска запланированных заданий. Чтобы явно задать часовой пояс для таблицы cron, добавьте префикс: «CRON_TZ=${IANA_TIME_ZONE}» или «TZ=${IANA_TIME_ZONE}». |
vector_search_config словарь | Конфигурация векторного поиска. Она содержит необходимые настройки для создания индекса на основе исходных данных, чтобы во время онлайн-обслуживания можно было выполнять поиск алгоритмами приближённых ближайших соседей (ANN). |
|
brute_force_config словарь |
Параметры поиска полным перебором, при котором для каждого запроса в базе данных выполняется обычный линейный поиск. Этот режим предназначен главным образом для тестирования производительности и получения эталонных результатов для приближённого поиска. |
|
crowding_column строка |
Столбец группировки. Этот столбец содержит атрибут группировки — ограничение для списка соседей, возвращаемого поиском ближайших соседей. Оно требует, чтобы среди k возвращённых соседей значение crowdingAttribute повторялось не более k’ раз. |
|
distance_measure_type строка |
Мера расстояния, используемая при поиске ближайших соседей. Допустимые значения см. в [документации API](https://cloud.google.com/vertex-ai/docs/reference/rest/v1beta1/projects.locations.featureOnlineStores.featureViews#DistanceMeasureType). Варианты:
|
|
embedding_column строка / обязательный |
Столбец эмбеддингов. Этот столбец содержит исходные данные для создания индекса векторного поиска. |
|
embedding_dimension целое число |
Количество измерений входного эмбеддинга. |
|
filter_columns список / элементы=строка |
Столбцы признаков, используемые для фильтрации результатов векторного поиска. |
|
tree_ah_config словарь |
Параметры алгоритма tree-AH (неглубокое дерево + асимметричное хеширование). Дополнительные сведения см. в статье: https://arxiv.org/abs/1908.10396. |
|
leaf_node_embedding_count строка |
Количество эмбеддингов в каждом листовом узле. Если значение не задано, используется значение по умолчанию 1000. |
Примечания
Примечание
- Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.featureOnlineStores.featureViews
- Официальное руководство по документации: https://cloud.google.com/vertex-ai/docs
- Для аутентификации параметр auth_kind можно задать с помощью переменной среды
GCP_AUTH_KIND. - Для аутентификации параметр service_account_file можно задать с помощью переменной среды
GCP_SERVICE_ACCOUNT_FILE. - Для аутентификации параметр service_account_contents можно задать с помощью переменной среды
GCP_SERVICE_ACCOUNT_CONTENTS. - Для аутентификации параметр service_account_email можно задать с помощью переменной среды
GCP_SERVICE_ACCOUNT_EMAIL. - Для аутентификации параметр access_token можно задать с помощью переменной среды
GCP_ACCESS_TOKEN. - Для аутентификации параметр scopes можно задать с помощью переменной среды
GCP_SCOPES. - Значения переменных среды используются только в том случае, если значения не заданы в плейбуке.
- Параметры
service_account_email,service_account_file,service_account_fileиaccess_tokenявляются взаимоисключающими.
Примеры
- name: Create Feature Online Store Featureview
google.cloud.gcp_vertexai_feature_online_store_featureview:
state: present
name: my_feature_online_store_featureview
feature_online_store: my_feature_online_store
sync_config:
cron: "0 0 * * *"
big_query_source:
uri: "bq://{{ gcp_project }}.my_dataset.my_table"
region: us-central1
project: "{{ gcp_project }}"
auth_kind: "{{ gcp_cred_kind }}"
service_account_file: "{{ gcp_cred_file }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
changed логическое значение | Был ли изменён ресурс. Возвращается: всегда |
createTime строка | Время создания featureOnlinestore в формате RFC3339 UTC «Zulu», с наносекундной точностью и до девяти знаков после запятой. Возвращается: при успешном выполнении |
state строка | Текущее состояние ресурса. Возвращается: всегда |
updateTime строка | Время последнего обновления featureOnlinestore в формате RFC3339 UTC «Zulu», с наносекундной точностью и до девяти знаков после запятой. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/google/cloud/gcp_vertexai_feature_online_store_featureview_module.html