Skip to content

Fix stale OpenAI schema support reference - #506

Open
fallintoplace wants to merge 1 commit into
google:mainfrom
fallintoplace:docs/openai-schema-support
Open

Fix stale OpenAI schema support reference#506
fallintoplace wants to merge 1 commit into
google:mainfrom
fallintoplace:docs/openai-schema-support

Conversation

@fallintoplace

@fallintoplace fallintoplace commented Jul 25, 2026

Copy link
Copy Markdown

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_constraints does nothing.

This update:

  • documents that the provider exposes OpenAISchema and derives constraints
    from examples
  • notes that output_schema is supported when the selected model supports
    structured outputs
  • recommends leaving fence_output and use_schema_constraints unset so the
    provider can configure them automatically
  • keeps the existing JSON-mode fallback and batch-parallelism guidance

Only skills/langextract-usage/references/providers.md changes. No runtime
behavior 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.md

All required CI checks pass, including formatting, Python 3.10 through 3.12,
and the plugin and Ollama integration suites.

Checklist:

@github-actions github-actions Bot added the size/XS Pull request with less than 50 lines changed label Jul 25, 2026
@fallintoplace fallintoplace changed the title Correct OpenAI schema support documentation Fix stale OpenAI schema support reference Jul 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/XS Pull request with less than 50 lines changed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Schema constraints for OpenAI not supported

1 participant