Package com.azure.ai.inference.models
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 Summary
ConstructorsConstructorDescriptionCreates an instance of ChatCompletionsNamedToolSelection class. -
Method Summary
Modifier and TypeMethodDescriptionfromJson(com.azure.json.JsonReader jsonReader) Reads an instance of ChatCompletionsNamedToolSelection from the JsonReader.Get the function property: The function that should be called.getType()Get the type property: The type of the tool.com.azure.json.JsonWritertoJson(com.azure.json.JsonWriter jsonWriter) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.azure.json.JsonSerializable
toJson, toJson, toJsonBytes, toJsonString
-
Constructor Details
-
ChatCompletionsNamedToolSelection
Creates an instance of ChatCompletionsNamedToolSelection class.- Parameters:
function- the function value to set.
-
-
Method Details
-
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
- Specified by:
toJsonin interfacecom.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.
-