このページは Cloud Translation API によって翻訳されました。

Google Cloud コンソールまたは API 呼び出しを使用してセッションを管理する

このセクションでは、Vertex AI Agent Engine セッションで Google Cloud コンソールまたは API 呼び出しを直接使用してセッションを管理する方法について説明します。ADK エージェントを使用してセッションを管理しない場合は、 Google Cloud コンソールまたは直接 API 呼び出しを使用できます。

ADK エージェントを使用してセッションを管理するには、Agent Development Kit でセッションを管理するをご覧ください。

Vertex AI Agent Engine インスタンスを作成する

Vertex AI Agent Engine セッションにアクセスするには、まず Vertex AI Agent Engine インスタンスを使用する必要があります。セッションの使用を開始するためにコードをデプロイする必要はありません。Agent Engine を使用したことがある場合は、コードをデプロイしなくても、Vertex AI Agent Engine インスタンスの作成には数秒しかかかりません。Agent Engine を初めて使用する場合は、時間がかかることがあります。

既存の Vertex AI Agent Engine インスタンスがない場合は、次のコードを使用して作成します。

import vertexai

client = vertexai.Client(
  project="PROJECT_ID",
  location="LOCATION"
)
# If you don't have an Agent Engine instance already, create an instance.
agent_engine = client.agent_engines.create()

# Optionally, print out the Agent Engine resource name. You will need the
# resource name to interact with Sessions later on.
print(agent_engine.api_resource.name)

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

PROJECT_ID: プロジェクト ID。
LOCATION: リージョン。セッションのサポートされているリージョンをご覧ください。

セッションを一覧表示する

Vertex AI Agent Engine インスタンスに関連付けられているセッションを一覧表示します。

Google Cloud コンソール

デプロイされたエージェントの場合は、 Google Cloud コンソールを使用して、エージェントに関連付けられているセッションを一覧表示できます。

Google Cloud コンソールで、[Vertex AI Agent Engine] ページに移動します。
Agent Engine に移動

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

Vertex AI SDK for Python

for session in client.agent_engines.sessions.list(
    name=agent_engine.api_resource.name,  # Required
):
    print(session)

# To list sessions for a specific user:
for session in client.agent_engines.sessions.list(
    name=agent_engine.api_resource.name,  # Required
    config={"filter": "user_id=USER_ID"},
):
    print(session)

USER_ID: 128 文字以内でユーザー ID を選択します。例: user-123

REST

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

PROJECT_ID: プロジェクト ID。
LOCATION: Agent Engine インスタンスを作成したリージョン。
AGENT_ENGINE_ID: Agent Engine インスタンスのリソース ID。

HTTP メソッドと URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions

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

curl

注: 次のコマンドは、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/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions"

PowerShell

注: 次のコマンドは、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/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions" | Select-Object -Expand Content

返されたセッションのリストが表示されます。

必要に応じて、特定のユーザーのセッションを一覧表示するには、クエリパラメータ ?filter=user_id=\"USER_ID\" を追加します。ここで、USER_ID はクエリするユーザーの ID です。

セッションを作成する

ユーザー ID に関連付けられたセッションを作成します。

Google Cloud コンソール

デプロイされたエージェントの場合、 Google Cloud コンソールを使用してセッションを作成できます。

Google Cloud コンソールで、[Vertex AI Agent Engine] ページに移動します。
Agent Engine に移動

選択したプロジェクトの一部である Agent Engine インスタンスがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。
Agent Engine インスタンスの名前をクリックします。
[Playground] タブをクリックします。
[新しいセッション] をクリックして、新しいセッションを作成します。

Vertex AI SDK for Python

session = client.agent_engines.sessions.create(
    name=agent_engine.api_resource.name,  # Required
    user_id=USER_ID, # Required
)

ここで、USER_ID は定義したユーザー ID です。例: user-123

REST

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

