Package com.azure.ai.openai.models

Class FunctionCall

java.lang.Object

com.azure.ai.openai.models.FunctionCall

public final class FunctionCall
extends Object

The name and arguments of a function that should be called, as generated by the model.

Constructor Summary

Constructors

Constructor	Description
FunctionCall(String name, String arguments)	Creates an instance of FunctionCall class.

Method Summary

Modifier and Type	Method	Description
String	getArguments()	Get the arguments property: The arguments to call the function with, as generated by the model in JSON format.
String	getName()	Get the name property: The name of the function to call.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

FunctionCall

public FunctionCall(String name,
 String arguments)

Creates an instance of FunctionCall class.

Parameters:

name - the name value to set.

arguments - the arguments value to set.

Method Details

getName

public String getName()

Get the name property: The name of the function to call.

Returns:

the name value.

getArguments

public String getArguments()

Get the arguments property: 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 arguments value.