feat: add byom_properties to agent model (#1097)

Author: andreiancuta-uipath

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "uipath"
-version = "2.4.11"
+version = "2.4.12"
 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"

src/uipath/agent/models/agent.py

@@ -765,13 +765,21 @@ def normalize_role(cls, v: Any) -> Any:
         return v.lower() if isinstance(v, str) else v
 
 
+class AgentByomProperties(BaseCfg):
+    """Agent byom properties model."""
+
+    connection_id: str = Field(alias="connectionId")
+    connector_key: str = Field(alias="connectorKey")
+
+
 class AgentSettings(BaseCfg):
     """Agent settings model."""
 
     engine: str
     model: str
     max_tokens: int = Field(..., alias="maxTokens")
     temperature: float
+    byom_properties: Optional[AgentByomProperties] = Field(None, alias="byomProperties")
 
 
 class AgentDefinition(BaseModel):

tests/agent/models/test_agent.py

@@ -100,6 +100,10 @@ def test_agent_with_all_tool_types_loads(self):
                 "maxTokens": 16384,
                 "temperature": 0,
                 "engine": "basic-v1",
+                "byomProperties": {
+                    "connectionId": "test-byom-connection-id",
+                    "connectorKey": "uipath-openai-openai",
+                },
             },
             "resources": [
                 {
@@ -455,6 +459,11 @@ def test_agent_with_all_tool_types_loads(self):
         assert len(config.resources) == 8  # All tool types + escalation + context + mcp
         assert config.settings.engine == "basic-v1"
         assert config.settings.max_tokens == 16384
+        assert config.settings.byom_properties is not None
+        assert (
+            config.settings.byom_properties.connection_id == "test-byom-connection-id"
+        )
+        assert config.settings.byom_properties.connector_key == "uipath-openai-openai"
 
         # Validate resource types
         resource_types = [resource.resource_type for resource in config.resources]