Add support for similar docs query

[JiaYingZhang]

Pull Request

Related issue

Fixes #646

What does this PR do?

• Add support for similar docs queries with v1.13 version api #646. It works for my project.
• Completed but commented on the test cases; I will finish the remaining parts after the PR #554 is merged.

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

  • Introduced similarity search capabilities to find documents similar to a specified one within an index.
  • Added configurable options for similarity queries, including pagination, filtering, attribute selection, and detailed ranking score information in results.

• Documentation

  • Included example usage and detailed documentation for the similarity search functionality.

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

A new module for similarity search has been introduced, including data structures and builder methods for constructing and executing similarity queries on an index. The Index struct now supports an asynchronous method to perform similar document queries. Relevant modules are publicly exposed, and internal visibility is adjusted for a serialization helper.

Changes

File(s)	Change Summary
src/similar.rs	New module: Implements similarity search query builder, result types, and async execution method.
src/indexes.rs	Adds similar_query async method to Index for posting similarity queries. Imports similar.
src/lib.rs	Publicly exposes the new similar module.
src/search.rs	Increases visibility of serialize_with_wildcard to pub(crate).
src/documents.rs	Updates documentation URL for filtering syntax on DocumentsQuery struct.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant Index
    participant SimilarQuery
    participant HTTP

    Client->>Index: similar_query(&SimilarQuery)
    Index->>HTTP: POST /indexes/{uid}/similar (with SimilarQuery)
    HTTP-->>Index: SimilarResults<T>
    Index-->>Client: Result<SimilarResults<T>, Error>

Assessment against linked issues

Objective	Addressed	Explanation
Implement searchSimilarDocuments via POST /indexes/:uid/similar (meilisearch#646)	✅
Add builder and execution for similarity queries, including result/metadata structures (meilisearch#646)	✅
Expose new similar module and integrate with Index struct (meilisearch#646)	✅
No changes to embedders or vector/hybrid search settings/parameters (meilisearch#646)	❌	These aspects are not addressed in this PR.

Assessment against linked issues: Out-of-scope changes

Code Change	Explanation
Increased visibility of serialize_with_wildcard (src/search.rs)	This change is not directly related to the implementation of similarity queries or endpoints.

Poem

In the warren of code, a new path appears,
For searching by likeness, across data frontiers.
With queries that wander and results that align,
The similar module hops in—oh, how divine!
Now bunnies can fetch, with a whisker’s delight,
Documents alike, in the soft moonlight.
🐇✨

---

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.

[CommanderStorm]

Is this a duplicate of https://github.com/meilisearch/meilisearch-rust/pull/600 ?

[JiaYingZhang]

Is this a duplicate of #600 ?

It is not a complete repetition, and the implementation methods are inconsistent. I prefer to handle "similar" as an independent query to avoid affecting the search query.

[Mubelotix]

@coderabbitai review

[coderabbitai[bot]]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[codecov[bot]]

Welcome to Codecov :tada:

Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests.

Thanks for integrating Codecov - We've got you covered :open_umbrella:

[Mubelotix]

Thank you @JiaYingZhang!