Membuat atau menggunakan kembali instance Example Store

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.

Halaman ini menunjukkan cara membuat instance Example Store baru atau menggunakan kembali instance Example Store yang ada. Anda dapat menyimpan contoh di Example Store saat mengembangkan aplikasi LLM dan mengambilnya secara dinamis untuk digunakan dalam perintah LLM.

Untuk mengajari LLM atau agen menggunakan contoh beberapa kali, Anda harus membuat atau menggunakan kembali instance Example Store untuk project dan lokasi Anda terlebih dahulu, lalu mengupload contoh ke instance tersebut.

Untuk setiap project dan lokasi, Anda dapat memiliki maksimal 50 instance Example Store. Setelah membuat instance Example Store, Anda dapat membagikannya di beberapa aplikasi dan agen LLM.

Ada dua cara untuk menyediakan instance Example Store:

• Membuat instance Example Store baru: Saat membuat instance Example Store baru, Anda harus menentukan model embedding, yang digunakan Example Store untuk menentukan contoh mana yang relevan dengan kueri pengguna. Example Store mendukung model embedding berikut:

  • text-embedding-005

  • text-multilingual-embedding-002

  Anda tidak dapat mengubah model embedding setelah membuat instance Example Store. Jika ingin menggunakan model embedding yang berbeda, Anda harus membuat example store lain. Untuk mengetahui informasi selengkapnya tentang embedding teks, lihat Mendapatkan embedding teks.

• Menggunakan kembali instance Example Store yang ada: Instance Example Store dirancang untuk digunakan oleh beberapa agen, sehingga Anda dapat mengakses contoh yang disimpan di seluruh aplikasi LLM. Anda tidak dapat mengubah model embedding saat menggunakan kembali instance Example Store yang ada.

Prasyarat

Sebelum menggunakan contoh Python di halaman ini, instal dan inisialisasi Agent Platform SDK di lingkungan Python lokal Anda.

1. Jalankan perintah berikut untuk menginstal Agent Platform SDK untuk Example Store.

   pip install --upgrade google-cloud-aiplatform>=1.87.0

2. Gunakan contoh kode berikut untuk mengimpor dan menginisialisasi SDK untuk Example Store.

   import vertexai
   from vertexai.preview import example_stores
   
   vertexai.init(
     project="PROJECT_ID",
     location="LOCATION"
   )
   

   Ganti kode berikut:

   • PROJECT_ID: Project ID Anda.

   • LOCATION: Region Anda. Hanya us-central1 yang didukung.

Membuat instance Example Store

Gunakan contoh berikut untuk membuat instance Example Store untuk project dan lokasi yang ditentukan. Perhatikan bahwa pembuatan instance Example Store memerlukan waktu beberapa menit.

Python

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.

Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.

import vertexai
from vertexai.preview import example_stores

vertexai.init(
    project="PROJECT_ID",
    location="LOCATION"
)

my_example_store = example_stores.ExampleStore.create(
    example_store_config=example_stores.ExampleStoreConfig(
        vertex_embedding_model="EMBEDDING_MODEL"
    )
)

Ganti kode berikut:

• PROJECT_ID: Project ID Anda.
• LOCATION: Region tempat Anda ingin membuat example store. Satu-satunya region yang didukung adalah us-central1.
• EMBEDDING_MODEL: Model embedding yang digunakan instance Example Store untuk menentukan contoh mana yang relevan dengan kueri pengguna. Example Store mendukung model embedding berikut:
  • text-embedding-005
  • text-multilingual-embedding-002

REST

Untuk membuat ExampleStore resource, kirim permintaan POST menggunakan exampleStores.create metode.

Sebelum menggunakan salah satu data permintaan, lakukan penggantian berikut:

• PROJECT_ID: Project ID Anda.
• LOCATION: Region tempat Anda ingin membuat instance Example Store. Satu-satunya region yang didukung adalah us-central1.
• DISPLAY_NAME: Nama instance Example Store.
• EMBEDDING_MODEL: Model embedding yang digunakan instance Example Store untuk menentukan contoh mana yang relevan dengan kueri pengguna. Example Store mendukung model embedding berikut:
  • textembedding-gecko@003
  • text-embedding-004
  • text-multilingual-embedding-002

Metode HTTP dan URL:

POST https://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/exampleStores

Meminta isi JSON:

{
  "display_name": "DISPLAY_NAME",
  "example_store_config": {"vertex_embedding_model": EMBEDDING_MODEL}
}

Untuk mengirim permintaan Anda, pilih salah satu opsi berikut:

curl

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan 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://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/exampleStores"

PowerShell

Catatan: Perintah berikut mengasumsikan bahwa Anda telah login ke gcloud CLI menggunakan 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://LOCATION-aiplatform.googleapis.com/v1beta1/projects/PROJECT_ID/locations/LOCATION/exampleStores" | Select-Object -Expand Content

Anda akan menerima respons JSON yang mirip dengan berikut ini, dengan EXAMPLE_STORE_ID mewakili ID instance Example Store.

Respons

{
  "name": "projects/PROJECT_ID/locations/LOCATION/exampleStores/EXAMPLE_STORE_ID/operations/",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.aiplatform.v1beta1.CreateExampleStoreOperationMetadata",
    "genericMetadata": {
      "createTime": "2024-10-10T02:06:10.417111Z",
      "updateTime": "2024-10-10T02:06:10.417111Z"
    }
  }
}

Menggunakan kembali instance Example Store yang ada

Gunakan contoh berikut untuk menggunakan kembali instance Example Store yang ada untuk project dan lokasi yang ditentukan.

Python

Sebelum mencoba contoh ini, ikuti petunjuk penyiapan Python di Panduan memulai Agent Platform menggunakan library klien.

Untuk melakukan autentikasi ke Agent Platform, siapkan Kredensial Default Aplikasi. Untuk mengetahui informasi selengkapnya, lihat Menyiapkan autentikasi untuk lingkungan pengembangan lokal.

import vertexai
from vertexai.preview import example_stores

vertexai.init(
    project="PROJECT_ID",
    location="LOCATION"
)

example_store = example_stores.ExampleStore(
    "EXAMPLE_STORE_NAME")

Ganti kode berikut:

• PROJECT_ID: Project ID Anda.
• LOCATION: Region tempat Anda ingin membuat example store. Satu-satunya region yang didukung adalah us-central1.
• EXAMPLE_STORE_NAME: Nama instance Example Store yang ingin Anda gunakan kembali.

Langkah berikutnya

• Mengupload contoh ke instance Example Store.