label-studio-sdk 1.0.0__py3-none-any.whl → 1.0.2__py3-none-any.whl

label_studio_sdk/import_storage/azure/types/azure_update_response.py

@@ -8,49 +8,59 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class AzureUpdateResponse(pydantic_v1.BaseModel):
-    project: typing.Optional[int] = pydantic_v1.Field(default=None)
+    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Project ID
+    Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
     """
 
-    container: typing.Optional[str] = pydantic_v1.Field(default=None)
+    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    Azure blob container
+    Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
     """
 
-    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
+    presign: typing.Optional[bool] = pydantic_v1.Field(default=None)
     """
-    Azure blob prefix name
+    Presign URLs for direct download
     """
 
-    regex_filter: typing.Optional[str] = pydantic_v1.Field(default=None)
+    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
-    Cloud storage regex for filtering objects
+    Presign TTL in minutes
     """
 
-    use_blob_urls: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    title: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Interpret objects as BLOBs and generate URLs
+    Storage title
     """
 
-    account_name: typing.Optional[str] = pydantic_v1.Field(default=None)
+    description: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Azure Blob account name
+    Storage description
     """
 
-    account_key: typing.Optional[str] = pydantic_v1.Field(default=None)
+    project: typing.Optional[int] = pydantic_v1.Field(default=None)
     """
-    Azure Blob account key
+    Project ID
     """
 
-    presign: typing.Optional[bool] = pydantic_v1.Field(default=None)
+    container: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Presign URLs for direct download
+    Azure blob container
     """
 
-    presign_ttl: typing.Optional[int] = pydantic_v1.Field(default=None)
+    prefix: typing.Optional[str] = pydantic_v1.Field(default=None)
     """
-    Presign TTL in minutes
+    Azure blob prefix name
+    """
+
+    account_name: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure Blob account name
+    """
+
+    account_key: typing.Optional[str] = pydantic_v1.Field(default=None)
+    """
+    Azure Blob account key
     """
 
     def json(self, **kwargs: typing.Any) -> str:

label_studio_sdk/import_storage/gcs/client.py

@@ -66,15 +66,17 @@ class GcsClient:
     def create(
         self,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        presign: typing.Optional[bool] = OMIT,
+        presign_ttl: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsCreateResponse:
         """
@@ -88,6 +90,24 @@ class GcsClient:
 
         Parameters
         ----------
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        presign : typing.Optional[bool]
+            Presign URLs for direct download
+
+        presign_ttl : typing.Optional[int]
+            Presign TTL in minutes
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -97,24 +117,12 @@ class GcsClient:
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
 
-        presign : typing.Optional[bool]
-            Presign URLs for direct download
-
-        presign_ttl : typing.Optional[int]
-            Presign TTL in minutes
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -136,15 +144,17 @@ class GcsClient:
             "api/storages/gcs/",
             method="POST",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "presign": presign,
+                "presign_ttl": presign_ttl,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,
@@ -157,19 +167,70 @@ class GcsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    def validate(self, *, request_options: typing.Optional[RequestOptions] = None) -> GcsImportStorage:
+    def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        presign: typing.Optional[bool] = OMIT,
+        presign_ttl: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        bucket: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        google_application_credentials: typing.Optional[str] = OMIT,
+        google_project_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific GCS import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        presign : typing.Optional[bool]
+            Presign URLs for direct download
+
+        presign_ttl : typing.Optional[int]
+            Presign TTL in minutes
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        bucket : typing.Optional[str]
+            GCS bucket name
+
+        prefix : typing.Optional[str]
+            GCS bucket prefix
+
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+
+        google_project_id : typing.Optional[str]
+            Google project ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        GcsImportStorage
-
+        None
 
         Examples
         --------
@@ -181,10 +242,27 @@ class GcsClient:
         client.import_storage.gcs.validate()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/gcs/validate", method="POST", request_options=request_options
