rapidata 2.16.0__tar.gz → 2.17.0__tar.gz

{rapidata-2.16.0 → rapidata-2.17.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rapidata
-Version: 2.16.0
+Version: 2.17.0
 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.16.0 → rapidata-2.17.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "rapidata"
-version = "2.16.0"
+version = "2.17.0"
 description = "Rapidata package containing the Rapidata Python Client to interact with the Rapidata Web API in an easy way."
 authors = ["Rapidata AG <info@rapidata.ai>"]
 license = "Apache-2.0"

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/__init__.py

@@ -5,6 +5,7 @@ from .rapidata_client import (
     ValidationSelection,
     ConditionalValidationSelection,
     CappedSelection,
+    ShufflingSelection,
     RapidataSettings,
     TranslationBehaviourOptions,
     AlertOnFastResponse,

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/api/client_api.py

@@ -589,7 +589,7 @@ class ClientApi:
     ) -> ClientsQueryResultPagedResult:
         """(Deprecated) Gets the clients for the current customer.
 
-        A client allows a customer to authenticate with the APIs without using their own credentials.  This is useful for creating service accounts or other automated processes,  as when using the Rapidata Python SDK.
+        A client allows a customer to authenticate with the APIs without using their own credentials. This is useful for creating service accounts or other automated processes, as when using the Rapidata Python SDK.
 
         :param request:
         :type request: QueryModel
@@ -657,7 +657,7 @@ class ClientApi:
     ) -> ApiResponse[ClientsQueryResultPagedResult]:
         """(Deprecated) Gets the clients for the current customer.
 
-        A client allows a customer to authenticate with the APIs without using their own credentials.  This is useful for creating service accounts or other automated processes,  as when using the Rapidata Python SDK.
+        A client allows a customer to authenticate with the APIs without using their own credentials. This is useful for creating service accounts or other automated processes, as when using the Rapidata Python SDK.
 
         :param request:
         :type request: QueryModel
@@ -725,7 +725,7 @@ class ClientApi:
     ) -> RESTResponseType:
         """(Deprecated) Gets the clients for the current customer.
 
-        A client allows a customer to authenticate with the APIs without using their own credentials.  This is useful for creating service accounts or other automated processes,  as when using the Rapidata Python SDK.
+        A client allows a customer to authenticate with the APIs without using their own credentials. This is useful for creating service accounts or other automated processes, as when using the Rapidata Python SDK.
 
         :param request:
         :type request: QueryModel
@@ -1115,7 +1115,7 @@ class ClientApi:
     ) -> ClientsQueryResultPagedResult:
         """Queries the clients for the current customer.
 
-        A client allows a customer to authenticate with the APIs without using their own credentials.  This is useful for creating service accounts or other automated processes,  as when using the Rapidata Python SDK.
+        A client allows a customer to authenticate with the APIs without using their own credentials. This is useful for creating service accounts or other automated processes, as when using the Rapidata Python SDK.
 
         :param request:
         :type request: QueryModel
@@ -1182,7 +1182,7 @@ class ClientApi:
     ) -> ApiResponse[ClientsQueryResultPagedResult]:
         """Queries the clients for the current customer.
 
-        A client allows a customer to authenticate with the APIs without using their own credentials.  This is useful for creating service accounts or other automated processes,  as when using the Rapidata Python SDK.
+        A client allows a customer to authenticate with the APIs without using their own credentials. This is useful for creating service accounts or other automated processes, as when using the Rapidata Python SDK.
 
         :param request:
         :type request: QueryModel
@@ -1249,7 +1249,7 @@ class ClientApi:
     ) -> RESTResponseType:
         """Queries the clients for the current customer.
 
-        A client allows a customer to authenticate with the APIs without using their own credentials.  This is useful for creating service accounts or other automated processes,  as when using the Rapidata Python SDK.
+        A client allows a customer to authenticate with the APIs without using their own credentials. This is useful for creating service accounts or other automated processes, as when using the Rapidata Python SDK.
 
         :param request:
         :type request: QueryModel

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/api/dataset_api.py

