feat: support using JSONSchema to describe tool parameters (cloudwego#402)

Author: mrh997

components/tool/utils/create_options.go

@@ -58,6 +58,7 @@ func WithMarshalOutput(m MarshalOutput) Option {
 	}
 }
 
+// Deprecated. For more information, see https://github.com/cloudwego/eino/discussions/397.
 // SchemaCustomizerFn is the schema customizer function for inferring tool parameter from tagged go struct.
 // Within this function, end-user can parse custom go struct tags into corresponding openapi schema field.
 // Parameters:
@@ -67,6 +68,7 @@ func WithMarshalOutput(m MarshalOutput) Option {
 // 4. schema: the current openapi schema object to be customized.
 type SchemaCustomizerFn func(name string, t reflect.Type, tag reflect.StructTag, schema *openapi3.Schema) error
 
+// Deprecated. For more information, see https://github.com/cloudwego/eino/discussions/397.
 // WithSchemaCustomizer sets a user-defined schema customizer for inferring tool parameter from tagged go struct.
 // If this option is not set, the defaultSchemaCustomizer will be used.
 func WithSchemaCustomizer(sc SchemaCustomizerFn) Option {
@@ -86,6 +88,7 @@ func getToolOptions(opt ...Option) *toolOptions {
 	return opts
 }
 
+// Deprecated. For more information, see https://github.com/cloudwego/eino/discussions/397.
 // defaultSchemaCustomizer is the default schema customizer when using reflect to infer tool parameter from tagged go struct.
 // Supported struct tags:
 // 1. jsonschema: "description=xxx"

components/tool/utils/invokable_func.go

@@ -22,7 +22,7 @@ import (
 	"strings"
 
 	"github.com/bytedance/sonic"
-	"github.com/getkin/kin-openapi/openapi3gen"
+	"github.com/eino-contrib/jsonschema"
 
 	"github.com/cloudwego/eino/components/tool"
 	"github.com/cloudwego/eino/internal/generic"
@@ -80,22 +80,68 @@ func goStruct2ToolInfo[T any](toolName, toolDesc string, opts ...Option) (*schem
 	}, nil
 }
 
-func goStruct2ParamsOneOf[T any](opts ...Option) (*schema.ParamsOneOf, error) {
-	options := getToolOptions(opts...)
-	schemaCustomizer := defaultSchemaCustomizer
-	if options.sc != nil {
-		schemaCustomizer = options.sc
-	}
+func goStruct2ParamsOneOf[T any](_ ...Option) (*schema.ParamsOneOf, error) {
+	s := jsonschema.Reflect(generic.NewInstance[T]())
 
-	sc, err := openapi3gen.NewSchemaRefForValue(generic.NewInstance[T](), nil, openapi3gen.SchemaCustomizer(schemaCustomizer))
-	if err != nil {
-		return nil, fmt.Errorf("new SchemaRef from T failed: %w", err)
+	rootName := strings.TrimPrefix(s.Ref, "#/$defs/")
+	rootSchema := s.Definitions[rootName]
+	if rootSchema == nil {
+		return nil, fmt.Errorf("jsonschema '%s' not found", rootName)
 	}
 
-	paramsOneOf := schema.NewParamsOneOfByOpenAPIV3(sc.Value)
+	rootSchema = resolveRef(rootSchema, s.Definitions)
+	paramsOneOf := schema.NewParamsOneOfByJSONSchema(rootSchema)
 
 	return paramsOneOf, nil
+}
+
+func resolveRef(s *jsonschema.Schema, defs jsonschema.Definitions) *jsonschema.Schema {
+	if s == nil {
+		return nil
+	}
+
+	if s.Ref != "" {
+		if def, ok := defs[s.Ref[len("#/$defs/"):]]; ok {
+			s.Ref = "" // Clear the ref after resolution
+			return resolveRef(def, defs)
+		}
+	}
+
+	for i, s_ := range s.AllOf {
+		s.AllOf[i] = resolveRef(s_, defs)
+	}
+	for i, s_ := range s.AnyOf {
+		s.AnyOf[i] = resolveRef(s_, defs)
+	}
+	for i, s_ := range s.OneOf {
+		s.OneOf[i] = resolveRef(s_, defs)
+	}
+	for i, s_ := range s.DependentSchemas {
+		s.DependentSchemas[i] = resolveRef(s_, defs)
+	}
+	for i, s_ := range s.PrefixItems {
+		s.PrefixItems[i] = resolveRef(s_, defs)
+	}
+	for i, s_ := range s.PatternProperties {
+		s.PatternProperties[i] = resolveRef(s_, defs)
+	}
+	if s.Properties != nil {
+		for pair := s.Properties.Oldest(); pair != nil; pair = pair.Next() {
+			s.Properties.Set(pair.Key, resolveRef(pair.Value, defs))
+		}
+	}
 
+	s.Not = resolveRef(s.Not, defs)
+	s.If = resolveRef(s.If, defs)
+	s.Then = resolveRef(s.Then, defs)
+	s.Else = resolveRef(s.Else, defs)
+	s.Items = resolveRef(s.Items, defs)
+	s.Contains = resolveRef(s.Contains, defs)
+	s.AdditionalProperties = resolveRef(s.AdditionalProperties, defs)
+	s.PropertyNames = resolveRef(s.PropertyNames, defs)
+	s.ContentSchema = resolveRef(s.ContentSchema, defs)
+
+	return s
 }
 
 // NewTool Create a tool, where the input and output are both in JSON format.