Class: LiteParse::Config

Inherits:

Object

• Object
• LiteParse::Config

Defined in:

lib/liteparse/types.rb

Overview

The current configuration of a LiteParse parser instance.

Instance Method Summary

• #dpi ⇒ Float

  Rendering DPI.

• #max_pages ⇒ Integer

  Maximum pages to parse.

• #num_workers ⇒ Integer

  Number of worker threads.

• #ocr_enabled ⇒ Boolean

  Whether OCR is enabled.

• #ocr_language ⇒ String

  Language used for OCR (e.g. “eng”).

• #ocr_server_headers ⇒ Hash<String, String>^?

  Headers for OCR server requests.

• #ocr_server_url ⇒ String^?

  External OCR server URL, if configured.

• #output_format ⇒ String

  Output format: “json”, “text”, or “markdown”.

• #password ⇒ String^?

  Document password, if set.

• #preserve_very_small_text ⇒ Boolean

  Whether very small text is preserved.

• #quiet ⇒ Boolean

  Whether non-error output is suppressed.

• #target_pages ⇒ String^?

  Page range expression, if configured.

• #tessdata_path ⇒ String^?

  Path to Tesseract tessdata directory.

Instance Method Details

#dpi ⇒ Float

Returns Rendering DPI.

Returns:

• (Float) —

  Rendering DPI

# File 'lib/liteparse/types.rb', line 103

class Config; end

#max_pages ⇒ Integer

Returns Maximum pages to parse.

Returns:

• (Integer) —

  Maximum pages to parse

# File 'lib/liteparse/types.rb', line 103

class Config; end

#num_workers ⇒ Integer

Returns Number of worker threads.

Returns:

• (Integer) —

  Number of worker threads

# File 'lib/liteparse/types.rb', line 103

class Config; end

#ocr_enabled ⇒ Boolean

Returns Whether OCR is enabled.

Returns:

• (Boolean) —

  Whether OCR is enabled

# File 'lib/liteparse/types.rb', line 103

class Config; end

#ocr_language ⇒ String

Returns Language used for OCR (e.g. “eng”).

Returns:

• (String) —

  Language used for OCR (e.g. “eng”)

# File 'lib/liteparse/types.rb', line 103

class Config; end

#ocr_server_headers ⇒ Hash<String, String>^?

Returns Headers for OCR server requests.

Returns:

• (Hash<String, String>, nil) —

  Headers for OCR server requests

# File 'lib/liteparse/types.rb', line 103

class Config; end

#ocr_server_url ⇒ String^?

Returns External OCR server URL, if configured.

Returns:

• (String, nil) —

  External OCR server URL, if configured

# File 'lib/liteparse/types.rb', line 103

class Config; end

#output_format ⇒ String

Returns Output format: “json”, “text”, or “markdown”.

Returns:

• (String) —

  Output format: “json”, “text”, or “markdown”

# File 'lib/liteparse/types.rb', line 103

class Config; end

#password ⇒ String^?

Returns Document password, if set.

Returns:

• (String, nil) —

  Document password, if set

# File 'lib/liteparse/types.rb', line 103

class Config; end

#preserve_very_small_text ⇒ Boolean

Returns Whether very small text is preserved.

Returns:

• (Boolean) —

  Whether very small text is preserved

# File 'lib/liteparse/types.rb', line 103

class Config; end

#quiet ⇒ Boolean

Returns Whether non-error output is suppressed.

Returns:

• (Boolean) —

  Whether non-error output is suppressed

# File 'lib/liteparse/types.rb', line 103

class Config; end

#target_pages ⇒ String^?

Returns Page range expression, if configured.

Returns:

• (String, nil) —

  Page range expression, if configured

# File 'lib/liteparse/types.rb', line 103

class Config; end

#tessdata_path ⇒ String^?

Returns Path to Tesseract tessdata directory.

Returns:

• (String, nil) —

  Path to Tesseract tessdata directory

# File 'lib/liteparse/types.rb', line 103

class Config; end