fix: use messages in the schema

cosmyo · cosmyo · commit 5b62cc4be05e · 2026-01-23T03:10:18.000+02:00
diff --git a/packages/uipath-openai-agents/docs/quick_start.md b/packages/uipath-openai-agents/docs/quick_start.md
@@ -106,7 +106,7 @@ Generate your first UiPath OpenAI agent:
 ✓  Created 'pyproject.toml' file.
 🔧  Please ensure to define OPENAI_API_KEY in your .env file.
 💡  Initialize project: uipath init
-💡  Run agent: uipath run agent '{"message": "Hello"}'
+💡  Run agent: uipath run agent '{"messages": "Hello"}'
 ```
 
 This command creates the following files:
@@ -173,7 +173,7 @@ Execute the agent with a sample input:
 <!-- termynal -->
 
 ```shell
-> uipath run agent '{"message": "Hello"}'
+> uipath run agent '{"messages": "Hello"}'
 {'response': 'Hello! How can I help you today?', 'agent_used': 'main'}
 ✓  Successful execution.
 ```
@@ -185,19 +185,19 @@ Depending on the shell you are using, it may be necessary to escape the input js
 
 /// tab | Bash/ZSH/PowerShell
 ```console
-uipath run agent '{"message": "Hello"}'
+uipath run agent '{"messages": "Hello"}'
 ```
 ///
 
 /// tab | Windows CMD
 ```console
-uipath run agent "{""message"": ""Hello""}"
+uipath run agent "{""messages"": ""Hello""}"
 ```
 ///
 
 /// tab | Windows PowerShell
 ```console
-uipath run agent '{\"message\":\"Hello\"}'
+uipath run agent '{\"messages\":\"Hello\"}'
 ```
 ///
 
@@ -215,7 +215,7 @@ The `run` command can also take a .json file as an input. You can create a file
 
 ```json
 {
-  "message": "Hello"
+  "messages": "Hello"
 }
 ```
 
@@ -275,7 +275,7 @@ Set the environment variables using the provided link.
 <!-- termynal -->
 
 ```shell
-> uipath invoke agent '{"message": "Hello"}'
+> uipath invoke agent '{"messages": "Hello"}'
 ⠴ Loading configuration ...
 ⠴ Starting job ...
 ✨ Job started successfully!
diff --git a/packages/uipath-openai-agents/samples/agent-as-tools/input.json b/packages/uipath-openai-agents/samples/agent-as-tools/input.json
@@ -1,3 +1,3 @@
 {
-  "message": "Tell me a joke"
+  "messages": "Tell me a joke"
 }
diff --git a/packages/uipath-openai-agents/samples/rag-assistant/entry-points.json b/packages/uipath-openai-agents/samples/rag-assistant/entry-points.json
@@ -9,7 +9,7 @@
             "input": {
                 "type": "object",
                 "properties": {
-                    "message": {
+                    "messages": {
                         "anyOf": [
                             {
                                 "type": "string"
@@ -21,12 +21,12 @@
                                 }
                             }
                         ],
-                        "title": "Message",
-                        "description": "User message(s) to send to the agent"
+                        "title": "Messages",
+                        "description": "User messages to send to the agent"
                     }
                 },
                 "required": [
-                    "message"
+                    "messages"
                 ]
             },
             "output": {
diff --git a/packages/uipath-openai-agents/samples/rag-assistant/input.json b/packages/uipath-openai-agents/samples/rag-assistant/input.json
@@ -1,3 +1,3 @@
 {
-  "message": "Who is the best ai llm?"
+  "messages": "Who is the best ai llm?"
 }
diff --git a/packages/uipath-openai-agents/samples/triage-agent/README.md b/packages/uipath-openai-agents/samples/triage-agent/README.md
@@ -29,13 +29,13 @@ In this pattern:
 
 ```bash
 # Spanish message
-uipath run main '{"message": "Hola, ¿cómo estás?"}'
+uipath run main '{"messages": "Hola, ¿cómo estás?"}'
 
 # French message
-uipath run main '{"message": "Bonjour, comment allez-vous?"}'
+uipath run main '{"messages": "Bonjour, comment allez-vous?"}'
 
 # English message
-uipath run main '{"message": "Hello, how are you?"}'
+uipath run main '{"messages": "Hello, how are you?"}'
 ```
 
 ### Configure in openai_agents.json
@@ -53,7 +53,7 @@ uipath run main '{"message": "Hello, how are you?"}'
 ### Input
 ```python
 class Input(BaseModel):
-    message: str  # User message in any language
+    messages: str  # User message in any language
 ```
 
 ### Output
@@ -66,7 +66,7 @@ class Output(BaseModel):
 ## Example Execution
 
 ```bash
-$ uipath run main '{"message": "Hola, ¿cómo estás?"}'
+$ uipath run main '{"messages": "Hola, ¿cómo estás?"}'
 
 Processing message: Hola, ¿cómo estás?
 ¡Hola! Estoy muy bien, gracias. ¿Y tú, cómo estás?
diff --git a/packages/uipath-openai-agents/samples/triage-agent/entry-points.json b/packages/uipath-openai-agents/samples/triage-agent/entry-points.json
@@ -9,7 +9,7 @@
             "input": {
                 "type": "object",
                 "properties": {
-                    "message": {
+                    "messages": {
                         "anyOf": [
                             {
                                 "type": "string"
@@ -21,12 +21,12 @@
                                 }
                             }
                         ],
-                        "title": "Message",
-                        "description": "User message(s) to send to the agent"
+                        "title": "Messages",
+                        "description": "User messages to send to the agent"
                     }
                 },
                 "required": [
-                    "message"
+                    "messages"
                 ]
             },
             "output": {
diff --git a/packages/uipath-openai-agents/samples/triage-agent/input.json b/packages/uipath-openai-agents/samples/triage-agent/input.json
@@ -1,3 +1,3 @@
 {
-  "message": "une blague."
+  "messages": "une blague."
 }
diff --git a/packages/uipath-openai-agents/src/uipath_openai_agents/_cli/_templates/AGENTS.md.template b/packages/uipath-openai-agents/src/uipath_openai_agents/_cli/_templates/AGENTS.md.template
@@ -18,4 +18,4 @@ This documentation is split into multiple files for efficient context loading. L
 
 3. **@.agent/CLI_REFERENCE.md** - CLI commands documentation
    - **When to load:** Working with `uipath init`, `uipath run agent`, or deployment commands
-   - **Contains:** Command syntax for OpenAI agents, options, input formats (`{"message": "..."}` or `{"messages": [...]}`), debug mode, usage examples
+   - **Contains:** Command syntax for OpenAI agents, options, input formats (`{"messages": "..."}` or `{"messages": [...]}`), debug mode, usage examples
diff --git a/packages/uipath-openai-agents/src/uipath_openai_agents/_cli/cli_new.py b/packages/uipath-openai-agents/src/uipath_openai_agents/_cli/cli_new.py
@@ -63,7 +63,7 @@ def openai_agents_new_middleware(name: str) -> MiddlewareResult:
             generate_pyproject(directory, name)
             console.success("Created 'pyproject.toml' file.")
             init_command = """uipath init"""
-            run_command = """uipath run agent '{"message": "What is the weather in San Francisco?"}'"""
+            run_command = """uipath run agent '{"messages": "What is the weather in San Francisco?"}'"""
             console.hint(
                 f""" Initialize project: {click.style(init_command, fg="cyan")}"""
             )
diff --git a/packages/uipath-openai-agents/src/uipath_openai_agents/runtime/runtime.py b/packages/uipath-openai-agents/src/uipath_openai_agents/runtime/runtime.py
@@ -219,10 +219,20 @@ def _convert_stream_event_to_runtime_event(
         return None
 
     def _prepare_agent_input(self, input: dict[str, Any] | None) -> str | list[Any]:
-        """Prepare agent input from UiPath input dictionary."""
-        if input and "messages" in input and isinstance(input["messages"], list):
-            return input.get("messages", [])
-        return input.get("message", "") if input else ""
+        """
+        Prepare agent input from UiPath input dictionary.
+
+        """
+        if not input:
+            return ""
+
+        messages = input.get("messages", "")
+
+        if isinstance(messages, (str, list)):
+            return messages
+
+        # Fallback to empty string for unexpected types
+        return ""
 
     def _serialize_message(self, message: Any) -> dict[str, Any]:
         """
diff --git a/packages/uipath-openai-agents/src/uipath_openai_agents/runtime/schema.py b/packages/uipath-openai-agents/src/uipath_openai_agents/runtime/schema.py
@@ -63,19 +63,19 @@ def get_entrypoints_schema(agent: Agent) -> dict[str, Any]:
     schema["input"] = {
         "type": "object",
         "properties": {
-            "message": {
+            "messages": {
                 "anyOf": [
                     {"type": "string"},
                     {
                         "type": "array",
                         "items": {"type": "object"},
                     },
                 ],
-                "title": "Message",
-                "description": "User message(s) to send to the agent",
+                "title": "Messages",
+                "description": "User messages to send to the agent",
             }
         },
-        "required": ["message"],
+        "required": ["messages"],
     }
 
     # Extract output schema - Agent's output_type (native OpenAI Agents pattern)
diff --git a/packages/uipath-openai-agents/testcases/triage-agent/input.json b/packages/uipath-openai-agents/testcases/triage-agent/input.json
@@ -1,3 +1,3 @@
 {
-  "message": "Hola, ¿cómo estás?"
+  "messages": "Hola, ¿cómo estás?"
 }
diff --git a/packages/uipath-openai-agents/tests/cli/test_run.py b/packages/uipath-openai-agents/tests/cli/test_run.py
@@ -22,7 +22,7 @@ def test_run_basic_agent_invocation(
     ) -> None:
         """Test basic agent invocation structure (without actual OpenAI API calls)."""
         input_file_name = "input.json"
-        input_json_content = '{"message": "Hello, agent!"}'
+        input_json_content = '{"messages": "Hello, agent!"}'
 
         with runner.isolated_filesystem(temp_dir=temp_dir):
             # create input file
@@ -54,7 +54,7 @@ def test_run_with_invalid_agent_name(
     ) -> None:
         """Test run command with non-existent agent name."""
         input_file_name = "input.json"
-        input_json_content = '{"message": "test"}'
+        input_json_content = '{"messages": "test"}'
 
         with runner.isolated_filesystem(temp_dir=temp_dir):
             input_file_path = os.path.join(temp_dir, input_file_name)
@@ -83,7 +83,7 @@ def test_run_without_config_file(
     ) -> None:
         """Test run command without openai_agents.json file."""
         input_file_name = "input.json"
-        input_json_content = '{"message": "test"}'
+        input_json_content = '{"messages": "test"}'
 
         with runner.isolated_filesystem(temp_dir=temp_dir):
             input_file_path = os.path.join(temp_dir, input_file_name)
@@ -109,7 +109,7 @@ def test_run_with_malformed_input_json(
     ) -> None:
         """Test run command with malformed JSON input."""
         input_file_name = "input.json"
-        input_json_content = '{"message": invalid json}'  # Malformed
+        input_json_content = '{"messages": invalid json}'  # Malformed
 
         with runner.isolated_filesystem(temp_dir=temp_dir):
             input_file_path = os.path.join(temp_dir, input_file_name)
diff --git a/packages/uipath-openai-agents/tests/test_integration.py b/packages/uipath-openai-agents/tests/test_integration.py
@@ -56,7 +56,7 @@ def test_schema_extraction_with_new_serialization():
 
     # Verify input schema (messages format)
     assert "input" in schema
-    assert "message" in schema["input"]["properties"]
+    assert "messages" in schema["input"]["properties"]
 
     # Verify output schema (from agent's output_type)
     assert "output" in schema

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "message": "Tell me a joke"`
	`2`	`+ "messages": "Tell me a joke"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`	`"input": {`
`10`	`10`	`"type": "object",`
`11`	`11`	`"properties": {`
`12`		`- "message": {`
	`12`	`+ "messages": {`
`13`	`13`	`"anyOf": [`
`14`	`14`	`{`
`15`	`15`	`"type": "string"`
`@@ -21,12 +21,12 @@`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`	`],`
`24`		`- "title": "Message",`
`25`		`- "description": "User message(s) to send to the agent"`
	`24`	`+ "title": "Messages",`
	`25`	`+ "description": "User messages to send to the agent"`
`26`	`26`	`}`
`27`	`27`	`},`
`28`	`28`	`"required": [`
`29`		`- "message"`
	`29`	`+ "messages"`
`30`	`30`	`]`
`31`	`31`	`},`
`32`	`32`	`"output": {`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "message": "Who is the best ai llm?"`
	`2`	`+ "messages": "Who is the best ai llm?"`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`	`1`	`{`
`2`		`- "message": "une blague."`
	`2`	`+ "messages": "une blague."`
`3`	`3`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ def openai_agents_new_middleware(name: str) -> MiddlewareResult:`
`63`	`63`	`generate_pyproject(directory, name)`
`64`	`64`	`console.success("Created 'pyproject.toml' file.")`
`65`	`65`	`init_command = """uipath init"""`
`66`		`- run_command = """uipath run agent '{"message": "What is the weather in San Francisco?"}'"""`
	`66`	`+ run_command = """uipath run agent '{"messages": "What is the weather in San Francisco?"}'"""`
`67`	`67`	`console.hint(`
`68`	`68`	`f""" Initialize project: {click.style(init_command, fg="cyan")}"""`
`69`	`69`	`)`