Menyiapkan lingkungan

Sebelum menggunakan Vertex AI Agent Engine, Anda harus memastikan lingkungan Anda telah 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 bekerja dengan Vertex AI Agent Engine.

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

Siapkan dengan Google Cloud

Anda dapat melakukan penyiapan dengan Google Cloud untuk Vertex AI Agent Engine dengan membuat project Google Cloud atau mendaftar ke Vertex AI dalam mode ekspres:

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:

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Cloud Storage, Cloud Logging, Cloud Monitoring, Telemetry, and Cloud Trace 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

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.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Vertex AI, Cloud Storage, Cloud Logging, Cloud Monitoring, Telemetry, and Cloud Trace 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

Catatan: Untuk mengaktifkan API, Anda memerlukan izin serviceusage.services.enable. Jika Anda tidak memiliki izin ini, minta administrator untuk memberi Anda peran Service Usage Admin (roles/serviceusage.serviceUsageAdmin).

Mode ekspres

Ikuti petunjuk di Vertex AI dalam mode ekspres untuk menyiapkan Vertex AI Agent Engine dalam mode ekspres.

Setelah menyiapkan Vertex AI Agent Engine dalam mode ekspres, Anda dapat melewati langkah Menginstal dan melakukan inisialisasi Vertex AI SDK untuk Python.

Mendapatkan peran yang diperlukan

Guna mendapatkan izin yang diperlukan untuk menggunakan Vertex AI Agent Engine, minta administrator Anda untuk memberi Anda peran IAM Vertex AI 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) (Pratinjau): Gunakan identitas agen Identity Access Management (IAM) untuk menyediakan fitur keamanan dan pengelolaan akses saat menggunakan agen di Vertex AI Agent Engine Runtime. Identitas agen terikat ke setiap agen.

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

  • Agen Layanan Default: Secara default, agen menggunakan Agen Layanan AI Platform Reasoning Engine. Akun layanan terkelola Google ini memiliki peran Vertex AI 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

Pratinjau

Fitur ini tunduk pada "Persyaratan Penawaran Pra-GA" di bagian Persyaratan Layanan Umum dari Persyaratan Khusus Layanan. Fitur pra-GA tersedia "sebagaimana adanya" dan mungkin memiliki dukungan terbatas. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran.

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

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

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

1. Sediakan identitas agen dengan peran yang direkomendasikan berikut:

   • roles/aiplatform.expressUser: Memberikan akses untuk menjalankan inferensi, sesi, dan memori.

   • roles/serviceusage.serviceUsageConsumer: Beri agen izin untuk menggunakan kuota project dan Vertex AI SDK.

2. Berikan peran tambahan identitas agen sesuai kebutuhan untuk kasus penggunaan Anda.

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

Agen Layanan Default

Agen Layanan Reasoning Engine AI Platform 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 [e-mail].

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

Membuat agen layanan default secara manual

Meskipun Agen Layanan Reasoning Engine disediakan secara otomatis selama deployment Vertex AI Agent Engine, mungkin ada skenario saat 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

   Catatan: Respons terhadap perintah Google Cloud CLI mungkin hanya menampilkan Vertex AI Service Agent. Namun, Agen Layanan Reasoning Engine juga dibuat.

2. Buka halaman IAM, lalu klik Grant Access.

   Buka IAM

3. Di bagian Add principals, di kolom New principals, masukkan [e-mail].

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 memberikan izin yang diperlukan agar akun tersebut dapat menjalankan agen. Akun layanan kustom Anda kemungkinan memerlukan peran Vertex AI User (roles/aiplatform.user).

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

