REST Resource: projects.locations.collections.indexes

Resource: Index

Message describing Index object

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

string

Identifier. name of resource
displayName

string

Optional. User-specified display name of the index
description

string

Optional. User-specified description of the index
labels

map (key: string, value: string)

Optional. Labels as key value pairs.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Output only. [Output only] Create time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. [Output only] Update time stamp

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
distanceMetric

enum (DistanceMetric)

Optional. Distance metric used for indexing. If not specified, will default to DOT_PRODUCT.
indexField

string

Required. The collection schema field to index.
filterFields[]

string

Optional. The fields to push into the index to enable fast ANN inline filtering.
storeFields[]

string

Optional. The fields to push into the index to enable inline data retrieval.

DistanceMetric

Distance metric for vector search.

Enums
DISTANCE_METRIC_UNSPECIFIED Default value, distance metric is not specified.
DOT_PRODUCT Dot product distance metric.
COSINE_DISTANCE Cosine distance metric.

Methods

create

 Creates a new Index in a given project and location.

delete

 Deletes a single Index.

get

 Gets details of a single Index.

list

 Lists Indexes in a given project and location.