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

Class RequiredFunctionToolCallDetails

java.lang.Object
com.azure.ai.openai.assistants.models.RequiredFunctionToolCallDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<RequiredFunctionToolCallDetails>
public final class RequiredFunctionToolCallDetails extends Object implements com.azure.json.JsonSerializable<RequiredFunctionToolCallDetails>
The detailed information for a function invocation, as provided by a required action invoking a function tool, that includes the name of and arguments to the function.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RequiredFunctionToolCallDetails
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RequiredFunctionToolCallDetails from the JsonReader.
    String
    getArguments()
    Get the arguments property: The arguments to use when invoking the named function, as provided by the model.
    String
    getName()
    Get the name property: The name of the function.
    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

  • Method Details

    • getName

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

    • getArguments

      public String getArguments()
      Get the arguments property: The arguments to use when invoking the named function, as provided by the model. Arguments are presented as a JSON document that should be validated and parsed for evaluation.
      Returns:
      the arguments value.

    • toJson

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

    • fromJson

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