2. Berikan peran Vertex AI User (roles/aiplatform.user) ke 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 untuk menonaktifkan 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. Memberikan izin kepada Agen Layanan Vertex AI: Di project tempat akun layanan berada, berikan peran Service Account Token Creator (roles/iam.serviceAccountTokenCreator) kepada Agen Layanan Vertex AI ([e-mail]) dari 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 Vertex AI User (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 Vertex AI SDK untuk Python memerlukan tempat untuk menyiapkan kode agen Anda sebelum deployment:

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

• Deploy dari objek agen: Agen ada dalam memori. Vertex AI SDK untuk Python mengemas objek ini dan menguploadnya ke bucket Cloud Storage, yang berfungsi sebagai area penyiapan 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, Vertex AI Agent Engine akan menyiapkan artefak agen yang di-deploy di bucket Cloud Storage sebagai bagian dari proses deployment. Pastikan pokok yang diautentikasi untuk menggunakan Vertex AI (diri Anda 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.

Catatan: Sebaiknya buat bucket Cloud Storage di project yang sama tempat Anda men-deploy agen ke Vertex AI Agent Engine. Jika Anda menggunakan bucket di project lain, Anda harus memberikan izin baca secara manual ke Vertex AI Service Agent ([e-mail]) untuk bucket Cloud Storage Anda.

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

In the Google Cloud console, go to the Cloud Storage Buckets page.

Go to Buckets

Click Create.

On the Create a bucket page, enter your bucket information. To go to the next step, click Continue.

1. In the Get started section, do the following:
   • Enter a globally unique name that meets the bucket naming requirements.
   • To add a bucket label, expand the Labels section (), click Add label, and specify a key and a value for your label.
2. In the Choose where to store your data section, do the following:
   1. Select a Location type.
   2. Choose a location where your bucket's data is permanently stored from the Location type drop-down menu.
      • If you select the dual-region location type, you can also choose to enable turbo replication by using the relevant checkbox.
   3. To set up cross-bucket replication, select Add cross-bucket replication via Storage Transfer Service and follow these steps:

      Set up cross-bucket replication

      1. In the Bucket menu, select a bucket.

      2. In the Replication settings section, click Configure to configure settings for the replication job.

         The Configure cross-bucket replication pane appears.

         • To filter objects to replicate by object name prefix, enter a prefix that you want to include or exclude objects from, then click Add a prefix.
         • To set a storage class for the replicated objects, select a storage class from the Storage class menu. If you skip this step, the replicated objects will use the destination bucket's storage class by default.
         • Click Done.
3. In the Choose how to store your data section, do the following:
   1. Select a default storage class for the bucket or Autoclass for automatic storage class management of your bucket's data.
   2. To enable hierarchical namespace, in the Optimize storage for data-intensive workloads section, select Enable hierarchical namespace on this bucket.
      Note: You cannot enable hierarchical namespace in existing buckets.
4. In the Choose how to control access to objects section, select whether or not your bucket enforces public access prevention, and select an access control method for your bucket's objects.
   Note: You cannot change the Prevent public access setting if this setting is enforced at an organization policy.
5. In the Choose how to protect object data section, do the following:
   • Select any of the options under Data protection that you want to set for your bucket.
     • To enable soft delete, click the Soft delete policy (For data recovery) checkbox, and specify the number of days you want to retain objects after deletion.
     • To set Object Versioning, click the Object versioning (For version control) checkbox, and specify the maximum number of versions per object and the number of days after which the noncurrent versions expire.
     • To enable the retention policy on objects and buckets, click the Retention (For compliance) checkbox, and then do the following:
       • To enable Object Retention Lock, click the Enable object retention checkbox.
       • To enable Bucket Lock, click the Set bucket retention policy checkbox, and choose a unit of time and a length of time for your retention period.
   • To choose how your object data will be encrypted, expand the Data encryption section (), and select a Data encryption method.

Click Create.

Menginstal dan melakukan inisialisasi Vertex AI 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 Vertex AI Agent Engine.
• adk: set 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 Vertex AI 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 Agent Engine, 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

Mode ekspres

Jika Anda menggunakan Vertex AI dalam mode ekspres, Anda tidak perlu melakukan tindakan apa pun.

Mengimpor dan melakukan inisialisasi SDK

Jalankan kode berikut untuk mengimpor dan melakukan inisialisasi SDK untuk Vertex AI Agent Engine:

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

dengan

• PROJECT_ID adalah Google Cloud project ID yang digunakan untuk mengembangkan dan men-deploy agen, dan
• LOCATION adalah salah satu wilayah yang didukung.

Mode ekspres

Jika Anda menggunakan Vertex AI dalam mode ekspres, jalankan kode berikut:

import vertexai
from vertexai import agent_engines # For the prebuilt ADK template

client = vertexai.Client(  # For service interactions via client.agent_engines
    api_key="API_KEY"
)

dengan API_KEY adalah kunci API yang Anda gunakan untuk mengautentikasi agen.

Langkah berikutnya

• Mengembangkan agen.
• Memecahkan masalah saat menyiapkan lingkungan.
• Dapatkan dukungan.