+            "api/storages/gcs/validate",
+            method="POST",
+            json={
+                "id": id,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "presign": presign,
+                "presign_ttl": presign_ttl,
+                "title": title,
+                "description": description,
+                "project": project,
+                "bucket": bucket,
+                "prefix": prefix,
+                "google_application_credentials": google_application_credentials,
+                "google_project_id": google_project_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(GcsImportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -278,15 +356,17 @@ class GcsClient:
         self,
         id: int,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        presign: typing.Optional[bool] = OMIT,
+        presign_ttl: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsUpdateResponse:
         """
@@ -299,6 +379,24 @@ class GcsClient:
         id : int
             A unique integer value identifying this gcs import storage.
 
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        presign : typing.Optional[bool]
+            Presign URLs for direct download
+
+        presign_ttl : typing.Optional[int]
+            Presign TTL in minutes
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -308,24 +406,12 @@ class GcsClient:
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
 
-        presign : typing.Optional[bool]
-            Presign URLs for direct download
-
-        presign_ttl : typing.Optional[int]
-            Presign TTL in minutes
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -349,15 +435,17 @@ class GcsClient:
             f"api/storages/gcs/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "presign": presign,
+                "presign_ttl": presign_ttl,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,
@@ -464,15 +552,17 @@ class AsyncGcsClient:
     async def create(
         self,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        presign: typing.Optional[bool] = OMIT,
+        presign_ttl: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsCreateResponse:
         """
@@ -486,6 +576,24 @@ class AsyncGcsClient:
 
         Parameters
         ----------
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        presign : typing.Optional[bool]
+            Presign URLs for direct download
+
+        presign_ttl : typing.Optional[int]
+            Presign TTL in minutes
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -495,24 +603,12 @@ class AsyncGcsClient:
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
 
-        presign : typing.Optional[bool]
-            Presign URLs for direct download
-
-        presign_ttl : typing.Optional[int]
-            Presign TTL in minutes
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -534,15 +630,17 @@ class AsyncGcsClient:
             "api/storages/gcs/",
             method="POST",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "presign": presign,
+                "presign_ttl": presign_ttl,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,
@@ -555,19 +653,70 @@ class AsyncGcsClient:
             raise ApiError(status_code=_response.status_code, body=_response.text)
         raise ApiError(status_code=_response.status_code, body=_response_json)
 
-    async def validate(self, *, request_options: typing.Optional[RequestOptions] = None) -> GcsImportStorage:
+    async def validate(
+        self,
+        *,
+        id: typing.Optional[int] = OMIT,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        presign: typing.Optional[bool] = OMIT,
+        presign_ttl: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
+        project: typing.Optional[int] = OMIT,
+        bucket: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        google_application_credentials: typing.Optional[str] = OMIT,
+        google_project_id: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific GCS import storage connection. This is useful to ensure that the storage configuration settings are correct and operational before attempting to import data.
 
         Parameters
         ----------
+        id : typing.Optional[int]
+            Storage ID. If set, storage with specified ID will be updated
+
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        presign : typing.Optional[bool]
+            Presign URLs for direct download
+
+        presign_ttl : typing.Optional[int]
+            Presign TTL in minutes
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
+        project : typing.Optional[int]
+            Project ID
+
+        bucket : typing.Optional[str]
+            GCS bucket name
+
+        prefix : typing.Optional[str]
+            GCS bucket prefix
+
+        google_application_credentials : typing.Optional[str]
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
+
+        google_project_id : typing.Optional[str]
+            Google project ID
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        GcsImportStorage
-
+        None
 
         Examples
         --------
@@ -579,10 +728,27 @@ class AsyncGcsClient:
         await client.import_storage.gcs.validate()
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/gcs/validate", method="POST", request_options=request_options
+            "api/storages/gcs/validate",
+            method="POST",
+            json={
+                "id": id,
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "presign": presign,
+                "presign_ttl": presign_ttl,
+                "title": title,
+                "description": description,
+                "project": project,
+                "bucket": bucket,
+                "prefix": prefix,
+                "google_application_credentials": google_application_credentials,
+                "google_project_id": google_project_id,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(GcsImportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -676,15 +842,17 @@ class AsyncGcsClient:
         self,
         id: int,
         *,
+        regex_filter: typing.Optional[str] = OMIT,
+        use_blob_urls: typing.Optional[bool] = OMIT,
+        presign: typing.Optional[bool] = OMIT,
+        presign_ttl: typing.Optional[int] = OMIT,
+        title: typing.Optional[str] = OMIT,
+        description: typing.Optional[str] = OMIT,
         project: typing.Optional[int] = OMIT,
         bucket: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         google_application_credentials: typing.Optional[str] = OMIT,
         google_project_id: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> GcsUpdateResponse:
         """
@@ -697,6 +865,24 @@ class AsyncGcsClient:
         id : int
             A unique integer value identifying this gcs import storage.
 
+        regex_filter : typing.Optional[str]
+            Cloud storage regex for filtering objects. You must specify it otherwise no objects will be imported.
+
+        use_blob_urls : typing.Optional[bool]
+            Interpret objects as BLOBs and generate URLs. For example, if your bucket contains images, you can use this option to generate URLs for these images. If set to False, it will read the content of the file and load it into Label Studio.
+
+        presign : typing.Optional[bool]
+            Presign URLs for direct download
+
+        presign_ttl : typing.Optional[int]
+            Presign TTL in minutes
+
+        title : typing.Optional[str]
+            Storage title
+
+        description : typing.Optional[str]
+            Storage description
+
         project : typing.Optional[int]
             Project ID
 
@@ -706,24 +892,12 @@ class AsyncGcsClient:
         prefix : typing.Optional[str]
             GCS bucket prefix
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         google_application_credentials : typing.Optional[str]
-            The content of GOOGLE_APPLICATION_CREDENTIALS json file
+            The content of GOOGLE_APPLICATION_CREDENTIALS json file. Check official Google Cloud Authentication documentation for more details.
 
         google_project_id : typing.Optional[str]
             Google project ID
 
-        presign : typing.Optional[bool]
-            Presign URLs for direct download
-
-        presign_ttl : typing.Optional[int]
-            Presign TTL in minutes
-
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
@@ -747,15 +921,17 @@ class AsyncGcsClient:
             f"api/storages/gcs/{jsonable_encoder(id)}",
             method="PATCH",
             json={
+                "regex_filter": regex_filter,
+                "use_blob_urls": use_blob_urls,
+                "presign": presign,
+                "presign_ttl": presign_ttl,
+                "title": title,
+                "description": description,
                 "project": project,
                 "bucket": bucket,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "google_application_credentials": google_application_credentials,
                 "google_project_id": google_project_id,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,