Package com.azure.ai.inference.models

Class ChatCompletionsToolCall

java.lang.Object
com.azure.ai.inference.models.ChatCompletionsToolCall
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsToolCall>
Direct Known Subclasses:
ChatCompletionsFunctionToolCall
public class ChatCompletionsToolCall extends Object implements com.azure.json.JsonSerializable<ChatCompletionsToolCall>
A function tool call requested by the AI model.

  • Constructor Details

    • ChatCompletionsToolCall

      public ChatCompletionsToolCall(String id, FunctionCall function)
      Creates an instance of ChatCompletionsToolCall class.
      Parameters:
      id - the id value to set.
      function - the function value to set.

  • Method Details

    • getId

      public String getId()
      Get the id property: The ID of the tool call.
      Returns:
      the id value.

    • getType

      public String getType()
      Get the type property: The type of tool call. Currently, only `function` is supported.
      Returns:
      the type value.

    • getFunction

      public FunctionCall getFunction()
      Get the function property: The details of the function call requested by the AI model.
      Returns:
      the function value.

    • toJson

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

    • fromJson

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