rapidata 2.14.0__py3-none-any.whl → 2.15.0__py3-none-any.whl

rapidata/api_client/models/__init__.py

@@ -41,6 +41,7 @@ from rapidata.api_client.models.campaign_query_result_paged_result import Campai
 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.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
 from rapidata.api_client.models.classify_payload import ClassifyPayload
@@ -54,6 +55,7 @@ from rapidata.api_client.models.compare_rapid_blueprint import CompareRapidBluep
 from rapidata.api_client.models.compare_result import CompareResult
 from rapidata.api_client.models.compare_truth import CompareTruth
 from rapidata.api_client.models.compare_workflow_config import CompareWorkflowConfig
+from rapidata.api_client.models.compare_workflow_config_metadata_value import CompareWorkflowConfigMetadataValue
 from rapidata.api_client.models.compare_workflow_config_model import CompareWorkflowConfigModel
 from rapidata.api_client.models.compare_workflow_config_model_pair_maker_config import CompareWorkflowConfigModelPairMakerConfig
 from rapidata.api_client.models.compare_workflow_config_pair_maker_config import CompareWorkflowConfigPairMakerConfig
@@ -65,6 +67,7 @@ from rapidata.api_client.models.compare_workflow_model_pair_maker_config import
 from rapidata.api_client.models.conditional_validation_selection import ConditionalValidationSelection
 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_user_filter_model import CountryUserFilterModel
 from rapidata.api_client.models.create_bridge_token_result import CreateBridgeTokenResult
@@ -133,6 +136,7 @@ from rapidata.api_client.models.get_order_by_id_result import GetOrderByIdResult
 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_rapid_responses_result import GetRapidResponsesResult
 from rapidata.api_client.models.get_responses_result import GetResponsesResult
 from rapidata.api_client.models.get_simple_workflow_results_model import GetSimpleWorkflowResultsModel
 from rapidata.api_client.models.get_simple_workflow_results_result import GetSimpleWorkflowResultsResult
@@ -143,6 +147,7 @@ from rapidata.api_client.models.get_workflow_by_id_result_workflow import GetWor
 from rapidata.api_client.models.get_workflow_progress_result import GetWorkflowProgressResult
 from rapidata.api_client.models.i_workflow_model_paged_result import IWorkflowModelPagedResult
 from rapidata.api_client.models.identity_read_bridge_token_get202_response import IdentityReadBridgeTokenGet202Response
+from rapidata.api_client.models.image_dimension_metadata import ImageDimensionMetadata
 from rapidata.api_client.models.image_dimension_metadata_model import ImageDimensionMetadataModel
 from rapidata.api_client.models.import_from_file_result import ImportFromFileResult
 from rapidata.api_client.models.import_validation_set_from_file_result import ImportValidationSetFromFileResult
@@ -160,9 +165,11 @@ from rapidata.api_client.models.locate_coordinate import LocateCoordinate
 from rapidata.api_client.models.locate_payload import LocatePayload
 from rapidata.api_client.models.locate_rapid_blueprint import LocateRapidBlueprint
 from rapidata.api_client.models.locate_result import LocateResult
+from rapidata.api_client.models.location_metadata import LocationMetadata
 from rapidata.api_client.models.location_metadata_exists_filter_config import LocationMetadataExistsFilterConfig
 from rapidata.api_client.models.location_metadata_model import LocationMetadataModel
 from rapidata.api_client.models.logic_operator import LogicOperator
+from rapidata.api_client.models.metadata_visibilities import MetadataVisibilities
 from rapidata.api_client.models.multi_asset_model import MultiAssetModel
 from rapidata.api_client.models.naive_referee_config import NaiveRefereeConfig
 from rapidata.api_client.models.naive_referee_model import NaiveRefereeModel
