REST Resource: projects.locations.collections.indexes

Resource: Index

Pesan yang menjelaskan objek Indeks

Representasi JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "distanceMetric": enum (DistanceMetric),
  "indexField": string,
  "filterFields": [
    string
  ],
  "storeFields": [
    string
  ],

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

  // Union field index_type can be only one of the following:
  "denseScann": {
    object (DenseScannIndex)
  }
  // End of list of possible types for union field index_type.
}
Kolom
name

string

ID. nama resource
displayName

string

Opsional. Nama tampilan indeks yang ditentukan pengguna
description

string

Opsional. Deskripsi indeks yang ditentukan pengguna
labels

map (key: string, value: string)

Opsional. Label sebagai pasangan nilai kunci.

Objek yang berisi daftar "key": value pasangan. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Hanya output. [Khusus output] Stempel waktu pembuatan

Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Hanya output. [Khusus output] Stempel waktu pembaruan

Menggunakan RFC 3339 yang outputnya akan selalu dikonversi ke format Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
distanceMetric

enum (DistanceMetric)

Opsional. Metrik jarak yang digunakan untuk pengindeksan. Jika tidak ditentukan, nilai defaultnya adalah DOT_PRODUCT.
indexField

string

Wajib diisi. Kolom skema koleksi yang akan diindeks.
filterFields[]

string

Opsional. Kolom yang akan didorong ke indeks untuk mengaktifkan pemfilteran inline ANN cepat.
storeFields[]

string

Opsional. Kolom yang akan didorong ke indeks untuk mengaktifkan pengambilan data inline.
Kolom union infra_type. Jenis infrastruktur indeks. infra_type hanya dapat berupa salah satu dari berikut:
dedicatedInfrastructure

object (DedicatedInfrastructure)

Opsional. Infrastruktur khusus untuk indeks.
Kolom union index_type. Jenis indeks. index_type hanya dapat berupa salah satu dari berikut:
denseScann

object (DenseScannIndex)

Opsional. Indeks ScaNN padat.

DedicatedInfrastructure

Menampilkan infrastruktur khusus untuk indeks.

Representasi JSON 
{
  "autoscalingSpec": {
    object (AutoscalingSpec)
  },
  "mode": enum (Mode)
}
Kolom
autoscalingSpec

object (AutoscalingSpec)

Opsional. Spesifikasi penskalaan otomatis.
mode

enum (Mode)

Opsional. Mode infrastruktur khusus.

Mode

Mode infrastruktur khusus.

Enum
MODE_UNSPECIFIED Default akan menggunakan PERFORMANCE_OPTIMIZED.
STORAGE_OPTIMIZED Ini adalah variasi yang dioptimalkan untuk penyimpanan.
PERFORMANCE_OPTIMIZED Ini adalah performa yang dioptimalkan pada E2 atau keluarga yang setara.

AutoscalingSpec

Spesifikasi untuk penskalaan otomatis.

Representasi JSON 
{
  "minReplicaCount": integer,
  "maxReplicaCount": integer
}
Kolom
minReplicaCount

integer

Opsional. Jumlah minimum replika. Jika tidak ditetapkan atau ditetapkan ke 0, nilai defaultnya adalah 2. Harus >= 1 dan <= 1000.
maxReplicaCount

integer

Opsional. Jumlah maksimum replika. Harus >= minReplicaCount dan <= 1000. Untuk versi v1beta, jika tidak ditetapkan atau ditetapkan ke 0, nilai defaultnya adalah nilai yang lebih besar antara minReplicaCount dan 5. Untuk semua versi lainnya, jika tidak ditetapkan atau ditetapkan ke 0, nilai defaultnya adalah nilai yang lebih besar antara minReplicaCount dan 2.

DenseScannIndex

Konfigurasi indeks ScaNN padat.

Representasi JSON 
{
  "featureNormType": enum (FeatureNormType)
}
Kolom
featureNormType

enum (FeatureNormType)

Opsional. Jenis norma fitur.

FeatureNormType

Jenis norma fitur untuk indeks ScaNN.

Enum
FEATURE_NORM_TYPE_UNSPECIFIED Jenis norma fitur belum ditetapkan.
NONE Tidak ada norma yang diterapkan.
UNIT_L2_NORM Norma unit L2.

DistanceMetric

Metrik jarak untuk penelusuran vektor.

Enum
DISTANCE_METRIC_UNSPECIFIED Nilai default, metrik jarak tidak ditentukan.
DOT_PRODUCT Metrik jarak produk titik.
COSINE_DISTANCE Metrik jarak kosinus.

Metode

create

 Membuat Indeks baru di project dan lokasi tertentu.

delete

 Menghapus satu Indeks.

get

 Mendapatkan detail satu Indeks.

list

 Mencantumkan Indeks di project dan lokasi tertentu.

patch

 Memperbarui parameter satu Indeks.