edgeimpulse-api 1.96.0__tar.gz → 1.96.2__tar.gz

{edgeimpulse_api-1.96.0 → edgeimpulse_api-1.96.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: edgeimpulse-api
-Version: 1.96.0
+Version: 1.96.2
 Summary: Python bindings for the Edge Impulse API.
 Home-page: https://edgeimpulse.com
 License: BSD-3-Clause-Clear

{edgeimpulse_api-1.96.0 → edgeimpulse_api-1.96.2}/edgeimpulse_api/__init__.py

@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "1.96.0" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+__version__ = "1.96.2" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 
 # import apis into sdk package
 from edgeimpulse_api.api.classify_api import ClassifyApi

{edgeimpulse_api-1.96.0 → edgeimpulse_api-1.96.2}/edgeimpulse_api/api/classify_api.py

@@ -998,10 +998,10 @@ class ClassifyApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_classify_job_result(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], feature_explorer_only : Annotated[Optional[StrictBool], Field(description="Whether to get only the classification results relevant to the feature explorer.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, **kwargs) -> ClassifyJobResponse:  # noqa: E501
+    def get_classify_job_result(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], feature_explorer_only : Annotated[Optional[StrictBool], Field(description="Whether to get only the classification results relevant to the feature explorer.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs) -> ClassifyJobResponse:  # noqa: E501
         """Classify job result
 
-        Get classify job result, containing the result for the complete testing dataset.
+        Get classify job result, containing the result for the complete dataset.
 
         :param project_id: Project ID (required)
         :type project_id: int
@@ -1013,6 +1013,8 @@ class ClassifyApi(object):
         :type impulse_id: int
         :param truncate_structured_labels: If true, only a slice of labels will be returned for samples with multiple labels.
         :type truncate_structured_labels: bool
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1029,13 +1031,13 @@ class ClassifyApi(object):
         :rtype: ClassifyJobResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._get_classify_job_result_with_http_info(project_id, feature_explorer_only, variant, impulse_id, truncate_structured_labels, **kwargs)  # noqa: E501
+        return self._get_classify_job_result_with_http_info(project_id, feature_explorer_only, variant, impulse_id, truncate_structured_labels, category, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _get_classify_job_result_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], feature_explorer_only : Annotated[Optional[StrictBool], Field(description="Whether to get only the classification results relevant to the feature explorer.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, **kwargs):  # noqa: E501
+    def _get_classify_job_result_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], feature_explorer_only : Annotated[Optional[StrictBool], Field(description="Whether to get only the classification results relevant to the feature explorer.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs):  # noqa: E501
         """Classify job result
 
-        Get classify job result, containing the result for the complete testing dataset.
+        Get classify job result, containing the result for the complete dataset.
 
         :param project_id: Project ID (required)
         :type project_id: int
@@ -1047,6 +1049,8 @@ class ClassifyApi(object):
         :type impulse_id: int
         :param truncate_structured_labels: If true, only a slice of labels will be returned for samples with multiple labels.
         :type truncate_structured_labels: bool
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _return_http_data_only: response data without head status code
@@ -1078,7 +1082,8 @@ class ClassifyApi(object):
             'feature_explorer_only',
             'variant',
             'impulse_id',
-            'truncate_structured_labels'
+            'truncate_structured_labels',
+            'category'
         ]
         _all_params.extend(
             [
@@ -1119,6 +1124,8 @@ class ClassifyApi(object):
             _query_params.append(('impulseId', _params['impulse_id']))
         if _params.get('truncate_structured_labels') is not None:  # noqa: E501
             _query_params.append(('truncateStructuredLabels', _params['truncate_structured_labels']))
+        if _params.get('category') is not None:  # noqa: E501
+            _query_params.append(('category', _params['category']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
@@ -1159,7 +1166,7 @@ class ClassifyApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_classify_job_result_page(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results")] = None, offset : Annotated[Optional[StrictInt], Field(description="Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, labels : Annotated[Optional[StrictStr], Field(description="Only include samples with a label within the given list of labels, given as a JSON string")] = None, filename : Annotated[Optional[StrictStr], Field(description="Only include samples whose filename includes the given filename")] = None, max_length : Annotated[Optional[StrictInt], Field(description="Only include samples shorter than the given length, in milliseconds")] = None, min_length : Annotated[Optional[StrictInt], Field(description="Only include samples longer than the given length, in milliseconds")] = None, min_frequency : Annotated[Optional[float], Field(description="Only include samples with higher frequency than given frequency, in hertz")] = None, max_frequency : Annotated[Optional[float], Field(description="Only include samples with lower frequency than given frequency, in hertz")] = None, signature_validity : Annotated[Optional[StrictStr], Field(description="Include samples with either valid or invalid signatures")] = None, min_label : Annotated[Optional[float], Field(description="Only include samples with a label >= this value")] = None, max_label : Annotated[Optional[float], Field(description="Only include samples with a label < this value")] = None, search : Annotated[Optional[StrictStr], Field(description="Search query")] = None, data_type : Annotated[Optional[StrictStr], Field(description="Include only samples with a particular data type")] = None, min_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID >= this value")] = None, max_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID < this value")] = None, metadata : Annotated[Optional[StrictStr], Field(description="Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties:     - \"key\": Metadata key to filter on.     - \"op\": Operator (\"eq\" for positive match, \"neq\" for negative match).     - \"values\": (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified:     - { \"no_metadata\": boolean } - If true, include samples without any metadata     - { \"filters_combinator\": (\"and\" | \"or\") } - Specifies the combinator and matching mode:         - \"and\": All filter items must match (logical AND).         - \"or\": Any filter item may match (logical OR); samples with metadata keys not present in the filters are included. ")] = None, min_date : Annotated[Optional[datetime], Field(description="Only include samples that where added after the date given")] = None, max_date : Annotated[Optional[datetime], Field(description="Only include samples that were added before the date given")] = None, **kwargs) -> ClassifyJobResponsePage:  # noqa: E501
+    def get_classify_job_result_page(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results")] = None, offset : Annotated[Optional[StrictInt], Field(description="Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, labels : Annotated[Optional[StrictStr], Field(description="Only include samples with a label within the given list of labels, given as a JSON string")] = None, filename : Annotated[Optional[StrictStr], Field(description="Only include samples whose filename includes the given filename")] = None, max_length : Annotated[Optional[StrictInt], Field(description="Only include samples shorter than the given length, in milliseconds")] = None, min_length : Annotated[Optional[StrictInt], Field(description="Only include samples longer than the given length, in milliseconds")] = None, min_frequency : Annotated[Optional[float], Field(description="Only include samples with higher frequency than given frequency, in hertz")] = None, max_frequency : Annotated[Optional[float], Field(description="Only include samples with lower frequency than given frequency, in hertz")] = None, signature_validity : Annotated[Optional[StrictStr], Field(description="Include samples with either valid or invalid signatures")] = None, min_label : Annotated[Optional[float], Field(description="Only include samples with a label >= this value")] = None, max_label : Annotated[Optional[float], Field(description="Only include samples with a label < this value")] = None, search : Annotated[Optional[StrictStr], Field(description="Search query")] = None, data_type : Annotated[Optional[StrictStr], Field(description="Include only samples with a particular data type")] = None, min_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID >= this value")] = None, max_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID < this value")] = None, metadata : Annotated[Optional[StrictStr], Field(description="Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties:     - \"key\": Metadata key to filter on.     - \"op\": Operator (\"eq\" for positive match, \"neq\" for negative match).     - \"values\": (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified:     - { \"no_metadata\": boolean } - If true, include samples without any metadata     - { \"filters_combinator\": (\"and\" | \"or\") } - Specifies the combinator and matching mode:         - \"and\": All filter items must match (logical AND).         - \"or\": Any filter item may match (logical OR); samples with metadata keys not present in the filters are included. ")] = None, min_date : Annotated[Optional[datetime], Field(description="Only include samples that where added after the date given")] = None, max_date : Annotated[Optional[datetime], Field(description="Only include samples that were added before the date given")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs) -> ClassifyJobResponsePage:  # noqa: E501
         """Single page of a classify job result
 
         Get classify job result, containing the predictions for a given page.
@@ -1208,6 +1215,8 @@ class ClassifyApi(object):
         :type min_date: datetime
         :param max_date: Only include samples that were added before the date given
         :type max_date: datetime
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1224,10 +1233,10 @@ class ClassifyApi(object):
         :rtype: ClassifyJobResponsePage
         """
         kwargs['_return_http_data_only'] = True
-        return self._get_classify_job_result_page_with_http_info(project_id, limit, offset, variant, impulse_id, truncate_structured_labels, labels, filename, max_length, min_length, min_frequency, max_frequency, signature_validity, min_label, max_label, search, data_type, min_id, max_id, metadata, min_date, max_date, **kwargs)  # noqa: E501
+        return self._get_classify_job_result_page_with_http_info(project_id, limit, offset, variant, impulse_id, truncate_structured_labels, labels, filename, max_length, min_length, min_frequency, max_frequency, signature_validity, min_label, max_label, search, data_type, min_id, max_id, metadata, min_date, max_date, category, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _get_classify_job_result_page_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results")] = None, offset : Annotated[Optional[StrictInt], Field(description="Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, labels : Annotated[Optional[StrictStr], Field(description="Only include samples with a label within the given list of labels, given as a JSON string")] = None, filename : Annotated[Optional[StrictStr], Field(description="Only include samples whose filename includes the given filename")] = None, max_length : Annotated[Optional[StrictInt], Field(description="Only include samples shorter than the given length, in milliseconds")] = None, min_length : Annotated[Optional[StrictInt], Field(description="Only include samples longer than the given length, in milliseconds")] = None, min_frequency : Annotated[Optional[float], Field(description="Only include samples with higher frequency than given frequency, in hertz")] = None, max_frequency : Annotated[Optional[float], Field(description="Only include samples with lower frequency than given frequency, in hertz")] = None, signature_validity : Annotated[Optional[StrictStr], Field(description="Include samples with either valid or invalid signatures")] = None, min_label : Annotated[Optional[float], Field(description="Only include samples with a label >= this value")] = None, max_label : Annotated[Optional[float], Field(description="Only include samples with a label < this value")] = None, search : Annotated[Optional[StrictStr], Field(description="Search query")] = None, data_type : Annotated[Optional[StrictStr], Field(description="Include only samples with a particular data type")] = None, min_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID >= this value")] = None, max_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID < this value")] = None, metadata : Annotated[Optional[StrictStr], Field(description="Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties:     - \"key\": Metadata key to filter on.     - \"op\": Operator (\"eq\" for positive match, \"neq\" for negative match).     - \"values\": (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified:     - { \"no_metadata\": boolean } - If true, include samples without any metadata     - { \"filters_combinator\": (\"and\" | \"or\") } - Specifies the combinator and matching mode:         - \"and\": All filter items must match (logical AND).         - \"or\": Any filter item may match (logical OR); samples with metadata keys not present in the filters are included. ")] = None, min_date : Annotated[Optional[datetime], Field(description="Only include samples that where added after the date given")] = None, max_date : Annotated[Optional[datetime], Field(description="Only include samples that were added before the date given")] = None, **kwargs):  # noqa: E501
+    def _get_classify_job_result_page_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], limit : Annotated[Optional[StrictInt], Field(description="Maximum number of results")] = None, offset : Annotated[Optional[StrictInt], Field(description="Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.")] = None, variant : Annotated[Optional[KerasModelVariantEnum], Field(description="Keras model variant")] = None, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, truncate_structured_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned for samples with multiple labels.")] = None, labels : Annotated[Optional[StrictStr], Field(description="Only include samples with a label within the given list of labels, given as a JSON string")] = None, filename : Annotated[Optional[StrictStr], Field(description="Only include samples whose filename includes the given filename")] = None, max_length : Annotated[Optional[StrictInt], Field(description="Only include samples shorter than the given length, in milliseconds")] = None, min_length : Annotated[Optional[StrictInt], Field(description="Only include samples longer than the given length, in milliseconds")] = None, min_frequency : Annotated[Optional[float], Field(description="Only include samples with higher frequency than given frequency, in hertz")] = None, max_frequency : Annotated[Optional[float], Field(description="Only include samples with lower frequency than given frequency, in hertz")] = None, signature_validity : Annotated[Optional[StrictStr], Field(description="Include samples with either valid or invalid signatures")] = None, min_label : Annotated[Optional[float], Field(description="Only include samples with a label >= this value")] = None, max_label : Annotated[Optional[float], Field(description="Only include samples with a label < this value")] = None, search : Annotated[Optional[StrictStr], Field(description="Search query")] = None, data_type : Annotated[Optional[StrictStr], Field(description="Include only samples with a particular data type")] = None, min_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID >= this value")] = None, max_id : Annotated[Optional[StrictInt], Field(description="Include only samples with an ID < this value")] = None, metadata : Annotated[Optional[StrictStr], Field(description="Filter samples by metadata key-value pairs, provided as a JSON string. Each item in the filter list is an object with the following properties:     - \"key\": Metadata key to filter on.     - \"op\": Operator (\"eq\" for positive match, \"neq\" for negative match).     - \"values\": (optional) Array of values to match/exclude. If omitted or empty, matches/excludes all values for the key. In addition to filter objects, the following option objects can be specified:     - { \"no_metadata\": boolean } - If true, include samples without any metadata     - { \"filters_combinator\": (\"and\" | \"or\") } - Specifies the combinator and matching mode:         - \"and\": All filter items must match (logical AND).         - \"or\": Any filter item may match (logical OR); samples with metadata keys not present in the filters are included. ")] = None, min_date : Annotated[Optional[datetime], Field(description="Only include samples that where added after the date given")] = None, max_date : Annotated[Optional[datetime], Field(description="Only include samples that were added before the date given")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs):  # noqa: E501
         """Single page of a classify job result
 
         Get classify job result, containing the predictions for a given page.
@@ -1276,6 +1285,8 @@ class ClassifyApi(object):
         :type min_date: datetime
         :param max_date: Only include samples that were added before the date given
         :type max_date: datetime
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _return_http_data_only: response data without head status code
@@ -1324,7 +1335,8 @@ class ClassifyApi(object):
             'max_id',
             'metadata',
             'min_date',
-            'max_date'
+            'max_date',
+            'category'
         ]
         _all_params.extend(
             [
@@ -1399,6 +1411,8 @@ class ClassifyApi(object):
             _query_params.append(('minDate', _params['min_date']))
         if _params.get('max_date') is not None:  # noqa: E501
             _query_params.append(('maxDate', _params['max_date']))
+        if _params.get('category') is not None:  # noqa: E501
+            _query_params.append(('category', _params['category']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))

{edgeimpulse_api-1.96.0 → edgeimpulse_api-1.96.2}/edgeimpulse_api/api/impulse_api.py

@@ -1888,7 +1888,7 @@ class ImpulseApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def regenerate_model_testing_summary(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[StrictInt, Field(..., description="Impulse ID")], **kwargs) -> StartJobResponse:  # noqa: E501
+    def regenerate_model_testing_summary(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[StrictInt, Field(..., description="Impulse ID")], category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs) -> StartJobResponse:  # noqa: E501
         """Regenerate model testing summary
 
         Regenerate model testing results (without re-running feature generation). Use this if thresholds changed (e.g. via setImpulseThresholds), but no job was kicked off automatically.
