Skip to content

fix readme on nested_params for response format #2678

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −5
Open

fix readme on nested_params for response format #2678

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
19 changes: 14 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -373,19 +373,28 @@ Nested parameters are dictionaries, typed using `TypedDict`, for example:

```python
from openai import OpenAI
from pydantic import BaseModel

client = OpenAI()

response = client.chat.responses.create(
class CalendarEvent(BaseModel):
name: str
date: str
participants: list[str]

response = client.responses.parse(
model="gpt-4o-2024-08-06",
input=[
{"role": "system", "content": "Extract the event information."},
{
"role": "user",
"content": "How much ?",
}
"content": "Alice and Bob are going to a science fair on Friday.",
},
],
model="gpt-4o",
response_format={"type": "json_object"},
text_format=CalendarEvent,
)

event = response.output_parsed
```

## File uploads
Expand Down