Documents

UiPath Documents Models.

This module contains models related to UiPath Document Understanding service.

ActionPriority

Bases: str, Enum

Priority levels for validation actions. More details can be found in the official documentation.

CRITICAL class-attribute instance-attribute

CRITICAL = 'Critical'

Critical priority

HIGH class-attribute instance-attribute

HIGH = 'High'

High priority

LOW class-attribute instance-attribute

LOW = 'Low'

Low priority

MEDIUM class-attribute instance-attribute

MEDIUM = 'Medium'

Medium priority

ClassificationResponse

Bases: BaseModel

A model representing the response from a document classification process.

ClassificationResult

Bases: BaseModel

A model representing the result of a document classification.

Attributes:

Name	Type	Description
document_id	str	The ID of the classified document.
document_type_id	str	The ID of the predicted document type.
confidence	float	The confidence score of the classification.
ocr_confidence	float	The OCR confidence score of the document.
reference	Reference	The reference information for the classified document.
document_bounds	DocumentBounds	The bounds of the document in terms of pages and text.
classifier_name	str	The name of the classifier used.
project_id	str	The ID of the project associated with the classification.

DocumentBounds

Bases: BaseModel

A model representing the bounds of a document in terms of pages and text.

ExtractionResponse

Bases: BaseModel

A model representing the response from a document extraction process.

Attributes:

Name	Type	Description
extraction_result	ExtractionResult	The result of the extraction process.
project_id	str	The ID of the project associated with the extraction.
tag	str	The tag associated with the published model version.
document_type_id	str	The ID of the document type associated with the extraction.

ExtractionResponseIXP

Bases: ExtractionResponse

A model representing the response from a document extraction process for IXP projects.

Attributes:

Name	Type	Description
data_projection	list[FieldGroupValueProjection]	A simplified projection of the extracted data.

ExtractionResult

Bases: BaseModel

A model representing the result of a document extraction process.

FieldGroupValueProjection

Bases: BaseModel

A model representing a projection of a field group value in a document extraction result.

FieldType

Bases: str, Enum

Field types supported by Document Understanding service.

FieldValueProjection

Bases: BaseModel

A model representing a projection of a field value in a document extraction result.

ProjectType

Bases: str, Enum

Project types available and supported by Documents Service.

IXP class-attribute instance-attribute

IXP = 'IXP'

Represents an IXP project type.

MODERN class-attribute instance-attribute

MODERN = 'Modern'

Represents a DU Modern project type.

PRETRAINED class-attribute instance-attribute

PRETRAINED = 'Pretrained'

Represents a Pretrained project type.

Reference

Bases: BaseModel

A model representing a reference within a document.

ValidateClassificationAction

Bases: ValidationAction

A model representing a validation action for document classification.

ValidateExtractionAction

Bases: ValidationAction

A model representing a validation action for document extraction.

ValidationAction

Bases: BaseModel

A model representing a validation action for a document.

Attributes:

Name	Type	Description
action_data	dict	The data associated with the validation action.
action_status	str	The status of the validation action. Possible values can be found in the official documentation.
project_id	str	The ID of the project associated with the validation action.
tag	str	The tag associated with the published model version.
operation_id	str	The operation ID associated with the validation action.