Menyiapkan lingkungan

Sebelum menggunakan Agent Runtime, Anda harus memastikan lingkungan Anda sudah disiapkan. Anda harus memiliki Google Cloud project dengan penagihan diaktifkan, memiliki izin yang diperlukan, menyiapkan bucket Cloud Storage, dan menginstal Vertex AI SDK untuk Python. Gunakan topik berikut untuk memastikan Anda siap mulai menggunakan Agent Runtime.

Untuk contoh Terraform referensi guna menyederhanakan penyiapan dan deployment lingkungan Agent Runtime, pertimbangkan untuk mempelajari agent-starter-pack.

Siapkan dengan Google Cloud

Anda dapat menyiapkan dengan Google Cloud untuk Agent Runtime dengan membuat project Google Cloud .

Google Cloud project

Setiap project dapat diidentifikasi dengan dua cara: nomor project atau project ID. PROJECT_NUMBER dibuat secara otomatis saat Anda membuat project, sedangkan PROJECT_ID dibuat oleh Anda, atau siapa pun yang membuat project. Untuk menyiapkan project:

  1. Login ke akun Google Cloud Anda. Jika Anda baru menggunakan Google Cloud, buat akun untuk mengevaluasi performa produk kami dalam skenario dunia nyata. Pelanggan baru juga mendapatkan kredit gratis senilai $300 untuk menjalankan, menguji, dan men-deploy workload.

  2. 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 the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. 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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

  5. 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 the resourcemanager.projects.create permission. Learn how to grant roles.

    Go to project selector

  6. Verify that billing is enabled for your Google Cloud project.

  7. 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 Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the APIs

    8.

Mendapatkan peran yang diperlukan

Untuk mendapatkan izin yang diperlukan guna menggunakan Agent Runtime, minta administrator Anda untuk memberi Anda peran IAM Agent Platform User (roles/aiplatform.user) di project Anda. Untuk mengetahui informasi selengkapnya tentang cara memberikan peran, lihat Mengelola akses ke project, folder, dan organisasi.

Anda mungkin juga bisa mendapatkan izin yang diperlukan melalui peran khusus atau peran bawaan lainnya.

Menyiapkan identitas dan izin untuk agen Anda

Anda memiliki opsi berikut saat menyiapkan identitas dan izin:

  • Identitas agen (Direkomendasikan) Gunakan identitas agen Identity Access Management (IAM) untuk menyediakan fitur keamanan dan pengelolaan akses saat menggunakan agen di Agent Runtime. Identitas agen terikat ke setiap agen. Secara default, agen memiliki peran Agent Platform Agent Default Access (roles/aiplatform.agentDefaultAccess), yang hanya mencakup izin logging dan panggilan model dasar di seluruh project, serta peran Agent Platform Agent Context Editor (roles/aiplatform.agentContextEditor), yang membatasi agen untuk mengakses hanya sesi, memori, dan sandbox-nya sendiri.

    Catatan: Beberapa fitur yang dapat diakses oleh peran ini mungkin dalam status Pratinjau

  • Akun layanan: Akun layanan dibagikan di seluruh agen yang Anda deploy ke Agent Runtime. Anda memiliki dua opsi untuk akun layanan:

    • Agen Layanan Default: Secara default, agen menggunakan Agen Layanan AI Platform Reasoning Engine. Akun layanan yang dikelola Google ini memiliki peran Gemini Enterprise Agent Platform Reasoning Engine Service Agent (roles/aiplatform.reasoningEngineServiceAgent), yang mencakup izin default yang diperlukan untuk agen yang di-deploy.
    • Akun Layanan Kustom: Anda dapat menentukan akun layanan Anda sendiri yang akan digunakan oleh agen. Cara ini memberi Anda kontrol yang lebih terperinci atas izin yang diberikan kepada agen.

Identitas agen

Untuk menyiapkan kebijakan IAM sebelum men-deploy agen, Anda dapat membuat identitas agen tanpa men-deploy kode agen. Untuk melakukannya, buat instance Agent Platform dengan hanya kolom identity_type:

remote_app = client.agent_engines.create(
      config={
          "identity_type": types.IdentityType.AGENT_IDENTITY,
      },
)

