feat(documents): add samples

Author: alexandrujircan

samples/documents/README.md

@@ -0,0 +1,76 @@
+# Document Understanding Sample
+
+This sample demonstrates how to use UiPath Document Understanding capabilities with the UiPath Python SDK to classify, extract and validate data from documents.
+
+## Overview
+
+Document Understanding enables automated processing of documents through:
+
+- **Classification**: Identify document types
+- **Extraction**: Extract data from classified documents
+- **Validation**: Create human-in-the-loop validation actions for review
+
+This sample includes three Document Understanding approaches:
+
+- **IXP (Intelligent Xtraction and Processing)** (`samples/ixp.py`) - [IXP documentation](https://docs.uipath.com/ixp/automation-cloud/latest/overview/introduction)
+- **Modern Projects** (`samples/du_modern.py`) - [Modern DU documentation](https://docs.uipath.com/document-understanding/automation-cloud/latest/user-guide/about-document-understanding)
+- **Pretrained Models** (`samples/pretrained.py`) - [Pretrained models documentation](https://docs.uipath.com/document-understanding/automation-cloud/latest/user-guide/out-of-the-box-pre-trained-ml-packages)
+
+## Prerequisites
+
+- UiPath Automation Suite or Automation Cloud tenant
+- Document Understanding projects deployed with appropriate tags
+- Action catalog configured for validation actions
+- Storage bucket for validation data
+
+## Setup
+
+1. **Install dependencies**:
+
+   ```bash
+   uv sync
+   ```
+
+2. **Configure UiPath credentials and initialize project**:
+
+   ```bash
+   uv run uipath auth
+   uv run uipath init
+   ```
+
+3. **Update sample parameters**:
+
+   Edit the sample files to match your environment:
+   - Project names and tags
+   - Document type names
+   - Action catalog and folder names
+   - Storage bucket configuration
+
+4. **Add test document**:
+
+   Place a `test.pdf` file in the project root for processing.
+
+## Usage
+
+Run the complete sample workflow:
+
+```bash
+uipath run main.py '{"message": "test"}'
+```
+
+Or run individual samples:
+
+```python
+from samples import ixp, du_modern, pretrained
+
+# IXP extraction and validation
+ixp.extract_validate()
+
+# Modern project
+du_modern.extract_validate()
+du_modern.classify_extract_validate()
+
+# Pretrained model
+pretrained.extract_validate()
+pretrained.classify_extract_validate()
+```

samples/documents/main.py

@@ -0,0 +1,23 @@
+from dataclasses import dataclass
+from samples import ixp, du_modern, pretrained
+
+
+@dataclass
+class EchoIn:
+    message: str
+
+
+@dataclass
+class EchoOut:
+    message: str
+
+def main(input: EchoIn) -> EchoOut:
+    ixp.extract_validate()
+
+    du_modern.extract_validate()
+    du_modern.classify_extract_validate()
+
+    pretrained.extract_validate()
+    pretrained.classify_extract_validate()
+
+    return EchoOut(message="")

samples/documents/pyproject.toml

@@ -0,0 +1,10 @@
+[project]
+name = "documents"
+version = "0.1.0"
+authors = [{ name = "John Doe" }]
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "uipath>=2.1.173",
+]

samples/documents/samples/du_modern.py

@@ -0,0 +1,73 @@
+from uipath import UiPath
+from uipath.models.documents import ProjectType, ActionPriority
+
+TAG = "Production"
+PROJECT_NAME = "TestModernProject"
+
+def extract_validate():
+    uipath = UiPath()
+
+    extraction_response = uipath.documents.extract(
+        tag=TAG,
+        project_name=PROJECT_NAME,
+        project_type=ProjectType.MODERN,
+        document_type_name="TestDocumentType",
+        file_path="test.pdf",
+    )
+
+    validation_action = uipath.documents.create_validate_extraction_action(
+        action_title="Test Validation Action",
+        action_priority=ActionPriority.MEDIUM,
+        action_catalog="default_du_actions",
+        action_folder="Shared",
+        storage_bucket_name="du_storage_bucket",
+        storage_bucket_directory_path="TestDirectory",
+        extraction_response=extraction_response,
+    )
+
+    uipath.documents.get_validate_extraction_result(
+        validation_action=validation_action
+    )
+
+def classify_extract_validate():
+    uipath = UiPath()
+
+    classification_results = uipath.documents.classify(
+        tag=TAG,
+        project_name=PROJECT_NAME,
+        project_type=ProjectType.MODERN,
+        file_path="test.pdf",
+    )
+
+    validation_action = uipath.documents.create_validate_classification_action(
+        action_title="Test Validation Action",
+        action_priority=ActionPriority.MEDIUM,
+        action_catalog="default_du_actions",
+        action_folder="Shared",
+        storage_bucket_name="du_storage_bucket",
+        storage_bucket_directory_path="TestDirectory",
+        classification_results=classification_results,
+    )
+
+    validated_classification_results = uipath.documents.get_validate_classification_result(
+        validation_action=validation_action
+    )
+
+    best_confidence_result = max(validated_classification_results, key=lambda result: result.confidence)
+
+    extraction_response = uipath.documents.extract(classification_result=best_confidence_result)
+
+    validation_action = uipath.documents.create_validate_extraction_action(
+        action_title="Test Extraction Validation Action",
+        action_priority=ActionPriority.MEDIUM,
+        action_catalog="default_du_actions",
+        action_folder="Shared",
+        storage_bucket_name="du_storage_bucket",
+        storage_bucket_directory_path="TestDirectory",
+        extraction_response=extraction_response,
+    )
+
+    uipath.documents.get_validate_extraction_result(
+        validation_action=validation_action
+    )
+

samples/documents/samples/ixp.py

@@ -0,0 +1,26 @@
+from uipath import UiPath
+from uipath.models.documents import ProjectType, ActionPriority
+
+def extract_validate():
+    uipath = UiPath()
+
+    extraction_response = uipath.documents.extract(
+        tag="live",
+        project_name="TestIxpProject",
+        project_type=ProjectType.IXP,
+        file_path="test.pdf",
+    )
+
+    validation_action = uipath.documents.create_validate_extraction_action(
+        action_title="Test Validation Action",
+        action_priority=ActionPriority.MEDIUM,
+        action_catalog="default_du_actions",
+        action_folder="Shared",
+        storage_bucket_name="du_storage_bucket",
+        storage_bucket_directory_path="TestDirectory",
+        extraction_response=extraction_response,
+    )
+
+    uipath.documents.get_validate_extraction_result(
+        validation_action=validation_action
+    )

samples/documents/samples/pretrained.py

@@ -0,0 +1,52 @@
+from uipath import UiPath
+from uipath.models.documents import ProjectType, ActionPriority
+
+def extract_validate():
+    uipath = UiPath()
+
+    extraction_response = uipath.documents.extract(
+        project_type=ProjectType.PRETRAINED,
+        document_type_name="invoices",
+        file_path="test.pdf",
+    )
+
+    extraction_action = uipath.documents.create_validate_extraction_action(
+        action_title="Test Validation Action",
+        action_priority=ActionPriority.MEDIUM,
+        action_catalog="default_du_actions",
+        action_folder="Shared",
+        storage_bucket_name="du_storage_bucket",
+        storage_bucket_directory_path="TestDirectory",
+        extraction_response=extraction_response,
+    )
+
+    uipath.documents.get_validate_extraction_result(
+        validation_action=extraction_action
+    )
+
+def classify_extract_validate():
+    uipath = UiPath()
+
+    classification_results = uipath.documents.classify(
+        project_type=ProjectType.PRETRAINED, file_path="test.pdf"
+    )
+
+    best_confidence_result = max(classification_results, key=lambda result: result.confidence)
+
+    extraction_response = uipath.documents.extract(
+        classification_result=best_confidence_result
+    )
+
+    extraction_action = uipath.documents.create_validate_extraction_action(
+        action_title="Test Validation Action",
+        action_priority=ActionPriority.MEDIUM,
+        action_catalog="default_du_actions",
+        action_folder="Shared",
+        storage_bucket_name="du_storage_bucket",
+        storage_bucket_directory_path="TestDirectory",
+        extraction_response=extraction_response,
+    )
+
+    uipath.documents.get_validate_extraction_result(
+        validation_action=extraction_action
+    )