rapidata 2.36.0__py3-none-any.whl → 2.36.2__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 (101) hide show
  1. rapidata/__init__.py +2 -2
  2. rapidata/api_client/__init__.py +3 -2
  3. rapidata/api_client/api/leaderboard_api.py +295 -6
  4. rapidata/api_client/api/validation_set_api.py +561 -313
  5. rapidata/api_client/models/__init__.py +3 -2
  6. rapidata/api_client/models/add_validation_rapid_model.py +29 -4
  7. rapidata/api_client/models/add_validation_rapid_model_truth.py +7 -1
  8. rapidata/api_client/models/asset_metadata.py +9 -1
  9. rapidata/api_client/models/asset_type.py +40 -0
  10. rapidata/api_client/models/boost_query_result.py +5 -17
  11. rapidata/api_client/models/campaign_query_result.py +3 -9
  12. rapidata/api_client/models/classification_metadata.py +12 -1
  13. rapidata/api_client/models/compare_workflow_config.py +22 -12
  14. rapidata/api_client/models/compare_workflow_config_model.py +12 -2
  15. rapidata/api_client/models/compare_workflow_model.py +12 -2
  16. rapidata/api_client/models/count_metadata.py +12 -1
  17. rapidata/api_client/models/create_demographic_rapid_model.py +18 -3
  18. rapidata/api_client/models/create_order_model.py +6 -48
  19. rapidata/api_client/models/effort_capped_selection.py +2 -11
  20. rapidata/api_client/models/evaluation_workflow_config.py +13 -3
  21. rapidata/api_client/models/evaluation_workflow_model.py +13 -3
  22. rapidata/api_client/models/file_type_metadata.py +11 -6
  23. rapidata/api_client/models/file_type_metadata_model.py +2 -8
  24. rapidata/api_client/models/filter.py +5 -23
  25. rapidata/api_client/models/get_datapoint_by_id_result.py +3 -9
  26. rapidata/api_client/models/get_rapid_responses_result.py +3 -9
  27. rapidata/api_client/models/get_recommended_validation_set_result.py +95 -0
  28. rapidata/api_client/models/get_standing_by_id_result.py +3 -9
  29. rapidata/api_client/models/get_validation_rapids_result.py +3 -9
  30. rapidata/api_client/models/get_workflow_progress_result.py +3 -9
  31. rapidata/api_client/models/get_workflow_results_result.py +3 -9
  32. rapidata/api_client/models/image_dimension_metadata.py +12 -1
  33. rapidata/api_client/models/labeling_selection.py +2 -11
  34. rapidata/api_client/models/location_metadata.py +12 -1
  35. rapidata/api_client/models/order_model.py +3 -9
  36. rapidata/api_client/models/original_filename_metadata.py +12 -1
  37. rapidata/api_client/models/participant_by_benchmark.py +3 -9
  38. rapidata/api_client/models/prompt_metadata.py +12 -1
  39. rapidata/api_client/models/prompt_type.py +38 -0
  40. rapidata/api_client/models/rapid_modality.py +46 -0
  41. rapidata/api_client/models/rapid_model.py +3 -9
  42. rapidata/api_client/models/report_model.py +3 -9
  43. rapidata/api_client/models/response_count_filter.py +2 -8
  44. rapidata/api_client/models/response_count_user_filter_model.py +2 -8
  45. rapidata/api_client/models/root_filter.py +3 -12
  46. rapidata/api_client/models/runs_by_leaderboard_result.py +3 -9
  47. rapidata/api_client/models/simple_workflow_config.py +13 -3
  48. rapidata/api_client/models/simple_workflow_config_model.py +11 -3
  49. rapidata/api_client/models/simple_workflow_model.py +13 -3
  50. rapidata/api_client/models/sort_criterion.py +3 -9
  51. rapidata/api_client/models/source_url_metadata.py +12 -1
  52. rapidata/api_client/models/standing_by_leaderboard.py +3 -9
  53. rapidata/api_client/models/streams_metadata.py +12 -1
  54. rapidata/api_client/models/text_metadata.py +12 -1
  55. rapidata/api_client/models/transcription_metadata.py +9 -1
  56. rapidata/api_client/models/update_leaderboard_model.py +91 -0
  57. rapidata/api_client/models/update_should_alert_model.py +1 -1
  58. rapidata/api_client/models/validation_set_model.py +42 -3
  59. rapidata/api_client/models/video_duration_metadata.py +12 -1
  60. rapidata/api_client/models/workflow_aggregation_step_model.py +3 -12
  61. rapidata/api_client_README.md +8 -5
  62. rapidata/rapidata_client/__init__.py +1 -1
  63. rapidata/rapidata_client/benchmark/participant/_participant.py +5 -5
  64. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +2 -1
  65. rapidata/rapidata_client/benchmark/rapidata_benchmark_manager.py +10 -2
  66. rapidata/rapidata_client/config/__init__.py +1 -1
  67. rapidata/rapidata_client/config/rapidata_config.py +31 -0
  68. rapidata/rapidata_client/datapoints/__init__.py +10 -2
  69. rapidata/rapidata_client/datapoints/{datapoint.py → _datapoint.py} +105 -17
  70. rapidata/rapidata_client/datapoints/assets/_media_asset.py +80 -68
  71. rapidata/rapidata_client/datapoints/assets/_sessions.py +3 -3
  72. rapidata/rapidata_client/datapoints/assets/constants.py +7 -0
  73. rapidata/rapidata_client/exceptions/failed_upload_exception.py +42 -13
  74. rapidata/rapidata_client/filter/response_count_filter.py +16 -11
  75. rapidata/rapidata_client/order/_rapidata_dataset.py +8 -8
  76. rapidata/rapidata_client/order/_rapidata_order_builder.py +87 -8
  77. rapidata/rapidata_client/order/rapidata_order_manager.py +18 -4
  78. rapidata/rapidata_client/rapidata_client.py +6 -0
  79. rapidata/rapidata_client/selection/__init__.py +1 -1
  80. rapidata/rapidata_client/selection/effort_selection.py +18 -7
  81. rapidata/rapidata_client/selection/labeling_selection.py +19 -7
  82. rapidata/rapidata_client/selection/{retrieval_modes.py → rapidata_retrieval_modes.py} +7 -4
  83. rapidata/rapidata_client/validation/rapidata_validation_set.py +26 -1
  84. rapidata/rapidata_client/validation/rapids/rapids.py +46 -19
  85. rapidata/rapidata_client/validation/validation_set_manager.py +41 -4
  86. rapidata/rapidata_client/workflow/_base_workflow.py +27 -0
  87. rapidata/rapidata_client/workflow/_classify_workflow.py +25 -9
  88. rapidata/rapidata_client/workflow/_compare_workflow.py +11 -0
  89. rapidata/rapidata_client/workflow/_draw_workflow.py +15 -7
  90. rapidata/rapidata_client/workflow/_evaluation_workflow.py +8 -1
  91. rapidata/rapidata_client/workflow/_free_text_workflow.py +20 -2
  92. rapidata/rapidata_client/workflow/_locate_workflow.py +15 -7
  93. rapidata/rapidata_client/workflow/_ranking_workflow.py +39 -15
  94. rapidata/rapidata_client/workflow/_select_words_workflow.py +41 -7
  95. rapidata/rapidata_client/workflow/_timestamp_workflow.py +17 -8
  96. rapidata/service/openapi_service.py +1 -1
  97. {rapidata-2.36.0.dist-info → rapidata-2.36.2.dist-info}/METADATA +1 -1
  98. {rapidata-2.36.0.dist-info → rapidata-2.36.2.dist-info}/RECORD +100 -94
  99. rapidata/rapidata_client/config/config.py +0 -33
  100. {rapidata-2.36.0.dist-info → rapidata-2.36.2.dist-info}/LICENSE +0 -0
  101. {rapidata-2.36.0.dist-info → rapidata-2.36.2.dist-info}/WHEEL +0 -0
@@ -16,15 +16,15 @@ 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, StrictBytes, StrictStr
19
+ from pydantic import Field, StrictBool, StrictBytes, StrictStr, field_validator
20
20
  from typing import List, Optional, Tuple, Union
21
21
  from typing_extensions import Annotated
22
22
  from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
23
23
  from rapidata.api_client.models.add_validation_rapid_result import AddValidationRapidResult
24
- from rapidata.api_client.models.add_validation_text_rapid_model import AddValidationTextRapidModel
25
24
  from rapidata.api_client.models.create_empty_validation_set_result import CreateEmptyValidationSetResult
26
25
  from rapidata.api_client.models.create_validation_set_model import CreateValidationSetModel
27
26
  from rapidata.api_client.models.get_available_validation_sets_result import GetAvailableValidationSetsResult
27
+ from rapidata.api_client.models.get_recommended_validation_set_result import GetRecommendedValidationSetResult
28
28
  from rapidata.api_client.models.get_validation_rapids_result_paged_result import GetValidationRapidsResultPagedResult
29
29
  from rapidata.api_client.models.get_validation_set_by_id_result import GetValidationSetByIdResult
30
30
  from rapidata.api_client.models.import_validation_set_from_file_result import ImportValidationSetFromFileResult
@@ -328,6 +328,329 @@ class ValidationSetApi:
328
328
 
329
329
 
330
330
 
