Microsoft Azure

AzureBlobDocumentVersionSheet

Bases: DocumentVersionSheet

AzureBlobMetadataProperty

Bases: MetadataProperty

get

get()

Reads the metadata property definition from storage, overriding lazy load.

set

set(data=None)

Merges the updated metadata property into the session standard and writes to Azure Blob Storage.

AzureBlobMetadataSpecification

Bases: MetadataSpecification

get

get()

Reads the session standard and workflow definition from storage, overriding lazy load

set

set(data=None)

Writes the updated metadata properties and workflow definition to Azure Blob Storage.

AzureBlobPropertyValue

Bases: PropertyValue

get

get()

Reads the property value from storage, overriding lazy load.

set

set(data=None)

Merges the updated metadata property into the session standard and writes to Azure Blob Storage.

AzureBlobResults

Bases: Results

get

get()

Reads the results from storage, overriding lazy load

AzureBlobSession

Bases: Session

get_processing_status

get_processing_status()

Check if all files in the session have completed processing.

Returns:

Type	Description
str	completed if all files have status 'completed', error if any file has status 'failed', processing if no errors and any file has status 'processing', else draft.

results_to_df

results_to_df()

Transmute all document version results to a Pandas dataframe:

1. Inserting results to the correct dataframe columns according to their field names
2. Merging user edits and AI edits into their correct cell positions

Returns:

Type	Description
DataFrame	Each row in the dataframe is a document version.

set_file_count

set_file_count(new_file_count)

Set the file count in the session properties JSON.

Parameters:

Name	Type	Description	Default
new_file_count	int	The count of files	required

Returns:

Type	Description
bool	True if operation successful, else false.

set_processing_status

set_processing_status(new_status)

Set the processing status in the session properties JSON.

Parameters:

Name	Type	Description	Default
new_status	str	The status to set.	required

Returns:

Type	Description
bool	True if operation successful, else false.

AzureBlobSheetItem

Bases: SheetItem

set

set(data=None)

Writes the updated blob to Azure Blob Storage.

AzureBlobWorkflow

Bases: Workflow

get

get()

Reads the workflow definition from storage, overriding lazy load

set

set(data=None)

Writes the updated workflow definition to Azure Blob Storage.

HasBlobClient

Bases: Protocol

Protocol for classes with blob storage attributes

json_serializer

json_serializer(obj)

Custom JSON serializer for objects not serializable by default