Improve handling of JSON Schema in OpenAI API Response Context #819
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,7 +4,12 @@ | |
| // and/or pass in the schema in []byte format. | ||
| package jsonschema | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "reflect" | ||
| "strconv" | ||
| "strings" | ||
| ) | ||
|
|
||
| type DataType string | ||
|
|
||
|
|
@@ -53,3 +58,90 @@ | |
| Alias: (Alias)(d), | ||
| }) | ||
| } | ||
|
|
||
| type SchemaWrapper[T any] struct { | ||
|
There was a problem hiding this comment. Pardon my ignorance: do we even need this type? There was a problem hiding this comment. The sw, err := jsonschema.Wrap(MyStructuredResponse{})
result, err := sw.Unmarshal(`{...}`)or var result MyStructuredResponse{}
schema, err := jsonschema.GenerateSchemaForType(result)
schema.Unmarshal(`{...}`, &result) |
||
| data T | ||
| schema Definition | ||
| } | ||
|
|
||
| func (r SchemaWrapper[T]) Schema() Definition { | ||
| return r.schema | ||
| } | ||
|
|
||
| func (r SchemaWrapper[T]) MarshalJSON() ([]byte, error) { | ||
| return json.Marshal(r.schema) | ||
| } | ||
|
|
||
| func (r SchemaWrapper[T]) Unmarshal(content string) (*T, error) { | ||
| var v T | ||
| err := Unmarshal(r.schema, []byte(content), &v) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return &v, nil | ||
| } | ||
|
|
||
| func (r SchemaWrapper[T]) String() string { | ||
| bytes, _ := json.MarshalIndent(r.schema, "", " ") | ||
| return string(bytes) | ||
| } | ||
|
|
||
| func Warp[T any](v T) SchemaWrapper[T] { | ||
|
There was a problem hiding this comment. @eiixy heads up: I think you meant There was a problem hiding this comment. Or even better: |
||
| return SchemaWrapper[T]{ | ||
| data: v, | ||
| schema: reflectSchema(reflect.TypeOf(v)), | ||
| } | ||
| } | ||
|
|
||
| func reflectSchema(t reflect.Type) Definition { | ||
| var d Definition | ||
| switch t.Kind() { | ||
|
Check failure on line 98 in jsonschema/json.go
|
||
| case reflect.String: | ||
| d.Type = String | ||
| case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64, | ||
| reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64: | ||
| d.Type = Integer | ||
| case reflect.Float32, reflect.Float64: | ||
| d.Type = Number | ||
| case reflect.Bool: | ||
| d.Type = Boolean | ||
| case reflect.Slice, reflect.Array: | ||
| d.Type = Array | ||
| items := reflectSchema(t.Elem()) | ||
| d.Items = &items | ||
| case reflect.Struct: | ||
| d.Type = Object | ||
| d.AdditionalProperties = false | ||
| properties := make(map[string]Definition) | ||
| var requiredFields []string | ||
| for i := 0; i < t.NumField(); i++ { | ||
| field := t.Field(i) | ||
| jsonTag := field.Tag.Get("json") | ||
| var required = true | ||
| if jsonTag == "" { | ||
| jsonTag = field.Name | ||
| } else if strings.HasSuffix(jsonTag, ",omitempty") { | ||
| jsonTag = strings.TrimSuffix(jsonTag, ",omitempty") | ||
| required = false | ||
| } | ||
|
|
||
| item := reflectSchema(field.Type) | ||
| description := field.Tag.Get("description") | ||
| if description != "" { | ||
| item.Description = description | ||
| } | ||
| properties[jsonTag] = item | ||
|
|
||
| if s := field.Tag.Get("required"); s != "" { | ||
| required, _ = strconv.ParseBool(s) | ||
| } | ||
| if required { | ||
| requiredFields = append(requiredFields, jsonTag) | ||
| } | ||
| } | ||
| d.Required = requiredFields | ||
| d.Properties = properties | ||
| default: | ||
|
There was a problem hiding this comment. I suggest we either return an error or panic here There was a problem hiding this comment. Thank you for the suggestion! |
||
| } | ||
| return d | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| package jsonschema | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "errors" | ||
| ) | ||
|
|
||
| func Unmarshal(schema Definition, content []byte, v any) error { | ||
eiixy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| var data any | ||
| err := json.Unmarshal(content, &data) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| if !Validate(schema, data) { | ||
| return errors.New("validate failed") | ||
| } | ||
| return json.Unmarshal(content, &v) | ||
| } | ||
|
|
||
| func Validate(schema Definition, data interface{}) bool { | ||
eiixy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| switch schema.Type { | ||
| case Object: | ||
| return validateObject(schema, data) | ||
| case Array: | ||
| return validateArray(schema, data) | ||
| case String: | ||
| _, ok := data.(string) | ||
| return ok | ||
| case Number: // float64 and int | ||
| _, ok := data.(float64) | ||
|
There was a problem hiding this comment. should we also support float32 here? |
||
| if !ok { | ||
| _, ok = data.(int) | ||
| } | ||
| return ok | ||
| case Boolean: | ||
| _, ok := data.(bool) | ||
| return ok | ||
| case Integer: | ||
| _, ok := data.(int) | ||
| return ok | ||
| case Null: | ||
| return data == nil | ||
| default: | ||
| return false | ||
| } | ||
| } | ||
|
|
||
| func validateObject(schema Definition, data any) bool { | ||
| dataMap, ok := data.(map[string]any) | ||
| if !ok { | ||
| return false | ||
| } | ||
| for _, field := range schema.Required { | ||
| if _, exists := dataMap[field]; !exists { | ||
| return false | ||
| } | ||
| } | ||
| for key, valueSchema := range schema.Properties { | ||
| value, exists := dataMap[key] | ||
| if exists && !Validate(valueSchema, value) { | ||
| return false | ||
| } else if !exists && contains(schema.Required, key) { | ||
| return false | ||
| } | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func validateArray(schema Definition, data any) bool { | ||
| dataArray, ok := data.([]interface{}) | ||
eiixy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if !ok { | ||
| return false | ||
| } | ||
| for _, item := range dataArray { | ||
| if !Validate(*schema.Items, item) { | ||
| return false | ||
| } | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func contains[S ~[]E, E comparable](s S, v E) bool { | ||
| for i := range s { | ||
| if v == s[i] { | ||
| return true | ||
| } | ||
| } | ||
| return false | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great stuff, I guess we should put a proper README example on how to use this. That should be one of the top examples for sure.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have added an example use case from OpenAI documentation to the README. For reference, please see: https://platform.openai.com/docs/guides/structured-outputs/examples