Setelah membuat instance Agent Platform dengan identitas agen, Anda dapat melakukan hal berikut:

  1. Beri identitas agen peran tambahan sesuai kebutuhan untuk kasus penggunaan Anda.

  2. Tambahkan kode agen menggunakan agent_engine.update(...).

Agen Layanan Default

AI Platform Reasoning Engine Service Agent digunakan secara default. Anda dapat melihat daftar lengkap izin default di dokumentasi IAM.

Jika agen Anda memerlukan izin di luar set default, Anda dapat memberikan peran tambahan kepada Agen Layanan ini:

  1. Buka halaman IAM, lalu centang kotak "Sertakan pemberian peran yang disediakan Google".

    Buka IAM

  2. Temukan akun utama yang cocok dengan service-PROJECT_NUMBER@gcp-sa-aiplatform-re.iam.gserviceaccount.com.

  3. Tambahkan peran yang diperlukan ke akun utama dengan mengklik tombol edit, lalu tombol simpan.

Membuat agen layanan default secara manual

Meskipun Agen Layanan Mesin Inferensi disediakan secara otomatis selama deployment Agent Runtime, mungkin ada skenario di mana Anda perlu membuatnya secara manual terlebih dahulu. Hal ini sangat penting jika Anda perlu memberikan peran tertentu kepada agen layanan untuk memastikan proses deployment memiliki izin yang diperlukan dan menghindari potensi kegagalan deployment.

Berikut adalah langkah-langkah untuk membuat Reasoning Engine Service Agent secara manual:

  1. Buat Agen Layanan Reasoning Engine menggunakan Google Cloud CLI.

    gcloud beta services identity create --service=aiplatform.googleapis.com --project=PROJECT-ID-OR-PROJECT-NUMBER

  2. Buka halaman IAM, lalu klik Berikan Akses.

    Buka IAM

  3. Di bagian Add principals, di kolom New principals, masukkan service-PROJECT_NUMBER@gcp-sa-aiplatform-re.iam.gserviceaccount.com.

  4. Di bagian Assign roles, cari dan pilih peran yang Anda butuhkan.

  5. Klik tombol Save.

Akun layanan kustom

Untuk menggunakan akun layanan Anda sendiri, Anda harus memberinya izin yang diperlukan untuk menjalankan agen. Akun layanan kustom Anda kemungkinan memerlukan peran Pengguna Platform Agen (roles/aiplatform.user).

  1. Jika Anda belum memiliki akun layanan, buat akun layanan. Lihat Membuat akun layanan.

  2. Berikan peran Agent Platform User (roles/aiplatform.user) kepada akun layanan.

  3. Berikan peran lain yang diperlukan oleh kode agen Anda ke akun layanan.

  4. Untuk men-deploy agen Anda dengan akun layanan ini, berikan peran Service Account User (roles/iam.serviceAccountUser) kepada diri Anda di akun layanan kustom ini.

  5. Saat men-deploy agen, tentukan alamat email akun layanan kustom Anda. Lihat Mengonfigurasi akun layanan kustom untuk mengetahui detailnya.

Akun layanan kustom lintas project

Jika akun layanan kustom Anda berasal dari project yang berbeda, Anda memerlukan konfigurasi tambahan di project tempat akun layanan berada dan project tempat Anda men-deploy agen.

  1. Kebijakan organisasi nonaktifkan penggunaan akun layanan lintas project: Di project tempat akun layanan berada, pastikan kebijakan organisasi iam.disableCrossProjectServiceAccountUsage TIDAK diterapkan. Lihat Menonaktifkan penerapan penggunaan akun layanan lintas project untuk mengetahui detail selengkapnya.

  2. Berikan izin kepada Agen Layanan Platform Agen: Di project tempat akun layanan berada, berikan peran Service Account Token Creator (roles/iam.serviceAccountTokenCreator) kepada Agen Layanan Platform Agen (service-RESOURCE_PROJECT_NUMBER@gcp-sa-aiplatform.iam.gserviceaccount.com) project tempat Anda berencana men-deploy agen.

  3. Memberikan izin ke akun layanan kustom: Di project tempat Anda berencana men-deploy agen, berikan peran yang diperlukan ke akun layanan kustom. Hal ini biasanya mencakup peran Pengguna Platform Agen (roles/aiplatform.user) dan peran lain yang diperlukan oleh kode agen Anda.

