Method: projects.locations.collections.dataObjects.query

Membuat kueri objek data.

Permintaan HTTP

POST https://vectorsearch.googleapis.com/v1/{parent}/dataObjects:query

Parameter jalur

Parameter
parent

string

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

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "filter": {
    object
  },
  "outputFields": {
    object (OutputFields)
  },
  "pageSize": integer,
  "pageToken": string
}
Kolom
filter

object (Struct format)

Opsional. Ekspresi filter JSON, misalnya {"genre": {"$eq": "sci-fi"}}, yang ditampilkan sebagai google.protobuf.Struct.
outputFields

object (OutputFields)

Opsional. Masker yang menentukan kolom yang akan ditampilkan.
pageSize

integer

Opsional. Ukuran halaman daftar standar.
pageToken

string

Opsional. Token halaman daftar standar. Biasanya diperoleh melalui QueryDataObjectsResponse.next_page_token dari panggilan DataObjectSearchService.QueryDataObjects sebelumnya.

Isi respons

Pesan respons untuk DataObjectSearchService.QueryDataObjects.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "dataObjects": [
    {
      object (DataObject)
    }
  ],
  "nextPageToken": string
}
Kolom
dataObjects[]

object (DataObject)

Daftar dataObject yang cocok dengan kueri.
nextPageToken

string

Token untuk mengambil halaman hasil berikutnya. Teruskan ke [DataObjectSearchService.QueryDataObjectsRequest.page_token][] untuk mendapatkan halaman tersebut.

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

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.