Vertex AI Index Endpoint

Vertex AI Index Endpoint is a managed service in Google Cloud that hosts vector indexes for similarity search and retrieval. It provides a scalable and low-latency endpoint where machine learning models or applications can query embeddings to find the most relevant matches. This resource is commonly used in recommendation systems, semantic search, and generative AI applications, enabling efficient deployment and serving of vector-based search workloads without managing infrastructure.

gcp.aiplatform_index_endpoint

Fields

TitleIDTypeData TypeDescription
_keycorestring
ancestorscorearray<string>
create_timecoretimestampOutput only. Timestamp when this IndexEndpoint was created.
datadog_display_namecorestring
deployed_indexescorejsonOutput only. The indexes deployed in this endpoint.
descriptioncorestringThe description of the IndexEndpoint.
enable_private_service_connectcoreboolOptional. Deprecated: If true, expose the IndexEndpoint via private service connect. Only one of the fields, network or enable_private_service_connect, can be set.
encryption_speccorejsonImmutable. Customer-managed encryption key spec for an IndexEndpoint. If set, this IndexEndpoint and all sub-resources of this IndexEndpoint 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 IndexEndpoint. The name can be up to 128 characters long and can consist of any UTF-8 characters.
labelscorearray<string>The labels with user-defined metadata to organize your IndexEndpoints. 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.
namecorestringOutput only. The resource name of the IndexEndpoint.
networkcorestringOptional. The full name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the IndexEndpoint should be peered. Private services access must already be configured for the network. If left unspecified, the Endpoint is not peered with any network. network and private_service_connect_config are mutually exclusive. [Format](https://cloud.google.com/compute/docs/reference/rest/v1/networks/insert): `projects/{project}/global/networks/{network}`. Where {project} is a project number, as in '12345', and {network} is network name.
organization_idcorestring
parentcorestring
private_service_connect_configcorejsonOptional. Configuration for private service connect. network and private_service_connect_config are mutually exclusive.
project_idcorestring
project_numbercorestring
public_endpoint_domain_namecorestringOutput only. If public_endpoint_enabled is true, this field will be populated with the domain name to use for this index endpoint.
public_endpoint_enabledcoreboolOptional. If true, the deployed index will be accessible through public endpoint.
resource_namecorestring
satisfies_pzicoreboolOutput only. Reserved for future use.
satisfies_pzscoreboolOutput only. Reserved for future use.
tagscorehstore
update_timecoretimestampOutput only. Timestamp when this IndexEndpoint was last updated. This timestamp is not updated when the endpoint's DeployedIndexes are updated, e.g. due to updates of the original Indexes they are the deployments of.