feat(acl_openai): sort the required fields in the openapi3 schema in … (#374)

Author: mrh997

libs/acl/openai/chat_model.go

@@ -23,6 +23,7 @@ import (
 	"io"
 	"net/http"
 	"runtime/debug"
+	"slices"
 
 	"github.com/getkin/kin-openapi/openapi3"
 	"github.com/meguminnnnnnnnn/go-openai"
@@ -791,6 +792,33 @@ func resolveStreamResponse(resp openai.ChatCompletionStreamResponse) (msg *schem
 }
 
 func toTools(tis []*schema.ToolInfo) ([]tool, error) {
+	var sortArrayFields func(*openapi3.Schema)
+	sortArrayFields = func(sc *openapi3.Schema) {
+		if sc == nil {
+			return
+		}
+		switch sc.Type {
+		case openapi3.TypeObject:
+			if len(sc.Required) == 0 {
+				return
+			}
+
+			slices.Sort(sc.Required)
+
+			for _, v := range sc.Properties {
+				sortArrayFields(v.Value)
+			}
+
+		case openapi3.TypeArray:
+			if sc.Items != nil && sc.Items.Value != nil {
+				sortArrayFields(sc.Items.Value)
+			}
+
+		default:
+			return
+		}
+	}
+
 	tools := make([]tool, len(tis))
 	for i := range tis {
 		ti := tis[i]
@@ -803,6 +831,8 @@ func toTools(tis []*schema.ToolInfo) ([]tool, error) {
 			return nil, fmt.Errorf("failed to convert tool parameters to JSONSchema: %w", err)
 		}
 
+		sortArrayFields(paramsJSONSchema)
+
 		tools[i] = tool{
 			Function: &functionDefinition{
 				Name:        ti.Name,

libs/acl/openai/chat_model_test.go

@@ -20,6 +20,7 @@ import (
 	"math/rand"
 	"testing"
 
+	"github.com/bytedance/mockey"
 	goopenai "github.com/meguminnnnnnnnn/go-openai"
 	"github.com/stretchr/testify/assert"
 
@@ -186,3 +187,54 @@ func TestClientWithExtraHeader(t *testing.T) {
 		WithExtraHeader(map[string]string{"test": "test"}),
 	}), 1)
 }
+
+func TestToTools(t *testing.T) {
+	mockey.PatchConvey("", t, func() {
+		mockTools := []*schema.ToolInfo{
+			{
+				Name: "test tool name",
+				Desc: "description of test tool",
+				ParamsOneOf: schema.NewParamsOneOfByParams(map[string]*schema.ParameterInfo{
+					"126": {
+						Type:     schema.String,
+						Required: true,
+					},
+					"123": {
+						Type:     schema.Array,
+						Required: true,
+						ElemInfo: &schema.ParameterInfo{
+							Type:     schema.Object,
+							Required: true,
+							SubParams: map[string]*schema.ParameterInfo{
+								"459": {
+									Type:     schema.String,
+									Required: true,
+								},
+								"458": {
+									Type:     schema.String,
+									Required: true,
+								},
+								"457": {
+									Type:     schema.String,
+									Required: true,
+								},
+							},
+						},
+					},
+					"129": {
+						Type:     schema.Object,
+						Required: true,
+					},
+				}),
+			},
+		}
+
+		tools, err := toTools(mockTools)
+		assert.Nil(t, err)
+		assert.Len(t, tools, 1)
+
+		sc := tools[0].Function.Parameters
+		assert.Equal(t, []string{"123", "126", "129"}, sc.Required)
+		assert.Equal(t, []string{"457", "458", "459"}, sc.Properties["123"].Value.Items.Value.Required)
+	})
+}