Fix stale OpenAI schema support reference - #506
Open
fallintoplace wants to merge 1 commit into
Open
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Fixes #59
Type: Documentation
Summary
The OpenAI section in the bundled provider reference predates structured-output
support added in #468 and user-provided schemas added in #483. It still says
that OpenAI has no schema class and that
use_schema_constraintsdoes nothing.This update:
OpenAISchemaand derives constraintsfrom examples
output_schemais supported when the selected model supportsstructured outputs
fence_outputanduse_schema_constraintsunset so theprovider can configure them automatically
Only
skills/langextract-usage/references/providers.mdchanges. No runtimebehavior or public API is modified.
How Has This Been Tested?
The corrected statements were checked against
OpenAILanguageModel.get_schema_class(),OpenAISchema.from_examples(),OpenAISchema.from_schema_dict(), and the factory defaults.git diff --check awk 'length($0) > 80 {print FNR ":" length($0) ":" $0}' skills/langextract-usage/references/providers.mdAll required CI checks pass, including formatting, Python 3.10 through 3.12,
and the plugin and Ollama integration suites.
Checklist:
pylintis not applicable to this Markdown-only change, and the formatting check passes.