Address PR feedback: fix typo, update docstrings, migrate parse_obj, add pagination, move tests

- Fix pg/pgp typo in test_get_priming_group_unknown_raises
- Update priming_group_id docstrings to reference self-service create_priming_group
- Replace deprecated parse_obj with model_validate across client, experimental_api, internalapi
- Add page/page_size params to list_detector_pipelines and list_priming_groups, returning paginated types
- Move test_priming_groups.py from test/unit to test/integration (tests hit real API)

Author: brandon-wada

src/groundlight/client.py

@@ -304,7 +304,7 @@ def get_detector(
             obj = self.detectors_api.get_detector(id=id, _request_timeout=request_timeout)
         except NotFoundException as e:
             raise NotFoundError(f"Detector with id '{id}' not found") from e
-        return Detector.parse_obj(obj.to_dict())
+        return Detector.model_validate(obj.to_dict())
 
     def get_detector_by_name(self, name: str) -> Detector:
         """
@@ -345,7 +345,7 @@ def list_detectors(self, page: int = 1, page_size: int = 10) -> PaginatedDetecto
         obj = self.detectors_api.list_detectors(
             page=page, page_size=page_size, _request_timeout=DEFAULT_REQUEST_TIMEOUT
         )
-        return PaginatedDetectorList.parse_obj(obj.to_dict())
+        return PaginatedDetectorList.model_validate(obj.to_dict())
 
     def _prep_create_detector(  # noqa: PLR0913 # pylint: disable=too-many-arguments, too-many-locals
         self,
@@ -457,8 +457,7 @@ def create_detector(  # noqa: PLR0913
         :param class_names: The name or names of the class to use for the detector. Only used for multi-class
                         and counting detectors.
         :param priming_group_id: Optional ID of an existing PrimingGroup to associate with this detector.
-                        PrimingGroup IDs are provided by Groundlight representatives. If you would like
-                        to use a priming_group_id, please reach out to your Groundlight representative.
+                        You can create a PrimingGroup using the ExperimentalApi's create_priming_group method.
 
         :return: The created Detector object
         """
@@ -631,7 +630,7 @@ def get_image_query(self, id: str) -> ImageQuery:  # pylint: disable=redefined-b
         if obj.result_type == "counting" and getattr(obj.result, "label", None):
             obj.result.pop("label")
             obj.result["count"] = None
-        iq = ImageQuery.parse_obj(obj.to_dict())
+        iq = ImageQuery.model_validate(obj.to_dict())
         return self._fixup_image_query(iq)
 
     def list_image_queries(
@@ -662,7 +661,7 @@ def list_image_queries(
         if detector_id:
             params["detector_id"] = detector_id
         obj = self.image_queries_api.list_image_queries(**params)
-        image_queries = PaginatedImageQueryList.parse_obj(obj.to_dict())
+        image_queries = PaginatedImageQueryList.model_validate(obj.to_dict())
         if image_queries.results is not None:
             image_queries.results = [self._fixup_image_query(iq) for iq in image_queries.results]
         return image_queries
@@ -835,7 +834,7 @@ def submit_image_query(  # noqa: PLR0913 # pylint: disable=too-many-arguments, t
             params["image_query_id"] = image_query_id
 
         raw_image_query = self.image_queries_api.submit_image_query(**params)
-        image_query = ImageQuery.parse_obj(raw_image_query.to_dict())
+        image_query = ImageQuery.model_validate(raw_image_query.to_dict())
 
         if wait > 0:
             if confidence_threshold is None:
@@ -1626,8 +1625,7 @@ def create_counting_detector(  # noqa: PLR0913 # pylint: disable=too-many-argume
                         information like location, purpose, or related system IDs. You can retrieve this
                         metadata later by calling `get_detector()`.
         :param priming_group_id: Optional ID of an existing PrimingGroup to associate with this detector.
-                        PrimingGroup IDs are provided by Groundlight representatives. If you would like
-                        to use a priming_group_id, please reach out to your Groundlight representative.
+                        You can create a PrimingGroup using the ExperimentalApi's create_priming_group method.
 
         :return: The created Detector object
         """
@@ -1652,7 +1650,7 @@ def create_counting_detector(  # noqa: PLR0913 # pylint: disable=too-many-argume
 
         detector_creation_input.mode_configuration = mode_config
         obj = self.detectors_api.create_detector(detector_creation_input, _request_timeout=DEFAULT_REQUEST_TIMEOUT)
-        return Detector.parse_obj(obj.to_dict())
+        return Detector.model_validate(obj.to_dict())
 
     def create_binary_detector(  # noqa: PLR0913 # pylint: disable=too-many-arguments, too-many-locals
         self,
@@ -1697,7 +1695,7 @@ def create_binary_detector(  # noqa: PLR0913 # pylint: disable=too-many-argument
             priming_group_id=priming_group_id,
         )
         obj = self.detectors_api.create_detector(detector_creation_input, _request_timeout=DEFAULT_REQUEST_TIMEOUT)
-        return Detector.parse_obj(obj.to_dict())
+        return Detector.model_validate(obj.to_dict())
 
     def create_multiclass_detector(  # noqa: PLR0913 # pylint: disable=too-many-arguments, too-many-locals
         self,
@@ -1749,8 +1747,7 @@ def create_multiclass_detector(  # noqa: PLR0913 # pylint: disable=too-many-argu
                         information like location, purpose, or related system IDs. You can retrieve this
                         metadata later by calling `get_detector()`.
         :param priming_group_id: Optional ID of an existing PrimingGroup to associate with this detector.
-                        PrimingGroup IDs are provided by Groundlight representatives. If you would like
-                        to use a priming_group_id, please reach out to your Groundlight representative.
+                        You can create a PrimingGroup using the ExperimentalApi's create_priming_group method.
 
         :return: The created Detector object
         """
@@ -1770,7 +1767,7 @@ def create_multiclass_detector(  # noqa: PLR0913 # pylint: disable=too-many-argu
         mode_config = MultiClassModeConfiguration(class_names=class_names)
         detector_creation_input.mode_configuration = mode_config
         obj = self.detectors_api.create_detector(detector_creation_input, _request_timeout=DEFAULT_REQUEST_TIMEOUT)
-        return Detector.parse_obj(obj.to_dict())
+        return Detector.model_validate(obj.to_dict())
 
     def create_bounding_box_detector(  # noqa: PLR0913 # pylint: disable=too-many-arguments, too-many-locals
         self,
@@ -1829,8 +1826,7 @@ def create_bounding_box_detector(  # noqa: PLR0913 # pylint: disable=too-many-ar
                         information like location, purpose, or related system IDs. You can retrieve this
                         metadata later by calling `get_detector()`.
         :param priming_group_id: Optional ID of an existing PrimingGroup to associate with this detector.
-                        PrimingGroup IDs are provided by Groundlight representatives. If you would like
-                        to use a priming_group_id, please reach out to your Groundlight representative.
+                        You can create a PrimingGroup using the ExperimentalApi's create_priming_group method.
 
         :return: The created Detector object
         """
@@ -1855,4 +1851,4 @@ def create_bounding_box_detector(  # noqa: PLR0913 # pylint: disable=too-many-ar
 
         detector_creation_input.mode_configuration = mode_config
         obj = self.detectors_api.create_detector(detector_creation_input, _request_timeout=DEFAULT_REQUEST_TIMEOUT)
-        return Detector.parse_obj(obj.to_dict())
+        return Detector.model_validate(obj.to_dict())

src/groundlight/experimental_api.py

@@ -39,6 +39,8 @@
     EdgeModelInfo,
     MLPipeline,
     ModeEnum,
+    PaginatedMLPipelineList,
+    PaginatedPrimingGroupList,
     PaginatedRuleList,
     PayloadTemplate,
     PrimingGroup,
@@ -477,7 +479,7 @@ def list_rules(self, page=1, page_size=10) -> PaginatedRuleList:
         :return: PaginatedRuleList containing the rules and pagination info
         """
         obj = self.actions_api.list_rules(page=page, page_size=page_size)
-        return PaginatedRuleList.parse_obj(obj.to_dict())
+        return PaginatedRuleList.model_validate(obj.to_dict())
 
     def delete_all_rules(self, detector: Union[None, str, Detector] = None) -> int:
         """
@@ -686,8 +688,7 @@ def create_text_recognition_detector(  # noqa: PLR0913 # pylint: disable=too-man
                         information like location, purpose, or related system IDs. You can retrieve this
                         metadata later by calling `get_detector()`.
         :param priming_group_id: Optional ID of an existing PrimingGroup to associate with this detector.
-                        PrimingGroup IDs are provided by Groundlight representatives. If you would like
-                        to use a priming_group_id, please reach out to your Groundlight representative.
+                        You can create a PrimingGroup using the ExperimentalApi's create_priming_group method.
 
         :return: The created Detector object
         """
@@ -708,7 +709,7 @@ def create_text_recognition_detector(  # noqa: PLR0913 # pylint: disable=too-man
 
         detector_creation_input.mode_configuration = mode_config
         obj = self.detectors_api.create_detector(detector_creation_input, _request_timeout=DEFAULT_REQUEST_TIMEOUT)
-        return Detector.parse_obj(obj.to_dict())
+        return Detector.model_validate(obj.to_dict())
 
     def _download_mlbinary_url(self, detector: Union[str, Detector]) -> EdgeModelInfo:
         """
@@ -718,7 +719,7 @@ def _download_mlbinary_url(self, detector: Union[str, Detector]) -> EdgeModelInf
         if isinstance(detector, Detector):
             detector = detector.id
         obj = self._edge_model_download_api.get_model_urls(detector)
-        return EdgeModelInfo.parse_obj(obj.to_dict())
+        return EdgeModelInfo.model_validate(obj.to_dict())
 
     def download_mlbinary(self, detector: Union[str, Detector], output_dir: str) -> None:
         """
@@ -840,7 +841,9 @@ def edge_base_url(self) -> str:
     # ML Pipeline methods
     # ---------------------------------------------------------------------------
 
-    def list_detector_pipelines(self, detector: Union[str, Detector]) -> List[MLPipeline]:
+    def list_detector_pipelines(
+        self, detector: Union[str, Detector], page: int = 1, page_size: int = 10
+    ) -> PaginatedMLPipelineList:
         """
         Lists all ML pipelines associated with a given detector.
 
@@ -852,25 +855,27 @@ def list_detector_pipelines(self, detector: Union[str, Detector]) -> List[MLPipe
             gl = ExperimentalApi()
             detector = gl.get_detector("det_abc123")
             pipelines = gl.list_detector_pipelines(detector)
-            for p in pipelines:
+            for p in pipelines.results:
                 if p.is_active_pipeline:
                     print(f"Active pipeline: {p.id}, config={p.pipeline_config}")
 
         :param detector: A Detector object or detector ID string.
-        :return: A list of MLPipeline objects for this detector.
+        :param page: The page number to retrieve (1-based indexing).
+        :param page_size: The number of pipelines to return per page.
+        :return: PaginatedMLPipelineList containing the requested page of pipelines and pagination metadata.
         """
         detector_id = detector.id if isinstance(detector, Detector) else detector
         try:
-            paginated_result = self.detectors_api.list_detector_pipelines(detector_id)
-            return [MLPipeline(**p.to_dict()) for p in paginated_result.results]
+            obj = self.detectors_api.list_detector_pipelines(detector_id, page=page, page_size=page_size)
+            return PaginatedMLPipelineList.model_validate(obj.to_dict())
         except NotFoundException as e:
             raise NotFoundError(f"Detector '{detector_id}' not found.") from e
 
     # ---------------------------------------------------------------------------
     # PrimingGroup methods
     # ---------------------------------------------------------------------------
 
-    def list_priming_groups(self) -> List[PrimingGroup]:
+    def list_priming_groups(self, page: int = 1, page_size: int = 10) -> PaginatedPrimingGroupList:
         """
         Lists all PrimingGroups owned by the authenticated user's account.
 
@@ -881,13 +886,15 @@ def list_priming_groups(self) -> List[PrimingGroup]:
 
             gl = ExperimentalApi()
             groups = gl.list_priming_groups()
-            for g in groups:
+            for g in groups.results:
                 print(f"{g.name}: {g.id}")
 
-        :return: A list of PrimingGroup objects.
+        :param page: The page number to retrieve (1-based indexing).
+        :param page_size: The number of priming groups to return per page.
+        :return: PaginatedPrimingGroupList containing the requested page of priming groups and pagination metadata.
         """
-        paginated_result = self.priming_groups_api.list_priming_groups()
-        return [PrimingGroup.parse_obj(pg.to_dict()) for pg in paginated_result.results]
+        obj = self.priming_groups_api.list_priming_groups(page=page, page_size=page_size)
+        return PaginatedPrimingGroupList.model_validate(obj.to_dict())
 
     def create_priming_group(
         self,
@@ -908,7 +915,7 @@ def create_priming_group(
             gl = ExperimentalApi()
             detector = gl.get_detector("det_abc123")
             pipelines = gl.list_detector_pipelines(detector)
-            active = next(p for p in pipelines if p.is_active_pipeline)
+            active = next(p for p in pipelines.results if p.is_active_pipeline)
 
             priming_group = gl.create_priming_group(
                 name="door-detector-primer",
@@ -933,7 +940,7 @@ def create_priming_group(
             disable_shadow_pipelines=disable_shadow_pipelines,
         )
         result = self.priming_groups_api.create_priming_group(request)
-        return PrimingGroup.parse_obj(result.to_dict())
+        return PrimingGroup.model_validate(result.to_dict())
 
     def get_priming_group(self, priming_group_id: str) -> PrimingGroup:
         """
@@ -950,7 +957,7 @@ def get_priming_group(self, priming_group_id: str) -> PrimingGroup:
         """
         try:
             result = self.priming_groups_api.get_priming_group(priming_group_id)
-            return PrimingGroup.parse_obj(result.to_dict())
+            return PrimingGroup.model_validate(result.to_dict())
         except NotFoundException as e:
             raise NotFoundError(f"PrimingGroup '{priming_group_id}' not found.") from e
         except ApiException as e:

src/groundlight/internalapi.py

@@ -248,7 +248,7 @@ def _get_detector_by_name(self, name: str) -> Detector:
             raise RuntimeError(
                 f"We found multiple ({parsed['count']}) detectors with the same name. This shouldn't happen.",
             )
-        return Detector.parse_obj(parsed["results"][0])
+        return Detector.model_validate(parsed["results"][0])
 
     @RequestsRetryDecorator()
     def start_inspection(self) -> str:

test/integration/test_groundlight.py

@@ -953,8 +953,7 @@ def test_create_detector_with_invalid_priming_group_id(gl: Groundlight, detector
     """
     Test that creating a detector with a non-existent priming_group_id returns an appropriate error.
 
-    Note: PrimingGroup IDs are provided by Groundlight representatives. If you would like to
-    use a priming_group_id, please reach out to your Groundlight representative.
+    Note: You can create a PrimingGroup using the ExperimentalApi's create_priming_group method.
     """
     name = detector_name("Test invalid priming")
     query = "Is there a dog?"

test/unit/test_priming_groups.py test/integration/test_priming_groups.pytest/unit/test_priming_groups.py renamed to test/integration/test_priming_groups.py

@@ -23,16 +23,15 @@
 def test_list_detector_pipelines_returns_list(gl_experimental: ExperimentalApi, detector):
     """A freshly created detector has at least one pipeline."""
     pipelines = gl_experimental.list_detector_pipelines(detector)
-    assert isinstance(pipelines, list)
-    assert len(pipelines) >= 1
-    assert all(isinstance(p, MLPipeline) for p in pipelines)
+    assert len(pipelines.results) >= 1
+    assert all(isinstance(p, MLPipeline) for p in pipelines.results)
 
 
 def test_list_detector_pipelines_accepts_detector_id_string(gl_experimental: ExperimentalApi, detector):
     """list_detector_pipelines should accept a raw ID string as well as a Detector object."""
     by_obj = gl_experimental.list_detector_pipelines(detector)
     by_id = gl_experimental.list_detector_pipelines(detector.id)
-    assert [p.id for p in by_obj] == [p.id for p in by_id]
+    assert [p.id for p in by_obj.results] == [p.id for p in by_id.results]
 
 
 def test_list_detector_pipelines_unknown_detector_raises(gl_experimental: ExperimentalApi):
@@ -47,8 +46,7 @@ def test_list_detector_pipelines_unknown_detector_raises(gl_experimental: Experi
 
 def test_list_priming_groups_returns_list(gl_experimental: ExperimentalApi):
     groups = gl_experimental.list_priming_groups()
-    assert isinstance(groups, list)
-    assert all(isinstance(g, PrimingGroup) for g in groups)
+    assert all(isinstance(g, PrimingGroup) for g in groups.results)
 
 
 # ---------------------------------------------------------------------------
@@ -75,7 +73,7 @@ def _wait_for_trained_pipeline(gl_experimental: ExperimentalApi, detector, timeo
     deadline = time.monotonic() + timeout
     while time.monotonic() < deadline:
         pipelines = gl_experimental.list_detector_pipelines(detector)
-        for p in pipelines:
+        for p in pipelines.results:
             if p.is_active_pipeline and p.trained_at is not None:
                 return p
         time.sleep(5)
@@ -137,7 +135,7 @@ def test_get_priming_group(gl_experimental: ExperimentalApi, detector):
 @pytest.mark.expensive
 def test_get_priming_group_unknown_raises(gl_experimental: ExperimentalApi):
     with pytest.raises(NotFoundError):
-        gl_experimental.get_priming_group("pgp_doesnotexist000000000000")
+        gl_experimental.get_priming_group("pg_doesnotexist000000000000")
 
 
 @pytest.mark.expensive
@@ -165,6 +163,6 @@ def test_created_priming_group_appears_in_list(gl_experimental: ExperimentalApi,
     )
 
     groups = gl_experimental.list_priming_groups()
-    assert any(g.id == pg.id for g in groups)
+    assert any(g.id == pg.id for g in groups.results)
 
     gl_experimental.delete_priming_group(pg.id)