Resource: Index
A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.
JSON representation |
---|
{ "name": string, "displayName": string, "description": string, "metadataSchemaUri": string, "metadata": value, "deployedIndexes": [ { object ( |
Fields | |
---|---|
name |
Output only. The resource name of the Index. |
displayName |
Required. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters. |
description |
The description of the Index. |
metadataSchemaUri |
Immutable. Points to a YAML file stored on Google Cloud Storage describing additional information about the Index, that is specific to it. Unset if the Index does not have any additional information. The schema is defined as an OpenAPI 3.0.2 Schema Object. Note: The URI given on output will be immutable and probably different, including the URI scheme, than the one given on input. The output URI will point to a location where the user only has a read access. |
metadata |
An additional information about the Index; the schema of the metadata can be found in |
deployedIndexes[] |
Output only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first. |
etag |
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens. |
labels |
The labels with user-defined metadata to organize your Indexes. label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. |
createTime |
Output only. timestamp when this Index was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
updateTime |
Output only. timestamp when this Index was most recently updated. This also includes any update to the contents of the Index. Note that Operations working on this Index may have their A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
indexStats |
Output only. Stats of the index resource. |
indexUpdateMethod |
Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default. |
encryptionSpec |
Immutable. Customer-managed encryption key spec for an Index. If set, this Index and all sub-resources of this Index will be secured by this key. |
DeployedIndexRef
Points to a DeployedIndex.
JSON representation |
---|
{ "indexEndpoint": string, "deployedIndexId": string, "displayName": string } |
Fields | |
---|---|
indexEndpoint |
Immutable. A resource name of the IndexEndpoint. |
deployedIndexId |
Immutable. The ID of the DeployedIndex in the above IndexEndpoint. |
displayName |
Output only. The display name of the DeployedIndex. |
IndexStats
Stats of the Index.
JSON representation |
---|
{ "vectorsCount": string, "shardsCount": integer } |
Fields | |
---|---|
vectorsCount |
Output only. The number of dense vectors in the Index. |
shardsCount |
Output only. The number of shards in the Index. |
IndexUpdateMethod
The update method of an Index.
Enums | |
---|---|
INDEX_UPDATE_METHOD_UNSPECIFIED |
Should not be used. |
BATCH_UPDATE |
BatchUpdate: user can call indexes.patch with files on Cloud Storage of Datapoints to update. |
STREAM_UPDATE |
StreamUpdate: user can call indexes.upsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time. |
Methods |
|
---|---|
|
Creates an Index. |
|
Deletes an Index. |
|
Gets an Index. |
|
Lists Indexes in a Location. |
|
Updates an Index. |
|
Remove Datapoints from an Index. |
|
Add/update Datapoints into an Index. |