Package com.azure.ai.openai.models

Class AzureChatGroundingEnhancementConfiguration

java.lang.Object

com.azure.ai.openai.models.AzureChatGroundingEnhancementConfiguration

All Implemented Interfaces:

com.azure.json.JsonSerializable<AzureChatGroundingEnhancementConfiguration>

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

A representation of the available options for the Azure OpenAI grounding enhancement.

Constructor Summary

Constructors

Constructor	Description
AzureChatGroundingEnhancementConfiguration(boolean enabled)	Creates an instance of AzureChatGroundingEnhancementConfiguration class.

Method Summary

Modifier and Type	Method	Description
static AzureChatGroundingEnhancementConfiguration	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AzureChatGroundingEnhancementConfiguration from the JsonReader.
boolean	isEnabled()	Get the enabled property: Specifies whether the enhancement is enabled.
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

Constructor Details

AzureChatGroundingEnhancementConfiguration

public AzureChatGroundingEnhancementConfiguration(boolean enabled)

Creates an instance of AzureChatGroundingEnhancementConfiguration class.

Parameters:

enabled - the enabled value to set.

Method Details

isEnabled

public boolean isEnabled()

Get the enabled property: Specifies whether the enhancement is enabled.

Returns:

the enabled value.

toJson

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

Specified by:

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

Throws:

IOException

fromJson

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

Reads an instance of AzureChatGroundingEnhancementConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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