PROJECT_ID: プロジェクト ID。
LOCATION: Agent Engine インスタンスを作成したリージョン。
AGENT_ENGINE_ID: Agent Engine インスタンスのリソース ID。
USER_ID: 定義したユーザー ID。例: sessions-agent

HTTP メソッドと URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions

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

{
  "userId": USER_ID
}

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

curl

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

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions"

PowerShell

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

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

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions" | Select-Object -Expand Content

長時間実行オペレーションが返されます。このオペレーションをクエリで使用してセッションの作成ステータスを確認します。

セッションを取得する

Vertex AI Agent Engine インスタンスに関連付けられている特定のセッションを取得します。

Google Cloud コンソール

デプロイされたエージェントの場合、 Google Cloud コンソールを使用してセッションを作成できます。

Google Cloud コンソールで、[Vertex AI Agent Engine] ページに移動します。
Agent Engine に移動

選択したプロジェクトの一部である Agent Engine インスタンスがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。
Agent Engine インスタンスの名前をクリックします。
[Playground] タブをクリックします。
[セッション] タブをクリックします。セッションのリストが ID 別に表示されます。
詳細を表示するセッションをクリックします。

Vertex AI SDK for Python

session = client.agent_engines.sessions.get(
    name='projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID',  # Required
    user_id=USER_ID, # Required
)
# session.name will correspond to
#   'projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID'

REST

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

PROJECT_ID: プロジェクト ID。
LOCATION: Agent Engine インスタンスを作成したリージョン。
AGENT_ENGINE_ID: Agent Engine インスタンスのリソース ID。
SESSION_ID: 取得するセッションのリソース ID。セッション ID は、セッションの作成時に受信したレスポンスから取得できます。

HTTP メソッドと URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID

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

curl

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

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

PowerShell

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

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

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

レスポンスにセッションに関する情報が表示されます。

セッションを削除する

Vertex AI Agent Engine インスタンスに関連付けられているセッションを削除します。

Google Cloud コンソール

デプロイされたエージェントの場合は、 Google Cloud コンソールを使用して、エージェントに関連付けられたセッションを削除できます。

Google Cloud コンソールで、[Vertex AI Agent Engine] ページに移動します。
Agent Engine に移動

選択したプロジェクトの一部である Agent Engine インスタンスがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。
Agent Engine インスタンスの名前をクリックします。
[セッション] タブをクリックします。セッションのリストが ID 別に表示されます。
削除するセッションの [その他の操作] メニュー（）をクリックします。
[削除] をクリックします。
[セッションを削除] をクリックします。

Vertex AI SDK for Python

client.agent_engines.sessions.delete(name=session.name)

REST

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

PROJECT_ID: プロジェクト ID。
LOCATION: Example Store インスタンスを作成するリージョン。
AGENT_ENGINE_ID: Agent Engine インスタンスのリソース ID。
SESSION_ID: 取得するセッションのリソース ID。

HTTP メソッドと URL:

DELETE https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID

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

curl

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

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

PowerShell

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

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

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

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

セッションのイベントを一覧表示する

Vertex AI Agent Engine インスタンスに関連付けられているセッションのイベントを一覧表示します。

Google Cloud コンソール

デプロイされたエージェントの場合、 Google Cloud コンソールを使用してセッションを作成できます。

Google Cloud コンソールで、[Vertex AI Agent Engine] ページに移動します。
Agent Engine に移動

選択したプロジェクトの一部である Agent Engine インスタンスがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。
Agent Engine インスタンスの名前をクリックします。
[Playground] タブをクリックします。
[セッション] タブをクリックします。セッションのリストが ID 別に表示されます。
詳細を表示するセッションをクリックします。
[イベント] タブをクリックして、セッションに関連付けられているイベントを表示します。

Vertex AI SDK for Python

for session_event in client.agent_engines.list_session_events(
    name=session.name,
):
    print(session_event)

REST

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

PROJECT_ID: プロジェクト ID。
LOCATION: Agent Engine インスタンスを作成したリージョン。
AGENT_ENGINE_ID: Agent Engine インスタンスのリソース ID。
SESSION_ID: 取得するセッションのリソース ID。

