Package com.azure.ai.openai.models

Class AzureChatOCREnhancementConfiguration

java.lang.Object

com.azure.ai.openai.models.AzureChatOCREnhancementConfiguration

All Implemented Interfaces:

com.azure.json.JsonSerializable<AzureChatOCREnhancementConfiguration>

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

A representation of the available options for the Azure OpenAI optical character recognition (OCR) enhancement.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
static AzureChatOCREnhancementConfiguration	fromJson(com.azure.json.JsonReader jsonReader)	Reads an instance of AzureChatOCREnhancementConfiguration 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

AzureChatOCREnhancementConfiguration

public AzureChatOCREnhancementConfiguration(boolean enabled)

Creates an instance of AzureChatOCREnhancementConfiguration 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<AzureChatOCREnhancementConfiguration>

Throws:

IOException

fromJson

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

Reads an instance of AzureChatOCREnhancementConfiguration from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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