Package io.github.stefanbratanov.jvm.openai

Record Class AssistantsToolChoice.StringToolChoice

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.AssistantsToolChoice.StringToolChoice

Record Components:

choice - `none` means the model will not call a function and instead generates a message. `auto` means the model can pick between generating a message or calling a function.

All Implemented Interfaces:

AssistantsToolChoice

Enclosing interface:

AssistantsToolChoice

public static record AssistantsToolChoice.StringToolChoice(String choice)
extends Record
implements AssistantsToolChoice

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.stefanbratanov.jvm.openai.AssistantsToolChoice

AssistantsToolChoice.StringToolChoice

Constructor Summary

Constructors

Constructor	Description
StringToolChoice(String choice)	Creates an instance of a StringToolChoice record class.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

StringToolChoice

public StringToolChoice(String choice)

Creates an instance of a StringToolChoice record class.

Parameters:

choice - the value for the choice record component

Method Details

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.

choice

public String choice()

Returns the value of the choice record component.

Returns:

the value of the choice record component