com.google.cloud.documentai.v1beta3

Class OcrConfig

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.documentai.v1beta3.OcrConfig

All Implemented Interfaces:

OcrConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class OcrConfig
extends com.google.protobuf.GeneratedMessageV3
implements OcrConfigOrBuilder

 Config for Document OCR.
 

Protobuf type google.cloud.documentai.v1beta3.OcrConfig

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OcrConfig.Builder Config for Document OCR.
static class	OcrConfig.Hints Hints for OCR Engine Protobuf type google.cloud.documentai.v1beta3.OcrConfig.Hints
static interface	OcrConfig.HintsOrBuilder
static class	OcrConfig.PremiumFeatures Configurations for premium OCR features.
static interface	OcrConfig.PremiumFeaturesOrBuilder

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADVANCED_OCR_OPTIONS_FIELD_NUMBER
static int	COMPUTE_STYLE_INFO_FIELD_NUMBER
static int	DISABLE_CHARACTER_BOXES_DETECTION_FIELD_NUMBER
static int	ENABLE_IMAGE_QUALITY_SCORES_FIELD_NUMBER
static int	ENABLE_NATIVE_PDF_PARSING_FIELD_NUMBER
static int	ENABLE_SYMBOL_FIELD_NUMBER
static int	HINTS_FIELD_NUMBER
static int	PREMIUM_FEATURES_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getAdvancedOcrOptions(int index) A list of advanced OCR options to further fine-tune OCR behavior.
com.google.protobuf.ByteString	getAdvancedOcrOptionsBytes(int index) A list of advanced OCR options to further fine-tune OCR behavior.
int	getAdvancedOcrOptionsCount() A list of advanced OCR options to further fine-tune OCR behavior.
com.google.protobuf.ProtocolStringList	getAdvancedOcrOptionsList() A list of advanced OCR options to further fine-tune OCR behavior.
boolean	getComputeStyleInfo() Deprecated. google.cloud.documentai.v1beta3.OcrConfig.compute_style_info is deprecated. See google/cloud/documentai/v1beta3/document_io.proto;l=165
static OcrConfig	getDefaultInstance()
OcrConfig	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
boolean	getDisableCharacterBoxesDetection() Turn off character box detector in OCR engine.
boolean	getEnableImageQualityScores() Enables intelligent document quality scores after OCR.
boolean	getEnableNativePdfParsing() Enables special handling for PDFs with existing text information.
boolean	getEnableSymbol() Includes symbol level OCR information if set to true.
OcrConfig.Hints	getHints() Hints for the OCR model.
OcrConfig.HintsOrBuilder	getHintsOrBuilder() Hints for the OCR model.
com.google.protobuf.Parser<OcrConfig>	getParserForType()
OcrConfig.PremiumFeatures	getPremiumFeatures() Configurations for premium OCR features.
OcrConfig.PremiumFeaturesOrBuilder	getPremiumFeaturesOrBuilder() Configurations for premium OCR features.
int	getSerializedSize()
int	hashCode()
boolean	hasHints() Hints for the OCR model.
boolean	hasPremiumFeatures() Configurations for premium OCR features.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static OcrConfig.Builder	newBuilder()
static OcrConfig.Builder	newBuilder(OcrConfig prototype)
OcrConfig.Builder	newBuilderForType()
protected OcrConfig.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static OcrConfig	parseDelimitedFrom(InputStream input)
static OcrConfig	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrConfig	parseFrom(byte[] data)
static OcrConfig	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrConfig	parseFrom(ByteBuffer data)
static OcrConfig	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrConfig	parseFrom(com.google.protobuf.ByteString data)
static OcrConfig	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrConfig	parseFrom(com.google.protobuf.CodedInputStream input)
static OcrConfig	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static OcrConfig	parseFrom(InputStream input)
static OcrConfig	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<OcrConfig>	parser()
OcrConfig.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

HINTS_FIELD_NUMBER

public static final int HINTS_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_NATIVE_PDF_PARSING_FIELD_NUMBER

public static final int ENABLE_NATIVE_PDF_PARSING_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_IMAGE_QUALITY_SCORES_FIELD_NUMBER

public static final int ENABLE_IMAGE_QUALITY_SCORES_FIELD_NUMBER

See Also:

Constant Field Values

ADVANCED_OCR_OPTIONS_FIELD_NUMBER

public static final int ADVANCED_OCR_OPTIONS_FIELD_NUMBER

See Also:

Constant Field Values

ENABLE_SYMBOL_FIELD_NUMBER

public static final int ENABLE_SYMBOL_FIELD_NUMBER

See Also:

Constant Field Values

COMPUTE_STYLE_INFO_FIELD_NUMBER

public static final int COMPUTE_STYLE_INFO_FIELD_NUMBER

See Also:

Constant Field Values

DISABLE_CHARACTER_BOXES_DETECTION_FIELD_NUMBER

public static final int DISABLE_CHARACTER_BOXES_DETECTION_FIELD_NUMBER

See Also:

Constant Field Values

PREMIUM_FEATURES_FIELD_NUMBER

public static final int PREMIUM_FEATURES_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

hasHints

public boolean hasHints()

 Hints for the OCR model.
 

.google.cloud.documentai.v1beta3.OcrConfig.Hints hints = 2;

Specified by:

hasHints in interface OcrConfigOrBuilder

Returns:

Whether the hints field is set.

getHints

public OcrConfig.Hints getHints()

 Hints for the OCR model.
 

.google.cloud.documentai.v1beta3.OcrConfig.Hints hints = 2;

Specified by:

getHints in interface OcrConfigOrBuilder

Returns:

The hints.

getHintsOrBuilder

public OcrConfig.HintsOrBuilder getHintsOrBuilder()

 Hints for the OCR model.
 

.google.cloud.documentai.v1beta3.OcrConfig.Hints hints = 2;

Specified by:

getHintsOrBuilder in interface OcrConfigOrBuilder

getEnableNativePdfParsing

public boolean getEnableNativePdfParsing()

 Enables special handling for PDFs with existing text information. Results
 in better text extraction quality in such PDF inputs.
 

bool enable_native_pdf_parsing = 3;

Specified by:

getEnableNativePdfParsing in interface OcrConfigOrBuilder

Returns:

The enableNativePdfParsing.

getEnableImageQualityScores

public boolean getEnableImageQualityScores()

 Enables intelligent document quality scores after OCR. Can help with
 diagnosing why OCR responses are of poor quality for a given input.
 Adds additional latency comparable to regular OCR to the process call.
 

bool enable_image_quality_scores = 4;

Specified by:

getEnableImageQualityScores in interface OcrConfigOrBuilder

Returns:

The enableImageQualityScores.

getAdvancedOcrOptionsList

public com.google.protobuf.ProtocolStringList getAdvancedOcrOptionsList()

 A list of advanced OCR options to further fine-tune OCR behavior. Current
 valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
 

repeated string advanced_ocr_options = 5;

Specified by:

getAdvancedOcrOptionsList in interface OcrConfigOrBuilder

Returns:

A list containing the advancedOcrOptions.

getAdvancedOcrOptionsCount

public int getAdvancedOcrOptionsCount()

 A list of advanced OCR options to further fine-tune OCR behavior. Current
 valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
 

repeated string advanced_ocr_options = 5;

Specified by:

getAdvancedOcrOptionsCount in interface OcrConfigOrBuilder

Returns:

The count of advancedOcrOptions.

getAdvancedOcrOptions

public String getAdvancedOcrOptions(int index)

 A list of advanced OCR options to further fine-tune OCR behavior. Current
 valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
 

repeated string advanced_ocr_options = 5;

Specified by:

getAdvancedOcrOptions in interface OcrConfigOrBuilder

Parameters:

index - The index of the element to return.

Returns:

The advancedOcrOptions at the given index.

getAdvancedOcrOptionsBytes

public com.google.protobuf.ByteString getAdvancedOcrOptionsBytes(int index)

 A list of advanced OCR options to further fine-tune OCR behavior. Current
 valid values are:

 - `legacy_layout`: a heuristics layout detection algorithm, which serves as
 an alternative to the current ML-based layout detection algorithm.
 Customers can choose the best suitable layout algorithm based on their
 situation.
 

