All Implemented Interfaces:
```
public final class ResponseCreateParams.ToolChoice

                    
```
How the model should select which tool (or tools) to use when generating a response. See the tools parameter to see how to specify which tools the model can call.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`ResponseCreateParams.ToolChoice.Visitor`	An interface that defines how to map each variant of ToolChoice to a value of type T.

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final Optional<BetaToolChoiceOptions>`	`betaToolChoiceOptions()`	Controls which (if any) tool is called by the model.
`final Optional<BetaToolChoiceAllowed>`	`betaToolChoiceAllowed()`	Constrains the tools available to the model to a pre-defined set.
`final Optional<BetaToolChoiceTypes>`	`betaToolChoiceTypes()`	Indicates that the model should use a built-in tool to generate a response.
`final Optional<BetaToolChoiceFunction>`	`betaToolChoiceFunction()`	Use this option to force the model to call a specific function.
`final Optional<BetaToolChoiceMcp>`	`betaToolChoiceMcp()`	Use this option to force the model to call a specific tool on a remote MCP server.
`final Optional<BetaToolChoiceCustom>`	`betaToolChoiceCustom()`	Use this option to force the model to call a specific custom tool.
`final Optional<JsonValue>`	`betaSpecificProgrammaticToolCallingParam()`
`final Optional<BetaToolChoiceApplyPatch>`	`betaToolChoiceApplyPatch()`	Forces the model to call the apply_patch tool when executing a tool call.
`final Optional<BetaToolChoiceShell>`	`betaToolChoiceShell()`	Forces the model to call the shell tool when a tool call is required.
`final Boolean`	`isBetaToolChoiceOptions()`
`final Boolean`	`isBetaToolChoiceAllowed()`
`final Boolean`	`isBetaToolChoiceTypes()`
`final Boolean`	`isBetaToolChoiceFunction()`
`final Boolean`	`isBetaToolChoiceMcp()`
`final Boolean`	`isBetaToolChoiceCustom()`
`final Boolean`	`isBetaSpecificProgrammaticToolCallingParam()`
`final Boolean`	`isBetaToolChoiceApplyPatch()`
`final Boolean`	`isBetaToolChoiceShell()`
`final BetaToolChoiceOptions`	`asBetaToolChoiceOptions()`	Controls which (if any) tool is called by the model.
`final BetaToolChoiceAllowed`	`asBetaToolChoiceAllowed()`	Constrains the tools available to the model to a pre-defined set.
`final BetaToolChoiceTypes`	`asBetaToolChoiceTypes()`	Indicates that the model should use a built-in tool to generate a response.
`final BetaToolChoiceFunction`	`asBetaToolChoiceFunction()`	Use this option to force the model to call a specific function.
`final BetaToolChoiceMcp`	`asBetaToolChoiceMcp()`	Use this option to force the model to call a specific tool on a remote MCP server.
`final BetaToolChoiceCustom`	`asBetaToolChoiceCustom()`	Use this option to force the model to call a specific custom tool.
`final JsonValue`	`asBetaSpecificProgrammaticToolCallingParam()`
`final BetaToolChoiceApplyPatch`	`asBetaToolChoiceApplyPatch()`	Forces the model to call the apply_patch tool when executing a tool call.
`final BetaToolChoiceShell`	`asBetaToolChoiceShell()`	Forces the model to call the shell tool when a tool call is required.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(ResponseCreateParams.ToolChoice.Visitor<T> visitor)`	Maps this instance's current variant to a value of type T using the given visitor.
`final ResponseCreateParams.ToolChoice`	`validate()`	Validates that the types of all values in this object match their expected types recursively.
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceOptions(BetaToolChoiceOptions betaToolChoiceOptions)`	Controls which (if any) tool is called by the model.
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceAllowed(BetaToolChoiceAllowed betaToolChoiceAllowed)`	Constrains the tools available to the model to a pre-defined set.
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceTypes(BetaToolChoiceTypes betaToolChoiceTypes)`	Indicates that the model should use a built-in tool to generate a response.
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceFunction(BetaToolChoiceFunction betaToolChoiceFunction)`	Use this option to force the model to call a specific function.
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceMcp(BetaToolChoiceMcp betaToolChoiceMcp)`	Use this option to force the model to call a specific tool on a remote MCP server.
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceCustom(BetaToolChoiceCustom betaToolChoiceCustom)`	Use this option to force the model to call a specific custom tool.
`final static ResponseCreateParams.ToolChoice`	`ofBetaSpecificProgrammaticToolCallingParam()`
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceApplyPatch(BetaToolChoiceApplyPatch betaToolChoiceApplyPatch)`	Forces the model to call the apply_patch tool when executing a tool call.
`final static ResponseCreateParams.ToolChoice`	`ofBetaToolChoiceShell(BetaToolChoiceShell betaToolChoiceShell)`	Forces the model to call the shell tool when a tool call is required.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - betaToolChoiceOptions
```
 final Optional<BetaToolChoiceOptions> betaToolChoiceOptions()
