Class: Xberg::ExtractionConfig

Inherits:
Object
  • Object
show all
Defined in:
sig/types.rbs

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ ExtractionConfig

Returns a new instance of ExtractionConfig.

Parameters:



105
 
# File 'sig/types.rbs', line 105

def initialize: (?use_cache: bool, ?enable_quality_processing: bool, ?ocr: OcrConfig, ?force_ocr: bool, ?force_ocr_pages: Array[Integer], ?disable_ocr: bool, ?chunking: ChunkingConfig, ?content_filter: ContentFilterConfig, ?images: ImageExtractionConfig, ?pdf_options: PdfConfig, ?token_reduction: TokenReductionOptions, ?language_detection: LanguageDetectionConfig, ?pages: PageConfig, ?keywords: KeywordConfig, ?postprocessor: PostProcessorConfig, ?html_output: HtmlOutputConfig, ?extraction_timeout_secs: Integer, ?max_concurrent_extractions: Integer, ?result_format: ResultFormat, ?security_limits: SecurityLimits, ?max_embedded_file_bytes: Integer, ?output_format: OutputFormat, ?layout: LayoutDetectionConfig, ?transcription: TranscriptionConfig, ?use_layout_for_markdown: bool, ?include_document_structure: bool, ?acceleration: AccelerationConfig, ?cache_namespace: String, ?cache_ttl_secs: Integer, ?email: EmailConfig, ?url: UrlExtractionConfig, ?max_archive_depth: Integer, ?tree_sitter: TreeSitterConfig, ?structured_extraction: StructuredExtractionConfig, ?ner: NerConfig, ?redaction: RedactionConfig, ?summarization: SummarizationConfig, ?translation: TranslationConfig, ?page_classification: PageClassificationConfig, ?captioning: CaptioningConfig, ?qr_codes: bool) -> void

Instance Attribute Details

#acceleration ⇒ AccelerationConfig?

Returns the value of attribute acceleration.

Returns:



89
90
91
 
# File 'sig/types.rbs', line 89

def acceleration
  @acceleration
end

#cache_namespace ⇒ String?

Returns the value of attribute cache_namespace.

Returns:

  • (String, nil) 


90
91
92
 
# File 'sig/types.rbs', line 90

def cache_namespace
  @cache_namespace
end

#cache_ttl_secs ⇒ Integer?

Returns the value of attribute cache_ttl_secs.

Returns:

  • (Integer, nil) 


91
92
93
 
# File 'sig/types.rbs', line 91

def cache_ttl_secs
  @cache_ttl_secs
end

#captioning ⇒ CaptioningConfig?

Returns the value of attribute captioning.

Returns:



102
103
104
 
# File 'sig/types.rbs', line 102

def captioning
  @captioning
end

#chunking ⇒ ChunkingConfig?

Returns the value of attribute chunking.

Returns:



69
70
71
 
# File 'sig/types.rbs', line 69

def chunking
  @chunking
end

#content_filter ⇒ ContentFilterConfig?

Returns the value of attribute content_filter.

Returns:



70
71
72
 
# File 'sig/types.rbs', line 70

def content_filter
  @content_filter
end

#disable_ocr ⇒ Boolean?

Returns the value of attribute disable_ocr.

Returns:

  • (Boolean, nil) 


68
69
70
 
# File 'sig/types.rbs', line 68

def disable_ocr
  @disable_ocr
end

#email ⇒ EmailConfig?

Returns the value of attribute email.

Returns:



92
93
94
 
# File 'sig/types.rbs', line 92

def email
  @email
end

#enable_quality_processing ⇒ Boolean?

Returns the value of attribute enable_quality_processing.

Returns:

  • (Boolean, nil) 


64
65
66
 
# File 'sig/types.rbs', line 64

def enable_quality_processing
  @enable_quality_processing
end

#extraction_timeout_secs ⇒ Integer?

Returns the value of attribute extraction_timeout_secs.

Returns:

  • (Integer, nil) 


79
80
81
 
# File 'sig/types.rbs', line 79

def extraction_timeout_secs
  @extraction_timeout_secs
end

#force_ocr ⇒ Boolean?

Returns the value of attribute force_ocr.

Returns:

  • (Boolean, nil) 


66
67
68
 
# File 'sig/types.rbs', line 66

def force_ocr
  @force_ocr
end

#force_ocr_pages ⇒ Array[Integer]?

Returns the value of attribute force_ocr_pages.

Returns:

  • (Array[Integer], nil) 


67
68
69
 
# File 'sig/types.rbs', line 67

def force_ocr_pages
  @force_ocr_pages
end

#html_output ⇒ HtmlOutputConfig?

Returns the value of attribute html_output.

Returns:



78
79
80
 
# File 'sig/types.rbs', line 78

def html_output
  @html_output
end

#images ⇒ ImageExtractionConfig?

Returns the value of attribute images.

Returns:



71
72
73
 
# File 'sig/types.rbs', line 71

def images
  @images
end

#include_document_structure ⇒ Boolean?

Returns the value of attribute include_document_structure.

Returns:

  • (Boolean, nil) 


88
89
90
 
# File 'sig/types.rbs', line 88

def include_document_structure
  @include_document_structure
end

#keywords ⇒ KeywordConfig?

Returns the value of attribute keywords.

Returns:



76
77
78
 
# File 'sig/types.rbs', line 76

def keywords
  @keywords
end

#language_detection ⇒ LanguageDetectionConfig?

Returns the value of attribute language_detection.

Returns:



74
75
76
 
# File 'sig/types.rbs', line 74

def language_detection
  @language_detection
