View an Atlas Vector Search Index
On this page
Atlas Search index is a data structure that categorizes data in an easily searchable format. It is a mapping between terms and the documents that contain those terms. Atlas Search indexes enable faster retrieval of documents using certain identifiers. You must configure an Atlas Search index to query data in your Atlas cluster using Atlas Search.
You can create an Atlas Search index on a single field or on multiple fields. We recommend that you index the fields that you regularly use to sort or filter your data in order to quickly retrieve the documents that contain the relevant data at query-time.
You can view Atlas Vector Search indexes for all collections from the Atlas UI and Atlas Administration API.
Required Access
You need the Project Search Index Editor or higher role to view
Atlas Vector Search indexes.
Supported Clients
You can view an Atlas Vector Search index using the following:
Atlas UI
Atlas Administration API Return One Atlas Search Index endpoint
Atlas CLI v1.14.3 atlas clusters search indexes list command on both the cloud deployment and local deployment
mongoshv2.1.2 or laterdb.collection.getSearchIndexes()method