Package com.azure.ai.openai.models

Class FunctionName

java.lang.Object

com.azure.ai.openai.models.FunctionName

All Implemented Interfaces:

com.azure.json.JsonSerializable<FunctionName>

public final class FunctionName
extends Object
implements com.azure.json.JsonSerializable<FunctionName>

A structure that specifies the exact name of a specific, request-provided function to use when processing a chat completions operation.

Constructor Summary

Constructors

Constructor	Description
FunctionName(String name)	Creates an instance of FunctionName class.

Method Summary

Modifier and Type	Method	Description
static FunctionName	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of FunctionName from the JsonReader.
String	getName()	Get the name property: The name of the function to call.
com.azure.json.JsonWriter	toJson(com.azure.json.JsonWriter jsonWriter)

Methods inherited from class java.lang.Object

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

Constructor Details

FunctionName

public FunctionName(String name)

Creates an instance of FunctionName class.

Parameters:

name - the name value to set.

Method Details

getName

public String getName()

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

Returns:

the name value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<FunctionName>

Throws:

IOException

fromJson

public static FunctionName fromJson(com.azure.json.JsonReader jsonReader)
                             throws IOException

Reads an instance of FunctionName from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of FunctionName if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IllegalStateException - If the deserialized JSON object was missing any required properties.

IOException - If an error occurs while reading the FunctionName.