Make GraphRAG search's query backwards compatible #97
Conversation
This file contains hidden or 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
willtai
changed the title
|
@CodiumAI-Agent /update_changelog |
|
Changelog updates: 🔄 2024-08-08Changed
|
stellasia
reviewed
Aug 8, 2024
| - Add optional custom_prompt arg to the Text2CypherRetriever class. | ||
|
|
||
|
|
||
| ### Changed |
There was a problem hiding this comment.
Shall we add a "Deprecation notice" section to make it even more visible?
| DeprecationWarning, | ||
| stacklevel=2, | ||
| ) | ||
| elif isinstance(query, str): |
There was a problem hiding this comment.
Why do we need to test for the type of query here?
stellasia
reviewed
Aug 8, 2024
|
|
||
| ### Changed | ||
| - `GraphRAG.search` method first parameter has been renamed `query_text` (was `query`) for consistency with the retrievers interface. | ||
| - Made `GraphRAG.search` method backwards compatible with the query parameter, raising warnings to encourage using query_text instead. |
There was a problem hiding this comment.
Not sure we need a line in changelog for that, maybe rephrasing the previous one would be nicer. Something like:
`query` parameter in GraphRAG.search` was deprecated and will be removed in the next major release. Use `query_text` instead.
a-s-g93
pushed a commit
to a-s-g93/neo4j-genai-python-dev
that referenced
this pull request
Sep 13, 2024
* Make query backwards compatible * Update CHANGELOG
a-s-g93
pushed a commit
to a-s-g93/neo4j-genai-python-dev
that referenced
this pull request
Sep 13, 2024
* Make query backwards compatible * Update CHANGELOG
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.
Description
#89 A previous PR removed the
queryargument fromGraphRAG's.search()which is a breaking change. This PR allows the argumentqueryto still be used, but raises warnings for the user to start usingquery_text.Type of Change
Complexity
Complexity: Low
How Has This Been Tested?
Checklist
The following requirements should have been met (depending on the changes in the branch):