ADK 用 Google Cloud Data Agents ツール¶
これらは、Conversational Analytics API を活用したデータエージェントとの統合を提供することを目的としたツールセットです。
データエージェントは、自然言語を使用してデータを分析するのに役立つ AI 搭載のエージェントです。データエージェントを構成する際は、BigQuery、Looker、Looker Studio などのサポートされているデータソースから選択できます。
DataAgentToolset には、デフォルトで次の読み取り専用ツールが含まれています。
list_accessible_data_agents: 指定された Google Cloud プロジェクト内でアクセス権限があるデータエージェントを一覧表示します。オプションのlocationオーバーライドや、自動または手動のページネーション(page_sizeとpage_token)をサポートしています。get_data_agent_info: 完全なリソース名(projects/{project}/locations/{location}/dataAgents/{agent})を指定して、特定のデータエージェントに関する詳細と公開済みのコンテキストを取得します。ask_data_agent: 特定のデータエージェントに自然言語の質問を送信し、そのレスポンスを返します。
DataAgentToolConfig で enable_data_agent_modification=True を設定すると、ツールセットには次のツールも含まれます。
create_data_agent:DataAgentリソーススキーマに準拠した JSONagent_configから、Google Cloud プロジェクト内に指定されたdata_agent_idで新しいデータエージェントを作成します。location引数はオプションです。update_data_agent: JSONagent_configと、カンマ区切りのキャメルケース(camelCase)フィールド名のupdate_mask(例:displayName,description)から、既存のデータエージェントを更新します。update_maskにリストされているすべてのフィールドは、agent_configにも存在している必要があります。delete_data_agent: 完全なリソース名を指定して、既存のデータエージェントを削除します。
これらの変更ツールは、基盤となる長時間実行オペレーションが完了するまで、最大 data_agent_modification_timeout_seconds 秒間待機します。
前提条件¶
これらのツールを使用する前に、Google Cloud で次の手順を完了してください。
- Google Cloud プロジェクトで Gemini Data Analytics API(
geminidataanalytics.googleapis.com)を有効にします。 - ツールセットで使用される認証情報に、データエージェントとその基盤となるデータソースに必要な IAM 権限があることを確認します。エージェントを Google Cloud に接続する方法の詳細については、Google Cloud と Agent Platform への接続ガイドをご覧ください。
get_data_agent_infoツールとask_data_agentツールには、既存のデータエージェントが必要です。create_data_agent(enable_data_agent_modification=Trueの場合)を使用するか、次のいずれかのガイドに従って作成できます。
認証¶
DataAgentToolset には DataAgentCredentialsConfig が必要であり、複数の認証メカニズムをサポートしています。credentials、external_access_token_key、または client_id と client_secret のペアのいずれかを指定する必要があります。デフォルトでは、DataAgentCredentialsConfig は https://www.googleapis.com/auth/bigquery OAuth スコープを使用しますが、OAuth クライアント認証情報を構成する際に scopes を使用してオーバーライドできます。
試験運用版(Experimental)
DataAgentCredentialsConfig クラスは BaseGoogleCredentialsConfig を拡張しています。これは試験運用版であり、
本番環境プロジェクトでは使用しないでください。
アプリケーションのデフォルト認証情報(ADC)¶
ローカル開発や、Cloud Run や GKE などの Google Cloud サービス上で実行する場合は、このアプローチを使用する必要があります。
import google.auth
from google.adk.tools.data_agent import DataAgentToolset, DataAgentCredentialsConfig
# アプリケーションのデフォルト認証情報を読み込む
credentials, project_id = google.auth.default()
# ツールセットを構成する
credentials_config = DataAgentCredentialsConfig(credentials=credentials)
data_agent_toolset = DataAgentToolset(credentials_config=credentials_config)
サービス アカウント¶
サービス アカウント ファイルまたは情報を明示的に指定できます。
from google.oauth2 import service_account
from google.adk.tools.data_agent import DataAgentToolset, DataAgentCredentialsConfig
# サービス アカウントの認証情報を読み込む
credentials = service_account.Credentials.from_service_account_file('path/to/key.json')
# ツールセットを構成する
credentials_config = DataAgentCredentialsConfig(credentials=credentials)
data_agent_toolset = DataAgentToolset(credentials_config=credentials_config)
外部アクセス トークン¶
エンドユーザーに代わって処理を行う必要があるアプリケーションの場合、OAuth2 フローや外部 IDP などから取得したアクセス トークンから直接インスタンス化されたユーザー認証情報を渡すことができます。
from google.oauth2.credentials import Credentials
from google.adk.tools.data_agent import DataAgentToolset, DataAgentCredentialsConfig
# 'user_token' が外部 OAuth フロー経由で取得されていると仮定
credentials = Credentials(token=user_token)
# ツールセットを構成する
credentials_config = DataAgentCredentialsConfig(credentials=credentials)
data_agent_toolset = DataAgentToolset(credentials_config=credentials_config)
外部認証プロバイダ¶
Gemini Enterprise など、トークンがプラットフォームによって管理される外部認証プロバイダと統合する場合は、external_access_token_key を使用します。
from google.adk.tools.data_agent import DataAgentToolset, DataAgentCredentialsConfig
# セッション状態内でアクセス トークンを検索するために使用されるキー
credentials_config = DataAgentCredentialsConfig(
external_access_token_key="YOUR_AUTH_ID"
)
data_agent_toolset = DataAgentToolset(credentials_config=credentials_config)
インタラクティブ認証(ADK Web)¶
インタラクティブ セッションに adk web インターフェースを使用する場合、OAuth 2.0 クライアント認証情報を指定してログインフローをトリガーできます。このメカニズムは、ローカル開発と、ADK エージェントが Cloud Run などの環境にデプロイされている場合の両方で機能します。
from google.adk.tools.data_agent import DataAgentToolset, DataAgentCredentialsConfig
# OAuth 2.0 クライアント ID とシークレットを指定
credentials_config = DataAgentCredentialsConfig(
client_id="YOUR_CLIENT_ID",
client_secret="YOUR_CLIENT_SECRET"
)
data_agent_toolset = DataAgentToolset(credentials_config=credentials_config)
構成¶
DataAgentToolConfig を使用してツールの動作をカスタマイズできます。
max_query_result_rows(int、デフォルト:50):ask_data_agentが各データ結果に対して返す最大行数。location(str | None、デフォルト:None): API エンドポイントの選択に使用されるデフォルトの Google Cloud ロケーション(例:global、us、eu)。location引数を取るツールは、引数が設定されていない場合にこの値を使用し、設定されていない場合はglobalにフォールバックします。その他のツールはデータエージェントのリソース名からロケーションを使用しますが、ask_data_agentはこの値が設定されている場合にこの値を使用します。api_endpoint(str | None、デフォルト:None): Conversational Analytics API リクエスト用のオプションのカスタム API エンドポイント。指定した場合、デフォルトまたはロケーション由来の API エンドポイントをオーバーライドします。enable_data_agent_modification(bool、デフォルト:False):Trueの場合、ツールセットにcreate_data_agent、update_data_agent、delete_data_agentも含まれます。Falseの場合、ツールセットは読み取り専用になります。data_agent_modification_timeout_seconds(int、デフォルト:60): 長時間実行される作成、更新、または削除オペレーションをポーリングする際の合計タイムアウト(秒)。0より大きい必要があります。data_agent_modification_poll_interval_seconds(int、デフォルト:2): 作成、更新、または削除オペレーションが完了するのを待機する間のポーリング間隔(秒)。0より大きい必要があります。
使用上の注意
enable_data_agent_modification=True を設定すると、エージェントが Google Cloud プロジェクト内のデータエージェントを作成、更新、削除できるようになります。ツールセットで使用される認証情報が、必要最小限の IAM 権限を持つ承認済みのプロジェクトに制限されていることを確認してください。また、DataAgentToolset に tool_filter を渡して、特定のツールのみを公開することもできます(例: delete_data_agent を除外する)。
import google.auth
from google.adk.tools.data_agent import DataAgentToolset, DataAgentCredentialsConfig
from google.adk.tools.data_agent.config import DataAgentToolConfig
credentials, _ = google.auth.default()
credentials_config = DataAgentCredentialsConfig(credentials=credentials)
tool_config = DataAgentToolConfig(
max_query_result_rows=100,
enable_data_agent_modification=True,
data_agent_modification_timeout_seconds=120,
)
data_agent_toolset = DataAgentToolset(
credentials_config=credentials_config,
data_agent_tool_config=tool_config,
)
サンプルコード¶
次のサンプルコードは、アプリケーションのデフォルト認証情報(ADC)を使用して ADK エージェントで DataAgentToolset を使用する方法を示しています。
import asyncio
from google.adk.agents import Agent
from google.adk.runners import Runner
from google.adk.sessions import InMemorySessionService
from google.adk.tools.data_agent import DataAgentCredentialsConfig
from google.adk.tools.data_agent import DataAgentToolset
from google.adk.tools.data_agent.config import DataAgentToolConfig
from google.genai import types
import google.auth
# Define constants for this example agent
AGENT_NAME = "data_agent_example"
APP_NAME = "data_agent_app"
USER_ID = "user1234"
SESSION_ID = "1234"
GEMINI_MODEL = "gemini-flash-latest"
# Define tool configuration
# Set `enable_data_agent_modification=True` to also expose `create_data_agent`,
# `update_data_agent`, and `delete_data_agent`.
tool_config = DataAgentToolConfig(
max_query_result_rows=100,
enable_data_agent_modification=False,
)
# Use Application Default Credentials (ADC)
# https://cloud.google.com/docs/authentication/provide-credentials-adc
application_default_credentials, _ = google.auth.default()
credentials_config = DataAgentCredentialsConfig(
credentials=application_default_credentials
)
# Instantiate a Data Agent toolset
da_toolset = DataAgentToolset(
credentials_config=credentials_config,
data_agent_tool_config=tool_config,
)
# Agent Definition
data_agent = Agent(
name=AGENT_NAME,
model=GEMINI_MODEL,
description="Agent to answer user questions using data agents.",
instruction=(
"## Persona\nYou are a helpful assistant that uses data agents"
" to answer user questions about their data.\n\n"
),
tools=[da_toolset],
)
# Session and Runner
async def setup_session_and_runner():
session_service = InMemorySessionService()
await session_service.create_session(
app_name=APP_NAME, user_id=USER_ID, session_id=SESSION_ID
)
return Runner(
agent=data_agent, app_name=APP_NAME, session_service=session_service
)
# Agent Interaction
async def call_agent_async(runner, query):
"""
Helper function to call the agent with a query.
"""
content = types.Content(role="user", parts=[types.Part(text=query)])
events = runner.run_async(
user_id=USER_ID, session_id=SESSION_ID, new_message=content
)
print("USER:", query)
async for event in events:
if event.is_final_response():
final_response = event.content.parts[0].text
print("AGENT:", final_response)
async def main():
runner = await setup_session_and_runner()
# Replace `<PROJECT_ID>` with your Google Cloud project ID, and replace
# `<DATA_AGENT_NAME>` with a full resource name in the format:
# `projects/{project}/locations/{location}/dataAgents/{agent}`
await call_agent_async(
runner, "List accessible data agents in project <PROJECT_ID>."
)
await call_agent_async(runner, "Get information about <DATA_AGENT_NAME>.")
# The data agent in this example is configured with the BigQuery table:
# `bigquery-public-data.san_francisco.street_trees`
await call_agent_async(
runner, "Ask <DATA_AGENT_NAME> to count the rows in the table."
)
await call_agent_async(runner, "What are the columns in the table?")
await call_agent_async(runner, "What are the top 5 tree species?")
await call_agent_async(
runner, "For those species, what is the distribution of legal status?"
)
注: BigQuery のテーブルやデータセットをツールとして直接クエリする場合は、ADK 用 BigQuery ツールをご覧ください。