- 2.57.0 (latest)
- 2.56.0
- 2.55.0
- 2.53.0
- 2.52.0
- 2.51.0
- 2.50.0
- 2.49.0
- 2.48.0
- 2.47.0
- 2.46.0
- 2.45.0
- 2.44.0
- 2.43.0
- 2.41.0
- 2.40.0
- 2.39.0
- 2.38.0
- 2.37.0
- 2.36.0
- 2.35.0
- 2.34.0
- 2.33.0
- 2.32.0
- 2.31.0
- 2.28.0
- 2.27.0
- 2.26.0
- 2.25.0
- 2.24.0
- 2.23.0
- 2.22.0
- 2.21.0
- 2.20.0
- 2.19.0
- 2.18.0
- 2.17.0
- 2.16.0
- 2.15.0
- 2.13.0
- 2.12.0
- 2.11.0
- 2.10.0
- 2.9.0
- 2.8.0
- 2.7.5
- 2.6.2
- 2.5.1
- 2.4.3
- 2.3.1
- 2.2.1
- 2.1.9
public final class OcrConfig extends GeneratedMessageV3 implements OcrConfigOrBuilderConfig for Document OCR.
Protobuf type google.cloud.documentai.v1.OcrConfig
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > OcrConfigImplements
OcrConfigOrBuilderStatic Fields
ADVANCED_OCR_OPTIONS_FIELD_NUMBER
public static final int ADVANCED_OCR_OPTIONS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
COMPUTE_STYLE_INFO_FIELD_NUMBER
public static final int COMPUTE_STYLE_INFO_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
ENABLE_IMAGE_QUALITY_SCORES_FIELD_NUMBER
public static final int ENABLE_IMAGE_QUALITY_SCORES_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
ENABLE_NATIVE_PDF_PARSING_FIELD_NUMBER
public static final int ENABLE_NATIVE_PDF_PARSING_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
ENABLE_SYMBOL_FIELD_NUMBER
public static final int ENABLE_SYMBOL_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
HINTS_FIELD_NUMBER
public static final int HINTS_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static OcrConfig getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor | |
newBuilder()
public static OcrConfig.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
OcrConfig.Builder | |
newBuilder(OcrConfig prototype)
public static OcrConfig.Builder newBuilder(OcrConfig prototype)| Parameter | |
|---|---|
| Name | Description |
prototype | OcrConfig |
| Returns | |
|---|---|
| Type | Description |
OcrConfig.Builder | |
parseDelimitedFrom(InputStream input)
public static OcrConfig parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OcrConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(byte[] data)
public static OcrConfig parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data | byte[] |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static OcrConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | byte[] |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data)
public static OcrConfig parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data | ByteString |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static OcrConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteString |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(CodedInputStream input)
public static OcrConfig parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input | CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static OcrConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | CodedInputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input)
public static OcrConfig parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input | InputStream |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static OcrConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input | InputStream |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |
parseFrom(ByteBuffer data)
public static OcrConfig parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data | ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static OcrConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data | ByteBuffer |
extensionRegistry | ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException | |
parser()
public static Parser<OcrConfig> parser()| Returns | |
|---|---|
| Type | Description |
Parser<OcrConfig> | |
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj | Object |
| Returns | |
|---|---|
| Type | Description |
boolean | |
getAdvancedOcrOptions(int index)
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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String | The advancedOcrOptions at the given index. |
getAdvancedOcrOptionsBytes(int index)
public 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;
| Parameter | |
|---|---|
| Name | Description |
index | intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString | The bytes of the advancedOcrOptions at the given index. |
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;
| Returns | |
|---|---|
| Type | Description |
int | The count of advancedOcrOptions. |
getAdvancedOcrOptionsList()
public 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;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList | A list containing the advancedOcrOptions. |
getComputeStyleInfo()
public boolean getComputeStyleInfo()Turn on font id model and returns font style information.
bool compute_style_info = 8;
| Returns | |
|---|---|
| Type | Description |
boolean | The computeStyleInfo. |
getDefaultInstanceForType()
public OcrConfig getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
OcrConfig | |
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;
| Returns | |
|---|---|
| Type | Description |
boolean | The enableImageQualityScores. |
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;
| Returns | |
|---|---|
| Type | Description |
boolean | The enableNativePdfParsing. |
getEnableSymbol()
public boolean getEnableSymbol()Includes symbol level OCR information if set to true.
bool enable_symbol = 6;
| Returns | |
|---|---|
| Type | Description |
boolean | The enableSymbol. |
getHints()
public OcrConfig.Hints getHints()Hints for the OCR model.
.google.cloud.documentai.v1.OcrConfig.Hints hints = 2;
| Returns | |
|---|---|
| Type | Description |
OcrConfig.Hints | The hints. |
getHintsOrBuilder()
public OcrConfig.HintsOrBuilder getHintsOrBuilder()Hints for the OCR model.
.google.cloud.documentai.v1.OcrConfig.Hints hints = 2;
| Returns | |
|---|---|
| Type | Description |
OcrConfig.HintsOrBuilder | |
getParserForType()
public Parser<OcrConfig> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<OcrConfig> | |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int | |
hasHints()
public boolean hasHints()Hints for the OCR model.
.google.cloud.documentai.v1.OcrConfig.Hints hints = 2;
| Returns | |
|---|---|
| Type | Description |
boolean | Whether the hints field is set. |
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int | |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable | |
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean | |
newBuilderForType()
public OcrConfig.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
OcrConfig.Builder | |
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected OcrConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent | BuilderParent |
| Returns | |
|---|---|
| Type | Description |
OcrConfig.Builder | |
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)| Parameter | |
|---|---|
| Name | Description |
unused | UnusedPrivateParameter |
| Returns | |
|---|---|
| Type | Description |
Object | |
toBuilder()
public OcrConfig.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
OcrConfig.Builder | |
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output | CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException | |