Skip to content

[BREAKING CHANGES] Changes Definition.Type from DataType to []DataType #916

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

[BREAKING CHANGES] Changes Definition.Type from DataType to []DataType #916

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ed028e
Changes Definition.Type from DataType to []DataType
blwsh Dec 26, 2024
969d5bc
satisfy linter
blwsh Dec 26, 2024
6fc2bd2
add test
blwsh Dec 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -628,14 +628,14 @@ Using the `jsonschema` package, this schema could be created using structs as su
FunctionDefinition{
Name: "get_current_weather",
Parameters: jsonschema.Definition{
Type: jsonschema.Object,
Type: []jsonschema.DataType{jsonschema.Object},
Properties: map[string]jsonschema.Definition{
"location": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Description: "The city and state, e.g. San Francisco, CA",
},
"unit": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Enum: []string{"celsius", "fahrenheit"},
},
},
Expand Down
16 changes: 8 additions & 8 deletions api_integration_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,14 +91,14 @@ func TestAPI(t *testing.T) {
Functions: []openai.FunctionDefinition{{
Name: "get_current_weather",
Parameters: jsonschema.Definition{
Type: jsonschema.Object,
Type: []jsonschema.DataType{jsonschema.Object},
Properties: map[string]jsonschema.Definition{
"location": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Description: "The city and state, e.g. San Francisco, CA",
},
"unit": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Enum: []string{"celsius", "fahrenheit"},
},
},
Expand Down Expand Up @@ -273,19 +273,19 @@ func TestChatCompletionStructuredOutputsFunctionCalling(t *testing.T) {
Name: "display_cases",
Strict: true,
Parameters: &jsonschema.Definition{
Type: jsonschema.Object,
Type: []jsonschema.DataType{jsonschema.Object},
Properties: map[string]jsonschema.Definition{
"PascalCase": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
},
"CamelCase": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
},
"KebabCase": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
},
"SnakeCase": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
},
},
Required: []string{"PascalCase", "CamelCase", "KebabCase", "SnakeCase"},
Expand Down
20 changes: 10 additions & 10 deletions chat_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -428,21 +428,21 @@ func TestChatCompletionsFunctions(t *testing.T) {
Functions: []openai.FunctionDefinition{{
Name: "test",
Parameters: &jsonschema.Definition{
Type: jsonschema.Object,
Type: []jsonschema.DataType{jsonschema.Object},
Properties: map[string]jsonschema.Definition{
"count": {
Type: jsonschema.Number,
Type: []jsonschema.DataType{jsonschema.Number},
Description: "total number of words in sentence",
},
"words": {
Type: jsonschema.Array,
Type: []jsonschema.DataType{jsonschema.Array},
Description: "list of words in sentence",
Items: &jsonschema.Definition{
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
},
},
"enumTest": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Enum: []string{"hello", "world"},
},
},
Expand All @@ -465,21 +465,21 @@ func TestChatCompletionsFunctions(t *testing.T) {
Functions: []openai.FunctionDefine{{
Name: "test",
Parameters: &jsonschema.Definition{
Type: jsonschema.Object,
Type: []jsonschema.DataType{jsonschema.Object},
Properties: map[string]jsonschema.Definition{
"count": {
Type: jsonschema.Number,
Type: []jsonschema.DataType{jsonschema.Number},
Description: "total number of words in sentence",
},
"words": {
Type: jsonschema.Array,
Type: []jsonschema.DataType{jsonschema.Array},
Description: "list of words in sentence",
Items: &jsonschema.Definition{
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
},
},
"enumTest": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Enum: []string{"hello", "world"},
},
},
Expand Down
6 changes: 3 additions & 3 deletions examples/completion-with-tool/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,14 @@ func main() {

// describe the function & its inputs
params := jsonschema.Definition{
Type: jsonschema.Object,
Type: []jsonschema.DataType{jsonschema.Object},
Properties: map[string]jsonschema.Definition{
"location": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Description: "The city and state, e.g. San Francisco, CA",
},
"unit": {
Type: jsonschema.String,
Type: []jsonschema.DataType{jsonschema.String},
Enum: []string{"celsius", "fahrenheit"},
},
},
Expand Down
19 changes: 10 additions & 9 deletions jsonschema/json.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ const (
// It is fairly limited, and you may have better luck using a third-party library.
type Definition struct {
// Type specifies the data type of the schema.
Type DataType `json:"type,omitempty"`
Type []DataType `json:"type,omitempty"`
// Description is the description of the schema.
Description string `json:"description,omitempty"`
// Enum is used to restrict a value to a fixed set of values. It must be an array with at least
Expand All @@ -44,7 +44,7 @@ type Definition struct {
// that are not explicitly defined in the properties section of the schema. example:
// additionalProperties: true
// additionalProperties: false
// additionalProperties: jsonschema.Definition{Type: jsonschema.String}
// additionalProperties: jsonschema.Definition{Type: []jsonschema.DataType{jsonschema.String}}
AdditionalProperties any `json:"additionalProperties,omitempty"`
}

Expand Down Expand Up @@ -72,23 +72,23 @@ func reflectSchema(t reflect.Type) (*Definition, error) {
var d Definition
switch t.Kind() {
case reflect.String:
d.Type = String
d.Type = []DataType{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
d.Type = []DataType{Integer}
case reflect.Float32, reflect.Float64:
d.Type = Number
d.Type = []DataType{Number}
case reflect.Bool:
d.Type = Boolean
d.Type = []DataType{Boolean}
case reflect.Slice, reflect.Array:
d.Type = Array
d.Type = []DataType{Array}
items, err := reflectSchema(t.Elem())
if err != nil {
return nil, err
}
d.Items = items
case reflect.Struct:
d.Type = Object
d.Type = []DataType{Object}
d.AdditionalProperties = false
object, err := reflectSchemaObject(t)
if err != nil {
Expand All @@ -101,6 +101,7 @@ func reflectSchema(t reflect.Type) (*Definition, error) {
return nil, err
}
d = *definition
d.Type = append(d.Type, Null)
case reflect.Invalid, reflect.Uintptr, reflect.Complex64, reflect.Complex128,
reflect.Chan, reflect.Func, reflect.Interface, reflect.Map,
reflect.UnsafePointer:
Expand All @@ -112,7 +113,7 @@ func reflectSchema(t reflect.Type) (*Definition, error) {

func reflectSchemaObject(t reflect.Type) (*Definition, error) {
var d = Definition{
Type: Object,
Type: []DataType{Object},
AdditionalProperties: false,
}
properties := make(map[string]Definition)
Expand Down
Loading
Loading