feat(tagging): add retrocompatibility with text parameter

Author: corentin-hrflow

hrflow/hrflow/text/tagging.py

@@ -13,7 +13,8 @@ def __init__(self, api):
     def post(
         self,
         algorithm_key: str,
-        texts: t.List[str],
+        text: t.Optional[str] = None,
+        texts: t.Optional[t.List[str]] = None,
         context: t.Optional[str] = None,
         labels: t.Optional[t.List[str]] = None,
         top_n: t.Optional[int] = 1,
@@ -62,16 +63,22 @@ def post(
                 Returns:
                     `/text/tagging` response
         """
-
         payload = dict(
             algorithm_key=algorithm_key,
-            texts=texts,
             context=context,
             labels=labels,
             output_lang=output_lang,
             top_n=top_n,
         )
-
+        
+        if texts is None and text is not None:
+            payload["text"] = text
+        elif text is None and texts is not None:
+            payload["texts"] = texts
+        elif text is None and texts is None:
+            raise ValueError("Either text or texts must be provided.")
+        else:
+            raise ValueError("Only one of text or texts must be provided.")
+        
         response = self.client.post("text/tagging", json=payload)
-
         return validate_response(response)

tests/test_text.py

@@ -12,6 +12,7 @@
     TextLinkingResponse,
     TextOCRResponse,
     TextParsingResponse,
+    TextTaggingDataItem,
     TextTaggingReponse,
 )
 from .utils.tools import _file_get, _var_from_env_get
@@ -157,6 +158,63 @@ def test_linking_negative_amount(hrflow_client):
     assert model.code == requests.codes.bad_request
 
 
+@pytest.mark.text
+@pytest.mark.tagging
+def test_tagger_rome_family_with_text_param(hrflow_client):
+    model = TextTaggingReponse.model_validate(
+        hrflow_client.text.tagging.post(
+            algorithm_key=TAGGING_ALGORITHM.TAGGER_ROME_FAMILY,
+            text=TAGGING_TEXTS[0],
+            top_n=2,
+        )
+    )
+    assert model.code == requests.codes.ok
+    assert isinstance(model.data, TextTaggingDataItem)
+
+@pytest.mark.text
+@pytest.mark.tagging
+def test_tagger_rome_family_with_texts_param(hrflow_client):
+    model = TextTaggingReponse.model_validate(
+        hrflow_client.text.tagging.post(
+            algorithm_key=TAGGING_ALGORITHM.TAGGER_ROME_FAMILY,
+            texts=TAGGING_TEXTS,
+            top_n=2,
+        )
+    )
+    assert model.code == requests.codes.ok
+    assert isinstance(model.data, list)
+    assert len(model.data) == len(TAGGING_TEXTS)
+
+@pytest.mark.text
+@pytest.mark.tagging
+def test_tagger_rome_family_with_text_and_texts_param(hrflow_client):
+    try:
+        TextTaggingReponse.model_validate(
+            hrflow_client.text.tagging.post(
+                algorithm_key=TAGGING_ALGORITHM.TAGGER_ROME_FAMILY,
+                text=TAGGING_TEXTS[0],
+                texts=TAGGING_TEXTS,
+                top_n=2,
+            )
+        )
+        pytest.fail("Should have raised a ValueError")
+    except ValueError as e:
+        pass
+    
+@pytest.mark.text
+@pytest.mark.tagging
+def test_tagger_rome_family_without_text_or_texts_param(hrflow_client):
+    try:
+        TextTaggingReponse.model_validate(
+            hrflow_client.text.tagging.post(
+                algorithm_key=TAGGING_ALGORITHM.TAGGER_ROME_FAMILY,
+                top_n=2,
+            )
+        )
+        pytest.fail("Should have raised a ValueError")
+    except ValueError as e:
+        pass
+
 def _tagging_test(
     hrflow_client: Hrflow,
     algorithm_key: TAGGING_ALGORITHM,

tests/utils/schemas.py

@@ -100,6 +100,9 @@ class TextTaggingDataItem(BaseModel):
     @model_validator(mode="before")
     @classmethod
     def _check(cls, values: t.Dict[str, t.List[t.Any]]) -> t.Dict[str, t.List[t.Any]]:
+        if isinstance(values, list):
+            return [cls._check(item) for item in values
+        ]
         li = len(values.get("ids"))
         lp = len(values.get("predictions"))
         lt = len(values.get("tags"))
@@ -111,7 +114,7 @@ def _check(cls, values: t.Dict[str, t.List[t.Any]]) -> t.Dict[str, t.List[t.Any]
 
 
 class TextTaggingReponse(HrFlowAPIResponse):
-    data: t.Optional[t.List[TextTaggingDataItem]] = None
+    data: t.Optional[t.Union[t.List[TextTaggingDataItem], TextTaggingDataItem]] = None
 
 
 class TextParsingDataItemEntity(BaseModel):