Class OcrConfig.Hints.Builder (2.46.0)

public static final class OcrConfig.Hints.Builder extends GeneratedMessageV3.Builder<OcrConfig.Hints.Builder> implements OcrConfig.HintsOrBuilder

Hints for OCR Engine

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

Static Methods

getDescriptor()

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

Methods

addAllLanguageHints(Iterable<String> values)

public OcrConfig.Hints.Builder addAllLanguageHints(Iterable<String> values)

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
values Iterable<String>

The languageHints to add.

Returns
Type Description
OcrConfig.Hints.Builder

This builder for chaining.

addLanguageHints(String value)

public OcrConfig.Hints.Builder addLanguageHints(String value)

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
value String

The languageHints to add.

Returns
Type Description
OcrConfig.Hints.Builder

This builder for chaining.

addLanguageHintsBytes(ByteString value)

public OcrConfig.Hints.Builder addLanguageHintsBytes(ByteString value)

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
value ByteString

The bytes of the languageHints to add.

Returns
Type Description
OcrConfig.Hints.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OcrConfig.Hints.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

build()

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

buildPartial()

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

clear()

public OcrConfig.Hints.Builder clear()
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public OcrConfig.Hints.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

clearLanguageHints()

public OcrConfig.Hints.Builder clearLanguageHints()

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
OcrConfig.Hints.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public OcrConfig.Hints.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

clone()

public OcrConfig.Hints.Builder clone()
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

getDefaultInstanceForType()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(OcrConfig.Hints other)

public OcrConfig.Hints.Builder mergeFrom(OcrConfig.Hints other)
Parameter
Name Description
other OcrConfig.Hints
Returns
Type Description
OcrConfig.Hints.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OcrConfig.Hints.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
OcrConfig.Hints.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public OcrConfig.Hints.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OcrConfig.Hints.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public OcrConfig.Hints.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

setLanguageHints(int index, String value)

public OcrConfig.Hints.Builder setLanguageHints(int index, String value)

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;

Parameters
Name Description
index int

The index to set the value at.

value String

The languageHints to set.

Returns
Type Description
OcrConfig.Hints.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public OcrConfig.Hints.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
OcrConfig.Hints.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final OcrConfig.Hints.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
OcrConfig.Hints.Builder
Overrides