Flexible fusion part 3: CLI suggest option for additional metadata #866
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
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #866 +/- ##
=======================================
Coverage 99.65% 99.66%
=======================================
Files 102 102
Lines 7629 7649 +20
=======================================
+ Hits 7603 7623 +20
Misses 26 26 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Member
Author
|
Ping @c-poley @RietdorfC, you may be interested in testing this. |
Yes, we are very interested in. Meanwhile, Clemens and Sandro startet to test the new functionalities. 👍 |
juhoinkinen
approved these changes
Aug 7, 2025
Member
juhoinkinen
left a comment
There was a problem hiding this comment.
I tested this quickly, works and looks good!
|
This was referenced Aug 7, 2025
Closed
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.
3rd part of #813, after #864.
This PR adds a new
--metadata/-Doption to theannif suggestCLI command. It allows specifying metadata to go along with a document that is read from stdin. This is useful when testing projects that have aselect()transform that operates on custom metadata fields.Example use
For example, if
myprojecthas a settingtransform=select(title,description,text), then it can be tested appropriately with this command:Without the
-Doption, only the text would be read from stdin, but the metadata fields would remain unset during the suggest operation.Limitations
This applies only to the case where
annif suggestis used on a single document read from stdin (with or without-as the path parameter). Ifannif suggestis used with a path to a corpus of documents (a directory of .txt files), then likely every document would have its own metadata values anyway, and an option for setting metadata values once for the full set would not be very useful.