Package com.sap.ai.sdk.foundationmodels.openai.generated.model

Class ChatCompletionMessageToolCallFunction

java.lang.Object

com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionMessageToolCallFunction

public class ChatCompletionMessageToolCallFunction
extends Object

The function that the model called.

Constructor Summary

Constructors

Constructor	Description
ChatCompletionMessageToolCallFunction()

Method Summary

Modifier and Type	Method	Description
ChatCompletionMessageToolCallFunction	arguments(String arguments)	Set the arguments of this ChatCompletionMessageToolCallFunction instance and return the same instance.
boolean	equals(Object o)
String	getArguments()	The arguments to call the function with, as generated by the model in JSON format.
Object	getCustomField(String name)	Deprecated. Use toMap() instead.
Set<String>	getCustomFieldNames()	Get the names of the unrecognizable properties of the ChatCompletionMessageToolCallFunction.
String	getName()	The name of the function to call.
int	hashCode()
ChatCompletionMessageToolCallFunction	name(String name)	Set the name of this ChatCompletionMessageToolCallFunction instance and return the same instance.
void	setArguments(String arguments)	Set the arguments of this ChatCompletionMessageToolCallFunction instance.
void	setCustomField(String customFieldName, Object customFieldValue)	Set an unrecognizable property of this ChatCompletionMessageToolCallFunction instance.
void	setName(String name)	Set the name of this ChatCompletionMessageToolCallFunction instance.
Map<String,Object>	toMap()	Get the value of all properties of this ChatCompletionMessageToolCallFunction instance including unrecognized properties.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ChatCompletionMessageToolCallFunction

public ChatCompletionMessageToolCallFunction()

Method Details

name

@Nonnull
public ChatCompletionMessageToolCallFunction name(@Nonnull
 String name)

Set the name of this ChatCompletionMessageToolCallFunction instance and return the same instance.

Parameters:

name - The name of the function to call.

Returns:

The same instance of this ChatCompletionMessageToolCallFunction class

getName

@Nonnull
public String getName()

The name of the function to call.

Returns:

name The name of this ChatCompletionMessageToolCallFunction instance.

setName

public void setName(@Nonnull
 String name)

Set the name of this ChatCompletionMessageToolCallFunction instance.

Parameters:

name - The name of the function to call.

arguments

@Nonnull
public ChatCompletionMessageToolCallFunction arguments(@Nonnull
 String arguments)

Set the arguments of this ChatCompletionMessageToolCallFunction instance and return the same instance.

Parameters:

arguments - The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

Returns:

The same instance of this ChatCompletionMessageToolCallFunction class

getArguments

@Nonnull
public String getArguments()

The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

Returns:

arguments The arguments of this ChatCompletionMessageToolCallFunction instance.

setArguments

public void setArguments(@Nonnull
 String arguments)

Set the arguments of this ChatCompletionMessageToolCallFunction instance.

Parameters:

arguments - The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

getCustomFieldNames

@Nonnull
public Set<String> getCustomFieldNames()

Get the names of the unrecognizable properties of the ChatCompletionMessageToolCallFunction.

Returns:

The set of properties names

getCustomField

@Nullable
@Deprecated
public Object getCustomField(@Nonnull
 String name)
                      throws NoSuchElementException

Deprecated.

Use toMap() instead.

Get the value of an unrecognizable property of this ChatCompletionMessageToolCallFunction instance.

Parameters:

name - The name of the property

Returns:

The value of the property

Throws:

NoSuchElementException - If no property with the given name could be found.

toMap

@Nonnull
public Map<String,Object> toMap()

Get the value of all properties of this ChatCompletionMessageToolCallFunction instance including unrecognized properties.

Returns:

The map of all properties

setCustomField

public void setCustomField(@Nonnull
 String customFieldName,
 @Nullable
 Object customFieldValue)

Set an unrecognizable property of this ChatCompletionMessageToolCallFunction instance. If the map previously contained a mapping for the key, the old value is replaced by the specified value.

Parameters:

customFieldName - The name of the property

customFieldValue - The value of the property

equals

public boolean equals(@Nullable
 Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

@Nonnull
public String toString()

Overrides:

toString in class Object