feat(add_error_code): added error code to UiPathLlamaIndexRuntimeError

Author: giuliastf

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-llamaindex"
-version = "0.0.36"
+version = "0.0.37"
 description = "UiPath LlamaIndex SDK"
 readme = { file = "README.md", content-type = "text/markdown" }
 requires-python = ">=3.10"
@@ -9,7 +9,7 @@ dependencies = [
     "llama-index-embeddings-azure-openai>=0.3.8",
     "llama-index-llms-azure-openai>=0.3.2",
     "openinference-instrumentation-llama-index>=4.3.0",
-    "uipath>=2.1.54, <2.2.0",
+    "uipath>=2.1.108, <2.2.0",
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",

src/uipath_llamaindex/_cli/_runtime/_exception.py

@@ -1,17 +1,37 @@
-from typing import Optional
+from enum import Enum
+from typing import Optional, Union
 
-from uipath._cli._runtime._contracts import UiPathErrorCategory, UiPathRuntimeError
+from uipath._cli._runtime._contracts import (
+    UiPathBaseRuntimeError,
+    UiPathErrorCategory,
+    UiPathErrorCode,
+)
 
 
-class UiPathLlamaIndexRuntimeError(UiPathRuntimeError):
+class LLamaIndexErrorCode(Enum):
+    AGENT_EXECUTION_FAILURE = "AGENT_EXECUTION_FAILURE"
+    TIMEOUT_ERROR = "TIMEOUT_ERROR"
+    SERIALIZE_OUTPUT_ERROR = "SERIALIZE_OUTPUT_ERROR"
+
+    CONFIG_MISSING = "CONFIG_MISSING"
+    CONFIG_INVALID = "CONFIG_INVALID"
+
+    WORKFLOW_NOT_FOUND = "WORKFLOW_NOT_FOUND"
+    WORKFLOW_TYPE_ERROR = "WORKFLOW_TYPE_ERROR"
+    WORKFLOW_VALUE_ERROR = "WORKFLOW_VALUE_ERROR"
+    WORKFLOW_LOAD_ERROR = "WORKFLOW_LOAD_ERROR"
+    WORKFLOW_IMPORT_ERROR = "WORKFLOW_IMPORT_ERROR"
+
+
+class UiPathLlamaIndexRuntimeError(UiPathBaseRuntimeError):
     """Custom exception for LlamaIndex runtime errors with structured error information."""
 
     def __init__(
         self,
-        code: str,
+        code: Union[LLamaIndexErrorCode, UiPathErrorCode],
         title: str,
         detail: str,
         category: UiPathErrorCategory = UiPathErrorCategory.UNKNOWN,
         status: Optional[int] = None,
     ):
-        super().__init__(code, title, detail, category, status, prefix="LlamaIndex")
+        super().__init__(code.value, title, detail, category, status, prefix="LlamaIndex")

src/uipath_llamaindex/_cli/_runtime/_runtime.py

@@ -16,6 +16,7 @@
 from uipath._cli._runtime._contracts import (
     UiPathBaseRuntime,
     UiPathErrorCategory,
+    UiPathErrorCode,
     UiPathResumeTrigger,
     UiPathRuntimeResult,
     UiPathRuntimeStatus,
@@ -24,7 +25,7 @@
 
 from .._utils._config import LlamaIndexConfig
 from ._context import UiPathLlamaIndexRuntimeContext
-from ._exception import UiPathLlamaIndexRuntimeError
+from ._exception import LLamaIndexErrorCode, UiPathLlamaIndexRuntimeError
 
 logger = logging.getLogger(__name__)
 
@@ -97,7 +98,7 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
                 # catch any script exceptions
                 except Exception as e:
                     raise UiPathLlamaIndexRuntimeError(
-                        "AGENT_EXECUTION_FAILURE",
+                        LLamaIndexErrorCode.AGENT_EXECUTION_FAILURE,
                         "There was an exception while executing the agent ",
                         str(e),
                         UiPathErrorCategory.USER,
@@ -128,14 +129,14 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
                 # check if workflow failed because of timeout constraints
                 except WorkflowTimeoutError as e:
                     raise UiPathLlamaIndexRuntimeError(
-                        "TIMEOUT_ERROR",
+                        LLamaIndexErrorCode.TIMEOUT_ERROR,
                         "Workflow timed out",
                         str(e),
                         UiPathErrorCategory.USER,
                     ) from e
                 except Exception as e:
                     raise UiPathLlamaIndexRuntimeError(
-                        "SERIALIZE_OUTPUT_ERROR",
+                        LLamaIndexErrorCode.SERIALIZE_OUTPUT_ERROR,
                         "Failed to serialize output",
                         str(e),
                         UiPathErrorCategory.SYSTEM,
@@ -162,7 +163,7 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
                 raise
             detail = f"Error: {str(e)}"
             raise UiPathLlamaIndexRuntimeError(
-                "EXECUTION_ERROR",
+                UiPathErrorCode.EXECUTION_ERROR,
                 "LlamaIndex Runtime execution failed",
                 detail,
                 UiPathErrorCategory.USER,
@@ -175,7 +176,7 @@ async def validate(self) -> None:
                 self.context.input_json = json.loads(self.context.input)
         except json.JSONDecodeError as e:
             raise UiPathLlamaIndexRuntimeError(
-                "INPUT_INVALID_JSON",
+                UiPathErrorCode.INPUT_INVALID_JSON,
                 "Invalid JSON input",
                 "The input data is not valid JSON.",
                 UiPathErrorCategory.USER,
@@ -185,7 +186,7 @@ async def validate(self) -> None:
             self.context.config = LlamaIndexConfig()
             if not self.context.config.exists:
                 raise UiPathLlamaIndexRuntimeError(
-                    "CONFIG_MISSING",
+                    LLamaIndexErrorCode.CONFIG_MISSING,
                     "Invalid configuration",
                     "Failed to load configuration",
                     UiPathErrorCategory.DEPLOYMENT,
@@ -195,7 +196,7 @@ async def validate(self) -> None:
             self.context.config.load_config()
         except Exception as e:
             raise UiPathLlamaIndexRuntimeError(
-                "CONFIG_INVALID",
+                LLamaIndexErrorCode.CONFIG_INVALID,
                 "Invalid configuration",
                 f"Failed to load configuration: {str(e)}",
                 UiPathErrorCategory.DEPLOYMENT,
@@ -208,7 +209,7 @@ async def validate(self) -> None:
         elif not self.context.entrypoint:
             workflow_names = ", ".join(w.name for w in workflows)
             raise UiPathLlamaIndexRuntimeError(
-                "ENTRYPOINT_MISSING",
+                UiPathErrorCode.ENTRYPOINT_MISSING,
                 "Entrypoint required",
                 f"Multiple workflows available. Please specify one of: {workflow_names}.",
                 UiPathErrorCategory.DEPLOYMENT,
@@ -218,7 +219,7 @@ async def validate(self) -> None:
         self.workflow_config = self.context.config.get_workflow(self.context.entrypoint)
         if not self.workflow_config:
             raise UiPathLlamaIndexRuntimeError(
-                "WORKFLOW_NOT_FOUND",
+                LLamaIndexErrorCode.WORKFLOW_NOT_FOUND,
                 "Workflow not found",
                 f"Workflow '{self.context.entrypoint}' not found.",
                 UiPathErrorCategory.DEPLOYMENT,
@@ -227,28 +228,28 @@ async def validate(self) -> None:
             self.context.workflow = await self.workflow_config.load_workflow()
         except ImportError as e:
             raise UiPathLlamaIndexRuntimeError(
-                "WORKFLOW_IMPORT_ERROR",
+                LLamaIndexErrorCode.WORKFLOW_IMPORT_ERROR,
                 "Workflow import failed",
                 f"Failed to import workflow '{self.context.entrypoint}': {str(e)}",
                 UiPathErrorCategory.USER,
             ) from e
         except TypeError as e:
             raise UiPathLlamaIndexRuntimeError(
-                "WORKFLOW_TYPE_ERROR",
+                LLamaIndexErrorCode.WORKFLOW_TYPE_ERROR,
                 "Invalid workflow type",
                 f"Workflow '{self.context.entrypoint}' is not a valid `Workflow`: {str(e)}",
                 UiPathErrorCategory.USER,
             ) from e
         except ValueError as e:
             raise UiPathLlamaIndexRuntimeError(
-                "WORKFLOW_VALUE_ERROR",
+                LLamaIndexErrorCode.WORKFLOW_VALUE_ERROR,
                 "Invalid workflow value",
                 f"Invalid value in workflow '{self.context.entrypoint}': {str(e)}",
                 UiPathErrorCategory.USER,
             ) from e
         except Exception as e:
             raise UiPathLlamaIndexRuntimeError(
-                "WORKFLOW_LOAD_ERROR",
+                LLamaIndexErrorCode.WORKFLOW_LOAD_ERROR,
                 "Failed to load workflow",
                 f"Unexpected error loading workflow '{self.context.entrypoint}': {str(e)}",
                 UiPathErrorCategory.USER,