```
    Controls which (if any) tool is called by the model.
    none means the model will not call any tool and instead generates a message.
    auto means the model can pick between generating a message or calling one or more tools.
    required means the model must call one or more tools.
  - betaToolChoiceAllowed
```
 final Optional<BetaToolChoiceAllowed> betaToolChoiceAllowed()
```
    Constrains the tools available to the model to a pre-defined set.
  - betaToolChoiceTypes
```
 final Optional<BetaToolChoiceTypes> betaToolChoiceTypes()
```
    Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
  - betaToolChoiceFunction
```
 final Optional<BetaToolChoiceFunction> betaToolChoiceFunction()
```
    Use this option to force the model to call a specific function.
  - betaToolChoiceMcp
```
 final Optional<BetaToolChoiceMcp> betaToolChoiceMcp()
```
    Use this option to force the model to call a specific tool on a remote MCP server.
  - betaToolChoiceCustom
```
 final Optional<BetaToolChoiceCustom> betaToolChoiceCustom()
```
    Use this option to force the model to call a specific custom tool.
  - betaSpecificProgrammaticToolCallingParam
```
 final Optional<JsonValue> betaSpecificProgrammaticToolCallingParam()
```
  - betaToolChoiceApplyPatch
```
 final Optional<BetaToolChoiceApplyPatch> betaToolChoiceApplyPatch()
```
    Forces the model to call the apply_patch tool when executing a tool call.
  - betaToolChoiceShell
```
 final Optional<BetaToolChoiceShell> betaToolChoiceShell()
```
    Forces the model to call the shell tool when a tool call is required.
  - isBetaToolChoiceOptions
```
 final Boolean isBetaToolChoiceOptions()
```
  - isBetaToolChoiceAllowed
```
 final Boolean isBetaToolChoiceAllowed()
```
  - isBetaToolChoiceTypes
```
 final Boolean isBetaToolChoiceTypes()
```
  - isBetaToolChoiceFunction
```
 final Boolean isBetaToolChoiceFunction()
```
  - isBetaToolChoiceMcp
```
 final Boolean isBetaToolChoiceMcp()
```
  - isBetaToolChoiceCustom
```
 final Boolean isBetaToolChoiceCustom()
```
  - isBetaSpecificProgrammaticToolCallingParam
```
 final Boolean isBetaSpecificProgrammaticToolCallingParam()
```
  - isBetaToolChoiceApplyPatch
```
 final Boolean isBetaToolChoiceApplyPatch()
```
  - isBetaToolChoiceShell
```
 final Boolean isBetaToolChoiceShell()
```
  - asBetaToolChoiceOptions
```
 final BetaToolChoiceOptions asBetaToolChoiceOptions()
```
    Controls which (if any) tool is called by the model.
    none means the model will not call any tool and instead generates a message.
    auto means the model can pick between generating a message or calling one or more tools.
    required means the model must call one or more tools.
  - asBetaToolChoiceAllowed
```
 final BetaToolChoiceAllowed asBetaToolChoiceAllowed()
```
    Constrains the tools available to the model to a pre-defined set.
  - asBetaToolChoiceTypes
```
 final BetaToolChoiceTypes asBetaToolChoiceTypes()
```
    Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
  - asBetaToolChoiceFunction
```
 final BetaToolChoiceFunction asBetaToolChoiceFunction()
```
    Use this option to force the model to call a specific function.
  - asBetaToolChoiceMcp
```
 final BetaToolChoiceMcp asBetaToolChoiceMcp()
```
    Use this option to force the model to call a specific tool on a remote MCP server.
  - asBetaToolChoiceCustom
```
 final BetaToolChoiceCustom asBetaToolChoiceCustom()
```
    Use this option to force the model to call a specific custom tool.
  - asBetaSpecificProgrammaticToolCallingParam
```
 final JsonValue asBetaSpecificProgrammaticToolCallingParam()
```
  - asBetaToolChoiceApplyPatch
```
 final BetaToolChoiceApplyPatch asBetaToolChoiceApplyPatch()
```
    Forces the model to call the apply_patch tool when executing a tool call.
  - asBetaToolChoiceShell
```
 final BetaToolChoiceShell asBetaToolChoiceShell()
