Модуль google.cloud.gcp_vertexai_rag_engine_config — создание ресурса GCP VertexAI.RagEngineConfig

Примечание

Этот модуль входит в коллекцию google.cloud (версия 1.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install google.cloud. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: google.cloud.gcp_vertexai_rag_engine_config.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Vertex AI RAG Engine позволяет масштабировать экземпляр RagManagedDb в соответствии с требованиями к использованию и производительности, выбирая один из двух уровней. Кроме того, при необходимости можно удалить данные Vertex AI RAG Engine, выбрав третий уровень. Уровень — это параметр на уровне проекта, доступный в ресурсе RagEngineConfig, который влияет на все корпуса RAG, использующие RagManagedDb. В RagEngineConfig доступны следующие уровни: Basic, Scaled и Unprovisioned.

Требования

На узле, на котором выполняется этот модуль, необходимы следующие компоненты.

python >= 3.8
requests >= 2.18.4
google-auth >= 2.25.1

Параметры

Параметр	Комментарии
access_token string	Токен доступа, используемый для аутентификации.
auth_kind string / обязательный	Тип используемых учетных данных. Варианты: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
env_type string	Указывает, в какой среде Ansible выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Этот параметр изменяет только строку User Agent для всех запросов к API.
project string	Проект Google Cloud Platform, который будет использоваться.
rag_managed_db_config string	Конфигурация RagManagedDb, используемой RagEngine. Уровень Basic — экономичный уровень с низкой вычислительной нагрузкой, подходящий для следующих случаев: эксперименты с RagManagedDb, небольшой объем данных, рабочие нагрузки, нечувствительные к задержкам, использование RAG Engine только с внешними векторными базами данных. ПРИМЕЧАНИЕ. Это уровень по умолчанию, если явно не выбран другой. Уровень Scaled обеспечивает производительность промышленного уровня и функцию автоматического масштабирования. Он подходит клиентам с большим объемом данных или рабочими нагрузками, чувствительными к производительности. Уровень Unprovisioned отключает службу RAG Engine и удаляет все данные, хранящиеся в этой службе. При этом выставление счетов за службу будет прекращено. ПРИМЕЧАНИЕ. Удаленные данные восстановить нельзя. Чтобы снова использовать RAG Engine, необходимо изменить уровень, вызвав API UpdateRagEngineConfig. ПРИМЕЧАНИЕ. Установка значения Unprovisioned равносильна state=absent. Варианты: `"scaled"` `"basic"` ← (по умолчанию) `"unprovisioned"`
region string	Регион RagEngineConfig. Например, us-central1.
scopes list / элементы=string	Массив используемых областей действия.
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы в виде словаря или строки JSON, представляющей его.
service_account_email string	Необязательный адрес электронной почты учетной записи службы, если выбрано значение machineaccount и пользователь не хочет использовать адрес электронной почты по умолчанию.
service_account_file path	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрано serviceaccount.
state string	Должен ли ресурс существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник API: https://cloud.google.com/vertex-ai/generative-ai/docs/reference/rest/v1/RagEngineConfig
Официальное руководство по документации: https://cloud.google.com/vertex-ai/generative-ai/docs/rag-engine/understanding-ragmanageddb
Для аутентификации можно задать 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 Basic RAG Engine Config
  google.cloud.gcp_vertexai_rag_engine_config:
    state: present
    rag_managed_config: basic
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

################################################################################

- name: Create Scaled RAG Engine Config
  google.cloud.gcp_vertexai_rag_engine_config:
    state: present
    rag_managed_config: scaled
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

################################################################################

- name: Create Scaled RAG Engine Config
  google.cloud.gcp_vertexai_rag_engine_config:
    state: absent
    rag_managed_config: unprovisioned
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
changed boolean	Был ли изменен ресурс. Возвращается: всегда
name string	Имя ресурса Dataset. Это значение задается Google. Возвращается: при успешном выполнении
state string	Текущее состояние ресурса. Возвращается: всегда

Авторы

Google Inc. (@googlecloudplatform)

Ссылки на коллекцию

© 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_rag_engine_config_module.html