Share via

FunctionDefinition Class

Package:
com.azure.ai.openai.models
Maven Artifact:
com.azure:azure-ai-openai:1.0.0-beta.16
  • java.lang.Object
    • com.azure.ai.openai.models.FunctionDefinition

Implements

JsonSerializable<FunctionDefinition>

public final class FunctionDefinition
implements JsonSerializable<FunctionDefinition>

The definition of a caller-specified function that chat completions may invoke in response to matching user input.

Constructor Summary

Constructor Description
FunctionDefinition(String name)

Creates an instance of FunctionDefinition class.

Method Summary

Modifier and Type Method and Description
static FunctionDefinition fromJson(JsonReader jsonReader)

Reads an instance of FunctionDefinition from the JsonReader.
String getDescription()

Get the description property: A description of what the function does.
String getName()

Get the name property: The name of the function to be called.
BinaryData getParameters()

Get the parameters property: The parameters the function accepts, described as a JSON Schema object.
FunctionDefinition setDescription(String description)

Set the description property: A description of what the function does.
FunctionDefinition setParameters(BinaryData parameters)

Set the parameters property: The parameters the function accepts, described as a JSON Schema object.
JsonWriter toJson(JsonWriter jsonWriter)

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

FunctionDefinition

public FunctionDefinition(String name)

Creates an instance of FunctionDefinition class.

Parameters:

name - the name value to set.

Method Details

fromJson

public static FunctionDefinition fromJson(JsonReader jsonReader)

Reads an instance of FunctionDefinition from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

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

getDescription

public String getDescription()

Get the description property: A description of what the function does. The model will use this description when selecting the function and interpreting its parameters.

Returns:

the description value.

getName

public String getName()

Get the name property: The name of the function to be called.

Returns:

the name value.

getParameters

public BinaryData getParameters()

Get the parameters property: The parameters the function accepts, described as a JSON Schema object.

Returns:

the parameters value.

setDescription

public FunctionDefinition setDescription(String description)

Set the description property: A description of what the function does. The model will use this description when selecting the function and interpreting its parameters.

Parameters:

description - the description value to set.

Returns:

the FunctionDefinition object itself.

setParameters

public FunctionDefinition setParameters(BinaryData parameters)

Set the parameters property: The parameters the function accepts, described as a JSON Schema object.

Parameters:

parameters - the parameters value to set.

Returns:

the FunctionDefinition object itself.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to