rapidata 2.31.0__py3-none-any.whl → 2.31.2__py3-none-any.whl

rapidata/api_client/models/__init__.py

@@ -109,6 +109,7 @@ from rapidata.api_client.models.create_order_model_referee import CreateOrderMod
 from rapidata.api_client.models.create_order_model_workflow import CreateOrderModelWorkflow
 from rapidata.api_client.models.create_order_result import CreateOrderResult
 from rapidata.api_client.models.create_rapid_result import CreateRapidResult
+from rapidata.api_client.models.create_sample_model import CreateSampleModel
 from rapidata.api_client.models.create_simple_pipeline_model import CreateSimplePipelineModel
 from rapidata.api_client.models.create_simple_pipeline_model_artifacts_inner import CreateSimplePipelineModelArtifactsInner
 from rapidata.api_client.models.create_simple_pipeline_model_pipeline_steps_inner import CreateSimplePipelineModelPipelineStepsInner

rapidata/api_client/models/create_sample_model.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    Rapidata.Dataset
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: v1
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateSampleModel(BaseModel):
+    """
+    The model used to create a sample to a participant.
+    """ # noqa: E501
+    identifier: StrictStr = Field(description="The identifier used to correlate samples of different participants.")
+    __properties: ClassVar[List[str]] = ["identifier"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of CreateSampleModel from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CreateSampleModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "identifier": obj.get("identifier")
+        })
+        return _obj
+
+

rapidata/api_client_README.md

@@ -76,7 +76,6 @@ Class | Method | HTTP request | Description
 *BenchmarkApi* | [**benchmark_benchmark_id_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_get) | **GET** /benchmark/{benchmarkId} | Returns a single benchmark by its ID.
 *BenchmarkApi* | [**benchmark_benchmark_id_name_put**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_name_put) | **PUT** /benchmark/{benchmarkId}/name | Updates the name of a benchmark.
 *BenchmarkApi* | [**benchmark_benchmark_id_participant_participant_id_delete**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participant_participant_id_delete) | **DELETE** /benchmark/{benchmarkId}/participant/{participantId} | Deletes a participant on a benchmark.