@@ -939,7 +939,7 @@ class DatasetApi:
     ) -> GetFailedDatapointsResult:
         """Gets a list of all datapoints that failed to upload.
 
-        A datapoint usually fails to upload when using a deferred upload mechanism such as when providing a URL  and the URL is not accessible.
+        A datapoint usually fails to upload when using a deferred upload mechanism such as when providing a URL and the URL is not accessible.
 
         :param dataset_id: The id of the dataset to get the failed datapoints of. (required)
         :type dataset_id: str
@@ -1006,7 +1006,7 @@ class DatasetApi:
     ) -> ApiResponse[GetFailedDatapointsResult]:
         """Gets a list of all datapoints that failed to upload.
 
-        A datapoint usually fails to upload when using a deferred upload mechanism such as when providing a URL  and the URL is not accessible.
+        A datapoint usually fails to upload when using a deferred upload mechanism such as when providing a URL and the URL is not accessible.
 
         :param dataset_id: The id of the dataset to get the failed datapoints of. (required)
         :type dataset_id: str
@@ -1073,7 +1073,7 @@ class DatasetApi:
     ) -> RESTResponseType:
         """Gets a list of all datapoints that failed to upload.
 
-        A datapoint usually fails to upload when using a deferred upload mechanism such as when providing a URL  and the URL is not accessible.
+        A datapoint usually fails to upload when using a deferred upload mechanism such as when providing a URL and the URL is not accessible.
 
         :param dataset_id: The id of the dataset to get the failed datapoints of. (required)
         :type dataset_id: str
@@ -2361,7 +2361,7 @@ class DatasetApi:
     ) -> CreateDatapointResult:
         """Creates a single datapoint where the assets are fetched from the specified urls.
 
-        Passing in multiple urls will create a single datapoint with a MultiAsset.  Each url will be fetched and stored as a sub-asset of the MultiAsset.  <para />  If any of the urls are not accessible, the request will fail.
+        Passing in multiple urls will create a single datapoint with a MultiAsset. Each url will be fetched and stored as a sub-asset of the MultiAsset. <para /> If any of the urls are not accessible, the request will fail.
 
         :param dataset_id: The id of the dataset to create the datapoint in. (required)
         :type dataset_id: str
@@ -2432,7 +2432,7 @@ class DatasetApi:
     ) -> ApiResponse[CreateDatapointResult]:
         """Creates a single datapoint where the assets are fetched from the specified urls.
 
-        Passing in multiple urls will create a single datapoint with a MultiAsset.  Each url will be fetched and stored as a sub-asset of the MultiAsset.  <para />  If any of the urls are not accessible, the request will fail.
+        Passing in multiple urls will create a single datapoint with a MultiAsset. Each url will be fetched and stored as a sub-asset of the MultiAsset. <para /> If any of the urls are not accessible, the request will fail.
 
         :param dataset_id: The id of the dataset to create the datapoint in. (required)
         :type dataset_id: str
@@ -2503,7 +2503,7 @@ class DatasetApi:
     ) -> RESTResponseType:
         """Creates a single datapoint where the assets are fetched from the specified urls.
 
-        Passing in multiple urls will create a single datapoint with a MultiAsset.  Each url will be fetched and stored as a sub-asset of the MultiAsset.  <para />  If any of the urls are not accessible, the request will fail.
+        Passing in multiple urls will create a single datapoint with a MultiAsset. Each url will be fetched and stored as a sub-asset of the MultiAsset. <para /> If any of the urls are not accessible, the request will fail.
 
         :param dataset_id: The id of the dataset to create the datapoint in. (required)
         :type dataset_id: str

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/api/identity_api.py

@@ -59,7 +59,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ReadBridgeTokenKeysResult:
-        """Tries to read the bridge token keys for a given read key.  The read key is used to retrieve the authentication result written by the write key.
+        """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
 
 
         :param read_key: The read key to read the bridge token keys for.
@@ -126,7 +126,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[ReadBridgeTokenKeysResult]:
-        """Tries to read the bridge token keys for a given read key.  The read key is used to retrieve the authentication result written by the write key.
+        """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
 
 
         :param read_key: The read key to read the bridge token keys for.
