Package io.github.stefanbratanov.jvm.openai

Record Class Tool.FunctionTool

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.Tool.FunctionTool

All Implemented Interfaces:

Tool

Enclosing interface:

Tool

public static record Tool.FunctionTool(Tool.FunctionTool.Function function)
extends Record
implements Tool

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Tool.FunctionTool.Function

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

Tool.CodeInterpreterTool, Tool.FunctionTool, Tool.RetrievalTool

Constructor Summary

Constructors

Constructor	Description
FunctionTool(Tool.FunctionTool.Function function)	Creates an instance of a FunctionTool record class.

Method Summary

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

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionTool

public FunctionTool(Tool.FunctionTool.Function function)

Creates an instance of a FunctionTool record class.

Parameters:

function - the value for the function record component

Method Details

type

public String type()

Specified by:

type in interface Tool

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.

function

public Tool.FunctionTool.Function function()

Returns the value of the function record component.

Returns:

the value of the function record component