Package com.azure.ai.openai.models

Class AzureChatEnhancements

java.lang.Object

com.azure.ai.openai.models.AzureChatEnhancements

All Implemented Interfaces:

com.azure.json.JsonSerializable<AzureChatEnhancements>

public final class AzureChatEnhancements
extends Object
implements com.azure.json.JsonSerializable<AzureChatEnhancements>

Represents the output results of Azure enhancements to chat completions, as configured via the matching input provided in the request.

Method Summary

Modifier and Type	Method	Description
static AzureChatEnhancements	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AzureChatEnhancements from the JsonReader.
AzureGroundingEnhancement	getGrounding()	Get the grounding property: The grounding enhancement that returns the bounding box of the objects detected in the image.
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

Method Details

getGrounding

public AzureGroundingEnhancement getGrounding()

Get the grounding property: The grounding enhancement that returns the bounding box of the objects detected in the image.

Returns:

the grounding value.

toJson

public com.azure.json.JsonWriter toJson(com.azure.json.JsonWriter jsonWriter)
                                 throws IOException

Specified by:

toJson in interface com.azure.json.JsonSerializable<AzureChatEnhancements>

Throws:

IOException

fromJson

public static AzureChatEnhancements fromJson(com.azure.json.JsonReader jsonReader)
                                      throws IOException

Reads an instance of AzureChatEnhancements from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of AzureChatEnhancements 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 AzureChatEnhancements.