-*BenchmarkApi* | [**benchmark_benchmark_id_participant_participant_id_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participant_participant_id_get) | **GET** /benchmark/{benchmarkId}/participant/{participantId} | Gets a participant by it's Id.
 *BenchmarkApi* | [**benchmark_benchmark_id_participants_get**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participants_get) | **GET** /benchmark/{benchmarkId}/participants | Query all participants within a benchmark
 *BenchmarkApi* | [**benchmark_benchmark_id_participants_participant_id_disable_post**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participants_participant_id_disable_post) | **POST** /benchmark/{benchmarkId}/participants/{participantId}/disable | This endpoint disables a participant in a benchmark. this means that the participant will no longer actively be matched up against other participants and not collect further results. It will still be visible in the leaderboard.
 *BenchmarkApi* | [**benchmark_benchmark_id_participants_participant_id_submit_post**](rapidata/api_client/docs/BenchmarkApi.md#benchmark_benchmark_id_participants_participant_id_submit_post) | **POST** /benchmark/{benchmarkId}/participants/{participantId}/submit | Submits a participant to a benchmark.
@@ -163,6 +162,11 @@ Class | Method | HTTP request | Description
 *OrderApi* | [**order_unsupported_post**](rapidata/api_client/docs/OrderApi.md#order_unsupported_post) | **POST** /order/unsupported | Notifies the admins that a user wants to create an order with an unsupported label type or data type.
 *OrderApi* | [**orders_get**](rapidata/api_client/docs/OrderApi.md#orders_get) | **GET** /orders | Queries orders based on a filter, page, and sort criteria.
 *OrderApi* | [**orders_public_get**](rapidata/api_client/docs/OrderApi.md#orders_public_get) | **GET** /orders/public | Retrieves orders that are public and can be cloned by any user.
+*ParticipantApi* | [**participant_participant_id_delete**](rapidata/api_client/docs/ParticipantApi.md#participant_participant_id_delete) | **DELETE** /participant/{participantId} | Deletes a participant on a benchmark.
+*ParticipantApi* | [**participant_participant_id_get**](rapidata/api_client/docs/ParticipantApi.md#participant_participant_id_get) | **GET** /participant/{participantId} | Gets a participant by it's Id.
+*ParticipantApi* | [**participant_participant_id_sample_post**](rapidata/api_client/docs/ParticipantApi.md#participant_participant_id_sample_post) | **POST** /participant/{participantId}/sample | Adds a sample to a participant.
+*ParticipantApi* | [**participant_sample_sample_id_delete**](rapidata/api_client/docs/ParticipantApi.md#participant_sample_sample_id_delete) | **DELETE** /participant-sample/{sampleId} | Deletes a sample.
+*ParticipantApi* | [**participants_participant_id_submit_post**](rapidata/api_client/docs/ParticipantApi.md#participants_participant_id_submit_post) | **POST** /participants/{participantId}/submit | Submits a participant to a benchmark.
 *PipelineApi* | [**pipeline_id_workflow_config_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_config_artifact_id_put) | **PUT** /pipeline/{id}/workflow-config/{artifactId} | Updates the workflow configuration for a pipeline.
 *PipelineApi* | [**pipeline_id_workflow_config_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_id_workflow_config_put) | **PUT** /pipeline/{id}/workflow-config | Updates the workflow configuration for a pipeline.
 *PipelineApi* | [**pipeline_pipeline_id_campaign_artifact_id_put**](rapidata/api_client/docs/PipelineApi.md#pipeline_pipeline_id_campaign_artifact_id_put) | **PUT** /pipeline/{pipelineId}/campaign/{artifactId} | Updates a specific campaign for a pipeline.
@@ -297,6 +301,7 @@ Class | Method | HTTP request | Description
  - [CreateOrderModelWorkflow](rapidata/api_client/docs/CreateOrderModelWorkflow.md)
  - [CreateOrderResult](rapidata/api_client/docs/CreateOrderResult.md)
  - [CreateRapidResult](rapidata/api_client/docs/CreateRapidResult.md)
+ - [CreateSampleModel](rapidata/api_client/docs/CreateSampleModel.md)
  - [CreateSimplePipelineModel](rapidata/api_client/docs/CreateSimplePipelineModel.md)
  - [CreateSimplePipelineModelArtifactsInner](rapidata/api_client/docs/CreateSimplePipelineModelArtifactsInner.md)
  - [CreateSimplePipelineModelPipelineStepsInner](rapidata/api_client/docs/CreateSimplePipelineModelPipelineStepsInner.md)

rapidata/rapidata_client/assets/data_type_enum.py

@@ -1,4 +1,5 @@
 class RapidataDataTypes:
+    # deprecated use Literal["media", "text"] instead
     MEDIA = "media" # any form of image, video or audio
     TEXT = "text"
 

rapidata/rapidata_client/filter/rapidata_filters.py

@@ -37,8 +37,8 @@ class RapidataFilters:
         This ensures the order is only shown to users in the US and Germany whose phones are set to English.
 
     Info:        
-        The or and not filter support the | and ~ operators respectively.
-        The and is given by the elements in the list.
+        The OR, AND and NOT filter support the |, & and ~ operators respectively.
+        The AND is additionally given by the elements in the list.
 
         ```python
         from rapidata import AgeFilter, LanguageFilter, CountryFilter

rapidata/rapidata_client/order/rapidata_order_manager.py

@@ -1,9 +1,7 @@
-from typing import Sequence, Optional
-from urllib3._collections import HTTPHeaderDict # type: ignore[import]
+from typing import Sequence, Optional, Literal
 from itertools import zip_longest
 
 from rapidata.service.openapi_service import OpenAPIService
-from rapidata.rapidata_client.assets.data_type_enum import RapidataDataTypes
 from rapidata.rapidata_client.order.rapidata_order import RapidataOrder
 from rapidata.rapidata_client.order._rapidata_order_builder import RapidataOrderBuilder
 from rapidata.rapidata_client.metadata import PromptMetadata, SelectWordsMetadata, PrivateTextMetadata, MediaAssetMetadata, Metadata
@@ -21,8 +19,6 @@ from rapidata.rapidata_client.workflow import (
     TimestampWorkflow,
     RankingWorkflow
 )
-from rapidata.rapidata_client.selection.validation_selection import ValidationSelection
-from rapidata.rapidata_client.selection.labeling_selection import LabelingSelection
 from rapidata.rapidata_client.assets import MediaAsset, TextAsset, MultiAsset
 from rapidata.rapidata_client.filter import RapidataFilter
 from rapidata.rapidata_client.filter.rapidata_filters import RapidataFilters
@@ -140,7 +136,7 @@ class RapidataOrderManager:
             instruction: str,
             answer_options: list[str],
             datapoints: list[str],
-            data_type: str = RapidataDataTypes.MEDIA,
+            data_type: Literal["media", "text"] = "media",
             responses_per_datapoint: int = 10,
             contexts: list[str] | None = None,
             media_contexts: list[str] | None = None,
@@ -161,8 +157,8 @@ class RapidataOrderManager:
             instruction (str): The instruction for how the data should be classified.
             answer_options (list[str]): The list of options for the classification.
             datapoints (list[str]): The list of datapoints for the classification - each datapoint will be labeled.
-            data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
-                Other option: RapidataDataTypes.TEXT ("text").
+            data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
+                Other option: "text".
             responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10.
             contexts (list[str], optional): The list of contexts for the classification. Defaults to None.\n
                 If provided has to be the same length as datapoints and will be shown in addition to the instruction and options. (Therefore will be different for each datapoint)
@@ -181,12 +177,12 @@ class RapidataOrderManager:
                 This will NOT be shown to the labelers but will be included in the result purely for your own reference.
         """
         
-        if data_type == RapidataDataTypes.MEDIA:
+        if data_type == "media":
             assets = [MediaAsset(path=path) for path in datapoints]
-        elif data_type == RapidataDataTypes.TEXT:
+        elif data_type == "text":
             assets = [TextAsset(text=text) for text in datapoints]
         else:
-            raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
+            raise ValueError(f"Unsupported data type: {data_type}, must be one of 'media' or 'text'")
         
         return self._create_general_order(
             name=name,
@@ -210,7 +206,7 @@ class RapidataOrderManager:
             name: str,
             instruction: str,
             datapoints: list[list[str]],
-            data_type: str = RapidataDataTypes.MEDIA,
+            data_type: Literal["media", "text"] = "media",
             responses_per_datapoint: int = 10,
             contexts: list[str] | None = None,
             media_contexts: list[str] | None = None,
@@ -229,8 +225,8 @@ class RapidataOrderManager:
             name (str): The name of the order. (Will not be shown to the labeler)
             instruction (str): The instruction for the comparison. Will be shown along side each datapoint.
             datapoints (list[list[str]]): Outher list is the datapoints, inner list is the options for the comparison - each datapoint will be labeled.
-            data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
-                Other option: RapidataDataTypes.TEXT ("text").
+            data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
+                Other option: "text".
             responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10.
             contexts (list[str], optional): The list of contexts for the comparison. Defaults to None.\n
                 If provided has to be the same length as datapoints and will be shown in addition to the instruction. (Therefore will be different for each datapoint)
@@ -256,12 +252,12 @@ class RapidataOrderManager:
         if any(len(datapoint) != 2 for datapoint in datapoints):
             raise ValueError("Each datapoint must contain exactly two options")
 
-        if data_type == RapidataDataTypes.MEDIA:
+        if data_type == "media":
             assets = [MultiAsset([MediaAsset(path=path) for path in datapoint]) for datapoint in datapoints]
-        elif data_type == RapidataDataTypes.TEXT:
+        elif data_type == "text":
             assets = [MultiAsset([TextAsset(text=text) for text in datapoint]) for datapoint in datapoints]
         else:
-            raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
+            raise ValueError(f"Unsupported data type: {data_type}, must be one of 'media' or 'text'")
         
         return self._create_general_order(
             name=name,
@@ -286,7 +282,7 @@ class RapidataOrderManager:
                              datapoints: list[str],
                              total_comparison_budget: int,
                              responses_per_comparison: int = 1,
-                             data_type: str = RapidataDataTypes.MEDIA,
+                             data_type: Literal["media", "text"] = "media",
                              random_comparisons_ratio: float = 0.5,
                              context: Optional[str] = None,
                              validation_set_id: Optional[str] = None,
@@ -306,8 +302,8 @@ class RapidataOrderManager:
             datapoints (list[str]): A list of datapoints that will participate in the ranking.
             total_comparison_budget (int): The total number of (pairwise-)comparisons that can be made.
             responses_per_comparison (int, optional): The number of responses collected per comparison. Defaults to 1.
-            data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
-                Other option: RapidataDataTypes.TEXT ("text").
+            data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
+                Other option: "text".
             random_comparisons_ratio (float, optional): The fraction of random comparisons in the ranking process.
                 The rest will focus on pairing similarly ranked datapoints. Defaults to 0.5 and can be left untouched.
             context (str, optional): The context for all the comparison. Defaults to None.\n
@@ -319,12 +315,12 @@ class RapidataOrderManager:
             selections (Sequence[RapidataSelection], optional): The list of selections for the order. Defaults to []. Decides in what order the tasks should be shown.
         """
 
-        if data_type == RapidataDataTypes.MEDIA:
+        if data_type == "media":
             assets = [MediaAsset(path=path) for path in datapoints]
-        elif data_type == RapidataDataTypes.TEXT:
+        elif data_type == "text":
             assets = [TextAsset(text=text) for text in datapoints]
         else:
-            raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
+            raise ValueError(f"Unsupported data type: {data_type}, must be one of 'media' or 'text'")
 
         return self._create_general_order(
             name=name,
@@ -346,7 +342,7 @@ class RapidataOrderManager:
             name: str,
             instruction: str,
             datapoints: list[str],
-            data_type: str = RapidataDataTypes.MEDIA,
+            data_type: Literal["media", "text"] = "media",
             responses_per_datapoint: int = 10,
             filters: Sequence[RapidataFilter] = [],
             settings: Sequence[RapidataSetting] = [],
@@ -362,8 +358,8 @@ class RapidataOrderManager:
             name (str): The name of the order.
             instruction (str): The instruction to answer with free text. Will be shown along side each datapoint.
             datapoints (list[str]): The list of datapoints for the free text - each datapoint will be labeled.
-            data_type (str, optional): The data type of the datapoints. Defaults to RapidataDataTypes.MEDIA. \n
-                Other option: RapidataDataTypes.TEXT ("text").
+            data_type (str, optional): The data type of the datapoints. Defaults to "media" (any form of image, video or audio). \n
+                Other option: "text".
             responses_per_datapoint (int, optional): The number of responses that will be collected per datapoint. Defaults to 10.
             filters (Sequence[RapidataFilter], optional): The list of filters for the free text. Defaults to []. Decides who the tasks should be shown to.
             settings (Sequence[RapidataSetting], optional): The list of settings for the free text. Defaults to []. Decides how the tasks should be shown.
@@ -373,12 +369,12 @@ class RapidataOrderManager:
                 This will NOT be shown to the labelers but will be included in the result purely for your own reference.
         """
 
-        if data_type == RapidataDataTypes.MEDIA:
+        if data_type == "media":
             assets = [MediaAsset(path=path) for path in datapoints]
-        elif data_type == RapidataDataTypes.TEXT:
+        elif data_type == "text":
             assets = [TextAsset(text=text) for text in datapoints]
         else:
-            raise ValueError(f"Unsupported data type: {data_type}, must be one of {RapidataDataTypes._possible_values()}")
+            raise ValueError(f"Unsupported data type: {data_type}, must be one of 'media' or 'text'")
 
         return self._create_general_order(
             name=name,

rapidata/rapidata_client/validation/rapids/rapids.py

@@ -44,7 +44,7 @@ class Rapid():
             openapi_service.validation_api.validation_set_validation_set_id_rapid_post(
                 validation_set_id=validationSetId,
                 model=model,
-                files=[asset.to_file() for asset in files],
+                files=[asset.to_file() for asset in files if asset.is_local()],
                 urls=[asset.path for asset in files if not asset.is_local()]
             )
             

rapidata/rapidata_client/validation/rapids/rapids_manager.py

@@ -1,11 +1,10 @@
 import os
 from rapidata.api_client import AttachCategoryTruth, BoundingBoxTruth, BoxShape, ClassifyPayload, ComparePayload, CompareTruth, LinePayload, LocateBoxTruth, LocatePayload, ScrubPayload, ScrubRange, ScrubTruth, TranscriptionPayload, TranscriptionTruth, TranscriptionWord
-from rapidata.rapidata_client.assets.data_type_enum import RapidataDataTypes
 from rapidata.rapidata_client.assets import MediaAsset, TextAsset, MultiAsset
 from rapidata.rapidata_client.metadata import Metadata
 from rapidata.rapidata_client.validation.rapids.box import Box
 
-from typing import Sequence
+from typing import Sequence, Literal
 
 from rapidata.rapidata_client.validation.rapids.rapids import Rapid
 
@@ -21,7 +20,7 @@ class RapidsManager:
             answer_options: list[str],
             datapoint: str,
             truths: list[str],
-            data_type: str = RapidataDataTypes.MEDIA,
+            data_type: Literal["media", "text"] = "media",
             metadata: Sequence[Metadata] = [],
             explanation: str | None = None,
     ) -> Rapid:
@@ -32,16 +31,16 @@ class RapidsManager:
             answer_options (list[str]): The options that the labeler can choose from to answer the question.
             datapoint (str): The datapoint that the labeler will be labeling.
             truths (list[str]): The correct answers to the question.
-            data_type (str, optional): The type of the datapoint. Defaults to RapidataDataTypes.MEDIA.
+            data_type (str, optional): The type of the datapoint. Defaults to "media" (any form of image, video or audio).
             metadata (Sequence[Metadata], optional): The metadata that is attached to the rapid. Defaults to [].
         """
         
-        if data_type == RapidataDataTypes.MEDIA:
+        if data_type == "media":
             asset = MediaAsset(datapoint)
-        elif data_type == RapidataDataTypes.TEXT:
+        elif data_type == "text":
             asset = TextAsset(datapoint)
         else:
-            raise ValueError(f"Unsupported data type: {data_type}")
+            raise ValueError(f"Unsupported data type: {data_type}, must be one of 'media' or 'text'")
 
         if not isinstance(truths, list):
             raise ValueError("Truths must be a list of strings")
@@ -69,7 +68,7 @@ class RapidsManager:
             instruction: str,
             truth: str,
             datapoint: list[str],
-            data_type: str = RapidataDataTypes.MEDIA,
+            data_type: Literal["media", "text"] = "media",
             metadata: Sequence[Metadata] = [],
             explanation: str | None = None,
     ) -> Rapid:
@@ -79,13 +78,13 @@ class RapidsManager:
             instruction (str): The instruction that the labeler will be comparing the assets on.
             truth (str): The correct answer to the comparison. (has to be one of the assets)
             datapoint (list[str]): The two assets that the labeler will be comparing.
-            data_type (str, optional): The type of the datapoint. Defaults to RapidataDataTypes.MEDIA.
+            data_type (str, optional): The type of the datapoint. Defaults to "media" (any form of image, video or audio).
             metadata (Sequence[Metadata], optional): The metadata that is attached to the rapid. Defaults to [].
         """
 
-        if data_type == RapidataDataTypes.MEDIA:
+        if data_type == "media":
             assets = [MediaAsset(image) for image in datapoint]
-        elif data_type == RapidataDataTypes.TEXT:
+        elif data_type == "text":
             assets = [TextAsset(text) for text in datapoint]
         else:
             raise ValueError(f"Unsupported data type: {data_type}")

rapidata/rapidata_client/validation/validation_set_manager.py

@@ -1,8 +1,8 @@
+from typing import Literal
 from rapidata.api_client import QueryModel
 from rapidata.rapidata_client.validation.rapidata_validation_set import RapidataValidationSet
 from rapidata.api_client.models.create_validation_set_model import CreateValidationSetModel
 from rapidata.service.openapi_service import OpenAPIService
-from rapidata.rapidata_client.assets.data_type_enum import RapidataDataTypes
 from rapidata.rapidata_client.validation.rapids.rapids_manager import RapidsManager
 from rapidata.rapidata_client.validation.rapids.rapids import Rapid
 from rapidata.rapidata_client.metadata import PromptMetadata, MediaAssetMetadata
@@ -36,7 +36,7 @@ class ValidationSetManager:
         answer_options: list[str],
         datapoints: list[str],
         truths: list[list[str]],
-        data_type: str = RapidataDataTypes.MEDIA,
+        data_type: Literal["media", "text"] = "media",
         contexts: list[str] | None = None,
         media_contexts: list[str] | None = None,
         explanations: list[str | None] | None = None,
@@ -54,7 +54,7 @@ class ValidationSetManager:
                     options: ["yes", "no", "maybe"]
                     datapoints: ["datapoint1", "datapoint2"]
                     truths: [["yes"], ["no", "maybe"]] -> first datapoint correct answer is "yes", second datapoint is "no" or "maybe"
-            data_type (str, optional): The type of data. Defaults to RapidataDataTypes.MEDIA. Other option: RapidataDataTypes.TEXT ("text").
+            data_type (str, optional): The type of data. Defaults to "media" (any form of image, video or audio). Other option: "text".
             contexts (list[str], optional): The contexts for each datapoint. Defaults to None.\n
                 If provided has to be the same length as datapoints and will be shown in addition to the instruction and answer options. (Therefore will be different for each datapoint)
                 Will be match up with the datapoints using the list index.
@@ -119,7 +119,7 @@ class ValidationSetManager:
         instruction: str,
         datapoints: list[list[str]],
         truths: list[str],
-        data_type: str = RapidataDataTypes.MEDIA,
+        data_type: Literal["media", "text"] = "media",
         contexts: list[str] | None = None,
         media_contexts: list[str] | None = None,
         explanation: list[str | None] | None = None,
@@ -137,7 +137,7 @@ class ValidationSetManager:
                     truths: ["image1.jpg", "image4.jpg"] -> first comparison image1.jpg has a cat, second comparison image4.jpg has a cat
             datapoints (list[list[str]]): The compare datapoints to create the validation set with. 
                 Outer list is for each comparison, inner list the two images/texts that will be compared.
-            data_type (str, optional): The type of data. Defaults to RapidataDataTypes.MEDIA. Other option: RapidataDataTypes.TEXT ("text").
+            data_type (str, optional): The type of data. Defaults to "media" (any form of image, video or audio). Other option: "text".
             contexts (list[str], optional): The contexts for each datapoint. Defaults to None.\n
                 If provided has to be the same length as datapoints and will be shown in addition to the instruction and truth. (Therefore will be different for each datapoint)
                 Will be match up with the datapoints using the list index.

{rapidata-2.31.0.dist-info → rapidata-2.31.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rapidata
-Version: 2.31.0
+Version: 2.31.2
 Summary: Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way.
 License: Apache-2.0
 Author: Rapidata AG

{rapidata-2.31.0.dist-info → rapidata-2.31.2.dist-info}/RECORD

@@ -1,7 +1,7 @@
-rapidata/__init__.py,sha256=1J7X3wXGT2IlF9-Mt576ztUEGkXceBvfVxybgbO52wE,865
-rapidata/api_client/__init__.py,sha256=BgSOExnifSldFqbuk1ZWdHbrLKlntelU0IjKYUFf3MM,33738
-rapidata/api_client/api/__init__.py,sha256=V_nI5gljvhY0TmFLOdzpys9e1l9J6PokA8IxeYmynyg,1422
-rapidata/api_client/api/benchmark_api.py,sha256=1TzLL4lratyFaFbNiCtfW8l_yIRRil4u6xpvM0250UE,140976
+rapidata/__init__.py,sha256=9zyk6BW1q7xJJLiOcamEdO068ieM1eeWdrwsNKnABBA,865
+rapidata/api_client/__init__.py,sha256=bnGUWzPGaDhjFiRafYK3n8XNtHV_hr0C6yKNKmExsaE,33882
+rapidata/api_client/api/__init__.py,sha256=qjLeeJSnuPF_ar_nLknjnOqStBQnoCiz-O_rfZUBZrE,1489
+rapidata/api_client/api/benchmark_api.py,sha256=QB2smhWy12mZakh1aGlUH5d5DA0MbEJGdJy8mQToJnU,130931
 rapidata/api_client/api/campaign_api.py,sha256=406gNDALFb0sJhfx727ZM5_0GDX4iB0w5ym2dExLm4g,49894
 rapidata/api_client/api/client_api.py,sha256=KKgUrEKfqmEAqUCRqcYKRb6G3GLwD6R-JSUsShmo7r8,54313
 rapidata/api_client/api/coco_api.py,sha256=d1ypa-JfIoPFEJwn3l-INZM5bS2wB1ifuJuvYXLSRC4,24165
@@ -15,6 +15,7 @@ rapidata/api_client/api/identity_api.py,sha256=LmK6cTXssNjCa1BteOMc8P4FsyRiHQ_Kr
 rapidata/api_client/api/leaderboard_api.py,sha256=7h-nUh8EhMo84slSRE2EErZr9rRxiN6P0TBEHFKSIb8,177224
 rapidata/api_client/api/newsletter_api.py,sha256=3NU6HO5Gtm-RH-nx5hcp2CCE4IZmWHwTfCLMMz-Xpq4,22655
 rapidata/api_client/api/order_api.py,sha256=BfMsOGSovNizk1prukw18wH1-e0LrmmsCJy-vQhZdq4,210747
+rapidata/api_client/api/participant_api.py,sha256=YEwqQNwkpJlKMJ_tVf6FsUfRdq2URUugoJsO5w2x8Lg,54944
 rapidata/api_client/api/pipeline_api.py,sha256=s1_0GG3Rr-_yFzZ0TcBAgNGVrbQX_cjx2tnv3-1CmZw,96625
 rapidata/api_client/api/rapid_api.py,sha256=2omzmCbZxfseGTwEMFGESrkSH-FlkP0JmqIWJqgm8fM,97187
 rapidata/api_client/api/rapidata_identity_api_api.py,sha256=-kgoDuLdh-R4MQ7JPi3kQ0WDFKbmI0MkCjxwHXBmksA,9824
@@ -27,7 +28,7 @@ rapidata/api_client/api_client.py,sha256=EDhxAOUc5JFWvFsF1zc726Q7GoEFkuB8uor5SlG
 rapidata/api_client/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
 rapidata/api_client/configuration.py,sha256=g472vHVPLBotq8EkfSXP4sbp7xnn-3sb8O8BBlRWK1I,15931
 rapidata/api_client/exceptions.py,sha256=eLLd1fxM0Ygf3IIG6aNx9hdy79drst5Cem0UjI_NamM,5978
-rapidata/api_client/models/__init__.py,sha256=HnxPQRDj_6h0FLeItYyO5anP8kxqMI53cWuzCDKfRYM,31775
+rapidata/api_client/models/__init__.py,sha256=2aRs3QoYG90e4vTVqsQI1R5yIKRS3LhG8vAhjLPrwJk,31852
 rapidata/api_client/models/ab_test_selection.py,sha256=xQcE1BgKSnkTcmIuroeVOAQcAhGkHLlMP9XjakMFgDc,4327
 rapidata/api_client/models/ab_test_selection_a_inner.py,sha256=VsCi27NBGxAtupB_sQZCzUEsTNNgSGV_Mo-Fi0UY1Jw,11657
 rapidata/api_client/models/add_campaign_artifact_result.py,sha256=4IvFVS-tLlL6eHsWp-IZ_ul5T30-h3YEwd2B5ioBbgY,2582
@@ -154,6 +155,7 @@ rapidata/api_client/models/create_order_model_user_filters_inner.py,sha256=o_VLp
 rapidata/api_client/models/create_order_model_workflow.py,sha256=cy7bD2kWvLkCgFdrViAG63xtYDIdVOn0dD74GRxni_A,6638
 rapidata/api_client/models/create_order_result.py,sha256=Mo6_p9rPw9h1BOOviBoGeEDHFAaz1Tu7syEzviRP7vc,3390
 rapidata/api_client/models/create_rapid_result.py,sha256=ECREjyzsTg6leWTF19E-QtqmyaTIeIZzpp_sO9iA4kY,2535
+rapidata/api_client/models/create_sample_model.py,sha256=Xg4I0iqxbGqViXmyz0MVvFqqf7HLfgbIAoCrhzOasz8,2646
 rapidata/api_client/models/create_simple_pipeline_model.py,sha256=loLhevw-sZap22HDFGDF1aphPBznt1M-wBY31haihNY,4729
 rapidata/api_client/models/create_simple_pipeline_model_artifacts_inner.py,sha256=EvOz0EpU3RIfZ1rw6EGOkGiFzGi1Zm0YmeDKNQ7WWS8,5027
 rapidata/api_client/models/create_simple_pipeline_model_pipeline_steps_inner.py,sha256=6N8-Xsybow21NhHKVzKv-QDJR4rPZYkAzgorIVyTod4,8837
@@ -524,7 +526,7 @@ rapidata/api_client/models/workflow_split_model_filter_configs_inner.py,sha256=1
 rapidata/api_client/models/workflow_state.py,sha256=5LAK1se76RCoozeVB6oxMPb8p_5bhLZJqn7q5fFQWis,850
 rapidata/api_client/models/zip_entry_file_wrapper.py,sha256=06CoNJD3x511K3rnSmkrwwhc9GbQxwxF-c0ldOyJbAs,4240
 rapidata/api_client/rest.py,sha256=rtIMcgINZOUaDFaJIinJkXRSddNJmXvMRMfgO2Ezk2o,10835
-rapidata/api_client_README.md,sha256=xdgbo29fmH1jD1-o5U7eT9noDoh8yBQWextKrM4L1_k,59284
+rapidata/api_client_README.md,sha256=gr0R771p4eGlwrWMcTdFATDBWpSpvkTp7R2lbu2Fl08,60177
 rapidata/rapidata_client/__init__.py,sha256=MLl41ZPDYezE9ookAjHS75wFqfCTOKq-U01GJbHFjrA,1133
 rapidata/rapidata_client/api/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/api/rapidata_exception.py,sha256=BIdmHRrJUGW-Mqhp1H_suemZaR6w9TgjWq-ZW5iUPdQ,3878
@@ -534,7 +536,7 @@ rapidata/rapidata_client/assets/_media_asset.py,sha256=LEQtIPHNPVwuIA5ua_3x82aTt
 rapidata/rapidata_client/assets/_multi_asset.py,sha256=OzU5VxRh3Igku4HC60tEc0XECHh5C2k-k35AbqW7eG8,1842
 rapidata/rapidata_client/assets/_sessions.py,sha256=Dgcb61Q4gLwU5hurnv6sN2Jvw-ZV7vjhVWXog5Wq4aw,1094
 rapidata/rapidata_client/assets/_text_asset.py,sha256=bZHBrvbHSzF0qePoJ5LqYq__2ZDspzCeYi1nDbiIako,796
-rapidata/rapidata_client/assets/data_type_enum.py,sha256=ELC-ymeKnQlfNAzfqsI7MmUuRiGYamCHVcTc0qR6Fm4,185
+rapidata/rapidata_client/assets/data_type_enum.py,sha256=v6gR2Wqenb9H_Bs6dKmUrkbjYRDD3tZmeoL5f8LlAcM,239
 rapidata/rapidata_client/benchmark/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/benchmark/leaderboard/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rapidata/rapidata_client/benchmark/leaderboard/rapidata_leaderboard.py,sha256=BDI0xJkTumbZy4dYqkzXy074jC9eaVWoJJDZ84uvatE,3906
@@ -559,7 +561,7 @@ rapidata/rapidata_client/filter/models/gender.py,sha256=aXg6Kql2BIy8d5d1lCVi1axM
 rapidata/rapidata_client/filter/new_user_filter.py,sha256=qU7d6cSslGEO_N1tYPS4Ru3cGbQYH2_I5dJPNPHvtCM,369
 rapidata/rapidata_client/filter/not_filter.py,sha256=05uZMNPfguNPONP2uYYtuxx-5UAYdmc8gwSAEHMiK3k,1183
 rapidata/rapidata_client/filter/or_filter.py,sha256=EomsXyYec4beAA63LYfIsh8dO4So1duI7VlLW8VPfzY,1339
-rapidata/rapidata_client/filter/rapidata_filters.py,sha256=l_pPOA56f8hiacAgr3om5j6IpTP-BGOB247c_uhuYzM,2194
+rapidata/rapidata_client/filter/rapidata_filters.py,sha256=4UqpfD2SfxVKRsxWL7uOf3sTeW7dpwxzOqLEMNHERWY,2215
 rapidata/rapidata_client/filter/response_count_filter.py,sha256=sDv9Dvy0FbnIQRSAxFGrUf9SIMISTNxnlAQcrFKBjXE,1989
 rapidata/rapidata_client/filter/user_score_filter.py,sha256=2C78zkWm5TnfkxGbV1ER2xB7s9ynpacaibzyRZKG8Cc,1566
 rapidata/rapidata_client/logging/__init__.py,sha256=4gLxePW8TvgYDZmPWMcf6fA8bEyu35vMKOmlPj5oXNE,110
@@ -577,7 +579,7 @@ rapidata/rapidata_client/order/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5
 rapidata/rapidata_client/order/_rapidata_dataset.py,sha256=5OIeIDvqAnb38KfjTsgj5JN7k5xKRhC-1_G-VulzO2c,21216
 rapidata/rapidata_client/order/_rapidata_order_builder.py,sha256=PyRXNazBffj98Qp7S09QmuIGzNTE-YoUhI8YEvlSCps,12838
 rapidata/rapidata_client/order/rapidata_order.py,sha256=bYTa7GtR_TEvfAZJZ1Aliy4yPsc-wo8L8tyqtegupyM,12675
-rapidata/rapidata_client/order/rapidata_order_manager.py,sha256=Kdup91It_M4zGveZER-CjTG0e5NJTSJzBiRqGufuT-I,37778
+rapidata/rapidata_client/order/rapidata_order_manager.py,sha256=28Lb8iUh_Bun-ijiNGiCjrLn5Rkzbx7lgsgA63M_Jm0,37255
 rapidata/rapidata_client/order/rapidata_results.py,sha256=ZY0JyHMBZlR6-t6SqKt2OLEO6keR_KvKg9Wk6_I29x4,8653
 rapidata/rapidata_client/rapidata_client.py,sha256=jTkpu0YcizoxAzbfNdnY1S0xXX6Q0KEMi8boo0f2F5c,4274
 rapidata/rapidata_client/referee/__init__.py,sha256=q0Hv9nmfEpyChejtyMLT8hWKL0vTTf_UgUXPYNJ-H6M,153
@@ -613,9 +615,9 @@ rapidata/rapidata_client/validation/__init__.py,sha256=s5wHVtcJkncXSFuL9I0zNwccN
 rapidata/rapidata_client/validation/rapidata_validation_set.py,sha256=h6aicVyrBePfzS5-cPk_hPgmePUqCB3yAbGB_tTXYg0,1814
 rapidata/rapidata_client/validation/rapids/__init__.py,sha256=WU5PPwtTJlte6U90MDakzx4I8Y0laj7siw9teeXj5R0,21
 rapidata/rapidata_client/validation/rapids/box.py,sha256=t3_Kn6doKXdnJdtbwefXnYKPiTKHneJl9E2inkDSqL8,589
-rapidata/rapidata_client/validation/rapids/rapids.py,sha256=bsDPp8IJ_7dQOJP7U9IVqfLKctY5YP58gDBX8Ixrpc4,3827
-rapidata/rapidata_client/validation/rapids/rapids_manager.py,sha256=s5VAq8H5CKACWfmIQuz9kHC8t2nd-xEHGGUj9pIfXKI,14386
-rapidata/rapidata_client/validation/validation_set_manager.py,sha256=yQTZSAnqTT0xnwESPIEykQG-34UP9oyoavpNA0KuRIU,30626
+rapidata/rapidata_client/validation/rapids/rapids.py,sha256=WH2EQVhWShHIfXLbaV9-hiVN-ENyXzBZYcQIxdq-RjA,3847
+rapidata/rapidata_client/validation/rapids/rapids_manager.py,sha256=O-AWNQ84zNd8w8JEfCTnWDGAuiDz-Cy17MV1nt7xi2I,14338
+rapidata/rapidata_client/validation/validation_set_manager.py,sha256=7eLh9REoOLRvHR8Ao0oQkPU8REPdLYRP88WXsxX9-fU,30576
 rapidata/rapidata_client/workflow/__init__.py,sha256=7nXcY91xkxjHudBc9H0fP35eBBtgwHGWTQKbb-M4h7Y,477
 rapidata/rapidata_client/workflow/_base_workflow.py,sha256=XyIZFKS_RxAuwIHS848S3AyLEHqd07oTD_5jm2oUbsw,762
 rapidata/rapidata_client/workflow/_classify_workflow.py,sha256=9bT54wxVJgxC-zLk6MVNbseFpzYrvFPjt7DHvxqYfnk,1736
@@ -631,7 +633,7 @@ rapidata/service/__init__.py,sha256=s9bS1AJZaWIhLtJX_ZA40_CK39rAAkwdAmymTMbeWl4,
 rapidata/service/credential_manager.py,sha256=pUEEtp6VrFWYhfUUtyqmS0AlRqe2Y0kFkY6o22IT4KM,8682
 rapidata/service/local_file_service.py,sha256=pgorvlWcx52Uh3cEG6VrdMK_t__7dacQ_5AnfY14BW8,877
 rapidata/service/openapi_service.py,sha256=xoGBACpUhG0H-tadSBa8A91LHyfI7n-FCT2JlrERqco,5221
-rapidata-2.31.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-rapidata-2.31.0.dist-info/METADATA,sha256=I0oM2qAap3-ZDUa67lvb0L8wgIY9K3x9HArj6dW0ALc,1264
-rapidata-2.31.0.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-rapidata-2.31.0.dist-info/RECORD,,
+rapidata-2.31.2.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+rapidata-2.31.2.dist-info/METADATA,sha256=vwntCIsDSw71O6RSok27uOXpRGiueh8M210PoaOT_Gw,1264
+rapidata-2.31.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+rapidata-2.31.2.dist-info/RECORD,,