Class ChatCompletionMessageToolCallFunction
java.lang.Object
com.sap.ai.sdk.foundationmodels.openai.generated.model.ChatCompletionMessageToolCallFunction
The function that the model called.
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionSet the arguments of thisChatCompletionMessageToolCallFunctioninstance and return the same instance.booleanThe arguments to call the function with, as generated by the model in JSON format.getCustomField(String name) Deprecated.Get the names of the unrecognizable properties of theChatCompletionMessageToolCallFunction.getName()The name of the function to call.inthashCode()Set the name of thisChatCompletionMessageToolCallFunctioninstance and return the same instance.voidsetArguments(String arguments) Set the arguments of thisChatCompletionMessageToolCallFunctioninstance.voidsetCustomField(String customFieldName, Object customFieldValue) Set an unrecognizable property of thisChatCompletionMessageToolCallFunctioninstance.voidSet the name of thisChatCompletionMessageToolCallFunctioninstance.toMap()Get the value of all properties of thisChatCompletionMessageToolCallFunctioninstance including unrecognized properties.toString()
-
Constructor Details
-
ChatCompletionMessageToolCallFunction
public ChatCompletionMessageToolCallFunction()
-
-
Method Details
-
name
Set the name of thisChatCompletionMessageToolCallFunctioninstance and return the same instance.- Parameters:
name- The name of the function to call.- Returns:
- The same instance of this
ChatCompletionMessageToolCallFunctionclass
-
getName
The name of the function to call.- Returns:
- name The name of this
ChatCompletionMessageToolCallFunctioninstance.
-
setName
Set the name of thisChatCompletionMessageToolCallFunctioninstance.- Parameters:
name- The name of the function to call.
-
arguments
Set the arguments of thisChatCompletionMessageToolCallFunctioninstance 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
ChatCompletionMessageToolCallFunctionclass
-
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
ChatCompletionMessageToolCallFunctioninstance.
-
setArguments
Set the arguments of thisChatCompletionMessageToolCallFunctioninstance.- 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
Get the names of the unrecognizable properties of theChatCompletionMessageToolCallFunction.- Returns:
- The set of properties names
-
getCustomField
@Nullable @Deprecated public Object getCustomField(@Nonnull String name) throws NoSuchElementException Deprecated.UsetoMap()instead.Get the value of an unrecognizable property of thisChatCompletionMessageToolCallFunctioninstance.- 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
Get the value of all properties of thisChatCompletionMessageToolCallFunctioninstance including unrecognized properties.- Returns:
- The map of all properties
-
setCustomField
Set an unrecognizable property of thisChatCompletionMessageToolCallFunctioninstance. 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 propertycustomFieldValue- The value of the property
-
equals
-
hashCode
public int hashCode() -
toString
-
toMap()instead.