@@ -193,7 +193,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Tries to read the bridge token keys for a given read key.  The read key is used to retrieve the authentication result written by the write key.
+        """Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
 
 
         :param read_key: The read key to read the bridge token keys for.
@@ -325,7 +325,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> CreateBridgeTokenResult:
-        """Creates a pair of read and write keys for a client.  The write key is used to store the authentication result.  The read key is used to retrieve the authentication result.
+        """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
 
 
         :param client_id: The client ID to create the keys for.
@@ -391,7 +391,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[CreateBridgeTokenResult]:
-        """Creates a pair of read and write keys for a client.  The write key is used to store the authentication result.  The read key is used to retrieve the authentication result.
+        """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
 
 
         :param client_id: The client ID to create the keys for.
@@ -457,7 +457,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """Creates a pair of read and write keys for a client.  The write key is used to store the authentication result.  The read key is used to retrieve the authentication result.
+        """Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
 
 
         :param client_id: The client ID to create the keys for.
@@ -588,7 +588,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> CreateBridgeTokenResult:
-        """(Deprecated) Creates a pair of read and write keys for a client.  The write key is used to store the authentication result.  The read key is used to retrieve the authentication result.
+        """(Deprecated) Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
 
 
         :param client_id: The client ID to create the keys for.
@@ -655,7 +655,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[CreateBridgeTokenResult]:
-        """(Deprecated) Creates a pair of read and write keys for a client.  The write key is used to store the authentication result.  The read key is used to retrieve the authentication result.
+        """(Deprecated) Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
 
 
         :param client_id: The client ID to create the keys for.
@@ -722,7 +722,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """(Deprecated) Creates a pair of read and write keys for a client.  The write key is used to store the authentication result.  The read key is used to retrieve the authentication result.
+        """(Deprecated) Creates a pair of read and write keys for a client. The write key is used to store the authentication result. The read key is used to retrieve the authentication result.
 
 
         :param client_id: The client ID to create the keys for.
@@ -854,7 +854,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ReadBridgeTokenKeysResult:
-        """(Deprecated) Tries to read the bridge token keys for a given read key.  The read key is used to retrieve the authentication result written by the write key.
+        """(Deprecated) Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
 
 
         :param read_key: The read key to read the bridge token keys for.
@@ -922,7 +922,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[ReadBridgeTokenKeysResult]:
-        """(Deprecated) Tries to read the bridge token keys for a given read key.  The read key is used to retrieve the authentication result written by the write key.
+        """(Deprecated) Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
 
 
         :param read_key: The read key to read the bridge token keys for.
@@ -990,7 +990,7 @@ class IdentityApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """(Deprecated) Tries to read the bridge token keys for a given read key.  The read key is used to retrieve the authentication result written by the write key.
+        """(Deprecated) Tries to read the bridge token keys for a given read key. The read key is used to retrieve the authentication result written by the write key.
 
 
         :param read_key: The read key to read the bridge token keys for.

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/api/order_api.py

@@ -71,7 +71,7 @@ class OrderApi:
     ) -> None:
         """(Deprecated) Approves an order that has been submitted for manual approval.
 
-        An order is submitted for manual approval when the automatic approval process could not automatically  determine if the order is safe to process.  Once an order is approved, the pipeline will start processing the order.
+        An order is submitted for manual approval when the automatic approval process could not automatically determine if the order is safe to process. Once an order is approved, the pipeline will start processing the order.
 
         :param order_id: The id of the order to approve
         :type order_id: str
@@ -139,7 +139,7 @@ class OrderApi:
     ) -> ApiResponse[None]:
         """(Deprecated) Approves an order that has been submitted for manual approval.
 
-        An order is submitted for manual approval when the automatic approval process could not automatically  determine if the order is safe to process.  Once an order is approved, the pipeline will start processing the order.
+        An order is submitted for manual approval when the automatic approval process could not automatically determine if the order is safe to process. Once an order is approved, the pipeline will start processing the order.
 
         :param order_id: The id of the order to approve
         :type order_id: str
@@ -207,7 +207,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """(Deprecated) Approves an order that has been submitted for manual approval.
 
-        An order is submitted for manual approval when the automatic approval process could not automatically  determine if the order is safe to process.  Once an order is approved, the pipeline will start processing the order.
+        An order is submitted for manual approval when the automatic approval process could not automatically determine if the order is safe to process. Once an order is approved, the pipeline will start processing the order.
 
         :param order_id: The id of the order to approve
         :type order_id: str
