модуль google.cloud.gcp_vertexai_reasoning_engine — создание ресурса GCP VertexAI.ReasoningEngine

Примечание

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

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

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

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

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

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

ReasoningEngine предоставляет настраиваемую среду выполнения, которая позволяет моделям определять, какие действия и в каком порядке следует выполнять.

Требования

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

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

Параметры

Параметр	Комментарии
access_token строка	Токен доступа, используемый для аутентификации.
auth_kind строка / обязательный	Тип используемых учетных данных. Варианты: `"accesstoken"` `"application"` `"machineaccount"` `"serviceaccount"`
description строка	Описание ReasoningEngine.
display_name строка / обязательный	Отображаемое имя ReasoningEngine.
encryption_spec словарь	Спецификация ключа шифрования, управляемого клиентом, для ReasoningEngine. Если этот параметр задан, данный ReasoningEngine и все его подресурсы будут защищены этим ключом.
kms_key_name строка / обязательный	Идентификатор ресурса Cloud KMS для управляемого клиентом ключа шифрования, используемого для защиты ресурса. Формат: projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key. Ключ должен находиться в том же регионе, где создается вычислительный ресурс.
env_type строка	Указывает среду Ansible, в которой выполняется этот модуль. Не задавайте этот параметр, если не знаете, что делаете. Он изменяет только строку User Agent для всех запросов API.
project строка	Проект Google Cloud Platform, который следует использовать.
region строка	Регион среды выполнения ReasoningEngine. Например, us-central1.
scopes список / элементы=строки	Массив областей действия, которые следует использовать.
service_account_contents jsonarg	Содержимое JSON-файла учетной записи службы: в виде словаря или JSON-строки, представляющей его.
service_account_email строка	Необязательный адрес электронной почты учетной записи службы, если выбрана учетная запись компьютера и пользователь не хочет использовать адрес по умолчанию.
service_account_file путь	Путь к JSON-файлу учетной записи службы, если в качестве типа выбрана учетная запись службы.
spec словарь	Конфигурации ReasoningEngine.
agent_framework строка	Фреймворк агента с открытым исходным кодом, использованный для разработки агента.
class_methods строка	Объявления методов класса объекта в формате спецификации OpenAPI.
deployment_spec словарь	Спецификация развертывания ReasoningEngine.
container_concurrency целое число	Параллелизм для каждого контейнера и сервера агента. Рекомендуемое значение: 2 * cpu + 1. По умолчанию — 9.
env список / элементы=словарь	Переменные среды, задаваемые при развертывании ReasoningEngine.
name строка / обязательный	Имя переменной среды. Должно быть допустимым идентификатором C.
value строка / обязательный	Переменные, содержащие ссылку $(VAR_NAME), подставляются с использованием ранее заданных переменных среды контейнера и любых переменных среды службы. Если переменную разрешить не удается, ссылка во входной строке остается без изменений. Синтаксис $(VAR_NAME) можно экранировать с помощью двойного знака $, например: $$(VAR_NAME). Экранированные ссылки никогда не подставляются независимо от того, существует ли переменная.
max_instances целое число	Максимальное количество экземпляров приложения, которые можно запустить для обработки возросшего трафика. По умолчанию — 100. Диапазон: [1, 1000]. Если включена функция VPC-SC или PSC-I, допустимый диапазон — [1, 100].
min_instances целое число	Минимальное количество экземпляров приложения, которые будут постоянно работать. По умолчанию — 1. Диапазон: [0, 10].
psc_interface_config словарь	Конфигурация PSC-Interface.
dns_peering_configs список / элементы=словарь	Конфигурации пиринга DNS. Если этот параметр задан, Vertex AI попытается настроить зоны пиринга DNS в VPC проекта арендатора, чтобы разрешать указанные домены с помощью Cloud DNS целевой сети. Пользователь должен предоставить сервисному агенту Vertex AI роль dns.peer в целевом проекте.
domain строка / обязательный	Суффикс DNS-имени зоны, с которой устанавливается пиринг, например «my-internal-domain.corp.». Должен оканчиваться точкой.
target_network строка / обязательный	Имя сети VPC в targetProject, в которой видна зона DNS, указанная в параметре «domain».
target_project строка / обязательный	Идентификатор проекта, в котором размещена управляемая зона Cloud DNS, содержащая «domain». Сервисному агенту Vertex AI требуется роль dns.peer в этом проекте.
network_attachment строка	Имя подключения к сети Compute Engine, которое следует подключить к ресурсу в указанном регионе и проекте пользователя. Чтобы задать это поле, необходимо предварительно создать подключение к сети. Это поле используется только для ресурсов, работающих с PSC-Interface.
resource_limits словарь	Ограничения ресурсов для каждого контейнера. Поддерживаются только ключи «cpu» и «memory». По умолчанию — {“cpu”: “4”, “memory”: “4Gi”}. Для CPU поддерживаются только значения «1», «2», «4», «6» и «8». Подробнее см. на странице https://cloud.google.com/run/docs/configuring/cpu. Для памяти поддерживаются только значения «1Gi», «2Gi», .. «32 Gi». Подробнее см. на странице https://cloud.google.com/run/docs/configuring/memory-limits.
secret_env список / элементы=словарь	Переменные среды, значения которых представляют собой секреты в Cloud Secret Manager. Чтобы использовать эту функцию, назначьте сервисному агенту AI Platform Reasoning Engine роль «Secret Manager Secret Accessor» (roles/secretmanager.secretAccessor).
name строка / обязательный	Имя переменной среды. Должно быть допустимым идентификатором C.
secret_ref словарь / обязательный	Ссылка на секрет, хранящийся в Cloud Secret Manager и используемый в качестве значения этой переменной среды.
secret строка / обязательный	Имя секрета в Cloud Secret Manager. Формат: {secret_name}.
version строка	Версия секрета в Cloud Secret Manager. Можно указать «latest» для последней версии, целое число для определенной версии или псевдоним версии.
package_spec словарь	Спецификация пакета ReasoningEngine, предоставленная пользователем. Игнорируется, если пользователи напрямую указывают образ развертывания с помощью deploymentSpec.first_party_image_override; поле field_behavior сохраняется, чтобы избежать несовместимых изменений.
dependency_files_gcs_uri строка	URI файлов зависимостей в Cloud Storage в формате tar.gz.
pickle_object_gcs_uri строка	URI сериализованного объекта Python в Cloud Storage.
python_version строка	Версия Python. В настоящее время поддерживаются версии 3.8, 3.9, 3.10, 3.11, 3.12 и 3.13. Если параметр не задан, по умолчанию используется версия 3.10.
requirements_gcs_uri строка	URI файла requirements.txt в Cloud Storage.
service_account строка	Учетная запись службы, от имени которой запускается артефакт ReasoningEngine. Для чтения Cloud Storage проекта пользователя ей необходима роль “roles/storage.objectViewer”, а для использования расширений Vertex — роль “roles/aiplatform.user”. Если параметр не задан, будет использоваться сервисный агент Vertex AI Reasoning Engine в проекте.
source_code_spec словарь	Спецификация развертывания из исходного кода.
inline_source словарь	Исходный код предоставляется непосредственно в запросе.
source_archive строка	Только для ввода. Архив исходного кода приложения в виде сжатого tarball-файла (.tar.gz). Строка в кодировке base64.
python_spec словарь	Спецификация запуска приложения Python из исходного кода.
entrypoint_module строка	Модуль Python, загружаемый в качестве точки входа и заданный как полное имя модуля. Например: path.to.agent. Если параметр не задан, используется значение по умолчанию — “agent”. Корневая папка проекта будет добавлена в Python sys.path, что позволит указывать импорты относительно корневой папки.
entrypoint_object строка	Имя вызываемого объекта в entrypointModule, используемого в качестве приложения. Если параметр не задан, используется значение по умолчанию — “root_agent”.
requirements_file строка	Путь к файлу зависимостей относительно корневой папки исходного кода. Если параметр не задан, используется значение по умолчанию — “requirements.txt”.
version строка	Версия Python, которую следует использовать. Поддерживаются версии 3.9, 3.10, 3.11, 3.12 и 3.13. Если параметр не задан, по умолчанию используется версия 3.10.
state строка	Должен ли ресурс существовать в GCP. Варианты: `"present"` ← (по умолчанию) `"absent"`

