Skip to content

docs(readme): clarify response_format vs text for structured outputs #413

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
nezhyborets merged 1 commit into from
Apr 30, 2026
+8 −1
Merged

docs(readme): clarify response_format vs text for structured outputs #413

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
9 changes: 8 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -743,6 +743,13 @@ Review [Audio Documentation](https://platform.openai.com/docs/api-reference/audi

To configure structured outputs you would define a JSON Schema and pass it to a query.

> [!NOTE]
> The two query types pass the schema via different parameters, mirroring the OpenAI API:
> - `ChatQuery` (Chat Completions API): `responseFormat: .jsonSchema(...)` — encoded as `response_format`.
> - `CreateModelResponseQuery` (Responses API): `text: .jsonSchema(...)` — encoded as `text`.
>
> Both accept the same `JSONSchemaDefinition` value, so the schema-building examples below apply to either query type.

This SDK supports multiple ways to define a schema; choose the one you prefer.

<details>
Expand Down Expand Up @@ -825,7 +832,7 @@ for output in response.output {

Use [Pydantic](https://docs.pydantic.dev/latest/) or [Zod](https://zod.dev) fashion to define schemas.

- Use the `derivedJsonSchema(_ type:)` response format when creating a `ChatQuery` or `CreateModelResponseQuery`
- Use the `derivedJsonSchema(_ type:)` schema definition. Pass it via `responseFormat:` for `ChatQuery` or via `text:` for `CreateModelResponseQuery`.
- Provide a type that conforms to `JSONSchemaConvertible` and generates an instance as an example
- Make sure all enum types within the provided type conform to `JSONSchemaEnumConvertible` and generate an array of names for all cases

Expand Down
Loading