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

Class ToolDefinition

java.lang.Object
com.azure.ai.openai.assistants.models.ToolDefinition
All Implemented Interfaces:
com.azure.json.JsonSerializable<ToolDefinition>
Direct Known Subclasses:
CodeInterpreterToolDefinition, FileSearchToolDefinition, FunctionToolDefinition
public class ToolDefinition extends Object implements com.azure.json.JsonSerializable<ToolDefinition>
An abstract representation of an input tool definition that an assistant can use.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ToolDefinition()
    Creates an instance of ToolDefinition class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ToolDefinition
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ToolDefinition from the JsonReader.
    String
    getType()
    Get the type property: The object type.
    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

    Methods inherited from interface com.azure.json.JsonSerializable

    toJson, toJson, toJsonBytes, toJsonString

  • Constructor Details

    • ToolDefinition

      public ToolDefinition()
      Creates an instance of ToolDefinition class.

  • Method Details

    • toJson

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

    • fromJson

      public static ToolDefinition fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of ToolDefinition from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of ToolDefinition if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the ToolDefinition.

    • getType

      public String getType()
      Get the type property: The object type.
      Returns:
      the type value.