Примечания

Примечание

Справочник API: https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.reasoningEngines/
Руководство по разработке и развертыванию агентов в Vertex AI Agent Engine: https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/quickstart
Для аутентификации можно задать 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 Reasoning Engine
  google.cloud.gcp_vertexai_reasoning_engine:
    state: present
    display_name: basic-reasoning-engine
    description: A Basic Reasoning Engine
    region: us-central1
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

- name: Create Source Based Deployment Reasoning Engine
  google.cloud.gcp_vertexai_reasoning_engine:
    state: present
    display_name: source-based-deployment-reasoning-engine
    description: A Source Based Deployment Reasoning Engine
    region: us-central1
    spec:
      source_code_spec:
        inline_source:
          source_archive: "{{ slurped_tarball.content }}"  # slurp already returns b64
          # source_archive: "{{ some_other_b64_encoded_string }}"
        python_spec:
          entrypoint_module: my_agent
          entrypoint_object: name_generator
          requirements_file: prod-requirements.txt  # defaults to requirements.txt
          version: "3.11"
    project: "{{ gcp_project }}"
    auth_kind: "{{ gcp_cred_kind }}"
    service_account_file: "{{ gcp_cred_file }}"

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

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

Ключ	Описание
changed boolean	Был ли изменён ресурс. Возвращается: всегда
createTime string	Временная метка создания Index в формате RFC3339 UTC «Zulu», с наносекундной точностью и не более чем девятью дробными разрядами. Возвращается: при успешном выполнении
name string	Сгенерированное имя ReasoningEngine в формате projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}. Возвращается: при успешном выполнении
state string	Текущее состояние ресурса. Возвращается: всегда
updateTime string	Временная метка последнего обновления Index в формате RFC3339 UTC «Zulu», с наносекундной точностью и не более чем девятью дробными разрядами. Возвращается: при успешном выполнении

Авторы

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_reasoning_engine_module.html