fix(documents): improve typing and naming

Author: alexandrujircan

src/uipath/_services/documents_service.py

@@ -13,7 +13,7 @@
 from ..models.documents import (
     ActionPriority,
     ExtractionResponse,
-    ValidatedResult,
+    ExtractionResult,
     ValidationAction,
 )
 from ..tracing._traced import traced
@@ -502,8 +502,8 @@ async def result_getter() -> Tuple[str, Any]:
         response["operationId"] = operation_id
         return ValidationAction.model_validate(response)
 
-    @traced(name="documents_create_validation_action", run_type="uipath")
-    def create_validation_action(
+    @traced(name="documents_create_validate_extraction_action", run_type="uipath")
+    def create_validate_extraction_action(
         self,
         action_title: str,
         action_priority: ActionPriority,
@@ -513,7 +513,7 @@ def create_validation_action(
         storage_bucket_directory_path: str,
         extraction_response: ExtractionResponse,
     ) -> ValidationAction:
-        """Create a validation action for a document based on the extraction response. More details about validation actions can be found in the [official documentation](https://docs.uipath.com/ixp/automation-cloud/latest/user-guide/validating-extractions).
+        """Create a validate extraction action for a document based on the extraction response. More details about validation actions can be found in the [official documentation](https://docs.uipath.com/ixp/automation-cloud/latest/user-guide/validating-extractions).
 
         Args:
             action_title (str): Title of the action.
@@ -529,7 +529,7 @@ def create_validation_action(
 
         Examples:
             ```python
-            validation_action = service.create_validation_action(
+            validation_action = service.create_validate_extraction_action(
                 action_title="Test Validation Action",
                 action_priority=ActionPriority.MEDIUM,
                 action_catalog="default_du_actions",
@@ -558,8 +558,8 @@ def create_validation_action(
             operation_id=operation_id,
         )
 
-    @traced(name="documents_create_validation_action_async", run_type="uipath")
-    async def create_validation_action_async(
+    @traced(name="documents_create_validate_extraction_action_async", run_type="uipath")
+    async def create_validate_extraction_action_async(
         self,
         action_title: str,
         action_priority: ActionPriority,
@@ -569,7 +569,7 @@ async def create_validation_action_async(
         storage_bucket_directory_path: str,
         extraction_response: ExtractionResponse,
     ) -> ValidationAction:
-        """Asynchronously create a validation action for a document based on the extraction response."""
+        """Asynchronously create a validate extraction action for a document based on the extraction response."""
         # Add reference to sync method docstring
         operation_id = await self._start_validation_async(
             project_id=extraction_response.project_id,
@@ -589,11 +589,11 @@ async def create_validation_action_async(
             operation_id=operation_id,
         )
 
-    @traced(name="documents_get_validation_result", run_type="uipath")
-    def get_validation_result(
+    @traced(name="documents_get_validate_extraction_result", run_type="uipath")
+    def get_validate_extraction_result(
         self, validation_action: ValidationAction
-    ) -> ValidatedResult:
-        """Get the result of a validation action.
+    ) -> ExtractionResult:
+        """Get the result of a validate extraction action.
 
         Note:
             This method will block until the validation action is completed, meaning the user has completed the validation in UiPath Action Center.
@@ -602,11 +602,11 @@ def get_validation_result(
             validation_action (ValidationAction): The validation action to get the result for, typically obtained from the [`create_validation_action`][uipath._services.documents_service.DocumentsService.create_validation_action] method.
 
         Returns:
-            ValidatedResult: The result of the validation action.
+            ExtractionResult: The result of the validation action.
 
         Examples:
             ```python
-            validated_result = service.get_validation_result(validation_action)
+            validated_result = service.get_validate_extraction_result(validation_action)
             ```
         """
         response = self._wait_for_operation(
@@ -624,13 +624,13 @@ def get_validation_result(
             success_status="Completed",
         )
 
-        return ValidatedResult.model_validate(response)
+        return ExtractionResult.model_validate(response)
 
-    @traced(name="documents_get_validation_result_async", run_type="uipath")
-    async def get_validation_result_async(
+    @traced(name="documents_get_validate_extraction_result_async", run_type="uipath")
+    async def get_validate_extraction_result_async(
         self, validation_action: ValidationAction
-    ) -> ValidatedResult:
-        """Asynchronously get the result of a validation action."""
+    ) -> ExtractionResult:
+        """Asynchronously get the result of a validate extraction action."""
 
         async def result_getter() -> Tuple[str, Any]:
             result = await self._get_validation_result_async(
@@ -648,4 +648,4 @@ async def result_getter() -> Tuple[str, Any]:
             success_status="Completed",
         )
 
-        return ValidatedResult.model_validate(response)
+        return ExtractionResult.model_validate(response)

src/uipath/models/documents.py

@@ -108,20 +108,3 @@ class ValidationAction(BaseModel):
     project_id: str = Field(alias="projectId")
     tag: str
     operation_id: str = Field(alias="operationId")
-
-
-class ValidatedResult(BaseModel):
-    """A model representing the result of a validation action.
-
-    Attributes:
-        document_id (str): The ID of the validated document.
-        results_document (dict): The validated results document.
-    """
-
-    model_config = ConfigDict(
-        serialize_by_alias=True,
-        validate_by_alias=True,
-    )
-
-    document_id: str = Field(alias="DocumentId")
-    results_document: dict = Field(alias="ResultsDocument")  # type: ignore

tests/sdk/services/test_documents_service.py

@@ -37,15 +37,6 @@ def create_validation_action_response(documents_tests_data_path: Path) -> dict:
         return json.load(f)
 
 
-@pytest.fixture
-def validated_result(documents_tests_data_path: Path) -> dict:  # type: ignore
-    with open(
-        documents_tests_data_path / "validated_result.json",
-        "r",
-    ) as f:
-        return json.load(f)
-
-
 class TestDocumentsService:
     @pytest.mark.parametrize("mode", ["sync", "async"])
     @pytest.mark.asyncio
@@ -348,7 +339,7 @@ async def test_create_validation_action(
 
         # ACT
         if mode == "async":
-            response = await service.create_validation_action_async(
+            response = await service.create_validate_extraction_action_async(
                 action_title=action_title,
                 action_priority=action_priority,
                 action_catalog=action_catalog,
@@ -360,7 +351,7 @@ async def test_create_validation_action(
                 ),
             )
         else:
-            response = service.create_validation_action(
+            response = service.create_validate_extraction_action(
                 action_title=action_title,
                 action_priority=action_priority,
                 action_catalog=action_catalog,
@@ -388,7 +379,7 @@ async def test_get_validation_result(
         tenant: str,
         service: DocumentsService,
         create_validation_action_response: dict,  # type: ignore
-        validated_result: dict,  # type: ignore
+        extraction_response: dict,  # type: ignore
         mode: str,
     ):
         # ARRANGE
@@ -400,7 +391,7 @@ async def test_get_validation_result(
         create_validation_action_response["operationId"] = operation_id
         create_validation_action_response["actionStatus"] = "Completed"
         create_validation_action_response["validatedExtractionResults"] = (
-            validated_result
+            extraction_response["extractionResult"]
         )
 
         httpx_mock.add_response(
@@ -412,20 +403,20 @@ async def test_get_validation_result(
 
         # ACT
         if mode == "async":
-            response = await service.get_validation_result_async(
+            response = await service.get_validate_extraction_result_async(
                 validation_action=ValidationAction.model_validate(
                     create_validation_action_response
                 )
             )
         else:
-            response = service.get_validation_result(
+            response = service.get_validate_extraction_result(
                 validation_action=ValidationAction.model_validate(
                     create_validation_action_response
                 )
             )
 
         # ASSERT
-        assert response.model_dump() == validated_result
+        assert response.model_dump() == extraction_response["extractionResult"]
 
     @pytest.mark.parametrize("mode", ["sync", "async"])
     @pytest.mark.asyncio