```
    Forces the model to call the shell tool when a tool call is required.
  - _json
```
 final Optional<JsonValue> _json()
```
  - accept
```
 final <T extends Any> T accept(ResponseCreateParams.ToolChoice.Visitor<T> visitor)
```
    Maps this instance's current variant to a value of type T using the given visitor.
    Note that this method is not forwards compatible with new variants from the API, unless visitor overrides Visitor.unknown. To handle variants not known to this version of the SDK gracefully, consider overriding Visitor.unknown:
    import com.openai.core.JsonValue; import java.util.Optional; Optional<String> result = toolChoice.accept(new ToolChoice.Visitor<Optional<String>>() { @Override public Optional<String> visitBetaToolChoiceOptions(BetaToolChoiceOptions betaToolChoiceOptions) { return Optional.of(betaToolChoiceOptions.toString()); } // ... @Override public Optional<String> unknown(JsonValue json) { // Or inspect the `json`. return Optional.empty(); } });
  - validate
```
 final ResponseCreateParams.ToolChoice validate()
```
    Validates that the types of all values in this object match their expected types recursively.
    This method is not forwards compatible with new types from the API for existing fields.
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - ofBetaToolChoiceOptions
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceOptions(BetaToolChoiceOptions betaToolChoiceOptions)
```
    Controls which (if any) tool is called by the model.
    none means the model will not call any tool and instead generates a message.
    auto means the model can pick between generating a message or calling one or more tools.
    required means the model must call one or more tools.
  - ofBetaToolChoiceAllowed
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceAllowed(BetaToolChoiceAllowed betaToolChoiceAllowed)
```
    Constrains the tools available to the model to a pre-defined set.
  - ofBetaToolChoiceTypes
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceTypes(BetaToolChoiceTypes betaToolChoiceTypes)
```
    Indicates that the model should use a built-in tool to generate a response. Learn more about built-in tools.
  - ofBetaToolChoiceFunction
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceFunction(BetaToolChoiceFunction betaToolChoiceFunction)
```
    Use this option to force the model to call a specific function.
  - ofBetaToolChoiceMcp
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceMcp(BetaToolChoiceMcp betaToolChoiceMcp)
```
    Use this option to force the model to call a specific tool on a remote MCP server.
  - ofBetaToolChoiceCustom
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceCustom(BetaToolChoiceCustom betaToolChoiceCustom)
```
    Use this option to force the model to call a specific custom tool.
  - ofBetaSpecificProgrammaticToolCallingParam
```
 final static ResponseCreateParams.ToolChoice ofBetaSpecificProgrammaticToolCallingParam()
```
  - ofBetaToolChoiceApplyPatch
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceApplyPatch(BetaToolChoiceApplyPatch betaToolChoiceApplyPatch)
```
    Forces the model to call the apply_patch tool when executing a tool call.
  - ofBetaToolChoiceShell
```
 final static ResponseCreateParams.ToolChoice ofBetaToolChoiceShell(BetaToolChoiceShell betaToolChoiceShell)
```
    Forces the model to call the shell tool when a tool call is required.

Class ResponseCreateParams.ToolChoice

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

betaToolChoiceOptions

betaToolChoiceAllowed

betaToolChoiceTypes

betaToolChoiceFunction

betaToolChoiceMcp

betaToolChoiceCustom

betaSpecificProgrammaticToolCallingParam

betaToolChoiceApplyPatch

betaToolChoiceShell

isBetaToolChoiceOptions

isBetaToolChoiceAllowed

isBetaToolChoiceTypes

isBetaToolChoiceFunction

isBetaToolChoiceMcp

isBetaToolChoiceCustom

isBetaSpecificProgrammaticToolCallingParam

isBetaToolChoiceApplyPatch

isBetaToolChoiceShell

asBetaToolChoiceOptions

asBetaToolChoiceAllowed

asBetaToolChoiceTypes

asBetaToolChoiceFunction

asBetaToolChoiceMcp

asBetaToolChoiceCustom

asBetaSpecificProgrammaticToolCallingParam

asBetaToolChoiceApplyPatch

asBetaToolChoiceShell

_json

accept

validate

isValid

equals

hashCode

toString

ofBetaToolChoiceOptions

ofBetaToolChoiceAllowed

ofBetaToolChoiceTypes

ofBetaToolChoiceFunction

ofBetaToolChoiceMcp

ofBetaToolChoiceCustom

ofBetaSpecificProgrammaticToolCallingParam

ofBetaToolChoiceApplyPatch

ofBetaToolChoiceShell