(Opsional) Buat bucket Cloud Storage

Kebutuhan akan bucket Cloud Storage bergantung pada apakah Agent Platform SDK for Python memerlukan tempat untuk menyiapkan kode agen Anda sebelum deployment:

  • Deploy dari file sumber: Agen ada sebagai file. Agent Platform SDK untuk Python dapat memaketkan dan mengupload file ini langsung ke layanan deployment, sehingga tidak diperlukan bucket penyiapan Cloud Storage.

  • Deploy dari objek agen: Agen ada dalam memori. Agent Platform SDK untuk Python mengemas objek ini dan menguploadnya ke bucket Cloud Storage, yang berfungsi sebagai area staging untuk layanan deployment.

Men-deploy dari file sumber

Jika Anda men-deploy agen dari file sumber, bucket Cloud Storage tidak diperlukan.

Men-deploy dari objek

Saat Anda men-deploy dari objek agen, Agent Runtime akan melakukan penahapan artefak agen yang di-deploy di bucket Cloud Storage sebagai bagian dari proses deployment. Pastikan prinsipal yang diautentikasi untuk menggunakan Platform Agen Gemini Enterprise (baik Anda sendiri atau akun layanan) memiliki akses Storage Admin ke bucket ini. Hal ini diperlukan karena Vertex AI SDK untuk Python menulis kode Anda ke bucket ini.

Jika sudah menyiapkan bucket, Anda dapat melewati langkah ini. Jika tidak, Anda dapat mengikuti petunjuk standar untuk membuat bucket.

Minta administrator untuk memberi Anda peran IAM Storage Admin (roles/storage.admin) di project Anda.

KonsolGoogle Cloud

  1. Di konsol Google Cloud , buka halaman Buckets Cloud Storage.

    Buka Buckets

  2. Klik Create.
  3. Di halaman Buat bucket, masukkan informasi bucket Anda. Untuk melanjutkan ke langkah berikutnya, klik Lanjutkan.
    1. Di bagian Mulai, lakukan tindakan berikut:
      • Masukkan nama yang unik secara global yang memenuhi persyaratan penamaan bucket.
      • Untuk menambahkan label bucket, luaskan bagian Label (), klik Tambahkan label, lalu tentukan key dan value untuk label Anda.
    2. Di bagian Pilih tempat untuk menyimpan data Anda, lakukan tindakan berikut:
      1. Pilih Jenis lokasi.
      2. Pilih lokasi tempat data bucket Anda disimpan secara permanen dari menu drop-down Location type.
        • Jika memilih jenis lokasi dual-region, Anda juga dapat memilih untuk mengaktifkan replikasi turbo dengan menggunakan kotak centang yang relevan.
      3. Untuk menyiapkan replikasi lintas bucket, pilih Add cross-bucket replication via Storage Transfer Service dan ikuti langkah-langkah berikut:

        Menyiapkan replikasi lintas bucket

        1. Di menu Bucket, pilih bucket.

        2. Di bagian Setelan replikasi, klik Konfigurasi untuk mengonfigurasi setelan bagi tugas replikasi.

          Panel Konfigurasi replikasi lintas bucket akan muncul.

          • Untuk memfilter objek yang akan direplikasi menurut awalan nama objek, masukkan awalan yang ingin Anda sertakan atau kecualikan objeknya, lalu klik Tambahkan awalan.
          • Untuk menetapkan kelas penyimpanan bagi objek yang direplikasi, pilih kelas penyimpanan dari menu Kelas penyimpanan. Jika Anda melewati langkah ini, objek yang direplikasi akan menggunakan kelas penyimpanan bucket tujuan secara default.
          • Klik Done.
    3. Di bagian Choose how to store your data, lakukan tindakan berikut:
      1. Pilih kelas penyimpanan default untuk bucket atau Autoclass untuk pengelolaan kelas penyimpanan otomatis untuk data bucket Anda.
      2. Untuk mengaktifkan namespace hierarkis, di bagian Optimalkan penyimpanan untuk beban kerja intensif data, pilih Aktifkan namespace hierarkis di bucket ini.
    4. Di bagian Pilih cara mengontrol akses ke objek, pilih apakah bucket Anda menerapkan pencegahan akses publik atau tidak, lalu pilih metode kontrol akses untuk objek bucket Anda.
    5. Di bagian Pilih cara melindungi data objek, lakukan tindakan berikut:
      • Pilih salah satu opsi di bagian Perlindungan data yang ingin Anda tetapkan untuk bucket Anda.
        • Untuk mengaktifkan penghapusan sementara, klik kotak centang Kebijakan penghapusan sementara (Untuk pemulihan data), dan tentukan jumlah hari Anda ingin mempertahankan objek setelah penghapusan.
        • Untuk menyetel Pembuatan Versi Objek, klik kotak centang Pembuatan versi objek (Untuk kontrol versi), dan tentukan jumlah maksimum versi per objek dan jumlah hari setelah versi lama berakhir.
        • Untuk mengaktifkan kebijakan retensi pada objek dan bucket, klik kotak centang Retensi (Untuk kepatuhan), lalu lakukan hal berikut:
          • Untuk mengaktifkan Penguncian Retensi Objek, centang kotak Aktifkan retensi objek.
          • Untuk mengaktifkan Bucket Lock, centang kotak Setel kebijakan retensi bucket, lalu pilih satuan waktu dan durasi untuk periode retensi data Anda.
      • Untuk memilih cara mengenkripsi data objek Anda, luaskan bagian Enkripsi data (), lalu pilih metode Enkripsi data.
  4. Klik Create.

