rapidata 0.4.0__py3-none-any.whl → 0.5.0__py3-none-any.whl

rapidata/api_client/api/compare_workflow_api.py

@@ -0,0 +1,316 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictInt, StrictStr
+from typing import Optional
+from typing_extensions import Annotated
+from rapidata.api_client.models.compare_workflow_get_result_overview_get200_response import CompareWorkflowGetResultOverviewGet200Response
+
+from rapidata.api_client.api_client import ApiClient, RequestSerialized
+from rapidata.api_client.api_response import ApiResponse
+from rapidata.api_client.rest import RESTResponseType
+
+
+class CompareWorkflowApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def compare_workflow_get_result_overview_get(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
+        display_count: Annotated[Optional[StrictInt], Field(description="The number of datapoints to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> CompareWorkflowGetResultOverviewGet200Response:
+        """Get the result overview for a compare workflow.
+
+
+        :param workflow_id: The ID of the workflow. (required)
+        :type workflow_id: str
+        :param display_count: The number of datapoints to return.
+        :type display_count: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._compare_workflow_get_result_overview_get_serialize(
+            workflow_id=workflow_id,
+            display_count=display_count,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CompareWorkflowGetResultOverviewGet200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def compare_workflow_get_result_overview_get_with_http_info(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
+        display_count: Annotated[Optional[StrictInt], Field(description="The number of datapoints to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[CompareWorkflowGetResultOverviewGet200Response]:
+        """Get the result overview for a compare workflow.
+
+
+        :param workflow_id: The ID of the workflow. (required)
+        :type workflow_id: str
+        :param display_count: The number of datapoints to return.
+        :type display_count: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._compare_workflow_get_result_overview_get_serialize(
+            workflow_id=workflow_id,
+            display_count=display_count,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CompareWorkflowGetResultOverviewGet200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def compare_workflow_get_result_overview_get_without_preload_content(
+        self,
+        workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow.")],
+        display_count: Annotated[Optional[StrictInt], Field(description="The number of datapoints to return.")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Get the result overview for a compare workflow.
+
+
+        :param workflow_id: The ID of the workflow. (required)
+        :type workflow_id: str
+        :param display_count: The number of datapoints to return.
+        :type display_count: int
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._compare_workflow_get_result_overview_get_serialize(
+            workflow_id=workflow_id,
+            display_count=display_count,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "CompareWorkflowGetResultOverviewGet200Response",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _compare_workflow_get_result_overview_get_serialize(
+        self,
+        workflow_id,
+        display_count,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        if workflow_id is not None:
+            
+            _query_params.append(('WorkflowId', workflow_id))
+            
+        if display_count is not None:
+            
+            _query_params.append(('DisplayCount', display_count))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/CompareWorkflow/GetResultOverview',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

rapidata/api_client/api/dataset_api.py

@@ -47,7 +47,7 @@ class DatasetApi:
     @validate_call
     def dataset_create_datapoint_post(
         self,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to upload.")] = None,
         model: Optional[DatapointMetadataModel] = None,
         _request_timeout: Union[
             None,
@@ -66,7 +66,7 @@ class DatasetApi:
 
         If multiple files are uploaded, a multi asset datapoint will be created.
 
-        :param files:
+        :param files: The image files to upload.
         :type files: List[bytearray]
         :param model:
         :type model: DatapointMetadataModel
@@ -118,7 +118,7 @@ class DatasetApi:
     @validate_call
     def dataset_create_datapoint_post_with_http_info(
         self,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to upload.")] = None,
         model: Optional[DatapointMetadataModel] = None,
         _request_timeout: Union[
             None,
@@ -137,7 +137,7 @@ class DatasetApi:
 
         If multiple files are uploaded, a multi asset datapoint will be created.
 
-        :param files:
+        :param files: The image files to upload.
         :type files: List[bytearray]
         :param model:
         :type model: DatapointMetadataModel
@@ -189,7 +189,7 @@ class DatasetApi:
     @validate_call
     def dataset_create_datapoint_post_without_preload_content(
         self,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to upload.")] = None,
         model: Optional[DatapointMetadataModel] = None,
         _request_timeout: Union[
             None,
@@ -208,7 +208,7 @@ class DatasetApi:
 
         If multiple files are uploaded, a multi asset datapoint will be created.
 
-        :param files:
+        :param files: The image files to upload.
         :type files: List[bytearray]
         :param model:
         :type model: DatapointMetadataModel
@@ -602,7 +602,7 @@ class DatasetApi:
     def dataset_import_post(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to import the datapoints to.")] = None,
-        file: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
+        file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The csv file to import.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -621,7 +621,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to import the datapoints to.
         :type dataset_id: str
-        :param file:
+        :param file: The csv file to import.
         :type file: bytearray
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -672,7 +672,7 @@ class DatasetApi:
     def dataset_import_post_with_http_info(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to import the datapoints to.")] = None,
-        file: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
+        file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The csv file to import.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -691,7 +691,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to import the datapoints to.
         :type dataset_id: str
-        :param file:
+        :param file: The csv file to import.
         :type file: bytearray
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -742,7 +742,7 @@ class DatasetApi:
     def dataset_import_post_without_preload_content(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to import the datapoints to.")] = None,
-        file: Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]] = None,
+        file: Annotated[Optional[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]], Field(description="The csv file to import.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -761,7 +761,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to import the datapoints to.
         :type dataset_id: str
-        :param file:
+        :param file: The csv file to import.
         :type file: bytearray
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1162,7 +1162,7 @@ class DatasetApi:
     def dataset_upload_datapoint_post(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to upload the datapoint to.")] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to create the asset from.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1181,7 +1181,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to upload the datapoint to.
         :type dataset_id: str
-        :param files:
+        :param files: The image files to create the asset from.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1232,7 +1232,7 @@ class DatasetApi:
     def dataset_upload_datapoint_post_with_http_info(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to upload the datapoint to.")] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to create the asset from.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1251,7 +1251,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to upload the datapoint to.
         :type dataset_id: str
-        :param files:
+        :param files: The image files to create the asset from.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1302,7 +1302,7 @@ class DatasetApi:
     def dataset_upload_datapoint_post_without_preload_content(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to upload the datapoint to.")] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to create the asset from.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1321,7 +1321,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to upload the datapoint to.
         :type dataset_id: str
-        :param files:
+        :param files: The image files to create the asset from.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1731,7 +1731,7 @@ class DatasetApi:
     def dataset_upload_images_to_dataset_post(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to upload the images to.")] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to upload.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1751,7 +1751,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to upload the images to.
         :type dataset_id: str
-        :param files:
+        :param files: The image files to upload.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1802,7 +1802,7 @@ class DatasetApi:
     def dataset_upload_images_to_dataset_post_with_http_info(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to upload the images to.")] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to upload.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1822,7 +1822,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to upload the images to.
         :type dataset_id: str
-        :param files:
+        :param files: The image files to upload.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request
@@ -1873,7 +1873,7 @@ class DatasetApi:
     def dataset_upload_images_to_dataset_post_without_preload_content(
         self,
         dataset_id: Annotated[Optional[StrictStr], Field(description="The id of the dataset to upload the images to.")] = None,
-        files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
+        files: Annotated[Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]], Field(description="The image files to upload.")] = None,
         _request_timeout: Union[
             None,
             Annotated[StrictFloat, Field(gt=0)],
@@ -1893,7 +1893,7 @@ class DatasetApi:
 
         :param dataset_id: The id of the dataset to upload the images to.
         :type dataset_id: str
-        :param files:
+        :param files: The image files to upload.
         :type files: List[bytearray]
         :param _request_timeout: timeout setting for this request. If one
                                  number provided, it will be total request