Add support for returning document vector data when get one document

[JiaYingZhang]

Pull Request

Related issue

What does this PR do?

• Support return document vector data with get one document

PR checklist

Please check if your PR fulfills the following requirements:

• [x] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• [x] Have you read the contributing guidelines?
• [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

Summary by CodeRabbit

• New Features
  • Added an option to include document vector data in search results.
• Documentation
  • Updated usage examples to demonstrate how to enable retrieval of document vectors in queries.

[coderabbitai[bot]]

Walkthrough

A new optional boolean field, retrieve_vectors, was added to the DocumentQuery struct, along with a corresponding builder-style method for setting it. The constructor for DocumentQuery was updated to initialize this field, and the documentation example now demonstrates its usage.

Changes

File(s)	Change Summary
src/documents.rs	Added retrieve_vectors field and with_retrieve_vectors method to DocumentQuery; updated constructor and documentation example.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DocumentQuery
    participant Index

    User->>Index: Obtain Index reference
    User->>DocumentQuery: Call DocumentQuery::new(&Index)
    User->>DocumentQuery: Call .with_fields(...)
    User->>DocumentQuery: Call .with_retrieve_vectors(true)
    Note right of DocumentQuery: Sets retrieve_vectors = Some(true)
    User->>DocumentQuery: Execute query

Poem

In the land of code, a field appears,
retrieve_vectors now calms your fears.
With builder style, your queries grow,
More options for docs, as you now know.
The rabbit hops with glee anew—
More data for all, just for you!
🐇✨

---

📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3130f8c273687d13f1c16e1357ea765bde8d60fd and 161dff13b6cae82b6319592621bc9b50acfc5fa5.

📒 Files selected for processing (1)

• src/documents.rs (4 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/documents.rs

✨ Finishing Touches

• [ ] 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[Mubelotix]

Hello @JiaYingZhang, thank you for your contribution. I have to close this as it was already implemented and merged in commit https://github.com/meilisearch/meilisearch-rust/commit/464de4459dd6f0b91b88ad025733f73ee91cfaae