サンドボックス テンプレートを管理する

サンドボックス テンプレートは、 カスタム コンテナ サンドボックスのブループリントとして機能します。このページでは、Python SDK を使用してサンドボックス テンプレートのライフサイクルを管理する方法について説明します。既存のテンプレートを一覧表示したり、詳細を表示したり、不要になったときに削除したりできます。

テンプレートの構成(コンテナ イメージの変更など)を変更するには、既存のテンプレートを削除し、更新された構成で新しいテンプレートを作成します。

始める前に

サンドボックス テンプレートを管理するには、プロジェクトに対する次のロールが必要です。

  • Agent Platform ユーザー(roles/aiplatform.user

テンプレートの一覧表示

Agent Platform インスタンスに関連付けられているすべてのサンドボックス テンプレートを一覧表示するには:

import vertexai

client = vertexai.Client(project='<var>PROJECT_ID</var>', location='<var>LOCATION</var>')
instance_name = 'projects/PROJECT_ID/locations/LOCATION/reasoningEngines/INSTANCE_ID'

templates_response = client.agent_engines.sandboxes.templates.list(name=instance_name)

for template in templates_response.sandbox_environment_templates:
    print(template.name)

次のように置き換えます。

  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • LOCATION: Agent Platform インスタンスの Google Cloud リージョン。 サポートされているリージョンをご覧ください。
  • INSTANCE_ID: Agent Platform インスタンス ID。

テンプレートの詳細を表示する

特定のサンドボックス テンプレートの構成を表示するには:

template_name = 'projects/PROJECT_ID/locations/LOCATION/reasoningEngines/INSTANCE_ID/SandboxEnvironmentTemplate/TEMPLATE_ID'

template = client.agent_engines.sandboxes.templates.get(name=template_name)
print(template)

次のように置き換えます。

  • PROJECT_ID: 実際の Google Cloud プロジェクト ID。
  • LOCATION: Agent Platform インスタンスの Google Cloud リージョン。 サポートされているリージョンをご覧ください。
  • INSTANCE_ID: サンドボックス テンプレートを含む Agent Platform インスタンス ID。
  • TEMPLATE_ID: サンドボックス テンプレート ID。

テンプレートを削除する

サンドボックス テンプレートを削除するには:

client.agent_engines.sandboxes.templates.delete(name=template_name)
print("Template deleted.")