feat(chat): add keys to bridge

Made-with: Cursor

Author: scottcmg

pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "uipath"
-version = "2.9.9"
+version = "2.10.1"
 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"
 dependencies = [
   "uipath-core>=0.5.2, <0.6.0",
   "uipath-runtime>=0.9.1, <0.10.0",
-  "uipath-platform>=0.0.2, <0.1.0",
+  "uipath-platform>=0.0.4, <0.1.0",
   "click>=8.3.1",
   "httpx>=0.28.1",
   "pyjwt>=2.10.1",

samples/calculator/evaluations/eval-sets/eval-level-expected-output-llm-judge.json

@@ -0,0 +1,45 @@
+{
+  "version": "1.0",
+  "id": "EvalLevelExpectedOutputLLMJudgeSet",
+  "name": "Evaluation-Level expectedOutput with LLM Judge",
+  "evaluatorRefs": [
+    "ExactMatchEvaluator",
+    "LLMJudgeOutputEvaluator"
+  ],
+  "evaluations": [
+    {
+      "id": "eval-level-llm-judge-add",
+      "name": "LLM Judge uses eval-level expectedOutput (addition)",
+      "inputs": {
+        "a": 3,
+        "b": 7,
+        "operator": "+"
+      },
+      "expectedOutput": {
+        "result": 10.0
+      },
+      "expectedAgentBehavior": "The agent should correctly add the two numbers and return the result.",
+      "evaluationCriterias": {
+        "ExactMatchEvaluator": null,
+        "LLMJudgeOutputEvaluator": null
+      }
+    },
+    {
+      "id": "eval-level-llm-judge-multiply",
+      "name": "LLM Judge uses eval-level expectedOutput (multiplication)",
+      "inputs": {
+        "a": 6,
+        "b": 8,
+        "operator": "*"
+      },
+      "expectedOutput": {
+        "result": 48.0
+      },
+      "expectedAgentBehavior": "The agent should correctly multiply the two numbers and return the result.",
+      "evaluationCriterias": {
+        "ExactMatchEvaluator": null,
+        "LLMJudgeOutputEvaluator": null
+      }
+    }
+  ]
+}

samples/calculator/evaluations/eval-sets/eval-level-expected-output.json

@@ -0,0 +1,100 @@
+{
+  "version": "1.0",
+  "id": "EvalLevelExpectedOutputSet",
+  "name": "Evaluation-Level expectedOutput Tests",
+  "evaluatorRefs": [
+    "ExactMatchEvaluator",
+    "JsonSimilarityEvaluator",
+    "ContainsEvaluator"
+  ],
+  "evaluations": [
+    {
+      "id": "eval-level-null-criteria-add",
+      "name": "Eval-level expectedOutput with null criteria (addition)",
+      "inputs": {
+        "a": 2,
+        "b": 3,
+        "operator": "+"
+      },
+      "expectedOutput": {
+        "result": 5.0
+      },
+      "evaluationCriterias": {
+        "ExactMatchEvaluator": null,
+        "JsonSimilarityEvaluator": null,
+        "ContainsEvaluator": {
+          "searchText": "5"
+        }
+      }
+    },
+    {
+      "id": "eval-level-null-criteria-multiply",
+      "name": "Eval-level expectedOutput with null criteria (multiplication)",
+      "inputs": {
+        "a": 4,
+        "b": 5,
+        "operator": "*"
+      },
+      "expectedOutput": {
+        "result": 20.0
+      },
+      "evaluationCriterias": {
+        "ExactMatchEvaluator": null,
+        "JsonSimilarityEvaluator": null,
+        "ContainsEvaluator": {
+          "searchText": "20"
+        }
+      }
+    },
+    {
+      "id": "eval-level-per-evaluator-override",
+      "name": "Per-evaluator expectedOutput overrides eval-level",
+      "inputs": {
+        "a": 10,
+        "b": 5,
+        "operator": "-"
+      },
+      "expectedOutput": {
+        "result": 5.0
+      },
+      "evaluationCriterias": {
+        "ExactMatchEvaluator": {
+          "expectedOutput": {
+            "result": 5.0
+          }
+        },
+        "JsonSimilarityEvaluator": {
+          "expectedOutput": {
+            "result": 5.0
+          }
+        },
+        "ContainsEvaluator": {
+          "searchText": "5"
+        }
+      }
+    },
+    {
+      "id": "eval-level-mixed-null-and-explicit",
+      "name": "Mixed: some evaluators null, some explicit",
+      "inputs": {
+        "a": 7,
+        "b": 3,
+        "operator": "+"
+      },
+      "expectedOutput": {
+        "result": 10.0
+      },
+      "evaluationCriterias": {
+        "ExactMatchEvaluator": null,
+        "JsonSimilarityEvaluator": {
+          "expectedOutput": {
+            "result": 10.0
+          }
+        },
+        "ContainsEvaluator": {
+          "searchText": "10"
+        }
+      }
+    }
+  ]
+}

src/uipath/_cli/__init__.py

@@ -9,6 +9,17 @@
 from uipath._utils._logs import setup_logging
 from uipath._utils.constants import DOTENV_FILE
 
+# Windows console uses codepages (e.g. cp1252) that can't encode Unicode
+# characters used by Rich spinners (Braille) and emoji output.
+# When piped (not a TTY), keep the system encoding so the parent process
+# can decode our output, but use errors="replace" to avoid write-side crashes.
+if sys.platform == "win32":
+    for _stream in (sys.stdout, sys.stderr):
+        if hasattr(_stream, "reconfigure"):
+            if _stream.isatty():
+                _stream.reconfigure(encoding="utf-8")
+            else:
+                _stream.reconfigure(errors="replace")
 # DO NOT ADD HEAVY IMPORTS HERE
 #
 # Every import at the top of this file runs on EVERY command.

src/uipath/_cli/_chat/_bridge.py

@@ -8,6 +8,10 @@
 from typing import Any
 from urllib.parse import urlencode, urlparse
 
+from uipath._utils.constants import (
+    ENV_FOLDER_KEY,
+    ENV_JOB_KEY,
+)
 from uipath.core.chat import (
     UiPathConversationEvent,
     UiPathConversationExchangeEndEvent,
@@ -18,10 +22,6 @@
     UiPathConversationToolCallConfirmationInterruptStartEvent,
     UiPathConversationToolCallConfirmationValue,
 )
-from uipath._utils.constants import (
-    ENV_FOLDER_KEY,
-    ENV_JOB_KEY,
-)
 from uipath.core.triggers import UiPathResumeTrigger
 from uipath.runtime.chat import UiPathChatProtocol
 from uipath.runtime.context import UiPathRuntimeContext

src/uipath/_cli/cli_init.py

@@ -369,7 +369,7 @@ async def initialize() -> list[UiPathRuntimeSchema]:
 
                     if not entrypoints:
                         console.warning(
-                            'No function entrypoints found. Add them to `uipath.json` under "functions": {"my_function": "src/main.py:main"}'
+                            'No entrypoints found. Add them to `uipath.json` under "functions" or "agents": {"my_function": "src/main.py:main"}'
                         )
 
                     # Gather schemas from all discovered runtimes

src/uipath/_cli/models/uipath_json_schema.py

@@ -89,6 +89,12 @@ class UiPathJsonConfig(BaseModelWithDefaultConfig):
         "Each key is an entrypoint name, and each value is a path in format 'file_path:function_name'",
     )
 
+    agents: dict[str, str] = Field(
+        default_factory=dict,
+        description="Entrypoint definitions for agent scripts. "
+        "Each key is an entrypoint name, and each value is a path in format 'file_path:agent_name'",
+    )
+
     def to_json_string(self, indent: int = 2) -> str:
         """Export to JSON string with proper formatting."""
         return self.model_dump_json(
@@ -110,6 +116,7 @@ def create_default(cls) -> "UiPathJsonConfig":
                 include_uv_lock=True,
             ),
             functions={},
+            agents={},
         )
 
     @classmethod

src/uipath/agent/models/agent.py

@@ -361,10 +361,10 @@ class AgentContextSettings(BaseCfg):
     query: AgentContextQuerySetting = Field(
         default_factory=lambda: AgentContextQuerySetting(variant="dynamic")
     )
-    folder_path_prefix: Optional[Union[Dict[str, Any], AgentContextValueSetting]] = (
-        Field(None, alias="folderPathPrefix")
+    folder_path_prefix: Optional[AgentContextQuerySetting] = Field(
+        None, alias="folderPathPrefix"
     )
-    file_extension: Optional[Union[Dict[str, Any], AgentContextValueSetting]] = Field(
+    file_extension: Optional[AgentContextValueSetting] = Field(
         None, alias="fileExtension"
     )
     citation_mode: Optional[AgentContextValueSetting] = Field(

src/uipath/agent/react/conversational_prompts.py

@@ -83,23 +83,26 @@ class PromptUserSettings(BaseModel):
 - Any information drawn from Context Grounding documents.
 
 CITATION FORMAT (self-closing tag after each sentence with cited information):
-<uip:cite title="Document Title" reference="https://url" page_number="1"/>
+- Web results: <uip:cite title="Document Title" url="https://url"/>
+- Context Grounding: <uip:cite title="Document Title" reference="https://url" page_number="1"/>
 
 TOOL RESULT PATTERNS REQUIRING CITATION:
 Tool results containing these fields indicate citable sources:
-- Web results: "url", "title" fields -> use title and url attributes
-- Context Grounding: objects with "reference", "source", "page_number" -> use title (from source), reference, page_number attributes
+- Web results: "url", "title" fields -> use url, title attributes
+- Context Grounding: objects with "reference", "source", "page_number" -> use reference, title (from source), page_number attributes
 
 RULES:
 - Place citation tag immediately after the sentence containing the cited fact
 - title attribute is required (truncate to 48 chars if needed)
 - For web results: use title and url attributes
 - For context grounding: use title, reference, and page_number attributes
 - Never include citations in tool inputs
+- Do not mix attributes between citation types: web results use only title/url, context grounding uses only title/reference/page_number
+- Do not add a space before the citation tag
 
 EXAMPLES OF CORRECT USAGE:
-AI adoption is growing rapidly. <uip:cite title="Industry Study" url="https://example.com/study"/>
-The procedure requires manager approval. <uip:cite title="Policy Manual v2.pdf" reference="https://docs.example.com/ref" page_number="15"/>
+AI adoption is growing rapidly.<uip:cite title="Industry Study" url="https://example.com/study"/>
+The procedure requires manager approval.<uip:cite title="Policy Manual v2.pdf" reference="https://docs.example.com/ref" page_number="15"/>
 
 CRITICAL ERRORS TO AVOID:
 <uip:cite/> (missing attributes)

src/uipath/eval/helpers.py

@@ -152,7 +152,7 @@ def migrate_evaluation_item(
                             evaluation.conversational_inputs
                         )
                         evaluation.inputs["messages"] = [
-                            message.model_dump(by_alias=True)
+                            message.model_dump(by_alias=True, exclude_none=True)
                             for message in conversational_messages_input
                         ]
 
@@ -163,7 +163,7 @@ def migrate_evaluation_item(
                         evaluation.expected_output[
                             "uipath__agent_response_messages"
                         ] = [
-                            message.model_dump(by_alias=True)
+                            message.model_dump(by_alias=True, exclude_none=True)
                             for message in conversational_messages_expected_output
                         ]