Skip to content

DOCSP-43565: Update Indexes page to clarify Vector Search Indexes use the plural create method #577

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Oct 7, 2024
Merged

DOCSP-43565: Update Indexes page to clarify Vector Search Indexes use the plural create method #577

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
601cb68
Update Indexes page to clarify that vector search indexes require the…
cbullinger Oct 4, 2024
c7605bd
Update source/fundamentals/indexes.txt
cbullinger Oct 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions source/fundamentals/indexes.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -225,7 +225,7 @@ embeddings stored in MongoDB Atlas. To learn more about Atlas Vector Search, see
You can call the following methods on a collection to manage your Atlas
Search and Vector Search indexes:

- ``createSearchIndex()``
- ``createSearchIndex()`` *(valid for Search indexes only)*
- ``createSearchIndexes()``
- ``listSearchIndexes()``
- ``updateSearchIndex()``
Expand All @@ -244,10 +244,10 @@ each of the preceding methods.
Create a Search Index
+++++++++++++++++++++

You can use the `createSearchIndex() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#createSearchIndex(org.bson.conversions.Bson)>`__
and the
`createSearchIndexes() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#createSearchIndexes(java.util.List)>`__
methods to create Atlas Search and Vector Search indexes.
You can use the `createSearchIndex()
<{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#createSearchIndex(org.bson.conversions.Bson)>`__
method to create an Atlas Search index. You *cannot* use this method to create a
Vector Search index at this time.

The following code example shows how to create an Atlas Search index:

Expand All @@ -257,7 +257,10 @@ The following code example shows how to create an Atlas Search index:
:start-after: start create-search-index
:end-before: end create-search-index

To create multiple Search or Vector Search indexes, you must create a
You can use the
`createSearchIndexes() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#createSearchIndexes(java.util.List)>`__
method to create multiple Atlas Search indexes or one or more Vector Search
indexes. You must create and pass a
`SearchIndexModel
<{+api+}/apidocs/mongodb-driver-core/com/mongodb/client/model/SearchIndexModel.html>`__
instance for each index.
Expand Down Expand Up @@ -606,4 +609,5 @@ For prior versions of MongoDB, pass "*" as a parameter to your call to
For more information about the methods in this section, see the following API Documentation:

- `dropIndex() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#dropIndex(java.lang.String)>`__
- `dropIndexes() <{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#dropIndexes()>`__
- `dropIndexes()
<{+api+}/apidocs/mongodb-driver-sync/com/mongodb/client/MongoCollection.html#dropIndexes()>`__
Loading