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

Class RunStepDeltaFunction

java.lang.Object
com.azure.ai.openai.assistants.models.RunStepDeltaFunction
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunStepDeltaFunction>
public final class RunStepDeltaFunction extends Object implements com.azure.json.JsonSerializable<RunStepDeltaFunction>
Represents the function data in a streaming run step delta's function tool call.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RunStepDeltaFunction
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RunStepDeltaFunction from the JsonReader.
    String
    getArguments()
    Get the arguments property: The arguments passed to the function as input.
    String
    getName()
    Get the name property: The name of the function.
    String
    getOutput()
    Get the output property: The output of the function, null if outputs have not yet been 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 passed to the function as input.
      Returns:
      the arguments value.

    • getOutput

      public String getOutput()
      Get the output property: The output of the function, null if outputs have not yet been 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<RunStepDeltaFunction>
      Throws:
      IOException

    • fromJson

      public static RunStepDeltaFunction fromJson(com.azure.json.JsonReader jsonReader) throws IOException
      Reads an instance of RunStepDeltaFunction from the JsonReader.
      Parameters:
      jsonReader - The JsonReader being read.
      Returns:
      An instance of RunStepDeltaFunction if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
      Throws:
      IOException - If an error occurs while reading the RunStepDeltaFunction.