@@ -1897,6 +1897,8 @@ class ImpulseApi(object):
         :type project_id: int
         :param impulse_id: Impulse ID (required)
         :type impulse_id: int
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -1913,10 +1915,10 @@ class ImpulseApi(object):
         :rtype: StartJobResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._regenerate_model_testing_summary_with_http_info(project_id, impulse_id, **kwargs)  # noqa: E501
+        return self._regenerate_model_testing_summary_with_http_info(project_id, impulse_id, category, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _regenerate_model_testing_summary_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[StrictInt, Field(..., description="Impulse ID")], **kwargs):  # noqa: E501
+    def _regenerate_model_testing_summary_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[StrictInt, Field(..., description="Impulse ID")], category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs):  # noqa: E501
         """Regenerate model testing summary
 
         Regenerate model testing results (without re-running feature generation). Use this if thresholds changed (e.g. via setImpulseThresholds), but no job was kicked off automatically.
@@ -1925,6 +1927,8 @@ class ImpulseApi(object):
         :type project_id: int
         :param impulse_id: Impulse ID (required)
         :type impulse_id: int
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _return_http_data_only: response data without head status code
@@ -1953,7 +1957,8 @@ class ImpulseApi(object):
 
         _all_params = [
             'project_id',
-            'impulse_id'
+            'impulse_id',
+            'category'
         ]
         _all_params.extend(
             [
@@ -1988,6 +1993,8 @@ class ImpulseApi(object):
 
         # process the query parameters
         _query_params = []
+        if _params.get('category') is not None:  # noqa: E501
+            _query_params.append(('category', _params['category']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))

{edgeimpulse_api-1.96.0 → edgeimpulse_api-1.96.2}/edgeimpulse_api/api/jobs_api.py

@@ -3919,10 +3919,10 @@ class JobsApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def start_classify_job(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], start_classify_job_request : StartClassifyJobRequest, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, **kwargs) -> StartJobResponse:  # noqa: E501
+    def start_classify_job(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], start_classify_job_request : StartClassifyJobRequest, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs) -> StartJobResponse:  # noqa: E501
         """Classify
 
