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

Class RunStepDeltaCodeInterpreterOutput

java.lang.Object
com.azure.ai.openai.assistants.models.RunStepDeltaCodeInterpreterOutput
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunStepDeltaCodeInterpreterOutput>
Direct Known Subclasses:
RunStepDeltaCodeInterpreterImageOutput, RunStepDeltaCodeInterpreterLogOutput
public class RunStepDeltaCodeInterpreterOutput extends Object implements com.azure.json.JsonSerializable<RunStepDeltaCodeInterpreterOutput>
The abstract base representation of a streaming run step tool call's Code Interpreter tool output.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RunStepDeltaCodeInterpreterOutput(int index)
    Creates an instance of RunStepDeltaCodeInterpreterOutput class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RunStepDeltaCodeInterpreterOutput
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RunStepDeltaCodeInterpreterOutput from the JsonReader.
    int
    getIndex()
    Get the index property: The index of the output in the streaming run step tool call's Code Interpreter outputs array.
    String
    getType()
    Get the type property: The type of the streaming run step tool call's Code Interpreter output.
    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

    • RunStepDeltaCodeInterpreterOutput

      protected RunStepDeltaCodeInterpreterOutput(int index)
      Creates an instance of RunStepDeltaCodeInterpreterOutput class.
      Parameters:
      index - the index value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The type of the streaming run step tool call's Code Interpreter output.
      Returns:
      the type value.

    • getIndex

      public int getIndex()
      Get the index property: The index of the output in the streaming run step tool call's Code Interpreter outputs array.
      Returns:
      the index value.

    • toJson

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

    • fromJson

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