@@ -2240,7 +2240,7 @@ class OrderApi:
     ) -> object:
         """(Deprecated) Aggregates the results of an order.
 
-        Returns the aggregated result as a file with a given name.  The annotated type of the response represents the content type of the file.
+        Returns the aggregated result as a file with a given name. The annotated type of the response represents the content type of the file.
 
         :param id: The id of the order
         :type id: str
@@ -2308,7 +2308,7 @@ class OrderApi:
     ) -> ApiResponse[object]:
         """(Deprecated) Aggregates the results of an order.
 
-        Returns the aggregated result as a file with a given name.  The annotated type of the response represents the content type of the file.
+        Returns the aggregated result as a file with a given name. The annotated type of the response represents the content type of the file.
 
         :param id: The id of the order
         :type id: str
@@ -2376,7 +2376,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """(Deprecated) Aggregates the results of an order.
 
-        Returns the aggregated result as a file with a given name.  The annotated type of the response represents the content type of the file.
+        Returns the aggregated result as a file with a given name. The annotated type of the response represents the content type of the file.
 
         :param id: The id of the order
         :type id: str
@@ -2758,7 +2758,7 @@ class OrderApi:
     ) -> None:
         """Approves an order that has been submitted for manual approval.
 
-        An order is submitted for manual approval when the automatic approval process could not automatically  determine if the order is safe to process.  Once an order is approved, the pipeline will start processing the order.
+        An order is submitted for manual approval when the automatic approval process could not automatically determine if the order is safe to process. Once an order is approved, the pipeline will start processing the order.
 
         :param order_id: The id of the order to approve (required)
         :type order_id: str
@@ -2825,7 +2825,7 @@ class OrderApi:
     ) -> ApiResponse[None]:
         """Approves an order that has been submitted for manual approval.
 
-        An order is submitted for manual approval when the automatic approval process could not automatically  determine if the order is safe to process.  Once an order is approved, the pipeline will start processing the order.
+        An order is submitted for manual approval when the automatic approval process could not automatically determine if the order is safe to process. Once an order is approved, the pipeline will start processing the order.
 
         :param order_id: The id of the order to approve (required)
         :type order_id: str
@@ -2892,7 +2892,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """Approves an order that has been submitted for manual approval.
 
-        An order is submitted for manual approval when the automatic approval process could not automatically  determine if the order is safe to process.  Once an order is approved, the pipeline will start processing the order.
+        An order is submitted for manual approval when the automatic approval process could not automatically determine if the order is safe to process. Once an order is approved, the pipeline will start processing the order.
 
         :param order_id: The id of the order to approve (required)
         :type order_id: str
@@ -3828,7 +3828,7 @@ class OrderApi:
     ) -> bytearray:
         """Aggregates the results of an order and returns it as a file attachment.
 
-        Returns the aggregated result as a file with a given name.  The annotated type of the response represents the content type of the file.
+        Returns the aggregated result as a file with a given name. The annotated type of the response represents the content type of the file.
 
         :param order_id: The id of the order (required)
         :type order_id: str
@@ -3895,7 +3895,7 @@ class OrderApi:
     ) -> ApiResponse[bytearray]:
         """Aggregates the results of an order and returns it as a file attachment.
 
-        Returns the aggregated result as a file with a given name.  The annotated type of the response represents the content type of the file.
+        Returns the aggregated result as a file with a given name. The annotated type of the response represents the content type of the file.
 
         :param order_id: The id of the order (required)
         :type order_id: str
@@ -3962,7 +3962,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """Aggregates the results of an order and returns it as a file attachment.
 
-        Returns the aggregated result as a file with a given name.  The annotated type of the response represents the content type of the file.
+        Returns the aggregated result as a file with a given name. The annotated type of the response represents the content type of the file.
 
         :param order_id: The id of the order (required)
         :type order_id: str
@@ -6176,7 +6176,7 @@ class OrderApi:
     ) -> None:
         """Submits an order for approval.
 
-        Once an order is created its order id and dataset id is returned.  The dataset id can be used to fill the dataset with data points.  Once submitted, the order will be locked and no further changes can be made.
+        Once an order is created its order id and dataset id is returned. The dataset id can be used to fill the dataset with data points. Once submitted, the order will be locked and no further changes can be made.
 
         :param order_id: The id of the order to submit (required)
         :type order_id: str
