デプロイされたエージェントを管理する

Agent Runtime を使用すると、プラットフォームにデプロイされたエージェントを管理できます。コンソール、SDK、REST API を使用して、デプロイされたエージェントを一覧表示、取得、更新、削除できます。

このドキュメントでは、Agent Platform でデプロイされたエージェントを管理する方法について説明します。 新しいエージェントをデプロイする場合は、 エージェントをデプロイするをご覧ください。

デプロイされたエージェントを一覧表示する

指定されたプロジェクトとロケーションにデプロイされているすべてのエージェントを一覧表示します。

コンソール

1. コンソールで、Agent Platform の [デプロイ] ページに移動します。 Google Cloud
   

   [デプロイ] に移動

選択したプロジェクトの一部であるデプロイ済みのエージェントがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。

Agent Platform SDK

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

for agent in client.agent_engines.list():
    print(agent)

リストを display_name でフィルタするには:

for agent in client.agent_engines.list(
    config={
        "filter": 'display_name="DISPLAY_NAME"',
    },
):
    print(agent)

REST

reasoningEngines.list メソッドを呼び出します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: GCP プロジェクト ID
• LOCATION: サポートされているリージョン

HTTP メソッドと URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines" | Select-Object -Expand Content

成功したことを示すステータス コード（2xx）と空のレスポンスが返されます。

デプロイされたエージェントを取得する

デプロイされた各エージェントには一意の RESOURCE_ID 識別子があります。詳細については、エージェントをデプロイするをご覧ください。

コンソール

1. コンソールで、Agent Platform の [デプロイ] ページに移動します。 Google Cloud
   

   [デプロイ] に移動

   選択したプロジェクトの一部であるデプロイ済みのエージェントがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。

2. 指定したエージェントの名前をクリックします。エージェントの [指標] ページが開きます。

3. 省略可: エージェントのデプロイの詳細を表示するには、[デプロイの詳細] をクリックします。[デプロイの詳細] ペインが開きます。ペインを閉じるには、[完了] をクリックします。

4. 省略可: エージェントの query URL と streamQuery URL を表示するには、[API URL] をクリックします。[API URL] ペインが開きます。ペインを閉じるには、[完了] をクリックします。

Agent Platform SDK

次のコードを使用すると、デプロイされた特定のエージェントを取得できます。

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

remote_agent = client.agent_engines.get(
    name="projects/PROJECT_ID_OR_NUMBER/locations/LOCATION/reasoningEngines/RESOURCE_ID"
)

REST

reasoningEngines.get メソッドを呼び出します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: GCP プロジェクト ID
• LOCATION: サポートされているリージョン
• RESOURCE_ID: デプロイされたエージェントのリソース ID

HTTP メソッドと URL:

GET https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X GET \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method GET `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID" | Select-Object -Expand Content

成功したことを示すステータス コード（2xx）と空のレスポンスが返されます。

デプロイされたエージェントを更新する

デプロイされたエージェントの 1 つ以上のフィールドを同時に更新できますが、更新するフィールドを少なくとも 1 つ指定する必要があります。

デプロイされたエージェントのバージョン管理されていないフィールドまたはバージョン管理されているフィールドを更新できます。バージョン管理されたフィールドを更新すると、新しいリビジョンが作成されます。バージョン管理されたフィールドとリビジョンの管理の詳細については、リビジョンとトラフィックを管理するをご覧ください。

デプロイされたエージェントの更新にかかる時間は、実行される更新内容によって異なりますが、通常は数秒から数分ほどかかります。

コンソール

1. コンソールで、Agent Platform の [デプロイ] ページに移動します。 Google Cloud
   

   [デプロイ] に移動

2. 指定したエージェントの [その他の操作] メニュー（）をクリックします。

3. [編集] をクリックします。エージェントの [編集] ペインが開きます。

4. エージェントの表示名または説明を編集します。

5. [保存] をクリックします。

Agent Platform SDK

デプロイされたエージェント（RESOURCE_NAME に対応）を更新されたエージェント（UPDATED_AGENT に対応）に更新するには:

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

client.agent_engines.update(
    name=RESOURCE_NAME,                    # Required.
    agent=UPDATED_AGENT,                   # Optional.
    config={                                                # Optional.
        "requirements": REQUIREMENTS,      # Optional.
        "display_name": "DISPLAY_NAME",    # Optional.
        "description": "DESCRIPTION",      # Optional.
        "extra_packages": EXTRA_PACKAGES,  # Optional.
    },
)

引数は、エージェントをデプロイする場合と同じです。

REST

reasoningEngines.patch メソッドを呼び出し、update_mask を提供して更新するフィールドを指定します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: GCP プロジェクト ID
• LOCATION: サポートされているリージョン
• RESOURCE_ID: デプロイされたエージェントのリソース ID
• update_mask: 更新するフィールドのカンマ区切りリスト

HTTP メソッドと URL:

PATCH https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID?update_mask="display_name,description"

リクエストの本文（JSON）:

{
"displayName": "DISPLAY_NAME",
"description": "DESCRIPTION"
}

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

curl -X PATCH \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID?update_mask="display_name,description""

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

リクエスト本文を request.json という名前のファイルに保存して、次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method PATCH `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID?update_mask="display_name,description"" | Select-Object -Expand Content

成功したことを示すステータス コード（2xx）と空のレスポンスが返されます。

デプロイされたエージェントのテレメトリーを構成する

エージェントの開発中にトレースを有効にした 場合は、 Google Cloud コンソールを使用して、デプロイされたエージェントの テレメトリーを構成できます。

テレメトリーが有効になっているデプロイ済みエージェントのテレメトリーを構成します。

