Struct OcrConfig 

#[non_exhaustive]
pub struct OcrConfig {
    pub hints: Option<Hints>,
    pub enable_native_pdf_parsing: bool,
    pub enable_image_quality_scores: bool,
    pub advanced_ocr_options: Vec<String>,
    pub enable_symbol: bool,
    pub compute_style_info: bool,
    pub disable_character_boxes_detection: bool,
    pub premium_features: Option<PremiumFeatures>,
    /* private fields */
}

Config for Document OCR.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

hints: Option<Hints>

Hints for the OCR model.

enable_native_pdf_parsing: bool

Enables special handling for PDFs with existing text information. Results in better text extraction quality in such PDF inputs.

enable_image_quality_scores: bool

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.

advanced_ocr_options: Vec<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.

enable_symbol: bool

Includes symbol level OCR information if set to true.

compute_style_info: bool

👎Deprecated

Turn on font identification model and return font style information. Deprecated, use PremiumFeatures.compute_style_info instead.

disable_character_boxes_detection: bool

Turn off character box detector in OCR engine. Character box detection is enabled by default in OCR 2.0 (and later) processors.

premium_features: Option<PremiumFeatures>

Configurations for premium OCR features.

Implementations

impl OcrConfig

pub fn new() -> Self

pub fn set_hints<T>(self, v: T) -> Self

where T: Into<Hints>,

Sets the value of hints.

pub fn set_or_clear_hints<T>(self, v: Option<T>) -> Self

where T: Into<Hints>,

Sets or clears the value of hints.

pub fn set_enable_native_pdf_parsing<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_native_pdf_parsing.

pub fn set_enable_image_quality_scores<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_image_quality_scores.

pub fn set_advanced_ocr_options<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of advanced_ocr_options.

pub fn set_enable_symbol<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_symbol.

pub fn set_compute_style_info<T: Into<bool>>(self, v: T) -> Self

👎Deprecated

Sets the value of compute_style_info.

pub fn set_disable_character_boxes_detection<T: Into<bool>>(self, v: T) -> Self

Sets the value of disable_character_boxes_detection.

pub fn set_premium_features<T>(self, v: T) -> Self

where T: Into<PremiumFeatures>,

Sets the value of premium_features.

pub fn set_or_clear_premium_features<T>(self, v: Option<T>) -> Self

where T: Into<PremiumFeatures>,

Sets or clears the value of premium_features.

Trait Implementations

impl Clone for OcrConfig

fn clone(&self) -> OcrConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for OcrConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for OcrConfig

fn default() -> OcrConfig

Returns the “default value” for a type.

impl Message for OcrConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for OcrConfig

fn eq(&self, other: &OcrConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for OcrConfig