Add highlights in search

[Akhilathina]

Summary by CodeRabbit

• New Features

  • Added optional highlights attribute to the Search class for more dynamic API request content.

• Chores

  • Bumped package version from 1.7.10 to 1.7.11.

[coderabbitai]

Walkthrough

This pull request introduces a new highlights attribute to the Search class in the search.py file. The attribute is an optional dictionary that allows for more dynamic content in API calls. Simultaneously, the package version has been incremented from 1.7.10 to 1.7.11 in the pyproject.toml file. The changes modify how search-related data is prepared and transmitted, with a focus on providing more flexible highlight information.

Changes

File	Change Summary
athina/steps/search.py	Added highlights: Optional[Dict[str, Any]] = None attribute to Search class; modified API request body preparation to include highlights in contents section.
pyproject.toml	Bumped package version from 1.7.10 to 1.7.11.

Possibly related PRs

• Added response time + highlights + summary to search step #143: Enhances Search class by adding highlights key to request body.

Suggested reviewers

• Akhilathina
• shivsak

Poem

🐰 A search hop with highlights bright,
Rabbit's code takes a nimble flight,
Version bumped with gentle care,
Flexibility beyond compare,
Searching smarter, leaping light! 🔍

---

📜 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 756b562 and 3547223.

📒 Files selected for processing (1)

• athina/steps/search.py (3 hunks)

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

• athina/steps/search.py

---

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 (1)

athina/steps/search.py (1)

35-35: Enhance the docstring with more details about the highlights structure.

The docstring could be more descriptive about the expected structure and format of the highlights dictionary to help users understand how to properly use this attribute.

Consider expanding the docstring like this:

-        highlights: Text snippets the LLM identifies as most relevant from each page.
+        highlights: Optional dictionary containing text snippets that the LLM identifies as most relevant from each page. The dictionary can contain any key-value pairs that represent highlighted content.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8db5c7b and 756b562.

📒 Files selected for processing (2)

• athina/steps/search.py (3 hunks)
• pyproject.toml (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• pyproject.toml

🔇 Additional comments (2)

athina/steps/search.py (2)

51-51: LGTM!

The type hint and default value are appropriate, and the attribute follows the established pattern of optional parameters in the class.

---

89-92: Consider adding validation for the highlights structure.

While the integration is correct, consider adding validation for the highlights dictionary before sending it to the API to prevent potential runtime errors or invalid requests.

You might want to add basic validation like this:

         "contents": {
-                "highlights": self.highlights,
+                "highlights": (self.highlights if isinstance(self.highlights, dict) else None),
                 "summary": {"query": self.query},
         },