Package com.azure.ai.inference.models

Class FunctionDefinition

java.lang.Object
com.azure.ai.inference.models.FunctionDefinition
All Implemented Interfaces:
com.azure.json.JsonSerializable<FunctionDefinition>
public final class FunctionDefinition extends Object implements com.azure.json.JsonSerializable<FunctionDefinition>
The definition of a caller-specified function that chat completions may invoke in response to matching user input.

  • Constructor Summary

    Constructors
    Constructor
    Description
    FunctionDefinition(String name)
    Creates an instance of FunctionDefinition class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static FunctionDefinition
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of FunctionDefinition from the JsonReader.
    String
    getDescription()
    Get the description property: A description of what the function does.
    String
    getName()
    Get the name property: The name of the function to be called.
    com.azure.core.util.BinaryData
    getParameters()
    Get the parameters property: The parameters the function accepts, described as a JSON Schema object.
    FunctionDefinition
    setDescription(String description)
    Set the description property: A description of what the function does.
    FunctionDefinition
    setParameters(com.azure.core.util.BinaryData parameters)
    Set the parameters property: The parameters the function accepts, described as a JSON Schema object.
    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

    • FunctionDefinition

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

  • Method Details

    • getName

      public String getName()
      Get the name property: The name of the function to be called.
      Returns:
      the name value.

    • getDescription

      public String getDescription()
      Get the description property: A description of what the function does. The model will use this description when selecting the function and interpreting its parameters.
      Returns:
      the description value.

    • setDescription

      public FunctionDefinition setDescription(String description)
      Set the description property: A description of what the function does. The model will use this description when selecting the function and interpreting its parameters.
      Parameters:
      description - the description value to set.
      Returns:
      the FunctionDefinition object itself.

    • getParameters

      public com.azure.core.util.BinaryData getParameters()
      Get the parameters property: The parameters the function accepts, described as a JSON Schema object.
      Returns:
      the parameters value.

    • setParameters

      public FunctionDefinition setParameters(com.azure.core.util.BinaryData parameters)
      Set the parameters property: The parameters the function accepts, described as a JSON Schema object.
      Parameters:
      parameters - the parameters value to set.
      Returns:
      the FunctionDefinition object itself.

    • toJson

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

    • fromJson

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