Package io.github.stefanbratanov.jvm.openai

Record Class ToolCall.FunctionToolCall

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.ToolCall.FunctionToolCall

All Implemented Interfaces:

ToolCall

Enclosing interface:

ToolCall

public static record ToolCall.FunctionToolCall(String id, ToolCall.FunctionToolCall.Function function)
extends Record
implements ToolCall

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	ToolCall.FunctionToolCall.Function

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

ToolCall.CodeInterpreterToolCall, ToolCall.FileSearchToolCall, ToolCall.FunctionToolCall

Constructor Summary

Constructors

Constructor	Description
FunctionToolCall(String id, ToolCall.FunctionToolCall.Function function)	Creates an instance of a FunctionToolCall record class.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionToolCall

public FunctionToolCall(String id,
 ToolCall.FunctionToolCall.Function function)

Creates an instance of a FunctionToolCall record class.

Parameters:

id - the value for the id record component

function - the value for the function record component

Method Details

type

public String type()

Description copied from interface: ToolCall

The type of tool call

Specified by:

type in interface ToolCall

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.

id

public String id()

Returns the value of the id record component.

Specified by:

id in interface ToolCall

Returns:

the value of the id record component

function

public ToolCall.FunctionToolCall.Function function()

Returns the value of the function record component.

Returns:

the value of the function record component