OpenApiFunctionDefinitionFunction Class

Package:
com.azure.ai.agents.models
Maven Artifact:
com.azure:azure-ai-agents:2.2.0
  • java.lang.Object
    • com.azure.ai.agents.models.OpenApiFunctionDefinitionFunction

Implements

JsonSerializable<OpenApiFunctionDefinitionFunction>

public final class OpenApiFunctionDefinitionFunction
implements JsonSerializable<OpenApiFunctionDefinitionFunction>

The OpenApiFunctionDefinitionFunction model.

Method Summary

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

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

Get the description property: A description of what the function does, used by the model to choose when and how to call the function.
String getName()

Get the name property: The name of the function to be called.
Map<String,BinaryData> getParameters()

Get the parameters property: The parameters the functions 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

Method Details

fromJson

public static OpenApiFunctionDefinitionFunction fromJson(JsonReader jsonReader)

Reads an instance of OpenApiFunctionDefinitionFunction from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of OpenApiFunctionDefinitionFunction 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, used by the model to choose when and how to call the function.

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 Map<String,BinaryData> getParameters()

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

Returns:

the parameters value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

Applies to