HTTP メソッドと URL:

GET https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID/events

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

curl

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

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

PowerShell

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

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

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

レスポンスには、セッションに関連付けられているイベントのリストが表示されます。

セッションにイベントを追加する

Vertex AI Agent Engine インスタンスに関連付けられているセッションにイベントを追加します。

Google Cloud コンソール

デプロイされたエージェントの場合、 Google Cloud コンソールを使用してセッションを作成できます。

Google Cloud コンソールで、[Vertex AI Agent Engine] ページに移動します。
Agent Engine に移動

選択したプロジェクトの一部である Agent Engine インスタンスがリストに表示されます。[フィルタ] フィールドを使用して、指定した列でリストをフィルタできます。
Agent Engine インスタンスの名前をクリックします。
[Playground] タブをクリックします。
[セッション] タブをクリックします。セッションのリストが ID 別に表示されます。
詳細を表示するセッションをクリックします。
[イベント] タブをクリックして、セッションに関連付けられているイベントを表示します。
メッセージを入力し、Enter キーを押して、セッションに新しいイベントを追加します。

Vertex AI SDK for Python

import datetime

client.agent_engines.sessions.events.append(
    name=session.name,
    author="user",                                              # Required.
    invocation_id="1",                                          # Required.
    timestamp=datetime.datetime.now(tz=datetime.timezone.utc),  # Required.
    config={
        "content": {
            "role": "user",
            "parts": [{"text": "hello"}]
        },
    },
)

REST

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

PROJECT_ID: プロジェクト ID。
LOCATION: Agent Engine インスタンスを作成したリージョン。
AGENT_ENGINE_ID: Agent Engine インスタンスのリソース ID。
SESSION_ID: イベントを追加するセッションのリソース ID。
AUTHOR: イベントの作成者。'user' またはエージェント名を指定できます。
INVOCATION_ID: 呼び出しの ID。
TIMESTAMP: イベントのタイムスタンプ。

HTTP メソッドと URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID:appendEvent

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

{
  "author": AUTHOR,
  "invocationId": INVOCATION_ID,
  "timestamp": TIMESTAMP,
}

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

curl

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

curl -X POST \
     -H "Authorization: Bearer $(gcloud auth print-access-token)" \
     -H "Content-Type: application/json; charset=utf-8" \
     -d @request.json \
     "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID:appendEvent"

PowerShell

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

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

Invoke-WebRequest `
    -Method POST `
    -Headers $headers `
    -ContentType: "application/json; charset=utf-8" `
    -InFile request.json `
    -Uri "https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/reasoningEngines/AGENT_ENGINE_ID/sessions/SESSION_ID:appendEvent" | Select-Object -Expand Content

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

クリーンアップ

このプロジェクトで使用されているすべてのリソースをクリーンアップするには、Vertex AI Agent Engine インスタンスとその子リソースを削除します。

agent_engine.delete(force=True)

Google Cloud コンソールまたは API 呼び出しを使用してセッションを管理する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

Vertex AI Agent Engine インスタンスを作成する

セッションを一覧表示する

Google Cloud コンソール

Vertex AI SDK for Python

REST

curl

PowerShell

セッションを作成する

Google Cloud コンソール

Vertex AI SDK for Python

REST

curl

PowerShell

セッションを取得する

Google Cloud コンソール

Vertex AI SDK for Python

REST

curl

PowerShell

セッションを削除する

Google Cloud コンソール

Vertex AI SDK for Python

REST

curl

PowerShell

セッションのイベントを一覧表示する

Google Cloud コンソール

Vertex AI SDK for Python

REST

curl

PowerShell

セッションにイベントを追加する

Google Cloud コンソール

Vertex AI SDK for Python

REST

curl

PowerShell

クリーンアップ

Google Cloud コンソールまたは API 呼び出しを使用してセッションを管理する