1. コンソールで、Agent Platform の [デプロイ] ページに移動します。 Google Cloud
   

   [デプロイ] に移動

   選択したプロジェクトの一部である Agent Platform インスタンスがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。

2. Agent Platform インスタンスの行を見つけます。[テレメトリー構成] 列で [構成] をクリックします。[サービス構成] パネルが開きます。

3. 次の構成を行うことができます。

   • オブザーバビリティ: 次の構成を行うことができます。

     • OpenTelemetry のトレースとログの計測を有効にする: エージェント のオブザーバビリティ ダッシュボードとトレースページにデータを入力するには、切り替えボタンをクリックしてオン にします。

     • プロンプト入力とレスポンス出力のロギングを有効にする: ユーザーのプロンプトとレスポンスの内容全体を収集して 保存するには、切り替えボタンをクリックして オンにします。

     エージェントのテレメトリー収集が無効になっている場合は、エージェントを再デプロイ し、Vertex AI SDK のバージョンを >= 1.126.1 に更新して、[Observability] の構成オプションを表示する必要があります。

   • コンテナ: デプロイされたエージェントのコンテナ設定を構成します。

     • スケーリング: [インスタンスの最小数] と [インスタンスの最大数] [のインスタンス] を入力します。

     • [Resources]: 各コンテナの [Memory] と [CPU] の上限を選択します。

     • [コンテナの同時実行]: [インスタンスの最小数] を入力して、各コンテナとエージェント サーバーの同時実行を設定します。推奨値は（2 × CPU + 1）で、デフォルト値は 9 です。

   • アクセスと権限: [IAM で権限を管理] をクリックして、関連付けられたサービス アカウントの エージェント権限を管理します。

   • デプロイの詳細: エージェントのデプロイの詳細（ リソース名 や 表示名 など）を表示します。

   • Agent Platform メモリバンク: エージェントのメモリバンクの詳細（メモリ 生成やメモリ検索など）を表示します。

4. [更新] または [閉じる] をクリックします。

デプロイされたエージェントの指標を表示する

デプロイされたエージェントの場合、コンソールを使用してエージェントの指標を表示できます。

1. コンソールで、Agent Platform の [デプロイ] ページに移動します。 Google Cloud
   

   [デプロイ] に移動

   選択したプロジェクトの一部であるデプロイ済みのエージェントがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。

2. エージェントの名前をクリックします。選択したエージェントのダッシュボード が表示されます。

3. 次のいずれかの [ダッシュボード] タブを選択します。

   • 概要: エージェントの指標の概要ダッシュボード（ エージェントのレイテンシ、エージェントのリクエスト数、エージェントのエラー率など）を表示します。

   • モデル: エージェントのモデルの指標のダッシュボード（ モデル呼び出し数、モデルエラー率、モデルトークンの使用量など）を表示します。

   • ツール: エージェントのツールの指標のダッシュボード（ ツール呼び出し数、ツールエラー率、ツールのレイテンシなど）を表示します。

   • 使用量: エージェントの使用量の指標のダッシュボード（ 入力と出力によるトークンの使用量、コンテナの CPU 割り当て、コンテナの メモリ割り当てなど）を表示します。

   • ログ: エージェントで Cloud Logging を 有効にしている場合は、エージェントのログを表示します。

デプロイされたエージェントを削除する

デプロイされたエージェントを Agent Runtime マネージド ランタイムから削除します。

コンソール

1. コンソールで、Agent Platform の [デプロイ] ページに移動します。 Google Cloud
   

   [デプロイ] に移動

2. 指定したエージェントの [その他の操作] メニュー（）をクリックします。

3. [削除] をクリックします。

4. [エージェントを削除] をクリックします。

Agent Platform SDK

デプロイされたエージェントの既存のインスタンス （remote_agentとして）がすでに存在する場合は、次のコマンドを実行できます。

remote_agent.delete(
    force=True, # Optional, if the agent has resources (e.g. sessions, memory)
)

または、次のように agent_engines.delete() を呼び出して、RESOURCE_NAME に対応するデプロイされたエージェントを削除することもできます。

import vertexai

client = vertexai.Client(  # For service interactions via client.agent_engines
    project="PROJECT_ID",
    location="LOCATION",
)

client.agent_engines.delete(
    name=RESOURCE_NAME,
    force=True, # Optional, if the agent has resources (e.g. sessions, memory)
)

REST

reasoningEngines.delete メソッドを呼び出します。

リクエストのデータを使用する前に、次のように置き換えます。

• PROJECT_ID: GCP プロジェクト ID
• LOCATION: サポートされているリージョン
• RESOURCE_ID: デプロイされたエージェントのリソース ID

HTTP メソッドと URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID

リクエストを送信するには、次のいずれかのオプションを展開します。

curl（Linux、macOS、Cloud Shell）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ユーザー アカウントで gcloud CLI にログインしているか、Cloud Shell を使用して自動的に gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

curl -X DELETE \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID"

PowerShell（Windows）

注: 次のコマンドは、gcloud init または gcloud auth login を実行して、ご自分のユーザー アカウントで gcloud CLI にログインしていることを前提としています。gcloud auth list を実行すると、現在アクティブなアカウントを確認できます。

次のコマンドを実行します。

$cred = gcloud auth print-access-token
$headers = @{ "Authorization" = "Bearer $cred" }

Invoke-WebRequest `
    -Method DELETE `
    -Headers $headers `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/RESOURCE_ID" | Select-Object -Expand Content

成功したことを示すステータス コード（2xx）と空のレスポンスが返されます。

次のステップ

ガイド

エージェントを使用する

Agent Platform Runtime でエージェントを使用する。