All Implemented Interfaces:
```
public final class ToolChoice

                    
```
How the model should use the provided tools. The model can use a specific tool, any available tool, decide by itself, or not use tools at all.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`public interface`	`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<ToolChoiceAuto>`	`auto()`	The model will automatically decide whether to use tools.
`final Optional<ToolChoiceAny>`	`any()`	The model will use any available tools.
`final Optional<ToolChoiceTool>`	`tool()`	The model will use the specified tool with `tool_choice.name`.
`final Optional<ToolChoiceNone>`	`none()`	The model will not be allowed to use tools.
`final Boolean`	`isAuto()`
`final Boolean`	`isAny()`
`final Boolean`	`isTool()`
`final Boolean`	`isNone()`
`final ToolChoiceAuto`	`asAuto()`	The model will automatically decide whether to use tools.
`final ToolChoiceAny`	`asAny()`	The model will use any available tools.
`final ToolChoiceTool`	`asTool()`	The model will use the specified tool with `tool_choice.name`.
`final ToolChoiceNone`	`asNone()`	The model will not be allowed to use tools.
`final Optional<JsonValue>`	`_json()`
`final <T extends Any> T`	`accept(ToolChoice.Visitor<T> visitor)`
`final ToolChoice`	`validate()`
`Boolean`	`equals(Object other)`
`Integer`	`hashCode()`
`String`	`toString()`
`final static ToolChoice`	`ofAuto(ToolChoiceAuto auto)`	The model will automatically decide whether to use tools.
`final static ToolChoice`	`ofAny(ToolChoiceAny any)`	The model will use any available tools.
`final static ToolChoice`	`ofTool(ToolChoiceTool tool)`	The model will use the specified tool with `tool_choice.name`.
`final static ToolChoice`	`ofNone(ToolChoiceNone none)`	The model will not be allowed to use tools.

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<ToolChoiceAuto> auto()
```
The model will automatically decide whether to use tools.

any
```
 final Optional<ToolChoiceAny> any()
```
The model will use any available tools.

tool
```
 final Optional<ToolChoiceTool> tool()
```
The model will use the specified tool with tool_choice.name.

none
```
 final Optional<ToolChoiceNone> none()
```
The model will not be allowed to use tools.

isAuto
```
 final Boolean isAuto()
```

isAny
```
 final Boolean isAny()
```

isTool
```
 final Boolean isTool()
```

isNone
```
 final Boolean isNone()
```

asAuto
```
 final ToolChoiceAuto asAuto()
```
The model will automatically decide whether to use tools.

asAny
```
 final ToolChoiceAny asAny()
```
The model will use any available tools.

asTool
```
 final ToolChoiceTool asTool()
```
The model will use the specified tool with tool_choice.name.

asNone
```
 final ToolChoiceNone asNone()
```
The model will not be allowed to use tools.

_json
```
 final Optional<JsonValue> _json()
```

accept

 final <T extends Any> T accept(ToolChoice.Visitor<T> visitor)

validate
```
 final ToolChoice validate()
```

equals
```
 Boolean equals(Object other)
```

hashCode
```
 Integer hashCode()
```

toString
```
 String toString()
```

ofAuto
```
 final static ToolChoice ofAuto(ToolChoiceAuto auto)
```
The model will automatically decide whether to use tools.

ofAny

 final static ToolChoice ofAny(ToolChoiceAny any)

The model will use any available tools.

ofTool
```
 final static ToolChoice ofTool(ToolChoiceTool tool)
```
The model will use the specified tool with tool_choice.name.

ofNone

 final static ToolChoice ofNone(ToolChoiceNone none)

The model will not be allowed to use tools.

Class ToolChoice

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Method Detail

auto

any

tool

none

isAuto

isAny

isTool

isNone

asAuto

asAny

asTool

asNone

_json

accept

validate

equals

hashCode

toString

ofAuto

ofAny

ofTool

ofNone