repeated string advanced_ocr_options = 5;

Specified by:

getAdvancedOcrOptionsBytes in interface OcrConfigOrBuilder

Parameters:

index - The index of the value to return.

Returns:

The bytes of the advancedOcrOptions at the given index.

getEnableSymbol

public boolean getEnableSymbol()

 Includes symbol level OCR information if set to true.
 

bool enable_symbol = 6;

Specified by:

getEnableSymbol in interface OcrConfigOrBuilder

Returns:

The enableSymbol.

getComputeStyleInfo

@Deprecated
public boolean getComputeStyleInfo()

Deprecated. google.cloud.documentai.v1beta3.OcrConfig.compute_style_info is deprecated. See google/cloud/documentai/v1beta3/document_io.proto;l=165

 Turn on font identification model and return font style information.
 Deprecated, use
 [PremiumFeatures.compute_style_info][google.cloud.documentai.v1beta3.OcrConfig.PremiumFeatures.compute_style_info]
 instead.
 

bool compute_style_info = 8 [deprecated = true];

Specified by:

getComputeStyleInfo in interface OcrConfigOrBuilder

Returns:

The computeStyleInfo.

getDisableCharacterBoxesDetection

public boolean getDisableCharacterBoxesDetection()

 Turn off character box detector in OCR engine. Character box detection is
 enabled by default in OCR 2.0 (and later) processors.
 

bool disable_character_boxes_detection = 10;

Specified by:

getDisableCharacterBoxesDetection in interface OcrConfigOrBuilder

Returns:

The disableCharacterBoxesDetection.

hasPremiumFeatures

public boolean hasPremiumFeatures()

 Configurations for premium OCR features.
 

.google.cloud.documentai.v1beta3.OcrConfig.PremiumFeatures premium_features = 11;

Specified by:

hasPremiumFeatures in interface OcrConfigOrBuilder

Returns:

Whether the premiumFeatures field is set.

getPremiumFeatures

public OcrConfig.PremiumFeatures getPremiumFeatures()

 Configurations for premium OCR features.
 

.google.cloud.documentai.v1beta3.OcrConfig.PremiumFeatures premium_features = 11;

Specified by:

getPremiumFeatures in interface OcrConfigOrBuilder

Returns:

The premiumFeatures.

getPremiumFeaturesOrBuilder

public OcrConfig.PremiumFeaturesOrBuilder getPremiumFeaturesOrBuilder()

 Configurations for premium OCR features.
 

.google.cloud.documentai.v1beta3.OcrConfig.PremiumFeatures premium_features = 11;

Specified by:

getPremiumFeaturesOrBuilder in interface OcrConfigOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static OcrConfig parseFrom(ByteBuffer data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrConfig parseFrom(ByteBuffer data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrConfig parseFrom(com.google.protobuf.ByteString data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrConfig parseFrom(com.google.protobuf.ByteString data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrConfig parseFrom(byte[] data)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrConfig parseFrom(byte[] data,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static OcrConfig parseFrom(InputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static OcrConfig parseFrom(InputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

parseDelimitedFrom

public static OcrConfig parseDelimitedFrom(InputStream input)
                                    throws IOException

Throws:

IOException

parseDelimitedFrom

public static OcrConfig parseDelimitedFrom(InputStream input,
                                           com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                    throws IOException

Throws:

IOException

parseFrom

public static OcrConfig parseFrom(com.google.protobuf.CodedInputStream input)
                           throws IOException

Throws:

IOException

parseFrom

public static OcrConfig parseFrom(com.google.protobuf.CodedInputStream input,
                                  com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                           throws IOException

Throws:

IOException

newBuilderForType

public OcrConfig.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static OcrConfig.Builder newBuilder()

newBuilder

public static OcrConfig.Builder newBuilder(OcrConfig prototype)

toBuilder

public OcrConfig.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected OcrConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static OcrConfig getDefaultInstance()

parser

public static com.google.protobuf.Parser<OcrConfig> parser()

getParserForType

public com.google.protobuf.Parser<OcrConfig> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public OcrConfig getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder