ChatGPT-Java-API/com.cjcrafter.openai.chat.tool/ToolChoice

ToolChoice

Sometimes, you may want chat to be forced to use a tool. Sometimes you may want to prevent chat from using a tool. This sealed class represents all options that can be used with the Chat endpoint.

In general, you should use ToolChoice.Auto unless you have a specific reason not to.

Use the helper methods in the chat request builder:

ChatRequest.Builder.useAutoTool ->ToolChoice.Auto
ChatRequest.Builder.useNoTool ->ToolChoice.None
ChatRequest.Builder.useFunctionTool ->ToolChoice.Function

Inheritors

Auto

None

Function

Types

Auto

data object Auto : ToolChoice

Lets ChatGPT automatically decide whether to use a tool, and which tool to use. This is the default value (when toolChoice is null).

Companion

object Companion

Function

data class Function(var name: String) : ToolChoice

Forces ChatGPT to use the specified function.

None

data object None : ToolChoice

Prevents ChatGPT from using any tool.