rapidata 2.7.1__py3-none-any.whl → 2.8.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of rapidata might be problematic. Click here for more details.
- rapidata/api_client/__init__.py +1 -0
- rapidata/api_client/api/dataset_api.py +31 -615
- rapidata/api_client/api/rapid_api.py +252 -0
- rapidata/api_client/api/workflow_api.py +280 -1
- rapidata/api_client/models/__init__.py +1 -0
- rapidata/api_client/models/add_campaign_model.py +1 -1
- rapidata/api_client/models/add_validation_rapid_model.py +2 -2
- rapidata/api_client/models/add_validation_text_rapid_model.py +2 -2
- rapidata/api_client/models/clients_query_result.py +3 -3
- rapidata/api_client/models/compare_workflow_model1.py +2 -2
- rapidata/api_client/models/coordinate.py +2 -2
- rapidata/api_client/models/datapoint.py +9 -2
- rapidata/api_client/models/datapoint_metadata_model.py +11 -4
- rapidata/api_client/models/get_compare_ab_summary_result.py +87 -0
- rapidata/api_client/models/order_model.py +1 -1
- rapidata/api_client/models/preliminary_download_model.py +2 -2
- rapidata/api_client/models/query_validation_rapids_result.py +1 -1
- rapidata/api_client/models/read_bridge_token_keys_result.py +6 -6
- rapidata/api_client/models/report_model.py +1 -1
- rapidata/api_client/models/simple_workflow_model1.py +2 -2
- rapidata/api_client/models/update_campaign_model.py +2 -2
- rapidata/api_client/models/update_validation_rapid_model.py +2 -2
- rapidata/api_client/models/upload_files_from_s3_bucket_model.py +3 -3
- rapidata/api_client/models/upload_text_sources_to_dataset_model.py +11 -4
- rapidata/api_client_README.md +3 -2
- rapidata/rapidata_client/assets/_media_asset.py +42 -28
- rapidata/rapidata_client/order/_rapidata_dataset.py +9 -7
- rapidata/rapidata_client/order/rapidata_order.py +9 -0
- rapidata/rapidata_client/order/rapidata_order_manager.py +3 -1
- rapidata/rapidata_client/validation/validation_set_manager.py +2 -1
- {rapidata-2.7.1.dist-info → rapidata-2.8.0.dist-info}/METADATA +1 -1
- {rapidata-2.7.1.dist-info → rapidata-2.8.0.dist-info}/RECORD +34 -33
- {rapidata-2.7.1.dist-info → rapidata-2.8.0.dist-info}/LICENSE +0 -0
- {rapidata-2.7.1.dist-info → rapidata-2.8.0.dist-info}/WHEEL +0 -0
|
@@ -873,6 +873,258 @@ class RapidApi:
|
|
|
873
873
|
|
|
874
874
|
|
|
875
875
|
|
|
876
|
+
@validate_call
|
|
877
|
+
def rapid_rapid_id_delete(
|
|
878
|
+
self,
|
|
879
|
+
rapid_id: Annotated[StrictStr, Field(description="The rapid to be deleted")],
|
|
880
|
+
_request_timeout: Union[
|
|
881
|
+
None,
|
|
882
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
883
|
+
Tuple[
|
|
884
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
885
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
886
|
+
]
|
|
887
|
+
] = None,
|
|
888
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
889
|
+
_content_type: Optional[StrictStr] = None,
|
|
890
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
891
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
892
|
+
) -> None:
|
|
893
|
+
"""Deletes a rapid.
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
:param rapid_id: The rapid to be deleted (required)
|
|
897
|
+
:type rapid_id: str
|
|
898
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
899
|
+
number provided, it will be total request
|
|
900
|
+
timeout. It can also be a pair (tuple) of
|
|
901
|
+
(connection, read) timeouts.
|
|
902
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
903
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
904
|
+
request; this effectively ignores the
|
|
905
|
+
authentication in the spec for a single request.
|
|
906
|
+
:type _request_auth: dict, optional
|
|
907
|
+
:param _content_type: force content-type for the request.
|
|
908
|
+
:type _content_type: str, Optional
|
|
909
|
+
:param _headers: set to override the headers for a single
|
|
910
|
+
request; this effectively ignores the headers
|
|
911
|
+
in the spec for a single request.
|
|
912
|
+
:type _headers: dict, optional
|
|
913
|
+
:param _host_index: set to override the host_index for a single
|
|
914
|
+
request; this effectively ignores the host_index
|
|
915
|
+
in the spec for a single request.
|
|
916
|
+
:type _host_index: int, optional
|
|
917
|
+
:return: Returns the result object.
|
|
918
|
+
""" # noqa: E501
|
|
919
|
+
|
|
920
|
+
_param = self._rapid_rapid_id_delete_serialize(
|
|
921
|
+
rapid_id=rapid_id,
|
|
922
|
+
_request_auth=_request_auth,
|
|
923
|
+
_content_type=_content_type,
|
|
924
|
+
_headers=_headers,
|
|
925
|
+
_host_index=_host_index
|
|
926
|
+
)
|
|
927
|
+
|
|
928
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
929
|
+
'200': None,
|
|
930
|
+
}
|
|
931
|
+
response_data = self.api_client.call_api(
|
|
932
|
+
*_param,
|
|
933
|
+
_request_timeout=_request_timeout
|
|
934
|
+
)
|
|
935
|
+
response_data.read()
|
|
936
|
+
return self.api_client.response_deserialize(
|
|
937
|
+
response_data=response_data,
|
|
938
|
+
response_types_map=_response_types_map,
|
|
939
|
+
).data
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
@validate_call
|
|
943
|
+
def rapid_rapid_id_delete_with_http_info(
|
|
944
|
+
self,
|
|
945
|
+
rapid_id: Annotated[StrictStr, Field(description="The rapid to be deleted")],
|
|
946
|
+
_request_timeout: Union[
|
|
947
|
+
None,
|
|
948
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
949
|
+
Tuple[
|
|
950
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
951
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
952
|
+
]
|
|
953
|
+
] = None,
|
|
954
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
955
|
+
_content_type: Optional[StrictStr] = None,
|
|
956
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
957
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
958
|
+
) -> ApiResponse[None]:
|
|
959
|
+
"""Deletes a rapid.
|
|
960
|
+
|
|
961
|
+
|
|
962
|
+
:param rapid_id: The rapid to be deleted (required)
|
|
963
|
+
:type rapid_id: str
|
|
964
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
965
|
+
number provided, it will be total request
|
|
966
|
+
timeout. It can also be a pair (tuple) of
|
|
967
|
+
(connection, read) timeouts.
|
|
968
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
969
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
970
|
+
request; this effectively ignores the
|
|
971
|
+
authentication in the spec for a single request.
|
|
972
|
+
:type _request_auth: dict, optional
|
|
973
|
+
:param _content_type: force content-type for the request.
|
|
974
|
+
:type _content_type: str, Optional
|
|
975
|
+
:param _headers: set to override the headers for a single
|
|
976
|
+
request; this effectively ignores the headers
|
|
977
|
+
in the spec for a single request.
|
|
978
|
+
:type _headers: dict, optional
|
|
979
|
+
:param _host_index: set to override the host_index for a single
|
|
980
|
+
request; this effectively ignores the host_index
|
|
981
|
+
in the spec for a single request.
|
|
982
|
+
:type _host_index: int, optional
|
|
983
|
+
:return: Returns the result object.
|
|
984
|
+
""" # noqa: E501
|
|
985
|
+
|
|
986
|
+
_param = self._rapid_rapid_id_delete_serialize(
|
|
987
|
+
rapid_id=rapid_id,
|
|
988
|
+
_request_auth=_request_auth,
|
|
989
|
+
_content_type=_content_type,
|
|
990
|
+
_headers=_headers,
|
|
991
|
+
_host_index=_host_index
|
|
992
|
+
)
|
|
993
|
+
|
|
994
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
995
|
+
'200': None,
|
|
996
|
+
}
|
|
997
|
+
response_data = self.api_client.call_api(
|
|
998
|
+
*_param,
|
|
999
|
+
_request_timeout=_request_timeout
|
|
1000
|
+
)
|
|
1001
|
+
response_data.read()
|
|
1002
|
+
return self.api_client.response_deserialize(
|
|
1003
|
+
response_data=response_data,
|
|
1004
|
+
response_types_map=_response_types_map,
|
|
1005
|
+
)
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
@validate_call
|
|
1009
|
+
def rapid_rapid_id_delete_without_preload_content(
|
|
1010
|
+
self,
|
|
1011
|
+
rapid_id: Annotated[StrictStr, Field(description="The rapid to be deleted")],
|
|
1012
|
+
_request_timeout: Union[
|
|
1013
|
+
None,
|
|
1014
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1015
|
+
Tuple[
|
|
1016
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1017
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1018
|
+
]
|
|
1019
|
+
] = None,
|
|
1020
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1021
|
+
_content_type: Optional[StrictStr] = None,
|
|
1022
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1023
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1024
|
+
) -> RESTResponseType:
|
|
1025
|
+
"""Deletes a rapid.
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
:param rapid_id: The rapid to be deleted (required)
|
|
1029
|
+
:type rapid_id: str
|
|
1030
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1031
|
+
number provided, it will be total request
|
|
1032
|
+
timeout. It can also be a pair (tuple) of
|
|
1033
|
+
(connection, read) timeouts.
|
|
1034
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1035
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1036
|
+
request; this effectively ignores the
|
|
1037
|
+
authentication in the spec for a single request.
|
|
1038
|
+
:type _request_auth: dict, optional
|
|
1039
|
+
:param _content_type: force content-type for the request.
|
|
1040
|
+
:type _content_type: str, Optional
|
|
1041
|
+
:param _headers: set to override the headers for a single
|
|
1042
|
+
request; this effectively ignores the headers
|
|
1043
|
+
in the spec for a single request.
|
|
1044
|
+
:type _headers: dict, optional
|
|
1045
|
+
:param _host_index: set to override the host_index for a single
|
|
1046
|
+
request; this effectively ignores the host_index
|
|
1047
|
+
in the spec for a single request.
|
|
1048
|
+
:type _host_index: int, optional
|
|
1049
|
+
:return: Returns the result object.
|
|
1050
|
+
""" # noqa: E501
|
|
1051
|
+
|
|
1052
|
+
_param = self._rapid_rapid_id_delete_serialize(
|
|
1053
|
+
rapid_id=rapid_id,
|
|
1054
|
+
_request_auth=_request_auth,
|
|
1055
|
+
_content_type=_content_type,
|
|
1056
|
+
_headers=_headers,
|
|
1057
|
+
_host_index=_host_index
|
|
1058
|
+
)
|
|
1059
|
+
|
|
1060
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1061
|
+
'200': None,
|
|
1062
|
+
}
|
|
1063
|
+
response_data = self.api_client.call_api(
|
|
1064
|
+
*_param,
|
|
1065
|
+
_request_timeout=_request_timeout
|
|
1066
|
+
)
|
|
1067
|
+
return response_data.response
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
def _rapid_rapid_id_delete_serialize(
|
|
1071
|
+
self,
|
|
1072
|
+
rapid_id,
|
|
1073
|
+
_request_auth,
|
|
1074
|
+
_content_type,
|
|
1075
|
+
_headers,
|
|
1076
|
+
_host_index,
|
|
1077
|
+
) -> RequestSerialized:
|
|
1078
|
+
|
|
1079
|
+
_host = None
|
|
1080
|
+
|
|
1081
|
+
_collection_formats: Dict[str, str] = {
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
_path_params: Dict[str, str] = {}
|
|
1085
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1086
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1087
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1088
|
+
_files: Dict[
|
|
1089
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1090
|
+
] = {}
|
|
1091
|
+
_body_params: Optional[bytes] = None
|
|
1092
|
+
|
|
1093
|
+
# process the path parameters
|
|
1094
|
+
if rapid_id is not None:
|
|
1095
|
+
_path_params['rapidId'] = rapid_id
|
|
1096
|
+
# process the query parameters
|
|
1097
|
+
# process the header parameters
|
|
1098
|
+
# process the form parameters
|
|
1099
|
+
# process the body parameter
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
# authentication setting
|
|
1105
|
+
_auth_settings: List[str] = [
|
|
1106
|
+
'bearer',
|
|
1107
|
+
'oauth2'
|
|
1108
|
+
]
|
|
1109
|
+
|
|
1110
|
+
return self.api_client.param_serialize(
|
|
1111
|
+
method='DELETE',
|
|
1112
|
+
resource_path='/rapid/{rapidId}',
|
|
1113
|
+
path_params=_path_params,
|
|
1114
|
+
query_params=_query_params,
|
|
1115
|
+
header_params=_header_params,
|
|
1116
|
+
body=_body_params,
|
|
1117
|
+
post_params=_form_params,
|
|
1118
|
+
files=_files,
|
|
1119
|
+
auth_settings=_auth_settings,
|
|
1120
|
+
collection_formats=_collection_formats,
|
|
1121
|
+
_host=_host,
|
|
1122
|
+
_request_auth=_request_auth
|
|
1123
|
+
)
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
|
|
876
1128
|
@validate_call
|
|
877
1129
|
def rapid_report_post(
|
|
878
1130
|
self,
|
|
@@ -16,9 +16,10 @@ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
|
16
16
|
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
17
17
|
from typing_extensions import Annotated
|
|
18
18
|
|
|
19
|
-
from pydantic import Field, StrictStr
|
|
19
|
+
from pydantic import Field, StrictBool, StrictStr
|
|
20
20
|
from typing import Optional
|
|
21
21
|
from typing_extensions import Annotated
|
|
22
|
+
from rapidata.api_client.models.get_compare_ab_summary_result import GetCompareAbSummaryResult
|
|
22
23
|
from rapidata.api_client.models.get_workflow_by_id_result import GetWorkflowByIdResult
|
|
23
24
|
from rapidata.api_client.models.get_workflow_progress_result import GetWorkflowProgressResult
|
|
24
25
|
from rapidata.api_client.models.i_workflow_model_paged_result import IWorkflowModelPagedResult
|
|
@@ -822,6 +823,284 @@ class WorkflowApi:
|
|
|
822
823
|
|
|
823
824
|
|
|
824
825
|
|
|
826
|
+
@validate_call
|
|
827
|
+
def workflow_id_compare_ab_summary_get(
|
|
828
|
+
self,
|
|
829
|
+
id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
|
|
830
|
+
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
831
|
+
_request_timeout: Union[
|
|
832
|
+
None,
|
|
833
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
834
|
+
Tuple[
|
|
835
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
836
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
837
|
+
]
|
|
838
|
+
] = None,
|
|
839
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
840
|
+
_content_type: Optional[StrictStr] = None,
|
|
841
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
842
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
843
|
+
) -> GetCompareAbSummaryResult:
|
|
844
|
+
"""Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
:param id: The ID of the workflow to get the summary for. (required)
|
|
848
|
+
:type id: str
|
|
849
|
+
:param use_user_score: Whether to use the user score to determine the winner.
|
|
850
|
+
:type use_user_score: bool
|
|
851
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
852
|
+
number provided, it will be total request
|
|
853
|
+
timeout. It can also be a pair (tuple) of
|
|
854
|
+
(connection, read) timeouts.
|
|
855
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
856
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
857
|
+
request; this effectively ignores the
|
|
858
|
+
authentication in the spec for a single request.
|
|
859
|
+
:type _request_auth: dict, optional
|
|
860
|
+
:param _content_type: force content-type for the request.
|
|
861
|
+
:type _content_type: str, Optional
|
|
862
|
+
:param _headers: set to override the headers for a single
|
|
863
|
+
request; this effectively ignores the headers
|
|
864
|
+
in the spec for a single request.
|
|
865
|
+
:type _headers: dict, optional
|
|
866
|
+
:param _host_index: set to override the host_index for a single
|
|
867
|
+
request; this effectively ignores the host_index
|
|
868
|
+
in the spec for a single request.
|
|
869
|
+
:type _host_index: int, optional
|
|
870
|
+
:return: Returns the result object.
|
|
871
|
+
""" # noqa: E501
|
|
872
|
+
|
|
873
|
+
_param = self._workflow_id_compare_ab_summary_get_serialize(
|
|
874
|
+
id=id,
|
|
875
|
+
use_user_score=use_user_score,
|
|
876
|
+
_request_auth=_request_auth,
|
|
877
|
+
_content_type=_content_type,
|
|
878
|
+
_headers=_headers,
|
|
879
|
+
_host_index=_host_index
|
|
880
|
+
)
|
|
881
|
+
|
|
882
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
883
|
+
'200': "GetCompareAbSummaryResult",
|
|
884
|
+
}
|
|
885
|
+
response_data = self.api_client.call_api(
|
|
886
|
+
*_param,
|
|
887
|
+
_request_timeout=_request_timeout
|
|
888
|
+
)
|
|
889
|
+
response_data.read()
|
|
890
|
+
return self.api_client.response_deserialize(
|
|
891
|
+
response_data=response_data,
|
|
892
|
+
response_types_map=_response_types_map,
|
|
893
|
+
).data
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
@validate_call
|
|
897
|
+
def workflow_id_compare_ab_summary_get_with_http_info(
|
|
898
|
+
self,
|
|
899
|
+
id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
|
|
900
|
+
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
901
|
+
_request_timeout: Union[
|
|
902
|
+
None,
|
|
903
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
904
|
+
Tuple[
|
|
905
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
906
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
907
|
+
]
|
|
908
|
+
] = None,
|
|
909
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
910
|
+
_content_type: Optional[StrictStr] = None,
|
|
911
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
912
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
913
|
+
) -> ApiResponse[GetCompareAbSummaryResult]:
|
|
914
|
+
"""Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
:param id: The ID of the workflow to get the summary for. (required)
|
|
918
|
+
:type id: str
|
|
919
|
+
:param use_user_score: Whether to use the user score to determine the winner.
|
|
920
|
+
:type use_user_score: bool
|
|
921
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
922
|
+
number provided, it will be total request
|
|
923
|
+
timeout. It can also be a pair (tuple) of
|
|
924
|
+
(connection, read) timeouts.
|
|
925
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
926
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
927
|
+
request; this effectively ignores the
|
|
928
|
+
authentication in the spec for a single request.
|
|
929
|
+
:type _request_auth: dict, optional
|
|
930
|
+
:param _content_type: force content-type for the request.
|
|
931
|
+
:type _content_type: str, Optional
|
|
932
|
+
:param _headers: set to override the headers for a single
|
|
933
|
+
request; this effectively ignores the headers
|
|
934
|
+
in the spec for a single request.
|
|
935
|
+
:type _headers: dict, optional
|
|
936
|
+
:param _host_index: set to override the host_index for a single
|
|
937
|
+
request; this effectively ignores the host_index
|
|
938
|
+
in the spec for a single request.
|
|
939
|
+
:type _host_index: int, optional
|
|
940
|
+
:return: Returns the result object.
|
|
941
|
+
""" # noqa: E501
|
|
942
|
+
|
|
943
|
+
_param = self._workflow_id_compare_ab_summary_get_serialize(
|
|
944
|
+
id=id,
|
|
945
|
+
use_user_score=use_user_score,
|
|
946
|
+
_request_auth=_request_auth,
|
|
947
|
+
_content_type=_content_type,
|
|
948
|
+
_headers=_headers,
|
|
949
|
+
_host_index=_host_index
|
|
950
|
+
)
|
|
951
|
+
|
|
952
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
953
|
+
'200': "GetCompareAbSummaryResult",
|
|
954
|
+
}
|
|
955
|
+
response_data = self.api_client.call_api(
|
|
956
|
+
*_param,
|
|
957
|
+
_request_timeout=_request_timeout
|
|
958
|
+
)
|
|
959
|
+
response_data.read()
|
|
960
|
+
return self.api_client.response_deserialize(
|
|
961
|
+
response_data=response_data,
|
|
962
|
+
response_types_map=_response_types_map,
|
|
963
|
+
)
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
@validate_call
|
|
967
|
+
def workflow_id_compare_ab_summary_get_without_preload_content(
|
|
968
|
+
self,
|
|
969
|
+
id: Annotated[StrictStr, Field(description="The ID of the workflow to get the summary for.")],
|
|
970
|
+
use_user_score: Annotated[Optional[StrictBool], Field(description="Whether to use the user score to determine the winner.")] = None,
|
|
971
|
+
_request_timeout: Union[
|
|
972
|
+
None,
|
|
973
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
974
|
+
Tuple[
|
|
975
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
976
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
977
|
+
]
|
|
978
|
+
] = None,
|
|
979
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
980
|
+
_content_type: Optional[StrictStr] = None,
|
|
981
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
982
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
983
|
+
) -> RESTResponseType:
|
|
984
|
+
"""Calculates a summary of the results for a simple compare workflow. The summary includes the number of times an asset at each index was the winner.
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
:param id: The ID of the workflow to get the summary for. (required)
|
|
988
|
+
:type id: str
|
|
989
|
+
:param use_user_score: Whether to use the user score to determine the winner.
|
|
990
|
+
:type use_user_score: bool
|
|
991
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
992
|
+
number provided, it will be total request
|
|
993
|
+
timeout. It can also be a pair (tuple) of
|
|
994
|
+
(connection, read) timeouts.
|
|
995
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
996
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
997
|
+
request; this effectively ignores the
|
|
998
|
+
authentication in the spec for a single request.
|
|
999
|
+
:type _request_auth: dict, optional
|
|
1000
|
+
:param _content_type: force content-type for the request.
|
|
1001
|
+
:type _content_type: str, Optional
|
|
1002
|
+
:param _headers: set to override the headers for a single
|
|
1003
|
+
request; this effectively ignores the headers
|
|
1004
|
+
in the spec for a single request.
|
|
1005
|
+
:type _headers: dict, optional
|
|
1006
|
+
:param _host_index: set to override the host_index for a single
|
|
1007
|
+
request; this effectively ignores the host_index
|
|
1008
|
+
in the spec for a single request.
|
|
1009
|
+
:type _host_index: int, optional
|
|
1010
|
+
:return: Returns the result object.
|
|
1011
|
+
""" # noqa: E501
|
|
1012
|
+
|
|
1013
|
+
_param = self._workflow_id_compare_ab_summary_get_serialize(
|
|
1014
|
+
id=id,
|
|
1015
|
+
use_user_score=use_user_score,
|
|
1016
|
+
_request_auth=_request_auth,
|
|
1017
|
+
_content_type=_content_type,
|
|
1018
|
+
_headers=_headers,
|
|
1019
|
+
_host_index=_host_index
|
|
1020
|
+
)
|
|
1021
|
+
|
|
1022
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1023
|
+
'200': "GetCompareAbSummaryResult",
|
|
1024
|
+
}
|
|
1025
|
+
response_data = self.api_client.call_api(
|
|
1026
|
+
*_param,
|
|
1027
|
+
_request_timeout=_request_timeout
|
|
1028
|
+
)
|
|
1029
|
+
return response_data.response
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
def _workflow_id_compare_ab_summary_get_serialize(
|
|
1033
|
+
self,
|
|
1034
|
+
id,
|
|
1035
|
+
use_user_score,
|
|
1036
|
+
_request_auth,
|
|
1037
|
+
_content_type,
|
|
1038
|
+
_headers,
|
|
1039
|
+
_host_index,
|
|
1040
|
+
) -> RequestSerialized:
|
|
1041
|
+
|
|
1042
|
+
_host = None
|
|
1043
|
+
|
|
1044
|
+
_collection_formats: Dict[str, str] = {
|
|
1045
|
+
}
|
|
1046
|
+
|
|
1047
|
+
_path_params: Dict[str, str] = {}
|
|
1048
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1049
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1050
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1051
|
+
_files: Dict[
|
|
1052
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1053
|
+
] = {}
|
|
1054
|
+
_body_params: Optional[bytes] = None
|
|
1055
|
+
|
|
1056
|
+
# process the path parameters
|
|
1057
|
+
if id is not None:
|
|
1058
|
+
_path_params['id'] = id
|
|
1059
|
+
# process the query parameters
|
|
1060
|
+
if use_user_score is not None:
|
|
1061
|
+
|
|
1062
|
+
_query_params.append(('useUserScore', use_user_score))
|
|
1063
|
+
|
|
1064
|
+
# process the header parameters
|
|
1065
|
+
# process the form parameters
|
|
1066
|
+
# process the body parameter
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
# set the HTTP header `Accept`
|
|
1070
|
+
if 'Accept' not in _header_params:
|
|
1071
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1072
|
+
[
|
|
1073
|
+
'text/plain',
|
|
1074
|
+
'application/json',
|
|
1075
|
+
'text/json'
|
|
1076
|
+
]
|
|
1077
|
+
)
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
# authentication setting
|
|
1081
|
+
_auth_settings: List[str] = [
|
|
1082
|
+
'bearer',
|
|
1083
|
+
'oauth2'
|
|
1084
|
+
]
|
|
1085
|
+
|
|
1086
|
+
return self.api_client.param_serialize(
|
|
1087
|
+
method='GET',
|
|
1088
|
+
resource_path='/workflow/{id}/compare-ab-summary',
|
|
1089
|
+
path_params=_path_params,
|
|
1090
|
+
query_params=_query_params,
|
|
1091
|
+
header_params=_header_params,
|
|
1092
|
+
body=_body_params,
|
|
1093
|
+
post_params=_form_params,
|
|
1094
|
+
files=_files,
|
|
1095
|
+
auth_settings=_auth_settings,
|
|
1096
|
+
collection_formats=_collection_formats,
|
|
1097
|
+
_host=_host,
|
|
1098
|
+
_request_auth=_request_auth
|
|
1099
|
+
)
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
|
|
825
1104
|
@validate_call
|
|
826
1105
|
def workflow_query_get(
|
|
827
1106
|
self,
|
|
@@ -124,6 +124,7 @@ from rapidata.api_client.models.free_text_result import FreeTextResult
|
|
|
124
124
|
from rapidata.api_client.models.gender import Gender
|
|
125
125
|
from rapidata.api_client.models.gender_user_filter_model import GenderUserFilterModel
|
|
126
126
|
from rapidata.api_client.models.get_available_validation_sets_result import GetAvailableValidationSetsResult
|
|
127
|
+
from rapidata.api_client.models.get_compare_ab_summary_result import GetCompareAbSummaryResult
|
|
127
128
|
from rapidata.api_client.models.get_compare_workflow_results_model import GetCompareWorkflowResultsModel
|
|
128
129
|
from rapidata.api_client.models.get_compare_workflow_results_result import GetCompareWorkflowResultsResult
|
|
129
130
|
from rapidata.api_client.models.get_compare_workflow_results_result_asset import GetCompareWorkflowResultsResultAsset
|
|
@@ -34,7 +34,7 @@ class AddCampaignModel(BaseModel):
|
|
|
34
34
|
campaign_name: StrictStr = Field(description="The name of the campaign.", alias="campaignName")
|
|
35
35
|
user_filters: List[CreateOrderModelUserFiltersInner] = Field(description="The user filters to apply to the campaign.", alias="userFilters")
|
|
36
36
|
validation_set_id: Optional[StrictStr] = Field(default=None, description="A validation set that should be used.", alias="validationSetId")
|
|
37
|
-
selections: Optional[List[AbTestSelectionAInner]] = Field(description="The selections that the campaign should have.")
|
|
37
|
+
selections: Optional[List[AbTestSelectionAInner]] = Field(default=None, description="The selections that the campaign should have.")
|
|
38
38
|
feature_flags: List[FeatureFlag] = Field(description="The feature flags that should be applied to the campaign.", alias="featureFlags")
|
|
39
39
|
priority: StrictInt = Field(description="The priority of the campaign.")
|
|
40
40
|
is_sticky: Optional[StrictBool] = Field(default=None, description="Indicates if the campaign is sticky.", alias="isSticky")
|
|
@@ -33,8 +33,8 @@ class AddValidationRapidModel(BaseModel):
|
|
|
33
33
|
payload: AddValidationRapidModelPayload
|
|
34
34
|
metadata: List[DatapointMetadataModelMetadataInner] = Field(description="Some metadata to attach to the rapid.")
|
|
35
35
|
truth: AddValidationRapidModelTruth
|
|
36
|
-
random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(description="The probability for an answer to be correct when randomly guessing.", alias="randomCorrectProbability")
|
|
37
|
-
explanation: Optional[StrictStr]
|
|
36
|
+
random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The probability for an answer to be correct when randomly guessing.", alias="randomCorrectProbability")
|
|
37
|
+
explanation: Optional[StrictStr] = Field(default=None, description="An explanation for the users if they answer the rapid incorrectly.")
|
|
38
38
|
__properties: ClassVar[List[str]] = ["validationSetId", "payload", "metadata", "truth", "randomCorrectProbability", "explanation"]
|
|
39
39
|
|
|
40
40
|
model_config = ConfigDict(
|
|
@@ -34,8 +34,8 @@ class AddValidationTextRapidModel(BaseModel):
|
|
|
34
34
|
metadata: List[DatapointMetadataModelMetadataInner] = Field(description="Some metadata to attach to the rapid.")
|
|
35
35
|
truth: AddValidationRapidModelTruth
|
|
36
36
|
texts: List[StrictStr] = Field(description="The texts to use for the rapid.")
|
|
37
|
-
random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(description="The probability for an answer to be correct when randomly guessing.", alias="randomCorrectProbability")
|
|
38
|
-
explanation: Optional[StrictStr]
|
|
37
|
+
random_correct_probability: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, description="The probability for an answer to be correct when randomly guessing.", alias="randomCorrectProbability")
|
|
38
|
+
explanation: Optional[StrictStr] = Field(default=None, description="An explanation for the users if they answer the rapid incorrectly.")
|
|
39
39
|
__properties: ClassVar[List[str]] = ["validationSetId", "payload", "metadata", "truth", "texts", "randomCorrectProbability", "explanation"]
|
|
40
40
|
|
|
41
41
|
model_config = ConfigDict(
|
|
@@ -27,9 +27,9 @@ class ClientsQueryResult(BaseModel):
|
|
|
27
27
|
"""
|
|
28
28
|
ClientsQueryResult
|
|
29
29
|
""" # noqa: E501
|
|
30
|
-
client_id: Optional[StrictStr] = Field(alias="clientId")
|
|
31
|
-
display_name: Optional[StrictStr] = Field(alias="displayName")
|
|
32
|
-
created_at: Optional[datetime] = Field(alias="createdAt")
|
|
30
|
+
client_id: Optional[StrictStr] = Field(default=None, alias="clientId")
|
|
31
|
+
display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
|
|
32
|
+
created_at: Optional[datetime] = Field(default=None, alias="createdAt")
|
|
33
33
|
__properties: ClassVar[List[str]] = ["clientId", "displayName", "createdAt"]
|
|
34
34
|
|
|
35
35
|
model_config = ConfigDict(
|
|
@@ -30,13 +30,13 @@ class CompareWorkflowModel1(BaseModel):
|
|
|
30
30
|
""" # noqa: E501
|
|
31
31
|
t: StrictStr = Field(description="Discriminator value for CompareWorkflowModel", alias="_t")
|
|
32
32
|
id: StrictStr
|
|
33
|
-
dataset_id: Optional[StrictStr] = Field(alias="datasetId")
|
|
33
|
+
dataset_id: Optional[StrictStr] = Field(default=None, alias="datasetId")
|
|
34
34
|
referee: CompareWorkflowModel1Referee
|
|
35
35
|
pair_maker_information: CompareWorkflowModel1PairMakerInformation = Field(alias="pairMakerInformation")
|
|
36
36
|
state: StrictStr
|
|
37
37
|
criteria: StrictStr
|
|
38
38
|
name: StrictStr
|
|
39
|
-
owner_mail: Optional[StrictStr] = Field(alias="ownerMail")
|
|
39
|
+
owner_mail: Optional[StrictStr] = Field(default=None, alias="ownerMail")
|
|
40
40
|
starting_elo: StrictInt = Field(alias="startingElo")
|
|
41
41
|
k_factor: StrictInt = Field(alias="kFactor")
|
|
42
42
|
scaling_factor: StrictInt = Field(alias="scalingFactor")
|
|
@@ -27,8 +27,8 @@ class Coordinate(BaseModel):
|
|
|
27
27
|
Coordinate
|
|
28
28
|
""" # noqa: E501
|
|
29
29
|
t: StrictStr = Field(description="Discriminator value for Coordinate", alias="_t")
|
|
30
|
-
x: Optional[Union[StrictFloat, StrictInt]]
|
|
31
|
-
y: Optional[Union[StrictFloat, StrictInt]]
|
|
30
|
+
x: Optional[Union[StrictFloat, StrictInt]] = None
|
|
31
|
+
y: Optional[Union[StrictFloat, StrictInt]] = None
|
|
32
32
|
__properties: ClassVar[List[str]] = ["_t", "x", "y"]
|
|
33
33
|
|
|
34
34
|
@field_validator('t')
|