Package com.azure.ai.agents.persistent.models

Class RunStepToolCall

java.lang.Object
com.azure.ai.agents.persistent.models.RunStepToolCall
All Implemented Interfaces:
com.azure.json.JsonSerializable<RunStepToolCall>
Direct Known Subclasses:
RunStepAzureAISearchToolCall, RunStepBingGroundingToolCall, RunStepCodeInterpreterToolCall, RunStepFileSearchToolCall, RunStepFunctionToolCall, RunStepOpenApiToolCall
public class RunStepToolCall extends Object implements com.azure.json.JsonSerializable<RunStepToolCall>
An abstract representation of a detailed tool call as recorded within a run step for an existing run.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    protected
    RunStepToolCall(String id)
    Creates an instance of RunStepToolCall class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static RunStepToolCall
    fromJson(com.azure.json.JsonReader jsonReader)
    Reads an instance of RunStepToolCall from the JsonReader.
    String
    getId()
    Get the id property: The ID of the tool call.
    String
    getType()
    Get the type property: The object type.
    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

    • RunStepToolCall

      protected RunStepToolCall(String id)
      Creates an instance of RunStepToolCall class.
      Parameters:
      id - the id value to set.

  • Method Details

    • getType

      public String getType()
      Get the type property: The object type.
      Returns:
      the type value.

    • getId

      public String getId()
      Get the id property: The ID of the tool call. This ID must be referenced when you submit tool outputs.
      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<RunStepToolCall>
      Throws:
      IOException

    • fromJson

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