DOCSP-48420: bson v2.14 vector support by rustagir · Pull Request #169 · mongodb/docs-rust

rustagir · 2025-03-14T15:25:32Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-48420
Staging:

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-03-14T15:32:31Z

✅ Deploy Preview for docs-rust ready!

Name	Link
🔨 Latest commit	`cc7554c`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-rust/deploys/67dad6be0675f300077a0db4
😎 Deploy Preview	https://deploy-preview-169--docs-rust.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 site configuration.

lindseymoore

A few questions and suggestions, thanks!

lindseymoore · 2025-03-14T19:51:12Z

source/fundamentals/aggregation/vector-search.txt

+   * - ``filter``
+     - document
+     - Specifies a pre-filter for documents to search on
+     - No filtering


Suggested change

- No filtering

- ``null`` (No filtering)

S: Is there a default value you can list along with the default value behavior?

This came from the Atlas docs, which didn't supply default values. I'm not sure null is actually the type interpreted by the server

Could be worth asking the tech reviewer for the default value/clarification

I'd leave these as-is; I'm not sure how the server represents these values when they're unset, but that shouldn't be of concern to the user and I think this phrasing better represents the actual behavior. There's no default value from the driver's perspective because the driver just sends the pipeline the user provided directly to the server.

lindseymoore · 2025-03-14T19:51:37Z

source/fundamentals/aggregation/vector-search.txt

+     - number
+     - Specifies the number of nearest neighbors to use during the
+       search
+     - No limit


Same as above, is there a default value you can list?

See reply above

Would ask tech reviewer

lindseymoore · 2025-03-14T19:52:50Z

source/fundamentals/serialization.txt

+   at the ``crates.io`` crate registry.

 By implementing functionality from the ``serde`` crate into your
 application, you can use custom Rust types such as structs and enums


Suggested change

application, you can use custom Rust types such as structs and enums

application, you can use custom Rust types such as ``structs`` and ``enums``

S: Should this be monospaced since they're types?

I think they are regular nouns and other docs do not monospace them:

https://doc.rust-lang.org/book/ch05-01-defining-structs.html

https://doc.rust-lang.org/book/ch06-00-enums.html

lindseymoore · 2025-03-14T19:56:13Z

source/fundamentals/serialization.txt

 By implementing functionality from the ``serde`` crate into your
 application, you can use custom Rust types such as structs and enums
-to model your data.
+to model your data and Rust data types to model your field values.


Q: I'm confused by this. What is the difference between data and field values? Can you make a clearer distinction?

I meant that you can use a struct to model a whole document and select Rust data types for each field value - will revert back to old wording if this is already clear

lindseymoore · 2025-03-14T20:01:40Z

source/fundamentals/aggregation/vector-search.txt

+.. note:: Query Vector Length
+
+   For demonstrative purposes, the examples in this section use
+   sample query vectors that contain very few elements, compared to 
+   the query vector you might use in a runnable application. To view an
+   example that contains the full-length query vector, see the
+   :atlas:`Atlas Vector Search Quick Start </atlas-vector-search/tutorials/vector-search-quick-start/>`
+   and select :guilabel:`Rust` from the :guilabel:`Select your language` dropdown in the upper-right
+   corner of the page.


Q: Is the example still runnable without the correct query vector? If not, the output might be misleading.

I'll add a code comment to direct users to replace the query vector

S: I know it looks ugly to have the long vector, but it might be worth adding it to the page rather than including a note explaining why you didn't include and how to get the longer vector. I'll leave up to your discretion!

lindseymoore · 2025-03-14T20:05:24Z

source/fundamentals/aggregation/vector-search.txt

+.. list-table::
+   :header-rows: 1


Suggested change

.. list-table::

:header-rows: 1

.. list-table::

:widths: 20 20 40 20

:header-rows: 1

S: Edit column widths, so "document" doesn't wrap

lindseymoore · 2025-03-14T20:06:04Z

source/fundamentals/aggregation/vector-search.txt

+
+To learn more about these parameters, see the :atlas:`Fields
+</atlas-vector-search/vector-search-stage/#fields>` section of the
+``$vectorSearch`` operator reference in the Atlas documentation.


Should you include an Additional Information section with API refs?

lindseymoore

A few comments, otherwise LGTM! Let me know if you have any questions

lindseymoore · 2025-03-18T17:46:42Z

source/fundamentals/aggregation/vector-search.txt

+   For demonstrative purposes, the examples in this section use
+   sample query vectors that contain very few elements, compared to 
+   the query vector you use in a runnable application.


Suggested change

For demonstrative purposes, the examples in this section use

sample query vectors that contain very few elements, compared to

the query vector you use in a runnable application.

For demonstrative purposes, the example ``query_vector`` in this section

contains very few elements, compared to

the query vector you might use in a runnable application.

S: Just to make it clear what example vector you are referring to

using the full query vector so removing this admonition

isabelatkinson

small formatting suggestion, otherwise looks good!

isabelatkinson · 2025-03-18T19:20:36Z

source/includes/fundamentals/code-snippets/aggregation/vector-search.rs

+            "queryVector": &query_vector,
+            "path": "plot_embedding",
+            "numCandidates": 150,
+            "index": "vector_index",
+            "limit": 5
+        }


suggest indenting these lines for better readability

I ran rustfmt and this was the indentation that was implemented - should I add an extra indent?

isabelatkinson · 2025-03-18T19:20:48Z

source/includes/fundamentals/code-snippets/aggregation/vector-search.rs

+            "queryVector": &query_vector,
+            "path": "plot_embedding",
+            "numCandidates": 150,
+            "index": "vector_index",
+            "limit": 5
+        }


(cherry picked from commit aeb0adc)

rustagir added 2 commits March 14, 2025 11:25

DOCSP-48420: bson v2.14 vector support

c43ab83

landing page snooty.toml

ce9186f

rustagir requested review from a team and isabelatkinson and removed request for a team March 14, 2025 15:45

lindseymoore requested changes Mar 14, 2025

View reviewed changes

LM PR fixes 1

23455b8

rustagir requested a review from lindseymoore March 18, 2025 14:26

lindseymoore approved these changes Mar 18, 2025

View reviewed changes

isabelatkinson approved these changes Mar 18, 2025

View reviewed changes

rustagir added 4 commits March 19, 2025 10:16

LM PR fixes 2 + indentation

12f3c5e

indentation fix

526a05b

small fix

7306be4

small fix

cc7554c

rustagir merged commit aeb0adc into mongodb:master Mar 19, 2025

rustagir added a commit that referenced this pull request Mar 19, 2025

DOCSP-48420: bson v2.14 vector support (#169)

6b8c389

(cherry picked from commit aeb0adc)

rustagir added a commit that referenced this pull request Mar 19, 2025

DOCSP-48420: bson v2.14 vector support (#169)

62de55f

(cherry picked from commit aeb0adc)

	application, you can use custom Rust types such as structs and enums
	application, you can use custom Rust types such as ``structs`` and ``enums``

Conversation

rustagir commented Mar 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

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

Uh oh!

✅ Deploy Preview for docs-rust 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!

rustagir Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

rustagir Mar 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

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!

isabelatkinson 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rustagir commented Mar 14, 2025 •

edited

Loading

netlify bot commented Mar 14, 2025 •

edited

Loading

rustagir Mar 18, 2025 •

edited

Loading

rustagir Mar 18, 2025 •

edited

Loading