Package io.github.stefanbratanov.jvm.openai

Record Class ToolChoice

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.ToolChoice

public record ToolChoice(String type, ToolChoice.Function function)
extends Record

Specifies a tool the model should use. Use to force the model to call a specific function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ToolChoice.Function

Constructor Summary

Constructors

Constructor	Description
ToolChoice(String type, ToolChoice.Function function)	Creates an instance of a ToolChoice record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
ToolChoice.Function	function()	Returns the value of the function record component.
static ToolChoice	functionToolChoice(ToolChoice.Function function)
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.

Methods inherited from class java.lang.Object

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

Constructor Details

ToolChoice

public ToolChoice(String type,
 ToolChoice.Function function)

Creates an instance of a ToolChoice record class.

Parameters:

type - the value for the type record component

function - the value for the function record component

Method Details

functionToolChoice

public static ToolChoice functionToolChoice(ToolChoice.Function function)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

function

public ToolChoice.Function function()

Returns the value of the function record component.

Returns:

the value of the function record component