Dokumen ini menunjukkan cara mendaftarkan dan menggunakan ekstensi Penelusuran Agen yang disediakan Google dari konsol Google Cloud dan Vertex AI API. Ekstensi ini memungkinkan Anda mengakses dan menelusuri korpus situs dan data tidak terstruktur untuk memberikan respons yang relevan terhadap pertanyaan bahasa alami, seperti:
- "Bagaimana perubahan ancaman kompetitif bagi perusahaan dari Kuartal 1 tahun lalu hingga Kuartal 1 tahun ini?"
- "Bagian mana dari perusahaan yang berkembang paling pesat? Seberapa cepat?"
Ekstensi Agent Search menggunakan
Agent Search
untuk mengambil hasil yang bermakna dari penyimpanan data Anda. Ekstensi Penelusuran Agen ditentukan dalam file vertex_ai_search.yaml Spesifikasi OpenAPI.
Untuk menggunakan ekstensi Penelusuran Agen, Anda harus Membuat penyimpanan data di region global dengan cakupan penelusuran yang ditentukan. Untuk hasil penelusuran terbaik, aktifkan pengindeksan lanjutan untuk data situs dan edisi Enterprise untuk data tidak terstruktur. Lihat Tentang fitur lanjutan untuk mengetahui informasi selengkapnya.
openapi: "3.0.0" info: title: Vertex AI Search version: v1alpha description: > Performs search on user ingested data including website and unstructured data type. This extension is used when user wants to search or retrieve meaningful results from their ingested data in the Vertex AI Search service. Supported AuthTypes: - GOOGLE_SERVICE_ACCOUNT_AUTH: (only supports using Vertex AI Extension Service Agent). paths: /search: get: operationId: search description: Retrieves the results from user's query by searching in the data store. parameters: - name: query in: query schema: type: string description: User natural language instructions for search. required: true responses: default: description: Search execution result. content: application/json: schema: $ref: "#/components/schemas/SearchResult" components: schemas: SearchResult: description: Top results from search response. type: object properties: results: type: array items: type: object properties: title: type: string description: Retrieved document title. display_link: type: string description: Retrieved document link to display. link: type: string description: Retrieved document link. extractive_segments: type: array description: Extractive segments from the retrieved file. items: type: string extractive_answers: type: array description: Extractive answers from the retrieved file. These are generated from the extractive segments. items: type: string
Untuk mempelajari ekstensi Google dengan tutorial menyeluruh, lihat notebook Jupyter berikut:
- Alur kerja analis bisnis dengan Ekstensi Vertex AI: Gunakan ekstensi Code Interpreter dan ekstensi Agent Search untuk menyelesaikan laporan riset peluang investasi properti bagi pemangku kepentingan bisnis.
Colab | GitHub | Vertex AI Workbench - Alur kerja analisis ulasan game dengan Ekstensi Vertex AI: Gunakan ekstensi Code Interpreter untuk menganalisis ulasan game dari Steam. Gunakan ekstensi Penelusuran Agen untuk meringkas ulasan game dari situs. Gunakan ekstensi Code Interpreter untuk membuat laporan dengan semua aset yang dihasilkan.
Colab | GitHub | Vertex AI Workbench
Sebelum memulai
- 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.
-
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 Vertex AI API, if it is not already enabled.
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 Vertex AI API, if it is not already enabled.
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.
Mendaftarkan dan menjalankan ekstensi Penelusuran Agen
Bagian berikut menunjukkan cara mendaftarkan ekstensi Penelusuran Agen menggunakan konsol dan Vertex AI API. Google Cloud Setelah mendaftarkan ekstensi, Anda dapat menjalankannya menggunakan Vertex AI API.
Konsol
Mendaftarkan ekstensi
Lakukan langkah-langkah berikut untuk mendaftarkan ekstensi Agent Search menggunakan konsol Google Cloud .
Di konsol Google Cloud , buka halaman Ekstensi Vertex AI.
Klik Buat Ekstensi.
Dalam dialog Create a new extension, isi kolom berikut:
- Nama ekstensi: Masukkan nama untuk ekstensi Anda, seperti "vertex_search_extension".
- Deskripsi: (Opsional) Masukkan deskripsi ekstensi, seperti "Ekstensi penelusuran Vertex AI".
- Jenis ekstensi: Pilih
Vertex AI search.
Di bagian file Spesifikasi OpenAPI yang kini muncul, pastikan kolom berikut ditetapkan dengan benar:
- Nama API:
vertex_ai_search. - Deskripsi API:
Performs search on user ingested data including website and unstructured data type... - Sumber:
Cloud Storage. - Spesifikasi OpenAPI:
vertex-extension-public/vertex_ai_search.yaml. - Autentikasi:
Google service account.
- Nama API:
Di bagian Konfigurasi runtime, berikan nama konfigurasi penayangan. Nama konfigurasi penayangan ditentukan di vertexAiSearchRuntimeConfig. Format dan penyelesaiannya adalah sebagai berikut:
projects/PROJECT_ID/locations/global/collections/COLLECTION_NAME/engines/ENGINE/servingConfigs/SERVING_CONFIG- Tetapkan COLLECTION_NAME ke
default_collection. - Tetapkan ENGINE ke ID aplikasi yang Anda terima saat membuat aplikasi penelusuran. Untuk mempelajari lebih lanjut, lihat Membuat aplikasi penelusuran untuk data situs.
- Tetapkan SERVING_CONFIG ke
default_search.
- Tetapkan COLLECTION_NAME ke
Klik Buat Ekstensi.
REST
Mendaftarkan ekstensi
Kirim permintaan Vertex AI API
extensions.import
untuk mendaftarkan ekstensi Agent Search.
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: ID Google Cloud project Anda.
- REGION: Region Compute Engine.
- DISPLAY_NAME: Ekstensi name yang ditampilkan kepada pengguna, seperti "my_search_extension".
- DESCRIPTION: (Opsional) Deskripsi ekstensi yang ditampilkan kepada pengguna, seperti "Ekstensi penelusuran".
- SERVICE_ACCOUNT: (Opsional) Ekstensi Vertex AI Search
menggunakan GOOGLE_SERVICE_ACCOUNT_AUTH
seperti yang ditunjukkan dalam isi permintaan contoh. Jika Anda tidak menentukan akun layanan, ekstensi akan menggunakan akun layanan
Agen Layanan Ekstensi Vertex AI
default. Jika Anda menentukan akun layanan yang berbeda, berikan izin
iam.serviceAccounts.getAccessTokenke akun layanan Vertex AI Extension Service Agent pada akun layanan yang ditentukan. - SERVING_CONFIG_NAME: Nama konfigurasi penayangan ditentukan dalam
vertexAiSearchRuntimeConfig.
Format dan penyelesaiannya adalah sebagai berikut:
projects/PROJECT_ID/locations/global/collections/COLLECTION_NAME/engines/ENGINE/servingConfigs/SERVING_CONFIG.- PROJECT_ID: ID Google Cloud project Anda.
- Tetapkan COLLECTION_NAME ke
default_collection. - ENGINE: ID aplikasi yang Anda terima saat membuat aplikasi penelusuran. Untuk mempelajari lebih lanjut, lihat Membuat aplikasi penelusuran untuk data situs.
- Tetapkan SERVING_CONFIG ke
default_search.
Metode HTTP dan URL:
POST https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions:import
Meminta isi JSON:
{
"displayName":"DISPLAY_NAME",
"description":"DESCRIPTION",
"manifest":{
"name":"vertex_ai_search_tool",
"description":"A Vertex AI Search tool",
"apiSpec":{
"openApiGcsUri":"gs://vertex-extension-public/vertex_ai_search.yaml"
},
"authConfig":{
"authType":"GOOGLE_SERVICE_ACCOUNT_AUTH",
"googleServiceAccountConfig":{
"serviceAccount":"SERVICE_ACCOUNT"
}
}
}
"runtimeConfig": {
"vertexAiSearchRuntimeConfig": {
"servingConfigName": "SERVING_CONFIG_NAME",
}
}
}
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions:import"
PowerShell
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
$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://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions:import" | Select-Object -Expand Content
Menjalankan ekstensi
Anda dapat mengirimkan operasi execute ke Vertex AI API
untuk mendapatkan hasil yang bermakna dari penyimpanan data Anda.
Penelusuran dokumen
Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:
- PROJECT_ID: ID Google Cloud project Anda.
- REGION: Region Compute Engine.
- EXTENSION_ID: ID ekstensi Vertex AI Search Anda yang tercantum di Detail ekstensi di konsol Google Cloud .
Metode HTTP dan URL:
POST https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions/EXTENSION_ID:execute
Meminta isi JSON:
{
"operation_id":"search",
"operation_params":{
"query":"Housing affordability since 2010",
}
}
Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:
curl
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
curl -X POST \
-H "Authorization: Bearer $(gcloud auth print-access-token)" \
-H "Content-Type: application/json; charset=utf-8" \
-d @request.json \
"https://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions/EXTENSION_ID:execute"
PowerShell
Simpan isi permintaan dalam file bernama request.json,
dan jalankan perintah berikut:
$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://REGION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/REGION/extensions/EXTENSION_ID:execute" | Select-Object -Expand Content