@@ -6243,7 +6243,7 @@ class OrderApi:
     ) -> ApiResponse[None]:
         """Submits an order for approval.
 
-        Once an order is created its order id and dataset id is returned.  The dataset id can be used to fill the dataset with data points.  Once submitted, the order will be locked and no further changes can be made.
+        Once an order is created its order id and dataset id is returned. The dataset id can be used to fill the dataset with data points. Once submitted, the order will be locked and no further changes can be made.
 
         :param order_id: The id of the order to submit (required)
         :type order_id: str
@@ -6310,7 +6310,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """Submits an order for approval.
 
-        Once an order is created its order id and dataset id is returned.  The dataset id can be used to fill the dataset with data points.  Once submitted, the order will be locked and no further changes can be made.
+        Once an order is created its order id and dataset id is returned. The dataset id can be used to fill the dataset with data points. Once submitted, the order will be locked and no further changes can be made.
 
         :param order_id: The id of the order to submit (required)
         :type order_id: str
@@ -6431,7 +6431,7 @@ class OrderApi:
     ) -> UnlockOrderResult:
         """Unlocks a newly cloned order.
 
-        When an order is cloned only the necessary information is copied.  In order to make changes to the order, it must be unlocked first.  Unlocking the order will clone the entire dataset and its datapoints.
+        When an order is cloned only the necessary information is copied. In order to make changes to the order, it must be unlocked first. Unlocking the order will clone the entire dataset and its datapoints.
 
         :param order_id: The id of the order to unlock (required)
         :type order_id: str
@@ -6498,7 +6498,7 @@ class OrderApi:
     ) -> ApiResponse[UnlockOrderResult]:
         """Unlocks a newly cloned order.
 
-        When an order is cloned only the necessary information is copied.  In order to make changes to the order, it must be unlocked first.  Unlocking the order will clone the entire dataset and its datapoints.
+        When an order is cloned only the necessary information is copied. In order to make changes to the order, it must be unlocked first. Unlocking the order will clone the entire dataset and its datapoints.
 
         :param order_id: The id of the order to unlock (required)
         :type order_id: str
@@ -6565,7 +6565,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """Unlocks a newly cloned order.
 
-        When an order is cloned only the necessary information is copied.  In order to make changes to the order, it must be unlocked first.  Unlocking the order will clone the entire dataset and its datapoints.
+        When an order is cloned only the necessary information is copied. In order to make changes to the order, it must be unlocked first. Unlocking the order will clone the entire dataset and its datapoints.
 
         :param order_id: The id of the order to unlock (required)
         :type order_id: str
@@ -8531,7 +8531,7 @@ class OrderApi:
     ) -> None:
         """(Deprecated) Submits an order for approval.
 
-        Once an order is created its order id and dataset id is returned.  The dataset id can be used to fill the dataset with data points.  Once submitted, the order will be locked and no further changes can be made.
+        Once an order is created its order id and dataset id is returned. The dataset id can be used to fill the dataset with data points. Once submitted, the order will be locked and no further changes can be made.
 
         :param order_id: The id of the order to submit
         :type order_id: str
@@ -8599,7 +8599,7 @@ class OrderApi:
     ) -> ApiResponse[None]:
         """(Deprecated) Submits an order for approval.
 
-        Once an order is created its order id and dataset id is returned.  The dataset id can be used to fill the dataset with data points.  Once submitted, the order will be locked and no further changes can be made.
+        Once an order is created its order id and dataset id is returned. The dataset id can be used to fill the dataset with data points. Once submitted, the order will be locked and no further changes can be made.
 
         :param order_id: The id of the order to submit
         :type order_id: str
@@ -8667,7 +8667,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """(Deprecated) Submits an order for approval.
 
-        Once an order is created its order id and dataset id is returned.  The dataset id can be used to fill the dataset with data points.  Once submitted, the order will be locked and no further changes can be made.
+        Once an order is created its order id and dataset id is returned. The dataset id can be used to fill the dataset with data points. Once submitted, the order will be locked and no further changes can be made.
 
         :param order_id: The id of the order to submit
         :type order_id: str
@@ -8791,7 +8791,7 @@ class OrderApi:
     ) -> UnlockOrderResult:
         """(Deprecated) Unlocks a newly cloned order.
 
-        When an order is cloned only the necessary information is copied.  In order to make changes to the order, it must be unlocked first.  Unlocking the order will clone the entire dataset and its datapoints.
+        When an order is cloned only the necessary information is copied. In order to make changes to the order, it must be unlocked first. Unlocking the order will clone the entire dataset and its datapoints.
 
         :param order_id: The id of the order to unlock
         :type order_id: str
@@ -8859,7 +8859,7 @@ class OrderApi:
     ) -> ApiResponse[UnlockOrderResult]:
         """(Deprecated) Unlocks a newly cloned order.
 
