ToolChoice

Represents a sealed class that defines choices for tools used in a process or operation.

This class serves as the base for specifying different tool-related choices. Possible options include automatic tool selection, no tool usage, or specifying a function-based tool choice.

Subclasses:

  • Auto: Represents the automatic tool selection mode.

  • None: Represents a state where no tool is selected.

  • Function: Represents a specific tool choice based on a ToolChoiceFunction.

Inheritors

Types

Link copied to clipboard
@SerialName(value = "auto")
object Auto : ToolChoice
Link copied to clipboard
@SerialName(value = "function")
data class Function(val function: ToolChoiceFunction) : ToolChoice
Link copied to clipboard
@SerialName(value = "none")
object None : ToolChoice