Create Document Classification Action
UiPath.IntelligentOCR.Activities.CreateDocumentClassificationAction
Creates a document classification action. To be used in conjunction with the "Wait For Document Classification Action And Resume" activity to collect the results.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AutomaticClassificationResults | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult[]> |
|||
| EnablePageReorderging | In | InArgument<Boolean> |
|||
| ActionTitle | In | InArgument<String> |
✓ | ||
| ActionCatalog | In | InArgument<String> |
|||
| ActionPriority | In | InArgument<UiPath.DocumentProcessing.Contracts.Actions.DocumentActionPriority> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ | ||
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| Taxonomy | In | InArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
✓ | ||
| ActionOutput | Out | OutArgument<T> |
|||
| BucketName | In | InArgument<String> |
✓ | ||
| BucketFolderPath | In | InArgument<String> |
✓ | ||
| FolderPath | In | InArgument<String> |
|||
| TimeoutMs | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| RetryOnFailure | property | Boolean |
Create Document Validation Action
UiPath.IntelligentOCR.Activities.CreateDocumentValidationAction
Creates a document validation action. To be used in conjunction with the "Wait For Document Validation Action And Resume" activity to collect the results.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AutomaticExtractionResults | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
|||
| DisplayMode | In | InArgument<UiPath.DU.Shared.Actions.DisplayModeArgument> |
|||
| EnableRTLControls | In | InArgument<Boolean> |
|||
| ActionTitle | In | InArgument<String> |
✓ | ||
| ActionCatalog | In | InArgument<String> |
|||
| ActionPriority | In | InArgument<UiPath.DocumentProcessing.Contracts.Actions.DocumentActionPriority> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ | ||
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| Taxonomy | In | InArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
✓ | ||
| ActionOutput | Out | OutArgument<T> |
|||
| BucketName | In | InArgument<String> |
✓ | ||
| BucketFolderPath | In | InArgument<String> |
✓ | ||
| FolderPath | In | InArgument<String> |
|||
| TimeoutMs | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| FieldsValidationConfidence | property | Nullable<Int32> |
|
| ShowOnlyRelevantPageRange | property | Boolean |
|
| RetryOnFailure | property | Boolean |
Wait For Document Classification Action And Resume
UiPath.IntelligentOCR.Activities.WaitForDocumentClassificationActionAndResume
Suspends the workflow until the document classification action is completed and then resumes the workflow. To be used in conjunction with the output of a "Create Document Classification Action" activity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AutomaticClassificationResults | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult[]> |
|||
| ValidatedClassificationResults | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult[]> |
|||
| ActionInput | In | InArgument<T> |
✓ | ||
| DownloadFolderPath | In | InArgument<String> |
|||
| DocumentPath | Out | OutArgument<String> |
|||
| DocumentText | Out | OutArgument<String> |
|||
| DocumentObjectModel | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
|||
| Taxonomy | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
|||
| ActionOutput | Out | OutArgument<T> |
|||
| StatusMessage | In | InArgument<String> |
|||
| TimeoutMs | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| RemoveDataFromStorage | property | Boolean |
|
| RetryOnFailure | property | Boolean |
Wait For Document Validation Action And Resume
UiPath.IntelligentOCR.Activities.WaitForDocumentValidationActionAndResume
Suspends the workflow until the document validation action is completed and then resumes the workflow. To be used in conjunction with the output of a "Create Document Validation Action" activity.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AutomaticExtractionResults | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
|||
| ValidatedExtractionResults | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
|||
| ActionInput | In | InArgument<T> |
✓ | ||
| DownloadFolderPath | In | InArgument<String> |
|||
| DocumentPath | Out | OutArgument<String> |
|||
| DocumentText | Out | OutArgument<String> |
|||
| DocumentObjectModel | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
|||
| Taxonomy | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
|||
| ActionOutput | Out | OutArgument<T> |
|||
| StatusMessage | In | InArgument<String> |
|||
| TimeoutMs | In | InArgument<Int32> |
|||
| ContinueOnError | In | InArgument<Boolean> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| RemoveDataFromStorage | property | Boolean |
|
| RetryOnFailure | property | Boolean |
Present Validation Station
UiPath.IntelligentOCR.Activities.ValidationStation.PresentValidationStation
Opens Validation Station and allows for human review of automatic clasification and data extraction, if any
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AutomaticExtractionResults | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
|||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ | ||
| Taxonomy | In | InArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
✓ | ||
| DisplayMode | In | InArgument<UiPath.DU.Shared.Actions.DisplayModeArgument> |
|||
| EnableRTLControls | In | InArgument<Boolean> |
|||
| ValidatedExtractionResults | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| ShowOnlyRelevantPageRange | property | Boolean |
|
| FieldsValidationConfidence | property | Nullable<Int32> |
Intelligent Keyword Classifier Trainer
UiPath.IntelligentOCR.Activities.Training.IntelligentKeywordClassifierTrainer
Intelligent Keyword Classifier Trainer
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| LearningFilePath | In | InArgument<String> |
|||
| LearningData | InOut | InOutArgument<String> |
Keyword Based Classifier Trainer
UiPath.IntelligentOCR.Activities.Training.KeywordBasedClassifierTrainer
Keyword Based Classifier Trainer
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| LearningFilePath | In | InArgument<String> |
|||
| LearningData | InOut | InOutArgument<String> |
Train Classifiers Scope
UiPath.IntelligentOCR.Activities.Training.TrainClassifiersScope
Train Classifiers Scope
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| HumanValidatedData | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
|||
| Taxonomy | In | InArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
|||
| HumanValidatedClassificationData | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult[]> |
|||
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ |
Train Extractors Scope
UiPath.IntelligentOCR.Activities.Training.TrainExtractorsScope
Train Extractors Scope
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| HumanValidatedData | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
✓ | ||
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ |
Load Taxonomy
UiPath.IntelligentOCR.Activities.TaxonomyManagement.LoadTaxonomy
Load Taxonomy
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Taxonomy | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
RunDevAccessProviderHost
UiPath.IntelligentOCR.Activities.Internal.RunDevAccessProviderHost
No members extracted.
Classify Document Scope
UiPath.IntelligentOCR.Activities.DocumentClassification.ClassifyDocumentScope
Classify Document Scope
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ | ||
| Taxonomy | In | InArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
✓ | ||
| ClassificationResults | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult[]> |
Intelligent Keyword Classifier
UiPath.IntelligentOCR.Activities.DocumentClassification.IntelligentKeywordClassifier
Intelligent Keyword Classifier
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| LearningFilePath | In | InArgument<String> |
|||
| LearningData | In | InArgument<String> |
|||
| Endpoint | In | InArgument<String> |
✓ | ||
| ApiKey | In | InArgument<String> |
|||
| TimeoutMs | In | InArgument<Int32> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SendDocumentsForAlgorithmImprovements | property | Boolean |
|
| UsePageNumbers | property | Boolean |
|
| PerformDocumentSplitting | property | Boolean |
Keyword Based Classifier
UiPath.IntelligentOCR.Activities.DocumentClassification.KeywordBasedClassifier
Keyword Based Classifier
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| LearningFilePath | In | InArgument<String> |
|||
| LearningData | In | InArgument<String> |
|||
| OriginalDocumentText | In | InArgument<String> |
|||
| OriginalDocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
|||
| OriginalDocumentPath | In | InArgument<String> |
Present Classification Station
UiPath.IntelligentOCR.Activities.DocumentClassification.PresentClassificationStation
Opens Classification Station and allows for human review of automatic document classification
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| AutomaticClassificationResults | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult[]> |
|||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ | ||
| Taxonomy | In | InArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
✓ | ||
| EnablePageReorderging | In | InArgument<Boolean> |
|||
| ValidatedClassificationResults | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult[]> |
Digitize Document
UiPath.IntelligentOCR.Activities.Digitization.DigitizeDocument
Processes PDF and image files to obtain document object model and text version
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| DocumentPath | In | InArgument<String> |
✓ | ||
| DegreeOfParallelism | In | InArgument<Int32> |
✓ | ||
| DetectCheckboxes | In | InArgument<Boolean> |
✓ | ||
| ApplyOcrOnPdf | In | InArgument<UiPath.IntelligentOCR.Activities.Digitization.ApplyOcrOnPdfArgument> |
✓ | ||
| DocumentText | Out | OutArgument<String> |
|||
| DocumentObjectModel | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
Data Extraction Scope
UiPath.IntelligentOCR.Activities.DataExtraction.DataExtractionScope
Data Extraction Scope
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ClassificationResult | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ClassificationResult> |
|||
| DocumentTypeId | In | InArgument<String> |
|||
| DocumentText | In | InArgument<String> |
✓ | ||
| DocumentObjectModel | In | InArgument<UiPath.DocumentProcessing.Contracts.Dom.Document> |
✓ | ||
| DocumentPath | In | InArgument<String> |
✓ | ||
| Taxonomy | In | InArgument<UiPath.DocumentProcessing.Contracts.Taxonomy.DocumentTaxonomy> |
✓ | ||
| GenerativeValidationConfidenceThreshold | In | InArgument<Int32> |
|||
| ExtractionResult | Out | OutArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
|||
| RuntimeAssetPath | In | InArgument<String> |
|||
| RuntimeTenantUrl | In | InArgument<String> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| FormatValuesIfPossible | property | Boolean |
|
| ApplyGenerativeValidation | property | Boolean |
Export Extraction Results
UiPath.IntelligentOCR.Activities.DataExtraction.ExportExtractionResults
Exports an ExtractionResults object to a DataSet containing multiple Tables, for all types of fields and values.
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| ExtractionResult | In | InArgument<UiPath.DocumentProcessing.Contracts.Results.ExtractionResult> |
✓ | ||
| DataSet | Out | OutArgument<Data.DataSet> |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| IncludeConfidence | property | Boolean |
|
| IncludeOCRConfidence | property | Boolean |
Form Extractor
UiPath.IntelligentOCR.Activities.DataExtraction.FormExtractor
Data extractor for fixed template document types
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Endpoint | In | InArgument<String> |
✓ | ||
| ApiKey | In | InArgument<String> |
|||
| MinOverlapPercentage | In | InArgument<Int32> |
✓ | ||
| Timeout | In | InArgument<Int32> |
✓ |
Properties
| Name | Kind | Type | Description |
|---|---|---|---|
| SendDocumentsForAlgorithmImprovements | property | Boolean |
Regex Based Extractor
UiPath.IntelligentOCR.Activities.DataExtraction.RegexBasedExtractor
An extractor using regular expressions
Arguments
| Name | Dir | Type | Req | Default | Description |
|---|---|---|---|---|---|
| Configuration | In | InArgument<String> |
✓ | ||
| Timeout | In | InArgument<Int32> |
✓ | ||
| UseVisualAlignment | In | InArgument<Boolean> |