Document AI V1 API - Class Google::Cloud::DocumentAI::V1::OcrConfig (v1.2.0)

Reference documentation and code samples for the Document AI V1 API class Google::Cloud::DocumentAI::V1::OcrConfig.

Config for Document OCR.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#advanced_ocr_options

def advanced_ocr_options() -> ::Array<::String>
Returns
  • (::Array<::String>) —

    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.

#advanced_ocr_options=

def advanced_ocr_options=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) —

    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.
Returns
  • (::Array<::String>) —

    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.

#compute_style_info

def compute_style_info() -> ::Boolean
Returns

#compute_style_info=

def compute_style_info=(value) -> ::Boolean
Parameter
Returns

#disable_character_boxes_detection

def disable_character_boxes_detection() -> ::Boolean
Returns
  • (::Boolean) — Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.

#disable_character_boxes_detection=

def disable_character_boxes_detection=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.
Returns
  • (::Boolean) — Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.

#enable_image_quality_scores

def enable_image_quality_scores() -> ::Boolean
Returns
  • (::Boolean) — 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.

#enable_image_quality_scores=

def enable_image_quality_scores=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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.
Returns
  • (::Boolean) — 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.

#enable_native_pdf_parsing

def enable_native_pdf_parsing() -> ::Boolean
Returns
  • (::Boolean) — Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.

#enable_native_pdf_parsing=

def enable_native_pdf_parsing=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.
Returns
  • (::Boolean) — Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.

#enable_symbol

def enable_symbol() -> ::Boolean
Returns
  • (::Boolean) — Includes symbol level OCR information if set to true.

#enable_symbol=

def enable_symbol=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Includes symbol level OCR information if set to true.
Returns
  • (::Boolean) — Includes symbol level OCR information if set to true.

#hints

def hints() -> ::Google::Cloud::DocumentAI::V1::OcrConfig::Hints
Returns

#hints=

def hints=(value) -> ::Google::Cloud::DocumentAI::V1::OcrConfig::Hints
Parameter
Returns

#premium_features

def premium_features() -> ::Google::Cloud::DocumentAI::V1::OcrConfig::PremiumFeatures
Returns

#premium_features=

def premium_features=(value) -> ::Google::Cloud::DocumentAI::V1::OcrConfig::PremiumFeatures
Parameter
Returns