feat: add minRelevanceScore parameter to PostgresVectorCollection

[GregoireDaure]

Summary by CodeRabbit

• New Features
  • Enhanced search functionality by introducing a configurable minimum relevance threshold. This update aids in filtering search results to ensure users receive more pertinent outcomes based on a defined score criterion.

[coderabbitai]

Walkthrough

This change updates the SearchAsync method in the PostgresVectorCollection class to pass an additional parameter (minRelevanceScore) to the GetWithDistanceAsync method. The parameter is derived from settings.ScoreThreshold, defaulting to 0D if not provided. The core flow of the method remains unchanged while adding a new filtering criterion for search results.

Changes

File Location	Change Summary
src/.../PostgresVectorCollection.cs	Added a new parameter minRelevanceScore in the call to GetWithDistanceAsync within the SearchAsync method, using settings.ScoreThreshold

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant VectorCollection
    participant DistanceService

    Client->>VectorCollection: Call SearchAsync(request, settings, cancellationToken)
    VectorCollection->>DistanceService: Call GetWithDistanceAsync(..., minRelevanceScore = settings.ScoreThreshold or 0D)
    DistanceService-->>VectorCollection: Return search results
    VectorCollection-->>Client: Return VectorSearchResponse

Loading

Possibly related PRs

• (feat): add scoreThreshold + metadata for milvus #137: Both changes add a minRelevanceScore parameter to the SearchAsync method to modify search behavior.
• fix(opensearch): Return Distance and respect the provided ScoreThreshold #112: Both involve modifications in SearchAsync to handle a ScoreThreshold parameter for search filtering.

Suggested reviewers

• HavenDV

Poem

I'm a rabbit with a joyful heart,
Hopping through the code with a brand new part.
A min score now in every search I roam,
Keeping results precise, right back home.
Code magic hops, and fun abounds—
Enjoy this leap in functionality! 🐇✨

---

📜 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 4ab4317 and b7ec169.

📒 Files selected for processing (1)

• src/Postgres/src/PostgresVectorCollection.cs (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Build and test / Build, test and publish

🔇 Additional comments (1)

src/Postgres/src/PostgresVectorCollection.cs (1)

79-79: Good enhancement to filtering search results!

The addition of the minRelevanceScore parameter to GetWithDistanceAsync improves the search functionality by allowing filtering based on a minimum relevance score threshold. The parameter naming is clear, and the default of 0D is sensible as it won't filter any results when no threshold is specified.

✨ 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.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @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 generate unit testing code.
  • @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.

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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @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.