Skip to content

fix(documents): make action parameters optional #1174

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexandrujircan merged 1 commit into from
Jan 27, 2026
Merged

fix(documents): make action parameters optional #1174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "uipath"
version = "2.6.12"
version = "2.6.13"
description = "Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools."
readme = { file = "README.md", content-type = "text/markdown" }
requires-python = ">=3.11"
Expand Down
152 changes: 76 additions & 76 deletions src/uipath/platform/documents/_documents_service.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1316,13 +1316,13 @@ def _start_classification_validation(
project_id: str,
project_type: ProjectType,
tag: Optional[str],
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
classification_results: List[ClassificationResult],
action_title: str,
action_priority: Optional[ActionPriority] = None,
action_catalog: Optional[str] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> str:
if project_type == ProjectType.PRETRAINED:
url = Endpoint(
Expand Down Expand Up @@ -1357,13 +1357,13 @@ async def _start_classification_validation_async(
project_id: str,
project_type: ProjectType,
tag: Optional[str],
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
classification_results: List[ClassificationResult],
action_title: str,
action_priority: Optional[ActionPriority] = None,
action_catalog: Optional[str] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> str:
if project_type == ProjectType.PRETRAINED:
url = Endpoint(
Expand Down Expand Up @@ -1402,11 +1402,11 @@ def _start_extraction_validation(
tag: Optional[str],
document_type_id: str,
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
action_priority: Optional[ActionPriority],
action_catalog: Optional[str],
action_folder: Optional[str],
storage_bucket_name: Optional[str],
storage_bucket_directory_path: Optional[str],
extraction_response: ExtractionResponse,
) -> StartOperationResponse:
if project_type == ProjectType.PRETRAINED:
Expand Down Expand Up @@ -1450,11 +1450,11 @@ async def _start_extraction_validation_async(
tag: Optional[str],
document_type_id: str,
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
action_priority: Optional[ActionPriority],
action_catalog: Optional[str],
action_folder: Optional[str],
storage_bucket_name: Optional[str],
storage_bucket_directory_path: Optional[str],
extraction_response: ExtractionResponse,
) -> StartOperationResponse:
if project_type == ProjectType.PRETRAINED:
Expand Down Expand Up @@ -1496,24 +1496,24 @@ async def _start_extraction_validation_async(
@traced(name="documents_start_ixp_extraction_validation", run_type="uipath")
def start_ixp_extraction_validation(
self,
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
extraction_response: ExtractionResponseIXP,
action_title: str,
action_catalog: Optional[str] = None,
action_priority: Optional[ActionPriority] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> StartOperationResponse:
"""Start an IXP extraction validation action without waiting for results (non-blocking).

Args:
action_title (str): The title of the validation action.
action_priority (ActionPriority): The priority of the validation action.
action_catalog (str): The catalog of the validation action.
action_folder (str): The folder of the validation action.
storage_bucket_name (str): The name of the storage bucket where validation data will be stored.
storage_bucket_directory_path (str): The directory path within the storage bucket.
extraction_response (ExtractionResponseIXP): The extraction response from the IXP extraction process.
action_title (str): The title of the validation action.
action_catalog (str, optional): The catalog of the validation action.
action_priority (ActionPriority, optional): The priority of the validation action.
action_folder (str, optional): The folder of the validation action.
storage_bucket_name (str, optional): The name of the storage bucket where validation data will be stored.
storage_bucket_directory_path (str, optional): The directory path within the storage bucket.

Returns:
StartOperationResponse: Contains the operation_id, document_id, project_id, and tag.
Expand Down Expand Up @@ -1552,13 +1552,13 @@ def start_ixp_extraction_validation(
)
async def start_ixp_extraction_validation_async(
self,
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
extraction_response: ExtractionResponseIXP,
action_title: str,
action_catalog: Optional[str] = None,
action_priority: Optional[ActionPriority] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> StartOperationResponse:
"""Asynchronous version of the [`start_ixp_extraction_validation`][uipath.platform.documents._documents_service.DocumentsService.start_ixp_extraction_validation] method."""
return await self._start_extraction_validation_async(
Expand Down Expand Up @@ -1899,24 +1899,24 @@ async def result_getter_async() -> Tuple[Any, Optional[Any], Optional[Any]]:
@traced(name="documents_create_validate_classification_action", run_type="uipath")
def create_validate_classification_action(
self,
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
classification_results: List[ClassificationResult],
action_title: str,
action_priority: Optional[ActionPriority] = None,
action_catalog: Optional[str] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> ValidateClassificationAction:
"""Create a validate classification action for a document based on the classification results. More details about validation actions can be found in the [official documentation](https://docs.uipath.com/ixp/automation-cloud/latest/user-guide/validating-classifications).

Args:
action_title (str): Title of the action.
action_priority (ActionPriority): Priority of the action.
action_catalog (str): Catalog of the action.
action_folder (str): Folder of the action.
storage_bucket_name (str): Name of the storage bucket.
storage_bucket_directory_path (str): Directory path in the storage bucket.
classification_results (List[ClassificationResult]): The classification results to be validated, typically obtained from the [`classify`][uipath.platform.documents._documents_service.DocumentsService.classify] method.
action_title (str): Title of the action.
action_priority (ActionPriority, optional): Priority of the action.
action_catalog (str, optional): Catalog of the action.
action_folder (str, optional): Folder of the action.
storage_bucket_name (str, optional): Name of the storage bucket.
storage_bucket_directory_path (str, optional): Directory path in the storage bucket.

Returns:
ValidateClassificationAction: The created validate classification action.
Expand Down Expand Up @@ -1960,13 +1960,13 @@ def create_validate_classification_action(
@traced(name="documents_create_validate_classification_action", run_type="uipath")
async def create_validate_classification_action_async(
self,
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
classification_results: List[ClassificationResult],
action_title: str,
action_priority: Optional[ActionPriority] = None,
action_catalog: Optional[str] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> ValidateClassificationAction:
"""Asynchronous version of the [`create_validation_action`][uipath.platform.documents._documents_service.DocumentsService.create_validate_classification_action] method."""
if not classification_results:
Expand Down Expand Up @@ -1995,24 +1995,24 @@ async def create_validate_classification_action_async(
@traced(name="documents_create_validate_extraction_action", run_type="uipath")
def create_validate_extraction_action(
self,
action_title: str,
action_priority: ActionPriority,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
extraction_response: ExtractionResponse,
action_title: str,
action_priority: Optional[ActionPriority] = None,
action_catalog: Optional[str] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> ValidateExtractionAction:
"""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.
action_priority (ActionPriority): Priority of the action.
action_catalog (str): Catalog of the action.
action_folder (str): Folder of the action.
storage_bucket_name (str): Name of the storage bucket.
storage_bucket_directory_path (str): Directory path in the storage bucket.
extraction_response (ExtractionResponse): The extraction result to be validated, typically obtained from the [`extract`][uipath.platform.documents._documents_service.DocumentsService.extract] method.
action_title (str): Title of the action.
action_priority (ActionPriority, optional): Priority of the action.
action_catalog (str, optional): Catalog of the action.
action_folder (str, optional): Folder of the action.
storage_bucket_name (str, optional): Name of the storage bucket.
storage_bucket_directory_path (str, optional): Directory path in the storage bucket.

Returns:
ValidateClassificationAction: The created validation action.
Expand Down Expand Up @@ -2055,13 +2055,13 @@ def create_validate_extraction_action(
@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,
action_catalog: str,
action_folder: str,
storage_bucket_name: str,
storage_bucket_directory_path: str,
extraction_response: ExtractionResponse,
action_title: str,
action_priority: Optional[ActionPriority] = None,
action_catalog: Optional[str] = None,
action_folder: Optional[str] = None,
storage_bucket_name: Optional[str] = None,
storage_bucket_directory_path: Optional[str] = None,
) -> ValidateExtractionAction:
"""Asynchronous version of the [`create_validation_action`][uipath.platform.documents._documents_service.DocumentsService.create_validate_extraction_action] method."""
operation_id = (
Expand Down
Loading
Loading