end

#layout ⇒ LayoutDetectionConfig?

Returns the value of attribute layout.

Returns:



85
86
87
 
# File 'sig/types.rbs', line 85

def layout
  @layout
end

#max_archive_depth ⇒ Integer?

Returns the value of attribute max_archive_depth.

Returns:

  • (Integer, nil) 


94
95
96
 
# File 'sig/types.rbs', line 94

def max_archive_depth
  @max_archive_depth
end

#max_concurrent_extractions ⇒ Integer?

Returns the value of attribute max_concurrent_extractions.

Returns:

  • (Integer, nil) 


80
81
82
 
# File 'sig/types.rbs', line 80

def max_concurrent_extractions
  @max_concurrent_extractions
end

#max_embedded_file_bytes ⇒ Integer?

Returns the value of attribute max_embedded_file_bytes.

Returns:

  • (Integer, nil) 


83
84
85
 
# File 'sig/types.rbs', line 83

def max_embedded_file_bytes
  @max_embedded_file_bytes
end

#ner ⇒ NerConfig?

Returns the value of attribute ner.

Returns:



97
98
99
 
# File 'sig/types.rbs', line 97

def ner
  @ner
end

#ocr ⇒ OcrConfig?

Returns the value of attribute ocr.

Returns:



65
66
67
 
# File 'sig/types.rbs', line 65

def ocr
  @ocr
end

#output_format ⇒ OutputFormat?

Returns the value of attribute output_format.

Returns:



84
85
86
 
# File 'sig/types.rbs', line 84

def output_format
  @output_format
end

#page_classification ⇒ PageClassificationConfig?

Returns the value of attribute page_classification.

Returns:



101
102
103
 
# File 'sig/types.rbs', line 101

def page_classification
  @page_classification
end

#pages ⇒ PageConfig?

Returns the value of attribute pages.

Returns:



75
76
77
 
# File 'sig/types.rbs', line 75

def pages
  @pages
end

#pdf_options ⇒ PdfConfig?

Returns the value of attribute pdf_options.

Returns:



72
73
74
 
# File 'sig/types.rbs', line 72

def pdf_options
  @pdf_options
end

#postprocessor ⇒ PostProcessorConfig?

Returns the value of attribute postprocessor.

Returns:



77
78
79
 
# File 'sig/types.rbs', line 77

def postprocessor
  @postprocessor
end

#qr_codes ⇒ Boolean?

Returns the value of attribute qr_codes.

Returns:

  • (Boolean, nil) 


103
104
105
 
# File 'sig/types.rbs', line 103

def qr_codes
  @qr_codes
end

#redaction ⇒ RedactionConfig?

Returns the value of attribute redaction.

Returns:



98
99
100
 
# File 'sig/types.rbs', line 98

def redaction
  @redaction
end

#result_format ⇒ ResultFormat?

Returns the value of attribute result_format.

Returns:



81
82
83
 
# File 'sig/types.rbs', line 81

def result_format
  @result_format
end

#security_limits ⇒ SecurityLimits?

Returns the value of attribute security_limits.

Returns:



82
83
84
 
# File 'sig/types.rbs', line 82

def security_limits
  @security_limits
end

#structured_extraction ⇒ StructuredExtractionConfig?

Returns the value of attribute structured_extraction.

Returns:



96
97
98
 
# File 'sig/types.rbs', line 96

def structured_extraction
  @structured_extraction
end

#summarization ⇒ SummarizationConfig?

Returns the value of attribute summarization.

Returns:



99
100
101
 
# File 'sig/types.rbs', line 99

def summarization
  @summarization
end

#token_reduction ⇒ TokenReductionOptions?

Returns the value of attribute token_reduction.

Returns:



73
74
75
 
# File 'sig/types.rbs', line 73

def token_reduction
  @token_reduction
end

#transcription ⇒ TranscriptionConfig?

Returns the value of attribute transcription.

Returns:



86
87
88
 
# File 'sig/types.rbs', line 86

def transcription
  @transcription
end

#translation ⇒ TranslationConfig?

Returns the value of attribute translation.

Returns:



100
101
102
 
# File 'sig/types.rbs', line 100

def translation
  @translation
end

#tree_sitter ⇒ TreeSitterConfig?

Returns the value of attribute tree_sitter.

Returns:



95
96
97
 
# File 'sig/types.rbs', line 95

def tree_sitter
  @tree_sitter
end

#url ⇒ UrlExtractionConfig?

Returns the value of attribute url.

Returns:



93
94
95
 
# File 'sig/types.rbs', line 93

def url
  @url
end

#use_cache ⇒ Boolean?

Returns the value of attribute use_cache.

Returns:

  • (Boolean, nil) 


63
64
65
 
# File 'sig/types.rbs', line 63

def use_cache
  @use_cache
end

#use_layout_for_markdown ⇒ Boolean?

Returns the value of attribute use_layout_for_markdown.

Returns:

  • (Boolean, nil) 


87
88
89
 
# File 'sig/types.rbs', line 87

def use_layout_for_markdown
  @use_layout_for_markdown
end

Class Method Details

.default ⇒ ExtractionConfig

Returns:



108
 
# File 'sig/types.rbs', line 108

def self.default: () -> ExtractionConfig

Instance Method Details

#needs_image_data ⇒ Boolean

Returns:

  • (Boolean) 


106
 
# File 'sig/types.rbs', line 106

def needs_image_data: () -> bool

#needs_image_processing ⇒ Boolean

Returns:

  • (Boolean) 


107
 
# File 'sig/types.rbs', line 107

def needs_image_processing: () -> bool