Package com.azure.ai.openai.responses.models

Class ResponsesFunctionTool

java.lang.Object
com.azure.ai.openai.responses.models.ResponsesTool
com.azure.ai.openai.responses.models.ResponsesFunctionTool
All Implemented Interfaces:
com.azure.json.JsonSerializable<ResponsesTool>
public final class ResponsesFunctionTool extends ResponsesTool
The ResponsesFunctionTool model.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ResponsesFunctionTool(String name, String description, com.azure.core.util.BinaryData parameters, boolean strict)
    Creates an instance of ResponsesFunctionTool class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static ResponsesFunctionTool
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of ResponsesFunctionTool from the JsonReader.
    String
    getDescription()
    Get the description property: The description property.
    String
    getName()
    Get the name property: The name property.
    com.azure.core.util.BinaryData
    getParameters()
    Get the parameters property: The parameters property.
    ResponsesToolType
    getType()
    Get the type property: The type property.
    boolean
    isStrict()
    Get the strict property: The strict property.
    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

    • ResponsesFunctionTool

      public ResponsesFunctionTool(String name, String description, com.azure.core.util.BinaryData parameters, boolean strict)
      Creates an instance of ResponsesFunctionTool class.
      Parameters:
      name - the name value to set.
      description - the description value to set.
      parameters - the parameters value to set.
      strict - the strict value to set.

  • Method Details

    • getType

      public ResponsesToolType getType()
      Get the type property: The type property.
      Overrides:
      getType in class ResponsesTool
      Returns:
      the type value.

    • getName

      public String getName()
      Get the name property: The name property.
      Returns:
      the name value.

    • getDescription

      public String getDescription()
      Get the description property: The description property.
      Returns:
      the description value.

    • getParameters

      public com.azure.core.util.BinaryData getParameters()
      Get the parameters property: The parameters property.
      Returns:
      the parameters value.

    • isStrict

      public boolean isStrict()
      Get the strict property: The strict property.
      Returns:
      the strict value.

    • toJson

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

    • fromJson

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