Class Index (1.31.1)

  Index 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

A representation of a collection of database items organized in a way that allows for approximate nearest neighbor (a.k.a ANN) algorithms search.

Attributes

Name

Description

name

str
Output only. The resource name of the Index.

display_name

str
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

str
The description of the Index.

metadata_schema_uri

str
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

metadata

google.protobuf.struct_pb2.Value
An additional information about the Index; the schema of the metadata can be found in metadata_schema .

deployed_indexes

MutableSequence[ google.cloud.aiplatform_v1beta1.types.DeployedIndexRef 
]

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

str
Used to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.

labels

MutableMapping[str, str]
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.

create_time

google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp when this Index was created.

update_time

google.protobuf.timestamp_pb2.Timestamp
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 [Operations.metadata.generic_metadata.update_time] [google.cloud.aiplatform.v1beta1.GenericOperationMetadata.update_time] a little after the value of this timestamp, yet that does not mean their results are not already reflected in the Index. Result of any successfully completed Operation on the Index is reflected in it.

index_stats

 google.cloud.aiplatform_v1beta1.types.IndexStats

Output only. Stats of the index resource.

index_update_method

 google.cloud.aiplatform_v1beta1.types.Index.IndexUpdateMethod

Immutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.

Classes

IndexUpdateMethod

  IndexUpdateMethod 
 ( 
 value 
 )

The update method of an Index.

Values: INDEX_UPDATE_METHOD_UNSPECIFIED (0): Should not be used. BATCH_UPDATE (1): BatchUpdate: user can call UpdateIndex with files on Cloud Storage of datapoints to update. STREAM_UPDATE (2): StreamUpdate: user can call UpsertDatapoints/DeleteDatapoints to update the Index and the updates will be applied in corresponding DeployedIndexes in nearly real-time.

LabelsEntry

  LabelsEntry 
 ( 
 mapping 
 = 
 None 
 , 
 * 
 , 
 ignore_unknown_fields 
 = 
 False 
 , 
 ** 
 kwargs 
 )

The abstract base class for a message.

Parameters

Name

Description

kwargs

dict

Keys and values corresponding to the fields of the message.

mapping

Union[dict, .Message 
]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields

Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.