docs: document reasoning_content output removal as a breaking client change (#50624)

Signed-off-by: fede-kamel <[email protected]>
Signed-off-by: Harry Mellor <[email protected]>
Co-authored-by: Harry Mellor <[email protected]>
This commit is contained in:
Fede Kamelhar
2026-08-03 13:45:23 +00:00
committed by GitHub
co-authored by Harry Mellor
parent 9ae11a6b89
commit 005fa01756
+2 -1
View File
@@ -6,6 +6,7 @@ Reasoning models return an additional `reasoning` field in their outputs, which
!!! warning
`reasoning` used to be called `reasoning_content`. To migrate, directly replace `reasoning_content` with `reasoning`.
It is important that you also update your client code. Otherwise, your client code could silently read an empty `reasoning_content`, even when `reasoning` is populated.
## Supported Models
@@ -105,7 +106,7 @@ Streaming chat completions are also supported for reasoning models. The `reasoni
}
```
OpenAI Python client library does not officially support `reasoning` attribute for streaming output. But the client supports extra attributes in the response. You can use `hasattr` to check if the `reasoning` attribute is present in the response. For example:
OpenAI Python client library does not officially support `reasoning` attribute for streaming output. But the client supports extra attributes in the response. You can use `getattr` to check if the `reasoning` attribute is present in the response. For example:
??? code