rapidata 2.28.4__py3-none-any.whl → 2.29.0__py3-none-any.whl

rapidata/api_client/api/customer_rapid_api.py

@@ -16,13 +16,15 @@ 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, StrictBytes, StrictStr
+from pydantic import Field, StrictBytes, StrictFloat, StrictInt, StrictStr
 from typing import List, Optional, Tuple, Union
 from typing_extensions import Annotated
 from rapidata.api_client.models.create_demographic_rapid_model import CreateDemographicRapidModel
 from rapidata.api_client.models.create_rapid_result import CreateRapidResult
 from rapidata.api_client.models.get_rapid_responses_result import GetRapidResponsesResult
+from rapidata.api_client.models.potential_validation_rapid_paged_result import PotentialValidationRapidPagedResult
 from rapidata.api_client.models.query_model import QueryModel
+from rapidata.api_client.models.query_validation_model import QueryValidationModel
 from rapidata.api_client.models.rapid_model_paged_result import RapidModelPagedResult
 from rapidata.api_client.models.update_validation_rapid_model import UpdateValidationRapidModel
 
@@ -44,6 +46,335 @@ class CustomerRapidApi:
         self.api_client = api_client
 
 
+    @validate_call
+    def rapid_correlation_id_validation_potential_get(
+        self,
+        correlation_id: Annotated[StrictStr, Field(description="The correlation id of the rapids to query, usually a workflow id.")],
+        request: Annotated[QueryValidationModel, Field(description="The query model containing the paging, filtering, and sorting information.")],
+        min_responses: Annotated[Optional[StrictInt], Field(description="The minimum number of responses a rapid should have to be considered eligible.")] = None,
+        min_confidence: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The minimum confidence a rapid should have to be considered eligible.")] = None,
+        target_group_id: Annotated[Optional[StrictStr], Field(description="A specific subgroup of rapids to target.")] = 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,
+    ) -> PotentialValidationRapidPagedResult:
+        """Queries rapids that are potentially eligible for validation set creation.
+
+
+        :param correlation_id: The correlation id of the rapids to query, usually a workflow id. (required)
+        :type correlation_id: str
+        :param request: The query model containing the paging, filtering, and sorting information. (required)
+        :type request: QueryValidationModel
+        :param min_responses: The minimum number of responses a rapid should have to be considered eligible.
+        :type min_responses: int
+        :param min_confidence: The minimum confidence a rapid should have to be considered eligible.
+        :type min_confidence: float
+        :param target_group_id: A specific subgroup of rapids to target.
+        :type target_group_id: str
+        :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._rapid_correlation_id_validation_potential_get_serialize(
+            correlation_id=correlation_id,
+            request=request,
+            min_responses=min_responses,
+            min_confidence=min_confidence,
+            target_group_id=target_group_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PotentialValidationRapidPagedResult",
+        }
+        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 rapid_correlation_id_validation_potential_get_with_http_info(
+        self,
+        correlation_id: Annotated[StrictStr, Field(description="The correlation id of the rapids to query, usually a workflow id.")],
+        request: Annotated[QueryValidationModel, Field(description="The query model containing the paging, filtering, and sorting information.")],
+        min_responses: Annotated[Optional[StrictInt], Field(description="The minimum number of responses a rapid should have to be considered eligible.")] = None,
+        min_confidence: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The minimum confidence a rapid should have to be considered eligible.")] = None,
+        target_group_id: Annotated[Optional[StrictStr], Field(description="A specific subgroup of rapids to target.")] = 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[PotentialValidationRapidPagedResult]:
+        """Queries rapids that are potentially eligible for validation set creation.
+
+
+        :param correlation_id: The correlation id of the rapids to query, usually a workflow id. (required)
+        :type correlation_id: str
+        :param request: The query model containing the paging, filtering, and sorting information. (required)
+        :type request: QueryValidationModel
+        :param min_responses: The minimum number of responses a rapid should have to be considered eligible.
+        :type min_responses: int
+        :param min_confidence: The minimum confidence a rapid should have to be considered eligible.
+        :type min_confidence: float
+        :param target_group_id: A specific subgroup of rapids to target.
+        :type target_group_id: str
+        :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._rapid_correlation_id_validation_potential_get_serialize(
+            correlation_id=correlation_id,
+            request=request,
+            min_responses=min_responses,
+            min_confidence=min_confidence,
+            target_group_id=target_group_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PotentialValidationRapidPagedResult",
+        }
+        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 rapid_correlation_id_validation_potential_get_without_preload_content(
+        self,
+        correlation_id: Annotated[StrictStr, Field(description="The correlation id of the rapids to query, usually a workflow id.")],
+        request: Annotated[QueryValidationModel, Field(description="The query model containing the paging, filtering, and sorting information.")],
+        min_responses: Annotated[Optional[StrictInt], Field(description="The minimum number of responses a rapid should have to be considered eligible.")] = None,
+        min_confidence: Annotated[Optional[Union[StrictFloat, StrictInt]], Field(description="The minimum confidence a rapid should have to be considered eligible.")] = None,
+        target_group_id: Annotated[Optional[StrictStr], Field(description="A specific subgroup of rapids to target.")] = 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:
+        """Queries rapids that are potentially eligible for validation set creation.
+
+
+        :param correlation_id: The correlation id of the rapids to query, usually a workflow id. (required)
+        :type correlation_id: str
+        :param request: The query model containing the paging, filtering, and sorting information. (required)
+        :type request: QueryValidationModel
+        :param min_responses: The minimum number of responses a rapid should have to be considered eligible.
+        :type min_responses: int
+        :param min_confidence: The minimum confidence a rapid should have to be considered eligible.
+        :type min_confidence: float
+        :param target_group_id: A specific subgroup of rapids to target.
+        :type target_group_id: str
+        :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._rapid_correlation_id_validation_potential_get_serialize(
+            correlation_id=correlation_id,
+            request=request,
+            min_responses=min_responses,
+            min_confidence=min_confidence,
+            target_group_id=target_group_id,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "PotentialValidationRapidPagedResult",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _rapid_correlation_id_validation_potential_get_serialize(
+        self,
+        correlation_id,
+        request,
+        min_responses,
+        min_confidence,
+        target_group_id,
+        _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
+        if correlation_id is not None:
+            _path_params['CorrelationId'] = correlation_id
+        # process the query parameters
+        if request is not None:
+            
+            _query_params.append(('Request', request))
+            
+        if min_responses is not None:
+            
+            _query_params.append(('MinResponses', min_responses))
+            
+        if min_confidence is not None:
+            
+            _query_params.append(('MinConfidence', min_confidence))
+            
+        if target_group_id is not None:
+            
+            _query_params.append(('TargetGroupId', target_group_id))
+            
+        # 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(
+                [
+                    'text/plain', 
+                    'application/json', 
+                    'text/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer', 
+            'oauth2'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/rapid/{correlationId}/validation-potential',
+            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
+        )
+
+
+
+
     @validate_call
     def rapid_demographic_post(
         self,