-        Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API.
+        Classifies all items in the dataset against the current impulse. Updates are streamed over the websocket API.
 
         :param project_id: Project ID (required)
         :type project_id: int
@@ -3930,6 +3930,8 @@ class JobsApi(object):
         :type start_classify_job_request: StartClassifyJobRequest
         :param impulse_id: Impulse ID. If this is unset then the default impulse is used.
         :type impulse_id: int
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3946,13 +3948,13 @@ class JobsApi(object):
         :rtype: StartJobResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._start_classify_job_with_http_info(project_id, start_classify_job_request, impulse_id, **kwargs)  # noqa: E501
+        return self._start_classify_job_with_http_info(project_id, start_classify_job_request, impulse_id, category, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _start_classify_job_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], start_classify_job_request : StartClassifyJobRequest, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, **kwargs):  # noqa: E501
+    def _start_classify_job_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], start_classify_job_request : StartClassifyJobRequest, impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs):  # noqa: E501
         """Classify
 
-        Classifies all items in the testing dataset against the current impulse. Updates are streamed over the websocket API.
+        Classifies all items in the dataset against the current impulse. Updates are streamed over the websocket API.
 
         :param project_id: Project ID (required)
         :type project_id: int
@@ -3960,6 +3962,8 @@ class JobsApi(object):
         :type start_classify_job_request: StartClassifyJobRequest
         :param impulse_id: Impulse ID. If this is unset then the default impulse is used.
         :type impulse_id: int
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _return_http_data_only: response data without head status code
@@ -3989,7 +3993,8 @@ class JobsApi(object):
         _all_params = [
             'project_id',
             'start_classify_job_request',
-            'impulse_id'
+            'impulse_id',
+            'category'
         ]
         _all_params.extend(
             [
@@ -4024,6 +4029,8 @@ class JobsApi(object):
         _query_params = []
         if _params.get('impulse_id') is not None:  # noqa: E501
             _query_params.append(('impulseId', _params['impulse_id']))
+        if _params.get('category') is not None:  # noqa: E501
+            _query_params.append(('category', _params['category']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
@@ -4227,7 +4234,7 @@ class JobsApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def start_evaluate_job(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, **kwargs) -> StartJobResponse:  # noqa: E501
+    def start_evaluate_job(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs) -> StartJobResponse:  # noqa: E501
         """Evaluate
 
         Evaluates every variant of the current impulse. Updates are streamed over the websocket API.
