fix: avoid duplicate references!

[amindadgar]

Summary by CodeRabbit

• Improvements
  • Enhanced source URL processing in answer generation
  • Improved handling of duplicate URLs
  • Refined node filtering and scoring mechanism
  • Updated method documentation and error handling

[coderabbitai]

Walkthrough

The changes in the prepare_answer_sources method focus on improving the handling of source nodes and URLs. The updated implementation introduces a more robust mechanism for processing nodes, emphasizing URL uniqueness and ensuring that only the highest-scoring node for each URL is retained. The method now uses a defaultdict to group nodes by tool name, filters nodes based on score and URL validity, and limits the number of references per tool.

Changes

File	Change Summary
utils/query_engine/prepare_answer_sources.py	- Updated method signature to remove None from input nodes type - Modified logic to handle unique URLs and track highest-scoring nodes - Refined error handling and logging - Updated method documentation

Poem

🐰 A Rabbit's Ode to Source Refinement 🔍

URLs unique, no duplicates in sight,
Nodes filtered with algorithmic might,
Scores dancing, tools aligned just right,
A query's sources, now crystal clear and bright,
Code hopping with precision and delight! 🌟

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

utils/query_engine/prepare_answer_sources.py (3)

Line range hint 13-17: Update method parameter type to exclude None values

The method prepare_answer_sources currently accepts nodes: list[NodeWithScore | None] and then filters out None values using a list comprehension. To enhance type safety and simplify the code, consider updating the parameter type to nodes: list[NodeWithScore] and ensuring that None values are not passed to this method.

---

42-42: Adjust the docstring 'Returns' section to follow style conventions

In the docstring's 'Returns' section, the return type includes the variable name all_sources : str. According to standard docstring conventions (e.g., NumPy style), the variable name should be omitted. Please update it to:

Returns
-------
str
    A formatted string containing numbered URLs organized by tool name...

---

71-75: Consolidate duplicate error handling logic

The error handling for cases where no valid sources are found is duplicated at lines 71-75 and 102-106. This redundancy can be reduced by consolidating the error checking into a single conditional block, which will improve code clarity and maintainability.

Also applies to: 102-106

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a4ab241 and dbf0ddf.

📒 Files selected for processing (1)

• utils/query_engine/prepare_answer_sources.py (4 hunks)

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

• GitHub Check: ci / test / Test
• GitHub Check: ci / lint / Lint

🔇 Additional comments (1)

utils/query_engine/prepare_answer_sources.py (1)

108-109: ⚠️ Potential issue

Replace removesuffix for Python version compatibility

The use of removesuffix("\n\n") in return all_sources.removesuffix("\n\n") requires Python 3.9 or later. If your codebase needs to support earlier Python versions, consider replacing it with an alternative method to ensure compatibility.

You can use:

return all_sources.rstrip('\n')

Or apply this diff:

- return all_sources.removesuffix("\n\n")
+ return all_sources[:-2] if all_sources.endswith("\n\n") else all_sources