Skip to content

docs: explain omitempty behavior in structured outputs #879

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
pentaoa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: explain omitempty behavior in structured outputs #879

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,11 @@ import (
// ...
)

// A struct that will be converted to a Structured Outputs response schema
// A struct that will be converted to a Structured Outputs response schema.
//
// Avoid `omitempty` in JSON tags here: jsonschema treats those fields as optional
// and leaves them out of the schema's required array. With Strict enabled, the API
// can reject that schema; otherwise, the model may omit the fields.
type HistoricalComputer struct {
Origin Origin `json:"origin" jsonschema_description:"The origin of the computer"`
Name string `json:"full_name" jsonschema_description:"The name of the device model"`
Expand Down