Google Vertex Vector Search icon

Google Vertex Vector Search

Interact with Google Vertex AI Vector Search

Actions9

Index → Get

AI-generated

Summary

Retrieve details about a specific Vector Search index in Google Vertex AI by providing its ID and the resource location.

Inputs

  • Location (required) — The Google Cloud location where the Vector Search index is hosted (e.g., 'us-central1').
  • Index ID (required) — The unique identifier of the index to retrieve.

Output shape

a JSON object representing the requested index's details

The output contains comprehensive metadata of the specified index as returned by the Google Vertex AI IndexServiceClient's getIndex method. Errors for invalid index IDs are handled and reported per execution item.

Examples

Example 1: Retrieve an index named 'my-index' located in 'us-central1' to examine its configuration and metadata.

Set Location to 'us-central1' and Index ID to the target index's ID. Use the 'Get' operation under the 'Index' resource.

Discussion