Enum ToolChoice 

pub enum ToolChoice {
    Auto,
    Required,
    None,
}

Tool choice behavior for agent execution

Controls when the agent uses tools during execution.

YAML Syntax

agent:
  prompt: "..."
  tool_choice: auto    # auto | required | none

Variants

Auto

LLM decides when to use tools (default behavior)

Required

Must use at least one tool per turn

None

Never use tools (text-only response)

Implementations

impl ToolChoice

pub fn as_str(&self) -> &'static str

Convert to rig-core compatible string representation

Trait Implementations

impl Clone for ToolChoice

fn clone(&self) -> ToolChoice

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ToolChoice

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ToolChoice

fn default() -> ToolChoice

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ToolChoice

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ToolChoice> for ToolChoice

Convert Nika’s ToolChoice to rig-core’s ToolChoice.

Nika’s ToolChoice maps directly to rig-core’s ToolChoice variants:

• Auto → LLM decides when to use tools (default)
• Required → Must use at least one tool per turn
• None → Never use tools (text-only response)

fn from(choice: NikaToolChoice) -> Self

Converts to this type from the input type.

impl PartialEq for ToolChoice

fn eq(&self, other: &ToolChoice) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ToolChoice

impl StructuralPartialEq for ToolChoice