@@ -182,6 +189,7 @@ from rapidata.api_client.models.online_pair_maker_information import OnlinePairM
 from rapidata.api_client.models.order_model import OrderModel
 from rapidata.api_client.models.order_model_paged_result import OrderModelPagedResult
 from rapidata.api_client.models.order_state import OrderState
+from rapidata.api_client.models.original_filename_metadata import OriginalFilenameMetadata
 from rapidata.api_client.models.original_filename_metadata_model import OriginalFilenameMetadataModel
 from rapidata.api_client.models.page_info import PageInfo
 from rapidata.api_client.models.pipeline_id_workflow_put_request import PipelineIdWorkflowPutRequest
@@ -194,6 +202,7 @@ from rapidata.api_client.models.preliminary_download_result import PreliminaryDo
 from rapidata.api_client.models.private_text_metadata_input import PrivateTextMetadataInput
 from rapidata.api_client.models.probabilistic_attach_category_referee_config import ProbabilisticAttachCategoryRefereeConfig
 from rapidata.api_client.models.problem_details import ProblemDetails
+from rapidata.api_client.models.prompt_metadata import PromptMetadata
 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.public_order_model import PublicOrderModel
@@ -233,12 +242,15 @@ from rapidata.api_client.models.simple_workflow_model_blueprint import SimpleWor
 from rapidata.api_client.models.skip_result import SkipResult
 from rapidata.api_client.models.sort_criterion import SortCriterion
 from rapidata.api_client.models.sort_direction import SortDirection
+from rapidata.api_client.models.source_url_metadata import SourceUrlMetadata
 from rapidata.api_client.models.source_url_metadata_model import SourceUrlMetadataModel
 from rapidata.api_client.models.static_selection import StaticSelection
 from rapidata.api_client.models.submit_coco_model import SubmitCocoModel
 from rapidata.api_client.models.submit_coco_result import SubmitCocoResult
 from rapidata.api_client.models.text_asset_model import TextAssetModel
+from rapidata.api_client.models.text_metadata import TextMetadata
 from rapidata.api_client.models.text_metadata_model import TextMetadataModel
+from rapidata.api_client.models.transcription_metadata import TranscriptionMetadata
 from rapidata.api_client.models.transcription_metadata_input import TranscriptionMetadataInput
 from rapidata.api_client.models.transcription_metadata_model import TranscriptionMetadataModel
 from rapidata.api_client.models.transcription_payload import TranscriptionPayload
@@ -251,6 +263,7 @@ 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_access_model import UpdateAccessModel
 from rapidata.api_client.models.update_campaign_model import UpdateCampaignModel
+from rapidata.api_client.models.update_dimensions_model import UpdateDimensionsModel
 from rapidata.api_client.models.update_order_model import UpdateOrderModel
 from rapidata.api_client.models.update_validation_rapid_model import UpdateValidationRapidModel
 from rapidata.api_client.models.update_validation_rapid_model_truth import UpdateValidationRapidModelTruth

rapidata/api_client/models/add_campaign_model.py

@@ -38,7 +38,8 @@ class AddCampaignModel(BaseModel):
     feature_flags: List[FeatureFlag] = Field(description="The feature flags that should be applied to the campaign.", alias="featureFlags")
     priority: StrictInt = Field(description="The priority of the campaign.")
     is_sticky: Optional[StrictBool] = Field(default=None, description="Indicates if the campaign is sticky.", alias="isSticky")
-    __properties: ClassVar[List[str]] = ["_t", "artifactId", "campaignName", "userFilters", "validationSetId", "selections", "featureFlags", "priority", "isSticky"]
+    is_preview_enabled: Optional[StrictBool] = Field(default=None, description="A flag to indicate whether the campaign should be put into preview mode after creation.  This way the campaign will not start automatically and the user will have to manually start it.", alias="isPreviewEnabled")
+    __properties: ClassVar[List[str]] = ["_t", "artifactId", "campaignName", "userFilters", "validationSetId", "selections", "featureFlags", "priority", "isSticky", "isPreviewEnabled"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -122,6 +123,11 @@ class AddCampaignModel(BaseModel):
         if self.selections is None and "selections" in self.model_fields_set:
             _dict['selections'] = None
 
+        # set to None if is_preview_enabled (nullable) is None
+        # and model_fields_set contains the field
+        if self.is_preview_enabled is None and "is_preview_enabled" in self.model_fields_set:
+            _dict['isPreviewEnabled'] = None
+
         return _dict
 
     @classmethod
@@ -142,7 +148,8 @@ class AddCampaignModel(BaseModel):
             "selections": [AbTestSelectionAInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None,
             "featureFlags": [FeatureFlag.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None,
             "priority": obj.get("priority"),
-            "isSticky": obj.get("isSticky")
+            "isSticky": obj.get("isSticky"),
+            "isPreviewEnabled": obj.get("isPreviewEnabled")
         })
         return _obj
 

rapidata/api_client/models/campaign_query_result.py

@@ -38,8 +38,8 @@ class CampaignQueryResult(BaseModel):
     @field_validator('status')
     def status_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['Created', 'Active', 'Paused', 'Completed']):
-            raise ValueError("must be one of enum values ('Created', 'Active', 'Paused', 'Completed')")
+        if value not in set(['Created', 'Active', 'Paused', 'Preview', 'Completed']):
+            raise ValueError("must be one of enum values ('Created', 'Active', 'Paused', 'Preview', 'Completed')")
         return value
 
     model_config = ConfigDict(

rapidata/api_client/models/campaign_status.py

@@ -29,6 +29,7 @@ class CampaignStatus(str, Enum):
     CREATED = 'Created'
     ACTIVE = 'Active'
     PAUSED = 'Paused'
+    PREVIEW = 'Preview'
     COMPLETED = 'Completed'
 
     @classmethod

rapidata/api_client/models/classification_metadata.py

@@ -29,8 +29,7 @@ class ClassificationMetadata(BaseModel):
     t: StrictStr = Field(description="Discriminator value for ClassificationMetadata", alias="_t")
     classification: StrictStr
     visibilities: Optional[StrictStr] = None
-    identifier: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["_t", "classification", "visibilities", "identifier"]
+    __properties: ClassVar[List[str]] = ["_t", "classification", "visibilities"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -92,8 +91,7 @@ class ClassificationMetadata(BaseModel):
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'ClassificationMetadata',
             "classification": obj.get("classification"),
-            "visibilities": obj.get("visibilities"),
-            "identifier": obj.get("identifier")
+            "visibilities": obj.get("visibilities")
         })
         return _obj
 

rapidata/api_client/models/compare_workflow_config.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.compare_workflow_config_metadata_value import CompareWorkflowConfigMetadataValue
 from rapidata.api_client.models.compare_workflow_config_pair_maker_config import CompareWorkflowConfigPairMakerConfig
 from rapidata.api_client.models.compare_workflow_model1_referee import CompareWorkflowModel1Referee
 from rapidata.api_client.models.elo_config import EloConfig
@@ -35,7 +36,8 @@ class CompareWorkflowConfig(BaseModel):
     pair_maker_config: Optional[CompareWorkflowConfigPairMakerConfig] = Field(default=None, alias="pairMakerConfig")
     referee: CompareWorkflowModel1Referee
     target_country_codes: List[StrictStr] = Field(alias="targetCountryCodes")
-    __properties: ClassVar[List[str]] = ["_t", "criteria", "eloConfig", "pairMakerConfig", "referee", "targetCountryCodes"]
+    metadata: Dict[str, CompareWorkflowConfigMetadataValue]
+    __properties: ClassVar[List[str]] = ["_t", "criteria", "eloConfig", "pairMakerConfig", "referee", "targetCountryCodes", "metadata"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -92,6 +94,13 @@ class CompareWorkflowConfig(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of referee
         if self.referee:
             _dict['referee'] = self.referee.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in metadata (dict)
+        _field_dict = {}
+        if self.metadata:
+            for _key_metadata in self.metadata:
+                if self.metadata[_key_metadata]:
+                    _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict()
+            _dict['metadata'] = _field_dict
         return _dict
 
     @classmethod
@@ -109,7 +118,13 @@ class CompareWorkflowConfig(BaseModel):
             "eloConfig": EloConfig.from_dict(obj["eloConfig"]) if obj.get("eloConfig") is not None else None,
             "pairMakerConfig": CompareWorkflowConfigPairMakerConfig.from_dict(obj["pairMakerConfig"]) if obj.get("pairMakerConfig") is not None else None,
             "referee": CompareWorkflowModel1Referee.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
-            "targetCountryCodes": obj.get("targetCountryCodes")
+            "targetCountryCodes": obj.get("targetCountryCodes"),
+            "metadata": dict(
+                (_k, CompareWorkflowConfigMetadataValue.from_dict(_v))
+                for _k, _v in obj["metadata"].items()
+            )
+            if obj.get("metadata") is not None
+            else None
         })
         return _obj
 

rapidata/api_client/models/compare_workflow_config_metadata_value.py