331
+ @validate_call
332
+ def validation_set_recommended_get(
333
+ self,
334
+ asset_type: Annotated[Optional[List[StrictStr]], Field(description="The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.")] = None,
335
+ modality: Annotated[Optional[List[StrictStr]], Field(description="The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.")] = None,
336
+ prompt_type: Annotated[Optional[List[StrictStr]], Field(description="The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.")] = None,
337
+ instruction: Annotated[Optional[StrictStr], Field(description="An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.")] = None,
338
+ _request_timeout: Union[
339
+ None,
340
+ Annotated[StrictFloat, Field(gt=0)],
341
+ Tuple[
342
+ Annotated[StrictFloat, Field(gt=0)],
343
+ Annotated[StrictFloat, Field(gt=0)]
344
+ ]
345
+ ] = None,
346
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
347
+ _content_type: Optional[StrictStr] = None,
348
+ _headers: Optional[Dict[StrictStr, Any]] = None,
349
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
350
+ ) -> GetRecommendedValidationSetResult:
351
+ """Gets a validation set that is available to the user and best matches the provided parameters.
352
+
353
+ This is not a hard filter, instead it is used to find validation sets that have similar characteristics to the provided instruction.
354
+
355
+ :param asset_type: The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.
356
+ :type asset_type: List[str]
357
+ :param modality: The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.
358
+ :type modality: List[str]
359
+ :param prompt_type: The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.
360
+ :type prompt_type: List[str]
361
+ :param instruction: An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.
362
+ :type instruction: str
363
+ :param _request_timeout: timeout setting for this request. If one
364
+ number provided, it will be total request
365
+ timeout. It can also be a pair (tuple) of
366
+ (connection, read) timeouts.
367
+ :type _request_timeout: int, tuple(int, int), optional
368
+ :param _request_auth: set to override the auth_settings for an a single
369
+ request; this effectively ignores the
370
+ authentication in the spec for a single request.
371
+ :type _request_auth: dict, optional
372
+ :param _content_type: force content-type for the request.
373
+ :type _content_type: str, Optional
374
+ :param _headers: set to override the headers for a single
375
+ request; this effectively ignores the headers
376
+ in the spec for a single request.
377
+ :type _headers: dict, optional
378
+ :param _host_index: set to override the host_index for a single
379
+ request; this effectively ignores the host_index
380
+ in the spec for a single request.
381
+ :type _host_index: int, optional
382
+ :return: Returns the result object.
383
+ """ # noqa: E501
384
+
385
+ _param = self._validation_set_recommended_get_serialize(
386
+ asset_type=asset_type,
387
+ modality=modality,
388
+ prompt_type=prompt_type,
389
+ instruction=instruction,
390
+ _request_auth=_request_auth,
391
+ _content_type=_content_type,
392
+ _headers=_headers,
393
+ _host_index=_host_index
394
+ )
395
+
396
+ _response_types_map: Dict[str, Optional[str]] = {
397
+ '200': "GetRecommendedValidationSetResult",
398
+ '404': "ProblemDetails",
399
+ }
400
+ response_data = self.api_client.call_api(
401
+ *_param,
402
+ _request_timeout=_request_timeout
403
+ )
404
+ response_data.read()
405
+ return self.api_client.response_deserialize(
406
+ response_data=response_data,
407
+ response_types_map=_response_types_map,
408
+ ).data
409
+
410
+
411
+ @validate_call
412
+ def validation_set_recommended_get_with_http_info(
413
+ self,
414
+ asset_type: Annotated[Optional[List[StrictStr]], Field(description="The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.")] = None,
415
+ modality: Annotated[Optional[List[StrictStr]], Field(description="The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.")] = None,
416
+ prompt_type: Annotated[Optional[List[StrictStr]], Field(description="The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.")] = None,
417
+ instruction: Annotated[Optional[StrictStr], Field(description="An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.")] = None,
418
+ _request_timeout: Union[
419
+ None,
420
+ Annotated[StrictFloat, Field(gt=0)],
421
+ Tuple[
422
+ Annotated[StrictFloat, Field(gt=0)],
423
+ Annotated[StrictFloat, Field(gt=0)]
424
+ ]
425
+ ] = None,
426
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
427
+ _content_type: Optional[StrictStr] = None,
428
+ _headers: Optional[Dict[StrictStr, Any]] = None,
429
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
430
+ ) -> ApiResponse[GetRecommendedValidationSetResult]:
431
+ """Gets a validation set that is available to the user and best matches the provided parameters.
432
+
433
+ This is not a hard filter, instead it is used to find validation sets that have similar characteristics to the provided instruction.
434
+
435
+ :param asset_type: The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.
436
+ :type asset_type: List[str]
437
+ :param modality: The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.
438
+ :type modality: List[str]
439
+ :param prompt_type: The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.
440
+ :type prompt_type: List[str]
441
+ :param instruction: An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.
442
+ :type instruction: str
443
+ :param _request_timeout: timeout setting for this request. If one
444
+ number provided, it will be total request
445
+ timeout. It can also be a pair (tuple) of
446
+ (connection, read) timeouts.
447
+ :type _request_timeout: int, tuple(int, int), optional
448
+ :param _request_auth: set to override the auth_settings for an a single
449
+ request; this effectively ignores the
450
+ authentication in the spec for a single request.
451
+ :type _request_auth: dict, optional
452
+ :param _content_type: force content-type for the request.
453
+ :type _content_type: str, Optional
454
+ :param _headers: set to override the headers for a single
455
+ request; this effectively ignores the headers
456
+ in the spec for a single request.
457
+ :type _headers: dict, optional
458
+ :param _host_index: set to override the host_index for a single
459
+ request; this effectively ignores the host_index
460
+ in the spec for a single request.
461
+ :type _host_index: int, optional
462
+ :return: Returns the result object.
463
+ """ # noqa: E501
464
+
465
+ _param = self._validation_set_recommended_get_serialize(
466
+ asset_type=asset_type,
467
+ modality=modality,
468
+ prompt_type=prompt_type,
469
+ instruction=instruction,
470
+ _request_auth=_request_auth,
471
+ _content_type=_content_type,
472
+ _headers=_headers,
473
+ _host_index=_host_index
474
+ )
475
+
476
+ _response_types_map: Dict[str, Optional[str]] = {
477
+ '200': "GetRecommendedValidationSetResult",
478
+ '404': "ProblemDetails",
479
+ }
480
+ response_data = self.api_client.call_api(
481
+ *_param,
482
+ _request_timeout=_request_timeout
483
+ )
484
+ response_data.read()
485
+ return self.api_client.response_deserialize(
486
+ response_data=response_data,
487
+ response_types_map=_response_types_map,
488
+ )
489
+
490
+
491
+ @validate_call
492
+ def validation_set_recommended_get_without_preload_content(
493
+ self,
494
+ asset_type: Annotated[Optional[List[StrictStr]], Field(description="The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.")] = None,
495
+ modality: Annotated[Optional[List[StrictStr]], Field(description="The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.")] = None,
496
+ prompt_type: Annotated[Optional[List[StrictStr]], Field(description="The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.")] = None,
497
+ instruction: Annotated[Optional[StrictStr], Field(description="An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.")] = None,
498
+ _request_timeout: Union[
499
+ None,
500
+ Annotated[StrictFloat, Field(gt=0)],
501
+ Tuple[
502
+ Annotated[StrictFloat, Field(gt=0)],
503
+ Annotated[StrictFloat, Field(gt=0)]
504
+ ]
505
+ ] = None,
506
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
507
+ _content_type: Optional[StrictStr] = None,
508
+ _headers: Optional[Dict[StrictStr, Any]] = None,
509
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
510
+ ) -> RESTResponseType:
511
+ """Gets a validation set that is available to the user and best matches the provided parameters.
512
+
513
+ This is not a hard filter, instead it is used to find validation sets that have similar characteristics to the provided instruction.
514
+
515
+ :param asset_type: The types of assets that the validation set should contain. An asset type can be an image, video, audio, text, or any combination of these. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified asset types.
516
+ :type asset_type: List[str]
517
+ :param modality: The rapid modalities that the validation set should contain. The modality is the type of rapid such as classify, compare, locate, etc. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified modalities.
518
+ :type modality: List[str]
519
+ :param prompt_type: The prompt types that the validation set should contain. A prompt type is the additional information that is presented to the user when solving a rapid. For example, a prompt type can be either text or an asset if the context is an image or video. <para /> This parameter is a flag, meaning that it can be null or contain multiple values. If multiple values are provided, a validation set will be chosen that contains at least one of the specified prompt types.
520
+ :type prompt_type: List[str]
521
+ :param instruction: An instruction that can be used to filter for validation sets that have similar instructions. An instruction is a text that is presented to the user when solving a rapid that explains how to solve the rapid.
522
+ :type instruction: str
523
+ :param _request_timeout: timeout setting for this request. If one
524
+ number provided, it will be total request
525
+ timeout. It can also be a pair (tuple) of
526
+ (connection, read) timeouts.
527
+ :type _request_timeout: int, tuple(int, int), optional
528
+ :param _request_auth: set to override the auth_settings for an a single
529
+ request; this effectively ignores the
530
+ authentication in the spec for a single request.
531
+ :type _request_auth: dict, optional
532
+ :param _content_type: force content-type for the request.
533
+ :type _content_type: str, Optional
534
+ :param _headers: set to override the headers for a single
535
+ request; this effectively ignores the headers
536
+ in the spec for a single request.
537
+ :type _headers: dict, optional
538
+ :param _host_index: set to override the host_index for a single
539
+ request; this effectively ignores the host_index
540
+ in the spec for a single request.
541
+ :type _host_index: int, optional
542
+ :return: Returns the result object.
543
+ """ # noqa: E501
544
+
545
+ _param = self._validation_set_recommended_get_serialize(
546
+ asset_type=asset_type,
547
+ modality=modality,
548
+ prompt_type=prompt_type,
549
+ instruction=instruction,
550
+ _request_auth=_request_auth,
551
+ _content_type=_content_type,
552
+ _headers=_headers,
553
+ _host_index=_host_index
554
+ )
555
+
556
+ _response_types_map: Dict[str, Optional[str]] = {
557
+ '200': "GetRecommendedValidationSetResult",
558
+ '404': "ProblemDetails",
559
+ }
560
+ response_data = self.api_client.call_api(
561
+ *_param,
562
+ _request_timeout=_request_timeout
563
+ )
564
+ return response_data.response
565
+
566
+
567
+ def _validation_set_recommended_get_serialize(
568
+ self,
569
+ asset_type,
570
+ modality,
571
+ prompt_type,
572
+ instruction,
573
+ _request_auth,
574
+ _content_type,
575
+ _headers,
576
+ _host_index,
577
+ ) -> RequestSerialized:
578
+
579
+ _host = None
580
+
581
+ _collection_formats: Dict[str, str] = {
582
+ 'assetType': 'multi',
583
+ 'modality': 'multi',
584
+ 'promptType': 'multi',
585
+ }
586
+
587
+ _path_params: Dict[str, str] = {}
588
+ _query_params: List[Tuple[str, str]] = []
589
+ _header_params: Dict[str, Optional[str]] = _headers or {}
590
+ _form_params: List[Tuple[str, str]] = []
591
+ _files: Dict[
592
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
593
+ ] = {}
594
+ _body_params: Optional[bytes] = None
595
+
596
+ # process the path parameters
597
+ # process the query parameters
598
+ if asset_type is not None:
599
+
600
+ _query_params.append(('assetType', asset_type))
601
+
602
+ if modality is not None:
603
+
604
+ _query_params.append(('modality', modality))
605
+
606
+ if prompt_type is not None:
607
+
608
+ _query_params.append(('promptType', prompt_type))
609
+
610
+ if instruction is not None:
611
+
612
+ _query_params.append(('instruction', instruction))
613
+
614
+ # process the header parameters
615
+ # process the form parameters
616
+ # process the body parameter
617
+
618
+
619
+ # set the HTTP header `Accept`
620
+ if 'Accept' not in _header_params:
621
+ _header_params['Accept'] = self.api_client.select_header_accept(
622
+ [
623
+ 'text/plain',
624
+ 'application/json',
625
+ 'text/json'
626
+ ]
627
+ )
628
+
629
+
630
+ # authentication setting
631
+ _auth_settings: List[str] = [
632
+ 'bearer',
633
+ 'oauth2'
634
+ ]
635
+
636
+ return self.api_client.param_serialize(
637
+ method='GET',
638
+ resource_path='/validation-set/recommended',
639
+ path_params=_path_params,
640
+ query_params=_query_params,
641
+ header_params=_header_params,
642
+ body=_body_params,
643
+ post_params=_form_params,
644
+ files=_files,
645
+ auth_settings=_auth_settings,
646
+ collection_formats=_collection_formats,
647
+ _host=_host,
648
+ _request_auth=_request_auth
649
+ )
650
+
651
+
652
+
653
+
331
654
  @validate_call
