DOCSP-49759: Vector search index #33

norareidy · 2025-05-21T15:22:16Z

Pull Request Info

PR Reviewing Guidelines

JIRA - https://jira.mongodb.org/browse/DOCSP-49759

Staging Links

model-data/indexes

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2025-05-21T15:22:20Z

✅ Deploy Preview for docs-django ready!

Name	Link
🔨 Latest commit	`3b9bb4c`
🔍 Latest deploy log	https://app.netlify.com/projects/docs-django/deploys/682f8e38f5a1f7000808cee7
😎 Deploy Preview	https://deploy-preview-33--docs-django.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

lindseymoore

LGTM! I would be consistent about using the full Atlas Vector Search product name, as I've been told by a PM that there is sometimes naming confusion from customers.

lindseymoore · 2025-05-21T17:59:41Z

source/model-data/indexes.txt


+.. _django-indexes-vector-search:
+
+Vector Search Indexes


Suggested change

Vector Search Indexes

Atlas Vector Search Indexes

S: I've gotten guidance from PMs to include the full product name. Also, to be consistent with the above Atlas Search section.

lindseymoore · 2025-05-21T18:00:27Z

source/model-data/indexes.txt

+Vector Search Indexes
+~~~~~~~~~~~~~~~~~~~~~
+
+Vector Search indexes specify the behavior of an Atlas Vector Search, which allows


Suggested change

Vector Search indexes specify the behavior of an Atlas Vector Search, which allows

Atlas Vector Search indexes allow

S: full product name and edit bc it seems duplicative to say AVS twice

lindseymoore · 2025-05-21T18:03:01Z

source/model-data/indexes.txt

+You can integrate vector search with full-text search queries and AI frameworks to
+support a range of use cases.
+
+To create a Vector Search index, assign the ``indexes`` option in your model's


Suggested change

To create a Vector Search index, assign the ``indexes`` option in your model's

To create an Atlas Vector Search index, assign the ``indexes`` option in your model's

S: I would lowercase "vector search" or include full product name

lindseymoore · 2025-05-21T18:03:40Z

source/model-data/indexes.txt

+``Meta`` class to a ``VectorSearchIndex`` object. Pass the following arguments to the
+``VectorSearchIndex()`` constructor:
+
+- ``name``: *(Optional)* The name of your Vector Search index. If you do not


Suggested change

- ``name``: *(Optional)* The name of your Vector Search index. If you do not

- ``name``: *(Optional)* The name of your Atlas Vector Search index. If you do not

S: lowercase or full product name

lindseymoore · 2025-05-21T18:04:58Z

source/model-data/indexes.txt

+  of values that assigns functions to individual vector fields.
+
+The following example updates the ``Recipe`` model's ``Meta`` class to create
+a Vector Search index named ``"vector_search_idx"`` on the ``ratings`` vector field


Suggested change

a Vector Search index named ``"vector_search_idx"`` on the ``ratings`` vector field

an Atlas Vector Search index named ``"vector_search_idx"`` on the ``ratings`` vector field

lindseymoore · 2025-05-21T18:05:21Z

source/model-data/indexes.txt

+
+.. tip::
+
+   To learn more about Vector Search queries and indexes, see the following resources:


Suggested change

To learn more about Vector Search queries and indexes, see the following resources:

To learn more about Atlas Vector Search queries and indexes, see the following resources:

source/includes/model-data/indexes.py

timgraham · 2025-05-22T01:13:40Z

source/model-data/indexes.txt

+- ``name``: *(Optional)* The name of your Atlas Vector Search index. If you do not
+  specify this argument, {+framework+} automatically generates an index name.
+- ``fields``: The fields you want to index. At least one must be a vector
+  field, represented by an array of ``FloatField`` or ``IntegerField`` values and an 


"and an array size" -> "with a size"
(It would be really helpful to get intersphinx working to https://django-mongodb-backend.readthedocs.io/ so you can have size link to ArrayField.size) If you need help, let me know.

Unfortunately additional changes to the intersphinx links are stalled, I can't configure it myself - the docs platform team does that - and they have some higher priority work at the moment. I added a link to the API docs using the source constant instead

source/includes/model-data/indexes.py

aclark4life

LGTM pending @timgraham comment

* DOCSP-49759: Vector search index * edits * LM feedback * fix * link * fix link (cherry picked from commit 794ab48)

DOCSP-49759: Vector search index

0f45c4a

edits

b0ee587

lindseymoore approved these changes May 21, 2025

View reviewed changes

LM feedback

4a5b20b

aclark4life reviewed May 21, 2025

View reviewed changes

source/includes/model-data/indexes.py Show resolved Hide resolved

timgraham reviewed May 22, 2025

View reviewed changes

aclark4life self-requested a review May 22, 2025 11:48

aclark4life approved these changes May 22, 2025

View reviewed changes

norareidy added 3 commits May 22, 2025 16:42

fix

392abc3

link

00d0c05

fix link

3b9bb4c

norareidy merged commit 794ab48 into mongodb:master May 23, 2025
5 checks passed

norareidy deleted the DOCSP-49759-vector-search-idx branch May 23, 2025 14:51

norareidy added a commit that referenced this pull request May 23, 2025

DOCSP-49759: Vector search index (#33)

c217ade

* DOCSP-49759: Vector search index * edits * LM feedback * fix * link * fix link (cherry picked from commit 794ab48)

	Vector Search indexes specify the behavior of an Atlas Vector Search, which allows
	Atlas Vector Search indexes allow

	To create a Vector Search index, assign the ``indexes`` option in your model's
	To create an Atlas Vector Search index, assign the ``indexes`` option in your model's

	- ``name``: (Optional) The name of your Vector Search index. If you do not
	- ``name``: (Optional) The name of your Atlas Vector Search index. If you do not

	a Vector Search index named ``"vector_search_idx"`` on the ``ratings`` vector field
	an Atlas Vector Search index named ``"vector_search_idx"`` on the ``ratings`` vector field


		.. tip::

		To learn more about Vector Search queries and indexes, see the following resources:

	To learn more about Vector Search queries and indexes, see the following resources:
	To learn more about Atlas Vector Search queries and indexes, see the following resources:

DOCSP-49759: Vector search index #33

DOCSP-49759: Vector search index #33

Uh oh!

Conversation

norareidy commented May 21, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Staging Links

Self-Review Checklist

Uh oh!

netlify bot commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-django ready!

Uh oh!

lindseymoore left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aclark4life left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

norareidy commented May 21, 2025 •

edited by github-actions bot

Loading

netlify bot commented May 21, 2025 •

edited

Loading