Method: projects.locations.indexEndpoints.searchIndexEndpoint

Menelusuri endpoint indeks yang di-deploy (khusus jenis korpus IMAGE).

Permintaan HTTP

POST https://visionai.googleapis.com/v1/{indexEndpoint=projects/*/locations/*/indexEndpoints/*}:searchIndexEndpoint

URL menggunakan sintaks gRPC Transcoding.

Parameter jalur

Parameter
indexEndpoint

string

Wajib. Endpoint indeks yang akan ditelusuri. Format: `projects/{projectId}/locations/{locationId}/indexEndpoints/{indexEndpointId}'

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "criteria": [
    {
      object (Criteria)
    }
  ],
  "exclusionCriteria": [
    {
      object (Criteria)
    }
  ],
  "pageSize": integer,
  "pageToken": string,

  // Union field query can be only one of the following:
  "imageQuery": {
    object (ImageQuery)
  },
  "textQuery": string
  // End of list of possible types for union field query.
}
Kolom
criteria[]

object (Criteria)

Kriteria yang diterapkan ke hasil penelusuran.
exclusionCriteria[]

object (Criteria)

Kriteria yang akan dikecualikan dari hasil penelusuran. Perhatikan bahwa fetchMatchedAnnotations akan diabaikan.
pageSize

integer

Ukuran halaman yang diminta. API mungkin menampilkan lebih sedikit hasil daripada yang diminta. Jika negatif, error INVALID_ARGUMENT akan ditampilkan. Jika tidak ditentukan atau 0, API akan memilih ukuran default, yaitu 10. Jika ukuran halaman yang diminta lebih besar dari ukuran maksimum, API akan memilih ukuran maksimum, yaitu 100.
pageToken

string

Token lanjutan untuk mengambil halaman berikutnya. Jika kosong, berarti halaman pertama sedang diambil.
Kolom union query. Kueri penelusuran global oneof. query hanya ada berupa salah satu diantara berikut:
imageQuery

object (ImageQuery)

Kueri khusus gambar.
textQuery

string

Kueri hanya teks.

Isi respons

Pesan respons untuk indexEndpoints.searchIndexEndpoint.

Jika berhasil, isi respons memuat data dengan struktur berikut:

Representasi JSON 
{
  "searchResultItems": [
    {
      object (SearchResultItem)
    }
  ],
  "nextPageToken": string
}
Kolom
searchResultItems[]

object (SearchResultItem)

Menampilkan hasil penelusuran.
nextPageToken

string

Token lanjutan halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.

Cakupan otorisasi

Memerlukan cakupan OAuth berikut:

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

Untuk mengetahui informasi selengkapnya, lihat Ringkasan Autentikasi.

Izin IAM

Memerlukan izin IAM berikut pada resource indexEndpoint:

  • visionai.indexEndpoints.search

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

ImageQuery

Kueri gambar untuk permintaan endpoint penelusuran.

Representasi JSON 
{

  // Union field image can be only one of the following:
  "inputImage": string,
  "asset": string
  // End of list of possible types for union field image.
}
Kolom

Kolom union image.

image hanya dapat berupa salah satu dari hal berikut:
inputImage

string (bytes format)

Masukkan gambar dalam byte mentah.

String berenkode base64.
asset

string

Nama resource aset. Hanya didukung dalam jenis korpus IMAGE. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}