generate client code with done_processing included (#327)

Author: brandon-wada

generated/docs/ImageQuery.md

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
 **confidence_threshold** | **float** | Min confidence needed to accept the response of the image query. | [readonly] 
 **rois** | [**[ROI], none_type**](ROI.md) | An array of regions of interest (bounding boxes) collected on image | [readonly] 
 **text** | **str, none_type** | A text field on image query. | [readonly] 
+**done_processing** | **bool** | EDGE ONLY - Whether the image query has completed escalating and will receive no new results. | [optional]  if omitted the server will use the default value of False
 **any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional]
 
 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

generated/groundlight_openapi_client/model/image_query.py

@@ -159,6 +159,7 @@ def openapi_types():
                 str,
                 none_type,
             ),  # noqa: E501
+            "done_processing": (bool,),  # noqa: E501
         }
 
     @cached_property
@@ -178,6 +179,7 @@ def discriminator():
         "confidence_threshold": "confidence_threshold",  # noqa: E501
         "rois": "rois",  # noqa: E501
         "text": "text",  # noqa: E501
+        "done_processing": "done_processing",  # noqa: E501
     }
 
     read_only_vars = {
@@ -262,6 +264,7 @@ def _from_openapi_data(
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            done_processing (bool): EDGE ONLY - Whether the image query has completed escalating and will receive no new results.. [optional] if omitted the server will use the default value of False  # noqa: E501
         """
 
         _check_type = kwargs.pop("_check_type", True)
@@ -359,6 +362,7 @@ def __init__(self, result, *args, **kwargs):  # noqa: E501
                                 Animal class but this time we won't travel
                                 through its discriminator because we passed in
                                 _visited_composed_classes = (Animal,)
+            done_processing (bool): EDGE ONLY - Whether the image query has completed escalating and will receive no new results.. [optional] if omitted the server will use the default value of False  # noqa: E501
         """
 
         _check_type = kwargs.pop("_check_type", True)

generated/groundlight_openapi_client/model/patched_detector_request.py

@@ -8,7 +8,6 @@
     Generated by: https://openapi-generator.tech
 """
 
-
 import re  # noqa: F401
 import sys  # noqa: F401
 
@@ -25,7 +24,7 @@
     file_type,
     none_type,
     validate_get_composed_info,
-    OpenApiModel
+    OpenApiModel,
 )
 from groundlight_openapi_client.exceptions import ApiAttributeError
 
@@ -34,9 +33,10 @@ def lazy_import():
     from groundlight_openapi_client.model.blank_enum import BlankEnum
     from groundlight_openapi_client.model.escalation_type_enum import EscalationTypeEnum
     from groundlight_openapi_client.model.status_enum import StatusEnum
-    globals()['BlankEnum'] = BlankEnum
-    globals()['EscalationTypeEnum'] = EscalationTypeEnum
-    globals()['StatusEnum'] = StatusEnum
+
+    globals()["BlankEnum"] = BlankEnum
+    globals()["EscalationTypeEnum"] = EscalationTypeEnum
+    globals()["StatusEnum"] = StatusEnum
 
 
 class PatchedDetectorRequest(ModelNormal):
@@ -63,21 +63,20 @@ class PatchedDetectorRequest(ModelNormal):
           as additional properties values.
     """
 
-    allowed_values = {
-    }
+    allowed_values = {}
 
     validations = {
-        ('name',): {
-            'max_length': 200,
-            'min_length': 1,
+        ("name",): {
+            "max_length": 200,
+            "min_length": 1,
         },
-        ('confidence_threshold',): {
-            'inclusive_maximum': 1.0,
-            'inclusive_minimum': 0.0,
+        ("confidence_threshold",): {
+            "inclusive_maximum": 1.0,
+            "inclusive_minimum": 0.0,
         },
-        ('patience_time',): {
-            'inclusive_maximum': 3600,
-            'inclusive_minimum': 0,
+        ("patience_time",): {
+            "inclusive_maximum": 3600,
+            "inclusive_minimum": 0,
         },
     }
 
@@ -88,7 +87,17 @@ def additional_properties_type():
         of type self, this must run after the class is loaded
         """
         lazy_import()
-        return (bool, date, datetime, dict, float, int, list, str, none_type,)  # noqa: E501
+        return (
+            bool,
+            date,
+            datetime,
+            dict,
+            float,
+            int,
+            list,
+            str,
+            none_type,
+        )  # noqa: E501
 
     _nullable = False
 
@@ -104,28 +113,46 @@ def openapi_types():
         """
         lazy_import()
         return {
-            'name': (str,),  # noqa: E501
-            'confidence_threshold': (float,),  # noqa: E501
-            'patience_time': (float,),  # noqa: E501
-            'status': (bool, date, datetime, dict, float, int, list, str, none_type,),  # noqa: E501
-            'escalation_type': (bool, date, datetime, dict, float, int, list, str, none_type,),  # noqa: E501
+            "name": (str,),  # noqa: E501
+            "confidence_threshold": (float,),  # noqa: E501
+            "patience_time": (float,),  # noqa: E501
+            "status": (
+                bool,
+                date,
+                datetime,
+                dict,
+                float,
+                int,
+                list,
+                str,
+                none_type,
+            ),  # noqa: E501
+            "escalation_type": (
+                bool,
+                date,
+                datetime,
+                dict,
+                float,
+                int,
+                list,
+                str,
+                none_type,
+            ),  # noqa: E501
         }
 
     @cached_property
     def discriminator():
         return None
 
-
     attribute_map = {
-        'name': 'name',  # noqa: E501
-        'confidence_threshold': 'confidence_threshold',  # noqa: E501
-        'patience_time': 'patience_time',  # noqa: E501
-        'status': 'status',  # noqa: E501
-        'escalation_type': 'escalation_type',  # noqa: E501
+        "name": "name",  # noqa: E501
+        "confidence_threshold": "confidence_threshold",  # noqa: E501
+        "patience_time": "patience_time",  # noqa: E501
+        "status": "status",  # noqa: E501
+        "escalation_type": "escalation_type",  # noqa: E501
     }
 
-    read_only_vars = {
-    }
+    read_only_vars = {}
 
     _composed_schemas = {}
 
@@ -172,17 +199,18 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
             escalation_type (bool, date, datetime, dict, float, int, list, str, none_type): Category that define internal proccess for labeling image queries  * `STANDARD` - STANDARD * `NO_HUMAN_LABELING` - NO_HUMAN_LABELING. [optional]  # noqa: E501
         """
 
-        _check_type = kwargs.pop('_check_type', True)
-        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
-        _path_to_item = kwargs.pop('_path_to_item', ())
-        _configuration = kwargs.pop('_configuration', None)
-        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+        _check_type = kwargs.pop("_check_type", True)
+        _spec_property_naming = kwargs.pop("_spec_property_naming", False)
+        _path_to_item = kwargs.pop("_path_to_item", ())
+        _configuration = kwargs.pop("_configuration", None)
+        _visited_composed_classes = kwargs.pop("_visited_composed_classes", ())
 
         self = super(OpenApiModel, cls).__new__(cls)
 
         if args:
             raise ApiTypeError(
-                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments."
+                % (
                     args,
                     self.__class__.__name__,
                 ),
@@ -198,22 +226,24 @@ def _from_openapi_data(cls, *args, **kwargs):  # noqa: E501
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         for var_name, var_value in kwargs.items():
-            if var_name not in self.attribute_map and \
-                        self._configuration is not None and \
-                        self._configuration.discard_unknown_keys and \
-                        self.additional_properties_type is None:
+            if (
+                var_name not in self.attribute_map
+                and self._configuration is not None
+                and self._configuration.discard_unknown_keys
+                and self.additional_properties_type is None
+            ):
                 # discard variable.
                 continue
             setattr(self, var_name, var_value)
         return self
 
     required_properties = set([
-        '_data_store',
-        '_check_type',
-        '_spec_property_naming',
-        '_path_to_item',
-        '_configuration',
-        '_visited_composed_classes',
+        "_data_store",
+        "_check_type",
+        "_spec_property_naming",
+        "_path_to_item",
+        "_configuration",
+        "_visited_composed_classes",
     ])
 
     @convert_js_args_to_python_args
@@ -258,15 +288,16 @@ def __init__(self, *args, **kwargs):  # noqa: E501
             escalation_type (bool, date, datetime, dict, float, int, list, str, none_type): Category that define internal proccess for labeling image queries  * `STANDARD` - STANDARD * `NO_HUMAN_LABELING` - NO_HUMAN_LABELING. [optional]  # noqa: E501
         """
 
-        _check_type = kwargs.pop('_check_type', True)
-        _spec_property_naming = kwargs.pop('_spec_property_naming', False)
-        _path_to_item = kwargs.pop('_path_to_item', ())
-        _configuration = kwargs.pop('_configuration', None)
-        _visited_composed_classes = kwargs.pop('_visited_composed_classes', ())
+        _check_type = kwargs.pop("_check_type", True)
+        _spec_property_naming = kwargs.pop("_spec_property_naming", False)
+        _path_to_item = kwargs.pop("_path_to_item", ())
+        _configuration = kwargs.pop("_configuration", None)
+        _visited_composed_classes = kwargs.pop("_visited_composed_classes", ())
 
         if args:
             raise ApiTypeError(
-                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments." % (
+                "Invalid positional arguments=%s passed to %s. Remove those invalid positional arguments."
+                % (
                     args,
                     self.__class__.__name__,
                 ),
@@ -282,13 +313,17 @@ def __init__(self, *args, **kwargs):  # noqa: E501
         self._visited_composed_classes = _visited_composed_classes + (self.__class__,)
 
         for var_name, var_value in kwargs.items():
-            if var_name not in self.attribute_map and \
-                        self._configuration is not None and \
-                        self._configuration.discard_unknown_keys and \
-                        self.additional_properties_type is None:
+            if (
+                var_name not in self.attribute_map
+                and self._configuration is not None
+                and self._configuration.discard_unknown_keys
+                and self.additional_properties_type is None
+            ):
                 # discard variable.
                 continue
             setattr(self, var_name, var_value)
             if var_name in self.read_only_vars:
-                raise ApiAttributeError(f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
-                                     f"class with read only attributes.")
+                raise ApiAttributeError(
+                    f"`{var_name}` is a read-only attribute. Use `from_openapi_data` to instantiate "
+                    "class with read only attributes."
+                )

generated/model.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  public-api.yaml
-#   timestamp: 2025-03-05T22:46:43+00:00
+#   timestamp: 2025-03-11T18:57:57+00:00
 
 from __future__ import annotations
 
@@ -430,6 +430,10 @@ class ImageQuery(BaseModel):
         ..., description="An array of regions of interest (bounding boxes) collected on image"
     )
     text: Optional[str] = Field(..., description="A text field on image query.")
+    done_processing: bool = Field(
+        False,
+        description="EDGE ONLY - Whether the image query has completed escalating and will receive no new results.",
+    )
 
 
 class LabelValue(BaseModel):

spec/public-api.yaml

@@ -1100,6 +1100,11 @@ components:
           nullable: true
           readOnly: true
           description: A text field on image query.
+        done_processing:
+          type: boolean
+          default: false
+          description: EDGE ONLY - Whether the image query has completed escalating
+            and will receive no new results.
       required:
       - confidence_threshold
       - created_at
@@ -1759,4 +1764,4 @@ servers:
 - url: https://device.positronix.ai/device-api
   description: Device Prod
 - url: https://device.integ.positronix.ai/device-api
-  description: Device Integ
+  description: Device Integ