[ENHANCEMENT][REFACTOR] SDK: allow to remove settings

argilla/src/argilla/settings/_resource.py

@@ -207,10 +207,10 @@ def create(self) -> "Settings":
         self.validate()
 
         self._update_dataset_related_attributes()
-        self.__fields.create()
-        self.__questions.create()
-        self.__vectors.create()
-        self.__metadata.create()
+        self.__fields._create()
+        self.__questions._create()
+        self.__vectors._create()
+        self.__metadata._create()
 
         self._update_last_api_call()
         return self
@@ -219,10 +219,10 @@ def update(self) -> "Resource":
         self.validate()
 
         self._update_dataset_related_attributes()
-        self.__fields.update()
-        self.__vectors.update()
-        self.__metadata.update()
-        # self.questions.update()
+        self.__fields._update()
+        self.__vectors._update()
+        self.__metadata._update()
+        self.__questions._update()
 
         self._update_last_api_call()
         return self
@@ -457,6 +457,7 @@ class SettingsProperties(Sequence[Property]):
     def __init__(self, settings: "Settings", properties: List[Property]):
         self._properties_by_name = {}
         self._settings = settings
+        self._removed_properties = []
 
         for property in properties or []:
             if self._settings.dataset and hasattr(property, "dataset"):
@@ -474,7 +475,7 @@ def __getitem__(self, key: Union[UUID, str, int]) -> Optional[Property]:
             return self._properties_by_name.get(key)
 
     def __iter__(self) -> Iterator[Property]:
-        return iter(self._properties_by_name.values())
+        return iter([v for v in self._properties_by_name.values()])
 
     def __len__(self):
         return len(self._properties_by_name)
@@ -491,22 +492,41 @@ def add(self, property: Property) -> Property:
         setattr(self, property.name, property)
         return property
 
-    def create(self):
+    def remove(self, property: Union[str, Property]) -> None:
+        if isinstance(property, str):
+            property = self._properties_by_name.pop(property)
+        else:
+            property = self._properties_by_name.pop(property.name)
+
+        if property:
+            delattr(self, property.name)
+            self._removed_properties.append(property)
+
+    def _create(self):
         for property in self:
             try:
                 property.dataset = self._settings.dataset
                 property.create()
             except ArgillaAPIError as e:
                 raise SettingsError(f"Failed to create property {property.name!r}: {e.message}") from e
 
-    def update(self):
+    def _update(self):
         for item in self:
             try:
                 item.dataset = self._settings.dataset
                 item.update() if item.id else item.create()
             except ArgillaAPIError as e:
                 raise SettingsError(f"Failed to update {item.name!r}: {e.message}") from e
 
+        self._delete()
+
+    def _delete(self):
+        for item in self._removed_properties:
+            try:
+                item.delete()
+            except ArgillaAPIError as e:
+                raise SettingsError(f"Failed to delete {item.name!r}: {e.message}") from e
+
     def serialize(self) -> List[dict]:
         return [property.serialize() for property in self]
 
@@ -533,13 +553,19 @@ class to work with questions as we do with fields, vectors, or metadata (special
     Once issue https://github.com/argilla-io/argilla/issues/4931 is tackled, this class should be removed.
     """
 
-    def create(self):
+    def _create(self):
         for question in self:
             try:
                 self._create_question(question)
             except ArgillaAPIError as e:
                 raise SettingsError(f"Failed to create question {question.name}") from e
 
+    def _update(self):
+        pass
+
+    def _delete(self):
+        pass
+
     def _create_question(self, question: QuestionType) -> None:
         question_model = self._settings._client.api.questions.create(
             dataset_id=self._settings.dataset.id,

argilla/tests/integration/test_update_dataset_settings.py

@@ -12,11 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-import uuid
-
 import pytest
 
-from argilla import Dataset, Settings, TextField, ChatField, LabelQuestion, Argilla, VectorField, FloatMetadataProperty
+from argilla import (
+    Dataset,
+    Settings,
+    TextField,
+    ChatField,
+    LabelQuestion,
+    Argilla,
+    VectorField,
+    FloatMetadataProperty,
+    TermsMetadataProperty,
+)
 
 
 @pytest.fixture
@@ -62,3 +70,19 @@ def test_update_distribution_settings(self, client: Argilla, dataset: Dataset):
 
         dataset = client.datasets(dataset.name)
         assert dataset.settings.distribution.min_submitted == 100
+
+    def test_remove_settings_property(self, client: Argilla, dataset: Dataset):
+        dataset.settings.metadata.add(TermsMetadataProperty(name="metadata"))
+        dataset.settings.vectors.add(VectorField(name="vector", dimensions=10))
+        dataset.update()
+
+        assert isinstance(dataset.settings.metadata["metadata"], TermsMetadataProperty)
+        assert isinstance(dataset.settings.vectors["vector"], VectorField)
+
+        dataset.settings.metadata.remove("metadata")
+        dataset.settings.vectors.remove("vector")
+
+        dataset.update()
+
+        assert dataset.settings.metadata["metadata"] is None
+        assert dataset.settings.vectors["vector"] is None

argilla/tests/unit/test_settings/test_settings.py

@@ -16,6 +16,7 @@
 
 import pytest
 from pytest_mock import MockerFixture
+from tensorboard.compat.tensorflow_stub.tensor_shape import vector
 
 import argilla as rg
 from argilla import Dataset
@@ -195,14 +196,33 @@ def test_read_settings_without_distribution(self, mocker: "MockerFixture"):
         settings.get()
         assert settings.distribution == TaskDistribution.default()
 
-    class TestSettingsSerialization:
-        def test_serialize(self):
-            settings = rg.Settings(
-                guidelines="This is a guideline",
-                fields=[rg.TextField(name="prompt", use_markdown=True)],
-                questions=[rg.LabelQuestion(name="sentiment", labels=["positive", "negative"])],
-            )
-            settings_serialized = settings.serialize()
-            assert settings_serialized["guidelines"] == "This is a guideline"
-            assert settings_serialized["fields"][0]["name"] == "prompt"
-            assert settings_serialized["fields"][0]["settings"]["use_markdown"] is True
+    def test_serialize(self):
+        settings = rg.Settings(
+            guidelines="This is a guideline",
+            fields=[rg.TextField(name="prompt", use_markdown=True)],
+            questions=[rg.LabelQuestion(name="sentiment", labels=["positive", "negative"])],
+        )
+        settings_serialized = settings.serialize()
+        assert settings_serialized["guidelines"] == "This is a guideline"
+        assert settings_serialized["fields"][0]["name"] == "prompt"
+        assert settings_serialized["fields"][0]["settings"]["use_markdown"] is True
+
+    def test_remove_property_from_settings(self):
+        settings = rg.Settings(
+            fields=[rg.TextField(name="text", title="text")],
+            questions=[rg.LabelQuestion(name="label", title="text", labels=["positive", "negative"])],
+            metadata=[rg.FloatMetadataProperty("source")],
+            vectors=[rg.VectorField(name="vector", dimensions=3)],
+        )
+
+        settings.fields.remove("text")
+        assert len(settings.fields) == 0
+
+        settings.questions.remove("label")
+        assert len(settings.questions) == 0
+
+        settings.metadata.remove("source")
+        assert len(settings.metadata) == 0
+
+        settings.vectors.remove("vector")
+        assert len(settings.vectors) == 0