332
655
  def validation_set_validation_set_id_delete(
333
656
  self,
@@ -1670,11 +1993,13 @@ class ValidationSetApi:
1670
1993
 
1671
1994
 
1672
1995
  @validate_call
1673
- def validation_set_validation_set_id_rapid_files_post(
1996
+ def validation_set_validation_set_id_rapid_post(
1674
1997
  self,
1675
1998
  validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
1676
1999
  model: Optional[AddValidationRapidModel] = None,
1677
2000
  files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
2001
+ texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2002
+ urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
1678
2003
  _request_timeout: Union[
1679
2004
  None,
1680
2005
  Annotated[StrictFloat, Field(gt=0)],
@@ -1688,7 +2013,7 @@ class ValidationSetApi:
1688
2013
  _headers: Optional[Dict[StrictStr, Any]] = None,
1689
2014
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1690
2015
  ) -> AddValidationRapidResult:
1691
- """(Deprecated) Adds a new validation rapid to the specified validation set using files to create the assets.
2016
+ """Adds a new validation rapid to the specified validation set using files to create the assets.
1692
2017
 
1693
2018
 
1694
2019
  :param validation_set_id: The ID of the validation set to add the rapid to. (required)
@@ -1697,6 +2022,10 @@ class ValidationSetApi:
1697
2022
  :type model: AddValidationRapidModel
1698
2023
  :param files:
1699
2024
  :type files: List[bytearray]
2025
+ :param texts: The texts to use for the rapid.
2026
+ :type texts: List[str]
2027
+ :param urls: The urls to use for the rapid
2028
+ :type urls: List[str]
1700
2029
  :param _request_timeout: timeout setting for this request. If one
1701
2030
  number provided, it will be total request
1702
2031
  timeout. It can also be a pair (tuple) of
@@ -1718,12 +2047,13 @@ class ValidationSetApi:
1718
2047
  :type _host_index: int, optional
1719
2048
  :return: Returns the result object.
1720
2049
  """ # noqa: E501
1721
- warnings.warn("POST /validation-set/{validationSetId}/rapid/files is deprecated.", DeprecationWarning)
1722
2050
 
1723
- _param = self._validation_set_validation_set_id_rapid_files_post_serialize(
2051
+ _param = self._validation_set_validation_set_id_rapid_post_serialize(
1724
2052
  validation_set_id=validation_set_id,
1725
2053
  model=model,
1726
2054
  files=files,
2055
+ texts=texts,
2056
+ urls=urls,
1727
2057
  _request_auth=_request_auth,
1728
2058
  _content_type=_content_type,
1729
2059
  _headers=_headers,
@@ -1745,11 +2075,13 @@ class ValidationSetApi:
1745
2075
 
1746
2076
 
1747
2077
  @validate_call
1748
- def validation_set_validation_set_id_rapid_files_post_with_http_info(
2078
+ def validation_set_validation_set_id_rapid_post_with_http_info(
1749
2079
  self,
1750
2080
  validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
1751
2081
  model: Optional[AddValidationRapidModel] = None,
1752
2082
  files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
2083
+ texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2084
+ urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
1753
2085
  _request_timeout: Union[
1754
2086
  None,
1755
2087
  Annotated[StrictFloat, Field(gt=0)],
@@ -1763,7 +2095,7 @@ class ValidationSetApi:
1763
2095
  _headers: Optional[Dict[StrictStr, Any]] = None,
1764
2096
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1765
2097
  ) -> ApiResponse[AddValidationRapidResult]:
1766
- """(Deprecated) Adds a new validation rapid to the specified validation set using files to create the assets.
2098
+ """Adds a new validation rapid to the specified validation set using files to create the assets.
1767
2099
 
1768
2100
 
1769
2101
  :param validation_set_id: The ID of the validation set to add the rapid to. (required)
@@ -1772,6 +2104,10 @@ class ValidationSetApi:
1772
2104
  :type model: AddValidationRapidModel
1773
2105
  :param files:
1774
2106
  :type files: List[bytearray]
2107
+ :param texts: The texts to use for the rapid.
2108
+ :type texts: List[str]
2109
+ :param urls: The urls to use for the rapid
2110
+ :type urls: List[str]
1775
2111
  :param _request_timeout: timeout setting for this request. If one
1776
2112
  number provided, it will be total request
1777
2113
  timeout. It can also be a pair (tuple) of
@@ -1793,12 +2129,13 @@ class ValidationSetApi:
1793
2129
  :type _host_index: int, optional
1794
2130
  :return: Returns the result object.
1795
2131
  """ # noqa: E501
1796
- warnings.warn("POST /validation-set/{validationSetId}/rapid/files is deprecated.", DeprecationWarning)
1797
2132
 
1798
- _param = self._validation_set_validation_set_id_rapid_files_post_serialize(
2133
+ _param = self._validation_set_validation_set_id_rapid_post_serialize(
1799
2134
  validation_set_id=validation_set_id,
1800
2135
  model=model,
1801
2136
  files=files,
2137
+ texts=texts,
2138
+ urls=urls,
1802
2139
  _request_auth=_request_auth,
1803
2140
  _content_type=_content_type,
1804
2141
  _headers=_headers,
@@ -1820,12 +2157,14 @@ class ValidationSetApi:
1820
2157
 
1821
2158
 
1822
2159
  @validate_call
1823
- def validation_set_validation_set_id_rapid_files_post_without_preload_content(
2160
+ def validation_set_validation_set_id_rapid_post_without_preload_content(
1824
2161
  self,
1825
2162
  validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
1826
2163
  model: Optional[AddValidationRapidModel] = None,
1827
2164
  files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
1828
- _request_timeout: Union[
2165
+ texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2166
+ urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
2167
+ _request_timeout: Union[
1829
2168
  None,
1830
2169
  Annotated[StrictFloat, Field(gt=0)],
1831
2170
  Tuple[
@@ -1838,7 +2177,7 @@ class ValidationSetApi:
1838
2177
  _headers: Optional[Dict[StrictStr, Any]] = None,
1839
2178
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1840
2179
  ) -> RESTResponseType:
1841
- """(Deprecated) Adds a new validation rapid to the specified validation set using files to create the assets.
2180
+ """Adds a new validation rapid to the specified validation set using files to create the assets.
1842
2181
 
1843
2182
 
1844
2183
  :param validation_set_id: The ID of the validation set to add the rapid to. (required)
@@ -1847,6 +2186,10 @@ class ValidationSetApi:
1847
2186
  :type model: AddValidationRapidModel
1848
2187
  :param files:
1849
2188
  :type files: List[bytearray]
2189
+ :param texts: The texts to use for the rapid.
2190
+ :type texts: List[str]
2191
+ :param urls: The urls to use for the rapid
2192
+ :type urls: List[str]
1850
2193
  :param _request_timeout: timeout setting for this request. If one
1851
2194
  number provided, it will be total request
1852
2195
  timeout. It can also be a pair (tuple) of
@@ -1868,12 +2211,13 @@ class ValidationSetApi:
1868
2211
  :type _host_index: int, optional
1869
2212
  :return: Returns the result object.
1870
2213
  """ # noqa: E501
1871
- warnings.warn("POST /validation-set/{validationSetId}/rapid/files is deprecated.", DeprecationWarning)
1872
2214
 
1873
- _param = self._validation_set_validation_set_id_rapid_files_post_serialize(
2215
+ _param = self._validation_set_validation_set_id_rapid_post_serialize(
1874
2216
  validation_set_id=validation_set_id,
1875
2217
  model=model,
1876
2218
  files=files,
2219
+ texts=texts,
2220
+ urls=urls,
1877
2221
  _request_auth=_request_auth,
1878
2222
  _content_type=_content_type,
1879
2223
  _headers=_headers,
@@ -1890,11 +2234,13 @@ class ValidationSetApi:
1890
2234
  return response_data.response
1891
2235
 
1892
2236
 
1893
- def _validation_set_validation_set_id_rapid_files_post_serialize(
2237
+ def _validation_set_validation_set_id_rapid_post_serialize(
1894
2238
  self,
1895
2239
  validation_set_id,
1896
2240
  model,
1897
2241
  files,
2242
+ texts,
2243
+ urls,
1898
2244
  _request_auth,
1899
2245
  _content_type,
1900
2246
  _headers,
@@ -1905,6 +2251,8 @@ class ValidationSetApi:
1905
2251
 
1906
2252
  _collection_formats: Dict[str, str] = {
1907
2253
  'files': 'multi',
2254
+ 'texts': 'multi',
2255
+ 'urls': 'multi',
1908
2256
  }
1909
2257
 
1910
2258
  _path_params: Dict[str, str] = {}
@@ -1926,6 +2274,10 @@ class ValidationSetApi:
1926
2274
  _form_params.append(('model', model))
1927
2275
  if files is not None:
1928
2276
  _files['files'] = files
2277
+ if texts is not None:
2278
+ _form_params.append(('texts', texts))
2279
+ if urls is not None:
2280
+ _form_params.append(('urls', urls))
1929
2281
  # process the body parameter
1930
2282
 
1931
2283
 
@@ -1961,7 +2313,7 @@ class ValidationSetApi:
1961
2313
 
1962
2314
  return self.api_client.param_serialize(
1963
2315
  method='POST',
1964
- resource_path='/validation-set/{validationSetId}/rapid/files',
2316
+ resource_path='/validation-set/{validationSetId}/rapid',
1965
2317
  path_params=_path_params,
1966
2318
  query_params=_query_params,
1967
2319
  header_params=_header_params,
@@ -1978,13 +2330,10 @@ class ValidationSetApi:
1978
2330
 
1979
2331
 
1980
2332
  @validate_call
1981
- def validation_set_validation_set_id_rapid_post(
2333
+ def validation_set_validation_set_id_rapids_get(
1982
2334
  self,
1983
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
1984
- model: Optional[AddValidationRapidModel] = None,
1985
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
1986
- texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
1987
- urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
2335
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2336
+ model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
1988
2337
  _request_timeout: Union[
1989
2338
  None,
1990
2339
  Annotated[StrictFloat, Field(gt=0)],
@@ -1997,20 +2346,14 @@ class ValidationSetApi:
1997
2346
  _content_type: Optional[StrictStr] = None,
1998
2347
  _headers: Optional[Dict[StrictStr, Any]] = None,
1999
2348
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2000
- ) -> AddValidationRapidResult:
2001
- """Adds a new validation rapid to the specified validation set using files to create the assets.
2349
+ ) -> GetValidationRapidsResultPagedResult:
2350
+ """Queries the validation rapids for a specific validation set.
2002
2351
 
2003
2352
 
2004
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2353
+ :param validation_set_id: The validation set to query. (required)
2005
2354
  :type validation_set_id: str
2006
- :param model:
2007
- :type model: AddValidationRapidModel
2008
- :param files:
2009
- :type files: List[bytearray]
2010
- :param texts: The texts to use for the rapid.
2011
- :type texts: List[str]
2012
- :param urls: The urls to use for the rapid
2013
- :type urls: List[str]
2355
+ :param model: The request formatted as a JSON in the query parameters.
2356
+ :type model: QueryModel
2014
2357
  :param _request_timeout: timeout setting for this request. If one
2015
2358
  number provided, it will be total request
2016
2359
  timeout. It can also be a pair (tuple) of
@@ -2033,12 +2376,9 @@ class ValidationSetApi:
2033
2376
  :return: Returns the result object.
2034
2377
  """ # noqa: E501
2035
2378
 
2036
- _param = self._validation_set_validation_set_id_rapid_post_serialize(
2379
+ _param = self._validation_set_validation_set_id_rapids_get_serialize(
2037
2380
  validation_set_id=validation_set_id,
2038
2381
  model=model,
2039
- files=files,
2040
- texts=texts,
2041
- urls=urls,
2042
2382
  _request_auth=_request_auth,
2043
2383
  _content_type=_content_type,
2044
2384
  _headers=_headers,
@@ -2046,7 +2386,7 @@ class ValidationSetApi:
2046
2386
  )
2047
2387
 
2048
2388
  _response_types_map: Dict[str, Optional[str]] = {
2049
- '200': "AddValidationRapidResult",
2389
+ '200': "GetValidationRapidsResultPagedResult",
2050
2390
  }
2051
2391
  response_data = self.api_client.call_api(
2052
2392
  *_param,
@@ -2060,13 +2400,10 @@ class ValidationSetApi:
2060
2400
 
2061
2401
 
2062
2402
  @validate_call
2063
- def validation_set_validation_set_id_rapid_post_with_http_info(
2403
+ def validation_set_validation_set_id_rapids_get_with_http_info(
2064
2404
  self,
2065
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
2066
- model: Optional[AddValidationRapidModel] = None,
2067
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
2068
- texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2069
- urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
2405
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2406
+ model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
2070
2407
  _request_timeout: Union[
2071
2408
  None,
2072
2409
  Annotated[StrictFloat, Field(gt=0)],
@@ -2079,20 +2416,14 @@ class ValidationSetApi:
2079
2416
  _content_type: Optional[StrictStr] = None,
2080
2417
  _headers: Optional[Dict[StrictStr, Any]] = None,
2081
2418
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2082
- ) -> ApiResponse[AddValidationRapidResult]:
2083
- """Adds a new validation rapid to the specified validation set using files to create the assets.
2419
+ ) -> ApiResponse[GetValidationRapidsResultPagedResult]:
2420
+ """Queries the validation rapids for a specific validation set.
2084
2421
 
2085
2422
 
2086
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2423
+ :param validation_set_id: The validation set to query. (required)
2087
2424
  :type validation_set_id: str
2088
- :param model:
2089
- :type model: AddValidationRapidModel
2090
- :param files:
2091
- :type files: List[bytearray]
2092
- :param texts: The texts to use for the rapid.
2093
- :type texts: List[str]
2094
- :param urls: The urls to use for the rapid
2095
- :type urls: List[str]
2425
+ :param model: The request formatted as a JSON in the query parameters.
2426
+ :type model: QueryModel
2096
2427
  :param _request_timeout: timeout setting for this request. If one
2097
2428
  number provided, it will be total request
2098
2429
  timeout. It can also be a pair (tuple) of
@@ -2115,12 +2446,9 @@ class ValidationSetApi:
2115
2446
  :return: Returns the result object.
2116
2447
  """ # noqa: E501
2117
2448
 
2118
- _param = self._validation_set_validation_set_id_rapid_post_serialize(
2449
+ _param = self._validation_set_validation_set_id_rapids_get_serialize(
2119
2450
  validation_set_id=validation_set_id,
2120
2451
  model=model,
2121
- files=files,
2122
- texts=texts,
2123
- urls=urls,
2124
2452
  _request_auth=_request_auth,
2125
2453
  _content_type=_content_type,
2126
2454
  _headers=_headers,
@@ -2128,7 +2456,7 @@ class ValidationSetApi:
2128
2456
  )
2129
2457
 
2130
2458
  _response_types_map: Dict[str, Optional[str]] = {
2131
- '200': "AddValidationRapidResult",
2459
+ '200': "GetValidationRapidsResultPagedResult",
2132
2460
  }
2133
2461
  response_data = self.api_client.call_api(
2134
2462
  *_param,
@@ -2142,13 +2470,10 @@ class ValidationSetApi:
2142
2470
 
2143
2471
 
2144
2472
  @validate_call
2145
- def validation_set_validation_set_id_rapid_post_without_preload_content(
2473
+ def validation_set_validation_set_id_rapids_get_without_preload_content(
2146
2474
  self,
2147
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
2148
- model: Optional[AddValidationRapidModel] = None,
2149
- files: Optional[List[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]]] = None,
2150
- texts: Annotated[Optional[List[StrictStr]], Field(description="The texts to use for the rapid.")] = None,
2151
- urls: Annotated[Optional[List[StrictStr]], Field(description="The urls to use for the rapid")] = None,
2475
+ validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2476
+ model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
2152
2477
  _request_timeout: Union[
2153
2478
  None,
2154
2479
  Annotated[StrictFloat, Field(gt=0)],
@@ -2162,19 +2487,13 @@ class ValidationSetApi:
2162
2487
  _headers: Optional[Dict[StrictStr, Any]] = None,
2163
2488
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2164
2489
  ) -> RESTResponseType:
2165
- """Adds a new validation rapid to the specified validation set using files to create the assets.
2490
+ """Queries the validation rapids for a specific validation set.
2166
2491
 
2167
2492
 
2168
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2493
+ :param validation_set_id: The validation set to query. (required)
2169
2494
  :type validation_set_id: str
2170
- :param model:
2171
- :type model: AddValidationRapidModel
2172
- :param files:
2173
- :type files: List[bytearray]
2174
- :param texts: The texts to use for the rapid.
2175
- :type texts: List[str]
2176
- :param urls: The urls to use for the rapid
2177
- :type urls: List[str]
2495
+ :param model: The request formatted as a JSON in the query parameters.
2496
+ :type model: QueryModel
2178
2497
  :param _request_timeout: timeout setting for this request. If one
2179
2498
  number provided, it will be total request
2180
2499
  timeout. It can also be a pair (tuple) of
@@ -2197,12 +2516,9 @@ class ValidationSetApi:
2197
2516
  :return: Returns the result object.
2198
2517
  """ # noqa: E501
2199
2518
 
2200
- _param = self._validation_set_validation_set_id_rapid_post_serialize(
2519
+ _param = self._validation_set_validation_set_id_rapids_get_serialize(
2201
2520
  validation_set_id=validation_set_id,
2202
2521
  model=model,
2203
- files=files,
2204
- texts=texts,
2205
- urls=urls,
2206
2522
  _request_auth=_request_auth,
2207
2523
  _content_type=_content_type,
2208
2524
  _headers=_headers,
@@ -2210,7 +2526,7 @@ class ValidationSetApi:
2210
2526
  )
2211
2527
 
2212
2528
  _response_types_map: Dict[str, Optional[str]] = {
2213
- '200': "AddValidationRapidResult",
2529
+ '200': "GetValidationRapidsResultPagedResult",
2214
2530
  }
2215
2531
  response_data = self.api_client.call_api(
2216
2532
  *_param,
@@ -2219,13 +2535,10 @@ class ValidationSetApi:
2219
2535
  return response_data.response
2220
2536
 
2221
2537
 
2222
- def _validation_set_validation_set_id_rapid_post_serialize(
2538
+ def _validation_set_validation_set_id_rapids_get_serialize(
2223
2539
  self,
2224
2540
  validation_set_id,
2225
2541
  model,
2226
- files,
2227
- texts,
2228
- urls,
2229
2542
  _request_auth,
2230
2543
  _content_type,
2231
2544
  _headers,
@@ -2235,9 +2548,6 @@ class ValidationSetApi:
2235
2548
  _host = None
2236
2549
 
2237
2550
  _collection_formats: Dict[str, str] = {
2238
- 'files': 'multi',
2239
- 'texts': 'multi',
2240
- 'urls': 'multi',
2241
2551
  }
2242
2552
 
2243
2553
  _path_params: Dict[str, str] = {}
@@ -2253,16 +2563,12 @@ class ValidationSetApi:
2253
2563
  if validation_set_id is not None:
2254
2564
  _path_params['validationSetId'] = validation_set_id
2255
2565
  # process the query parameters
2566
+ if model is not None:
2567
+
2568
+ _query_params.append(('model', model))
2569
+
2256
2570
  # process the header parameters
2257
2571
  # process the form parameters
2258
- if model is not None:
2259
- _form_params.append(('model', model))
2260
- if files is not None:
2261
- _files['files'] = files
2262
- if texts is not None:
2263
- _form_params.append(('texts', texts))
2264
- if urls is not None:
2265
- _form_params.append(('urls', urls))
2266
2572
  # process the body parameter
2267
2573
 
2268
2574
 
@@ -2276,19 +2582,6 @@ class ValidationSetApi:
2276
2582
  ]
2277
2583
  )
2278
2584
 
2279
- # set the HTTP header `Content-Type`
2280
- if _content_type:
2281
- _header_params['Content-Type'] = _content_type
2282
- else:
2283
- _default_content_type = (
2284
- self.api_client.select_header_content_type(
2285
- [
2286
- 'multipart/form-data'
2287
- ]
2288
- )
2289
- )
2290
- if _default_content_type is not None:
2291
- _header_params['Content-Type'] = _default_content_type
2292
2585
 
2293
2586
  # authentication setting
2294
2587
  _auth_settings: List[str] = [
@@ -2297,8 +2590,8 @@ class ValidationSetApi:
2297
2590
  ]
2298
2591
 
2299
2592
  return self.api_client.param_serialize(
2300
- method='POST',
2301
- resource_path='/validation-set/{validationSetId}/rapid',
2593
+ method='GET',
2594
+ resource_path='/validation-set/{validationSetId}/rapids',
2302
2595
  path_params=_path_params,
2303
2596
  query_params=_query_params,
2304
2597
  header_params=_header_params,
@@ -2315,10 +2608,10 @@ class ValidationSetApi:
2315
2608
 
2316
2609
 
2317
2610
  @validate_call
2318
- def validation_set_validation_set_id_rapid_texts_post(
2611
+ def validation_set_validation_set_id_shouldalert_patch(
2319
2612
  self,
2320
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
2321
- add_validation_text_rapid_model: Annotated[Optional[AddValidationTextRapidModel], Field(description="The model containing the information needed to add the validation rapid.")] = None,
2613
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2614
+ update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
2322
2615
  _request_timeout: Union[
2323
2616
  None,
2324
2617
  Annotated[StrictFloat, Field(gt=0)],
@@ -2331,14 +2624,14 @@ class ValidationSetApi:
2331
2624
  _content_type: Optional[StrictStr] = None,
2332
2625
  _headers: Optional[Dict[StrictStr, Any]] = None,
2333
2626
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2334
- ) -> AddValidationRapidResult:
2335
- """(Deprecated) Adds a new validation rapid to the specified validation set using text sources to create the assets.
2627
+ ) -> None:
2628
+ """Updates the dimensions of all rapids within a validation set.
2336
2629
 
2337
2630
 
2338
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2631
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
2339
2632
  :type validation_set_id: str
2340
- :param add_validation_text_rapid_model: The model containing the information needed to add the validation rapid.
2341
- :type add_validation_text_rapid_model: AddValidationTextRapidModel
2633
+ :param update_should_alert_model: The body request for updating the shouldAlert property.
2634
+ :type update_should_alert_model: UpdateShouldAlertModel
2342
2635
  :param _request_timeout: timeout setting for this request. If one
2343
2636
  number provided, it will be total request
2344
2637
  timeout. It can also be a pair (tuple) of
@@ -2360,11 +2653,10 @@ class ValidationSetApi:
2360
2653
  :type _host_index: int, optional
2361
2654
  :return: Returns the result object.
2362
2655
  """ # noqa: E501
2363
- warnings.warn("POST /validation-set/{validationSetId}/rapid/texts is deprecated.", DeprecationWarning)
2364
2656
 
2365
- _param = self._validation_set_validation_set_id_rapid_texts_post_serialize(
2657
+ _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
2366
2658
  validation_set_id=validation_set_id,
2367
- add_validation_text_rapid_model=add_validation_text_rapid_model,
2659
+ update_should_alert_model=update_should_alert_model,
2368
2660
  _request_auth=_request_auth,
2369
2661
  _content_type=_content_type,
2370
2662
  _headers=_headers,
@@ -2372,7 +2664,7 @@ class ValidationSetApi:
2372
2664
  )
2373
2665
 
2374
2666
  _response_types_map: Dict[str, Optional[str]] = {
2375
- '200': "AddValidationRapidResult",
2667
+ '204': None,
2376
2668
  }
2377
2669
  response_data = self.api_client.call_api(
2378
2670
  *_param,
@@ -2386,10 +2678,10 @@ class ValidationSetApi:
2386
2678
 
2387
2679
 
2388
2680
  @validate_call
2389
- def validation_set_validation_set_id_rapid_texts_post_with_http_info(
2681
+ def validation_set_validation_set_id_shouldalert_patch_with_http_info(
2390
2682
  self,
2391
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
2392
- add_validation_text_rapid_model: Annotated[Optional[AddValidationTextRapidModel], Field(description="The model containing the information needed to add the validation rapid.")] = None,
2683
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2684
+ update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
2393
2685
  _request_timeout: Union[
2394
2686
  None,
2395
2687
  Annotated[StrictFloat, Field(gt=0)],
@@ -2402,14 +2694,14 @@ class ValidationSetApi:
2402
2694
  _content_type: Optional[StrictStr] = None,
2403
2695
  _headers: Optional[Dict[StrictStr, Any]] = None,
2404
2696
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2405
- ) -> ApiResponse[AddValidationRapidResult]:
2406
- """(Deprecated) Adds a new validation rapid to the specified validation set using text sources to create the assets.
2697
+ ) -> ApiResponse[None]:
2698
+ """Updates the dimensions of all rapids within a validation set.
2407
2699
 
2408
2700
 
2409
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2701
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
2410
2702
  :type validation_set_id: str
2411
- :param add_validation_text_rapid_model: The model containing the information needed to add the validation rapid.
2412
- :type add_validation_text_rapid_model: AddValidationTextRapidModel
2703
+ :param update_should_alert_model: The body request for updating the shouldAlert property.
2704
+ :type update_should_alert_model: UpdateShouldAlertModel
2413
2705
  :param _request_timeout: timeout setting for this request. If one
2414
2706
  number provided, it will be total request
2415
2707
  timeout. It can also be a pair (tuple) of
@@ -2431,11 +2723,10 @@ class ValidationSetApi:
2431
2723
  :type _host_index: int, optional
2432
2724
  :return: Returns the result object.
2433
2725
  """ # noqa: E501
2434
- warnings.warn("POST /validation-set/{validationSetId}/rapid/texts is deprecated.", DeprecationWarning)
2435
2726
 
2436
- _param = self._validation_set_validation_set_id_rapid_texts_post_serialize(
2727
+ _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
2437
2728
  validation_set_id=validation_set_id,
2438
- add_validation_text_rapid_model=add_validation_text_rapid_model,
2729
+ update_should_alert_model=update_should_alert_model,
2439
2730
  _request_auth=_request_auth,
2440
2731
  _content_type=_content_type,
2441
2732
  _headers=_headers,
@@ -2443,7 +2734,7 @@ class ValidationSetApi:
2443
2734
  )
2444
2735
 
2445
2736
  _response_types_map: Dict[str, Optional[str]] = {
2446
- '200': "AddValidationRapidResult",
2737
+ '204': None,
2447
2738
  }
2448
2739
  response_data = self.api_client.call_api(
2449
2740
  *_param,
@@ -2457,10 +2748,10 @@ class ValidationSetApi:
2457
2748
 
2458
2749
 
2459
2750
  @validate_call
2460
- def validation_set_validation_set_id_rapid_texts_post_without_preload_content(
2751
+ def validation_set_validation_set_id_shouldalert_patch_without_preload_content(
2461
2752
  self,
2462
- validation_set_id: Annotated[StrictStr, Field(description="The ID of the validation set to add the rapid to.")],
2463
- add_validation_text_rapid_model: Annotated[Optional[AddValidationTextRapidModel], Field(description="The model containing the information needed to add the validation rapid.")] = None,
2753
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2754
+ update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
2464
2755
  _request_timeout: Union[
2465
2756
  None,
2466
2757
  Annotated[StrictFloat, Field(gt=0)],
@@ -2474,13 +2765,13 @@ class ValidationSetApi:
2474
2765
  _headers: Optional[Dict[StrictStr, Any]] = None,
2475
2766
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2476
2767
  ) -> RESTResponseType:
2477
- """(Deprecated) Adds a new validation rapid to the specified validation set using text sources to create the assets.
2768
+ """Updates the dimensions of all rapids within a validation set.
2478
2769
 
2479
2770
 
2480
- :param validation_set_id: The ID of the validation set to add the rapid to. (required)
2771
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
2481
2772
  :type validation_set_id: str
2482
- :param add_validation_text_rapid_model: The model containing the information needed to add the validation rapid.
2483
- :type add_validation_text_rapid_model: AddValidationTextRapidModel
2773
+ :param update_should_alert_model: The body request for updating the shouldAlert property.
2774
+ :type update_should_alert_model: UpdateShouldAlertModel
2484
2775
  :param _request_timeout: timeout setting for this request. If one
2485
2776
  number provided, it will be total request
2486
2777
  timeout. It can also be a pair (tuple) of
@@ -2502,11 +2793,10 @@ class ValidationSetApi:
2502
2793
  :type _host_index: int, optional
2503
2794
  :return: Returns the result object.
2504
2795
  """ # noqa: E501
2505
- warnings.warn("POST /validation-set/{validationSetId}/rapid/texts is deprecated.", DeprecationWarning)
2506
2796
 
2507
- _param = self._validation_set_validation_set_id_rapid_texts_post_serialize(
2797
+ _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
2508
2798
  validation_set_id=validation_set_id,
2509
- add_validation_text_rapid_model=add_validation_text_rapid_model,
2799
+ update_should_alert_model=update_should_alert_model,
2510
2800
  _request_auth=_request_auth,
2511
2801
  _content_type=_content_type,
2512
2802
  _headers=_headers,
@@ -2514,7 +2804,7 @@ class ValidationSetApi:
2514
2804
  )
2515
2805
 
2516
2806
  _response_types_map: Dict[str, Optional[str]] = {
2517
- '200': "AddValidationRapidResult",
2807
+ '204': None,
2518
2808
  }
2519
2809
  response_data = self.api_client.call_api(
2520
2810
  *_param,
@@ -2523,10 +2813,10 @@ class ValidationSetApi:
2523
2813
  return response_data.response
2524
2814
 
2525
2815
 
2526
- def _validation_set_validation_set_id_rapid_texts_post_serialize(
2816
+ def _validation_set_validation_set_id_shouldalert_patch_serialize(
2527
2817
  self,
2528
2818
  validation_set_id,
2529
- add_validation_text_rapid_model,
2819
+ update_should_alert_model,
2530
2820
  _request_auth,
2531
2821
  _content_type,
2532
2822
  _headers,
@@ -2554,19 +2844,10 @@ class ValidationSetApi:
2554
2844
  # process the header parameters
2555
2845
  # process the form parameters
2556
2846
  # process the body parameter
2557
- if add_validation_text_rapid_model is not None:
2558
- _body_params = add_validation_text_rapid_model
2847
+ if update_should_alert_model is not None:
2848
+ _body_params = update_should_alert_model
2559
2849
 
2560
2850
 
2561
- # set the HTTP header `Accept`
2562
- if 'Accept' not in _header_params:
2563
- _header_params['Accept'] = self.api_client.select_header_accept(
2564
- [
2565
- 'text/plain',
2566
- 'application/json',
2567
- 'text/json'
2568
- ]
2569
- )
2570
2851
 
2571
2852
  # set the HTTP header `Content-Type`
2572
2853
  if _content_type:
@@ -2591,8 +2872,8 @@ class ValidationSetApi:
2591
2872
  ]
2592
2873
 
2593
2874
  return self.api_client.param_serialize(
2594
- method='POST',
2595
- resource_path='/validation-set/{validationSetId}/rapid/texts',
2875
+ method='PATCH',
2876
+ resource_path='/validation-set/{validationSetId}/shouldalert',
2596
2877
  path_params=_path_params,
2597
2878
  query_params=_query_params,
2598
2879
  header_params=_header_params,
@@ -2609,10 +2890,10 @@ class ValidationSetApi:
2609
2890
 
2610
2891
 
2611
2892
  @validate_call
2612
- def validation_set_validation_set_id_rapids_get(
2893
+ def validation_set_validation_set_id_shouldalert_put(
2613
2894
  self,
2614
- validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2615
- model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
2895
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2896
+ update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
2616
2897
  _request_timeout: Union[
2617
2898
  None,
2618
2899
  Annotated[StrictFloat, Field(gt=0)],
@@ -2625,14 +2906,14 @@ class ValidationSetApi:
2625
2906
  _content_type: Optional[StrictStr] = None,
2626
2907
  _headers: Optional[Dict[StrictStr, Any]] = None,
2627
2908
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2628
- ) -> GetValidationRapidsResultPagedResult:
2629
- """Queries the validation rapids for a specific validation set.
2909
+ ) -> None:
2910
+ """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
2630
2911
 
2631
2912
 
2632
- :param validation_set_id: The validation set to query. (required)
2913
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
2633
2914
  :type validation_set_id: str
2634
- :param model: The request formatted as a JSON in the query parameters.
2635
- :type model: QueryModel
2915
+ :param update_should_alert_model: The body request for updating the shouldAlert property.
2916
+ :type update_should_alert_model: UpdateShouldAlertModel
2636
2917
  :param _request_timeout: timeout setting for this request. If one
2637
2918
  number provided, it will be total request
2638
2919
  timeout. It can also be a pair (tuple) of
@@ -2654,10 +2935,11 @@ class ValidationSetApi:
2654
2935
  :type _host_index: int, optional
2655
2936
  :return: Returns the result object.
2656
2937
  """ # noqa: E501
2938
+ warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
2657
2939
 
2658
- _param = self._validation_set_validation_set_id_rapids_get_serialize(
2940
+ _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
2659
2941
  validation_set_id=validation_set_id,
2660
- model=model,
2942
+ update_should_alert_model=update_should_alert_model,
2661
2943
  _request_auth=_request_auth,
2662
2944
  _content_type=_content_type,
2663
2945
  _headers=_headers,
@@ -2665,7 +2947,7 @@ class ValidationSetApi:
2665
2947
  )
2666
2948
 
2667
2949
  _response_types_map: Dict[str, Optional[str]] = {
2668
- '200': "GetValidationRapidsResultPagedResult",
2950
+ '204': None,
2669
2951
  }
2670
2952
  response_data = self.api_client.call_api(
2671
2953
  *_param,
@@ -2679,10 +2961,10 @@ class ValidationSetApi:
2679
2961
 
2680
2962
 
2681
2963
  @validate_call
2682
- def validation_set_validation_set_id_rapids_get_with_http_info(
2964
+ def validation_set_validation_set_id_shouldalert_put_with_http_info(
2683
2965
  self,
2684
- validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2685
- model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
2966
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2967
+ update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
2686
2968
  _request_timeout: Union[
2687
2969
  None,
2688
2970
  Annotated[StrictFloat, Field(gt=0)],
@@ -2695,14 +2977,14 @@ class ValidationSetApi:
2695
2977
  _content_type: Optional[StrictStr] = None,
2696
2978
  _headers: Optional[Dict[StrictStr, Any]] = None,
2697
2979
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2698
- ) -> ApiResponse[GetValidationRapidsResultPagedResult]:
2699
- """Queries the validation rapids for a specific validation set.
2980
+ ) -> ApiResponse[None]:
2981
+ """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
2700
2982
 
2701
2983
 
2702
- :param validation_set_id: The validation set to query. (required)
2984
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
2703
2985
  :type validation_set_id: str
2704
- :param model: The request formatted as a JSON in the query parameters.
2705
- :type model: QueryModel
2986
+ :param update_should_alert_model: The body request for updating the shouldAlert property.
2987
+ :type update_should_alert_model: UpdateShouldAlertModel
2706
2988
  :param _request_timeout: timeout setting for this request. If one
2707
2989
  number provided, it will be total request
2708
2990
  timeout. It can also be a pair (tuple) of
@@ -2724,10 +3006,11 @@ class ValidationSetApi:
2724
3006
  :type _host_index: int, optional
2725
3007
  :return: Returns the result object.
2726
3008
  """ # noqa: E501
3009
+ warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
2727
3010
 
2728
- _param = self._validation_set_validation_set_id_rapids_get_serialize(
3011
+ _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
2729
3012
  validation_set_id=validation_set_id,
2730
- model=model,
3013
+ update_should_alert_model=update_should_alert_model,
2731
3014
  _request_auth=_request_auth,
2732
3015
  _content_type=_content_type,
2733
3016
  _headers=_headers,
@@ -2735,7 +3018,7 @@ class ValidationSetApi:
2735
3018
  )
2736
3019
 
2737
3020
  _response_types_map: Dict[str, Optional[str]] = {
2738
- '200': "GetValidationRapidsResultPagedResult",
3021
+ '204': None,
2739
3022
  }
2740
3023
  response_data = self.api_client.call_api(
2741
3024
  *_param,
@@ -2749,10 +3032,10 @@ class ValidationSetApi:
2749
3032
 
2750
3033
 
2751
3034
  @validate_call
2752
- def validation_set_validation_set_id_rapids_get_without_preload_content(
3035
+ def validation_set_validation_set_id_shouldalert_put_without_preload_content(
2753
3036
  self,
2754
- validation_set_id: Annotated[StrictStr, Field(description="The validation set to query.")],
2755
- model: Annotated[Optional[QueryModel], Field(description="The request formatted as a JSON in the query parameters.")] = None,
3037
+ validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
3038
+ update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
2756
3039
  _request_timeout: Union[
2757
3040
  None,
2758
3041
  Annotated[StrictFloat, Field(gt=0)],
@@ -2766,13 +3049,13 @@ class ValidationSetApi:
2766
3049
  _headers: Optional[Dict[StrictStr, Any]] = None,
2767
3050
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2768
3051
  ) -> RESTResponseType:
2769
- """Queries the validation rapids for a specific validation set.
3052
+ """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
2770
3053
 
2771
3054
 
2772
- :param validation_set_id: The validation set to query. (required)
3055
+ :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
2773
3056
  :type validation_set_id: str
2774
- :param model: The request formatted as a JSON in the query parameters.
2775
- :type model: QueryModel
3057
+ :param update_should_alert_model: The body request for updating the shouldAlert property.
3058
+ :type update_should_alert_model: UpdateShouldAlertModel
2776
3059
  :param _request_timeout: timeout setting for this request. If one
2777
3060
  number provided, it will be total request
2778
3061
  timeout. It can also be a pair (tuple) of
@@ -2794,10 +3077,11 @@ class ValidationSetApi:
2794
3077
  :type _host_index: int, optional
2795
3078
  :return: Returns the result object.
2796
3079
  """ # noqa: E501
3080
+ warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
2797
3081
 
2798
- _param = self._validation_set_validation_set_id_rapids_get_serialize(
3082
+ _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
2799
3083
  validation_set_id=validation_set_id,
2800
- model=model,
3084
+ update_should_alert_model=update_should_alert_model,
2801
3085
  _request_auth=_request_auth,
2802
3086
  _content_type=_content_type,
2803
3087
  _headers=_headers,
@@ -2805,7 +3089,7 @@ class ValidationSetApi:
2805
3089
  )
2806
3090
 
2807
3091
  _response_types_map: Dict[str, Optional[str]] = {
2808
- '200': "GetValidationRapidsResultPagedResult",
3092
+ '204': None,
2809
3093
  }
2810
3094
  response_data = self.api_client.call_api(
2811
3095
  *_param,
@@ -2814,10 +3098,10 @@ class ValidationSetApi:
2814
3098
  return response_data.response
2815
3099
 
2816
3100
 
2817
- def _validation_set_validation_set_id_rapids_get_serialize(
3101
+ def _validation_set_validation_set_id_shouldalert_put_serialize(
2818
3102
  self,
2819
3103
  validation_set_id,
2820
- model,
3104
+ update_should_alert_model,
2821
3105
  _request_auth,
2822
3106
  _content_type,
2823
3107
  _headers,
@@ -2842,25 +3126,29 @@ class ValidationSetApi:
2842
3126
  if validation_set_id is not None:
2843
3127
  _path_params['validationSetId'] = validation_set_id
2844
3128
  # process the query parameters
2845
- if model is not None:
2846
-
2847
- _query_params.append(('model', model))
2848
-
2849
3129
  # process the header parameters
2850
3130
  # process the form parameters
2851
3131
  # process the body parameter
3132
+ if update_should_alert_model is not None:
3133
+ _body_params = update_should_alert_model
2852
3134
 
2853
3135
 
2854
- # set the HTTP header `Accept`
2855
- if 'Accept' not in _header_params:
2856
- _header_params['Accept'] = self.api_client.select_header_accept(
2857
- [
2858
- 'text/plain',
2859
- 'application/json',
2860
- 'text/json'
2861
- ]
2862
- )
2863
3136
 
3137
+ # set the HTTP header `Content-Type`
3138
+ if _content_type:
3139
+ _header_params['Content-Type'] = _content_type
3140
+ else:
3141
+ _default_content_type = (
3142
+ self.api_client.select_header_content_type(
3143
+ [
3144
+ 'application/json',
3145
+ 'text/json',
3146
+ 'application/*+json'
3147
+ ]
3148
+ )
3149
+ )
3150
+ if _default_content_type is not None:
3151
+ _header_params['Content-Type'] = _default_content_type
2864
3152
 
2865
3153
  # authentication setting
2866
3154
  _auth_settings: List[str] = [
@@ -2869,8 +3157,8 @@ class ValidationSetApi:
2869
3157
  ]
2870
3158
 
2871
3159
  return self.api_client.param_serialize(
2872
- method='GET',
2873
- resource_path='/validation-set/{validationSetId}/rapids',
3160
+ method='PUT',
3161
+ resource_path='/validation-set/{validationSetId}/shouldalert',
2874
3162
  path_params=_path_params,
2875
3163
  query_params=_query_params,
2876
3164
  header_params=_header_params,
@@ -2887,10 +3175,9 @@ class ValidationSetApi:
2887
3175
 
2888
3176
 
2889
3177
  @validate_call
2890
- def validation_set_validation_set_id_shouldalert_patch(
3178
+ def validation_set_validation_set_id_update_labeling_hints_post(
2891
3179
  self,
2892
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2893
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
3180
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the labeling hints for.")],
2894
3181
  _request_timeout: Union[
2895
3182
  None,
2896
3183
  Annotated[StrictFloat, Field(gt=0)],
@@ -2904,13 +3191,12 @@ class ValidationSetApi:
2904
3191
  _headers: Optional[Dict[StrictStr, Any]] = None,
2905
3192
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2906
3193
  ) -> None:
2907
- """Updates the dimensions of all rapids within a validation set.
3194
+ """Refreshes the labeling hints for a validation set.
2908
3195
 
3196
+ This will sample the rapids in the validation set and update the labeling hints based on the sampled rapids.
2909
3197
 
2910
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3198
+ :param validation_set_id: The id of the validation set to update the labeling hints for. (required)
2911
3199
  :type validation_set_id: str
2912
- :param update_should_alert_model: The body request for updating the shouldAlert property.
2913
- :type update_should_alert_model: UpdateShouldAlertModel
2914
3200
  :param _request_timeout: timeout setting for this request. If one
2915
3201
  number provided, it will be total request
2916
3202
  timeout. It can also be a pair (tuple) of
@@ -2933,9 +3219,8 @@ class ValidationSetApi:
2933
3219
  :return: Returns the result object.
2934
3220
  """ # noqa: E501
2935
3221
 
2936
- _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
3222
+ _param = self._validation_set_validation_set_id_update_labeling_hints_post_serialize(
2937
3223
  validation_set_id=validation_set_id,
2938
- update_should_alert_model=update_should_alert_model,
2939
3224
  _request_auth=_request_auth,
2940
3225
  _content_type=_content_type,
2941
3226
  _headers=_headers,
@@ -2957,10 +3242,9 @@ class ValidationSetApi:
2957
3242
 
2958
3243
 
2959
3244
  @validate_call
2960
- def validation_set_validation_set_id_shouldalert_patch_with_http_info(
3245
+ def validation_set_validation_set_id_update_labeling_hints_post_with_http_info(
2961
3246
  self,
2962
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
2963
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
3247
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the labeling hints for.")],
2964
3248
  _request_timeout: Union[
2965
3249
  None,
2966
3250
  Annotated[StrictFloat, Field(gt=0)],
@@ -2974,13 +3258,12 @@ class ValidationSetApi:
2974
3258
  _headers: Optional[Dict[StrictStr, Any]] = None,
2975
3259
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2976
3260
  ) -> ApiResponse[None]:
2977
- """Updates the dimensions of all rapids within a validation set.
3261
+ """Refreshes the labeling hints for a validation set.
2978
3262
 
3263
+ This will sample the rapids in the validation set and update the labeling hints based on the sampled rapids.
2979
3264
 
2980
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3265
+ :param validation_set_id: The id of the validation set to update the labeling hints for. (required)
2981
3266
  :type validation_set_id: str
2982
- :param update_should_alert_model: The body request for updating the shouldAlert property.
2983
- :type update_should_alert_model: UpdateShouldAlertModel
2984
3267
  :param _request_timeout: timeout setting for this request. If one
2985
3268
  number provided, it will be total request
2986
3269
  timeout. It can also be a pair (tuple) of
@@ -3003,9 +3286,8 @@ class ValidationSetApi:
3003
3286
  :return: Returns the result object.
3004
3287
  """ # noqa: E501
3005
3288
 
3006
- _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
3289
+ _param = self._validation_set_validation_set_id_update_labeling_hints_post_serialize(
3007
3290
  validation_set_id=validation_set_id,
3008
- update_should_alert_model=update_should_alert_model,
3009
3291
  _request_auth=_request_auth,
3010
3292
  _content_type=_content_type,
3011
3293
  _headers=_headers,
@@ -3027,10 +3309,9 @@ class ValidationSetApi:
3027
3309
 
3028
3310
 
3029
3311
  @validate_call
3030
- def validation_set_validation_set_id_shouldalert_patch_without_preload_content(
3312
+ def validation_set_validation_set_id_update_labeling_hints_post_without_preload_content(
3031
3313
  self,
3032
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
3033
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
3314
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the labeling hints for.")],
3034
3315
  _request_timeout: Union[
3035
3316
  None,
3036
3317
  Annotated[StrictFloat, Field(gt=0)],
@@ -3044,13 +3325,12 @@ class ValidationSetApi:
3044
3325
  _headers: Optional[Dict[StrictStr, Any]] = None,
3045
3326
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3046
3327
  ) -> RESTResponseType:
3047
- """Updates the dimensions of all rapids within a validation set.
3328
+ """Refreshes the labeling hints for a validation set.
3048
3329
 
3330
+ This will sample the rapids in the validation set and update the labeling hints based on the sampled rapids.
3049
3331
 
3050
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3332
+ :param validation_set_id: The id of the validation set to update the labeling hints for. (required)
3051
3333
  :type validation_set_id: str
3052
- :param update_should_alert_model: The body request for updating the shouldAlert property.
3053
- :type update_should_alert_model: UpdateShouldAlertModel
3054
3334
  :param _request_timeout: timeout setting for this request. If one
3055
3335
  number provided, it will be total request
3056
3336
  timeout. It can also be a pair (tuple) of
@@ -3073,9 +3353,8 @@ class ValidationSetApi:
3073
3353
  :return: Returns the result object.
3074
3354
  """ # noqa: E501
3075
3355
 
3076
- _param = self._validation_set_validation_set_id_shouldalert_patch_serialize(
3356
+ _param = self._validation_set_validation_set_id_update_labeling_hints_post_serialize(
3077
3357
  validation_set_id=validation_set_id,
3078
- update_should_alert_model=update_should_alert_model,
3079
3358
  _request_auth=_request_auth,
3080
3359
  _content_type=_content_type,
3081
3360
  _headers=_headers,
@@ -3092,10 +3371,9 @@ class ValidationSetApi:
3092
3371
  return response_data.response
3093
3372
 
3094
3373
 
3095
- def _validation_set_validation_set_id_shouldalert_patch_serialize(
3374
+ def _validation_set_validation_set_id_update_labeling_hints_post_serialize(
3096
3375
  self,
3097
3376
  validation_set_id,
3098
- update_should_alert_model,
3099
3377
  _request_auth,
3100
3378
  _content_type,
3101
3379
  _headers,
@@ -3123,26 +3401,9 @@ class ValidationSetApi:
3123
3401
  # process the header parameters
3124
3402
  # process the form parameters
3125
3403
  # process the body parameter
3126
- if update_should_alert_model is not None:
3127
- _body_params = update_should_alert_model
3128
3404
 
3129
3405
 
3130
3406
 
3131
- # set the HTTP header `Content-Type`
3132
- if _content_type:
3133
- _header_params['Content-Type'] = _content_type
3134
- else:
3135
- _default_content_type = (
3136
- self.api_client.select_header_content_type(
3137
- [
3138
- 'application/json',
3139
- 'text/json',
3140
- 'application/*+json'
3141
- ]
3142
- )
3143
- )
3144
- if _default_content_type is not None:
3145
- _header_params['Content-Type'] = _default_content_type
3146
3407
 
3147
3408
  # authentication setting
3148
3409
  _auth_settings: List[str] = [
@@ -3151,8 +3412,8 @@ class ValidationSetApi:
3151
3412
  ]
3152
3413
 
3153
3414
  return self.api_client.param_serialize(
3154
- method='PATCH',
3155
- resource_path='/validation-set/{validationSetId}/shouldalert',
3415
+ method='POST',
3416
+ resource_path='/validation-set/{validationSetId}/update-labeling-hints',
3156
3417
  path_params=_path_params,
3157
3418
  query_params=_query_params,
3158
3419
  header_params=_header_params,
@@ -3169,10 +3430,10 @@ class ValidationSetApi:
3169
3430
 
3170
3431
 
3171
3432
  @validate_call
3172
- def validation_set_validation_set_id_shouldalert_put(
3433
+ def validation_set_validation_set_id_visibility_patch(
3173
3434
  self,
3174
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
3175
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
3435
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
3436
+ is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
3176
3437
  _request_timeout: Union[
3177
3438
  None,
3178
3439
  Annotated[StrictFloat, Field(gt=0)],
@@ -3186,13 +3447,14 @@ class ValidationSetApi:
3186
3447
  _headers: Optional[Dict[StrictStr, Any]] = None,
3187
3448
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3188
3449
  ) -> None:
3189
- """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
3450
+ """Updates the visibility of a validation set.
3190
3451
 
3452
+ Public validation sets are used to automatically add a validation set to an order if no validation set is specified. If the validation set is made public, the labeling hints will be updated automatically.
3191
3453
 
3192
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3454
+ :param validation_set_id: The id of the validation set to update the visibility for. (required)
3193
3455
  :type validation_set_id: str
3194
- :param update_should_alert_model: The body request for updating the shouldAlert property.
3195
- :type update_should_alert_model: UpdateShouldAlertModel
3456
+ :param is_public: Whether the validation set should be public or private.
3457
+ :type is_public: bool
3196
3458
  :param _request_timeout: timeout setting for this request. If one
3197
3459
  number provided, it will be total request
3198
3460
  timeout. It can also be a pair (tuple) of
@@ -3214,11 +3476,10 @@ class ValidationSetApi:
3214
3476
  :type _host_index: int, optional
3215
3477
  :return: Returns the result object.
3216
3478
  """ # noqa: E501
3217
- warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
3218
3479
 
3219
- _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
3480
+ _param = self._validation_set_validation_set_id_visibility_patch_serialize(
3220
3481
  validation_set_id=validation_set_id,
3221
- update_should_alert_model=update_should_alert_model,
3482
+ is_public=is_public,
3222
3483
  _request_auth=_request_auth,
3223
3484
  _content_type=_content_type,
3224
3485
  _headers=_headers,
@@ -3240,10 +3501,10 @@ class ValidationSetApi:
3240
3501
 
3241
3502
 
3242
3503
  @validate_call
3243
- def validation_set_validation_set_id_shouldalert_put_with_http_info(
3504
+ def validation_set_validation_set_id_visibility_patch_with_http_info(
3244
3505
  self,
3245
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
3246
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
3506
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
3507
+ is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
3247
3508
  _request_timeout: Union[
3248
3509
  None,
3249
3510
  Annotated[StrictFloat, Field(gt=0)],
@@ -3257,13 +3518,14 @@ class ValidationSetApi:
3257
3518
  _headers: Optional[Dict[StrictStr, Any]] = None,
3258
3519
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3259
3520
  ) -> ApiResponse[None]:
3260
- """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
3521
+ """Updates the visibility of a validation set.
3261
3522
 
3523
+ Public validation sets are used to automatically add a validation set to an order if no validation set is specified. If the validation set is made public, the labeling hints will be updated automatically.
3262
3524
 
3263
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3525
+ :param validation_set_id: The id of the validation set to update the visibility for. (required)
3264
3526
  :type validation_set_id: str
3265
- :param update_should_alert_model: The body request for updating the shouldAlert property.
3266
- :type update_should_alert_model: UpdateShouldAlertModel
3527
+ :param is_public: Whether the validation set should be public or private.
3528
+ :type is_public: bool
3267
3529
  :param _request_timeout: timeout setting for this request. If one
3268
3530
  number provided, it will be total request
3269
3531
  timeout. It can also be a pair (tuple) of
@@ -3285,11 +3547,10 @@ class ValidationSetApi:
3285
3547
  :type _host_index: int, optional
3286
3548
  :return: Returns the result object.
3287
3549
  """ # noqa: E501
3288
- warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
3289
3550
 
3290
- _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
3551
+ _param = self._validation_set_validation_set_id_visibility_patch_serialize(
3291
3552
  validation_set_id=validation_set_id,
3292
- update_should_alert_model=update_should_alert_model,
3553
+ is_public=is_public,
3293
3554
  _request_auth=_request_auth,
3294
3555
  _content_type=_content_type,
3295
3556
  _headers=_headers,
@@ -3311,10 +3572,10 @@ class ValidationSetApi:
3311
3572
 
3312
3573
 
3313
3574
  @validate_call
3314
- def validation_set_validation_set_id_shouldalert_put_without_preload_content(
3575
+ def validation_set_validation_set_id_visibility_patch_without_preload_content(
3315
3576
  self,
3316
- validation_set_id: Annotated[StrictStr, Field(description="The Id of the validation set to update the dimensions for.")],
3317
- update_should_alert_model: Annotated[Optional[UpdateShouldAlertModel], Field(description="The body request for updating the shouldAlert property.")] = None,
3577
+ validation_set_id: Annotated[StrictStr, Field(description="The id of the validation set to update the visibility for.")],
3578
+ is_public: Annotated[Optional[StrictBool], Field(description="Whether the validation set should be public or private.")] = None,
3318
3579
  _request_timeout: Union[
3319
3580
  None,
3320
3581
  Annotated[StrictFloat, Field(gt=0)],
@@ -3328,13 +3589,14 @@ class ValidationSetApi:
3328
3589
  _headers: Optional[Dict[StrictStr, Any]] = None,
3329
3590
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
3330
3591
  ) -> RESTResponseType:
3331
- """(Deprecated) Updates the of all rapshouldAlert property of all rapids within a validation set.
3592
+ """Updates the visibility of a validation set.
3332
3593
 
3594
+ Public validation sets are used to automatically add a validation set to an order if no validation set is specified. If the validation set is made public, the labeling hints will be updated automatically.
3333
3595
 
3334
- :param validation_set_id: The Id of the validation set to update the dimensions for. (required)
3596
+ :param validation_set_id: The id of the validation set to update the visibility for. (required)
3335
3597
  :type validation_set_id: str
3336
- :param update_should_alert_model: The body request for updating the shouldAlert property.
3337
- :type update_should_alert_model: UpdateShouldAlertModel
3598
+ :param is_public: Whether the validation set should be public or private.
3599
+ :type is_public: bool
3338
3600
  :param _request_timeout: timeout setting for this request. If one
3339
3601
  number provided, it will be total request
3340
3602
  timeout. It can also be a pair (tuple) of
@@ -3356,11 +3618,10 @@ class ValidationSetApi:
3356
3618
  :type _host_index: int, optional
3357
3619
  :return: Returns the result object.
3358
3620
  """ # noqa: E501
3359
- warnings.warn("PUT /validation-set/{validationSetId}/shouldalert is deprecated.", DeprecationWarning)
3360
3621
 
3361
- _param = self._validation_set_validation_set_id_shouldalert_put_serialize(
3622
+ _param = self._validation_set_validation_set_id_visibility_patch_serialize(
3362
3623
  validation_set_id=validation_set_id,
3363
- update_should_alert_model=update_should_alert_model,
3624
+ is_public=is_public,
3364
3625
  _request_auth=_request_auth,
3365
3626
  _content_type=_content_type,
3366
3627
  _headers=_headers,
@@ -3377,10 +3638,10 @@ class ValidationSetApi:
3377
3638
  return response_data.response
3378
3639
 
3379
3640
 
3380
- def _validation_set_validation_set_id_shouldalert_put_serialize(
3641
+ def _validation_set_validation_set_id_visibility_patch_serialize(
3381
3642
  self,
3382
3643
  validation_set_id,
3383
- update_should_alert_model,
3644
+ is_public,
3384
3645
  _request_auth,
3385
3646
  _content_type,
3386
3647
  _headers,
@@ -3405,29 +3666,16 @@ class ValidationSetApi:
3405
3666
  if validation_set_id is not None:
3406
3667
  _path_params['validationSetId'] = validation_set_id
3407
3668
  # process the query parameters
3669
+ if is_public is not None:
3670
+
3671
+ _query_params.append(('isPublic', is_public))
3672
+
3408
3673
  # process the header parameters
3409
3674
  # process the form parameters
3410
3675
  # process the body parameter
3411
- if update_should_alert_model is not None:
3412
- _body_params = update_should_alert_model
3413
3676
 
3414
3677
 
3415
3678
 
3416
- # set the HTTP header `Content-Type`
3417
- if _content_type:
3418
- _header_params['Content-Type'] = _content_type
3419
- else:
3420
- _default_content_type = (
3421
- self.api_client.select_header_content_type(
3422
- [
3423
- 'application/json',
3424
- 'text/json',
3425
- 'application/*+json'
3426
- ]
3427
- )
3428
- )
3429
- if _default_content_type is not None:
3430
- _header_params['Content-Type'] = _default_content_type
3431
3679
 
3432
3680
  # authentication setting
3433
3681
  _auth_settings: List[str] = [
@@ -3436,8 +3684,8 @@ class ValidationSetApi:
3436
3684
  ]
3437
3685
 
3438
3686
  return self.api_client.param_serialize(
3439
- method='PUT',
3440
- resource_path='/validation-set/{validationSetId}/shouldalert',
3687
+ method='PATCH',
3688
+ resource_path='/validation-set/{validationSetId}/visibility',
3441
3689
  path_params=_path_params,
3442
3690
  query_params=_query_params,
3443
3691
  header_params=_header_params,
@@ -4264,7 +4512,7 @@ class ValidationSetApi:
4264
4512
  _headers: Optional[Dict[StrictStr, Any]] = None,
4265
4513
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4266
4514
  ) -> ValidationSetModelPagedResult:
4267
- """Queries validation sets based on the provided filter, paging and sorting criteria.
4515
+ """Queries available validation sets based on the provided filter, paging and sorting criteria.
4268
4516
 
4269
4517
 
4270
4518
  :param model: The model containing the query parameters.
@@ -4330,7 +4578,7 @@ class ValidationSetApi:
4330
4578
  _headers: Optional[Dict[StrictStr, Any]] = None,
4331
4579
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4332
4580
  ) -> ApiResponse[ValidationSetModelPagedResult]:
4333
- """Queries validation sets based on the provided filter, paging and sorting criteria.
4581
+ """Queries available validation sets based on the provided filter, paging and sorting criteria.
4334
4582
 
4335
4583
 
4336
4584
  :param model: The model containing the query parameters.
@@ -4396,7 +4644,7 @@ class ValidationSetApi:
4396
4644
  _headers: Optional[Dict[StrictStr, Any]] = None,
4397
4645
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
4398
4646
  ) -> RESTResponseType:
4399
- """Queries validation sets based on the provided filter, paging and sorting criteria.
4647
+ """Queries available validation sets based on the provided filter, paging and sorting criteria.
4400
4648
 
4401
4649
 
4402
4650
  :param model: The model containing the query parameters.