Package io.github.stefanbratanov.jvm.openai

Record Class DeltaToolCall.RetrievalToolCall

java.lang.Object

java.lang.Record

io.github.stefanbratanov.jvm.openai.DeltaToolCall.RetrievalToolCall

All Implemented Interfaces:

DeltaToolCall

Enclosing interface:

DeltaToolCall

public static record DeltaToolCall.RetrievalToolCall(int index, String id, Map<String,Object> retrieval)
extends Record
implements DeltaToolCall

Nested Class Summary

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

DeltaToolCall.CodeInterpreterToolCall, DeltaToolCall.FunctionToolCall, DeltaToolCall.RetrievalToolCall

Constructor Summary

Constructors

Constructor	Description
RetrievalToolCall(int index, String id, Map<String,Object> retrieval)	Creates an instance of a RetrievalToolCall record class.

Method Summary

Modifier and Type	Method	Description
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.
String	id()	Returns the value of the id record component.
int	index()	Returns the value of the index record component.
Map<String,Object>	retrieval()	Returns the value of the retrieval 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

RetrievalToolCall

public RetrievalToolCall(int index,
 String id,
 Map<String,Object> retrieval)

Creates an instance of a RetrievalToolCall record class.

Parameters:

index - the value for the index record component

id - the value for the id record component

retrieval - the value for the retrieval record component

Method Details

type

public String type()

Description copied from interface: DeltaToolCall

The type of tool call

Specified by:

type in interface DeltaToolCall

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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.

index

public int index()

Returns the value of the index record component.

Specified by:

index in interface DeltaToolCall

Returns:

the value of the index record component

id

public String id()

Returns the value of the id record component.

Specified by:

id in interface DeltaToolCall

Returns:

the value of the id record component

retrieval

public Map<String,Object> retrieval()

Returns the value of the retrieval record component.

Returns:

the value of the retrieval record component