boarddata 6.2.1__tar.gz → 6.2.2__tar.gz

{boarddata-6.2.1 → boarddata-6.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boarddata
-Version: 6.2.1
+Version: 6.2.2
 Summary: Python SDK for the BoardData V2 REST API
 License: MIT
 Classifier: Development Status :: 4 - Beta

{boarddata-6.2.1 → boarddata-6.2.2}/__init__.py

@@ -6,7 +6,7 @@ from .cache import FileTokenCache, ScalewaySecretTokenCache
 from .client import BoardDataClient
 from .errors import BoardDataError, ExportTooLargeError
 
-__version__ = "6.2.1"
+__version__ = "6.2.2"
 __all__ = [
     "Base",
     "BoardDataClient",

{boarddata-6.2.1 → boarddata-6.2.2}/_persons.py

@@ -19,6 +19,7 @@ class PersonMixin:
         *,
         search: str | None = None,
         similarity: str | None = None,
+        similarity_threshold: float | None = None,
         gender: str | None = None,
         nationality: str | None = None,
         page: int | None = None,
@@ -29,6 +30,9 @@ class PersonMixin:
         Args:
             search: Search by first/last name.
             similarity: Trigram similarity search (returns best matches by name).
+            similarity_threshold: Minimum trigram similarity (0.0–1.0). Only
+                applies when ``similarity`` is set. ``None`` uses the server
+                default (0.80).
             gender: Filter by gender code.
             nationality: Filter by nationality code(s), comma-separated.
             page: Page number (1-indexed).
@@ -44,6 +48,7 @@ class PersonMixin:
             "persons/",
             search=search,
             similarity=similarity,
+            similarity_threshold=similarity_threshold,
             gender=gender,
             nationality=nationality,
             page=page,
@@ -261,11 +266,18 @@ class PersonMixin:
         """
         return self._post("schools/", {"name": name, "country": country})  # type: ignore[attr-defined]
 
-    def find_person_by_similarity(self, full_name: str) -> PersonSimilarityItem | None:
+    def find_person_by_similarity(
+        self,
+        full_name: str,
+        *,
+        similarity_threshold: float | None = None,
+    ) -> PersonSimilarityItem | None:
         """Find the best-matching person by trigram similarity.
 
         Args:
             full_name: Full name to search for (e.g. ``"Jean Dupont"``).
+            similarity_threshold: Minimum trigram similarity (0.0–1.0).
+                ``None`` uses the server default (0.80).
 
         Returns:
             PersonSimilarityItem for the best match, or ``None`` if no match found.
@@ -273,7 +285,7 @@ class PersonMixin:
         Raises:
             BoardDataError: On non-2xx API response.
         """
-        resp = self.list_persons(similarity=full_name)
+        resp = self.list_persons(similarity=full_name, similarity_threshold=similarity_threshold)
         if isinstance(resp, dict) and "results" in resp:
             results = resp["results"]
         elif isinstance(resp, list):
@@ -295,6 +307,7 @@ class PersonMixin:
         schools: list[int] | None = None,
         professional_address: AddressPayload | None = None,
         field_sources: list[FieldSourcePayload] | None = None,
+        similarity_threshold: float | None = None,
     ) -> UpsertResult:
         """Find person by similarity, create or update.
 
@@ -309,6 +322,9 @@ class PersonMixin:
             schools: List of school IDs.
             professional_address: Professional address.
             field_sources: Document provenance for fields.
+            similarity_threshold: Minimum trigram similarity (0.0–1.0) for the
+                pre-write match step. ``None`` uses the server default (0.80).
+                Raise for strict ingestion; lower for loose dedup behavior.
 
         Returns:
             UpsertResult::
@@ -318,7 +334,7 @@ class PersonMixin:
         Raises:
             BoardDataError: On non-2xx API response.
         """
-        person = self.find_person_by_similarity(person_name)
+        person = self.find_person_by_similarity(person_name, similarity_threshold=similarity_threshold)
         person_uid = person["id"] if person else None
 
         payload = self._build_payload(  # type: ignore[attr-defined]

{boarddata-6.2.1 → boarddata-6.2.2}/boarddata.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: boarddata
-Version: 6.2.1
+Version: 6.2.2
 Summary: Python SDK for the BoardData V2 REST API
 License: MIT
 Classifier: Development Status :: 4 - Beta

{boarddata-6.2.1 → boarddata-6.2.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "boarddata"
-version = "6.2.1"
+version = "6.2.2"
 description = "Python SDK for the BoardData V2 REST API"
 readme = "README.md"
 license = {text = "MIT"}

{boarddata-6.2.1 → boarddata-6.2.2}/tests/test_persons.py

@@ -28,6 +28,24 @@ class TestListPersons:
         _, kwargs = c._request.call_args
         assert kwargs["params"] == {"search": "Jean", "gender": "M", "page": 1}
 
+    def test_forwards_similarity_threshold(self):
+        c = make_client()
+        c._request.return_value = {"count": 0, "results": []}
+        c.list_persons(similarity="Jean Dupont", similarity_threshold=0.85)
+        _, kwargs = c._request.call_args
+        assert kwargs["params"] == {
+            "similarity": "Jean Dupont",
+            "similarity_threshold": 0.85,
+        }
+
+    def test_omits_similarity_threshold_when_none(self):
+        c = make_client()
+        c._request.return_value = {"count": 0, "results": []}
+        c.list_persons(similarity="Jean Dupont")
+        _, kwargs = c._request.call_args
+        assert kwargs["params"] == {"similarity": "Jean Dupont"}
+        assert "similarity_threshold" not in kwargs["params"]
+
 
 class TestFindPersonBySimilarity:
     def test_returns_best_match(self):
@@ -41,6 +59,16 @@ class TestFindPersonBySimilarity:
         c._request.return_value = {"count": 0, "results": []}
         assert c.find_person_by_similarity("Unknown") is None
 
+    def test_forwards_similarity_threshold(self):
+        c = make_client()
+        c._request.return_value = {"count": 0, "results": []}
+        c.find_person_by_similarity("Jean Dupont", similarity_threshold=0.9)
+        _, kwargs = c._request.call_args
+        assert kwargs["params"] == {
+            "similarity": "Jean Dupont",
+            "similarity_threshold": 0.9,
+        }
+
 
 class TestUpsertPerson:
     def test_creates_when_not_found(self):
@@ -62,3 +90,21 @@ class TestUpsertPerson:
         result = c.upsert_person("Jean Dupont", first_name="Jean", last_name="Dupont")
         assert result["action"] == "updated"
         assert result["id"] == "existing"
+
+    def test_forwards_similarity_threshold_to_lookup(self):
+        c = make_client()
+        c._request.side_effect = [
+            {"count": 0, "results": []},  # similarity search
+            {"id": "new-uuid", "first_name": "Jean", "last_name": "Dupont"},  # create
+        ]
+        c.upsert_person(
+            "Jean Dupont",
+            first_name="Jean",
+            last_name="Dupont",
+            similarity_threshold=0.95,
+        )
+        lookup_call = c._request.call_args_list[0]
+        assert lookup_call.kwargs["params"] == {
+            "similarity": "Jean Dupont",
+            "similarity_threshold": 0.95,
+        }