Vertex AI Index

Vertex AI Index in Google Cloud is a managed resource that stores and organizes vector embeddings for efficient similarity search and retrieval. It is commonly used in machine learning and AI applications to power semantic search, recommendation systems, and generative AI use cases. The index enables fast querying across large datasets by leveraging approximate nearest neighbor search, making it easier to integrate advanced search and retrieval capabilities into applications without managing complex infrastructure.

gcp.aiplatform_index

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. Timestamp when this Index was created.
datadog_display_namecorestring
deployed_indexescorejsonOutput only. The pointers to DeployedIndexes created from this Index. An Index can be only deleted if all its DeployedIndexes had been undeployed first.
descriptioncorestringThe description of the Index.
encryption_speccorejsonImmutable. 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.
etagcorestringUsed to perform consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
gcp_display_namecorestringRequired. The display name of the Index. The name can be up to 128 characters long and can consist of any UTF-8 characters.
index_statscorejsonOutput only. Stats of the index resource.
index_update_methodcorestringImmutable. The update method to use with this Index. If not set, BATCH_UPDATE will be used by default.
labelscorearray<string>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.
metadata_schema_uricorestringImmutable. 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](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject). 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.
namecorestringOutput only. The resource name of the Index.
organization_idcorestring
parentcorestring
project_idcorestring
project_numbercorestring
resource_namecorestring
satisfies_pzicoreboolOutput only. Reserved for future use.
satisfies_pzscoreboolOutput only. Reserved for future use.
tagscorehstore
update_timecoretimestampOutput 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 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.