feat: adding metadata grouper component #8512
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
github-actions
bot
added
topic:tests
type:documentation
Pull Request Test Coverage Report for Build 11799668570Details
💛 - Coveralls |
davidsbatista
changed the title
davidsbatista
requested review from
dfokina and
anakin87
and removed request for
a team
Co-authored-by: Stefano Fiorucci <[email protected]>
|
About the naming: from a grouper, I would expect it to return groups of Documents; this returns an ordered flat list, instead. |
|
@davidsbatista Let's add it do the pydocs file too, pls |
anakin87
reviewed
Nov 11, 2024
Comment on lines
179
to
206
| @component.output_types(documents=List[Document]) | ||
| def run(self, documents: List[Document]) -> Dict[str, Any]: | ||
| """ | ||
| Groups the provided list of documents based on the `group_by` parameter and optionally the `subgroup_by`. | ||
|
|
||
| The output is a list of documents reordered based on how they were grouped. | ||
|
|
||
| :param documents: The list of documents to group. | ||
| :returns: | ||
| A dictionary with the following keys: | ||
| - documents: The list of documents ordered by the `group_by` and `subgroup_by` metadata values. | ||
| """ | ||
|
|
||
| if len(documents) == 0: | ||
| return {"documents": []} | ||
|
|
||
| # docs based on the 'group_by' value | ||
| document_groups, no_group, ordered_keys = self._group_documents(documents) | ||
|
|
||
| # further grouping of the document inside each group based on the 'subgroup_by' value | ||
| document_subgroups, subgroup_ordered_keys = self._create_subgroups(document_groups) | ||
|
|
||
| # sort the docs within the groups or subgroups if necessary | ||
| result_docs = self._merge_and_sort( | ||
| document_groups, document_subgroups, no_group, ordered_keys, subgroup_ordered_keys | ||
| ) | ||
|
|
||
| return {"documents": result_docs} |
There was a problem hiding this comment.
Do you see problems in a simple implementation like this?
@component.output_types(documents=List[Document])
def run(self, documents: List[Document]) -> Dict[str, Any]:
...
if not documents:
return {"documents": []}
document_groups = defaultdict(lambda: defaultdict(list))
no_group_docs = []
for doc in documents:
group_value = str(doc.meta.get(self.group_by, ""))
if group_value:
subgroup_value = str(doc.meta.get(self.subgroup_by, "no_subgroup")) if self.subgroup_by else "no_subgroup"
document_groups[group_value][subgroup_value].append(doc)
else:
no_group_docs.append(doc)
ordered_docs = []
for group in document_groups:
for subgroup in document_groups[group]:
docs = document_groups[group][subgroup]
if self.sort_docs_by:
docs = sorted(docs, key=lambda d: d.meta.get(self.sort_docs_by, float("inf")))
ordered_docs.extend(docs)
ordered_docs.extend(no_group_docs)
return {"documents": ordered_docs}There was a problem hiding this comment.
@ju-gu can you test whether this simpler implementation is suitable for your needs? The tests are satisfied.
There was a problem hiding this comment.
nice, this seems to work as well, 👍
Co-authored-by: Stefano Fiorucci <[email protected]>
Co-authored-by: Stefano Fiorucci <[email protected]>
Co-authored-by: Stefano Fiorucci <[email protected]>
Co-authored-by: Stefano Fiorucci <[email protected]>
ju-gu
approved these changes
Nov 12, 2024
Comment on lines
179
to
206
| @component.output_types(documents=List[Document]) | ||
| def run(self, documents: List[Document]) -> Dict[str, Any]: | ||
| """ | ||
| Groups the provided list of documents based on the `group_by` parameter and optionally the `subgroup_by`. | ||
|
|
||
| The output is a list of documents reordered based on how they were grouped. | ||
|
|
||
| :param documents: The list of documents to group. | ||
| :returns: | ||
| A dictionary with the following keys: | ||
| - documents: The list of documents ordered by the `group_by` and `subgroup_by` metadata values. | ||
| """ | ||
|
|
||
| if len(documents) == 0: | ||
| return {"documents": []} | ||
|
|
||
| # docs based on the 'group_by' value | ||
| document_groups, no_group, ordered_keys = self._group_documents(documents) | ||
|
|
||
| # further grouping of the document inside each group based on the 'subgroup_by' value | ||
| document_subgroups, subgroup_ordered_keys = self._create_subgroups(document_groups) | ||
|
|
||
| # sort the docs within the groups or subgroups if necessary | ||
| result_docs = self._merge_and_sort( | ||
| document_groups, document_subgroups, no_group, ordered_keys, subgroup_ordered_keys | ||
| ) | ||
|
|
||
| return {"documents": result_docs} |
There was a problem hiding this comment.
nice, this seems to work as well, 👍
anakin87
approved these changes
Nov 12, 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.
Related Issues
Proposed Changes:
How did you test it?
Checklist
fix:,feat:,build:,chore:,ci:,docs:,style:,refactor:,perf:,test:.