feat(document-search): LLM-based query rephraser #115
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
akotyla
added
feature
|
Code Coverage SummaryDiff against mainResults for commit: fd4a48d Minimum allowed coverage is ♻️ This comment has been updated with latest results |
|
Trivy scanning results. .venv/lib/python3.10/site-packages/PyJWT-2.9.0.dist-info/METADATA (secrets)Total: 1 (MEDIUM: 1, HIGH: 0, CRITICAL: 0) MEDIUM: JWT (jwt-token) .venv/lib/python3.10/site-packages/litellm/llms/huggingface_llms_metadata/hf_text_generation_models.txt (secrets)Total: 1 (MEDIUM: 0, HIGH: 0, CRITICAL: 1) CRITICAL: HuggingFace (hugging-face-access-token) .venv/lib/python3.10/site-packages/litellm/proxy/_types.py (secrets)Total: 1 (MEDIUM: 1, HIGH: 0, CRITICAL: 0) MEDIUM: Slack (slack-web-hook) |
ludwiktrammer
requested changes
Oct 17, 2024
| """ | ||
| Rephrase a query. | ||
|
|
||
| Args: | ||
| query: The query to rephrase. | ||
| options: OptionaL options to fine-tune the rephraser behavior. |
There was a problem hiding this comment.
Suggested change
| options: OptionaL options to fine-tune the rephraser behavior. | |
| options: Optional configuration of the the rephraser behavior. |
(it's very nit-picky but fixes the "L" in "OptionaL", the awkward sounding "Optional options", and gets rid of the word "fine-tuning" which got me confused at first since usually it has a different meaning when used with LLMs)
| """ | ||
| Mock implementation which outputs the same query as in input. | ||
|
|
||
| Args: | ||
| query: The query to rephrase. | ||
| options: OptionaL options to fine-tune the rephraser behavior. |
There was a problem hiding this comment.
Suggested change
| options: OptionaL options to fine-tune the rephraser behavior. | |
| options: Optional configuration of the the rephraser behavior. |
| If not provided, the default `QueryRephraserPrompt` is used. | ||
| """ | ||
|
|
||
| self._prompt = prompt or QueryRephraserPrompt |
There was a problem hiding this comment.
Wouldn't this mean that _prompt sometimes is an instance of QueryRephraserPrompt and sometimes it's the class itself? I also don't see self._prompt used anywhere. In the rephrase method QueryRephraserPrompt is used directly.
There was a problem hiding this comment.
Right, I cleaned it up now and prompt is no longer an attribute
micpst
reviewed
Oct 17, 2024
packages/ragbits-document-search/src/ragbits/document_search/retrieval/rephrasers/llm.py
Outdated
Show resolved
Hide resolved
packages/ragbits-document-search/src/ragbits/document_search/retrieval/rephrasers/llm.py
Outdated
Show resolved
Hide resolved
micpst
approved these changes
Oct 23, 2024
ludwiktrammer
approved these changes
Oct 23, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.