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

Class RunStepDeltaToolCall

java.lang.Object
com.azure.ai.openai.assistants.models.RunStepDeltaToolCall
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunStepDeltaToolCall>
Direct Known Subclasses:
RunStepDeltaCodeInterpreterToolCall, RunStepDeltaFileSearchToolCall, RunStepDeltaFunctionToolCall
public class RunStepDeltaToolCall extends Object implements com.azure.json.JsonSerializable<RunStepDeltaToolCall>
The abstract base representation of a single tool call within a streaming run step's delta tool call details.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RunStepDeltaToolCall(int index, String id)
    Creates an instance of RunStepDeltaToolCall class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RunStepDeltaToolCall
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RunStepDeltaToolCall from the JsonReader.
    String
    getId()
    Get the id property: The ID of the tool call, used when submitting outputs to the run.
    int
    getIndex()
    Get the index property: The index of the tool call detail in the run step's tool_calls array.
    String
    getType()
    Get the type property: The type of the tool call detail item in a streaming run step's details.
    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

    • RunStepDeltaToolCall

      protected RunStepDeltaToolCall(int index, String id)
      Creates an instance of RunStepDeltaToolCall class.
      Parameters:
      index - the index value to set.
      id - the id value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The type of the tool call detail item in a streaming run step's details.
      Returns:
      the type value.

    • getIndex

      public int getIndex()
      Get the index property: The index of the tool call detail in the run step's tool_calls array.
      Returns:
      the index value.

    • getId

      public String getId()
      Get the id property: The ID of the tool call, used when submitting outputs to the run.
      Returns:
      the id value.

    • toJson

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

    • fromJson

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