Package com.azure.ai.inference.models
Class ChatCompletionsResponseFormatJson
java.lang.Object
com.azure.ai.inference.models.ChatCompletionsResponseFormat
com.azure.ai.inference.models.ChatCompletionsResponseFormatJson
- All Implemented Interfaces:
com.azure.json.JsonSerializable<ChatCompletionsResponseFormat>
A response format for Chat Completions that restricts responses to emitting valid JSON objects.
Note that to enable JSON mode, some AI models may also require you to instruct the model to produce JSON
via a system or user message.
-
Constructor Summary
ConstructorsConstructorDescriptionCreates an instance of ChatCompletionsResponseFormatJson class. -
Method Summary
Modifier and TypeMethodDescriptionfromJson(com.azure.json.JsonReader jsonReader) Reads an instance of ChatCompletionsResponseFormatJson from the JsonReader.getType()Get the type property: The response format type to use for chat completions.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
-
ChatCompletionsResponseFormatJson
public ChatCompletionsResponseFormatJson()Creates an instance of ChatCompletionsResponseFormatJson class.
-
-
Method Details
-
getType
Get the type property: The response format type to use for chat completions.- Overrides:
getTypein classChatCompletionsResponseFormat- Returns:
- the type value.
-
toJson
- Specified by:
toJsonin interfacecom.azure.json.JsonSerializable<ChatCompletionsResponseFormat>- Overrides:
toJsonin classChatCompletionsResponseFormat- Throws:
IOException
-
fromJson
public static ChatCompletionsResponseFormatJson fromJson(com.azure.json.JsonReader jsonReader) throws IOException Reads an instance of ChatCompletionsResponseFormatJson from the JsonReader.- Parameters:
jsonReader- The JsonReader being read.- Returns:
- An instance of ChatCompletionsResponseFormatJson if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.
- Throws:
IOException- If an error occurs while reading the ChatCompletionsResponseFormatJson.
-