spring-projects / spring-projects/spring-ai
spring.ai.openai.chat.reasoning-effort not documented
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 9.5k
- Forks
- 2.9k
- Avg merge
- 1d 7h
- Merged PRs (30d)
- 6
Description
Bug description
The spring.ai.openai.chat.reasoning-effort option is implemented, but contrary to the equivalent for DeepSeek or Mistral, it is not documented for OpenAI.
Steps to reproduce
- Try to use Spring AI 2.0.0 with
-Dspring.ai.openai.chat.model=gpt-5.6-terra. - As soon as a tool is invoked, you get:
400: Function tools with reasoning_effort are not supported for gpt-5.6-terra in /v1/chat/completions. To use function tools, use /v1/responses or set reasoning_effort to 'none'.
- Look at the doc to see if this option is supported. It does not appear.
- Try it anyway, with
-Dspring.ai.openai.chat.reasoning-effort=none. - It actually works, just not documented.
Expected behavior
The OpenAI documentation should mention all supported options to avoid confusion.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with spring-ai-docs/src/main/antora/modules/ROOT/pages/api/chat/openai-chat.adoc and compare the documented options in the DeepSeek and Mistral chat pages. Confirm the supported property in OpenAiChatProperties.java, then document spring.ai.openai.chat.reasoning-effort for OpenAI. Done means the OpenAI documentation lists this supported option and its usage is clear.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 90/100