Package org.springframework.ai.openai.api

Record Class OpenAiApi.FunctionTool

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.FunctionTool

Record Components:

type - The type of the tool. Currently, only 'function' is supported.

function - The function definition.

Enclosing class:

OpenAiApi

public static record OpenAiApi.FunctionTool(OpenAiApi.FunctionTool.Type type, OpenAiApi.FunctionTool.Function function)
extends Record

Represents a tool the model may call. Currently, only functions are supported as a tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	OpenAiApi.FunctionTool.Function	Function definition.
static enum	OpenAiApi.FunctionTool.Type	Create a tool of type 'function' and the given function definition.

Constructor Summary

Constructors

Constructor	Description
FunctionTool(OpenAiApi.FunctionTool.Function function)	Create a tool of type 'function' and the given function definition.
FunctionTool(OpenAiApi.FunctionTool.Type type, OpenAiApi.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.
OpenAiApi.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.
OpenAiApi.FunctionTool.Type	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

FunctionTool

@ConstructorBinding
public FunctionTool(OpenAiApi.FunctionTool.Function function)

Create a tool of type 'function' and the given function definition.

Parameters:

function - function definition.

FunctionTool

public FunctionTool(OpenAiApi.FunctionTool.Type type,
 OpenAiApi.FunctionTool.Function function)

Creates an instance of a FunctionTool record class.

Parameters:

type - the value for the type record component

function - the value for the function 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.

type

public OpenAiApi.FunctionTool.Type type()

Returns the value of the type record component.

Returns:

the value of the type record component

function

public OpenAiApi.FunctionTool.Function function()

Returns the value of the function record component.

Returns:

the value of the function record component