Class ChatCompletionsNamedToolSelection

java.lang.Object
com.azure.ai.inference.models.ChatCompletionsNamedToolSelection
All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsNamedToolSelection>
Direct Known Subclasses:
ChatCompletionsNamedFunctionToolSelection

public class ChatCompletionsNamedToolSelection extends Object implements com.azure.json.JsonSerializable<ChatCompletionsNamedToolSelection>
A tool selection of a specific, named function tool that will limit chat completions to using the named function.
  • Constructor Details

    • ChatCompletionsNamedToolSelection

      public ChatCompletionsNamedToolSelection(ChatCompletionsFunctionToolSelection function)
      Creates an instance of ChatCompletionsNamedToolSelection class.
      Parameters:
      function - the function value to set.
  • Method Details

    • getType

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

      Get the function property: The function that should be called.
      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<ChatCompletionsNamedToolSelection>
      Throws:
      IOException
    • fromJson

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