Command line

    Buat bucket Cloud Storage dan konfigurasikan sebagai berikut: 
    gcloud storage buckets create gs://BUCKET_NAME --default-storage-class STORAGE_CLASS --location LOCATION

Menginstal dan melakukan inisialisasi Agent Platform SDK untuk Python

Bagian ini mengasumsikan bahwa Anda telah menyiapkan lingkungan pengembangan Python, atau menggunakan Colab (atau runtime lain yang sesuai yang telah menyiapkannya untuk Anda).

(Opsional) Menyiapkan lingkungan virtual

Sebaiknya siapkan lingkungan virtual untuk mengisolasi dependensi Anda.

Penginstalan

Untuk meminimalkan kumpulan dependensi yang harus Anda instal, kami telah memisahkan dependensi menjadi:

  • agent_engines: set paket yang diperlukan untuk deployment ke Agent Runtime.
  • adk: kumpulan paket Agent Development Kit yang kompatibel.
  • langchain: kumpulan paket LangChain dan LangGraph yang kompatibel.
  • ag2: set paket AG2 yang kompatibel.
  • llama_index: set paket LlamaIndex yang kompatibel.

Saat menginstal Agent Platform SDK untuk Python, Anda dapat menentukan dependensi yang diperlukan (dipisahkan dengan koma). Untuk menginstal semuanya:

pip install google-cloud-aiplatform[agent_engines,adk,langchain,ag2,llama_index]>=1.112.0

Untuk menggunakan Agent2Agent (A2A) di Platform Agen , Anda juga harus menginstal paket a2a-sdk:

pip install a2a-sdk>=0.3.4

Autentikasi

Colab

Jalankan kode berikut:

from google.colab import auth

auth.authenticate_user(project_id="PROJECT_ID")

Cloud Shell

Tindakan tidak diperlukan.

Shell Lokal

Jalankan perintah berikut:

gcloud auth application-default login

Mengimpor dan melakukan inisialisasi SDK

Jalankan kode berikut untuk mengimpor dan menginisialisasi SDK untuk Agent Runtime:

Project 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",
)

di mana

(Opsional) Bawa penampung Anda sendiri (BYOC)

Runtime Agen membuat container untuk Anda sebagai bagian dari proses deployment. Jika Anda ingin membuat container sendiri untuk deployment, Anda harus mengikuti petunjuk di subbagian berikut. Secara umum, langkah-langkahnya adalah sebagai berikut:

  1. Bangun dan kirim image container ke Artifact Registry.
  2. Siapkan akun layanan untuk Agent Runtime yang sesuai dengan project pengguna (di Menyiapkan identitas dan izin untuk agen Anda) dan project tenant (tempat runtime berjalan).
  3. Berikan peran roles/artifactregistry.reader ke akun layanan project pengguna dan akun layanan project tenant.

