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

Class RunStepFunctionToolCall

java.lang.Object
com.azure.ai.openai.assistants.models.RunStepToolCall
com.azure.ai.openai.assistants.models.RunStepFunctionToolCall
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunStepToolCall>
public final class RunStepFunctionToolCall extends RunStepToolCall
A record of a call to a function tool, issued by the model in evaluation of a defined tool, that represents the inputs and output consumed and emitted by the specified function.

  • Method Details

    • getFunction

      public RunStepFunctionToolCallDetails getFunction()
      Get the function property: The detailed information about the function called by the model.
      Returns:
      the function value.

    • getType

      public String getType()
      Get the type property: The object type.
      Overrides:
      getType in class RunStepToolCall
      Returns:
      the type value.

    • toJson

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

    • fromJson

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