feat!: SentenceWindowRetriever returns List[Document] with docs ordered by split_idx_start
#8590
+48
−10
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
github-actions
bot
added
topic:tests
type:documentation
davidsbatista
changed the title
SentenceWindowRetriever returns a List[Document] instead of List[List[Document] with documents ordered by split_idx_startSentenceWindowRetriever returns List[Document] with docs ordered by split_idx_start
Pull Request Test Coverage Report for Build 12143707645Details
💛 - Coveralls |
davidsbatista
requested review from
dfokina,
Amnah199 and
julian-risch
and removed request for
a team
julian-risch
requested changes
Dec 3, 2024
There was a problem hiding this comment.
We need to change the output_type for the run method in https://github.com/deepset-ai/haystack/pull/8590/files#diff-750f6a7bf921c73e8d49b501612d4302738c3ddbe8b2a78d866493db722388e5R146
The docstring needs to be updated accordingly.
The PR should be feat!: instead of refactor: as we the changes are user-facing and change how the component can be used.
davidsbatista
changed the title
SentenceWindowRetriever returns List[Document] with docs ordered by split_idx_startSentenceWindowRetriever returns List[Document] with docs ordered by split_idx_start
davidsbatista
changed the title
SentenceWindowRetriever returns List[Document] with docs ordered by split_idx_startSentenceWindowRetriever returns List[Document] with docs ordered by split_idx_start
julian-risch
reviewed
Dec 3, 2024
There was a problem hiding this comment.
Looks good to me. As this is a breaking change, we'll need to wait until the deprecation notice was released before merging this PR. Let's put it back into draft PR mode.
Once this is merged, we can remove the deprecation note also from the documentation page.
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.
Related Issues
Proposed Changes:
SentenceWindowRetrievernow returns incontext_documentsaList[Document]instead ofList[List[Document]with the documents ordered bysplit_idx_startHow did you test it?
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.