Skip to content
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.

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

Add list of supported param types for structured outputs #315

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mrmer1
Copy link
Contributor

@mrmer1 mrmer1 commented Dec 19, 2024

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 a message 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:

  • Added a new page titled "Parameter Types in Structured Outputs (JSON)" with usage examples of JSON Schema parameters.
  • Included a helper code section for the Chat endpoint with response_format and message.
  • Covered various parameter types with code examples and outputs.
  • Updated fern/v2.yml to add a "Structured Outputs" section with two pages.

@mrmer1 mrmer1 requested review from a team as code owners December 19, 2024 09:12
@mrmer1 mrmer1 requested review from billytrend-cohere and trentfowlercohere and removed request for billytrend-cohere December 19, 2024 09:12
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant