uipath 2.0.74__py3-none-any.whl → 2.0.75__py3-none-any.whl

uipath/_services/llm_gateway_service.py

@@ -10,9 +10,9 @@ from ..models.llm_gateway import (
     TextEmbedding,
     ToolChoice,
     ToolDefinition,
-    UsageInfo,
 )
 from ..tracing._traced import traced
+from ..utils import EndpointManager
 from ._base_service import BaseService
 
 # Common constants
@@ -54,36 +54,12 @@ class UiPathOpenAIService(BaseService):
     def __init__(self, config: Config, execution_context: ExecutionContext) -> None:
         super().__init__(config=config, execution_context=execution_context)
 
-    @traced(name="llm_embeddings_usage", run_type="uipath")
-    async def embeddings_usage(
-        self, input: str, embedding_model: str = EmbeddingModels.text_embedding_ada_002
-    ):
-        """Embedd the input text using llm gateway service.
-
-        Args:
-            input (str): The input text to embedd.
-            embedding_model (str, optional): The embedding model to use. Defaults to text-embedding-ada-002.
-
-        Returns:
-            EmbeddingUsageInfo: The embedding usage information.
-        """
-        endpoint = Endpoint(
-            f"/llmgateway_/openai/deployments/{embedding_model}/embeddings/usage"
-        )
-
-        response = await self.request_async(
-            "POST",
-            endpoint,
-            content=json.dumps({"input": input}),
-            params={"api-version": API_VERSION},
-            headers=DEFAULT_LLM_HEADERS,
-        )
-
-        return UsageInfo.model_validate(response.json())
-
     @traced(name="llm_embeddings", run_type="uipath")
     async def embeddings(
-        self, input: str, embedding_model: str = EmbeddingModels.text_embedding_ada_002
+        self,
+        input: str,
+        embedding_model: str = EmbeddingModels.text_embedding_ada_002,
+        openai_api_version: str = API_VERSION,
     ):
         """Embed the input text using llm gateway service.
 
@@ -93,9 +69,10 @@ class UiPathOpenAIService(BaseService):
         Returns:
             TextEmbedding: The embedding response.
         """
-        endpoint = Endpoint(
-            f"/llmgateway_/openai/deployments/{embedding_model}/embeddings"
+        endpoint = EndpointManager.get_embeddings_endpoint().format(
+            model=embedding_model, api_version=openai_api_version
         )
+        endpoint = Endpoint("/" + endpoint)
 
         response = await self.request_async(
             "POST",
@@ -114,6 +91,7 @@ class UiPathOpenAIService(BaseService):
         model: str = ChatModels.gpt_4o_mini_2024_07_18,
         max_tokens: int = 50,
         temperature: float = 0,
+        api_version: str = API_VERSION,
     ):
         """Get chat completions using llm gateway service.
 
@@ -139,59 +117,10 @@ class UiPathOpenAIService(BaseService):
         Returns:
             ChatCompletion: The chat completion response.
         """
-        endpoint = Endpoint(f"/llmgateway_/openai/deployments/{model}/chat/completions")
-
-        request_body = {
-            "messages": messages,
-            "max_tokens": max_tokens,
-            "temperature": temperature,
-        }
-
-        response = await self.request_async(
-            "POST",
-            endpoint,
-            content=json.dumps(request_body),
-            params={"api-version": API_VERSION},
-            headers=DEFAULT_LLM_HEADERS,
-        )
-
-        return ChatCompletion.model_validate(response.json())
-
-    @traced(name="llm_chat_completions_usage", run_type="uipath")
-    async def chat_completions_usage(
-        self,
-        messages: List[Dict[str, str]],
-        model: str = ChatModels.gpt_4o_mini_2024_07_18,
-        max_tokens: int = 50,
-        temperature: float = 0,
-    ):
-        """Get chat completions usage using llm gateway service.
-
-        Args:
-            messages (List[Dict[str, str]]): List of message dictionaries with 'role' and 'content' keys.
-                The supported roles are 'system', 'user', and 'assistant'.
-
-        Example:
-                ```
-                [
-                    {"role": "system", "content": "You are a helpful Python programming assistant."},
-                    {"role": "user", "content": "How do I read a file in Python?"},
-                    {"role": "assistant", "content": "You can use the built-in open() function."},
-                    {"role": "user", "content": "Can you show an example?"}
-                ]
-                ```
-                The conversation history can be included to provide context to the model.
-            model (str, optional): The model to use for chat completion. Defaults to ChatModels.gpt_4o_mini_2024_07_18.
-            max_tokens (int, optional): Maximum number of tokens to generate. Defaults to 50.
-            temperature (float, optional): Temperature for sampling, between 0 and 1.
-                Lower values make output more deterministic. Defaults to 0.
-
-        Returns:
-            ChatCompletion: The chat completion usage response.
-        """
-        endpoint = Endpoint(
-            f"/llmgateway_/openai/deployments/{model}/chat/completions/usage"
+        endpoint = EndpointManager.get_passthrough_endpoint().format(
+            model=model, api_version=api_version
         )
+        endpoint = Endpoint("/" + endpoint)
 
         request_body = {
             "messages": messages,
@@ -207,7 +136,7 @@ class UiPathOpenAIService(BaseService):
             headers=DEFAULT_LLM_HEADERS,
         )
 
-        return UsageInfo.model_validate(response.json())
+        return ChatCompletion.model_validate(response.json())
 
 
 class UiPathLlmChatService(BaseService):
@@ -229,6 +158,7 @@ class UiPathLlmChatService(BaseService):
         top_p: float = 1,
         tools: Optional[List[ToolDefinition]] = None,
         tool_choice: Optional[ToolChoice] = None,
+        api_version: str = NORMALIZED_API_VERSION,
     ):
         """Get chat completions using UiPath's normalized LLM Gateway API.
 
@@ -250,7 +180,10 @@ class UiPathLlmChatService(BaseService):
         Returns:
             ChatCompletion: The chat completion response.
         """
-        endpoint = Endpoint("/llmgateway_/api/chat/completions")
+        endpoint = EndpointManager.get_normalized_endpoint().format(
+            model=model, api_version=api_version
+        )
+        endpoint = Endpoint("/" + endpoint)
 
         request_body = {
             "messages": messages,

uipath/models/llm_gateway.py

@@ -21,11 +21,6 @@ class TextEmbedding(BaseModel):
     usage: EmbeddingUsage
 
 
-class UsageInfo(BaseModel):
-    encoding: str
-    prompt_tokens: int
-
-
 class ToolCall(BaseModel):
     id: str
     name: str

uipath/utils/__init__.py

@@ -0,0 +1,5 @@
+from ._endpoints_manager import EndpointManager  # noqa: D104
+
+__all__ = [
+    "EndpointManager",
+]

uipath/utils/_endpoints_manager.py

@@ -0,0 +1,88 @@
+import logging
+import os
+from enum import Enum
+from typing import Optional
+
+import httpx
+
+loggger = logging.getLogger(__name__)
+
+
+class UiPathEndpoints(Enum):
+    AH_NORMALIZED_COMPLETION_ENDPOINT = "agenthub_/llm/api/chat/completions"
+    AH_PASSTHROUGH_COMPLETION_ENDPOINT = "agenthub_/llm/openai/deployments/{model}/chat/completions?api-version={api_version}"
+    AH_EMBEDDING_ENDPOINT = (
+        "agenthub_/llm/openai/deployments/{model}/embeddings?api-version={api_version}"
+    )
+    AH_CAPABILITIES_ENDPOINT = "agenthub_/llm/api/capabilities"
+
+    NORMALIZED_COMPLETION_ENDPOINT = "llmgateway_/api/chat/completions"
+    PASSTHROUGH_COMPLETION_ENDPOINT = "llmgateway_/openai/deployments/{model}/chat/completions?api-version={api_version}"
+    EMBEDDING_ENDPOINT = (
+        "llmgateway_/openai/deployments/{model}/embeddings?api-version={api_version}"
+    )
+
+
+class EndpointManager:
+    """Manages and caches the UiPath endpoints.
+    This class provides functionality to determine which UiPath endpoints to use based on
+    the availability of AgentHub. It checks for AgentHub capabilities and caches the result
+    to avoid repeated network calls.
+    Class Attributes:
+        _base_url (str): The base URL for UiPath services, retrieved from the UIPATH_URL
+                         environment variable.
+        _agenthub_available (Optional[bool]): Cached result of AgentHub availability check.
+
+    Methods:
+        is_agenthub_available(): Checks if AgentHub is available, caching the result.
+        get_passthrough_endpoint(): Returns the appropriate passthrough completion endpoint.
+        get_normalized_endpoint(): Returns the appropriate normalized completion endpoint.
+        get_embeddings_endpoint(): Returns the appropriate embeddings endpoint.
+    All endpoint methods automatically select between AgentHub and standard endpoints
+    based on availability.
+    """  # noqa: D205
+
+    _base_url = os.getenv("UIPATH_URL", "")
+    _agenthub_available: Optional[bool] = None
+
+    @classmethod
+    def is_agenthub_available(cls) -> bool:
+        """Check if AgentHub is available and cache the result."""
+        if cls._agenthub_available is None:
+            cls._agenthub_available = cls._check_agenthub()
+        return cls._agenthub_available
+
+    @classmethod
+    def _check_agenthub(cls) -> bool:
+        """Perform the actual check for AgentHub capabilities."""
+        try:
+            with httpx.Client() as http_client:
+                base_url = os.getenv("UIPATH_URL", "")
+                capabilities_url = f"{base_url.rstrip('/')}/{UiPathEndpoints.AH_CAPABILITIES_ENDPOINT.value}"
+                loggger.debug(f"Checking AgentHub capabilities at {capabilities_url}")
+                response = http_client.get(capabilities_url)
+                return response.status_code == 200
+        except Exception as e:
+            loggger.error(f"Error checking AgentHub capabilities: {e}", exc_info=True)
+            return False
+
+    @classmethod
+    def get_passthrough_endpoint(cls) -> str:
+        if cls.is_agenthub_available():
+            return UiPathEndpoints.AH_PASSTHROUGH_COMPLETION_ENDPOINT.value
+
+        return UiPathEndpoints.PASSTHROUGH_COMPLETION_ENDPOINT.value
+
+    @classmethod
+    def get_normalized_endpoint(cls) -> str:
+        if cls.is_agenthub_available():
+            return UiPathEndpoints.AH_NORMALIZED_COMPLETION_ENDPOINT.value
+
+        return UiPathEndpoints.NORMALIZED_COMPLETION_ENDPOINT.value
+
+    @classmethod
+    def get_embeddings_endpoint(cls) -> str:
+        if cls.is_agenthub_available():
+            return UiPathEndpoints.AH_EMBEDDING_ENDPOINT.value
+
+        return UiPathEndpoints.EMBEDDING_ENDPOINT.value

{uipath-2.0.74.dist-info → uipath-2.0.75.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: uipath
-Version: 2.0.74
+Version: 2.0.75
 Summary: Python SDK and CLI for UiPath Platform, enabling programmatic interaction with automation services, process management, and deployment tools.
 Project-URL: Homepage, https://uipath.com
 Project-URL: Repository, https://github.com/UiPath/uipath-python

{uipath-2.0.74.dist-info → uipath-2.0.75.dist-info}/RECORD

@@ -56,7 +56,7 @@ uipath/_services/connections_service.py,sha256=qh-HNL_GJsyPUD0wSJZRF8ZdrTE9l4HrI
 uipath/_services/context_grounding_service.py,sha256=EBf7lIIYz_s1ubf_07OAZXQHjS8kpZ2vqxo4mI3VL-A,25009
 uipath/_services/folder_service.py,sha256=9JqgjKhWD-G_KUnfUTP2BADxL6OK9QNZsBsWZHAULdE,2749
 uipath/_services/jobs_service.py,sha256=CnDd7BM4AMqcMIR1qqu5ohhxf9m0AF4dnGoF4EX38kw,30872
-uipath/_services/llm_gateway_service.py,sha256=ySg3sflIoXmY9K7txlSm7bkuI2qzBT0kAKmGlFBk5KA,12032
+uipath/_services/llm_gateway_service.py,sha256=ZdKRLdEVL8Zkcl9NDT5AKADxnjqeMIuOe5H2Oy7hYKw,9421
 uipath/_services/processes_service.py,sha256=b-c4ynjcgS0ymp130r0lI93z7DF989u8HWOmWCux754,5727
 uipath/_services/queues_service.py,sha256=VaG3dWL2QK6AJBOLoW2NQTpkPfZjsqsYPl9-kfXPFzA,13534
 uipath/_utils/__init__.py,sha256=VdcpnENJIa0R6Y26NoxY64-wUVyvb4pKfTh1wXDQeMk,526
@@ -83,7 +83,7 @@ uipath/models/errors.py,sha256=gPyU4sKYn57v03aOVqm97mnU9Do2e7bwMQwiSQVp9qc,461
 uipath/models/exceptions.py,sha256=jav4egsVRfC1jN_FLnV7FVgWZapSepSKZQCxMe94Pac,590
 uipath/models/interrupt_models.py,sha256=UzuVTMVesI204YQ4qFQFaN-gN3kksddkrujofcaC7zQ,881
 uipath/models/job.py,sha256=f9L6_kg_VP0dAYvdcz1DWEWzy4NZPdlpHREod0uNK1E,3099
-uipath/models/llm_gateway.py,sha256=0sl5Wtve94V14H3AHwmJSoXAhoc-Fai3wJxP8HrnBPg,1994
+uipath/models/llm_gateway.py,sha256=rUIus7BrUuuRriXqSJUE9FnjOyQ7pYpaX6hWEYvA6AA,1923
 uipath/models/processes.py,sha256=Atvfrt6X4TYST3iA62jpS_Uxc3hg6uah11p-RaKZ6dk,2029
 uipath/models/queues.py,sha256=N_s0GKucbyjh0RnO8SxPk6wlRgvq8KIIYsfaoIY46tM,6446
 uipath/telemetry/__init__.py,sha256=Wna32UFzZR66D-RzTKlPWlvji9i2HJb82NhHjCCXRjY,61
@@ -93,8 +93,10 @@ uipath/tracing/__init__.py,sha256=GKRINyWdHVrDsI-8mrZDLdf0oey6GHGlNZTOADK-kgc,22
 uipath/tracing/_otel_exporters.py,sha256=x0PDPmDKJcxashsuehVsSsqBCzRr6WsNFaq_3_HS5F0,3014
 uipath/tracing/_traced.py,sha256=qeVDrds2OUnpdUIA0RhtF0kg2dlAZhyC1RRkI-qivTM,18528
 uipath/tracing/_utils.py,sha256=ZeensQexnw69jVcsVrGyED7mPlAU-L1agDGm6_1A3oc,10388
-uipath-2.0.74.dist-info/METADATA,sha256=7nWW75xzek2vV6C_UQZiJKFUMFkwdxDP58_y3FYn-n0,6462
-uipath-2.0.74.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-uipath-2.0.74.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
-uipath-2.0.74.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
-uipath-2.0.74.dist-info/RECORD,,
+uipath/utils/__init__.py,sha256=VD-KXFpF_oWexFg6zyiWMkxl2HM4hYJMIUDZ1UEtGx0,105
+uipath/utils/_endpoints_manager.py,sha256=zcOsYwyoRzDuvdhdHwNabrqXRqC6e5J_GdEOriT7Dek,3768
+uipath-2.0.75.dist-info/METADATA,sha256=uAREv1kvwTRpAZSOumymODhJBi_oIWm8uR1Krr1UMM0,6462
+uipath-2.0.75.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+uipath-2.0.75.dist-info/entry_points.txt,sha256=9C2_29U6Oq1ExFu7usihR-dnfIVNSKc-0EFbh0rskB4,43
+uipath-2.0.75.dist-info/licenses/LICENSE,sha256=-KBavWXepyDjimmzH5fVAsi-6jNVpIKFc2kZs0Ri4ng,1058
+uipath-2.0.75.dist-info/RECORD,,