Package org.springframework.ai.openai.api

Record Class OpenAiApi.ChatCompletionMessage.ToolCall

java.lang.Object

java.lang.Record

org.springframework.ai.openai.api.OpenAiApi.ChatCompletionMessage.ToolCall

Record Components:

index - The index of the tool call in the list of tool calls. Required in case of streaming.

id - The ID of the tool call. This ID must be referenced when you submit the tool outputs in using the Submit tool outputs to run endpoint.

type - The type of tool call the output is required for. For now, this is always function.

function - The function definition.

Enclosing class:

OpenAiApi.ChatCompletionMessage

public static record OpenAiApi.ChatCompletionMessage.ToolCall(Integer index, String id, String type, OpenAiApi.ChatCompletionMessage.ChatCompletionFunction function)
extends Record

The relevant tool call.

Constructor Summary

Constructors

Constructor	Description
ToolCall(Integer index, String id, String type, OpenAiApi.ChatCompletionMessage.ChatCompletionFunction function)	Creates an instance of a ToolCall record class.
ToolCall(String id, String type, OpenAiApi.ChatCompletionMessage.ChatCompletionFunction function)

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
OpenAiApi.ChatCompletionMessage.ChatCompletionFunction	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.
Integer	index()	Returns the value of the index record component.
final String	toString()	Returns a string representation of this record class.
String	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

ToolCall

public ToolCall(String id,
 String type,
 OpenAiApi.ChatCompletionMessage.ChatCompletionFunction function)

ToolCall

public ToolCall(Integer index,
 String id,
 String type,
 OpenAiApi.ChatCompletionMessage.ChatCompletionFunction function)

Creates an instance of a ToolCall record class.

Parameters:

index - the value for the index record component

id - the value for the id record component

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.

index

public Integer index()

Returns the value of the index record component.

Returns:

the value of the index record component

id

public String id()

Returns the value of the id record component.

Returns:

the value of the id record component

type

public String type()

Returns the value of the type record component.

Returns:

the value of the type record component

function

public OpenAiApi.ChatCompletionMessage.ChatCompletionFunction function()

Returns the value of the function record component.

Returns:

the value of the function record component