Interface ToolChoice

All Known Implementing Classes:

ToolChoice.Auto, ToolChoice.Named, ToolChoice.None, ToolChoice.Required

public sealed interface ToolChoice
permits ToolChoice.Auto, ToolChoice.None, ToolChoice.Required, ToolChoice.Named

OpenAI tool_choice semantics.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	ToolChoice.Auto	Model may call tools or answer normally.
static final record	ToolChoice.Named	Force a specific function by name.
static final record	ToolChoice.None	Do not inject tools; disable tool-call parsing.
static final record	ToolChoice.Required	Model should call at least one tool.

Field Summary

Fields

Modifier and Type	Field	Description
static final ToolChoice	AUTO	Shared singleton for ToolChoice.Auto.
static final ToolChoice	NONE	Shared singleton for ToolChoice.None.
static final ToolChoice	REQUIRED	Shared singleton for ToolChoice.Required.

Field Details

AUTO

static final ToolChoice AUTO

Shared singleton for ToolChoice.Auto.

NONE

static final ToolChoice NONE

Shared singleton for ToolChoice.None.

REQUIRED

static final ToolChoice REQUIRED

Shared singleton for ToolChoice.Required.