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

このページでは、Agent Engine マネージド ランタイムにデプロイされたエージェントを管理する方法について説明します。デプロイされたエージェントは、Vertex AI で reasoningEngine タイプのリソースです。

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

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

Vertex AI SDK for Python

from vertexai import agent_engines

agent_engines.list()

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

from vertexai import agent_engines

agent_engines.list(filter='display_name="Demo Langchain 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 識別子があります。詳細については、エージェントをデプロイするをご覧ください。

Vertex AI SDK for Python

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

from vertexai import agent_engines

remote_agent = agent_engines.get("RESOURCE_ID")

または、完全修飾リソース名を指定することもできます。

from vertexai import agent_engines

remote_agent = agent_engines.get(
"projects/PROJECT_ID/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 つ指定する必要があります。デプロイされたエージェントの更新にかかる時間は、実行される更新内容によって異なりますが、通常は数秒から数分ほどかかります。

Vertex AI SDK for Python

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

from vertexai import agent_engines

agent_engines.update(
    resource_name=RESOURCE_NAME,    # Required.
    agent_engine=UPDATED_AGENT,     # Optional.
    requirements=REQUIREMENTS,      # Optional.
    display_name="DISPLAY_NAME",    # Optional.
    description="DESCRIPTION",      # Optional.
    extra_packages=EXTRA_PACKAGES,  # Optional.
)

引数は、エージェントをデプロイする場合と同じです。API リファレンスで詳細をご確認ください。

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）と空のレスポンスが返されます。

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

Vertex AI SDK for Python

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

remote_agent.delete()

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

from vertexai import agent_engines

agent_engines.delete(RESOURCE_NAME)

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

リクエストの本文（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 DELETE \
     -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"

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 DELETE `
    -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" | Select-Object -Expand Content

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