feat: add validation layer for metadata_properties and metadata_filters
#3860
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
frascuchon
reviewed
Sep 29, 2023
…o feat/add-metadata-validation
Because the `metadata` is always optional, so it will just be validated if provided
|
FYI @frascuchon I had to revert the |
Codecov ReportAttention:
... and 4 files with indirect coverage changes 📢 Thoughts on this report? Let us know!. |
|
The URL of the deployed environment for this PR is https://argilla-quickstart-pr-3860-ki24f765kq-no.a.run.app |
gabrielmbmb
reviewed
Oct 6, 2023
alvarobartt
force-pushed
the
feat/add-metadata-validation
branch
from
b3e0015 to
a0e1c0a
Compare
In favour of `@property` + `@abstractmethod`. More information at https://docs.python.org/3.11/library/abc.html#abc.abstractproperty
alvarobartt
merged commit 37eb163
into
feature/support-for-metadata-filtering-and-sorting
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
This PR adds a validation layer for both the
metadata_propertieswhenmetadatais provided viaFeedbackRecordwhen adding that record to either a local or existingFeedbackDataset, as well as validating themetadata_filtersprovided to thefilter_bymethod forRemoteFeedbackDataset.These validation layers would help reduce the API workload as the validation will be done client-side, which implies that the client will handle the validation first.
In this case, as we have the following properties:
TermsMetadataProperty,IntegerMetadataPropertyandFloatMetadataProperty; we'll need to ensure that the values provided for those are correct, both onadd_recordsand also onfilter_by.The approach is similar to the one already implemented for the
fieldsof aFeedbackRecord, but extending it to themetadata_propertiesto also include a validation layer that ensures not just the type of the value provided, but whether it's compliant with the pre-defined values forTermMetadataPropertyor the pre-defined boundaries for bothIntegerMetadataPropertyandFloatMetadataProperty. The core difference is that besides thepydanticvalidation, there's also a method in each property that validates the values provided in the filters related to those metadata properties.Closes #3859
Type of change
How Has This Been Tested
generate_pydantic_schema_for_metadatamethod_validate_filterand_pydantic_field_with_validatorin each property i.e.TermsMetadataProperty,IntegerMetadataProperty, andFloatMetadataPropertyadd_recordswith both correct and wrongmetadataadd_recordsandfilter_byto ensure that the validation is correct both before and after applying those opsChecklist