rapidata 2.35.3__py3-none-any.whl → 2.36.1__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 (58) hide show
  1. rapidata/__init__.py +1 -1
  2. rapidata/api_client/__init__.py +25 -4
  3. rapidata/api_client/api/__init__.py +1 -0
  4. rapidata/api_client/api/benchmark_api.py +294 -0
  5. rapidata/api_client/api/campaign_api.py +268 -0
  6. rapidata/api_client/api/customer_rapid_api.py +247 -0
  7. rapidata/api_client/api/leaderboard_api.py +295 -6
  8. rapidata/api_client/api/pipeline_api.py +0 -873
  9. rapidata/api_client/api/sample_api.py +299 -0
  10. rapidata/api_client/api/validation_set_api.py +537 -312
  11. rapidata/api_client/models/__init__.py +24 -4
  12. rapidata/api_client/models/add_validation_rapid_model.py +12 -2
  13. rapidata/api_client/models/add_validation_rapid_model_truth.py +7 -1
  14. rapidata/api_client/models/and_filter.py +121 -0
  15. rapidata/api_client/models/and_filter_filters_inner.py +268 -0
  16. rapidata/api_client/models/asset_type.py +40 -0
  17. rapidata/api_client/models/boost_mode.py +37 -0
  18. rapidata/api_client/models/boost_query_result.py +10 -1
  19. rapidata/api_client/models/campaign_filter.py +98 -0
  20. rapidata/api_client/models/change_boost_model.py +89 -0
  21. rapidata/api_client/models/compare_rapid_blueprint.py +5 -3
  22. rapidata/api_client/models/compare_rapid_blueprint1.py +96 -0
  23. rapidata/api_client/models/country_filter.py +98 -0
  24. rapidata/api_client/models/create_leaderboard_model.py +32 -2
  25. rapidata/api_client/models/demographic_filter.py +100 -0
  26. rapidata/api_client/models/feature_flag_model.py +4 -4
  27. rapidata/api_client/models/free_text_payload.py +10 -3
  28. rapidata/api_client/models/free_text_rapid_blueprint.py +10 -3
  29. rapidata/api_client/models/get_compare_ab_summary_result.py +4 -2
  30. rapidata/api_client/models/get_leaderboard_by_id_result.py +29 -2
  31. rapidata/api_client/models/get_public_responses_result.py +95 -0
  32. rapidata/api_client/models/get_sample_by_id_result.py +126 -0
  33. rapidata/api_client/models/language_filter.py +98 -0
  34. rapidata/api_client/models/leaderboard_query_result.py +29 -2
  35. rapidata/api_client/models/new_user_filter.py +96 -0
  36. rapidata/api_client/models/not_filter.py +117 -0
  37. rapidata/api_client/models/or_filter.py +121 -0
  38. rapidata/api_client/models/prompt_type.py +38 -0
  39. rapidata/api_client/models/public_rapid_response.py +112 -0
  40. rapidata/api_client/models/rapid_modality.py +46 -0
  41. rapidata/api_client/models/response_count_filter.py +109 -0
  42. rapidata/api_client/models/sample_by_identifier.py +126 -0
  43. rapidata/api_client/models/sample_by_identifier_paged_result.py +105 -0
  44. rapidata/api_client/models/simple_workflow_config_blueprint.py +37 -23
  45. rapidata/api_client/models/update_leaderboard_model.py +91 -0
  46. rapidata/api_client/models/user_score_filter.py +102 -0
  47. rapidata/api_client/models/user_state.py +38 -0
  48. rapidata/api_client/models/user_state_filter.py +101 -0
  49. rapidata/api_client/models/validation_set_model.py +54 -3
  50. rapidata/api_client_README.md +33 -10
  51. rapidata/rapidata_client/benchmark/rapidata_benchmark.py +26 -2
  52. rapidata/rapidata_client/order/rapidata_order_manager.py +298 -219
  53. rapidata/rapidata_client/workflow/_compare_workflow.py +7 -2
  54. rapidata/rapidata_client/workflow/_free_text_workflow.py +9 -2
  55. {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/METADATA +1 -1
  56. {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/RECORD +58 -32
  57. {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/LICENSE +0 -0
  58. {rapidata-2.35.3.dist-info → rapidata-2.36.1.dist-info}/WHEEL +0 -0
rapidata/__init__.py CHANGED
@@ -1,4 +1,4 @@
1
- __version__ = "2.35.3"
1
+ __version__ = "2.36.1"
2
2
 
3
3
  from .rapidata_client import (
4
4
  RapidataClient,
@@ -35,6 +35,7 @@ from rapidata.api_client.api.participant_api import ParticipantApi
35
35
  from rapidata.api_client.api.pipeline_api import PipelineApi
36
36
  from rapidata.api_client.api.prompt_api import PromptApi
37
37
  from rapidata.api_client.api.rapidata_identity_api_api import RapidataIdentityAPIApi
38
+ from rapidata.api_client.api.sample_api import SampleApi
38
39
  from rapidata.api_client.api.simple_workflow_api import SimpleWorkflowApi
39
40
  from rapidata.api_client.api.user_info_api import UserInfoApi
40
41
  from rapidata.api_client.api.user_rapid_api import UserRapidApi
@@ -55,29 +56,30 @@ from rapidata.api_client.exceptions import ApiException
55
56
  # import models into sdk package
56
57
  from rapidata.api_client.models.ab_test_selection import AbTestSelection
57
58
  from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
58
- from rapidata.api_client.models.add_campaign_artifact_result import AddCampaignArtifactResult
59
- from rapidata.api_client.models.add_campaign_model import AddCampaignModel
60
59
  from rapidata.api_client.models.add_user_response_result import AddUserResponseResult
61
60
  from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
62
61
  from rapidata.api_client.models.add_validation_rapid_model_payload import AddValidationRapidModelPayload
63
62
  from rapidata.api_client.models.add_validation_rapid_model_truth import AddValidationRapidModelTruth
64
63
  from rapidata.api_client.models.add_validation_rapid_result import AddValidationRapidResult
65
- from rapidata.api_client.models.add_validation_text_rapid_model import AddValidationTextRapidModel
66
64
  from rapidata.api_client.models.age_group import AgeGroup
67
65
  from rapidata.api_client.models.age_user_filter_model import AgeUserFilterModel
68
66
  from rapidata.api_client.models.aggregator_type import AggregatorType
67
+ from rapidata.api_client.models.and_filter import AndFilter
68
+ from rapidata.api_client.models.and_filter_filters_inner import AndFilterFiltersInner
69
69
  from rapidata.api_client.models.and_user_filter_model import AndUserFilterModel
70
70
  from rapidata.api_client.models.and_user_filter_model_filters_inner import AndUserFilterModelFiltersInner
71
71
  from rapidata.api_client.models.are_rapids_active_result import AreRapidsActiveResult
72
72
  from rapidata.api_client.models.asset_metadata import AssetMetadata
73
73
  from rapidata.api_client.models.asset_metadata_asset import AssetMetadataAsset
74
74
  from rapidata.api_client.models.asset_metadata_model import AssetMetadataModel
75
+ from rapidata.api_client.models.asset_type import AssetType
75
76
  from rapidata.api_client.models.attach_category_rapid_blueprint import AttachCategoryRapidBlueprint
76
77
  from rapidata.api_client.models.attach_category_result import AttachCategoryResult
77
78
  from rapidata.api_client.models.attach_category_truth import AttachCategoryTruth
78
79
  from rapidata.api_client.models.benchmark_query_result import BenchmarkQueryResult
79
80
  from rapidata.api_client.models.benchmark_query_result_paged_result import BenchmarkQueryResultPagedResult
80
81
  from rapidata.api_client.models.boost_leaderboard_model import BoostLeaderboardModel
82
+ from rapidata.api_client.models.boost_mode import BoostMode
81
83
  from rapidata.api_client.models.boost_query_result import BoostQueryResult
82
84
  from rapidata.api_client.models.boost_status import BoostStatus
83
85
  from rapidata.api_client.models.bounding_box_payload import BoundingBoxPayload
@@ -86,11 +88,13 @@ from rapidata.api_client.models.bounding_box_result import BoundingBoxResult
86
88
  from rapidata.api_client.models.bounding_box_truth import BoundingBoxTruth
87
89
  from rapidata.api_client.models.box_shape import BoxShape
88
90
  from rapidata.api_client.models.campaign_artifact_model import CampaignArtifactModel
91
+ from rapidata.api_client.models.campaign_filter import CampaignFilter
89
92
  from rapidata.api_client.models.campaign_query_result import CampaignQueryResult
90
93
  from rapidata.api_client.models.campaign_query_result_paged_result import CampaignQueryResultPagedResult
91
94
  from rapidata.api_client.models.campaign_status import CampaignStatus
92
95
  from rapidata.api_client.models.campaign_user_filter_model import CampaignUserFilterModel
93
96
  from rapidata.api_client.models.capped_selection import CappedSelection
97
+ from rapidata.api_client.models.change_boost_model import ChangeBoostModel
94
98
  from rapidata.api_client.models.classification_metadata import ClassificationMetadata
95
99
  from rapidata.api_client.models.classification_metadata_filter_config import ClassificationMetadataFilterConfig
96
100
  from rapidata.api_client.models.classification_metadata_model import ClassificationMetadataModel
@@ -121,6 +125,7 @@ from rapidata.api_client.models.coordinate import Coordinate
121
125
  from rapidata.api_client.models.count_classification_metadata_filter_config import CountClassificationMetadataFilterConfig
122
126
  from rapidata.api_client.models.count_metadata import CountMetadata
123
127
  from rapidata.api_client.models.count_metadata_model import CountMetadataModel
128
+ from rapidata.api_client.models.country_filter import CountryFilter
124
129
  from rapidata.api_client.models.country_user_filter_model import CountryUserFilterModel
125
130
  from rapidata.api_client.models.create_benchmark_model import CreateBenchmarkModel
126
131
  from rapidata.api_client.models.create_benchmark_participant_model import CreateBenchmarkParticipantModel
@@ -164,6 +169,7 @@ from rapidata.api_client.models.dataset_artifact_model import DatasetArtifactMod
164
169
  from rapidata.api_client.models.dataset_dataset_id_datapoints_post_request_metadata_inner import DatasetDatasetIdDatapointsPostRequestMetadataInner
165
170
  from rapidata.api_client.models.dataset_evaluation_step_model import DatasetEvaluationStepModel
166
171
  from rapidata.api_client.models.demographic import Demographic
172
+ from rapidata.api_client.models.demographic_filter import DemographicFilter
167
173
  from rapidata.api_client.models.demographic_metadata_model import DemographicMetadataModel
168
174
  from rapidata.api_client.models.demographic_selection import DemographicSelection
169
175
  from rapidata.api_client.models.dynamic_client_registration_request import DynamicClientRegistrationRequest
@@ -215,8 +221,10 @@ from rapidata.api_client.models.get_participant_by_id_result import GetParticipa
215
221
  from rapidata.api_client.models.get_pipeline_by_id_result import GetPipelineByIdResult
216
222
  from rapidata.api_client.models.get_pipeline_by_id_result_artifacts_value import GetPipelineByIdResultArtifactsValue
217
223
  from rapidata.api_client.models.get_public_orders_result import GetPublicOrdersResult
224
+ from rapidata.api_client.models.get_public_responses_result import GetPublicResponsesResult
218
225
  from rapidata.api_client.models.get_rapid_responses_result import GetRapidResponsesResult
219
226
  from rapidata.api_client.models.get_responses_result import GetResponsesResult
227
+ from rapidata.api_client.models.get_sample_by_id_result import GetSampleByIdResult
220
228
  from rapidata.api_client.models.get_simple_workflow_results_model import GetSimpleWorkflowResultsModel
221
229
  from rapidata.api_client.models.get_standing_by_id_result import GetStandingByIdResult
222
230
  from rapidata.api_client.models.get_validation_rapids_result import GetValidationRapidsResult
@@ -240,6 +248,7 @@ from rapidata.api_client.models.inspect_report_result import InspectReportResult
240
248
  from rapidata.api_client.models.json_web_key import JsonWebKey
241
249
  from rapidata.api_client.models.json_web_key_set import JsonWebKeySet
242
250
  from rapidata.api_client.models.labeling_selection import LabelingSelection
251
+ from rapidata.api_client.models.language_filter import LanguageFilter
243
252
  from rapidata.api_client.models.language_user_filter_model import LanguageUserFilterModel
244
253
  from rapidata.api_client.models.leaderboard_query_result import LeaderboardQueryResult
245
254
  from rapidata.api_client.models.leaderboard_query_result_paged_result import LeaderboardQueryResultPagedResult
@@ -280,15 +289,18 @@ from rapidata.api_client.models.named_entity_result import NamedEntityResult
280
289
  from rapidata.api_client.models.named_entity_truth import NamedEntityTruth
281
290
  from rapidata.api_client.models.never_ending_referee_config import NeverEndingRefereeConfig
282
291
  from rapidata.api_client.models.never_ending_referee_info import NeverEndingRefereeInfo
292
+ from rapidata.api_client.models.new_user_filter import NewUserFilter
283
293
  from rapidata.api_client.models.new_user_filter_model import NewUserFilterModel
284
294
  from rapidata.api_client.models.newsletter_model import NewsletterModel
285
295
  from rapidata.api_client.models.not_available_yet_result import NotAvailableYetResult
296
+ from rapidata.api_client.models.not_filter import NotFilter
286
297
  from rapidata.api_client.models.not_user_filter_model import NotUserFilterModel
287
298
  from rapidata.api_client.models.null_asset import NullAsset
288
299
  from rapidata.api_client.models.null_asset_model import NullAssetModel
289
300
  from rapidata.api_client.models.online_pair_maker_config import OnlinePairMakerConfig
290
301
  from rapidata.api_client.models.online_pair_maker_config_model import OnlinePairMakerConfigModel
291
302
  from rapidata.api_client.models.online_pair_maker_information import OnlinePairMakerInformation
303
+ from rapidata.api_client.models.or_filter import OrFilter
292
304
  from rapidata.api_client.models.or_user_filter_model import OrUserFilterModel
293
305
  from rapidata.api_client.models.order_model import OrderModel
294
306
  from rapidata.api_client.models.order_model_paged_result import OrderModelPagedResult
@@ -320,12 +332,15 @@ from rapidata.api_client.models.prompt_by_benchmark_result_paged_result import P
320
332
  from rapidata.api_client.models.prompt_metadata import PromptMetadata
321
333
  from rapidata.api_client.models.prompt_metadata_input import PromptMetadataInput
322
334
  from rapidata.api_client.models.prompt_metadata_model import PromptMetadataModel
335
+ from rapidata.api_client.models.prompt_type import PromptType
323
336
  from rapidata.api_client.models.proxy_file_wrapper import ProxyFileWrapper
324
337
  from rapidata.api_client.models.public_order_model import PublicOrderModel
338
+ from rapidata.api_client.models.public_rapid_response import PublicRapidResponse
325
339
  from rapidata.api_client.models.public_text_metadata_input import PublicTextMetadataInput
326
340
  from rapidata.api_client.models.query_model import QueryModel
327
341
  from rapidata.api_client.models.query_validation_model import QueryValidationModel
328
342
  from rapidata.api_client.models.rapid_issue import RapidIssue
343
+ from rapidata.api_client.models.rapid_modality import RapidModality
329
344
  from rapidata.api_client.models.rapid_model import RapidModel
330
345
  from rapidata.api_client.models.rapid_model_paged_result import RapidModelPagedResult
331
346
  from rapidata.api_client.models.rapid_model_referee import RapidModelReferee
@@ -339,12 +354,15 @@ from rapidata.api_client.models.read_bridge_token_keys_result import ReadBridgeT
339
354
  from rapidata.api_client.models.register_temporary_customer_model import RegisterTemporaryCustomerModel
340
355
  from rapidata.api_client.models.register_temporary_customer_result import RegisterTemporaryCustomerResult
341
356
  from rapidata.api_client.models.report_model import ReportModel
357
+ from rapidata.api_client.models.response_count_filter import ResponseCountFilter
342
358
  from rapidata.api_client.models.response_count_user_filter_model import ResponseCountUserFilterModel
343
359
  from rapidata.api_client.models.retrieval_mode import RetrievalMode
344
360
  from rapidata.api_client.models.root_filter import RootFilter
345
361
  from rapidata.api_client.models.run_status import RunStatus
346
362
  from rapidata.api_client.models.runs_by_leaderboard_result import RunsByLeaderboardResult
347
363
  from rapidata.api_client.models.runs_by_leaderboard_result_paged_result import RunsByLeaderboardResultPagedResult
364
+ from rapidata.api_client.models.sample_by_identifier import SampleByIdentifier
365
+ from rapidata.api_client.models.sample_by_identifier_paged_result import SampleByIdentifierPagedResult
348
366
  from rapidata.api_client.models.sample_by_participant import SampleByParticipant
349
367
  from rapidata.api_client.models.sample_by_participant_paged_result import SampleByParticipantPagedResult
350
368
  from rapidata.api_client.models.scrub_payload import ScrubPayload
@@ -400,9 +418,9 @@ from rapidata.api_client.models.translated_prompt_metadata_model import Translat
400
418
  from rapidata.api_client.models.translated_string import TranslatedString
401
419
  from rapidata.api_client.models.unlock_order_result import UnlockOrderResult
402
420
  from rapidata.api_client.models.update_benchmark_name_model import UpdateBenchmarkNameModel
403
- from rapidata.api_client.models.update_campaign_model import UpdateCampaignModel
404
421
  from rapidata.api_client.models.update_dataset_name_model import UpdateDatasetNameModel
405
422
  from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
423
+ from rapidata.api_client.models.update_leaderboard_model import UpdateLeaderboardModel
406
424
  from rapidata.api_client.models.update_leaderboard_name_model import UpdateLeaderboardNameModel
407
425
  from rapidata.api_client.models.update_leaderboard_response_config_model import UpdateLeaderboardResponseConfigModel
408
426
  from rapidata.api_client.models.update_order_name_model import UpdateOrderNameModel
@@ -414,7 +432,10 @@ from rapidata.api_client.models.update_validation_rapid_model_truth import Updat
414
432
  from rapidata.api_client.models.upload_coco_result import UploadCocoResult
415
433
  from rapidata.api_client.models.upload_from_s3_result import UploadFromS3Result
416
434
  from rapidata.api_client.models.url_asset_input import UrlAssetInput
435
+ from rapidata.api_client.models.user_score_filter import UserScoreFilter
417
436
  from rapidata.api_client.models.user_score_user_filter_model import UserScoreUserFilterModel
437
+ from rapidata.api_client.models.user_state import UserState
438
+ from rapidata.api_client.models.user_state_filter import UserStateFilter
418
439
  from rapidata.api_client.models.validation_chance import ValidationChance
419
440
  from rapidata.api_client.models.validation_selection import ValidationSelection
420
441
  from rapidata.api_client.models.validation_set_model import ValidationSetModel
@@ -19,6 +19,7 @@ from rapidata.api_client.api.participant_api import ParticipantApi
19
19
  from rapidata.api_client.api.pipeline_api import PipelineApi
20
20
  from rapidata.api_client.api.prompt_api import PromptApi
21
21
  from rapidata.api_client.api.rapidata_identity_api_api import RapidataIdentityAPIApi
22
+ from rapidata.api_client.api.sample_api import SampleApi
22
23
  from rapidata.api_client.api.simple_workflow_api import SimpleWorkflowApi
23
24
  from rapidata.api_client.api.user_info_api import UserInfoApi
24
25
  from rapidata.api_client.api.user_rapid_api import UserRapidApi
@@ -28,6 +28,7 @@ from rapidata.api_client.models.get_benchmark_by_id_result import GetBenchmarkBy
28
28
  from rapidata.api_client.models.participant_by_benchmark_paged_result import ParticipantByBenchmarkPagedResult
29
29
  from rapidata.api_client.models.prompt_by_benchmark_result_paged_result import PromptByBenchmarkResultPagedResult
30
30
  from rapidata.api_client.models.query_model import QueryModel
31
+ from rapidata.api_client.models.sample_by_identifier_paged_result import SampleByIdentifierPagedResult
31
32
  from rapidata.api_client.models.submit_participant_result import SubmitParticipantResult
32
33
  from rapidata.api_client.models.submit_prompt_model import SubmitPromptModel
33
34
  from rapidata.api_client.models.tags_by_benchmark_result import TagsByBenchmarkResult
@@ -2507,6 +2508,299 @@ class BenchmarkApi:
2507
2508
 
2508
2509
 
2509
2510
 
2511
+ @validate_call
2512
+ def benchmark_benchmark_id_samples_identifier_get(
2513
+ self,
2514
+ benchmark_id: Annotated[StrictStr, Field(description="The id of the benchmark to query")],
2515
+ identifier: Annotated[StrictStr, Field(description="The identifier to filter all samples for")],
2516
+ request: Annotated[Optional[QueryModel], Field(description="additional query settings")] = None,
2517
+ _request_timeout: Union[
2518
+ None,
2519
+ Annotated[StrictFloat, Field(gt=0)],
2520
+ Tuple[
2521
+ Annotated[StrictFloat, Field(gt=0)],
2522
+ Annotated[StrictFloat, Field(gt=0)]
2523
+ ]
2524
+ ] = None,
2525
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2526
+ _content_type: Optional[StrictStr] = None,
2527
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2528
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2529
+ ) -> SampleByIdentifierPagedResult:
2530
+ """Returns the paged prompts of a benchmark by its ID.
2531
+
2532
+
2533
+ :param benchmark_id: The id of the benchmark to query (required)
2534
+ :type benchmark_id: str
2535
+ :param identifier: The identifier to filter all samples for (required)
2536
+ :type identifier: str
2537
+ :param request: additional query settings
2538
+ :type request: QueryModel
2539
+ :param _request_timeout: timeout setting for this request. If one
2540
+ number provided, it will be total request
2541
+ timeout. It can also be a pair (tuple) of
2542
+ (connection, read) timeouts.
2543
+ :type _request_timeout: int, tuple(int, int), optional
2544
+ :param _request_auth: set to override the auth_settings for an a single
2545
+ request; this effectively ignores the
2546
+ authentication in the spec for a single request.
2547
+ :type _request_auth: dict, optional
2548
+ :param _content_type: force content-type for the request.
2549
+ :type _content_type: str, Optional
2550
+ :param _headers: set to override the headers for a single
2551
+ request; this effectively ignores the headers
2552
+ in the spec for a single request.
2553
+ :type _headers: dict, optional
2554
+ :param _host_index: set to override the host_index for a single
2555
+ request; this effectively ignores the host_index
2556
+ in the spec for a single request.
2557
+ :type _host_index: int, optional
2558
+ :return: Returns the result object.
2559
+ """ # noqa: E501
2560
+
2561
+ _param = self._benchmark_benchmark_id_samples_identifier_get_serialize(
2562
+ benchmark_id=benchmark_id,
2563
+ identifier=identifier,
2564
+ request=request,
2565
+ _request_auth=_request_auth,
2566
+ _content_type=_content_type,
2567
+ _headers=_headers,
2568
+ _host_index=_host_index
2569
+ )
2570
+
2571
+ _response_types_map: Dict[str, Optional[str]] = {
2572
+ '200': "SampleByIdentifierPagedResult",
2573
+ }
2574
+ response_data = self.api_client.call_api(
2575
+ *_param,
2576
+ _request_timeout=_request_timeout
2577
+ )
2578
+ response_data.read()
2579
+ return self.api_client.response_deserialize(
2580
+ response_data=response_data,
2581
+ response_types_map=_response_types_map,
2582
+ ).data
2583
+
2584
+
2585
+ @validate_call
2586
+ def benchmark_benchmark_id_samples_identifier_get_with_http_info(
2587
+ self,
2588
+ benchmark_id: Annotated[StrictStr, Field(description="The id of the benchmark to query")],
2589
+ identifier: Annotated[StrictStr, Field(description="The identifier to filter all samples for")],
2590
+ request: Annotated[Optional[QueryModel], Field(description="additional query settings")] = None,
2591
+ _request_timeout: Union[
2592
+ None,
2593
+ Annotated[StrictFloat, Field(gt=0)],
2594
+ Tuple[
2595
+ Annotated[StrictFloat, Field(gt=0)],
2596
+ Annotated[StrictFloat, Field(gt=0)]
2597
+ ]
2598
+ ] = None,
2599
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2600
+ _content_type: Optional[StrictStr] = None,
2601
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2602
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2603
+ ) -> ApiResponse[SampleByIdentifierPagedResult]:
2604
+ """Returns the paged prompts of a benchmark by its ID.
2605
+
2606
+
2607
+ :param benchmark_id: The id of the benchmark to query (required)
2608
+ :type benchmark_id: str
2609
+ :param identifier: The identifier to filter all samples for (required)
2610
+ :type identifier: str
2611
+ :param request: additional query settings
2612
+ :type request: QueryModel
2613
+ :param _request_timeout: timeout setting for this request. If one
2614
+ number provided, it will be total request
2615
+ timeout. It can also be a pair (tuple) of
2616
+ (connection, read) timeouts.
2617
+ :type _request_timeout: int, tuple(int, int), optional
2618
+ :param _request_auth: set to override the auth_settings for an a single
2619
+ request; this effectively ignores the
2620
+ authentication in the spec for a single request.
2621
+ :type _request_auth: dict, optional
2622
+ :param _content_type: force content-type for the request.
2623
+ :type _content_type: str, Optional
2624
+ :param _headers: set to override the headers for a single
2625
+ request; this effectively ignores the headers
2626
+ in the spec for a single request.
2627
+ :type _headers: dict, optional
2628
+ :param _host_index: set to override the host_index for a single
2629
+ request; this effectively ignores the host_index
2630
+ in the spec for a single request.
2631
+ :type _host_index: int, optional
2632
+ :return: Returns the result object.
2633
+ """ # noqa: E501
2634
+
2635
+ _param = self._benchmark_benchmark_id_samples_identifier_get_serialize(
2636
+ benchmark_id=benchmark_id,
2637
+ identifier=identifier,
2638
+ request=request,
2639
+ _request_auth=_request_auth,
2640
+ _content_type=_content_type,
2641
+ _headers=_headers,
2642
+ _host_index=_host_index
2643
+ )
2644
+
2645
+ _response_types_map: Dict[str, Optional[str]] = {
2646
+ '200': "SampleByIdentifierPagedResult",
2647
+ }
2648
+ response_data = self.api_client.call_api(
2649
+ *_param,
2650
+ _request_timeout=_request_timeout
2651
+ )
2652
+ response_data.read()
2653
+ return self.api_client.response_deserialize(
2654
+ response_data=response_data,
2655
+ response_types_map=_response_types_map,
2656
+ )
2657
+
2658
+
2659
+ @validate_call
2660
+ def benchmark_benchmark_id_samples_identifier_get_without_preload_content(
2661
+ self,
2662
+ benchmark_id: Annotated[StrictStr, Field(description="The id of the benchmark to query")],
2663
+ identifier: Annotated[StrictStr, Field(description="The identifier to filter all samples for")],
2664
+ request: Annotated[Optional[QueryModel], Field(description="additional query settings")] = None,
2665
+ _request_timeout: Union[
2666
+ None,
2667
+ Annotated[StrictFloat, Field(gt=0)],
2668
+ Tuple[
2669
+ Annotated[StrictFloat, Field(gt=0)],
2670
+ Annotated[StrictFloat, Field(gt=0)]
2671
+ ]
2672
+ ] = None,
2673
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2674
+ _content_type: Optional[StrictStr] = None,
2675
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2676
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2677
+ ) -> RESTResponseType:
2678
+ """Returns the paged prompts of a benchmark by its ID.
2679
+
2680
+
2681
+ :param benchmark_id: The id of the benchmark to query (required)
2682
+ :type benchmark_id: str
2683
+ :param identifier: The identifier to filter all samples for (required)
2684
+ :type identifier: str
2685
+ :param request: additional query settings
2686
+ :type request: QueryModel
2687
+ :param _request_timeout: timeout setting for this request. If one
2688
+ number provided, it will be total request
2689
+ timeout. It can also be a pair (tuple) of
2690
+ (connection, read) timeouts.
2691
+ :type _request_timeout: int, tuple(int, int), optional
2692
+ :param _request_auth: set to override the auth_settings for an a single
2693
+ request; this effectively ignores the
2694
+ authentication in the spec for a single request.
2695
+ :type _request_auth: dict, optional
2696
+ :param _content_type: force content-type for the request.
2697
+ :type _content_type: str, Optional
2698
+ :param _headers: set to override the headers for a single
2699
+ request; this effectively ignores the headers
2700
+ in the spec for a single request.
2701
+ :type _headers: dict, optional
2702
+ :param _host_index: set to override the host_index for a single
2703
+ request; this effectively ignores the host_index
2704
+ in the spec for a single request.
2705
+ :type _host_index: int, optional
2706
+ :return: Returns the result object.
2707
+ """ # noqa: E501
2708
+
2709
+ _param = self._benchmark_benchmark_id_samples_identifier_get_serialize(
2710
+ benchmark_id=benchmark_id,
2711
+ identifier=identifier,
2712
+ request=request,
2713
+ _request_auth=_request_auth,
2714
+ _content_type=_content_type,
2715
+ _headers=_headers,
2716
+ _host_index=_host_index
2717
+ )
2718
+
2719
+ _response_types_map: Dict[str, Optional[str]] = {
2720
+ '200': "SampleByIdentifierPagedResult",
2721
+ }
2722
+ response_data = self.api_client.call_api(
2723
+ *_param,
2724
+ _request_timeout=_request_timeout
2725
+ )
2726
+ return response_data.response
2727
+
2728
+
2729
+ def _benchmark_benchmark_id_samples_identifier_get_serialize(
2730
+ self,
2731
+ benchmark_id,
2732
+ identifier,
2733
+ request,
2734
+ _request_auth,
2735
+ _content_type,
2736
+ _headers,
2737
+ _host_index,
2738
+ ) -> RequestSerialized:
2739
+
2740
+ _host = None
2741
+
2742
+ _collection_formats: Dict[str, str] = {
2743
+ }
2744
+
2745
+ _path_params: Dict[str, str] = {}
2746
+ _query_params: List[Tuple[str, str]] = []
2747
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2748
+ _form_params: List[Tuple[str, str]] = []
2749
+ _files: Dict[
2750
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2751
+ ] = {}
2752
+ _body_params: Optional[bytes] = None
2753
+
2754
+ # process the path parameters
2755
+ if benchmark_id is not None:
2756
+ _path_params['benchmarkId'] = benchmark_id
2757
+ if identifier is not None:
2758
+ _path_params['identifier'] = identifier
2759
+ # process the query parameters
2760
+ if request is not None:
2761
+
2762
+ _query_params.append(('request', request))
2763
+
2764
+ # process the header parameters
2765
+ # process the form parameters
2766
+ # process the body parameter
2767
+
2768
+
2769
+ # set the HTTP header `Accept`
2770
+ if 'Accept' not in _header_params:
2771
+ _header_params['Accept'] = self.api_client.select_header_accept(
2772
+ [
2773
+ 'text/plain',
2774
+ 'application/json',
2775
+ 'text/json'
2776
+ ]
2777
+ )
2778
+
2779
+
2780
+ # authentication setting
2781
+ _auth_settings: List[str] = [
2782
+ 'bearer',
2783
+ 'oauth2'
2784
+ ]
2785
+
2786
+ return self.api_client.param_serialize(
2787
+ method='GET',
2788
+ resource_path='/benchmark/{benchmarkId}/samples/{identifier}',
2789
+ path_params=_path_params,
2790
+ query_params=_query_params,
2791
+ header_params=_header_params,
2792
+ body=_body_params,
2793
+ post_params=_form_params,
2794
+ files=_files,
2795
+ auth_settings=_auth_settings,
2796
+ collection_formats=_collection_formats,
2797
+ _host=_host,
2798
+ _request_auth=_request_auth
2799
+ )
2800
+
2801
+
2802
+
2803
+
2510
2804
  @validate_call
2511
2805
  def benchmark_benchmark_id_tags_get(
2512
2806
  self,