Ekstensi Vertex AI Search

Pratinjau

Ekstensi Vertex AI adalah penawaran Pratinjau, yang tunduk pada "Persyaratan Penawaran Pra-GA" dari Persyaratan Khusus Layanan Google Cloud. Produk dan fitur pra-GA mungkin memiliki dukungan terbatas, dan perubahan pada produk serta fitur pra-GA mungkin tidak kompatibel dengan versi pra-GA lainnya. Untuk mengetahui informasi selengkapnya, lihat deskripsi tahap peluncuran. Selain itu, dengan menggunakan Ekstensi Vertex AI, Anda menyetujui persyaratan dan ketentuan Pratinjau AI Generatif ("Persyaratan Pratinjau").

Dokumen ini menunjukkan cara mendaftar dan menggunakan ekstensi Vertex AI Search 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 dalam bahasa alami, seperti:

• "Bagaimana ancaman kompetitif bagi perusahaan berubah dari K1 tahun lalu ke K1 tahun ini?"
• "Bagian mana dari perusahaan yang berkembang paling cepat? Seberapa cepat?"

Ekstensi Vertex AI Search menggunakan Vertex AI Search untuk mengambil hasil yang bermakna dari penyimpanan data Anda. Ekstensi Vertex AI Search ditentukan dalam file vertex_ai_search.yaml Spesifikasi OpenAPI.

Untuk menggunakan ekstensi Vertex AI Search, 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 informasi selengkapnya.

Luaskan Ciutkan

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 Jupyter notebook berikut:

• Alur kerja analis bisnis dengan Ekstensi Vertex AI: Gunakan ekstensi Code Interpreter dan ekstensi Vertex AI Search untuk menyelesaikan laporan riset peluang investasi perumahan 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 Vertex AI Search 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

1. 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.

2. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

3. Make sure that billing is enabled for your Google Cloud project.

4. Aktifkan API Vertex AI.

   Mengaktifkan API

5. Di konsol Google Cloud, pada halaman pemilih project, pilih atau buat project Google Cloud.

   Catatan: Jika tidak berencana untuk menyimpan resource yang Anda buat dalam prosedur ini, buatlah project, bukan memilih project yang ada. Setelah menyelesaikan langkah ini, Anda dapat menghapus project, yang menghapus semua resource yang terkait dengan project ini.

   Buka pemilih project

6. Make sure that billing is enabled for your Google Cloud project.

7. Aktifkan API Vertex AI.

   Mengaktifkan API

Mendaftarkan dan menjalankan ekstensi Vertex AI Search

Bagian berikut menunjukkan cara mendaftarkan ekstensi Vertex AI Search menggunakan Konsol Google Cloud dan Vertex AI API. Setelah mendaftarkan ekstensi, Anda dapat menjalankannya menggunakan Vertex AI API.

Konsol

Mendaftarkan ekstensi

Lakukan langkah-langkah berikut untuk mendaftarkan ekstensi Vertex AI Search menggunakan konsol Google Cloud.

1. Di konsol Google Cloud, buka halaman Extensions Vertex AI.

   Buka Vertex AI Extensions

2. Klik Buat Ekstensi.

3. 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.

4. Di bagian OpenAPI Spec file yang sekarang 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.

5. Di bagian Runtime configurations, 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.

6. Klik Buat Ekstensi.

REST

Mendaftarkan ekstensi

Kirim permintaan extensions.import Vertex AI API untuk mendaftarkan ekstensi Vertex AI Search.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: ID project Google Cloud 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 contoh isi permintaan. 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.getAccessToken ke akun layanan Vertex AI Extension Service Agent di akun layanan yang ditentukan.
• SERVING_CONFIG_NAME: Nama konfigurasi penayangan ditentukan dalam vertexAiSearchRuntimeConfig. Format dan penyelesaiannya sebagai berikut: projects/PROJECT_ID/locations/global/collections/COLLECTION_NAME/engines/ENGINE/servingConfigs/SERVING_CONFIG.
  • PROJECT_ID: ID project Google Cloud 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

Isi JSON permintaan:

{
  "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

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login , atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

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

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

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 project Google Cloud 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

Isi JSON permintaan:

{
  "operation_id":"search",
  "operation_params":{
    "query":"Housing affordability since 2010",
  }
}

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login , atau dengan menggunakan Cloud Shell, yang secara otomatis membuat Anda login ke gcloud CLI . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

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

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI dengan akun pengguna Anda dengan menjalankan gcloud init atau gcloud auth login . Anda dapat memeriksa akun yang saat ini aktif dengan menjalankan gcloud auth list.

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