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

Class RunStepFunctionToolCallDetails

java.lang.Object
com.azure.ai.openai.assistants.models.RunStepFunctionToolCallDetails
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunStepFunctionToolCallDetails>
public final class RunStepFunctionToolCallDetails extends Object implements com.azure.json.JsonSerializable<RunStepFunctionToolCallDetails>
The detailed information about the function called by the model.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RunStepFunctionToolCallDetails
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RunStepFunctionToolCallDetails from the JsonReader.
    String
    getArguments()
    Get the arguments property: The arguments that the model requires are provided to the named function.
    String
    getName()
    Get the name property: The name of the function.
    String
    getOutput()
    Get the output property: The output of the function, only populated for function calls that have already have had their outputs submitted.
    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 that the model requires are provided to the named function.
      Returns:
      the arguments value.

    • getOutput

      public String getOutput()
      Get the output property: The output of the function, only populated for function calls that have already have had their outputs submitted.
      Returns:
      the output value.

    • toJson

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

    • fromJson

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