Package com.google.cloud.documentai.v1

Interface OcrConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
OcrConfig, OcrConfig.Builder
@Generated public interface OcrConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasHints

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

    • getHints

      OcrConfig.Hints getHints()
       Hints for the OCR model.
      .google.cloud.documentai.v1.OcrConfig.Hints hints = 2;
      Returns:
      The hints.

    • getHintsOrBuilder

      OcrConfig.HintsOrBuilder getHintsOrBuilder()
       Hints for the OCR model.
      .google.cloud.documentai.v1.OcrConfig.Hints hints = 2;

    • getEnableNativePdfParsing

      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:
      The enableNativePdfParsing.

    • getEnableImageQualityScores

      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:
      The enableImageQualityScores.

    • getAdvancedOcrOptionsList

      List<String> 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:
      A list containing the advancedOcrOptions.

    • getAdvancedOcrOptionsCount

      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:
      The count of advancedOcrOptions.

    • getAdvancedOcrOptions

      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;
      Parameters:
      index - The index of the element to return.
      Returns:
      The advancedOcrOptions at the given index.

    • getAdvancedOcrOptionsBytes

      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;
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the advancedOcrOptions at the given index.

    • getEnableSymbol

      boolean getEnableSymbol()
       Includes symbol level OCR information if set to true.
      bool enable_symbol = 6;
      Returns:
      The enableSymbol.

    • getComputeStyleInfo

      @Deprecated 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];
      Returns:
      The computeStyleInfo.

    • getDisableCharacterBoxesDetection

      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;
      Returns:
      The disableCharacterBoxesDetection.

    • hasPremiumFeatures

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

    • getPremiumFeatures

      OcrConfig.PremiumFeatures getPremiumFeatures()
       Configurations for premium OCR features.
      .google.cloud.documentai.v1.OcrConfig.PremiumFeatures premium_features = 11;
      Returns:
      The premiumFeatures.

    • getPremiumFeaturesOrBuilder

      OcrConfig.PremiumFeaturesOrBuilder getPremiumFeaturesOrBuilder()
       Configurations for premium OCR features.
      .google.cloud.documentai.v1.OcrConfig.PremiumFeatures premium_features = 11;