Method: projects.locations.collections.dataObjects.batchSearch

Melakukan penelusuran batch pada objek data.

Permintaan HTTP

POST https://vectorsearch.googleapis.com/v1beta/{parent}/dataObjects:batchSearch

Parameter jalur

Parameter
parent

string

Wajib. Nama resource Koleksi yang akan ditelusuri. Format: projects/{project}/locations/{location}/collections/{collection}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "searches": [
    {
      object (Search)
    }
  ],
  "combine": {
    object (CombineResultsOptions)
  }
}
Kolom
searches[]

object (Search)

Wajib. Daftar permintaan penelusuran yang akan dieksekusi secara paralel.
combine

object (CombineResultsOptions)

Opsional. Opsi untuk menggabungkan hasil operasi penelusuran batch.

Isi respons

Respons dari operasi penelusuran batch.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "results": [
    {
      object (SearchDataObjectsResponse)
    }
  ]
}
Kolom
results[]

object (SearchDataObjectsResponse)

Hanya output. Daftar respons penelusuran, satu untuk setiap permintaan dalam batch. Jika perankingan digunakan, satu daftar hasil yang diberi peringkat akan ditampilkan.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource parent:

  • vectorsearch.dataObjects.search

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

CombineResultsOptions

Opsi untuk menggabungkan hasil operasi penelusuran batch.

Representasi JSON 
{
  "ranker": {
    object (Ranker)
  },
  "outputFields": {
    object (OutputFields)
  },
  "topK": integer
}
Kolom
ranker

object (Ranker)

Wajib. Peringkat yang akan digunakan untuk menggabungkan hasil.
outputFields

object (OutputFields)

Opsional. Mask yang menentukan kolom yang akan ditampilkan.
topK

integer

Opsional. Jumlah hasil yang akan ditampilkan. Jika tidak disetel, nilai default akan digunakan.

Peringkat

Menentukan perankingan untuk menggabungkan hasil dari beberapa penelusuran.

Representasi JSON 
{

  // Union field ranker can be only one of the following:
  "rrf": {
    object (ReciprocalRankFusion)
  }
  // End of list of possible types for union field ranker.

  // Union field reranker can be only one of the following:
  "vertexRanker": {
    object (VertexRanker)
  }
  // End of list of possible types for union field reranker.
}
Kolom
Kolom union ranker. Metode penentuan peringkat yang akan digunakan. ranker hanya ada berupa salah satu diantara berikut:
rrf

object (ReciprocalRankFusion)

Peringkat Reciprocal Rank Fusion.
Kolom union reranker. Pengubah peringkat yang akan digunakan untuk peringkat akhir hasil yang digabungkan oleh pengubah peringkat. reranker hanya ada berupa salah satu diantara berikut:
vertexRanker

object (VertexRanker)

Opsional. Peringkatan Vertex AI.

ReciprocalRankFusion

Menentukan algoritma Reciprocal Rank Fusion (RRF) untuk pemeringkatan hasil.

Representasi JSON 
{
  "weights": [
    number
  ]
}
Kolom
weights[]

number

Wajib. Bobot yang akan diterapkan ke setiap kumpulan hasil penelusuran selama penggabungan.

VertexRanker

Menentukan perankingan menggunakan layanan ranking Vertex AI. Lihat https://cloud.google.com/generative-ai-app-builder/docs/ranking untuk mengetahui detailnya.

Representasi JSON 
{
  "model": string,
  "topN": integer,

  // Union field record_spec can be only one of the following:
  "textRecordSpec": {
    object (TextRecordSpec)
  }
  // End of list of possible types for union field record_spec.
}
Kolom
model

string

Wajib. Model yang digunakan untuk memberi peringkat dokumen. Daftar model yang tersedia dijelaskan di https://docs.cloud.google.com/generative-ai-app-builder/docs/ranking#models. Saat ini, hanya semantic-ranker-fast@latest yang didukung.
topN

integer

Wajib. Jumlah dokumen yang akan diproses untuk pemberian peringkat.
Kolom union record_spec. Spesifikasi data untuk pemberian peringkat. Setidaknya satu spesifikasi rekaman harus ditetapkan. record_spec hanya ada berupa salah satu diantara berikut:
textRecordSpec

object (TextRecordSpec)

Spesifikasi rekaman untuk penelusuran teks.

TextRecordSpec

Spesifikasi rekaman untuk penelusuran teks.

Representasi JSON 
{
  "query": string,
  "titleTemplate": string,
  "contentTemplate": string
}
Kolom
query

string

Wajib. Kueri yang digunakan untuk memberi peringkat dan skor pada rekaman.
titleTemplate

string

Opsional. Template yang digunakan untuk membuat judul rekaman.
contentTemplate

string

Opsional. Template yang digunakan untuk membuat konten rekaman.