Add list of supported param types for structured outputs #315
+945
−57
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.
This PR introduces a new page titled "Parameter Types in Structured Outputs (JSON)" to the documentation. The page provides usage examples of the JSON Schema parameters supported in Structured Outputs (JSON). It includes a helper code section that demonstrates how to use the Chat endpoint with a
response_format
schema and amessage
to generate outputs.The page covers various parameter types, including basic types (string, integer, float, boolean), arrays (with specific types, without specific types, and lists of lists), and other types (nested objects, enums, const, pattern, and format). Each parameter type is accompanied by a code example and its corresponding output.
Additionally, the PR updates the
fern/v2.yml
file to include a new section titled "Structured Outputs" with two pages: "Structured Outputs" and "Parameter Types in Structured Outputs (JSON)".Changes:
response_format
andmessage
.fern/v2.yml
to add a "Structured Outputs" section with two pages.