All Implemented Interfaces:
```
public final class ChatCompletionToolChoiceOption

                    
```
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. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
none is the default when no tools are present. auto is the default if tools are present.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`ChatCompletionToolChoiceOption.Visitor`	An interface that defines how to map each variant of ChatCompletionToolChoiceOption to a value of type T.
`public final class`	`ChatCompletionToolChoiceOption.Auto`	`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.

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<ChatCompletionToolChoiceOption.Auto>`	`auto()`	`none` means the model will not call any tool and instead generates a message.
`final Optional<ChatCompletionAllowedToolChoice>`	`allowedToolChoice()`	Constrains the tools available to the model to a pre-defined set.
`final Optional<ChatCompletionNamedToolChoice>`	`namedToolChoice()`	Specifies a tool the model should use.
`final Optional<ChatCompletionNamedToolChoiceCustom>`	`namedToolChoiceCustom()`	Specifies a tool the model should use.
`final Boolean`	`isAuto()`
`final Boolean`	`isAllowedToolChoice()`
`final Boolean`	`isNamedToolChoice()`
`final Boolean`	`isNamedToolChoiceCustom()`
`final ChatCompletionToolChoiceOption.Auto`	`asAuto()`	`none` means the model will not call any tool and instead generates a message.
`final ChatCompletionAllowedToolChoice`	`asAllowedToolChoice()`	Constrains the tools available to the model to a pre-defined set.
`final ChatCompletionNamedToolChoice`	`asNamedToolChoice()`	Specifies a tool the model should use.
`final ChatCompletionNamedToolChoiceCustom`	`asNamedToolChoiceCustom()`	Specifies a tool the model should use.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(ChatCompletionToolChoiceOption.Visitor<T> visitor)`
`final ChatCompletionToolChoiceOption`	`validate()`
`final Boolean`	`isValid()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ChatCompletionToolChoiceOption`	`ofAuto(ChatCompletionToolChoiceOption.Auto auto)`	`none` means the model will not call any tool and instead generates a message.
`final static ChatCompletionToolChoiceOption`	`ofAllowedToolChoice(ChatCompletionAllowedToolChoice allowedToolChoice)`	Constrains the tools available to the model to a pre-defined set.
`final static ChatCompletionToolChoiceOption`	`ofNamedToolChoice(ChatCompletionNamedToolChoice namedToolChoice)`	Specifies a tool the model should use.
`final static ChatCompletionToolChoiceOption`	`ofNamedToolChoiceCustom(ChatCompletionNamedToolChoiceCustom namedToolChoiceCustom)`	Specifies a tool the model should use.

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

- Constructor Detail
- Method Detail
  - auto
```
 final Optional<ChatCompletionToolChoiceOption.Auto> auto()
```
    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.
  - allowedToolChoice
```
 final Optional<ChatCompletionAllowedToolChoice> allowedToolChoice()
```
    Constrains the tools available to the model to a pre-defined set.
  - namedToolChoice
```
 final Optional<ChatCompletionNamedToolChoice> namedToolChoice()
```
    Specifies a tool the model should use. Use to force the model to call a specific function.
  - namedToolChoiceCustom
```
 final Optional<ChatCompletionNamedToolChoiceCustom> namedToolChoiceCustom()
```
    Specifies a tool the model should use. Use to force the model to call a specific custom tool.
  - isAuto
```
 final Boolean isAuto()
```
  - isAllowedToolChoice
```
 final Boolean isAllowedToolChoice()
```
  - isNamedToolChoice
```
 final Boolean isNamedToolChoice()
```
  - isNamedToolChoiceCustom
```
 final Boolean isNamedToolChoiceCustom()
```
  - asAuto
```
 final ChatCompletionToolChoiceOption.Auto asAuto()
```
    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.
  - asAllowedToolChoice
```
 final ChatCompletionAllowedToolChoice asAllowedToolChoice()
```
    Constrains the tools available to the model to a pre-defined set.
  - asNamedToolChoice
```
 final ChatCompletionNamedToolChoice asNamedToolChoice()
```
    Specifies a tool the model should use. Use to force the model to call a specific function.
  - asNamedToolChoiceCustom
```
 final ChatCompletionNamedToolChoiceCustom asNamedToolChoiceCustom()
```
    Specifies a tool the model should use. Use to force the model to call a specific custom tool.
  - _json
```
 final Optional<JsonValue> _json()
```
  - accept
```
 final <T extends Any> T accept(ChatCompletionToolChoiceOption.Visitor<T> visitor)
```
  - validate
```
 final ChatCompletionToolChoiceOption validate()
```
  - isValid
```
 final Boolean isValid()
```
  - equals
```
 Boolean equals(Object other)
```
  - hashCode
```
 Integer hashCode()
```
  - toString
```
 String toString()
```
  - ofAuto
```
 final static ChatCompletionToolChoiceOption ofAuto(ChatCompletionToolChoiceOption.Auto auto)
```
    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.
  - ofAllowedToolChoice
```
 final static ChatCompletionToolChoiceOption ofAllowedToolChoice(ChatCompletionAllowedToolChoice allowedToolChoice)
```
    Constrains the tools available to the model to a pre-defined set.
  - ofNamedToolChoice
```
 final static ChatCompletionToolChoiceOption ofNamedToolChoice(ChatCompletionNamedToolChoice namedToolChoice)
```
    Specifies a tool the model should use. Use to force the model to call a specific function.
  - ofNamedToolChoiceCustom
```
 final static ChatCompletionToolChoiceOption ofNamedToolChoiceCustom(ChatCompletionNamedToolChoiceCustom namedToolChoiceCustom)
```
    Specifies a tool the model should use. Use to force the model to call a specific custom tool.

Class ChatCompletionToolChoiceOption

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

auto

allowedToolChoice

namedToolChoice

namedToolChoiceCustom

isAuto

isAllowedToolChoice

isNamedToolChoice

isNamedToolChoiceCustom

asAuto

asAllowedToolChoice

asNamedToolChoice

asNamedToolChoiceCustom

_json

accept

validate

isValid

equals

hashCode

toString

ofAuto

ofAllowedToolChoice

ofNamedToolChoice

ofNamedToolChoiceCustom