@@ -0,0 +1,238 @@
+# 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 json
+import pprint
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, List, Optional
+from rapidata.api_client.models.classification_metadata import ClassificationMetadata
+from rapidata.api_client.models.count_metadata import CountMetadata
+from rapidata.api_client.models.image_dimension_metadata import ImageDimensionMetadata
+from rapidata.api_client.models.location_metadata import LocationMetadata
+from rapidata.api_client.models.original_filename_metadata import OriginalFilenameMetadata
+from rapidata.api_client.models.prompt_metadata import PromptMetadata
+from rapidata.api_client.models.source_url_metadata import SourceUrlMetadata
+from rapidata.api_client.models.text_metadata import TextMetadata
+from rapidata.api_client.models.transcription_metadata import TranscriptionMetadata
+from pydantic import StrictStr, Field
+from typing import Union, List, Set, Optional, Dict
+from typing_extensions import Literal, Self
+
+COMPAREWORKFLOWCONFIGMETADATAVALUE_ONE_OF_SCHEMAS = ["ClassificationMetadata", "CountMetadata", "ImageDimensionMetadata", "LocationMetadata", "OriginalFilenameMetadata", "PromptMetadata", "SourceUrlMetadata", "TextMetadata", "TranscriptionMetadata"]
+
+class CompareWorkflowConfigMetadataValue(BaseModel):
+    """
+    CompareWorkflowConfigMetadataValue
+    """
+    # data type: ClassificationMetadata
+    oneof_schema_1_validator: Optional[ClassificationMetadata] = None
+    # data type: CountMetadata
+    oneof_schema_2_validator: Optional[CountMetadata] = None
+    # data type: ImageDimensionMetadata
+    oneof_schema_3_validator: Optional[ImageDimensionMetadata] = None
+    # data type: LocationMetadata
+    oneof_schema_4_validator: Optional[LocationMetadata] = None
+    # data type: OriginalFilenameMetadata
+    oneof_schema_5_validator: Optional[OriginalFilenameMetadata] = None
+    # data type: PromptMetadata
+    oneof_schema_6_validator: Optional[PromptMetadata] = None
+    # data type: SourceUrlMetadata
+    oneof_schema_7_validator: Optional[SourceUrlMetadata] = None
+    # data type: TextMetadata
+    oneof_schema_8_validator: Optional[TextMetadata] = None
+    # data type: TranscriptionMetadata
+    oneof_schema_9_validator: Optional[TranscriptionMetadata] = None
+    actual_instance: Optional[Union[ClassificationMetadata, CountMetadata, ImageDimensionMetadata, LocationMetadata, OriginalFilenameMetadata, PromptMetadata, SourceUrlMetadata, TextMetadata, TranscriptionMetadata]] = None
+    one_of_schemas: Set[str] = { "ClassificationMetadata", "CountMetadata", "ImageDimensionMetadata", "LocationMetadata", "OriginalFilenameMetadata", "PromptMetadata", "SourceUrlMetadata", "TextMetadata", "TranscriptionMetadata" }
+
+    model_config = ConfigDict(
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    discriminator_value_class_map: Dict[str, str] = {
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_oneof(cls, v):
+        instance = CompareWorkflowConfigMetadataValue.model_construct()
+        error_messages = []
+        match = 0
+        # validate data type: ClassificationMetadata
+        if not isinstance(v, ClassificationMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ClassificationMetadata`")
+        else:
+            match += 1
+        # validate data type: CountMetadata
+        if not isinstance(v, CountMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `CountMetadata`")
+        else:
+            match += 1
+        # validate data type: ImageDimensionMetadata
+        if not isinstance(v, ImageDimensionMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `ImageDimensionMetadata`")
+        else:
+            match += 1
+        # validate data type: LocationMetadata
+        if not isinstance(v, LocationMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `LocationMetadata`")
+        else:
+            match += 1
+        # validate data type: OriginalFilenameMetadata
+        if not isinstance(v, OriginalFilenameMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `OriginalFilenameMetadata`")
+        else:
+            match += 1
+        # validate data type: PromptMetadata
+        if not isinstance(v, PromptMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `PromptMetadata`")
+        else:
+            match += 1
+        # validate data type: SourceUrlMetadata
+        if not isinstance(v, SourceUrlMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `SourceUrlMetadata`")
+        else:
+            match += 1
+        # validate data type: TextMetadata
+        if not isinstance(v, TextMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TextMetadata`")
+        else:
+            match += 1
+        # validate data type: TranscriptionMetadata
+        if not isinstance(v, TranscriptionMetadata):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `TranscriptionMetadata`")
+        else:
+            match += 1
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when setting `actual_instance` in CompareWorkflowConfigMetadataValue with oneOf schemas: ClassificationMetadata, CountMetadata, ImageDimensionMetadata, LocationMetadata, OriginalFilenameMetadata, PromptMetadata, SourceUrlMetadata, TextMetadata, TranscriptionMetadata. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when setting `actual_instance` in CompareWorkflowConfigMetadataValue with oneOf schemas: ClassificationMetadata, CountMetadata, ImageDimensionMetadata, LocationMetadata, OriginalFilenameMetadata, PromptMetadata, SourceUrlMetadata, TextMetadata, TranscriptionMetadata. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        match = 0
+
+        # deserialize data into ClassificationMetadata
+        try:
+            instance.actual_instance = ClassificationMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into CountMetadata
+        try:
+            instance.actual_instance = CountMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into ImageDimensionMetadata
+        try:
+            instance.actual_instance = ImageDimensionMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into LocationMetadata
+        try:
+            instance.actual_instance = LocationMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into OriginalFilenameMetadata
+        try:
+            instance.actual_instance = OriginalFilenameMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into PromptMetadata
+        try:
+            instance.actual_instance = PromptMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into SourceUrlMetadata
+        try:
+            instance.actual_instance = SourceUrlMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into TextMetadata
+        try:
+            instance.actual_instance = TextMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        # deserialize data into TranscriptionMetadata
+        try:
+            instance.actual_instance = TranscriptionMetadata.from_json(json_str)
+            match += 1
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if match > 1:
+            # more than 1 match
+            raise ValueError("Multiple matches found when deserializing the JSON string into CompareWorkflowConfigMetadataValue with oneOf schemas: ClassificationMetadata, CountMetadata, ImageDimensionMetadata, LocationMetadata, OriginalFilenameMetadata, PromptMetadata, SourceUrlMetadata, TextMetadata, TranscriptionMetadata. Details: " + ", ".join(error_messages))
+        elif match == 0:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into CompareWorkflowConfigMetadataValue with oneOf schemas: ClassificationMetadata, CountMetadata, ImageDimensionMetadata, LocationMetadata, OriginalFilenameMetadata, PromptMetadata, SourceUrlMetadata, TextMetadata, TranscriptionMetadata. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], ClassificationMetadata, CountMetadata, ImageDimensionMetadata, LocationMetadata, OriginalFilenameMetadata, PromptMetadata, SourceUrlMetadata, TextMetadata, TranscriptionMetadata]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            # primitive type
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

rapidata/api_client/models/compare_workflow_config_model.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.compare_workflow_config_metadata_value import CompareWorkflowConfigMetadataValue
 from rapidata.api_client.models.compare_workflow_config_model_pair_maker_config import CompareWorkflowConfigModelPairMakerConfig
 from rapidata.api_client.models.compare_workflow_model1_referee import CompareWorkflowModel1Referee
 from rapidata.api_client.models.elo_config import EloConfig
@@ -35,7 +36,8 @@ class CompareWorkflowConfigModel(BaseModel):
     referee: CompareWorkflowModel1Referee
     target_country_codes: List[StrictStr] = Field(description="A list of country codes that this workflow is targeting.", alias="targetCountryCodes")
     elo_config: Optional[EloConfig] = Field(default=None, alias="eloConfig")
-    __properties: ClassVar[List[str]] = ["_t", "criteria", "pairMakerConfig", "referee", "targetCountryCodes", "eloConfig"]
+    metadata: Dict[str, CompareWorkflowConfigMetadataValue] = Field(description="The metadata is attached to every single rapid and can be used for something like the prompt.")
+    __properties: ClassVar[List[str]] = ["_t", "criteria", "pairMakerConfig", "referee", "targetCountryCodes", "eloConfig", "metadata"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -92,6 +94,13 @@ class CompareWorkflowConfigModel(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of elo_config
         if self.elo_config:
             _dict['eloConfig'] = self.elo_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in metadata (dict)
+        _field_dict = {}
+        if self.metadata:
+            for _key_metadata in self.metadata:
+                if self.metadata[_key_metadata]:
+                    _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict()
+            _dict['metadata'] = _field_dict
         return _dict
 
     @classmethod
@@ -109,7 +118,13 @@ class CompareWorkflowConfigModel(BaseModel):
             "pairMakerConfig": CompareWorkflowConfigModelPairMakerConfig.from_dict(obj["pairMakerConfig"]) if obj.get("pairMakerConfig") is not None else None,
             "referee": CompareWorkflowModel1Referee.from_dict(obj["referee"]) if obj.get("referee") is not None else None,
             "targetCountryCodes": obj.get("targetCountryCodes"),
-            "eloConfig": EloConfig.from_dict(obj["eloConfig"]) if obj.get("eloConfig") is not None else None
+            "eloConfig": EloConfig.from_dict(obj["eloConfig"]) if obj.get("eloConfig") is not None else None,
+            "metadata": dict(
+                (_k, CompareWorkflowConfigMetadataValue.from_dict(_v))
+                for _k, _v in obj["metadata"].items()
+            )
+            if obj.get("metadata") is not None
+            else None
         })
         return _obj
 

rapidata/api_client/models/compare_workflow_model.py

@@ -20,6 +20,7 @@ import json
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from rapidata.api_client.models.compare_workflow_model_pair_maker_config import CompareWorkflowModelPairMakerConfig
+from rapidata.api_client.models.create_datapoint_from_urls_model_metadata_inner import CreateDatapointFromUrlsModelMetadataInner
 from rapidata.api_client.models.elo_config_model import EloConfigModel
 from typing import Optional, Set
 from typing_extensions import Self
@@ -32,7 +33,8 @@ class CompareWorkflowModel(BaseModel):
     criteria: StrictStr = Field(description="The criteria that the datapoints should be compared based on. No default value.")
     pair_maker_config: Optional[CompareWorkflowModelPairMakerConfig] = Field(default=None, alias="pairMakerConfig")
     elo_config: Optional[EloConfigModel] = Field(default=None, alias="eloConfig")
-    __properties: ClassVar[List[str]] = ["_t", "criteria", "pairMakerConfig", "eloConfig"]
+    metadata: Optional[List[CreateDatapointFromUrlsModelMetadataInner]] = Field(default=None, description="The metadata is attached to every single rapid and can be used for something like the prompt.")
+    __properties: ClassVar[List[str]] = ["_t", "criteria", "pairMakerConfig", "eloConfig", "metadata"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -86,6 +88,18 @@ class CompareWorkflowModel(BaseModel):
         # override the default output from pydantic by calling `to_dict()` of elo_config
         if self.elo_config:
             _dict['eloConfig'] = self.elo_config.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in metadata (list)
+        _items = []
+        if self.metadata:
+            for _item_metadata in self.metadata:
+                if _item_metadata:
+                    _items.append(_item_metadata.to_dict())
+            _dict['metadata'] = _items
+        # set to None if metadata (nullable) is None
+        # and model_fields_set contains the field
+        if self.metadata is None and "metadata" in self.model_fields_set:
+            _dict['metadata'] = None
+
         return _dict
 
     @classmethod
@@ -101,7 +115,8 @@ class CompareWorkflowModel(BaseModel):
             "_t": obj.get("_t") if obj.get("_t") is not None else 'CompareWorkflow',
             "criteria": obj.get("criteria"),
             "pairMakerConfig": CompareWorkflowModelPairMakerConfig.from_dict(obj["pairMakerConfig"]) if obj.get("pairMakerConfig") is not None else None,
-            "eloConfig": EloConfigModel.from_dict(obj["eloConfig"]) if obj.get("eloConfig") is not None else None
+            "eloConfig": EloConfigModel.from_dict(obj["eloConfig"]) if obj.get("eloConfig") is not None else None,
+            "metadata": [CreateDatapointFromUrlsModelMetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None
         })
         return _obj
 

rapidata/api_client/models/count_metadata.py

@@ -28,9 +28,8 @@ class CountMetadata(BaseModel):
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for CountMetadata", alias="_t")
     count: StrictInt
-    identifier: Optional[StrictStr] = None
     visibilities: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["_t", "count", "identifier", "visibilities"]
+    __properties: ClassVar[List[str]] = ["_t", "count", "visibilities"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -92,7 +91,6 @@ class CountMetadata(BaseModel):
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'CountMetadata',
             "count": obj.get("count"),
-            "identifier": obj.get("identifier"),
             "visibilities": obj.get("visibilities")
         })
         return _obj

