REST Resource: projects.locations.corpora.indexes

Resource: Indeks

Indeks adalah resource di Korpus. File ini berisi versi aset dan anotasi yang diindeks. Saat di-deploy ke endpoint, pengguna akan dapat menelusuri Indeks.

Representasi JSON
{
  "name": string,
  "displayName": string,
  "description": string,
  "state": enum (State),
  "createTime": string,
  "updateTime": string,
  "deployedIndexes": [
    {
      object (DeployedIndexReference)
    }
  ],

  // Union field asset_filter can be only one of the following:
  "entireCorpus": boolean
  // End of list of possible types for union field asset_filter.
}
Kolom
name

string

Hanya output. Nama resource resource Indeks. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

displayName

string

Opsional. Nama tampilan indeks opsional yang ditentukan pengguna.

description

string

Opsional. Deskripsi opsional untuk indeks.

state

enum (State)

Hanya output. Status indeks.

createTime

string (Timestamp format)

Hanya output. Stempel waktu pembuatan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

updateTime

string (Timestamp format)

Hanya output. Stempel waktu update.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".

deployedIndexes[]

object (DeployedIndexReference)

Hanya output. Referensi ke instance indeks yang di-deploy. Indeks korpus VIDEO_ON_DEMAND dapat memiliki maksimal satu indeks yang di-deploy. Indeks korpus IMAGE dapat memiliki beberapa indeks yang di-deploy.

Kolom union asset_filter. Menentukan cara aset dipilih untuk indeks ini. Jika tidak ditentukan, setelan defaultnya adalah entire_corpus. Perilaku di UpdateIndex: jika update_mask menyertakan salah satu jalur kolom asset_filter, indeks akan dibuat ulang dengan aset terbaru, termasuk data dan anotasi yang dianalisis. asset_filter hanya ada berupa salah satu diantara berikut:
entireCorpus

boolean

Sertakan semua aset dalam korpus.

Negara bagian/Provinsi

Enum yang mewakili berbagai status yang dapat dilalui Index selama masa aktifnya.

Enum
STATE_UNSPECIFIED Nilai default. Tidak boleh digunakan.
CREATING Status MEMBUAT.
CREATED Status CREATED.
UPDATING Status UPDATING.

DeployedIndexReference

Menunjuk ke DeployedIndex.

Representasi JSON
{
  "indexEndpoint": string
}
Kolom
indexEndpoint

string

Tidak dapat diubah. Nama resource IndexEndpoint.

Metode

create

Membuat Indeks di bagian korpus.

delete

Menghapus satu Indeks.

get

Mendapatkan detail satu Indeks di bagian Korpus.

list

Mencantumkan semua Indeks dalam Korpus tertentu.

patch

Memperbarui Indeks di bagian korpus.

viewAssets

Mencantumkan aset di dalam indeks.