@@ -4236,6 +4243,8 @@ class JobsApi(object):
         :type project_id: int
         :param impulse_id: Impulse ID. If this is unset then the default impulse is used.
         :type impulse_id: int
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -4252,10 +4261,10 @@ class JobsApi(object):
         :rtype: StartJobResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._start_evaluate_job_with_http_info(project_id, impulse_id, **kwargs)  # noqa: E501
+        return self._start_evaluate_job_with_http_info(project_id, impulse_id, category, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _start_evaluate_job_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, **kwargs):  # noqa: E501
+    def _start_evaluate_job_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], impulse_id : Annotated[Optional[StrictInt], Field(description="Impulse ID. If this is unset then the default impulse is used.")] = None, category : Annotated[Optional[StrictStr], Field(description="Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.")] = None, **kwargs):  # noqa: E501
         """Evaluate
 
         Evaluates every variant of the current impulse. Updates are streamed over the websocket API.
@@ -4264,6 +4273,8 @@ class JobsApi(object):
         :type project_id: int
         :param impulse_id: Impulse ID. If this is unset then the default impulse is used.
         :type impulse_id: int
+        :param category: Category to run model testing, or to retrieve results. If not provided, this will default to 'testing'.
+        :type category: str
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _return_http_data_only: response data without head status code
@@ -4292,7 +4303,8 @@ class JobsApi(object):
 
         _all_params = [
             'project_id',
-            'impulse_id'
+            'impulse_id',
+            'category'
         ]
         _all_params.extend(
             [
@@ -4327,6 +4339,8 @@ class JobsApi(object):
         _query_params = []
         if _params.get('impulse_id') is not None:  # noqa: E501
             _query_params.append(('impulseId', _params['impulse_id']))
+        if _params.get('category') is not None:  # noqa: E501
+            _query_params.append(('category', _params['category']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))

{edgeimpulse_api-1.96.0 → edgeimpulse_api-1.96.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "edgeimpulse-api"
-version = "1.96.0" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+version = "1.96.2" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 description = "Python bindings for the Edge Impulse API."
 authors = ["EdgeImpulse Inc. <hello@edgeimpulse.com>"]
 license = "BSD-3-Clause-Clear"