Skip to content

fix(ai): add properties for OpenAI compat #3799

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

Merged
merged 1 commit into from
Oct 7, 2024
Merged

fix(ai): add properties for OpenAI compat #3799

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
5 changes: 5 additions & 0 deletions ai-data/generative-apis/how-to/use-structured-outputs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ extract = client.chat.completions.create(
"items": {"type": "string"}
}
},
"additionalProperties": false,
"required": ["title", "summary", "actionItems"]
}
}
Expand All @@ -237,6 +238,10 @@ Output example:
}
```

<Message type="tip">
When using the OpenAI SDKs like in the examples above, you are expected to set `additionalProperties` to false, and to specify all your properties as required.
</Message>

## Conclusion

Using structured outputs with LLMs can significantly enhance data handling in your applications.
Expand Down