Package com.azure.ai.openai.assistants.models

Class FunctionToolDefinition

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

  • Constructor Details

    • FunctionToolDefinition

      public FunctionToolDefinition(FunctionDefinition function)
      Creates an instance of FunctionToolDefinition class.
      Parameters:
      function - the function value to set.

  • Method Details

    • getFunction

      public FunctionDefinition getFunction()
      Get the function property: The definition of the concrete function that the function tool should call.
      Returns:
      the function value.

    • fromJson

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

    • getType

      public String getType()
      Get the type property: The object type.
      Overrides:
      getType in class ToolDefinition
      Returns:
      the type 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