rapidata/api_client/models/create_order_model.py

@@ -39,10 +39,12 @@ class CreateOrderModel(BaseModel):
     feature_flags: Optional[List[FeatureFlagModel]] = Field(default=None, description="The feature flags are used to enable or disable certain features.", alias="featureFlags")
     priority: Optional[StrictInt] = Field(default=None, description="The priority is used to prioritize over other orders.")
     is_sticky: Optional[StrictBool] = Field(default=None, description="Indicates if the underlying campaign should be sticky.", alias="isSticky")
+    user_score_dimensions: Optional[List[StrictStr]] = Field(default=None, description="The user score dimensions are used to determine the score of the responses from the user.", alias="userScoreDimensions")
+    demographic_keys: Optional[List[StrictStr]] = Field(default=None, description="The demographic keys are used to determine which demographics to store on the resposnes from the user.", alias="demographicKeys")
     user_filters: List[CreateOrderModelUserFiltersInner] = Field(description="The user filters are used to restrict the order to only collect votes from a specific demographic.", alias="userFilters")
     validation_set_id: Optional[StrictStr] = Field(default=None, description="The validation set id can be changed to point to a specific validation set. if not provided a sane default will be  used.", alias="validationSetId")
     selections: Optional[List[AbTestSelectionAInner]] = Field(default=None, description="The selections are used to determine which tasks are shown to a user.")
