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

Class RequiredToolCall

java.lang.Object
com.azure.ai.openai.assistants.models.RequiredToolCall
All Implemented Interfaces:
com.azure.json.JsonSerializable<RequiredToolCall>
Direct Known Subclasses:
RequiredFunctionToolCall
public class RequiredToolCall extends Object implements com.azure.json.JsonSerializable<RequiredToolCall>
An abstract representation a a tool invocation needed by the model to continue a run.

  • Constructor Summary

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

  • Method Summary

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

    • RequiredToolCall

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

  • Method Details

    • getId

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

    • fromJson

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

    • getType

      public String getType()
      Get the type property: The object type for the required tool call.
      Returns:
      the type value.