Package com.google.cloud.documentai.v1

Class OcrConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.documentai.v1.OcrConfig
All Implemented Interfaces:
OcrConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class OcrConfig extends com.google.protobuf.GeneratedMessage implements OcrConfigOrBuilder
 Config for Document OCR.
Protobuf type google.cloud.documentai.v1.OcrConfig
See Also:

  • Field Details

    • HINTS_FIELD_NUMBER

      public static final int HINTS_FIELD_NUMBER
      See Also:

    • ENABLE_NATIVE_PDF_PARSING_FIELD_NUMBER

      public static final int ENABLE_NATIVE_PDF_PARSING_FIELD_NUMBER
      See Also:

    • ENABLE_IMAGE_QUALITY_SCORES_FIELD_NUMBER

      public static final int ENABLE_IMAGE_QUALITY_SCORES_FIELD_NUMBER
      See Also:

    • ADVANCED_OCR_OPTIONS_FIELD_NUMBER

      public static final int ADVANCED_OCR_OPTIONS_FIELD_NUMBER
      See Also:

    • ENABLE_SYMBOL_FIELD_NUMBER

      public static final int ENABLE_SYMBOL_FIELD_NUMBER
      See Also:

    • COMPUTE_STYLE_INFO_FIELD_NUMBER

      public static final int COMPUTE_STYLE_INFO_FIELD_NUMBER
      See Also:

    • DISABLE_CHARACTER_BOXES_DETECTION_FIELD_NUMBER

      public static final int DISABLE_CHARACTER_BOXES_DETECTION_FIELD_NUMBER
      See Also:

    • PREMIUM_FEATURES_FIELD_NUMBER

      public static final int PREMIUM_FEATURES_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • hasHints

      public boolean hasHints()
       Hints for the OCR model.
      .google.cloud.documentai.v1.OcrConfig.Hints hints = 2;
      Specified by:
      hasHints in interface OcrConfigOrBuilder
      Returns:
      Whether the hints field is set.

    • getHints

      public OcrConfig.Hints getHints()
       Hints for the OCR model.
      .google.cloud.documentai.v1.OcrConfig.Hints hints = 2;
      Specified by:
      getHints in interface OcrConfigOrBuilder
      Returns:
      The hints.

    • getHintsOrBuilder

      public OcrConfig.HintsOrBuilder getHintsOrBuilder()
       Hints for the OCR model.
      .google.cloud.documentai.v1.OcrConfig.Hints hints = 2;
      Specified by:
      getHintsOrBuilder in interface OcrConfigOrBuilder

    • 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;
      Specified by:
      getEnableNativePdfParsing in interface OcrConfigOrBuilder
      Returns:
      The enableNativePdfParsing.

    • 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;
      Specified by:
      getEnableImageQualityScores in interface OcrConfigOrBuilder
      Returns:
      The enableImageQualityScores.

    • getAdvancedOcrOptionsList

      public com.google.protobuf.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;
      Specified by:
      getAdvancedOcrOptionsList in interface OcrConfigOrBuilder
      Returns:
      A list containing the advancedOcrOptions.

    • 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;
      Specified by:
      getAdvancedOcrOptionsCount in interface OcrConfigOrBuilder
      Returns:
      The count of advancedOcrOptions.

    • getAdvancedOcrOptions

      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;
      Specified by:
      getAdvancedOcrOptions in interface OcrConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The advancedOcrOptions at the given index.

    • getAdvancedOcrOptionsBytes

      public com.google.protobuf.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;
      Specified by:
      getAdvancedOcrOptionsBytes in interface OcrConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the advancedOcrOptions at the given index.

    • getEnableSymbol

      public boolean getEnableSymbol()
       Includes symbol level OCR information if set to true.
      bool enable_symbol = 6;
      Specified by:
      getEnableSymbol in interface OcrConfigOrBuilder
      Returns:
      The enableSymbol.

    • getComputeStyleInfo

      @Deprecated public boolean getComputeStyleInfo()
      Deprecated.
      google.cloud.documentai.v1.OcrConfig.compute_style_info is deprecated. See google/cloud/documentai/v1/document_io.proto;l=166
       Turn on font identification model and return font style information.
 Deprecated, use
 [PremiumFeatures.compute_style_info][google.cloud.documentai.v1.OcrConfig.PremiumFeatures.compute_style_info]
 instead.
      bool compute_style_info = 8 [deprecated = true];
      Specified by:
      getComputeStyleInfo in interface OcrConfigOrBuilder
      Returns:
      The computeStyleInfo.

    • getDisableCharacterBoxesDetection

      public boolean getDisableCharacterBoxesDetection()
       Turn off character box detector in OCR engine. Character box detection is
 enabled by default in OCR 2.0 (and later) processors.
      bool disable_character_boxes_detection = 10;
      Specified by:
      getDisableCharacterBoxesDetection in interface OcrConfigOrBuilder
      Returns:
      The disableCharacterBoxesDetection.

    • hasPremiumFeatures

      public boolean hasPremiumFeatures()
       Configurations for premium OCR features.
      .google.cloud.documentai.v1.OcrConfig.PremiumFeatures premium_features = 11;
      Specified by:
      hasPremiumFeatures in interface OcrConfigOrBuilder
      Returns:
      Whether the premiumFeatures field is set.

    • getPremiumFeatures

      public OcrConfig.PremiumFeatures getPremiumFeatures()
       Configurations for premium OCR features.
      .google.cloud.documentai.v1.OcrConfig.PremiumFeatures premium_features = 11;
      Specified by:
      getPremiumFeatures in interface OcrConfigOrBuilder
      Returns:
      The premiumFeatures.

    • getPremiumFeaturesOrBuilder

      public OcrConfig.PremiumFeaturesOrBuilder getPremiumFeaturesOrBuilder()
       Configurations for premium OCR features.
      .google.cloud.documentai.v1.OcrConfig.PremiumFeatures premium_features = 11;
      Specified by:
      getPremiumFeaturesOrBuilder in interface OcrConfigOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static OcrConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OcrConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OcrConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OcrConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OcrConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OcrConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static OcrConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OcrConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OcrConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static OcrConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OcrConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static OcrConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public OcrConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static OcrConfig.Builder newBuilder()

    • newBuilder

      public static OcrConfig.Builder newBuilder(OcrConfig prototype)

    • toBuilder

      public OcrConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected OcrConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static OcrConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<OcrConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<OcrConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public OcrConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder