fix ordering of returned arg key names to consistent alphabetic order (#4006)

Signed-off-by: Filinto Duran <[email protected]>

Author: filintod

conversation/echo/echo.go

@@ -18,6 +18,7 @@ import (
 	"context"
 	"fmt"
 	"reflect"
+	"sort"
 	"strconv"
 	"strings"
 
@@ -102,6 +103,8 @@ func (e *Echo) Converse(ctx context.Context, r *conversation.Request) (res *conv
 					for argName := range propMap {
 						argNames = append(argNames, argName)
 					}
+					// sort the arg names to keep deterministic order for tests
+					sort.Strings(argNames)
 				}
 			}
 

conversation/echo/echo_test.go

@@ -183,6 +183,69 @@ func TestConverseAlpha2(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "tool call request with multiple arguments alphabetic ordering of arguments",
+			messages: []llms.MessageContent{
+				{
+					Role: llms.ChatMessageTypeHuman,
+					Parts: []llms.ContentPart{
+						llms.TextContent{Text: "hello echo"},
+					},
+				},
+			},
+			tools: []llms.Tool{
+				{
+					Type: "function",
+					Function: &llms.FunctionDefinition{
+						Name:        "myfunc",
+						Description: "A function that does something",
+						Parameters: map[string]any{
+							"type": "object",
+							"properties": map[string]any{
+								"unit": map[string]any{
+									"type":        "string",
+									"description": "unit should come last",
+								},
+								"name": map[string]any{
+									"type":        "string",
+									"description": "The name to process, should come second",
+								},
+								"location": map[string]any{
+									"type":        "string",
+									"description": "location should come first",
+								},
+							},
+						},
+					},
+				},
+			},
+			expected: &conversation.Response{
+				Outputs: []conversation.Result{
+					{
+						StopReason: "tool_calls",
+						Choices: []conversation.Choice{
+							{
+								FinishReason: "tool_calls",
+								Index:        0,
+								Message: conversation.Message{
+									Content: "hello echo",
+									ToolCallRequest: &[]llms.ToolCall{
+										{
+											ID:   "0", // ID is auto-generated by the echo component
+											Type: "function",
+											FunctionCall: &llms.FunctionCall{
+												Name:      "myfunc",
+												Arguments: "location,name,unit",
+											},
+										},
+									},
+								},
+							},
+						},
+					},
+				},
+			},
+		},
 		{
 			name: "text message with tool call response",
 			// echo responds with the text message and tool call response appended to the message content