-        When an order is cloned only the necessary information is copied.  In order to make changes to the order, it must be unlocked first.  Unlocking the order will clone the entire dataset and its datapoints.
+        When an order is cloned only the necessary information is copied. In order to make changes to the order, it must be unlocked first. Unlocking the order will clone the entire dataset and its datapoints.
 
         :param order_id: The id of the order to unlock
         :type order_id: str
@@ -8927,7 +8927,7 @@ class OrderApi:
     ) -> RESTResponseType:
         """(Deprecated) Unlocks a newly cloned order.
 
-        When an order is cloned only the necessary information is copied.  In order to make changes to the order, it must be unlocked first.  Unlocking the order will clone the entire dataset and its datapoints.
+        When an order is cloned only the necessary information is copied. In order to make changes to the order, it must be unlocked first. Unlocking the order will clone the entire dataset and its datapoints.
 
         :param order_id: The id of the order to unlock
         :type order_id: str

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/api/pipeline_api.py

@@ -66,7 +66,7 @@ class PipelineApi:
     ) -> None:
         """(Deprecated) Updates the workflow configuration for a pipeline.
 
-        This method needs to be called before the pipeline is started.  Otherwise, the changes will not take effect unless the pipeline is restarted.
+        This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
 
         :param id: The id of the pipeline to update. (required)
         :type id: str
@@ -142,7 +142,7 @@ class PipelineApi:
     ) -> ApiResponse[None]:
         """(Deprecated) Updates the workflow configuration for a pipeline.
 
-        This method needs to be called before the pipeline is started.  Otherwise, the changes will not take effect unless the pipeline is restarted.
+        This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
 
         :param id: The id of the pipeline to update. (required)
         :type id: str
@@ -218,7 +218,7 @@ class PipelineApi:
     ) -> RESTResponseType:
         """(Deprecated) Updates the workflow configuration for a pipeline.
 
-        This method needs to be called before the pipeline is started.  Otherwise, the changes will not take effect unless the pipeline is restarted.
+        This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
 
         :param id: The id of the pipeline to update. (required)
         :type id: str
@@ -369,7 +369,7 @@ class PipelineApi:
     ) -> None:
         """Updates the workflow configuration for a pipeline.
 
-        This method needs to be called before the pipeline is started.  Otherwise, the changes will not take effect unless the pipeline is restarted.
+        This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
 
         :param id: The id of the pipeline to update. (required)
         :type id: str
@@ -444,7 +444,7 @@ class PipelineApi:
     ) -> ApiResponse[None]:
         """Updates the workflow configuration for a pipeline.
 
-        This method needs to be called before the pipeline is started.  Otherwise, the changes will not take effect unless the pipeline is restarted.
+        This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
 
         :param id: The id of the pipeline to update. (required)
         :type id: str
@@ -519,7 +519,7 @@ class PipelineApi:
     ) -> RESTResponseType:
         """Updates the workflow configuration for a pipeline.
 
-        This method needs to be called before the pipeline is started.  Otherwise, the changes will not take effect unless the pipeline is restarted.
+        This method needs to be called before the pipeline is started. Otherwise, the changes will not take effect unless the pipeline is restarted.
 
         :param id: The id of the pipeline to update. (required)
         :type id: str

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/api/workflow_api.py

@@ -1116,7 +1116,7 @@ class WorkflowApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> GetCompareAbSummaryResult:
-        """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.
+        """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.
 
 
         :param workflow_id: The ID of the workflow to get the summary for. (required)
@@ -1186,7 +1186,7 @@ class WorkflowApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[GetCompareAbSummaryResult]:
-        """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.
+        """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.
 
 
         :param workflow_id: The ID of the workflow to get the summary for. (required)
@@ -1256,7 +1256,7 @@ class WorkflowApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """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.
+        """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.
 
 
         :param workflow_id: The ID of the workflow to get the summary for. (required)
@@ -1917,7 +1917,7 @@ class WorkflowApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> GetResponsesResult:
-        """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.
+        """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.
 
 
         :param workflow_id: The ID of the workflow to get the responses for. (required)
@@ -1991,7 +1991,7 @@ class WorkflowApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> ApiResponse[GetResponsesResult]:
-        """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.
+        """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.
 
 
         :param workflow_id: The ID of the workflow to get the responses for. (required)
@@ -2065,7 +2065,7 @@ class WorkflowApi:
         _headers: Optional[Dict[StrictStr, Any]] = None,
         _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
     ) -> RESTResponseType:
-        """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.
+        """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.
 
 
         :param workflow_id: The ID of the workflow to get the responses for. (required)

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/models/add_campaign_model.py

@@ -38,7 +38,7 @@ 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")
-    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")
+    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')

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/models/compare_workflow_config_model.py

@@ -28,7 +28,7 @@ from typing_extensions import Self
 
 class CompareWorkflowConfigModel(BaseModel):
     """
