使用 Agent Runtime 前,請先確認環境已設定完成。您需要 Google Cloud 啟用帳單的專案、具備必要權限、設定 Cloud Storage 值區,並安裝 Python 適用的 Agent Platform SDK。請參閱下列主題,確保您已準備好開始使用 Agent Runtime。
如需簡化 Agent Runtime 環境設定和部署作業的 Terraform 參考範例,請參閱 agent-starter-pack。
使用 Google Cloud設定
您可以建立 Google Cloud 專案,設定 Agent Runtime 的 Google Cloud 。
Google Cloud 專案
每項專案都可用專案編號或專案 ID 來識別。PROJECT_NUMBER 是系統在您建立專案時自動產生的,而 PROJECT_ID 則是由您或專案建立者所建立。如要設定專案,請按照下列步驟操作:
- 登入 Google Cloud 帳戶。如果您是 Google Cloud新手,歡迎 建立帳戶,親自評估產品在實際工作環境中的成效。新客戶還能獲得價值 $300 美元的免費抵免額,可用於執行、測試及部署工作負載。
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Gemini Enterprise Agent Platform, Cloud Storage, Cloud Logging, Cloud Monitoring, Telemetry, Cloud Trace, and Resource Manager APIs.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator role
(
roles/resourcemanager.projectCreator), which contains theresourcemanager.projects.createpermission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
Enable the Gemini Enterprise Agent Platform, Cloud Storage, Cloud Logging, Cloud Monitoring, Telemetry, Cloud Trace, and Resource Manager APIs.
Roles required to enable APIs
To enable APIs, you need the
serviceusage.services.enablepermission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.
取得必要角色
如要取得使用 Agent Runtime 所需的權限,請要求管理員授予您專案的Agent Platform 使用者 (roles/aiplatform.user) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。
為代理設定身分和權限
設定身分和權限時,您可以選擇下列做法:
代理程式身分 (建議) 在 Agent Runtime 執行階段使用代理程式時,請使用 Identity Access Management (IAM) 代理程式身分,提供安全性和存取權管理功能。代理身分與每位代理人相關聯。根據預設,代理會具備「Agent Platform Agent Default Access」(Agent Platform 代理預設存取權) 角色 (
roles/aiplatform.agentDefaultAccess),僅包含基本專案範圍的記錄和模型呼叫權限,以及「Agent Platform Agent Context Editor」(Agent Platform 代理環境編輯者) 角色 (roles/aiplatform.agentContextEditor),限制代理只能存取自己的工作階段、記憶和沙箱。注意:這個角色可存取的部分功能可能處於預先發布階段
服務帳戶:服務帳戶會共用您部署至 Agent Runtime 的代理程式。服務帳戶有兩種選項:
- 預設服務代理:根據預設,代理會使用 AI Platform Reasoning Engine 服務代理。這個 Google 管理的服務帳戶具有「Gemini Enterprise Agent Platform Reasoning Engine Service Agent」角色 (
roles/aiplatform.reasoningEngineServiceAgent),其中包含已部署代理所需的預設權限。 - 自訂服務帳戶:您可以指定代理程式使用的服務帳戶。這樣一來,您就能更精細地控管授予代理商的權限。
- 預設服務代理:根據預設,代理會使用 AI Platform Reasoning Engine 服務代理。這個 Google 管理的服務帳戶具有「Gemini Enterprise Agent Platform Reasoning Engine Service Agent」角色 (
代理身分
如要在部署代理程式前設定 IAM 政策,可以建立代理程式身分,不必部署代理程式碼。如要這麼做,請只使用 identity_type 欄位建立 Agent Platform 執行個體:
remote_app = client.agent_engines.create(
config={
"identity_type": types.IdentityType.AGENT_IDENTITY,
},
)
使用代理程式身分建立 Agent Platform 執行個體後,即可執行下列操作:
視用途需要,授予代理程式身分其他角色。
使用
agent_engine.update(...)新增代理程式碼。
預設服務代理
系統預設會使用 AI Platform 推論引擎服務代理。如要查看預設權限的完整清單,請參閱 IAM 說明文件。
如果代理程式需要的權限超出預設集,您可以授予這項服務代理其他角色:
前往「IAM」頁面,然後勾選「包含 Google 提供的角色授予項目」核取方塊。
找出與
service-PROJECT_NUMBER@gcp-sa-aiplatform-re.iam.gserviceaccount.com相符的主體。按一下編輯按鈕,然後按一下儲存按鈕,將必要角色新增至主體。
手動產生預設服務代理
在 Agent Runtime 部署期間,系統會自動佈建 Reasoning Engine 服務代理程式,但有時您可能需要事先手動產生該代理程式。如要授予服務代理人特定角色,確保部署程序具備必要權限並避免潛在部署失敗,這項步驟就格外重要。
如要手動產生 Reasoning Engine 服務代理,請按照下列步驟操作:
使用 Google Cloud CLI 產生 Reasoning Engine 服務代理程式。
gcloud beta services identity create --service=aiplatform.googleapis.com --project=PROJECT-ID-OR-PROJECT-NUMBER前往「IAM」頁面,然後按一下「授予存取權」。
在「新增主體」部分的「New principals」(新增主體) 欄位中輸入
service-PROJECT_NUMBER@gcp-sa-aiplatform-re.iam.gserviceaccount.com。在「指派角色」部分,找出並選取所需角色。
按一下 [Save] 按鈕。
自訂服務帳戶
如要使用自己的服務帳戶,您必須授予該帳戶執行代理程式的必要權限。自訂服務帳戶可能需要「Agent Platform User」角色 (roles/aiplatform.user)。
如果沒有服務帳戶,請建立一個。請參閱「建立服務帳戶」。
將「Agent Platform User」(代理程式平台使用者) (
roles/aiplatform.user) 角色授予服務帳戶。將代理程式碼所需的任何其他角色授予服務帳戶。
如要使用這個服務帳戶部署代理程式,請授予自己這個自訂服務帳戶的「服務帳戶使用者」角色 (
roles/iam.serviceAccountUser)。部署代理程式時,請指定自訂服務帳戶的電子郵件地址。詳情請參閱「設定自訂服務帳戶」。
跨專案自訂服務帳戶
如果自訂服務帳戶來自其他專案,您需要在服務帳戶所在專案和部署代理程式的專案中,進行額外設定。
停用跨專案服務帳戶使用組織政策:在服務帳戶所在的專案中,請確保
iam.disableCrossProjectServiceAccountUsage組織政策未強制執行。詳情請參閱「停用跨專案服務帳戶使用強制執行」。授予 Agent Platform 服務代理程式權限:在服務帳戶所在的專案中,將「服務帳戶權杖建立者」(
roles/iam.serviceAccountTokenCreator) 角色授予您打算部署代理程式的專案 Agent Platform 服務代理程式 (service-RESOURCE_PROJECT_NUMBER@gcp-sa-aiplatform.iam.gserviceaccount.com)。授予自訂服務帳戶權限:在您打算部署代理程式的專案中,將必要角色授予自訂服務帳戶。這通常包括「Agent Platform 使用者」角色 (
roles/aiplatform.user) 和代理程式碼所需的任何其他角色。
(選用) 建立 Cloud Storage bucket
是否需要 Cloud Storage 值區,取決於 Agent Platform SDK for Python 是否需要暫存代理程式碼,才能進行部署:
從來源檔案部署:代理程式以檔案形式存在。Python 專用的 Agent Platform SDK 可將這些檔案直接封裝並上傳至部署服務,因此不需要 Cloud Storage 暫存值區。
從代理物件部署:代理存在於記憶體中。Python 適用的 Agent Platform SDK 會封裝這個物件,並上傳至 Cloud Storage bucket,做為部署服務的暫存區。
從來源檔案部署
如果從來源檔案部署代理程式,則不需要 Cloud Storage bucket。
從物件部署
從代理物件部署時,Agent Runtime 會在部署程序中,將已部署代理的構件暫存於 Cloud Storage bucket。請確認已通過驗證的主體 (您本人或服務帳戶) 具有這個儲存空間的 Storage Admin存取權,這是因為 Agent Platform SDK for Python 會將程式碼寫入這個值區。
如果已設定好儲存空間,可以略過這個步驟。否則,請按照建立值區的標準操作說明進行。
請要求管理員授予您專案的「Storage 管理員」(roles/storage.admin) IAM 角色。
Google Cloud 控制台
- 前往 Google Cloud 控制台的 Cloud Storage「Buckets」(值區) 頁面。
- 點選 「Create」(建立)。
- 在「建立 bucket」頁面中,輸入 bucket 資訊。如要前往下一個步驟,請按一下「繼續」。
- 在「開始使用」部分,執行下列操作:
-
在「Choose where to store your data」(選擇資料的儲存位置) 專區中,執行下列操作:
- 選取「位置類型」。
- 從「位置類型」下拉式選單中,選擇要永久儲存 bucket 資料的位置。
- 如果您選取「雙區域」位置類型,也可以使用相關核取方塊啟用強化型複製。
- 如要設定跨值區複製,請選取「透過 Storage 移轉服務新增跨值區複製作業」,然後按照下列步驟操作:
設定跨 bucket 複製作業
- 在「Bucket」選單中選取 bucket。
在「複製設定」部分,按一下「設定」,設定複製作業的設定。
畫面上會顯示「Configure cross-bucket replication」窗格。
- 如要依物件名稱前置字串篩選要複製的物件,請輸入要納入或排除物件的前置字串,然後按一下 「新增前置字串」。
- 如要為複製的物件設定儲存空間級別,請從「儲存空間級別」選單中選取儲存空間級別。如果略過這個步驟,複製的物件預設會使用目標值區的儲存空間級別。
- 按一下 [完成]。
- 在「選擇資料儲存方式」部分,執行下列操作:
- 在「選取如何控制物件的存取權」部分,選取 bucket 是否強制執行禁止公開存取,並為 bucket 物件選取存取權控管方法。
-
在「Choose how to protect object data」(選擇保護物件資料的方式) 專區中,執行下列操作:
- 選取「資料保護」下方的任何選項,為 bucket 設定所需項目。
- 如要啟用虛刪除,請按一下「虛刪除政策 (用於資料復原)」核取方塊,並指定要保留物件的天數 (刪除後)。
- 如要設定「物件版本管理」,請勾選「物件版本管理 (用於版本管控)」核取方塊,並指定每個物件的版本數量上限,以及非現行版本失效的天數。
- 如要為物件和 bucket 啟用保留政策,請勾選「保留 (符合法規)」核取方塊,然後執行下列操作:
- 如要啟用 Object Retention Lock,請按一下「啟用物件保留功能」核取方塊。
- 如要啟用「Bucket Lock」,請按一下「Set bucket retention policy」(設定值區保留政策) 核取方塊,然後選擇保留期限的時間單位和長度。
- 如要選擇物件資料的加密方式,請展開「資料加密」部分 (),然後選取「資料加密」方法。
- 選取「資料保護」下方的任何選項,為 bucket 設定所需項目。
- 點選「建立」。
指令列
安裝並初始化 Python 專用的 Agent Platform SDK
本節假設您已設定 Python 開發環境,或是使用 Colab (或任何其他已為您設定的合適執行階段)。
(選用) 設定虛擬環境
此外,也建議您設定虛擬環境,隔離依附元件。
安裝
為盡量減少必須安裝的依附元件組合,我們將依附元件分成以下幾類:
agent_engines:部署至 Agent Runtime 時所需的一組套件。adk:相容的 Agent Development Kit 套件組合。langchain:相容的 LangChain 和 LangGraph 套件組合。ag2:相容的 AG2 套件組合。llama_index:相容的 LlamaIndex 套件組合。
安裝 Agent Platform SDK for Python 時,您可以指定所需依附元件 (以半形逗號分隔)。如要安裝所有擴充功能,請按照下列步驟操作:
pip install google-cloud-aiplatform[agent_engines,adk,langchain,ag2,llama_index]>=1.112.0如要在 Agent Platform 上使用 Agent2Agent (A2A),您也必須安裝 a2a-sdk 套件:
pip install google-adk[a2a]驗證
Colab
請執行下列程式碼:
from google.colab import auth
auth.authenticate_user(project_id="PROJECT_ID")
Cloud Shell
您無需採取任何動作。
本機殼層
執行下列指令:
gcloud auth application-default login匯入並初始化 SDK
執行下列程式碼,匯入及初始化 Agent Runtime 的 SDK:
Google Cloud 專案
import vertexai
from vertexai import agent_engines # For the prebuilt templates
client = vertexai.Client( # For service interactions via client.agent_engines
project="PROJECT_ID",
location="LOCATION",
)
其中
(選用) 自備容器 (BYOC)
根據預設,Agent Runtime 會在部署程序中為您建構容器。如要為部署作業建立自訂容器,請按照本節的說明操作。
如要使用自訂容器部署代理程式,請完成下列高階工作:
- 建構容器映像檔並推送至 Artifact Registry。
- 為代理程式設定身分和權限。
- 將 Artifact Registry 讀取者角色授予 Agent Runtime 預設服務代理程式。
建構及推送容器映像檔
如要建構及推送容器映像檔,請按照「使用 Cloud Build 建構及推送 Docker 映像檔」中的操作說明進行。
設定 Agent Runtime 的身分和權限
如要從 Artifact Registry 存放區匯入容器,必須使用 Agent Runtime 預設服務代理程式。
根據預設,服務代理程式會在專案中自動產生。如果不存在,請按照「為代理程式設定身分和權限」建立及設定。
授予 Artifact Registry 讀取者角色
將 Artifact Registry 讀取者角色 (roles/artifactregistry.reader) 授予預設服務代理程式 (service-PROJECT_NUMBER@gcp-sa-aiplatform-re.iam.gserviceaccount.com)。
執行下列指令,將必要角色授予預設服務代理程式:
gcloud projects add-iam-policy-binding PROJECT_NUMBER \
--member="serviceAccount:service-PROJECT_NUMBER@gcp-sa-aiplatform-re.iam.gserviceaccount.com" \
--role="roles/artifactregistry.reader"(選用) 授予跨專案權限
如果容器映像檔儲存在 Artifact Registry 存放區中,且該存放區與部署代理程式的專案不同,則必須具備跨專案權限。 Google Cloud
在本例中,請在 Artifact Registry 存放區專案中,將 Artifact Registry 讀取者角色授予 Agent Platform 服務代理 (service-PROJECT_NUMBER@gcp-sa-aiplatform.iam.gserviceaccount.com)。
gcloud projects add-iam-policy-binding AR_REPO_PROJECT_NUMBER \
--member="serviceAccount:service-PROJECT_NUMBER@gcp-sa-aiplatform.iam.gserviceaccount.com" \
--role="roles/artifactregistry.reader"