Class OcrParams.Builder (2.53.0)

public static final class OcrParams.Builder extends GeneratedMessageV3.Builder<OcrParams.Builder> implements OcrParamsOrBuilder

Parameters to control Optical Character Recognition (OCR) behavior.

Protobuf type google.cloud.documentai.v1beta1.OcrParams

Implements

OcrParamsOrBuilder

Static Methods

getDescriptor()

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

Methods

addAllLanguageHints(Iterable<String> values)

public OcrParams.Builder addAllLanguageHints(Iterable<String> values)

List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

repeated string language_hints = 1;

Parameter
Name Description
values Iterable<String>

The languageHints to add.

Returns
Type Description
OcrParams.Builder

This builder for chaining.

addLanguageHints(String value)

public OcrParams.Builder addLanguageHints(String value)

List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

repeated string language_hints = 1;

Parameter
Name Description
value String

The languageHints to add.

Returns
Type Description
OcrParams.Builder

This builder for chaining.

addLanguageHintsBytes(ByteString value)

public OcrParams.Builder addLanguageHintsBytes(ByteString value)

List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

repeated string language_hints = 1;

Parameter
Name Description
value ByteString

The bytes of the languageHints to add.

Returns
Type Description
OcrParams.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

build()

public OcrParams build()
Returns
Type Description
OcrParams

buildPartial()

public OcrParams buildPartial()
Returns
Type Description
OcrParams

clear()

public OcrParams.Builder clear()
Returns
Type Description
OcrParams.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

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

clearLanguageHints()

public OcrParams.Builder clearLanguageHints()

List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

repeated string language_hints = 1;

Returns
Type Description
OcrParams.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

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

clone()

public OcrParams.Builder clone()
Returns
Type Description
OcrParams.Builder
Overrides

getDefaultInstanceForType()

public OcrParams getDefaultInstanceForType()
Returns
Type Description
OcrParams

getDescriptorForType()

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

getLanguageHints(int index)

public String getLanguageHints(int index)

List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

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 languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

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 languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

repeated string language_hints = 1;

Returns
Type Description
int

The count of languageHints.

getLanguageHintsList()

public ProtocolStringList getLanguageHintsList()

List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

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(OcrParams other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeUnknownFields(UnknownFieldSet unknownFields)

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

setField(Descriptors.FieldDescriptor field, Object value)

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

setLanguageHints(int index, String value)

public OcrParams.Builder setLanguageHints(int index, String value)

List of languages to use for OCR. In most cases, an empty value yields the best results since it enables automatic language detection. For languages based on the Latin alphabet, setting language_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). Document processing returns an error if one or more of the specified languages is not one of the supported languages.

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
OcrParams.Builder

This builder for chaining.

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

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

setUnknownFields(UnknownFieldSet unknownFields)

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