rapidata 2.14.1__py3-none-any.whl → 2.16.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.

Files changed (69) hide show
  1. rapidata/api_client/__init__.py +18 -7
  2. rapidata/api_client/api/__init__.py +2 -1
  3. rapidata/api_client/api/campaign_api.py +868 -92
  4. rapidata/api_client/api/client_api.py +292 -20
  5. rapidata/api_client/api/coco_api.py +594 -8
  6. rapidata/api_client/api/compare_workflow_api.py +23 -23
  7. rapidata/api_client/api/datapoint_api.py +548 -26
  8. rapidata/api_client/api/dataset_api.py +2198 -186
  9. rapidata/api_client/api/feedback_api.py +306 -0
  10. rapidata/api_client/api/identity_api.py +1143 -78
  11. rapidata/api_client/api/newsletter_api.py +299 -11
  12. rapidata/api_client/api/order_api.py +5570 -516
  13. rapidata/api_client/api/pipeline_api.py +263 -524
  14. rapidata/api_client/api/rapid_api.py +1930 -254
  15. rapidata/api_client/api/simple_workflow_api.py +23 -23
  16. rapidata/api_client/api/validation_api.py +283 -0
  17. rapidata/api_client/api/validation_set_api.py +5259 -0
  18. rapidata/api_client/api/workflow_api.py +929 -134
  19. rapidata/api_client/models/__init__.py +16 -6
  20. rapidata/api_client/models/ab_test_selection_a_inner.py +24 -10
  21. rapidata/api_client/models/add_campaign_model.py +9 -2
  22. rapidata/api_client/models/add_user_response_result.py +106 -0
  23. rapidata/api_client/models/add_user_response_result_validation_truth.py +258 -0
  24. rapidata/api_client/models/add_validation_rapid_model.py +3 -3
  25. rapidata/api_client/models/add_validation_text_rapid_model.py +3 -3
  26. rapidata/api_client/models/are_rapids_active_result.py +87 -0
  27. rapidata/api_client/models/campaign_query_result.py +2 -2
  28. rapidata/api_client/models/campaign_status.py +1 -0
  29. rapidata/api_client/models/compare_workflow_model.py +3 -3
  30. rapidata/api_client/models/create_datapoint_from_files_model.py +102 -0
  31. rapidata/api_client/models/create_datapoint_from_files_model_metadata_inner.py +168 -0
  32. rapidata/api_client/models/create_datapoint_from_text_sources_model.py +109 -0
  33. rapidata/api_client/models/create_datapoint_from_urls_model.py +4 -4
  34. rapidata/api_client/models/create_datapoints_from_s3_bucket_model.py +124 -0
  35. rapidata/api_client/models/create_order_model.py +15 -1
  36. rapidata/api_client/models/create_rapid_result.py +87 -0
  37. rapidata/api_client/models/create_validation_set_model.py +87 -0
  38. rapidata/api_client/models/datapoint_metadata_model.py +3 -3
  39. rapidata/api_client/models/evaluation_workflow_model.py +1 -1
  40. rapidata/api_client/models/get_validation_rapids_query.py +123 -0
  41. rapidata/api_client/models/get_validation_rapids_query_paged_result.py +105 -0
  42. rapidata/api_client/models/order_model.py +2 -2
  43. rapidata/api_client/models/order_state.py +1 -0
  44. rapidata/api_client/models/pipeline_id_workflow_artifact_id_put_request.py +140 -0
  45. rapidata/api_client/models/query_validation_rapids_result.py +3 -3
  46. rapidata/api_client/models/rapid_issue.py +4 -0
  47. rapidata/api_client/models/report_model.py +4 -4
  48. rapidata/api_client/models/shuffling_selection.py +106 -0
  49. rapidata/api_client/models/update_dataset_name_model.py +87 -0
  50. rapidata/api_client/models/update_dimensions_model.py +87 -0
  51. rapidata/api_client/models/update_order_name_model.py +87 -0
  52. rapidata/api_client/models/upload_text_sources_to_dataset_model.py +3 -3
  53. rapidata/api_client/models/user_score_user_filter_model.py +9 -2
  54. rapidata/api_client_README.md +154 -84
  55. rapidata/rapidata_client/demographic/demographic_manager.py +36 -1
  56. rapidata/rapidata_client/filter/user_score_filter.py +4 -1
  57. rapidata/rapidata_client/order/_rapidata_dataset.py +10 -11
  58. rapidata/rapidata_client/order/_rapidata_order_builder.py +3 -1
  59. rapidata/rapidata_client/order/rapidata_order.py +8 -10
  60. rapidata/rapidata_client/order/rapidata_order_manager.py +11 -2
  61. rapidata/rapidata_client/order/rapidata_results.py +1 -1
  62. rapidata/rapidata_client/validation/rapidata_validation_set.py +11 -0
  63. rapidata/rapidata_client/validation/rapids/rapids.py +3 -5
  64. rapidata/rapidata_client/validation/validation_set_manager.py +36 -21
  65. rapidata/rapidata_client/workflow/_ranking_workflow.py +2 -2
  66. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/METADATA +1 -1
  67. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/RECORD +69 -51
  68. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/LICENSE +0 -0
  69. {rapidata-2.14.1.dist-info → rapidata-2.16.0.dist-info}/WHEEL +0 -0