Membangun dan mengirim image container

Untuk membangun dan mengirim image container, ikuti petunjuk di Membangun dan mengirim image Docker dengan Cloud Build.

Menyiapkan akun layanan untuk Runtime Agen

Untuk menyiapkan akun layanan, deploy agen yang mencetak akun layanan tenant.

Pertama, siapkan kode sumber untuk agen:

  1. Buka jendela terminal

  2. Buat direktori baru bernama byoc_setup

    mkdir byoc_setup

  3. Buat file di direktori byoc_setup bernama metadata_agent.py dengan konten berikut:

    class MetadataAgent:

  def query(self):
    import requests
    url = "http://metadata.google.internal/computeMetadata/v1/project/numeric-project-id"
    try:
        response = requests.get(url, headers={"Metadata-Flavor": "Google"})
        response.raise_for_status()
        return f"service-{response.text}@serverless-robot-prod.iam.gserviceaccount.com"
    except Exception:
        return None

root_agent = MetadataAgent()

  4. Buat file lain di direktori byoc_setup bernama requirements.txt dengan konten berikut:

    google-cloud-aiplatform[agent_engines]

  5. Jika Anda belum melakukannya, instal dan lakukan inisialisasi Agent Platform SDK untuk Python. Dalam sesi Python yang sama tempat Anda melakukan inisialisasi Agent Platform SDK untuk Python, jalankan kode berikut untuk mencetak TENANT_SERVICE_ACCOUNT:

    remote_agent = client.agent_engines.create( # This deploys the agent
    config={
        "source_packages": ["byoc_setup"],
        "entrypoint_module": "byoc_setup.metadata_agent",
        "entrypoint_object": "root_agent",
        "requirements_file": "byoc_setup/requirements.txt",
        "class_methods": [{'api_mode': '', 'name': 'query'}],
    },
)
# This prints the tenant service account
# service-{tenant_project_number}@serverless-robot-prod.iam.gserviceaccount.com
print(remote_agent.query())
# This cleans up the resources
remote_agent.delete(force=True)

  6. Cari USER_SERVICE_ACCOUNT di Menyiapkan identitas dan izin untuk agen Anda. Jika Anda menggunakan agen layanan default, nilai ini harus cocok dengan service-PROJECT_NUMBER@gcp-sa-aiplatform-re.iam.gserviceaccount.com.

Memberikan peran Artifact Registry Reader

Anda harus memberikan peran Pembaca Artifact Registry ke USER_SERVICE_ACCOUNT dan TENANT_SERVICE_ACCOUNT yang disediakan Google.

Akun layanan pengguna

Jalankan perintah berikut untuk memberikan peran yang diperlukan ke USER_SERVICE_ACCOUNT Anda:

gcloud projects add-iam-policy-binding <var>PROJECT_NUMBER</var> \
  --member="serviceAccount:USER_SERVICE_ACCOUNT" \
  --role="roles/artifactregistry.reader"

Akun layanan tenant

Jika organisasi Anda menerapkan batasan kebijakan organisasi iam.allowedPolicyMemberDomains, Anda harus mengizinkan domain pelanggan Google (yaitu C02h8e9nw) sebelum dapat memberikan peran ke TENANT_SERVICE_ACCOUNT.

Untuk mengetahui informasi selengkapnya tentang batasan iam.allowedPolicyMemberDomains, lihat Berbagi dengan batasan domain dalam dokumentasi IAM.

Anda harus meminta administrator organisasi, yang memiliki izin untuk mengubah batasan organisasi Anda, agar mengizinkan project Google Cloud Anda.

Setelah Anda memiliki izin, jalankan perintah berikut untuk memberikan peran yang diperlukan ke TENANT_SERVICE_ACCOUNT:

gcloud projects add-iam-policy-binding <var>PROJECT_NUMBER</var> \
  --member="serviceAccount:TENANT_SERVICE_ACCOUNT" \
  --role="roles/artifactregistry.reader"

Langkah berikutnya

Ringkasan

Pelajari cara membuat agen menggunakan Runtime Platform Agen.

Pemecahan masalah

Pelajari cara mengatasi error umum saat membuat agen kustom.

Resource

Temukan referensi dan dukungan untuk Google Agent Platform.