feat: add dev terminal

Author: cristipufu

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath-llamaindex"
-version = "0.0.32"
+version = "0.0.33"
 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.10, <2.2.0",
+    "uipath>=2.1.30, <2.2.0",
 ]
 classifiers = [
     "Development Status :: 3 - Alpha",

samples/quickstart-llamacloud/main.py

@@ -1,10 +1,9 @@
 import os
-from typing import List
-from dotenv import load_dotenv
 
+from dotenv import load_dotenv
 from llama_index.core.agent.workflow import FunctionAgent
-from llama_index.llms.openai import OpenAI
 from llama_index.indices.managed.llama_cloud import LlamaCloudIndex
+from llama_index.llms.openai import OpenAI
 
 load_dotenv()
 
@@ -13,14 +12,14 @@
     name=os.getenv("LLAMACLOUD_INDEX_1_NAME"),
     project_name=os.getenv("LLAMACLOUD_PROJECT_NAME"),
     organization_id=os.getenv("LLAMACLOUD_ORG_ID"),
-    api_key=os.getenv("LLAMACLOUD_API_KEY")
+    api_key=os.getenv("LLAMACLOUD_API_KEY"),
 )
 
 personal_preferences_index = LlamaCloudIndex(
     name=os.getenv("LLAMACLOUD_INDEX_2_NAME"),
     project_name=os.getenv("LLAMACLOUD_PROJECT_NAME"),
     organization_id=os.getenv("LLAMACLOUD_ORG_ID"),
-    api_key=os.getenv("LLAMACLOUD_API_KEY")
+    api_key=os.getenv("LLAMACLOUD_API_KEY"),
 )
 
 llm = OpenAI(api_key=os.getenv("OPENAI_API_KEY"))
@@ -29,34 +28,34 @@
 def search_company_policy(query: str) -> str:
     """
     Search the company policy index for travel rates, guidelines, and company policies.
-    
+
     Args:
         query (str): The search query about company travel policies, rates, or guidelines
-        
+
     Returns:
         str: Relevant information from company policy documents
     """
     try:
         retriever = company_policy_index.as_retriever()
         retrieved_nodes = retriever.retrieve(query)
-        
+
         if not retrieved_nodes:
             return "No relevant company policy information found for your query."
-        
+
         # Format the search results
         results = []
         for i, node in enumerate(retrieved_nodes[:3], 1):  # Limit to top 3 results
             results.append(f"Result {i}:")
             results.append(f"  Content: {node.text[:300]}...")
             results.append(f"  Relevance Score: {node.score:.4f}")
-            if hasattr(node.node, 'metadata'):
+            if hasattr(node.node, "metadata"):
                 metadata = node.node.metadata
-                if 'file_name' in metadata:
+                if "file_name" in metadata:
                     results.append(f"  Source: {metadata['file_name']}")
-                if 'page_label' in metadata:
+                if "page_label" in metadata:
                     results.append(f"  Page: {metadata['page_label']}")
             results.append("")
-        
+
         return "\n".join(results)
     except Exception as e:
         return f"Error searching company policy index: {str(e)}"
@@ -65,34 +64,34 @@ def search_company_policy(query: str) -> str:
 def search_personal_preferences(query: str) -> str:
     """
     Search the personal preferences index for user's travel preferences and requirements.
-    
+
     Args:
         query (str): The search query about personal travel preferences or requirements
-        
+
     Returns:
         str: Relevant information from personal preference documents
     """
     try:
         retriever = personal_preferences_index.as_retriever()
         retrieved_nodes = retriever.retrieve(query)
-        
+
         if not retrieved_nodes:
             return "No relevant personal preference information found for your query."
-        
+
         # Format the search results
         results = []
         for i, node in enumerate(retrieved_nodes[:3], 1):  # Limit to top 3 results
             results.append(f"Result {i}:")
             results.append(f"  Content: {node.text[:300]}...")
             results.append(f"  Relevance Score: {node.score:.4f}")
-            if hasattr(node.node, 'metadata'):
+            if hasattr(node.node, "metadata"):
                 metadata = node.node.metadata
-                if 'file_name' in metadata:
+                if "file_name" in metadata:
                     results.append(f"  Source: {metadata['file_name']}")
-                if 'page_label' in metadata:
+                if "page_label" in metadata:
                     results.append(f"  Page: {metadata['page_label']}")
             results.append("")
-        
+
         return "\n".join(results)
     except Exception as e:
         return f"Error searching personal preferences index: {str(e)}"
@@ -101,18 +100,18 @@ def search_personal_preferences(query: str) -> str:
 def get_travel_recommendation(query: str) -> str:
     """
     Get travel recommendations based on company policies and personal preferences.
-    
+
     Args:
         query (str): The travel-related query or request for recommendations
-        
+
     Returns:
         str: Travel recommendations combining policy and preference information
     """
     try:
         # Search both indexes for comprehensive information
         policy_info = search_company_policy(query)
         preference_info = search_personal_preferences(query)
-        
+
         recommendation = f"""
 Travel Recommendation Analysis:
 
@@ -124,22 +123,26 @@ def get_travel_recommendation(query: str) -> str:
 
 Based on the above information, here are the key considerations for your travel request.
         """
-        
+
         return recommendation.strip()
     except Exception as e:
         return f"Error generating travel recommendation: {str(e)}"
 
 
 # Create the FunctionAgent with our tools
 agent = FunctionAgent(
-    tools=[search_company_policy, search_personal_preferences, get_travel_recommendation],
+    tools=[
+        search_company_policy,
+        search_personal_preferences,
+        get_travel_recommendation,
+    ],
     llm=llm,
-    system_prompt="""You are a helpful travel assistant that can search through company travel policies and personal preferences to provide comprehensive travel guidance. 
+    system_prompt="""You are a helpful travel assistant that can search through company travel policies and personal preferences to provide comprehensive travel guidance.
 
 You have access to three main functions:
 1. search_company_policy - Search for company travel rates, guidelines, and policies
-2. search_personal_preferences - Search for user's personal travel preferences and requirements  
+2. search_personal_preferences - Search for user's personal travel preferences and requirements
 3. get_travel_recommendation - Get comprehensive travel recommendations combining both sources
 
-Use these tools to help users with travel-related queries, ensuring you provide accurate information from both company policies and personal preferences when relevant."""
-) 
+Use these tools to help users with travel-related queries, ensuring you provide accurate information from both company policies and personal preferences when relevant.""",
+)

src/uipath_llamaindex/_cli/_runtime/_runtime.py

@@ -2,7 +2,6 @@
 import logging
 import os
 import pickle
-from contextlib import suppress
 from typing import Optional, cast
 
 from llama_index.core.workflow import (
@@ -13,13 +12,6 @@
     WorkflowTimeoutError,
 )
 from llama_index.core.workflow.handler import WorkflowHandler  # type: ignore
-from openinference.instrumentation.llama_index import (
-    LlamaIndexInstrumentor,
-    get_current_span,
-)
-from opentelemetry import trace
-from opentelemetry.sdk.trace import TracerProvider
-from opentelemetry.sdk.trace.export import BatchSpanProcessor
 from uipath._cli._runtime._contracts import (
     UiPathBaseRuntime,
     UiPathErrorCategory,
@@ -28,9 +20,8 @@
     UiPathRuntimeStatus,
 )
 from uipath._cli._runtime._hitl import HitlProcessor, HitlReader
-from uipath.tracing import TracingManager
 
-from .._tracing._oteladapter import LlamaIndexExporter
+from .._utils._config import LlamaIndexConfig
 from ._context import UiPathLlamaIndexRuntimeContext
 from ._exception import UiPathLlamaIndexRuntimeError
 
@@ -58,19 +49,6 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
         """
         await self.validate()
 
-        self.trace_provider = TracerProvider()
-        self.tracer = self.trace_provider.get_tracer("uipath.llamaindex.runtime")
-
-        with suppress(Exception):
-            trace.set_tracer_provider(self.trace_provider)
-            self.trace_provider.add_span_processor(
-                BatchSpanProcessor(LlamaIndexExporter())
-            )
-
-            LlamaIndexInstrumentor().instrument(tracer_provider=self.trace_provider)
-
-            TracingManager.register_current_span_provider(get_current_span)
-
         try:
             if self.context.resume is False and self.context.job_id is None:
                 # Delete the previous graph state file at debug time
@@ -176,8 +154,6 @@ async def execute(self) -> Optional[UiPathRuntimeResult]:
                 detail,
                 UiPathErrorCategory.USER,
             ) from e
-        finally:
-            self.trace_provider.shutdown()
 
     async def validate(self) -> None:
         """Validate runtime inputs and load Llama agent configuration."""
@@ -193,12 +169,14 @@ async def validate(self) -> None:
             ) from e
 
         if self.context.config is None:
-            raise UiPathLlamaIndexRuntimeError(
-                "CONFIG_MISSING",
-                "Invalid configuration",
-                "Failed to load configuration",
-                UiPathErrorCategory.DEPLOYMENT,
-            )
+            self.context.config = LlamaIndexConfig()
+            if not self.context.config.exists:
+                raise UiPathLlamaIndexRuntimeError(
+                    "CONFIG_MISSING",
+                    "Invalid configuration",
+                    "Failed to load configuration",
+                    UiPathErrorCategory.DEPLOYMENT,
+                )
 
         try:
             self.context.config.load_config()

src/uipath_llamaindex/_cli/cli_dev.py

@@ -0,0 +1,41 @@
+import asyncio
+from typing import Optional
+
+from openinference.instrumentation.llama_index import (
+    LlamaIndexInstrumentor,
+    get_current_span,
+)
+from uipath._cli._dev._terminal import UiPathDevTerminal
+from uipath._cli._runtime._contracts import UiPathRuntimeFactory
+from uipath._cli._utils._console import ConsoleLogger
+from uipath._cli.middlewares import MiddlewareResult
+
+from ._runtime._context import UiPathLlamaIndexRuntimeContext
+from ._runtime._runtime import UiPathLlamaIndexRuntime
+
+console = ConsoleLogger()
+
+
+def llamaindex_dev_middleware(interface: Optional[str]) -> MiddlewareResult:
+    """Middleware to launch the developer terminal"""
+
+    try:
+        if interface == "terminal":
+            runtime_factory = UiPathRuntimeFactory(
+                UiPathLlamaIndexRuntime, UiPathLlamaIndexRuntimeContext
+            )
+            runtime_factory.add_instrumentor(LlamaIndexInstrumentor, get_current_span)
+            app = UiPathDevTerminal(runtime_factory)
+            asyncio.run(app.run_async())
+        else:
+            console.error(f"Unknown interface: {interface}")
+    except KeyboardInterrupt:
+        console.info("Debug session interrupted by user")
+    except Exception as e:
+        console.error(f"Error occurred: {e}")
+        return MiddlewareResult(
+            should_continue=False,
+            should_include_stacktrace=True,
+        )
+
+    return MiddlewareResult(should_continue=False)

src/uipath_llamaindex/_cli/cli_run.py

@@ -4,12 +4,17 @@
 from typing import Optional
 
 from dotenv import load_dotenv
-from uipath._cli._runtime._contracts import UiPathTraceContext
+from openinference.instrumentation.llama_index import (
+    LlamaIndexInstrumentor,
+    get_current_span,
+)
+from uipath._cli._runtime._contracts import UiPathRuntimeFactory, UiPathTraceContext
 from uipath._cli.middlewares import MiddlewareResult
 
 from ._runtime._context import UiPathLlamaIndexRuntimeContext
 from ._runtime._exception import UiPathLlamaIndexRuntimeError
 from ._runtime._runtime import UiPathLlamaIndexRuntime
+from ._tracing._oteladapter import LlamaIndexExporter
 from ._utils._config import LlamaIndexConfig
 
 logger = logging.getLogger(__name__)
@@ -60,8 +65,16 @@ async def execute():
             env["UIPATH_REQUESTING_PRODUCT"] = "uipath-python-sdk"
             env["UIPATH_REQUESTING_FEATURE"] = "llamaindex"
 
-            async with UiPathLlamaIndexRuntime.from_context(context) as runtime:
-                await runtime.execute()
+            runtime_factory = UiPathRuntimeFactory(
+                UiPathLlamaIndexRuntime, UiPathLlamaIndexRuntimeContext
+            )
+
+            if context.job_id:
+                runtime_factory.add_span_exporter(LlamaIndexExporter())
+
+            runtime_factory.add_instrumentor(LlamaIndexInstrumentor, get_current_span)
+
+            await runtime_factory.execute(context)
 
         asyncio.run(execute())
 

src/uipath_llamaindex/middlewares.py

@@ -1,5 +1,6 @@
 from uipath._cli.middlewares import Middlewares
 
+from ._cli.cli_dev import llamaindex_dev_middleware
 from ._cli.cli_init import llamaindex_init_middleware
 from ._cli.cli_new import llamaindex_new_middleware
 from ._cli.cli_run import llamaindex_run_middleware
@@ -10,3 +11,4 @@ def register_middleware():
     Middlewares.register("init", llamaindex_init_middleware)
     Middlewares.register("run", llamaindex_run_middleware)
     Middlewares.register("new", llamaindex_new_middleware)
+    Middlewares.register("dev", llamaindex_dev_middleware)