@@ -41,9 +41,9 @@ class SimpleWorkflowApi:
41
41
 
42
42
 
43
43
  @validate_call
44
- def workflow_simple_id_results_get(
44
+ def workflow_simple_workflow_id_results_get(
45
45
  self,
46
- id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")],
46
+ workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")],
47
47
  model: Annotated[Optional[GetSimpleWorkflowResultsModel], Field(description="The model for the request.")] = None,
48
48
  _request_timeout: Union[
49
49
  None,
@@ -61,8 +61,8 @@ class SimpleWorkflowApi:
61
61
  """Get the result overview for a simple workflow.
62
62
 
63
63
 
64
- :param id: The ID of the workflow to get the results for. (required)
65
- :type id: str
64
+ :param workflow_id: The ID of the workflow to get the results for. (required)
65
+ :type workflow_id: str
66
66
  :param model: The model for the request.
67
67
  :type model: GetSimpleWorkflowResultsModel
68
68
  :param _request_timeout: timeout setting for this request. If one
@@ -87,8 +87,8 @@ class SimpleWorkflowApi:
87
87
  :return: Returns the result object.
88
88
  """ # noqa: E501
89
89
 
90
- _param = self._workflow_simple_id_results_get_serialize(
91
- id=id,
90
+ _param = self._workflow_simple_workflow_id_results_get_serialize(
91
+ workflow_id=workflow_id,
92
92
  model=model,
93
93
  _request_auth=_request_auth,
94
94
  _content_type=_content_type,
@@ -111,9 +111,9 @@ class SimpleWorkflowApi:
111
111
 
112
112
 
113
113
  @validate_call
114
- def workflow_simple_id_results_get_with_http_info(
114
+ def workflow_simple_workflow_id_results_get_with_http_info(
115
115
  self,
116
- id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")],
116
+ workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")],
117
117
  model: Annotated[Optional[GetSimpleWorkflowResultsModel], Field(description="The model for the request.")] = None,
118
118
  _request_timeout: Union[
119
119
  None,
@@ -131,8 +131,8 @@ class SimpleWorkflowApi:
131
131
  """Get the result overview for a simple workflow.
132
132
 
133
133
 
134
- :param id: The ID of the workflow to get the results for. (required)
135
- :type id: str
134
+ :param workflow_id: The ID of the workflow to get the results for. (required)
135
+ :type workflow_id: str
136
136
  :param model: The model for the request.
137
137
  :type model: GetSimpleWorkflowResultsModel
138
138
  :param _request_timeout: timeout setting for this request. If one
@@ -157,8 +157,8 @@ class SimpleWorkflowApi:
157
157
  :return: Returns the result object.
158
158
  """ # noqa: E501
159
159
 
160
- _param = self._workflow_simple_id_results_get_serialize(
161
- id=id,
160
+ _param = self._workflow_simple_workflow_id_results_get_serialize(
161
+ workflow_id=workflow_id,
162
162
  model=model,
163
163
  _request_auth=_request_auth,
164
164
  _content_type=_content_type,
@@ -181,9 +181,9 @@ class SimpleWorkflowApi:
181
181
 
182
182
 
183
183
  @validate_call
184
- def workflow_simple_id_results_get_without_preload_content(
184
+ def workflow_simple_workflow_id_results_get_without_preload_content(
185
185
  self,
186
- id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")],
186
+ workflow_id: Annotated[StrictStr, Field(description="The ID of the workflow to get the results for.")],
187
187
  model: Annotated[Optional[GetSimpleWorkflowResultsModel], Field(description="The model for the request.")] = None,
188
188
  _request_timeout: Union[
189
189
  None,
@@ -201,8 +201,8 @@ class SimpleWorkflowApi:
201
201
  """Get the result overview for a simple workflow.
202
202
 
203
203
 
204
- :param id: The ID of the workflow to get the results for. (required)
205
- :type id: str
204
+ :param workflow_id: The ID of the workflow to get the results for. (required)
205
+ :type workflow_id: str
206
206
  :param model: The model for the request.
207
207
  :type model: GetSimpleWorkflowResultsModel
208
208
  :param _request_timeout: timeout setting for this request. If one
@@ -227,8 +227,8 @@ class SimpleWorkflowApi:
227
227
  :return: Returns the result object.
228
228
  """ # noqa: E501
229
229
 
230
- _param = self._workflow_simple_id_results_get_serialize(
231
- id=id,
230
+ _param = self._workflow_simple_workflow_id_results_get_serialize(
231
+ workflow_id=workflow_id,
232
232
  model=model,
233
233
  _request_auth=_request_auth,
234
234
  _content_type=_content_type,
@@ -246,9 +246,9 @@ class SimpleWorkflowApi:
246
246
  return response_data.response
247
247
 
248
248
 
249
- def _workflow_simple_id_results_get_serialize(
249
+ def _workflow_simple_workflow_id_results_get_serialize(
250
250
  self,
251
- id,
251
+ workflow_id,
252
252
  model,
253
253
  _request_auth,
254
254
  _content_type,
@@ -271,8 +271,8 @@ class SimpleWorkflowApi:
271
271
  _body_params: Optional[bytes] = None
272
272
 
273
273
  # process the path parameters
274
- if id is not None:
275
- _path_params['id'] = id
274
+ if workflow_id is not None:
275
+ _path_params['workflowId'] = workflow_id
276
276
  # process the query parameters
277
277
  if model is not None:
278
278
 
@@ -302,7 +302,7 @@ class SimpleWorkflowApi:
302
302
 
303
303
  return self.api_client.param_serialize(
304
304
  method='GET',
305
- resource_path='/workflow/simple/{id}/results',
305
+ resource_path='/workflow/simple/{workflowId}/results',
306
306
  path_params=_path_params,
307
307
  query_params=_query_params,
308
308
  header_params=_header_params,
@@ -27,6 +27,7 @@ from rapidata.api_client.models.get_available_validation_sets_result import GetA
27
27
  from rapidata.api_client.models.get_validation_set_by_id_result import GetValidationSetByIdResult
28
28
  from rapidata.api_client.models.import_validation_set_from_file_result import ImportValidationSetFromFileResult
29
29
  from rapidata.api_client.models.query_model import QueryModel
30
+ from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
30
31
  from rapidata.api_client.models.validation_import_post_request_blueprint import ValidationImportPostRequestBlueprint
31
32
  from rapidata.api_client.models.validation_set_model_paged_result import ValidationSetModelPagedResult
32
33
 
@@ -2195,3 +2196,285 @@ class ValidationApi:
2195
2196
  )
2196
2197
 
2197
2198
 
2199
+
2200
+
2201
+ @validate_call
2202
+ def validation_validation_set_id_dimensions_patch(
2203
+ self,
2204
+ validation_set_id: StrictStr,
2205
+ update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The model containing the dimensions")] = None,
2206
+ _request_timeout: Union[
2207
+ None,
2208
+ Annotated[StrictFloat, Field(gt=0)],
2209
+ Tuple[
2210
+ Annotated[StrictFloat, Field(gt=0)],
2211
+ Annotated[StrictFloat, Field(gt=0)]
2212
+ ]
2213
+ ] = None,
2214
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2215
+ _content_type: Optional[StrictStr] = None,
2216
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2217
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2218
+ ) -> None:
2219
+ """Updates the dimensions of all rapids within a validation set.
2220
+
2221
+
2222
+ :param validation_set_id: (required)
2223
+ :type validation_set_id: str
2224
+ :param update_dimensions_model: The model containing the dimensions
2225
+ :type update_dimensions_model: UpdateDimensionsModel
2226
+ :param _request_timeout: timeout setting for this request. If one
2227
+ number provided, it will be total request
2228
+ timeout. It can also be a pair (tuple) of
2229
+ (connection, read) timeouts.
2230
+ :type _request_timeout: int, tuple(int, int), optional
2231
+ :param _request_auth: set to override the auth_settings for an a single
2232
+ request; this effectively ignores the
2233
+ authentication in the spec for a single request.
2234
+ :type _request_auth: dict, optional
2235
+ :param _content_type: force content-type for the request.
2236
+ :type _content_type: str, Optional
2237
+ :param _headers: set to override the headers for a single
2238
+ request; this effectively ignores the headers
2239
+ in the spec for a single request.
2240
+ :type _headers: dict, optional
2241
+ :param _host_index: set to override the host_index for a single
2242
+ request; this effectively ignores the host_index
2243
+ in the spec for a single request.
2244
+ :type _host_index: int, optional
2245
+ :return: Returns the result object.
2246
+ """ # noqa: E501
2247
+
2248
+ _param = self._validation_validation_set_id_dimensions_patch_serialize(
2249
+ validation_set_id=validation_set_id,
2250
+ update_dimensions_model=update_dimensions_model,
2251
+ _request_auth=_request_auth,
2252
+ _content_type=_content_type,
2253
+ _headers=_headers,
2254
+ _host_index=_host_index
2255
+ )
2256
+
2257
+ _response_types_map: Dict[str, Optional[str]] = {
2258
+ '200': None,
2259
+ }
2260
+ response_data = self.api_client.call_api(
2261
+ *_param,
2262
+ _request_timeout=_request_timeout
2263
+ )
2264
+ response_data.read()
2265
+ return self.api_client.response_deserialize(
2266
+ response_data=response_data,
2267
+ response_types_map=_response_types_map,
2268
+ ).data
2269
+
2270
+
2271
+ @validate_call
2272
+ def validation_validation_set_id_dimensions_patch_with_http_info(
2273
+ self,
2274
+ validation_set_id: StrictStr,
2275
+ update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The model containing the dimensions")] = None,
2276
+ _request_timeout: Union[
2277
+ None,
2278
+ Annotated[StrictFloat, Field(gt=0)],
2279
+ Tuple[
2280
+ Annotated[StrictFloat, Field(gt=0)],
2281
+ Annotated[StrictFloat, Field(gt=0)]
2282
+ ]
2283
+ ] = None,
2284
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2285
+ _content_type: Optional[StrictStr] = None,
2286
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2287
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2288
+ ) -> ApiResponse[None]:
2289
+ """Updates the dimensions of all rapids within a validation set.
2290
+
2291
+
2292
+ :param validation_set_id: (required)
2293
+ :type validation_set_id: str
2294
+ :param update_dimensions_model: The model containing the dimensions
2295
+ :type update_dimensions_model: UpdateDimensionsModel
2296
+ :param _request_timeout: timeout setting for this request. If one
2297
+ number provided, it will be total request
2298
+ timeout. It can also be a pair (tuple) of
2299
+ (connection, read) timeouts.
2300
+ :type _request_timeout: int, tuple(int, int), optional
2301
+ :param _request_auth: set to override the auth_settings for an a single
2302
+ request; this effectively ignores the
2303
+ authentication in the spec for a single request.
2304
+ :type _request_auth: dict, optional
2305
+ :param _content_type: force content-type for the request.
2306
+ :type _content_type: str, Optional
2307
+ :param _headers: set to override the headers for a single
2308
+ request; this effectively ignores the headers
2309
+ in the spec for a single request.
2310
+ :type _headers: dict, optional
2311
+ :param _host_index: set to override the host_index for a single
2312
+ request; this effectively ignores the host_index
2313
+ in the spec for a single request.
2314
+ :type _host_index: int, optional
2315
+ :return: Returns the result object.
2316
+ """ # noqa: E501
2317
+
2318
+ _param = self._validation_validation_set_id_dimensions_patch_serialize(
2319
+ validation_set_id=validation_set_id,
2320
+ update_dimensions_model=update_dimensions_model,
2321
+ _request_auth=_request_auth,
2322
+ _content_type=_content_type,
2323
+ _headers=_headers,
2324
+ _host_index=_host_index
2325
+ )
2326
+
2327
+ _response_types_map: Dict[str, Optional[str]] = {
2328
+ '200': None,
2329
+ }
2330
+ response_data = self.api_client.call_api(
2331
+ *_param,
2332
+ _request_timeout=_request_timeout
2333
+ )
2334
+ response_data.read()
2335
+ return self.api_client.response_deserialize(
2336
+ response_data=response_data,
2337
+ response_types_map=_response_types_map,
2338
+ )
2339
+
2340
+
2341
+ @validate_call
2342
+ def validation_validation_set_id_dimensions_patch_without_preload_content(
2343
+ self,
2344
+ validation_set_id: StrictStr,
2345
+ update_dimensions_model: Annotated[Optional[UpdateDimensionsModel], Field(description="The model containing the dimensions")] = None,
2346
+ _request_timeout: Union[
2347
+ None,
2348
+ Annotated[StrictFloat, Field(gt=0)],
2349
+ Tuple[
2350
+ Annotated[StrictFloat, Field(gt=0)],
2351
+ Annotated[StrictFloat, Field(gt=0)]
2352
+ ]
2353
+ ] = None,
2354
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2355
+ _content_type: Optional[StrictStr] = None,
2356
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2357
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2358
+ ) -> RESTResponseType:
2359
+ """Updates the dimensions of all rapids within a validation set.
2360
+
2361
+
2362
+ :param validation_set_id: (required)
2363
+ :type validation_set_id: str
2364
+ :param update_dimensions_model: The model containing the dimensions
2365
+ :type update_dimensions_model: UpdateDimensionsModel
2366
+ :param _request_timeout: timeout setting for this request. If one
2367
+ number provided, it will be total request
2368
+ timeout. It can also be a pair (tuple) of
2369
+ (connection, read) timeouts.
2370
+ :type _request_timeout: int, tuple(int, int), optional
2371
+ :param _request_auth: set to override the auth_settings for an a single
2372
+ request; this effectively ignores the
2373
+ authentication in the spec for a single request.
2374
+ :type _request_auth: dict, optional
2375
+ :param _content_type: force content-type for the request.
2376
+ :type _content_type: str, Optional
2377
+ :param _headers: set to override the headers for a single
2378
+ request; this effectively ignores the headers
2379
+ in the spec for a single request.
2380
+ :type _headers: dict, optional
2381
+ :param _host_index: set to override the host_index for a single
2382
+ request; this effectively ignores the host_index
2383
+ in the spec for a single request.
2384
+ :type _host_index: int, optional
2385
+ :return: Returns the result object.
2386
+ """ # noqa: E501
2387
+
2388
+ _param = self._validation_validation_set_id_dimensions_patch_serialize(
2389
+ validation_set_id=validation_set_id,
2390
+ update_dimensions_model=update_dimensions_model,
2391
+ _request_auth=_request_auth,
2392
+ _content_type=_content_type,
2393
+ _headers=_headers,
2394
+ _host_index=_host_index
2395
+ )
2396
+
2397
+ _response_types_map: Dict[str, Optional[str]] = {
2398
+ '200': None,
2399
+ }
2400
+ response_data = self.api_client.call_api(
2401
+ *_param,
2402
+ _request_timeout=_request_timeout
2403
+ )
2404
+ return response_data.response
2405
+
2406
+
2407
+ def _validation_validation_set_id_dimensions_patch_serialize(
2408
+ self,
2409
+ validation_set_id,
2410
+ update_dimensions_model,
2411
+ _request_auth,
2412
+ _content_type,
2413
+ _headers,
2414
+ _host_index,
2415
+ ) -> RequestSerialized:
2416
+
2417
+ _host = None
2418
+
2419
+ _collection_formats: Dict[str, str] = {
2420
+ }
2421
+
2422
+ _path_params: Dict[str, str] = {}
2423
+ _query_params: List[Tuple[str, str]] = []
2424
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2425
+ _form_params: List[Tuple[str, str]] = []
2426
+ _files: Dict[
2427
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2428
+ ] = {}
2429
+ _body_params: Optional[bytes] = None
2430
+
2431
+ # process the path parameters
2432
+ if validation_set_id is not None:
2433
+ _path_params['validationSetId'] = validation_set_id
2434
+ # process the query parameters
2435
+ # process the header parameters
2436
+ # process the form parameters
2437
+ # process the body parameter
2438
+ if update_dimensions_model is not None:
2439
+ _body_params = update_dimensions_model
2440
+
2441
+
2442
+
2443
+ # set the HTTP header `Content-Type`
2444
+ if _content_type:
2445
+ _header_params['Content-Type'] = _content_type
2446
+ else:
2447
+ _default_content_type = (
2448
+ self.api_client.select_header_content_type(
2449
+ [
2450
+ 'application/json',
2451
+ 'text/json',
2452
+ 'application/*+json'
2453
+ ]
2454
+ )
2455
+ )
2456
+ if _default_content_type is not None:
2457
+ _header_params['Content-Type'] = _default_content_type
2458
+
2459
+ # authentication setting
2460
+ _auth_settings: List[str] = [
2461
+ 'bearer',
2462
+ 'oauth2'
2463
+ ]
2464
+
2465
+ return self.api_client.param_serialize(
2466
+ method='PATCH',
2467
+ resource_path='/validation/{validationSetId}/dimensions',
2468
+ path_params=_path_params,
2469
+ query_params=_query_params,
2470
+ header_params=_header_params,
2471
+ body=_body_params,
2472
+ post_params=_form_params,
2473
+ files=_files,
2474
+ auth_settings=_auth_settings,
2475
+ collection_formats=_collection_formats,
2476
+ _host=_host,
2477
+ _request_auth=_request_auth
2478
+ )
2479
+
2480
+