All Implemented Interfaces:

com.openai.core.Enum
```
public final class ToolChoiceOptions
 implements Enum
                    
```
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.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public enum`	`ToolChoiceOptions.Known`	An enum containing ToolChoiceOptions's known values.
`public enum`	`ToolChoiceOptions.Value`	An enum containing ToolChoiceOptions's known values, as well as an _UNKNOWN member. An instance of ToolChoiceOptions can contain an unknown value in a couple of cases: It was deserialized from data that doesn't match any known member. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of. It was constructed with an arbitrary value using the of method.

Field Summary

Fields
Modifier and Type	Field	Description
`public final static ToolChoiceOptions`	`NONE`
`public final static ToolChoiceOptions`	`AUTO`
`public final static ToolChoiceOptions`	`REQUIRED`

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final JsonField<String>`	`_value()`	Returns this class instance's raw value.
`final ToolChoiceOptions.Value`	`value()`	Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
`final ToolChoiceOptions.Known`	`known()`	Returns an enum member corresponding to this class instance's value.
`final String`	`asString()`	Returns this class instance's primitive wire representation.
`final ToolChoiceOptions`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ToolChoiceOptions`	`of(String value)`

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

- Constructor Detail
- Method Detail
  - _value
```
 final JsonField<String> _value()
```
    Returns this class instance's raw value.
    This is usually only useful if this instance was deserialized from data that doesn't match any known member, and you want to know that value. For example, if the SDK is on an older version than the API, then the API may respond with new members that the SDK is unaware of.
  - value
```
 final ToolChoiceOptions.Value value()
```
    Returns an enum member corresponding to this class instance's value, or Value._UNKNOWN if the class was instantiated with an unknown value.
    Use the known method instead if you're certain the value is always known or if you want to throw for the unknown case.
  - known
```
 final ToolChoiceOptions.Known known()
```
    Returns an enum member corresponding to this class instance's value.
    Use the value method instead if you're uncertain the value is always known and don't want to throw for the unknown case.
  - asString
```
 final String asString()
```
    Returns this class instance's primitive wire representation.
    This differs from the toString method because that method is primarily for debugging and generally doesn't throw.
  - validate
```
 final ToolChoiceOptions validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - of
```
 final static ToolChoiceOptions of(String value)
```

Class ToolChoiceOptions

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

_value

value

known

asString

validate

isValid

equals

hashCode

toString

of