Merge pull request #212 from skyflowapi/release/25.9.1

SK-2385: Public release for v2 Python SDK

Author: skyflow-vivek

.github/workflows/shared-build-and-deploy.yml

@@ -27,6 +27,11 @@ jobs:
           python -m pip install --upgrade pip
           pip install setuptools wheel twine
 
+      - name: Build and install skyflow package
+        run: |
+          python setup.py sdist bdist_wheel
+          pip install dist/skyflow-*.whl
+
       - name: Resolve Branch for the Tagged Commit
         id: resolve-branch
         if: ${{ inputs.tag == 'beta' || inputs.tag == 'public' }} 

.github/workflows/shared-tests.yml

@@ -23,6 +23,12 @@ jobs:
         with:
           name: "credentials.json"
           json: ${{ secrets.VALID_SKYFLOW_CREDS_TEST }}
+
+      - name: Build and install skyflow package
+        run: |
+          pip install --upgrade pip setuptools wheel
+          python setup.py sdist bdist_wheel
+          pip install dist/skyflow-*.whl
       
       - name: 'Run Tests'
         run: |

README.md

@@ -215,7 +215,7 @@ table_name = '<SENSITIVE_DATA_TABLE>' # Replace with your actual table name
 
 # Create Insert Request
 insert_request = InsertRequest(
-   table_name=table_name,
+   table=table_name,
    values=insert_data,
    return_tokens=True, # Optional: Get tokens for inserted data
    continue_on_error=True # Optional: Continue on partial errors
@@ -273,7 +273,7 @@ options = InsertOptions(
 
 ```python
 insert_request = InsertRequest(
-   table_name=table_name,        # Replace with the table name
+   table=table_name,        # Replace with the table name
    values=insert_data,
    return_tokens=False,          # Do not return tokens
    continue_on_error=False,      # Stop inserting if any record fails
@@ -474,7 +474,7 @@ try:
 
     # Step 2: Create Insert Request
     insert_request = InsertRequest(
-        table_name='table1',  # Specify the table in the vault where the data will be inserted
+        table='table1',  # Specify the table in the vault where the data will be inserted
         values=insert_data,   # Attach the data (records) to be inserted
         return_tokens=True,   # Specify if tokens should be returned upon successful insertion
         continue_on_error=True  # Optional: Continue on partial errors
@@ -551,7 +551,7 @@ try:
 
     # Step 2: Build an InsertRequest object with the table name and the data to insert
     insert_request = InsertRequest(
-        table_name='<TABLE_NAME>',  # Replace with the actual table name in your Skyflow vault
+        table='<TABLE_NAME>',  # Replace with the actual table name in your Skyflow vault
         values=insert_data,         # Attach the data to be inserted
     )
 
@@ -608,7 +608,7 @@ try:
 
     # Step 4: Build the InsertRequest object with the data records to insert
     insert_request = InsertRequest(
-        table_name='table1',  # Specify the table in the vault where the data will be inserted
+        table='table1',  # Specify the table in the vault where the data will be inserted
         values=insert_data,   # Attach the data (records) to be inserted
         return_tokens=True,   # Specify if tokens should be returned upon successful insertion
         continue_on_error=True  # Specify to continue inserting records even if an error occurs for some records
@@ -686,7 +686,7 @@ try:
 
     # Step 3: Build the InsertRequest object with the upsertData
     insert_request = InsertRequest(
-        table_name='table1',      # Specify the table in the vault where the data will be inserted
+        table='table1',      # Specify the table in the vault where the data will be inserted
         values=insert_data,       # Attach the data (records) to be inserted
         return_tokens=True,       # Specify if tokens should be returned upon successful insertion
         upsert='cardholder_name'  # Specify the field to be used for upsert operations (e.g., cardholder_name)
@@ -1897,23 +1897,24 @@ ReidentifyTextResponse(
 ```
 
 ### Deidentify File
-To deidentify files, use the `deidentify_file` method. The `DeidentifyFileRequest` class creates a deidentify file request, which includes the file to be deidentified and various configuration options.
+To deidentify files, use the `deidentify_file` method. The `DeidentifyFileRequest` class creates a deidentify file request, supports providing either a file or a file path in class FileInput for de-identification, along with various configuration options.
 
 #### Construct a Deidentify File request
 ```python
 from skyflow.error import SkyflowError 
 from skyflow.utils.enums import DetectEntities, MaskingMethod, DetectOutputTranscriptions
-from skyflow.vault.detect import DeidentifyFileRequest, TokenFormat, Transformations, Bleep
+from skyflow.vault.detect import DeidentifyFileRequest, TokenFormat, Transformations, Bleep, FileInput
 """
 This example demonstrates how to deidentify file, along with corresponding DeidentifyFileRequest schema. 
 """
 try:
     # Initialize Skyflow client
     # Step 1: Open file for deidentification
-    file = open('<FILE_PATH>', 'rb')  # Open the file in read-binary mode
+    file_path="<FILE_PATH>"
+    file = open(file_path, 'rb')  # Open the file in read-binary mode
     # Step 2: Create deidentify file request
     request = DeidentifyFileRequest(
-        file=file,  # File object to deidentify
+        file=FileInput(file),  # File to de-identify (can also provide a file path)
         entities=[DetectEntities.SSN, DetectEntities.CREDIT_CARD],  # Entities to detect
 
         # Token format configuration
@@ -1971,7 +1972,7 @@ except Exception as error:
 ```python
 from skyflow.error import SkyflowError
 from skyflow.utils.enums import DetectEntities, MaskingMethod, DetectOutputTranscriptions
-from skyflow.vault.detect import DeidentifyFileRequest, TokenFormat, Bleep
+from skyflow.vault.detect import DeidentifyFileRequest, TokenFormat, Bleep, FileInput
 """
  * Skyflow Deidentify File Example
  * 
@@ -1985,7 +1986,7 @@ try:
     file = open('sensitive_document.txt', 'rb') # Open the file in read-binary mode
     # Step 2: Create deidentify file request
     request = DeidentifyFileRequest(
-        file=file,    # File object to deidentify
+        file=FileInput(file),  # File to de-identify (can also provide a file path)
         entities=[
             DetectEntities.SSN,
             DetectEntities.CREDIT_CARD
@@ -2038,7 +2039,6 @@ DeidentifyFileResponse(
     ],
     run_id='83abcdef-2b61-4a83-a4e0-cbc71ffabffd',
     status='SUCCESS',
-    errors=[]
 )
 ```
 
@@ -2121,7 +2121,7 @@ except Exception as error:
     print('Unexpected Error:', error)  # Print the stack trace for debugging purposes
 ```
 
-Sample Response
+Sample Response:
 ```python
 DeidentifyFileResponse(
     file='TXkgY2FyZCBudW1iZXIgaXMgW0NSRURJVF9DQVJEXQpteSBzZWNvbmQ…',  # Base64 encoded file content
@@ -2142,7 +2142,26 @@ DeidentifyFileResponse(
     ],
     run_id='48ec05ba-96ec-4641-a8e2-35e066afef95',
     status='SUCCESS',
-    errors=[]
+)
+```
+
+Incase of invalid/expired RunId:
+
+```python
+DeidentifyFileResponse(
+    file_base64=None,
+    file=None,
+    type='UNKNOWN',
+    extension=None,
+    word_count=None,
+    char_count=None,
+    size_in_kb=0.0,
+    duration_in_seconds=None,
+    page_count=None,
+    slide_count=None,
+    entities=[],
+    run_id='1e9f321f-dd51-4ab1-a014-21212fsdfsd',
+    status='UNKNOWN'
 )
 ```
 

samples/detect_api/deidentify_file.py

@@ -1,7 +1,7 @@
 from skyflow.error import SkyflowError
 from skyflow import Env, Skyflow, LogLevel
 from skyflow.utils.enums import DetectEntities, MaskingMethod, DetectOutputTranscriptions
-from skyflow.vault.detect import DeidentifyFileRequest, TokenFormat, Transformations, DateTransformation, Bleep
+from skyflow.vault.detect import DeidentifyFileRequest, TokenFormat, Transformations, DateTransformation, Bleep, FileInput
 
 """
  * Skyflow Deidentify File Example
@@ -39,7 +39,7 @@ def perform_file_deidentification():
         file = open(file_path, 'rb')
         # Step 5: Configure Deidentify File Request with all options
         deidentify_request = DeidentifyFileRequest(
-            file=file,  # File object to deidentify
+            file=FileInput(file),  # File to de-identify (can also provide a file path)
             entities=[DetectEntities.SSN, DetectEntities.CREDIT_CARD],  # Entities to detect
             allow_regex_list=['<YOUR_REGEX_PATTERN>'],  # Optional: Patterns to allow
             restrict_regex_list=['<YOUR_REGEX_PATTERN>'],  # Optional: Patterns to restrict

samples/vault_api/insert_byot.py

@@ -70,7 +70,7 @@ def perform_secure_data_insertion_with_byot():
         ]
 
         insert_request = InsertRequest(
-            table_name=table_name,
+            table=table_name,
             values=insert_data,
             token_mode=TokenMode.ENABLE,  # Enable Bring Your Own Token (BYOT)
             tokens=tokens,                # Specify tokens to use for BYOT

samples/vault_api/insert_records.py

@@ -47,7 +47,7 @@ def perform_secure_data_insertion():
 
         # Step 5: Create Insert Request
         insert_request = InsertRequest(
-            table_name=table_name,
+            table=table_name,
             values=insert_data,
             return_tokens=True, # Optional: Get tokens for inserted data
             continue_on_error=True # Optional: Continue on partial errors

setup.py

@@ -7,7 +7,7 @@
 
 if sys.version_info < (3, 8):
     raise RuntimeError("skyflow requires Python 3.8+")
-current_version = '2.1.0b1'
+current_version = '1.15.8.dev0+a22b9c6'
 
 setup(
     name='skyflow',