Package nl.dannyj.mistral.models.completion.tool

Class SpecificToolChoice

java.lang.Object

nl.dannyj.mistral.models.completion.tool.SpecificToolChoice

All Implemented Interfaces:

ToolChoiceOption

public final class SpecificToolChoice
extends Object
implements ToolChoiceOption

Represents the object variant for the 'tool_choice' parameter in a ChatCompletionRequest. This forces the model to call a specific function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpecificToolChoice.SpecificToolChoiceBuilder

Constructor Summary

Constructors

Constructor	Description
SpecificToolChoice()
SpecificToolChoice(ToolType type, FunctionName function)	Creates a new SpecificToolChoice instance.

Method Summary

Modifier and Type	Method	Description
static SpecificToolChoice.SpecificToolChoiceBuilder	builder()
boolean	equals(Object o)
FunctionName	getFunction()	The details of the function to be called.
ToolType	getType()	The type of the tool to be called.
int	hashCode()
void	setFunction(FunctionName function)	The details of the function to be called.
void	setType(ToolType type)	The type of the tool to be called.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SpecificToolChoice

public SpecificToolChoice()

SpecificToolChoice

public SpecificToolChoice(ToolType type,
 FunctionName function)

Creates a new SpecificToolChoice instance.

Parameters:

type - The type of the tool.

function - The function name.

Method Details

builder

public static SpecificToolChoice.SpecificToolChoiceBuilder builder()

getType

public ToolType getType()

The type of the tool to be called. Currently, only "function" is supported.

Returns:

The type of the tool.

getFunction

public FunctionName getFunction()

The details of the function to be called.

Returns:

The function name.

setType

public void setType(ToolType type)

The type of the tool to be called. Currently, only "function" is supported.

Parameters:

type - The type of the tool.

setFunction

public void setFunction(FunctionName function)

The details of the function to be called.

Parameters:

function - The function name.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object