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

label_studio_sdk/import_storage/azure/client.py

@@ -66,15 +66,17 @@ class AzureClient:
     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,
         container: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         account_name: typing.Optional[str] = OMIT,
         account_key: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureCreateResponse:
         """
@@ -88,6 +90,24 @@ class AzureClient:
 
         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 AzureClient:
         prefix : typing.Optional[str]
             Azure blob prefix name
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         account_name : typing.Optional[str]
             Azure Blob account name
 
         account_key : typing.Optional[str]
             Azure Blob account key
 
-        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 AzureClient:
             "api/storages/azure/",
             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,
                 "container": container,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "account_name": account_name,
                 "account_key": account_key,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,
@@ -157,19 +167,70 @@ class AzureClient:
             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) -> AzureBlobImportStorage:
+    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,
+        container: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        account_name: typing.Optional[str] = OMIT,
+        account_key: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific Azure 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
+
+        container : typing.Optional[str]
+            Azure blob container
+
+        prefix : typing.Optional[str]
+            Azure blob prefix name
+
+        account_name : typing.Optional[str]
+            Azure Blob account name
+
+        account_key : typing.Optional[str]
+            Azure Blob account key
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AzureBlobImportStorage
-
+        None
 
         Examples
         --------
@@ -181,10 +242,27 @@ class AzureClient:
         client.import_storage.azure.validate()
         """
         _response = self._client_wrapper.httpx_client.request(
-            "api/storages/azure/validate", method="POST", request_options=request_options
+            "api/storages/azure/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,
+                "container": container,
+                "prefix": prefix,
+                "account_name": account_name,
+                "account_key": account_key,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(AzureBlobImportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -278,15 +356,17 @@ class AzureClient:
         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,
         container: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         account_name: typing.Optional[str] = OMIT,
         account_key: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureUpdateResponse:
         """
@@ -299,6 +379,24 @@ class AzureClient:
         id : int
             A unique integer value identifying this azure blob 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 AzureClient:
         prefix : typing.Optional[str]
             Azure blob prefix name
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         account_name : typing.Optional[str]
             Azure Blob account name
 
         account_key : typing.Optional[str]
             Azure Blob account key
 
-        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 AzureClient:
             f"api/storages/azure/{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,
                 "container": container,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "account_name": account_name,
                 "account_key": account_key,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,
@@ -464,15 +552,17 @@ class AsyncAzureClient:
     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,
         container: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         account_name: typing.Optional[str] = OMIT,
         account_key: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureCreateResponse:
         """
@@ -486,6 +576,24 @@ class AsyncAzureClient:
 
         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 AsyncAzureClient:
         prefix : typing.Optional[str]
             Azure blob prefix name
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         account_name : typing.Optional[str]
             Azure Blob account name
 
         account_key : typing.Optional[str]
             Azure Blob account key
 
-        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 AsyncAzureClient:
             "api/storages/azure/",
             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,
                 "container": container,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "account_name": account_name,
                 "account_key": account_key,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,
@@ -555,19 +653,70 @@ class AsyncAzureClient:
             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) -> AzureBlobImportStorage:
+    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,
+        container: typing.Optional[str] = OMIT,
+        prefix: typing.Optional[str] = OMIT,
+        account_name: typing.Optional[str] = OMIT,
+        account_key: typing.Optional[str] = OMIT,
+        request_options: typing.Optional[RequestOptions] = None,
+    ) -> None:
         """
         Validate a specific Azure 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
+
+        container : typing.Optional[str]
+            Azure blob container
+
+        prefix : typing.Optional[str]
+            Azure blob prefix name
+
+        account_name : typing.Optional[str]
+            Azure Blob account name
+
+        account_key : typing.Optional[str]
+            Azure Blob account key
+
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
 
         Returns
         -------
-        AzureBlobImportStorage
-
+        None
 
         Examples
         --------
@@ -579,10 +728,27 @@ class AsyncAzureClient:
         await client.import_storage.azure.validate()
         """
         _response = await self._client_wrapper.httpx_client.request(
-            "api/storages/azure/validate", method="POST", request_options=request_options
+            "api/storages/azure/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,
+                "container": container,
+                "prefix": prefix,
+                "account_name": account_name,
+                "account_key": account_key,
+            },
+            request_options=request_options,
+            omit=OMIT,
         )
         if 200 <= _response.status_code < 300:
-            return pydantic_v1.parse_obj_as(AzureBlobImportStorage, _response.json())  # type: ignore
+            return
         try:
             _response_json = _response.json()
         except JSONDecodeError:
@@ -676,15 +842,17 @@ class AsyncAzureClient:
         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,
         container: typing.Optional[str] = OMIT,
         prefix: typing.Optional[str] = OMIT,
-        regex_filter: typing.Optional[str] = OMIT,
-        use_blob_urls: typing.Optional[bool] = OMIT,
         account_name: typing.Optional[str] = OMIT,
         account_key: typing.Optional[str] = OMIT,
-        presign: typing.Optional[bool] = OMIT,
-        presign_ttl: typing.Optional[int] = OMIT,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AzureUpdateResponse:
         """
@@ -697,6 +865,24 @@ class AsyncAzureClient:
         id : int
             A unique integer value identifying this azure blob 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 AsyncAzureClient:
         prefix : typing.Optional[str]
             Azure blob prefix name
 
-        regex_filter : typing.Optional[str]
-            Cloud storage regex for filtering objects
-
-        use_blob_urls : typing.Optional[bool]
-            Interpret objects as BLOBs and generate URLs
-
         account_name : typing.Optional[str]
             Azure Blob account name
 
         account_key : typing.Optional[str]
             Azure Blob account key
 
-        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 AsyncAzureClient:
             f"api/storages/azure/{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,
                 "container": container,
                 "prefix": prefix,
-                "regex_filter": regex_filter,
-                "use_blob_urls": use_blob_urls,
                 "account_name": account_name,
                 "account_key": account_key,
-                "presign": presign,
-                "presign_ttl": presign_ttl,
             },
             request_options=request_options,
             omit=OMIT,

label_studio_sdk/import_storage/azure/types/azure_create_response.py

@@ -8,49 +8,59 @@ from ....core.pydantic_utilities import deep_union_pydantic_dicts, pydantic_v1
 
 
 class AzureCreateResponse(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: