Package com.azure.ai.agents.persistent.models

Class AzureFunctionToolDefinition

java.lang.Object
com.azure.ai.agents.persistent.models.ToolDefinition
com.azure.ai.agents.persistent.models.AzureFunctionToolDefinition
All Implemented Interfaces:
com.azure.json.JsonSerializable<ToolDefinition>
public final class AzureFunctionToolDefinition extends ToolDefinition
The input definition information for a azure function tool as used to configure an agent.

  • Constructor Details

    • AzureFunctionToolDefinition

      public AzureFunctionToolDefinition(AzureFunctionDefinition azureFunction)
      Creates an instance of AzureFunctionToolDefinition class.
      Parameters:
      azureFunction - the azureFunction value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The object type.
      Overrides:
      getType in class ToolDefinition
      Returns:
      the type value.

    • getAzureFunction

      public AzureFunctionDefinition getAzureFunction()
      Get the azureFunction property: The definition of the concrete function that the function tool should call.
      Returns:
      the azureFunction value.

    • toJson

      public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter) throws IOException
      Specified by:
      toJson in interface com.azure.json.JsonSerializable<ToolDefinition>
      Overrides:
      toJson in class ToolDefinition
      Throws:
      IOException

    • fromJson

      public static AzureFunctionToolDefinition fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of AzureFunctionToolDefinition from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of AzureFunctionToolDefinition 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 AzureFunctionToolDefinition.