-    The configuration for creating a compare workflow.  A compare workflow is a workflow that continuously matches datapoints against each other and updates their  respective ELO scores. The ELO scores are used to determine the relative strength of the datapoints,  and datapoints are matched against other datapoints with similar ELO scores.  The end goal is a ranking of the datapoints based on their relative strength.
+    The configuration for creating a compare workflow. A compare workflow is a workflow that continuously matches datapoints against each other and updates their respective ELO scores. The ELO scores are used to determine the relative strength of the datapoints, and datapoints are matched against other datapoints with similar ELO scores. The end goal is a ranking of the datapoints based on their relative strength.
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for CompareWorkflowConfig", alias="_t")
     criteria: StrictStr = Field(description="The criteria to add to each compare rapid.")

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/models/compare_workflow_model.py

@@ -27,7 +27,7 @@ from typing_extensions import Self
 
 class CompareWorkflowModel(BaseModel):
     """
-    If the SimpleWorkflow is chosen, each datapoint uploaded will correspond to a single task to be solved.  This is the most commonly chosen workflow.
+    If the SimpleWorkflow is chosen, each datapoint uploaded will correspond to a single task to be solved. This is the most commonly chosen workflow.
     """ # noqa: E501
     t: StrictStr = Field(description="Discriminator value for CompareWorkflow", alias="_t")
     criteria: StrictStr = Field(description="The criteria that the datapoints should be compared based on. No default value.")

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/models/create_datapoint_from_files_model.py

@@ -25,7 +25,7 @@ from typing_extensions import Self
 
 class CreateDatapointFromFilesModel(BaseModel):
     """
-    The form request for creating a datapoint from files.  Needs to be encoded as a json string in the form request.
+    The form request for creating a datapoint from files. Needs to be encoded as a json string in the form request.
     """ # noqa: E501
     metadata: List[CreateDatapointFromFilesModelMetadataInner] = Field(description="The metadata of the datapoint.")
     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")

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/models/create_datapoint_from_text_sources_model.py

@@ -29,7 +29,7 @@ class CreateDatapointFromTextSourcesModel(BaseModel):
     """ # noqa: E501
     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")
-    metadata: Optional[List[CreateDatapointFromFilesModelMetadataInner]] = 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.")
+    metadata: Optional[List[CreateDatapointFromFilesModelMetadataInner]] = 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]] = ["textSources", "sortIndex", "metadata"]
 
     model_config = ConfigDict(

{rapidata-2.16.0 → rapidata-2.17.0}/src/rapidata/api_client/models/create_datapoint_from_urls_model.py

@@ -27,8 +27,8 @@ class CreateDatapointFromUrlsModel(BaseModel):
     """
     The body request for creating a datapoint from urls.
     """ # noqa: E501
-    urls: List[StrictStr] = Field(description="The urls to fetch the assets from.  The urls must be publicly accessible.  A HEAD request will be made to each url to check if it is accessible.")
-    metadata: Optional[List[CreateDatapointFromFilesModelMetadataInner]] = 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.")
+    urls: List[StrictStr] = Field(description="The urls to fetch the assets from. The urls must be publicly accessible. A HEAD request will be made to each url to check if it is accessible.")
+    metadata: Optional[List[CreateDatapointFromFilesModelMetadataInner]] = 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.")
     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]] = ["urls", "metadata", "sortIndex"]