-    __properties: ClassVar[List[str]] = ["_t", "orderName", "workflow", "referee", "aggregator", "featureFlags", "priority", "isSticky", "userFilters", "validationSetId", "selections"]
+    __properties: ClassVar[List[str]] = ["_t", "orderName", "workflow", "referee", "aggregator", "featureFlags", "priority", "isSticky", "userScoreDimensions", "demographicKeys", "userFilters", "validationSetId", "selections"]
 
     @field_validator('t')
     def t_validate_enum(cls, value):
@@ -142,6 +144,16 @@ class CreateOrderModel(BaseModel):
         if self.priority is None and "priority" in self.model_fields_set:
             _dict['priority'] = None
 
+        # set to None if user_score_dimensions (nullable) is None
+        # and model_fields_set contains the field
+        if self.user_score_dimensions is None and "user_score_dimensions" in self.model_fields_set:
+            _dict['userScoreDimensions'] = None
+
+        # set to None if demographic_keys (nullable) is None
+        # and model_fields_set contains the field
+        if self.demographic_keys is None and "demographic_keys" in self.model_fields_set:
+            _dict['demographicKeys'] = None
+
         # set to None if validation_set_id (nullable) is None
         # and model_fields_set contains the field
         if self.validation_set_id is None and "validation_set_id" in self.model_fields_set:
@@ -172,6 +184,8 @@ class CreateOrderModel(BaseModel):
             "featureFlags": [FeatureFlagModel.from_dict(_item) for _item in obj["featureFlags"]] if obj.get("featureFlags") is not None else None,
             "priority": obj.get("priority"),
             "isSticky": obj.get("isSticky"),
+            "userScoreDimensions": obj.get("userScoreDimensions"),
+            "demographicKeys": obj.get("demographicKeys"),
             "userFilters": [CreateOrderModelUserFiltersInner.from_dict(_item) for _item in obj["userFilters"]] if obj.get("userFilters") is not None else None,
             "validationSetId": obj.get("validationSetId"),
             "selections": [AbTestSelectionAInner.from_dict(_item) for _item in obj["selections"]] if obj.get("selections") is not None else None

rapidata/api_client/models/early_stopping_referee_model.py

@@ -24,7 +24,7 @@ from typing_extensions import Self
 
 class EarlyStoppingRefereeModel(BaseModel):
     """
-    The Early Stopping Referee can currently only be used for classification tasks and will stop once a certain threshold is reached or the maximum number of votes is collected.
+    The Early Stopping Referee can currently only be used for classification tasks and will stop once a certain  threshold is reached or the maximum number of votes is collected.
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for EarlyStoppingReferee", alias="_t")
     max_votes: StrictInt = Field(description="The upper limit of votes that will be collected for each task.", alias="maxVotes")

rapidata/api_client/models/evaluation_workflow_model.py

@@ -27,7 +27,7 @@ class EvaluationWorkflowModel(BaseModel):
     If the EvaluationWorkflow is chosen a validation set will be used as a source for all tasks.  It functions similarly to the SimpleWorkflow as there is a 1:1 mapping between validation rapids and tasks.
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for EvaluationWorkflow", alias="_t")
-    validation_set_id: StrictStr = Field(description="The Validation Set Id is used to as a source for the tasks that will be sent to the user.", alias="validationSetId")
+    validation_set_id: StrictStr = Field(description="The Validation Set id is used to as a source for the tasks that will be sent to the user.", alias="validationSetId")
     should_accept_incorrect: StrictBool = Field(description="Indicates if the user should get feedback on their answers if they answer wrong. If set to true the user will not  notice that he was tested.", alias="shouldAcceptIncorrect")
     __properties: ClassVar[List[str]] = ["_t", "validationSetId", "shouldAcceptIncorrect"]