SK-2042 Add deidentify and reidentify text interfaces for Detect service

.github/workflows/shared-tests.yml

@@ -27,7 +27,7 @@ jobs:
       - name: 'Run Tests'
         run: |
           pip install -r requirements.txt
-          python -m coverage run --source=skyflow --omit=skyflow/generated/*,skyflow/utils/validations/*,skyflow/vault/data/*,skyflow/vault/tokens/*,skyflow/vault/connection/*,skyflow/error/*,skyflow/utils/enums/*,skyflow/vault/controller/_audit.py,skyflow/vault/controller/_bin_look_up.py -m unittest discover
+          python -m coverage run --source=skyflow --omit=skyflow/generated/*,skyflow/utils/validations/*,skyflow/vault/data/*,skyflow/vault/detect/*,skyflow/vault/tokens/*,skyflow/vault/connection/*,skyflow/error/*,skyflow/utils/enums/*,skyflow/vault/controller/_audit.py,skyflow/vault/controller/_bin_look_up.py -m unittest discover
 
       - name: coverage
         run: coverage xml -o test-coverage.xml

skyflow/client/skyflow.py

@@ -8,6 +8,7 @@
 from skyflow.vault.client.client import VaultClient
 from skyflow.vault.controller import Vault
 from skyflow.vault.controller import Connection
+from skyflow.vault.controller import Detect
 
 class Skyflow:
     def __init__(self, builder):
@@ -65,11 +66,15 @@
 
     def vault(self, vault_id = None) -> Vault:
         vault_config = self.__builder.get_vault_config(vault_id)
-        return vault_config.get("controller")
+        return vault_config.get("vault_controller")
 
     def connection(self, connection_id = None) -> Connection:
         connection_config = self.__builder.get_connection_config(connection_id)
         return connection_config.get("controller")
+
+    def detect(self, vault_id = None) -> Detect:
+        vault_config = self.__builder.get_vault_config(vault_id)
+        return vault_config.get("detect_controller")
 
     class Builder:
         def __init__(self):
@@ -182,9 +187,11 @@
             vault_client = VaultClient(config)
             self.__vault_configs[vault_id] = {
                 "vault_client": vault_client,
-                "controller": Vault(vault_client)
+                "vault_controller": Vault(vault_client),
+                "detect_controller": Detect(vault_client)
             }
             log_info(SkyflowMessages.Info.VAULT_CONTROLLER_INITIALIZED.value.format(config.get("vault_id")), self.__logger)
+            log_info(SkyflowMessages.Info.DETECT_CONTROLLER_INITIALIZED.value.format(config.get("vault_id")), self.__logger)
 
         def __add_connection_config(self, config):
             validate_connection_config(self.__logger, config)

skyflow/generated/rest/__init__.py

@@ -3,18 +3,57 @@
 # isort: skip_file
 
 from .types import (
+    AdvancedOptionsColumnMapping,
+    AdvancedOptionsEntityColumnMap,
+    AdvancedOptionsVaultSchema,
+    AllowRegex,
+    AudioConfigTranscriptionType,
     AuditEventAuditResourceType,
     AuditEventContext,
     AuditEventData,
     AuditEventHttpInfo,
     BatchRecordMethod,
     ContextAccessType,
     ContextAuthMode,
+    DeidentifyFileOutput,
+    DeidentifyFileOutputProcessedFileType,
+    DeidentifyFileResponse,
+    DeidentifyStatusResponse,
+    DeidentifyStatusResponseOutputType,
+    DeidentifyStatusResponseStatus,
+    DeidentifyStatusResponseWordCharacterCount,
+    DeidentifyStringResponse,
+    DetectDataAccuracy,
+    DetectDataEntities,
+    DetectFileRequestDataType,
+    DetectRequestDeidentifyOption,
+    DetectedEntity,
     DetokenizeRecordResponseValueType,
+    EntityLocation,
+    EntityType,
+    EntityTypes,
+    ErrorResponse,
+    ErrorResponseError,
+    ErrorString,
     GooglerpcStatus,
+    ProcessedFileOutputProcessedFileType,
     ProtobufAny,
     RedactionEnumRedaction,
+    ReidentifyStringResponse,
     RequestActionType,
+    ResourceId,
+    RestrictRegex,
+    TokenType,
+    TokenTypeDefault,
+    TokenTypeWithoutVault,
+    TokenTypeWithoutVaultDefault,
+    Transformations,
+    TransformationsShiftDates,
+    TransformationsShiftDatesEntityTypesItem,
+    Uuid,
+    V1AdvancedOptions,
+    V1AudioConfig,
+    V1AudioOptions,
     V1AuditAfterOptions,
     V1AuditEventResponse,
     V1AuditResponse,
@@ -29,26 +68,39 @@
     V1Card,
     V1DeleteFileResponse,
     V1DeleteRecordResponse,
+    V1DetectFileResponse,
+    V1DetectStatusResponse,
+    V1DetectStatusResponseStatus,
+    V1DetectTextRequest,
+    V1DetectTextResponse,
     V1DetokenizeRecordRequest,
     V1DetokenizeRecordResponse,
     V1DetokenizeResponse,
     V1FieldRecords,
     V1FileAvScanStatus,
+    V1FileDataFormat,
     V1GetAuthTokenResponse,
     V1GetFileScanStatusResponse,
     V1GetQueryResponse,
+    V1ImageOptions,
     V1InsertRecordResponse,
+    V1Locations,
     V1MemberType,
+    V1PdfConfig,
+    V1PdfOptions,
+    V1ProcessedFileOutput,
     V1RecordMetaProperties,
+    V1ResponseEntities,
     V1TokenizeRecordRequest,
     V1TokenizeRecordResponse,
     V1TokenizeResponse,
     V1UpdateRecordResponse,
     V1VaultFieldMapping,
     V1VaultSchemaConfig,
+    VaultId,
 )
-from .errors import BadRequestError, NotFoundError, UnauthorizedError
-from . import audit, authentication, bin_lookup, query, records, tokens
+from .errors import BadRequestError, InternalServerError, NotFoundError, UnauthorizedError
+from . import audit, authentication, bin_lookup, deprecated, files, query, records, strings, tokens
 from .audit import (
     AuditServiceListAuditEventsRequestFilterOpsActionType,
     AuditServiceListAuditEventsRequestFilterOpsContextAccessType,
@@ -59,15 +111,41 @@
 )
 from .client import AsyncSkyflow, Skyflow
 from .environment import SkyflowEnvironment
+from .files import (
+    DeidentifyAudioRequestFile,
+    DeidentifyAudioRequestFileDataFormat,
+    DeidentifyAudioRequestOutputTranscription,
+    DeidentifyDocumentRequestFile,
+    DeidentifyDocumentRequestFileDataFormat,
+    DeidentifyFileRequestFile,
+    DeidentifyFileRequestFileDataFormat,
+    DeidentifyImageRequestFile,
+    DeidentifyImageRequestFileDataFormat,
+    DeidentifyImageRequestMaskingMethod,
+    DeidentifyPdfRequestFile,
+    DeidentifyPresentationRequestFile,
+    DeidentifyPresentationRequestFileDataFormat,
+    DeidentifySpreadsheetRequestFile,
+    DeidentifySpreadsheetRequestFileDataFormat,
+    DeidentifyStructuredTextRequestFile,
+    DeidentifyStructuredTextRequestFileDataFormat,
+    DeidentifyTextRequestFile,
+)
 from .records import (
     RecordServiceBulkGetRecordRequestOrderBy,
     RecordServiceBulkGetRecordRequestRedaction,
     RecordServiceGetRecordRequestRedaction,
 )
+from .strings import ReidentifyStringRequestFormat
 from .version import __version__
 
 __all__ = [
+    "AdvancedOptionsColumnMapping",
+    "AdvancedOptionsEntityColumnMap",
+    "AdvancedOptionsVaultSchema",
+    "AllowRegex",
     "AsyncSkyflow",
+    "AudioConfigTranscriptionType",
     "AuditEventAuditResourceType",
     "AuditEventContext",
     "AuditEventData",
@@ -82,18 +160,72 @@
     "BatchRecordMethod",
     "ContextAccessType",
     "ContextAuthMode",
+    "DeidentifyAudioRequestFile",
+    "DeidentifyAudioRequestFileDataFormat",
+    "DeidentifyAudioRequestOutputTranscription",
+    "DeidentifyDocumentRequestFile",
+    "DeidentifyDocumentRequestFileDataFormat",
+    "DeidentifyFileOutput",
+    "DeidentifyFileOutputProcessedFileType",
+    "DeidentifyFileRequestFile",
+    "DeidentifyFileRequestFileDataFormat",
+    "DeidentifyFileResponse",
+    "DeidentifyImageRequestFile",
+    "DeidentifyImageRequestFileDataFormat",
+    "DeidentifyImageRequestMaskingMethod",
+    "DeidentifyPdfRequestFile",
+    "DeidentifyPresentationRequestFile",
+    "DeidentifyPresentationRequestFileDataFormat",
+    "DeidentifySpreadsheetRequestFile",
+    "DeidentifySpreadsheetRequestFileDataFormat",
+    "DeidentifyStatusResponse",
+    "DeidentifyStatusResponseOutputType",
+    "DeidentifyStatusResponseStatus",
+    "DeidentifyStatusResponseWordCharacterCount",
+    "DeidentifyStringResponse",
+    "DeidentifyStructuredTextRequestFile",
+    "DeidentifyStructuredTextRequestFileDataFormat",
+    "DeidentifyTextRequestFile",
+    "DetectDataAccuracy",
+    "DetectDataEntities",
+    "DetectFileRequestDataType",
+    "DetectRequestDeidentifyOption",
+    "DetectedEntity",
     "DetokenizeRecordResponseValueType",
+    "EntityLocation",
+    "EntityType",
+    "EntityTypes",
+    "ErrorResponse",
+    "ErrorResponseError",
+    "ErrorString",
     "GooglerpcStatus",
+    "InternalServerError",
     "NotFoundError",
+    "ProcessedFileOutputProcessedFileType",
     "ProtobufAny",
     "RecordServiceBulkGetRecordRequestOrderBy",
     "RecordServiceBulkGetRecordRequestRedaction",
     "RecordServiceGetRecordRequestRedaction",
     "RedactionEnumRedaction",
+    "ReidentifyStringRequestFormat",
+    "ReidentifyStringResponse",
     "RequestActionType",
+    "ResourceId",
+    "RestrictRegex",
     "Skyflow",
     "SkyflowEnvironment",
+    "TokenType",
+    "TokenTypeDefault",
+    "TokenTypeWithoutVault",
+    "TokenTypeWithoutVaultDefault",
+    "Transformations",
+    "TransformationsShiftDates",
+    "TransformationsShiftDatesEntityTypesItem",
     "UnauthorizedError",
+    "Uuid",
+    "V1AdvancedOptions",
+    "V1AudioConfig",
+    "V1AudioOptions",
     "V1AuditAfterOptions",
     "V1AuditEventResponse",
     "V1AuditResponse",
@@ -108,28 +240,44 @@
     "V1Card",
     "V1DeleteFileResponse",
     "V1DeleteRecordResponse",
+    "V1DetectFileResponse",
+    "V1DetectStatusResponse",
+    "V1DetectStatusResponseStatus",
+    "V1DetectTextRequest",
+    "V1DetectTextResponse",
     "V1DetokenizeRecordRequest",
     "V1DetokenizeRecordResponse",
     "V1DetokenizeResponse",
     "V1FieldRecords",
     "V1FileAvScanStatus",
+    "V1FileDataFormat",
     "V1GetAuthTokenResponse",
     "V1GetFileScanStatusResponse",
     "V1GetQueryResponse",
+    "V1ImageOptions",
     "V1InsertRecordResponse",
+    "V1Locations",
     "V1MemberType",
+    "V1PdfConfig",
+    "V1PdfOptions",
+    "V1ProcessedFileOutput",
     "V1RecordMetaProperties",
+    "V1ResponseEntities",
     "V1TokenizeRecordRequest",
     "V1TokenizeRecordResponse",
     "V1TokenizeResponse",
     "V1UpdateRecordResponse",
     "V1VaultFieldMapping",
     "V1VaultSchemaConfig",
+    "VaultId",
     "__version__",
     "audit",
     "authentication",
     "bin_lookup",
+    "deprecated",
+    "files",
     "query",
     "records",
+    "strings",
     "tokens",
 ]

skyflow/generated/rest/audit/client.py

@@ -200,8 +200,13 @@ def audit_service_list_audit_events(
         Examples
         --------
         from skyflow import Skyflow
-        client = Skyflow(token="YOUR_TOKEN", )
-        client.audit.audit_service_list_audit_events(filter_ops_account_id='filterOps.accountID', )
+
+        client = Skyflow(
+            token="YOUR_TOKEN",
+        )
+        client.audit.audit_service_list_audit_events(
+            filter_ops_account_id="filterOps.accountID",
+        )
         """
         _response = self._raw_client.audit_service_list_audit_events(
             filter_ops_account_id=filter_ops_account_id,
@@ -415,11 +420,21 @@ async def audit_service_list_audit_events(
 
         Examples
         --------
-        from skyflow import AsyncSkyflow
         import asyncio
-        client = AsyncSkyflow(token="YOUR_TOKEN", )
+
+        from skyflow import AsyncSkyflow
+
+        client = AsyncSkyflow(
+            token="YOUR_TOKEN",
+        )
+
+
         async def main() -> None:
-            await client.audit.audit_service_list_audit_events(filter_ops_account_id='filterOps.accountID', )
+            await client.audit.audit_service_list_audit_events(
+                filter_ops_account_id="filterOps.accountID",
+            )
+
+
         asyncio.run(main())
         """
         _response = await self._raw_client.audit_service_list_audit_events(

skyflow/generated/rest/audit/raw_client.py

@@ -244,9 +244,9 @@ def audit_service_list_audit_events(
                 raise NotFoundError(
                     headers=dict(_response.headers),
                     body=typing.cast(
-                        typing.Dict[str, typing.Optional[typing.Any]],
+                        typing.Optional[typing.Any],
                         parse_obj_as(
-                            type_=typing.Dict[str, typing.Optional[typing.Any]],  # type: ignore
+                            type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
                     ),
@@ -471,9 +471,9 @@ async def audit_service_list_audit_events(
                 raise NotFoundError(
                     headers=dict(_response.headers),
                     body=typing.cast(
-                        typing.Dict[str, typing.Optional[typing.Any]],
+                        typing.Optional[typing.Any],
                         parse_obj_as(
-                            type_=typing.Dict[str, typing.Optional[typing.Any]],  # type: ignore
+                            type_=typing.Optional[typing.Any],  # type: ignore
                             object_=_response.json(),
                         ),
                     ),