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

rapidata/api_client/models/get_responses_result.py

@@ -0,0 +1,95 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from rapidata.api_client.models.rapid_response import RapidResponse
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetResponsesResult(BaseModel):
+    """
+    GetResponsesResult
+    """ # noqa: E501
+    responses: List[RapidResponse]
+    __properties: ClassVar[List[str]] = ["responses"]
+
+    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 GetResponsesResult 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,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in responses (list)
+        _items = []
+        if self.responses:
+            for _item_responses in self.responses:
+                if _item_responses:
+                    _items.append(_item_responses.to_dict())
+            _dict['responses'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetResponsesResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "responses": [RapidResponse.from_dict(_item) for _item in obj["responses"]] if obj.get("responses") is not None else None
+        })
+        return _obj
+
+

rapidata/api_client/models/get_simple_workflow_results_result.py

@@ -19,7 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List
-from rapidata.api_client.models.datapoint_model_asset import DatapointModelAsset
+from rapidata.api_client.models.datapoint_asset import DatapointAsset
 from rapidata.api_client.models.rapid_response import RapidResponse
 from typing import Optional, Set
 from typing_extensions import Self
@@ -29,7 +29,7 @@ class GetSimpleWorkflowResultsResult(BaseModel):
     GetSimpleWorkflowResultsResult
     """ # noqa: E501
     rapid_id: StrictStr = Field(alias="rapidId")
-    asset: DatapointModelAsset
+    asset: DatapointAsset
     responses: List[RapidResponse]
     state: StrictStr
     __properties: ClassVar[List[str]] = ["rapidId", "asset", "responses", "state"]
@@ -103,7 +103,7 @@ class GetSimpleWorkflowResultsResult(BaseModel):
 
         _obj = cls.model_validate({
             "rapidId": obj.get("rapidId"),
-            "asset": DatapointModelAsset.from_dict(obj["asset"]) if obj.get("asset") is not None else None,
+            "asset": DatapointAsset.from_dict(obj["asset"]) if obj.get("asset") is not None else None,
             "responses": [RapidResponse.from_dict(_item) for _item in obj["responses"]] if obj.get("responses") is not None else None,
             "state": obj.get("state")
         })

rapidata/api_client/models/multi_asset_model.py

@@ -28,7 +28,7 @@ class MultiAssetModel(BaseModel):
     MultiAssetModel
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for MultiAsset", alias="_t")
-    assets: List[DatapointModelAsset]
+    assets: List[DatapointAsset]
     metadata: Dict[str, FileAssetModelMetadataValue]
     identifier: StrictStr
     __properties: ClassVar[List[str]] = ["_t", "assets", "metadata", "identifier"]
@@ -106,7 +106,7 @@ class MultiAssetModel(BaseModel):
 
         _obj = cls.model_validate({
             "_t": obj.get("_t") if obj.get("_t") is not None else 'MultiAsset',
-            "assets": [DatapointModelAsset.from_dict(_item) for _item in obj["assets"]] if obj.get("assets") is not None else None,
+            "assets": [DatapointAsset.from_dict(_item) for _item in obj["assets"]] if obj.get("assets") is not None else None,
             "metadata": dict(
                 (_k, FileAssetModelMetadataValue.from_dict(_v))
                 for _k, _v in obj["metadata"].items()
@@ -117,7 +117,7 @@ class MultiAssetModel(BaseModel):
         })
         return _obj
 
-from rapidata.api_client.models.datapoint_model_asset import DatapointModelAsset
+from rapidata.api_client.models.datapoint_asset import DatapointAsset
 # TODO: Rewrite to not use raise_errors
 MultiAssetModel.model_rebuild(raise_errors=False)
 

rapidata/api_client/models/upload_text_sources_to_dataset_model.py

@@ -19,6 +19,7 @@ import json
 
 from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
+from rapidata.api_client.models.create_datapoint_from_urls_model_metadata_inner import CreateDatapointFromUrlsModelMetadataInner
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -29,7 +30,8 @@ class UploadTextSourcesToDatasetModel(BaseModel):
     dataset_id: StrictStr = Field(description="The id of the dataset to upload the text sources to.", alias="datasetId")
     text_sources: List[StrictStr] = Field(description="The text sources to upload.", alias="textSources")
     sort_index: Optional[StrictInt] = Field(default=None, description="The index will be used to keep the datapoints in order. Useful if upload is parallelized", alias="sortIndex")
-    __properties: ClassVar[List[str]] = ["datasetId", "textSources", "sortIndex"]
+    metadata: Optional[List[CreateDatapointFromUrlsModelMetadataInner]] = Field(default=None, description="Additional metadata to attach to the datapoint.  Most commonly used to add a prompt to the datapoint using the Rapidata.Shared.Assets.Abstraction.Models.Metadata.Input.PromptMetadataInput.")
+    __properties: ClassVar[List[str]] = ["datasetId", "textSources", "sortIndex", "metadata"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -70,11 +72,23 @@ class UploadTextSourcesToDatasetModel(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
+        # 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 sort_index (nullable) is None
         # and model_fields_set contains the field
         if self.sort_index is None and "sort_index" in self.model_fields_set:
             _dict['sortIndex'] = None
 
+        # 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
@@ -89,7 +103,8 @@ class UploadTextSourcesToDatasetModel(BaseModel):
         _obj = cls.model_validate({
             "datasetId": obj.get("datasetId"),
             "textSources": obj.get("textSources"),
-            "sortIndex": obj.get("sortIndex")
+            "sortIndex": obj.get("sortIndex"),
+            "metadata": [CreateDatapointFromUrlsModelMetadataInner.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None
         })
         return _obj
 

rapidata/api_client_README.md

@@ -87,6 +87,7 @@ Class | Method | HTTP request | Description
 *DatapointApi* | [**datapoint_get_by_id_get**](rapidata/api_client/docs/DatapointApi.md#datapoint_get_by_id_get) | **GET** /Datapoint/GetById | Get a datapoint by its id.
 *DatasetApi* | [**dataset_creat_text_datapoint_post**](rapidata/api_client/docs/DatasetApi.md#dataset_creat_text_datapoint_post) | **POST** /Dataset/CreatTextDatapoint | Creates new datapoints from text sources.
 *DatasetApi* | [**dataset_create_datapoint_post**](rapidata/api_client/docs/DatasetApi.md#dataset_create_datapoint_post) | **POST** /Dataset/CreateDatapoint | Creates a single datapoint.
+*DatasetApi* | [**dataset_dataset_id_datapoints_failed_get**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_failed_get) | **GET** /dataset/{datasetId}/datapoints/failed | Gets a list of all datapoints that failed to upload.
 *DatasetApi* | [**dataset_dataset_id_datapoints_urls_post**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_datapoints_urls_post) | **POST** /dataset/{datasetId}/datapoints/urls | Creates new datapoint where the assets are fetched from the specified urls.
 *DatasetApi* | [**dataset_dataset_id_progress_get**](rapidata/api_client/docs/DatasetApi.md#dataset_dataset_id_progress_get) | **GET** /dataset/{datasetId}/progress | Gets the upload progress of a dataset.
 *DatasetApi* | [**dataset_get_by_id_get**](rapidata/api_client/docs/DatasetApi.md#dataset_get_by_id_get) | **GET** /Dataset/GetById | Gets a dataset by its id.
@@ -135,6 +136,7 @@ Class | Method | HTTP request | Description
 *RapidApi* | [**rapid_skip_user_guess_post**](rapidata/api_client/docs/RapidApi.md#rapid_skip_user_guess_post) | **POST** /Rapid/SkipUserGuess | Skips a Rapid for the user.
 *RapidApi* | [**rapid_validate_current_rapid_bag_get**](rapidata/api_client/docs/RapidApi.md#rapid_validate_current_rapid_bag_get) | **GET** /Rapid/ValidateCurrentRapidBag | Validates that the rapids associated with the current user are active.
 *RapidApi* | [**rapid_validation_rapid_id_put**](rapidata/api_client/docs/RapidApi.md#rapid_validation_rapid_id_put) | **PUT** /rapid/validation/{rapidId} | Updates the validation information of a rapid.
+*RapidataIdentityAPIApi* | [**root_get**](rapidata/api_client/docs/RapidataIdentityAPIApi.md#root_get) | **GET** / | 
 *SimpleWorkflowApi* | [**workflow_simple_id_results_get**](rapidata/api_client/docs/SimpleWorkflowApi.md#workflow_simple_id_results_get) | **GET** /workflow/simple/{id}/results | Get the result overview for a simple workflow.
 *UserInfoApi* | [**connect_userinfo_get**](rapidata/api_client/docs/UserInfoApi.md#connect_userinfo_get) | **GET** /connect/userinfo | Retrieves information about the authenticated user.
 *ValidationApi* | [**validation_add_validation_rapid_post**](rapidata/api_client/docs/ValidationApi.md#validation_add_validation_rapid_post) | **POST** /Validation/AddValidationRapid | Adds a new validation rapid to the specified validation set.
@@ -149,6 +151,7 @@ Class | Method | HTTP request | Description
 *WorkflowApi* | [**workflow_get_by_id_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_get_by_id_get) | **GET** /Workflow/GetById | Get a workflow by its ID.
 *WorkflowApi* | [**workflow_get_progress_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_get_progress_get) | **GET** /Workflow/GetProgress | Get the progress of a workflow.
 *WorkflowApi* | [**workflow_id_compare_ab_summary_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_id_compare_ab_summary_get) | **GET** /workflow/{id}/compare-ab-summary | Calculates a summary of the results for a simple compare workflow.  The summary includes the number of times an asset at each index was the winner.
+*WorkflowApi* | [**workflow_id_responses_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_id_responses_get) | **GET** /workflow/{id}/responses | Gets the !:limit most recent or oldest responses for a workflow.  The responses are not guaranteed to be of any specific rapid.  Instead, this endpoint returns all responses to any rapid in the workflow.
 *WorkflowApi* | [**workflow_query_get**](rapidata/api_client/docs/WorkflowApi.md#workflow_query_get) | **GET** /Workflow/Query | Queries workflows based on the provided filter, page, and sort criteria.
 
 
@@ -158,7 +161,6 @@ Class | Method | HTTP request | Description
  - [AbTestSelectionAInner](rapidata/api_client/docs/AbTestSelectionAInner.md)
  - [AddCampaignArtifactResult](rapidata/api_client/docs/AddCampaignArtifactResult.md)
  - [AddCampaignModel](rapidata/api_client/docs/AddCampaignModel.md)
- - [AddCampaignModelUserFiltersInner](rapidata/api_client/docs/AddCampaignModelUserFiltersInner.md)
  - [AddValidationRapidModel](rapidata/api_client/docs/AddValidationRapidModel.md)
  - [AddValidationRapidModelPayload](rapidata/api_client/docs/AddValidationRapidModelPayload.md)
  - [AddValidationRapidModelTruth](rapidata/api_client/docs/AddValidationRapidModelTruth.md)
@@ -215,6 +217,7 @@ Class | Method | HTTP request | Description
  - [CreateComplexOrderModelPipeline](rapidata/api_client/docs/CreateComplexOrderModelPipeline.md)
  - [CreateComplexOrderResult](rapidata/api_client/docs/CreateComplexOrderResult.md)
  - [CreateDatapointFromUrlsModel](rapidata/api_client/docs/CreateDatapointFromUrlsModel.md)
+ - [CreateDatapointFromUrlsModelMetadataInner](rapidata/api_client/docs/CreateDatapointFromUrlsModelMetadataInner.md)
  - [CreateDatapointResult](rapidata/api_client/docs/CreateDatapointResult.md)
  - [CreateDatasetArtifactModel](rapidata/api_client/docs/CreateDatasetArtifactModel.md)
  - [CreateDatasetArtifactModelDataset](rapidata/api_client/docs/CreateDatasetArtifactModelDataset.md)
@@ -230,10 +233,10 @@ Class | Method | HTTP request | Description
  - [CreateSimplePipelineModelPipelineStepsInner](rapidata/api_client/docs/CreateSimplePipelineModelPipelineStepsInner.md)
  - [CreateUnsupportedOrderModel](rapidata/api_client/docs/CreateUnsupportedOrderModel.md)
  - [CustomUserFilterModel](rapidata/api_client/docs/CustomUserFilterModel.md)
+ - [Datapoint](rapidata/api_client/docs/Datapoint.md)
+ - [DatapointAsset](rapidata/api_client/docs/DatapointAsset.md)
  - [DatapointMetadataModel](rapidata/api_client/docs/DatapointMetadataModel.md)
- - [DatapointMetadataModelMetadataInner](rapidata/api_client/docs/DatapointMetadataModelMetadataInner.md)
  - [DatapointModel](rapidata/api_client/docs/DatapointModel.md)
- - [DatapointModelAsset](rapidata/api_client/docs/DatapointModelAsset.md)
  - [DatapointState](rapidata/api_client/docs/DatapointState.md)
  - [DatasetArtifactModel](rapidata/api_client/docs/DatasetArtifactModel.md)
  - [DatasetEvaluationStepModel](rapidata/api_client/docs/DatasetEvaluationStepModel.md)
@@ -268,10 +271,12 @@ Class | Method | HTTP request | Description
  - [GetDatapointsByDatasetIdResult](rapidata/api_client/docs/GetDatapointsByDatasetIdResult.md)
  - [GetDatasetByIdResult](rapidata/api_client/docs/GetDatasetByIdResult.md)
  - [GetDatasetProgressResult](rapidata/api_client/docs/GetDatasetProgressResult.md)
+ - [GetFailedDatapointsResult](rapidata/api_client/docs/GetFailedDatapointsResult.md)
  - [GetOrderByIdResult](rapidata/api_client/docs/GetOrderByIdResult.md)
  - [GetPipelineByIdResult](rapidata/api_client/docs/GetPipelineByIdResult.md)
  - [GetPipelineByIdResultArtifactsValue](rapidata/api_client/docs/GetPipelineByIdResultArtifactsValue.md)
  - [GetPublicOrdersResult](rapidata/api_client/docs/GetPublicOrdersResult.md)
+ - [GetResponsesResult](rapidata/api_client/docs/GetResponsesResult.md)
  - [GetSimpleWorkflowResultsModel](rapidata/api_client/docs/GetSimpleWorkflowResultsModel.md)
  - [GetSimpleWorkflowResultsResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResult.md)
  - [GetSimpleWorkflowResultsResultPagedResult](rapidata/api_client/docs/GetSimpleWorkflowResultsResultPagedResult.md)
@@ -311,7 +316,6 @@ Class | Method | HTTP request | Description
  - [NamedEntityTruth](rapidata/api_client/docs/NamedEntityTruth.md)
  - [NeverEndingRefereeConfig](rapidata/api_client/docs/NeverEndingRefereeConfig.md)
  - [NewUserFilterModel](rapidata/api_client/docs/NewUserFilterModel.md)
- - [NewUserFilterModel1](rapidata/api_client/docs/NewUserFilterModel1.md)
  - [NewsletterModel](rapidata/api_client/docs/NewsletterModel.md)
  - [NotAvailableYetResult](rapidata/api_client/docs/NotAvailableYetResult.md)
  - [NullAssetModel](rapidata/api_client/docs/NullAssetModel.md)

rapidata/rapidata_client/assets/_media_asset.py

@@ -84,7 +84,7 @@ class MediaAsset(BaseAsset):
             self._url = path
             self.name = path.split('/')[-1]
             self.name = self.__check_name_ending(self.name)
-            self.path = None  # Will be set when content is downloaded
+            self.path = path
             return
         
         if not os.path.exists(path):
@@ -287,6 +287,10 @@ class MediaAsset(BaseAsset):
         self._logger.error(error_msg)
         raise ValueError(error_msg)
     
+    def is_local(self) -> bool:
+        """Check if the media asset is a local file."""
+        return self._url is None
+    
     def to_file(self) -> StrictStr | tuple[StrictStr, StrictBytes] | StrictBytes:
         """Convert the media asset to a file representation."""
         if self._url is None:

rapidata/rapidata_client/assets/_multi_asset.py

@@ -5,7 +5,7 @@ Defines the MultiAsset class for handling multiple BaseAsset instances.
 
 from rapidata.rapidata_client.assets._base_asset import BaseAsset
 from rapidata.rapidata_client.assets import MediaAsset, TextAsset
-from typing import Iterator, Sequence
+from typing import Iterator, Sequence, cast
 
 
 class MultiAsset(BaseAsset):
@@ -34,6 +34,11 @@ class MultiAsset(BaseAsset):
         if not all(isinstance(asset, type(assets[0])) for asset in assets):
             raise ValueError("All assets must be of the same type.")
         
+        if isinstance(assets[0], MediaAsset):
+            local = [asset.is_local() for asset in cast(Sequence[MediaAsset], assets)]
+            if not all(loc == local[0] for loc in local):
+                raise ValueError("A datapoint with multiple assets can either have both assets be local paths or both be URLs. not a mix of both.")
+            
         self.assets = assets
         
     def __len__(self) -> int:

rapidata/rapidata_client/filter/country_filter.py

@@ -9,7 +9,7 @@ class CountryFilter(RapidataFilter):
     Can be used to filter who to target based on country codes.
     
     Args:
-        country_codes (list[str]): List of country codes (capizalized) to filter by.
+        country_codes (list[str]): List of country codes (capitalized) to filter by.
     """
 
     def __init__(self, country_codes: list[str]):