Class OcrConfig.Hints.Builder (2.39.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
TypeDescription
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
NameDescription
valuesIterable<String>

The languageHints to add.

Returns
TypeDescription
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
NameDescription
valueString

The languageHints to add.

Returns
TypeDescription
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
NameDescription
valueByteString

The bytes of the languageHints to add.

Returns
TypeDescription
OcrConfig.Hints.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public OcrConfig.Hints.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides

build()

public OcrConfig.Hints build()
Returns
TypeDescription
OcrConfig.Hints

buildPartial()

public OcrConfig.Hints buildPartial()
Returns
TypeDescription
OcrConfig.Hints

clear()

public OcrConfig.Hints.Builder clear()
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public OcrConfig.Hints.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
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
TypeDescription
OcrConfig.Hints.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public OcrConfig.Hints.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides

clone()

public OcrConfig.Hints.Builder clone()
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides

getDefaultInstanceForType()

public OcrConfig.Hints getDefaultInstanceForType()
Returns
TypeDescription
OcrConfig.Hints

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
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
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
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
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ProtocolStringList

A list containing the languageHints.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(OcrConfig.Hints other)

public OcrConfig.Hints.Builder mergeFrom(OcrConfig.Hints other)
Parameter
NameDescription
otherOcrConfig.Hints
Returns
TypeDescription
OcrConfig.Hints.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public OcrConfig.Hints.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public OcrConfig.Hints.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final OcrConfig.Hints.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public OcrConfig.Hints.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
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
NameDescription
indexint

The index to set the value at.

valueString

The languageHints to set.

Returns
TypeDescription
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
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final OcrConfig.Hints.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
OcrConfig.Hints.Builder
Overrides