Class OcrConfig.Hints (2.50.0)

public static final class OcrConfig.Hints extends GeneratedMessageV3 implements OcrConfig.HintsOrBuilder

Hints for OCR Engine

Protobuf type google.cloud.documentai.v1.OcrConfig.Hints

Static Fields

LANGUAGE_HINTS_FIELD_NUMBER

public static final int LANGUAGE_HINTS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static OcrConfig.Hints getDefaultInstance()
Returns
Type Description
OcrConfig.Hints

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static OcrConfig.Hints.Builder newBuilder()
Returns
Type Description
OcrConfig.Hints.Builder

newBuilder(OcrConfig.Hints prototype)

public static OcrConfig.Hints.Builder newBuilder(OcrConfig.Hints prototype)
Parameter
Name Description
prototype OcrConfig.Hints
Returns
Type Description
OcrConfig.Hints.Builder

parseDelimitedFrom(InputStream input)

public static OcrConfig.Hints parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OcrConfig.Hints parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static OcrConfig.Hints parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static OcrConfig.Hints parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static OcrConfig.Hints parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static OcrConfig.Hints parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static OcrConfig.Hints parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static OcrConfig.Hints parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static OcrConfig.Hints parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static OcrConfig.Hints parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static OcrConfig.Hints parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static OcrConfig.Hints parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OcrConfig.Hints
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<OcrConfig.Hints> parser()
Returns
Type Description
Parser<Hints>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public OcrConfig.Hints getDefaultInstanceForType()
Returns
Type Description
OcrConfig.Hints

getLanguageHints(int index)

public String getLanguageHints(int index)

List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).

repeated string language_hints = 1;

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The languageHints at the given index.

getLanguageHintsBytes(int index)

public ByteString getLanguageHintsBytes(int index)

List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).

repeated string language_hints = 1;

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the languageHints at the given index.

getLanguageHintsCount()

public int getLanguageHintsCount()

List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).

repeated string language_hints = 1;

Returns
Type Description
int

The count of languageHints.

getLanguageHintsList()

public ProtocolStringList getLanguageHintsList()

List of BCP-47 language codes to use for OCR. In most cases, not specifying it yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting hints is not needed. In rare cases, when the language of the text in the image is known, setting a hint will help get better results (although it will be a significant hindrance if the hint is wrong).

repeated string language_hints = 1;

Returns
Type Description
ProtocolStringList

A list containing the languageHints.

getParserForType()

public Parser<OcrConfig.Hints> getParserForType()
Returns
Type Description
Parser<Hints>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public OcrConfig.Hints.Builder newBuilderForType()
Returns
Type Description
OcrConfig.Hints.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected OcrConfig.Hints.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public OcrConfig.Hints.Builder toBuilder()
Returns
Type Description
OcrConfig.Hints.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException