rapidata 2.35.3__py3-none-any.whl → 2.36.0__py3-none-any.whl

rapidata/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "2.35.3"
+__version__ = "2.36.0"
 
 from .rapidata_client import (
     RapidataClient,

rapidata/api_client/__init__.py

@@ -35,6 +35,7 @@ from rapidata.api_client.api.participant_api import ParticipantApi
 from rapidata.api_client.api.pipeline_api import PipelineApi
 from rapidata.api_client.api.prompt_api import PromptApi
 from rapidata.api_client.api.rapidata_identity_api_api import RapidataIdentityAPIApi
+from rapidata.api_client.api.sample_api import SampleApi
 from rapidata.api_client.api.simple_workflow_api import SimpleWorkflowApi
 from rapidata.api_client.api.user_info_api import UserInfoApi
 from rapidata.api_client.api.user_rapid_api import UserRapidApi
@@ -55,8 +56,6 @@ from rapidata.api_client.exceptions import ApiException
 # import models into sdk package
 from rapidata.api_client.models.ab_test_selection import AbTestSelection
 from rapidata.api_client.models.ab_test_selection_a_inner import AbTestSelectionAInner
-from rapidata.api_client.models.add_campaign_artifact_result import AddCampaignArtifactResult
-from rapidata.api_client.models.add_campaign_model import AddCampaignModel
 from rapidata.api_client.models.add_user_response_result import AddUserResponseResult
 from rapidata.api_client.models.add_validation_rapid_model import AddValidationRapidModel
 from rapidata.api_client.models.add_validation_rapid_model_payload import AddValidationRapidModelPayload
@@ -66,6 +65,8 @@ from rapidata.api_client.models.add_validation_text_rapid_model import AddValida
 from rapidata.api_client.models.age_group import AgeGroup
 from rapidata.api_client.models.age_user_filter_model import AgeUserFilterModel
 from rapidata.api_client.models.aggregator_type import AggregatorType
+from rapidata.api_client.models.and_filter import AndFilter
+from rapidata.api_client.models.and_filter_filters_inner import AndFilterFiltersInner
 from rapidata.api_client.models.and_user_filter_model import AndUserFilterModel
 from rapidata.api_client.models.and_user_filter_model_filters_inner import AndUserFilterModelFiltersInner
 from rapidata.api_client.models.are_rapids_active_result import AreRapidsActiveResult
@@ -78,6 +79,7 @@ from rapidata.api_client.models.attach_category_truth import AttachCategoryTruth
 from rapidata.api_client.models.benchmark_query_result import BenchmarkQueryResult
 from rapidata.api_client.models.benchmark_query_result_paged_result import BenchmarkQueryResultPagedResult
 from rapidata.api_client.models.boost_leaderboard_model import BoostLeaderboardModel
+from rapidata.api_client.models.boost_mode import BoostMode
 from rapidata.api_client.models.boost_query_result import BoostQueryResult
 from rapidata.api_client.models.boost_status import BoostStatus
 from rapidata.api_client.models.bounding_box_payload import BoundingBoxPayload
@@ -86,11 +88,13 @@ from rapidata.api_client.models.bounding_box_result import BoundingBoxResult
 from rapidata.api_client.models.bounding_box_truth import BoundingBoxTruth
 from rapidata.api_client.models.box_shape import BoxShape
 from rapidata.api_client.models.campaign_artifact_model import CampaignArtifactModel
+from rapidata.api_client.models.campaign_filter import CampaignFilter
 from rapidata.api_client.models.campaign_query_result import CampaignQueryResult
 from rapidata.api_client.models.campaign_query_result_paged_result import CampaignQueryResultPagedResult
 from rapidata.api_client.models.campaign_status import CampaignStatus
 from rapidata.api_client.models.campaign_user_filter_model import CampaignUserFilterModel
 from rapidata.api_client.models.capped_selection import CappedSelection
+from rapidata.api_client.models.change_boost_model import ChangeBoostModel
 from rapidata.api_client.models.classification_metadata import ClassificationMetadata
 from rapidata.api_client.models.classification_metadata_filter_config import ClassificationMetadataFilterConfig
 from rapidata.api_client.models.classification_metadata_model import ClassificationMetadataModel
@@ -121,6 +125,7 @@ from rapidata.api_client.models.coordinate import Coordinate
 from rapidata.api_client.models.count_classification_metadata_filter_config import CountClassificationMetadataFilterConfig
 from rapidata.api_client.models.count_metadata import CountMetadata
 from rapidata.api_client.models.count_metadata_model import CountMetadataModel
+from rapidata.api_client.models.country_filter import CountryFilter
 from rapidata.api_client.models.country_user_filter_model import CountryUserFilterModel
 from rapidata.api_client.models.create_benchmark_model import CreateBenchmarkModel
 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
 from rapidata.api_client.models.dataset_dataset_id_datapoints_post_request_metadata_inner import DatasetDatasetIdDatapointsPostRequestMetadataInner
 from rapidata.api_client.models.dataset_evaluation_step_model import DatasetEvaluationStepModel
 from rapidata.api_client.models.demographic import Demographic
+from rapidata.api_client.models.demographic_filter import DemographicFilter
 from rapidata.api_client.models.demographic_metadata_model import DemographicMetadataModel
 from rapidata.api_client.models.demographic_selection import DemographicSelection
 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
 from rapidata.api_client.models.get_pipeline_by_id_result import GetPipelineByIdResult
 from rapidata.api_client.models.get_pipeline_by_id_result_artifacts_value import GetPipelineByIdResultArtifactsValue
 from rapidata.api_client.models.get_public_orders_result import GetPublicOrdersResult
+from rapidata.api_client.models.get_public_responses_result import GetPublicResponsesResult
 from rapidata.api_client.models.get_rapid_responses_result import GetRapidResponsesResult
 from rapidata.api_client.models.get_responses_result import GetResponsesResult
+from rapidata.api_client.models.get_sample_by_id_result import GetSampleByIdResult
 from rapidata.api_client.models.get_simple_workflow_results_model import GetSimpleWorkflowResultsModel
 from rapidata.api_client.models.get_standing_by_id_result import GetStandingByIdResult
 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
 from rapidata.api_client.models.json_web_key import JsonWebKey
 from rapidata.api_client.models.json_web_key_set import JsonWebKeySet
 from rapidata.api_client.models.labeling_selection import LabelingSelection
+from rapidata.api_client.models.language_filter import LanguageFilter
 from rapidata.api_client.models.language_user_filter_model import LanguageUserFilterModel
 from rapidata.api_client.models.leaderboard_query_result import LeaderboardQueryResult
 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
 from rapidata.api_client.models.named_entity_truth import NamedEntityTruth
 from rapidata.api_client.models.never_ending_referee_config import NeverEndingRefereeConfig
 from rapidata.api_client.models.never_ending_referee_info import NeverEndingRefereeInfo
+from rapidata.api_client.models.new_user_filter import NewUserFilter
 from rapidata.api_client.models.new_user_filter_model import NewUserFilterModel
 from rapidata.api_client.models.newsletter_model import NewsletterModel
 from rapidata.api_client.models.not_available_yet_result import NotAvailableYetResult
+from rapidata.api_client.models.not_filter import NotFilter
 from rapidata.api_client.models.not_user_filter_model import NotUserFilterModel
 from rapidata.api_client.models.null_asset import NullAsset
 from rapidata.api_client.models.null_asset_model import NullAssetModel
 from rapidata.api_client.models.online_pair_maker_config import OnlinePairMakerConfig
 from rapidata.api_client.models.online_pair_maker_config_model import OnlinePairMakerConfigModel
 from rapidata.api_client.models.online_pair_maker_information import OnlinePairMakerInformation
+from rapidata.api_client.models.or_filter import OrFilter
 from rapidata.api_client.models.or_user_filter_model import OrUserFilterModel
 from rapidata.api_client.models.order_model import OrderModel
 from rapidata.api_client.models.order_model_paged_result import OrderModelPagedResult
@@ -322,6 +334,7 @@ from rapidata.api_client.models.prompt_metadata_input import PromptMetadataInput
 from rapidata.api_client.models.prompt_metadata_model import PromptMetadataModel
 from rapidata.api_client.models.proxy_file_wrapper import ProxyFileWrapper
 from rapidata.api_client.models.public_order_model import PublicOrderModel
+from rapidata.api_client.models.public_rapid_response import PublicRapidResponse
 from rapidata.api_client.models.public_text_metadata_input import PublicTextMetadataInput
 from rapidata.api_client.models.query_model import QueryModel
 from rapidata.api_client.models.query_validation_model import QueryValidationModel
@@ -339,12 +352,15 @@ from rapidata.api_client.models.read_bridge_token_keys_result import ReadBridgeT
 from rapidata.api_client.models.register_temporary_customer_model import RegisterTemporaryCustomerModel
 from rapidata.api_client.models.register_temporary_customer_result import RegisterTemporaryCustomerResult
 from rapidata.api_client.models.report_model import ReportModel
+from rapidata.api_client.models.response_count_filter import ResponseCountFilter
 from rapidata.api_client.models.response_count_user_filter_model import ResponseCountUserFilterModel
 from rapidata.api_client.models.retrieval_mode import RetrievalMode
 from rapidata.api_client.models.root_filter import RootFilter
 from rapidata.api_client.models.run_status import RunStatus
 from rapidata.api_client.models.runs_by_leaderboard_result import RunsByLeaderboardResult
 from rapidata.api_client.models.runs_by_leaderboard_result_paged_result import RunsByLeaderboardResultPagedResult
+from rapidata.api_client.models.sample_by_identifier import SampleByIdentifier
+from rapidata.api_client.models.sample_by_identifier_paged_result import SampleByIdentifierPagedResult
 from rapidata.api_client.models.sample_by_participant import SampleByParticipant
 from rapidata.api_client.models.sample_by_participant_paged_result import SampleByParticipantPagedResult
 from rapidata.api_client.models.scrub_payload import ScrubPayload
@@ -400,7 +416,6 @@ from rapidata.api_client.models.translated_prompt_metadata_model import Translat
 from rapidata.api_client.models.translated_string import TranslatedString
 from rapidata.api_client.models.unlock_order_result import UnlockOrderResult
 from rapidata.api_client.models.update_benchmark_name_model import UpdateBenchmarkNameModel
-from rapidata.api_client.models.update_campaign_model import UpdateCampaignModel
 from rapidata.api_client.models.update_dataset_name_model import UpdateDatasetNameModel
 from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
 from rapidata.api_client.models.update_leaderboard_name_model import UpdateLeaderboardNameModel
@@ -414,7 +429,10 @@ from rapidata.api_client.models.update_validation_rapid_model_truth import Updat
 from rapidata.api_client.models.upload_coco_result import UploadCocoResult
 from rapidata.api_client.models.upload_from_s3_result import UploadFromS3Result
 from rapidata.api_client.models.url_asset_input import UrlAssetInput
+from rapidata.api_client.models.user_score_filter import UserScoreFilter
 from rapidata.api_client.models.user_score_user_filter_model import UserScoreUserFilterModel
+from rapidata.api_client.models.user_state import UserState
+from rapidata.api_client.models.user_state_filter import UserStateFilter
 from rapidata.api_client.models.validation_chance import ValidationChance
 from rapidata.api_client.models.validation_selection import ValidationSelection
 from rapidata.api_client.models.validation_set_model import ValidationSetModel

rapidata/api_client/api/__init__.py

@@ -19,6 +19,7 @@ from rapidata.api_client.api.participant_api import ParticipantApi
 from rapidata.api_client.api.pipeline_api import PipelineApi
 from rapidata.api_client.api.prompt_api import PromptApi
 from rapidata.api_client.api.rapidata_identity_api_api import RapidataIdentityAPIApi
+from rapidata.api_client.api.sample_api import SampleApi
 from rapidata.api_client.api.simple_workflow_api import SimpleWorkflowApi
 from rapidata.api_client.api.user_info_api import UserInfoApi
 from rapidata.api_client.api.user_rapid_api import UserRapidApi

rapidata/api_client/api/benchmark_api.py

@@ -28,6 +28,7 @@ from rapidata.api_client.models.get_benchmark_by_id_result import GetBenchmarkBy
 from rapidata.api_client.models.participant_by_benchmark_paged_result import ParticipantByBenchmarkPagedResult
 from rapidata.api_client.models.prompt_by_benchmark_result_paged_result import PromptByBenchmarkResultPagedResult
 from rapidata.api_client.models.query_model import QueryModel
+from rapidata.api_client.models.sample_by_identifier_paged_result import SampleByIdentifierPagedResult
 from rapidata.api_client.models.submit_participant_result import SubmitParticipantResult
 from rapidata.api_client.models.submit_prompt_model import SubmitPromptModel
 from rapidata.api_client.models.tags_by_benchmark_result import TagsByBenchmarkResult
@@ -2507,6 +2508,299 @@ class BenchmarkApi:
 
 
 
+    @validate_call
+    def benchmark_benchmark_id_samples_identifier_get(
+        self,
+        benchmark_id: Annotated[StrictStr, Field(description="The id of the benchmark to query")],
+        identifier: Annotated[StrictStr, Field(description="The identifier to filter all samples for")],
+        request: Annotated[Optional[QueryModel], Field(description="additional query settings")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> SampleByIdentifierPagedResult:
+        """Returns the paged prompts of a benchmark by its ID.
+
+
+        :param benchmark_id: The id of the benchmark to query (required)
+        :type benchmark_id: str
+        :param identifier: The identifier to filter all samples for (required)
+        :type identifier: str
+        :param request: additional query settings
+        :type request: QueryModel
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._benchmark_benchmark_id_samples_identifier_get_serialize(
+            benchmark_id=benchmark_id,
+            identifier=identifier,
+            request=request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SampleByIdentifierPagedResult",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def benchmark_benchmark_id_samples_identifier_get_with_http_info(
+        self,
+        benchmark_id: Annotated[StrictStr, Field(description="The id of the benchmark to query")],
+        identifier: Annotated[StrictStr, Field(description="The identifier to filter all samples for")],
+        request: Annotated[Optional[QueryModel], Field(description="additional query settings")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[SampleByIdentifierPagedResult]:
+        """Returns the paged prompts of a benchmark by its ID.
+
+
+        :param benchmark_id: The id of the benchmark to query (required)
+        :type benchmark_id: str
+        :param identifier: The identifier to filter all samples for (required)
+        :type identifier: str
+        :param request: additional query settings
+        :type request: QueryModel
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._benchmark_benchmark_id_samples_identifier_get_serialize(
+            benchmark_id=benchmark_id,
+            identifier=identifier,
+            request=request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SampleByIdentifierPagedResult",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def benchmark_benchmark_id_samples_identifier_get_without_preload_content(
+        self,
+        benchmark_id: Annotated[StrictStr, Field(description="The id of the benchmark to query")],
+        identifier: Annotated[StrictStr, Field(description="The identifier to filter all samples for")],
+        request: Annotated[Optional[QueryModel], Field(description="additional query settings")] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Returns the paged prompts of a benchmark by its ID.
+
+
+        :param benchmark_id: The id of the benchmark to query (required)
+        :type benchmark_id: str
+        :param identifier: The identifier to filter all samples for (required)
+        :type identifier: str
+        :param request: additional query settings
+        :type request: QueryModel
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._benchmark_benchmark_id_samples_identifier_get_serialize(
+            benchmark_id=benchmark_id,
+            identifier=identifier,
+            request=request,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "SampleByIdentifierPagedResult",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _benchmark_benchmark_id_samples_identifier_get_serialize(
+        self,
+        benchmark_id,
+        identifier,
+        request,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        if benchmark_id is not None:
+            _path_params['benchmarkId'] = benchmark_id
+        if identifier is not None:
+            _path_params['identifier'] = identifier
+        # process the query parameters
+        if request is not None:
+            
+            _query_params.append(('request', request))
+            
+        # process the header parameters
+        # process the form parameters
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'text/plain', 
+                    'application/json', 
+                    'text/json'
+                ]
+            )
+
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'bearer', 
+            'oauth2'
+        ]
+
+        return self.api_client.param_serialize(
+            method='GET',
+            resource_path='/benchmark/{benchmarkId}/samples/{identifier}',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+
+
+
     @validate_call
     def benchmark_benchmark_id_tags_get(
         self,