edgeimpulse-api 1.95.16__tar.gz → 1.95.27__tar.gz

{edgeimpulse_api-1.95.16 → edgeimpulse_api-1.95.27}/PKG-INFO

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

{edgeimpulse_api-1.95.16 → edgeimpulse_api-1.95.27}/edgeimpulse_api/__init__.py

@@ -14,7 +14,7 @@
 
 from __future__ import absolute_import
 
-__version__ = "1.95.16" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
+__version__ = "1.95.27" #DO_NOT_CHANGE_REPLACED_BY_BUILD_SCRIPT
 
 # import apis into sdk package
 from edgeimpulse_api.api.classify_api import ClassifyApi
@@ -66,6 +66,10 @@ from edgeimpulse_api.models.ai_actions_operates_on import AIActionsOperatesOn
 from edgeimpulse_api.models.accept_eula_request import AcceptEulaRequest
 from edgeimpulse_api.models.activate_user_by_third_party_activation_code_request import ActivateUserByThirdPartyActivationCodeRequest
 from edgeimpulse_api.models.activate_user_or_verify_email_request import ActivateUserOrVerifyEmailRequest
+from edgeimpulse_api.models.actor_o_auth_client import ActorOAuthClient
+from edgeimpulse_api.models.actor_project_api_key import ActorProjectApiKey
+from edgeimpulse_api.models.actor_user import ActorUser
+from edgeimpulse_api.models.actor_user_all_of import ActorUserAllOf
 from edgeimpulse_api.models.add_api_key_request import AddApiKeyRequest
 from edgeimpulse_api.models.add_api_key_response import AddApiKeyResponse
 from edgeimpulse_api.models.add_api_key_response_all_of import AddApiKeyResponseAllOf
@@ -114,6 +118,7 @@ from edgeimpulse_api.models.admin_list_projects import AdminListProjects
 from edgeimpulse_api.models.admin_list_projects_response import AdminListProjectsResponse
 from edgeimpulse_api.models.admin_organization_info_response import AdminOrganizationInfoResponse
 from edgeimpulse_api.models.admin_organization_info_response_all_of import AdminOrganizationInfoResponseAllOf
+from edgeimpulse_api.models.admin_organization_info_response_all_of_extension_blocks import AdminOrganizationInfoResponseAllOfExtensionBlocks
 from edgeimpulse_api.models.admin_project_info_response import AdminProjectInfoResponse
 from edgeimpulse_api.models.admin_project_info_response_all_of import AdminProjectInfoResponseAllOf
 from edgeimpulse_api.models.admin_update_organization_data_export_request import AdminUpdateOrganizationDataExportRequest
@@ -274,6 +279,11 @@ from edgeimpulse_api.models.dataset_split_preview_response import DatasetSplitPr
 from edgeimpulse_api.models.dataset_split_preview_response_all_of import DatasetSplitPreviewResponseAllOf
 from edgeimpulse_api.models.dataset_split_preview_row import DatasetSplitPreviewRow
 from edgeimpulse_api.models.dataset_split_preview_section import DatasetSplitPreviewSection
+from edgeimpulse_api.models.dataset_version import DatasetVersion
+from edgeimpulse_api.models.dataset_version_actors_inner import DatasetVersionActorsInner
+from edgeimpulse_api.models.dataset_version_summary import DatasetVersionSummary
+from edgeimpulse_api.models.dataset_version_summary_action_counts import DatasetVersionSummaryActionCounts
+from edgeimpulse_api.models.dataset_version_type import DatasetVersionType
 from edgeimpulse_api.models.delete_portal_file_request import DeletePortalFileRequest
 from edgeimpulse_api.models.delete_user_request import DeleteUserRequest
 from edgeimpulse_api.models.dependency_data import DependencyData
@@ -740,6 +750,7 @@ from edgeimpulse_api.models.organization_dataset_bucket import OrganizationDatas
 from edgeimpulse_api.models.organization_dataset_type_enum import OrganizationDatasetTypeEnum
 from edgeimpulse_api.models.organization_deploy_block import OrganizationDeployBlock
 from edgeimpulse_api.models.organization_dsp_block import OrganizationDspBlock
+from edgeimpulse_api.models.organization_extension_settings import OrganizationExtensionSettings
 from edgeimpulse_api.models.organization_get_create_projects_response import OrganizationGetCreateProjectsResponse
 from edgeimpulse_api.models.organization_get_create_projects_response_all_of import OrganizationGetCreateProjectsResponseAllOf
 from edgeimpulse_api.models.organization_get_create_projects_response_all_of_jobs import OrganizationGetCreateProjectsResponseAllOfJobs
@@ -1016,6 +1027,7 @@ from edgeimpulse_api.models.update_organization_data_item_request import UpdateO
 from edgeimpulse_api.models.update_organization_dataset_request import UpdateOrganizationDatasetRequest
 from edgeimpulse_api.models.update_organization_dataset_request_bucket import UpdateOrganizationDatasetRequestBucket
 from edgeimpulse_api.models.update_organization_dsp_block_request import UpdateOrganizationDspBlockRequest
+from edgeimpulse_api.models.update_organization_extension_settings import UpdateOrganizationExtensionSettings
 from edgeimpulse_api.models.update_organization_portal_response import UpdateOrganizationPortalResponse
 from edgeimpulse_api.models.update_organization_portal_response_all_of import UpdateOrganizationPortalResponseAllOf
 from edgeimpulse_api.models.update_organization_request import UpdateOrganizationRequest
@@ -1048,6 +1060,7 @@ from edgeimpulse_api.models.user_experiment import UserExperiment
 from edgeimpulse_api.models.user_generate_new_mfa_key_response import UserGenerateNewMfaKeyResponse
 from edgeimpulse_api.models.user_generate_new_mfa_key_response_all_of import UserGenerateNewMfaKeyResponseAllOf
 from edgeimpulse_api.models.user_organization import UserOrganization
+from edgeimpulse_api.models.user_organization_extension_settings import UserOrganizationExtensionSettings
 from edgeimpulse_api.models.user_organization_public_project_license import UserOrganizationPublicProjectLicense
 from edgeimpulse_api.models.user_projects_sort_order import UserProjectsSortOrder
 from edgeimpulse_api.models.user_set_totp_mfa_key_request import UserSetTotpMfaKeyRequest

{edgeimpulse_api-1.95.16 → edgeimpulse_api-1.95.27}/edgeimpulse_api/api/projects_api.py

@@ -2703,7 +2703,7 @@ class ProjectsApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_project_data_axes_summary(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, **kwargs) -> ProjectDataAxesSummaryResponse:  # noqa: E501
+    def get_project_data_axes_summary(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, **kwargs) -> ProjectDataAxesSummaryResponse:  # noqa: E501
         """Get data axes summary
 
         Get a list of axes that are present in the training data.
@@ -2714,6 +2714,8 @@ class ProjectsApi(object):
         :type include_disabled: bool
         :param include_not_processed: Whether to include non-processed samples. Defaults to true
         :type include_not_processed: bool
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2730,10 +2732,10 @@ class ProjectsApi(object):
         :rtype: ProjectDataAxesSummaryResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._get_project_data_axes_summary_with_http_info(project_id, include_disabled, include_not_processed, **kwargs)  # noqa: E501
+        return self._get_project_data_axes_summary_with_http_info(project_id, include_disabled, include_not_processed, dataset_version_id, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _get_project_data_axes_summary_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, **kwargs):  # noqa: E501
+    def _get_project_data_axes_summary_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, **kwargs):  # noqa: E501
         """Get data axes summary
 
         Get a list of axes that are present in the training data.
@@ -2744,6 +2746,8 @@ class ProjectsApi(object):
         :type include_disabled: bool
         :param include_not_processed: Whether to include non-processed samples. Defaults to true
         :type include_not_processed: bool
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :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
@@ -2773,7 +2777,8 @@ class ProjectsApi(object):
         _all_params = [
             'project_id',
             'include_disabled',
-            'include_not_processed'
+            'include_not_processed',
+            'dataset_version_id'
         ]
         _all_params.extend(
             [
@@ -2810,6 +2815,8 @@ class ProjectsApi(object):
             _query_params.append(('includeDisabled', _params['include_disabled']))
         if _params.get('include_not_processed') is not None:  # noqa: E501
             _query_params.append(('includeNotProcessed', _params['include_not_processed']))
+        if _params.get('dataset_version_id') is not None:  # noqa: E501
+            _query_params.append(('datasetVersionId', _params['dataset_version_id']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
@@ -2850,7 +2857,7 @@ class ProjectsApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_project_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, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, **kwargs) -> ProjectInfoResponse:  # noqa: E501
+    def get_project_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, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, **kwargs) -> ProjectInfoResponse:  # noqa: E501
         """Project information
 
         List all information about this project.
@@ -2861,6 +2868,8 @@ class ProjectsApi(object):
         :type impulse_id: int
         :param truncate_labels: If true, only a slice of labels will be returned.
         :type truncate_labels: bool
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -2877,10 +2886,10 @@ class ProjectsApi(object):
         :rtype: ProjectInfoResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._get_project_info_with_http_info(project_id, impulse_id, truncate_labels, **kwargs)  # noqa: E501
+        return self._get_project_info_with_http_info(project_id, impulse_id, truncate_labels, dataset_version_id, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _get_project_info_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, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, **kwargs):  # noqa: E501
+    def _get_project_info_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, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, **kwargs):  # noqa: E501
         """Project information
 
         List all information about this project.
@@ -2891,6 +2900,8 @@ class ProjectsApi(object):
         :type impulse_id: int
         :param truncate_labels: If true, only a slice of labels will be returned.
         :type truncate_labels: bool
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :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
@@ -2920,7 +2931,8 @@ class ProjectsApi(object):
         _all_params = [
             'project_id',
             'impulse_id',
-            'truncate_labels'
+            'truncate_labels',
+            'dataset_version_id'
         ]
         _all_params.extend(
             [
@@ -2957,6 +2969,8 @@ class ProjectsApi(object):
             _query_params.append(('impulseId', _params['impulse_id']))
         if _params.get('truncate_labels') is not None:  # noqa: E501
             _query_params.append(('truncateLabels', _params['truncate_labels']))
+        if _params.get('dataset_version_id') is not None:  # noqa: E501
+            _query_params.append(('datasetVersionId', _params['dataset_version_id']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
@@ -3263,13 +3277,15 @@ class ProjectsApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_project_recommended_data_interval(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], **kwargs) -> ProjectDataIntervalResponse:  # noqa: E501
+    def get_project_recommended_data_interval(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, **kwargs) -> ProjectDataIntervalResponse:  # noqa: E501
         """Get the interval (in ms) of the training data
 
         Get the interval of the training data; if multiple intervals are present, the interval of the longest data item is returned. This only takes data in your _training_ set into account. 
 
         :param project_id: Project ID (required)
         :type project_id: int
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :param async_req: Whether to execute the request asynchronously.
         :type async_req: bool, optional
         :param _preload_content: if False, the urllib3.HTTPResponse object will
@@ -3286,16 +3302,18 @@ class ProjectsApi(object):
         :rtype: ProjectDataIntervalResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._get_project_recommended_data_interval_with_http_info(project_id, **kwargs)  # noqa: E501
+        return self._get_project_recommended_data_interval_with_http_info(project_id, dataset_version_id, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _get_project_recommended_data_interval_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], **kwargs):  # noqa: E501
+    def _get_project_recommended_data_interval_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, **kwargs):  # noqa: E501
         """Get the interval (in ms) of the training data
 
         Get the interval of the training data; if multiple intervals are present, the interval of the longest data item is returned. This only takes data in your _training_ set into account. 
 
         :param project_id: Project ID (required)
         :type project_id: int
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :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
@@ -3323,7 +3341,8 @@ class ProjectsApi(object):
         _params = locals()
 
         _all_params = [
-            'project_id'
+            'project_id',
+            'dataset_version_id'
         ]
         _all_params.extend(
             [
@@ -3356,6 +3375,8 @@ class ProjectsApi(object):
 
         # process the query parameters
         _query_params = []
+        if _params.get('dataset_version_id') is not None:  # noqa: E501
+            _query_params.append(('datasetVersionId', _params['dataset_version_id']))
 
         # process the header parameters
         _header_params = dict(_params.get('_headers', {}))
@@ -3396,7 +3417,7 @@ class ProjectsApi(object):
             _request_auth=_params.get('_request_auth'))
 
     @validate_arguments
-    def get_project_training_data_summary(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, **kwargs) -> ProjectTrainingDataSummaryResponse:  # noqa: E501
+    def get_project_training_data_summary(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, **kwargs) -> ProjectTrainingDataSummaryResponse:  # noqa: E501
         """Get data summary
 
         Get summary of all data present in the training set. This returns the number of data items, the total length of all data, and the labels. This is similar to `dataSummary` in `ProjectInfoResponse` but allows you to exclude disabled items or items that are still processing. 
@@ -3407,6 +3428,8 @@ class ProjectsApi(object):
         :type include_disabled: bool
         :param include_not_processed: Whether to include non-processed samples. Defaults to true
         :type include_not_processed: bool
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :param truncate_labels: If true, only a slice of labels will be returned.
         :type truncate_labels: bool
         :param async_req: Whether to execute the request asynchronously.
@@ -3425,10 +3448,10 @@ class ProjectsApi(object):
         :rtype: ProjectTrainingDataSummaryResponse
         """
         kwargs['_return_http_data_only'] = True
-        return self._get_project_training_data_summary_with_http_info(project_id, include_disabled, include_not_processed, truncate_labels, **kwargs)  # noqa: E501
+        return self._get_project_training_data_summary_with_http_info(project_id, include_disabled, include_not_processed, dataset_version_id, truncate_labels, **kwargs)  # noqa: E501
 
     @validate_arguments
-    def _get_project_training_data_summary_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, **kwargs):  # noqa: E501
+    def _get_project_training_data_summary_with_http_info(self, project_id : Annotated[StrictInt, Field(..., description="Project ID")], include_disabled : Annotated[Optional[StrictBool], Field(description="Whether to include disabled samples. Defaults to true")] = None, include_not_processed : Annotated[Optional[StrictBool], Field(description="Whether to include non-processed samples. Defaults to true")] = None, dataset_version_id : Annotated[Optional[StrictInt], Field(description="Dataset version ID. If not set, the current mutable dataset is used")] = None, truncate_labels : Annotated[Optional[StrictBool], Field(description="If true, only a slice of labels will be returned.")] = None, **kwargs):  # noqa: E501
         """Get data summary
 
         Get summary of all data present in the training set. This returns the number of data items, the total length of all data, and the labels. This is similar to `dataSummary` in `ProjectInfoResponse` but allows you to exclude disabled items or items that are still processing. 
@@ -3439,6 +3462,8 @@ class ProjectsApi(object):
         :type include_disabled: bool
         :param include_not_processed: Whether to include non-processed samples. Defaults to true
         :type include_not_processed: bool
+        :param dataset_version_id: Dataset version ID. If not set, the current mutable dataset is used
+        :type dataset_version_id: int
         :param truncate_labels: If true, only a slice of labels will be returned.
         :type truncate_labels: bool
         :param async_req: Whether to execute the request asynchronously.
@@ -3471,6 +3496,7 @@ class ProjectsApi(object):
             'project_id',
             'include_disabled',
             'include_not_processed',
+            'dataset_version_id',
             'truncate_labels'
         ]
         _all_params.extend(
@@ -3508,6 +3534,8 @@ class ProjectsApi(object):
             _query_params.append(('includeDisabled', _params['include_disabled']))
         if _params.get('include_not_processed') is not None:  # noqa: E501
             _query_params.append(('includeNotProcessed', _params['include_not_processed']))
+        if _params.get('dataset_version_id') is not None:  # noqa: E501
+            _query_params.append(('datasetVersionId', _params['dataset_version_id']))
         if _params.get('truncate_labels') is not None:  # noqa: E501
             _query_params.append(('truncateLabels', _params['truncate_labels']))