docs: clarify ModelSettings.tool_choice options #1572

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

Jump to bottom

Closed

MuhammedSuhaib wants to merge 3 commits into openai:main from MuhammedSuhaib:clarify-tool-choice-docs

MuhammedSuhaib commented Aug 23, 2025

Expanded the docstring for ModelSettings.tool_choice.
Documented all valid values supported by the ToolChoice type alias:
- "auto" (default) → let the model decide.
- "required" → must call some tool.
- "none" → forbid tool calls.
- "<tool_name>" → force a specific tool by name.
- MCPToolChoice → advanced structured config.
- None → provider defaults.
Aligns SDK docs with the actual ToolChoice type definition.

MuhammedSuhaib added 3 commits

August 23, 2025 20:13


          docs: clarify ToolsToFinalOutputResult docstrings

4a4a043


          docs: clarify ModelSettings.truncation behavior

98d35a8


          docs: clarify ModelSettings.tool_choice options

d27e896

Member

seratch commented Aug 24, 2025

Let us close this due to the same reason I mentioned for your other PRs.

seratch closed this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet