kreuzberg 4.0.0.rc2 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (446) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +14 -14
  3. data/.rspec +3 -3
  4. data/.rubocop.yaml +1 -1
  5. data/.rubocop.yml +543 -538
  6. data/Gemfile +8 -8
  7. data/Gemfile.lock +194 -6
  8. data/README.md +391 -426
  9. data/Rakefile +34 -25
  10. data/Steepfile +51 -47
  11. data/examples/async_patterns.rb +283 -341
  12. data/ext/kreuzberg_rb/extconf.rb +65 -45
  13. data/ext/kreuzberg_rb/native/.cargo/config.toml +23 -0
  14. data/ext/kreuzberg_rb/native/Cargo.lock +7619 -6535
  15. data/ext/kreuzberg_rb/native/Cargo.toml +75 -44
  16. data/ext/kreuzberg_rb/native/README.md +425 -425
  17. data/ext/kreuzberg_rb/native/build.rs +15 -15
  18. data/ext/kreuzberg_rb/native/include/ieeefp.h +11 -11
  19. data/ext/kreuzberg_rb/native/include/msvc_compat/strings.h +14 -14
  20. data/ext/kreuzberg_rb/native/include/strings.h +20 -20
  21. data/ext/kreuzberg_rb/native/include/unistd.h +47 -47
  22. data/ext/kreuzberg_rb/native/src/lib.rs +3802 -2998
  23. data/extconf.rb +60 -28
  24. data/kreuzberg.gemspec +199 -148
  25. data/lib/kreuzberg/api_proxy.rb +126 -142
  26. data/lib/kreuzberg/cache_api.rb +67 -46
  27. data/lib/kreuzberg/cli.rb +47 -55
  28. data/lib/kreuzberg/cli_proxy.rb +117 -127
  29. data/lib/kreuzberg/config.rb +936 -691
  30. data/lib/kreuzberg/error_context.rb +136 -32
  31. data/lib/kreuzberg/errors.rb +116 -118
  32. data/lib/kreuzberg/extraction_api.rb +313 -85
  33. data/lib/kreuzberg/mcp_proxy.rb +177 -186
  34. data/lib/kreuzberg/ocr_backend_protocol.rb +40 -113
  35. data/lib/kreuzberg/post_processor_protocol.rb +15 -86
  36. data/lib/kreuzberg/result.rb +334 -216
  37. data/lib/kreuzberg/setup_lib_path.rb +99 -80
  38. data/lib/kreuzberg/types.rb +170 -0
  39. data/lib/kreuzberg/validator_protocol.rb +16 -89
  40. data/lib/kreuzberg/version.rb +5 -5
  41. data/lib/kreuzberg.rb +96 -103
  42. data/lib/libpdfium.so +0 -0
  43. data/sig/kreuzberg/internal.rbs +184 -184
  44. data/sig/kreuzberg.rbs +561 -520
  45. data/spec/binding/async_operations_spec.rb +473 -0
  46. data/spec/binding/batch_operations_spec.rb +595 -0
  47. data/spec/binding/batch_spec.rb +359 -0
  48. data/spec/binding/cache_spec.rb +227 -227
  49. data/spec/binding/cli_proxy_spec.rb +85 -85
  50. data/spec/binding/cli_spec.rb +55 -55
  51. data/spec/binding/config_result_spec.rb +377 -0
  52. data/spec/binding/config_spec.rb +419 -345
  53. data/spec/binding/config_validation_spec.rb +377 -283
  54. data/spec/binding/embeddings_spec.rb +816 -0
  55. data/spec/binding/error_handling_spec.rb +399 -213
  56. data/spec/binding/error_recovery_spec.rb +488 -0
  57. data/spec/binding/errors_spec.rb +66 -66
  58. data/spec/binding/font_config_spec.rb +220 -0
  59. data/spec/binding/images_spec.rb +738 -0
  60. data/spec/binding/keywords_extraction_spec.rb +600 -0
  61. data/spec/binding/metadata_types_spec.rb +1228 -0
  62. data/spec/binding/pages_extraction_spec.rb +471 -0
  63. data/spec/binding/plugins/ocr_backend_spec.rb +307 -307
  64. data/spec/binding/plugins/postprocessor_spec.rb +269 -269
  65. data/spec/binding/plugins/validator_spec.rb +273 -274
  66. data/spec/binding/tables_spec.rb +641 -0
  67. data/spec/fixtures/config.toml +38 -39
  68. data/spec/fixtures/config.yaml +41 -41
  69. data/spec/fixtures/invalid_config.toml +3 -4
  70. data/spec/smoke/package_spec.rb +177 -178
  71. data/spec/spec_helper.rb +40 -42
  72. data/spec/unit/config/chunking_config_spec.rb +213 -0
  73. data/spec/unit/config/embedding_config_spec.rb +343 -0
  74. data/spec/unit/config/extraction_config_spec.rb +438 -0
  75. data/spec/unit/config/font_config_spec.rb +285 -0
  76. data/spec/unit/config/hierarchy_config_spec.rb +314 -0
  77. data/spec/unit/config/image_extraction_config_spec.rb +209 -0
  78. data/spec/unit/config/image_preprocessing_config_spec.rb +249 -0
  79. data/spec/unit/config/keyword_config_spec.rb +229 -0
  80. data/spec/unit/config/language_detection_config_spec.rb +258 -0
  81. data/spec/unit/config/ocr_config_spec.rb +171 -0
  82. data/spec/unit/config/page_config_spec.rb +221 -0
  83. data/spec/unit/config/pdf_config_spec.rb +267 -0
  84. data/spec/unit/config/postprocessor_config_spec.rb +290 -0
  85. data/spec/unit/config/tesseract_config_spec.rb +181 -0
  86. data/spec/unit/config/token_reduction_config_spec.rb +251 -0
  87. data/test/metadata_types_test.rb +959 -0
  88. data/vendor/Cargo.toml +61 -0
  89. data/vendor/kreuzberg/Cargo.toml +259 -204
  90. data/vendor/kreuzberg/README.md +263 -175
  91. data/vendor/kreuzberg/build.rs +782 -474
  92. data/vendor/kreuzberg/examples/bench_fixes.rs +71 -0
  93. data/vendor/kreuzberg/examples/test_pdfium_fork.rs +62 -0
  94. data/vendor/kreuzberg/src/api/error.rs +81 -81
  95. data/vendor/kreuzberg/src/api/handlers.rs +320 -199
  96. data/vendor/kreuzberg/src/api/mod.rs +94 -79
  97. data/vendor/kreuzberg/src/api/server.rs +518 -353
  98. data/vendor/kreuzberg/src/api/types.rs +206 -170
  99. data/vendor/kreuzberg/src/cache/mod.rs +1167 -1167
  100. data/vendor/kreuzberg/src/chunking/mod.rs +2303 -677
  101. data/vendor/kreuzberg/src/chunking/processor.rs +219 -0
  102. data/vendor/kreuzberg/src/core/batch_mode.rs +95 -95
  103. data/vendor/kreuzberg/src/core/batch_optimizations.rs +385 -0
  104. data/vendor/kreuzberg/src/core/config.rs +1914 -1032
  105. data/vendor/kreuzberg/src/core/config_validation.rs +949 -0
  106. data/vendor/kreuzberg/src/core/extractor.rs +1200 -1024
  107. data/vendor/kreuzberg/src/core/formats.rs +235 -0
  108. data/vendor/kreuzberg/src/core/io.rs +329 -329
  109. data/vendor/kreuzberg/src/core/mime.rs +605 -605
  110. data/vendor/kreuzberg/src/core/mod.rs +61 -45
  111. data/vendor/kreuzberg/src/core/pipeline.rs +1223 -984
  112. data/vendor/kreuzberg/src/core/server_config.rs +1220 -0
  113. data/vendor/kreuzberg/src/embeddings.rs +471 -432
  114. data/vendor/kreuzberg/src/error.rs +431 -431
  115. data/vendor/kreuzberg/src/extraction/archive.rs +959 -954
  116. data/vendor/kreuzberg/src/extraction/capacity.rs +263 -0
  117. data/vendor/kreuzberg/src/extraction/docx.rs +404 -40
  118. data/vendor/kreuzberg/src/extraction/email.rs +855 -854
  119. data/vendor/kreuzberg/src/extraction/excel.rs +697 -688
  120. data/vendor/kreuzberg/src/extraction/html.rs +1830 -553
  121. data/vendor/kreuzberg/src/extraction/image.rs +492 -368
  122. data/vendor/kreuzberg/src/extraction/libreoffice.rs +574 -563
  123. data/vendor/kreuzberg/src/extraction/markdown.rs +216 -213
  124. data/vendor/kreuzberg/src/extraction/mod.rs +93 -81
  125. data/vendor/kreuzberg/src/extraction/office_metadata/app_properties.rs +398 -398
  126. data/vendor/kreuzberg/src/extraction/office_metadata/core_properties.rs +247 -247
  127. data/vendor/kreuzberg/src/extraction/office_metadata/custom_properties.rs +240 -240
  128. data/vendor/kreuzberg/src/extraction/office_metadata/mod.rs +130 -130
  129. data/vendor/kreuzberg/src/extraction/office_metadata/odt_properties.rs +284 -287
  130. data/vendor/kreuzberg/src/extraction/pptx.rs +3102 -3000
  131. data/vendor/kreuzberg/src/extraction/structured.rs +491 -490
  132. data/vendor/kreuzberg/src/extraction/table.rs +329 -328
  133. data/vendor/kreuzberg/src/extraction/text.rs +277 -269
  134. data/vendor/kreuzberg/src/extraction/xml.rs +333 -333
  135. data/vendor/kreuzberg/src/extractors/archive.rs +447 -446
  136. data/vendor/kreuzberg/src/extractors/bibtex.rs +470 -469
  137. data/vendor/kreuzberg/src/extractors/docbook.rs +504 -502
  138. data/vendor/kreuzberg/src/extractors/docx.rs +400 -367
  139. data/vendor/kreuzberg/src/extractors/email.rs +157 -143
  140. data/vendor/kreuzberg/src/extractors/epub.rs +696 -707
  141. data/vendor/kreuzberg/src/extractors/excel.rs +385 -343
  142. data/vendor/kreuzberg/src/extractors/fictionbook.rs +492 -491
  143. data/vendor/kreuzberg/src/extractors/html.rs +419 -393
  144. data/vendor/kreuzberg/src/extractors/image.rs +219 -198
  145. data/vendor/kreuzberg/src/extractors/jats.rs +1054 -1051
  146. data/vendor/kreuzberg/src/extractors/jupyter.rs +368 -367
  147. data/vendor/kreuzberg/src/extractors/latex.rs +653 -652
  148. data/vendor/kreuzberg/src/extractors/markdown.rs +701 -700
  149. data/vendor/kreuzberg/src/extractors/mod.rs +429 -365
  150. data/vendor/kreuzberg/src/extractors/odt.rs +628 -628
  151. data/vendor/kreuzberg/src/extractors/opml.rs +635 -634
  152. data/vendor/kreuzberg/src/extractors/orgmode.rs +529 -528
  153. data/vendor/kreuzberg/src/extractors/pdf.rs +761 -493
  154. data/vendor/kreuzberg/src/extractors/pptx.rs +279 -248
  155. data/vendor/kreuzberg/src/extractors/rst.rs +577 -576
  156. data/vendor/kreuzberg/src/extractors/rtf.rs +809 -810
  157. data/vendor/kreuzberg/src/extractors/security.rs +484 -484
  158. data/vendor/kreuzberg/src/extractors/security_tests.rs +367 -367
  159. data/vendor/kreuzberg/src/extractors/structured.rs +142 -140
  160. data/vendor/kreuzberg/src/extractors/text.rs +265 -260
  161. data/vendor/kreuzberg/src/extractors/typst.rs +651 -650
  162. data/vendor/kreuzberg/src/extractors/xml.rs +147 -135
  163. data/vendor/kreuzberg/src/image/dpi.rs +164 -164
  164. data/vendor/kreuzberg/src/image/mod.rs +6 -6
  165. data/vendor/kreuzberg/src/image/preprocessing.rs +417 -417
  166. data/vendor/kreuzberg/src/image/resize.rs +89 -89
  167. data/vendor/kreuzberg/src/keywords/config.rs +154 -154
  168. data/vendor/kreuzberg/src/keywords/mod.rs +237 -237
  169. data/vendor/kreuzberg/src/keywords/processor.rs +275 -267
  170. data/vendor/kreuzberg/src/keywords/rake.rs +293 -293
  171. data/vendor/kreuzberg/src/keywords/types.rs +68 -68
  172. data/vendor/kreuzberg/src/keywords/yake.rs +163 -163
  173. data/vendor/kreuzberg/src/language_detection/mod.rs +985 -942
  174. data/vendor/kreuzberg/src/language_detection/processor.rs +218 -0
  175. data/vendor/kreuzberg/src/lib.rs +114 -105
  176. data/vendor/kreuzberg/src/mcp/mod.rs +35 -32
  177. data/vendor/kreuzberg/src/mcp/server.rs +2090 -1968
  178. data/vendor/kreuzberg/src/ocr/cache.rs +469 -469
  179. data/vendor/kreuzberg/src/ocr/error.rs +37 -37
  180. data/vendor/kreuzberg/src/ocr/hocr.rs +216 -216
  181. data/vendor/kreuzberg/src/ocr/language_registry.rs +520 -0
  182. data/vendor/kreuzberg/src/ocr/mod.rs +60 -58
  183. data/vendor/kreuzberg/src/ocr/processor.rs +858 -863
  184. data/vendor/kreuzberg/src/ocr/table/mod.rs +4 -4
  185. data/vendor/kreuzberg/src/ocr/table/tsv_parser.rs +144 -144
  186. data/vendor/kreuzberg/src/ocr/tesseract_backend.rs +456 -450
  187. data/vendor/kreuzberg/src/ocr/types.rs +393 -393
  188. data/vendor/kreuzberg/src/ocr/utils.rs +47 -47
  189. data/vendor/kreuzberg/src/ocr/validation.rs +206 -206
  190. data/vendor/kreuzberg/src/panic_context.rs +154 -154
  191. data/vendor/kreuzberg/src/pdf/bindings.rs +306 -0
  192. data/vendor/kreuzberg/src/pdf/bundled.rs +408 -0
  193. data/vendor/kreuzberg/src/pdf/error.rs +214 -122
  194. data/vendor/kreuzberg/src/pdf/fonts.rs +358 -0
  195. data/vendor/kreuzberg/src/pdf/hierarchy.rs +903 -0
  196. data/vendor/kreuzberg/src/pdf/images.rs +139 -139
  197. data/vendor/kreuzberg/src/pdf/metadata.rs +509 -346
  198. data/vendor/kreuzberg/src/pdf/mod.rs +81 -50
  199. data/vendor/kreuzberg/src/pdf/rendering.rs +369 -369
  200. data/vendor/kreuzberg/src/pdf/table.rs +417 -393
  201. data/vendor/kreuzberg/src/pdf/text.rs +553 -158
  202. data/vendor/kreuzberg/src/plugins/extractor.rs +1042 -1013
  203. data/vendor/kreuzberg/src/plugins/mod.rs +212 -209
  204. data/vendor/kreuzberg/src/plugins/ocr.rs +637 -620
  205. data/vendor/kreuzberg/src/plugins/processor.rs +650 -642
  206. data/vendor/kreuzberg/src/plugins/registry.rs +1339 -1337
  207. data/vendor/kreuzberg/src/plugins/traits.rs +258 -258
  208. data/vendor/kreuzberg/src/plugins/validator.rs +967 -956
  209. data/vendor/kreuzberg/src/stopwords/mod.rs +1470 -1470
  210. data/vendor/kreuzberg/src/text/mod.rs +27 -19
  211. data/vendor/kreuzberg/src/text/quality.rs +710 -697
  212. data/vendor/kreuzberg/src/text/quality_processor.rs +231 -0
  213. data/vendor/kreuzberg/src/text/string_utils.rs +229 -217
  214. data/vendor/kreuzberg/src/text/token_reduction/cjk_utils.rs +164 -164
  215. data/vendor/kreuzberg/src/text/token_reduction/config.rs +100 -100
  216. data/vendor/kreuzberg/src/text/token_reduction/core.rs +832 -796
  217. data/vendor/kreuzberg/src/text/token_reduction/filters.rs +923 -902
  218. data/vendor/kreuzberg/src/text/token_reduction/mod.rs +160 -160
  219. data/vendor/kreuzberg/src/text/token_reduction/semantic.rs +619 -619
  220. data/vendor/kreuzberg/src/text/token_reduction/simd_text.rs +148 -147
  221. data/vendor/kreuzberg/src/text/utf8_validation.rs +193 -0
  222. data/vendor/kreuzberg/src/types.rs +1713 -903
  223. data/vendor/kreuzberg/src/utils/mod.rs +31 -17
  224. data/vendor/kreuzberg/src/utils/pool.rs +503 -0
  225. data/vendor/kreuzberg/src/utils/pool_sizing.rs +364 -0
  226. data/vendor/kreuzberg/src/utils/quality.rs +968 -959
  227. data/vendor/kreuzberg/src/utils/string_pool.rs +761 -0
  228. data/vendor/kreuzberg/src/utils/string_utils.rs +381 -381
  229. data/vendor/kreuzberg/stopwords/af_stopwords.json +53 -53
  230. data/vendor/kreuzberg/stopwords/ar_stopwords.json +482 -482
  231. data/vendor/kreuzberg/stopwords/bg_stopwords.json +261 -261
  232. data/vendor/kreuzberg/stopwords/bn_stopwords.json +400 -400
  233. data/vendor/kreuzberg/stopwords/br_stopwords.json +1205 -1205
  234. data/vendor/kreuzberg/stopwords/ca_stopwords.json +280 -280
  235. data/vendor/kreuzberg/stopwords/cs_stopwords.json +425 -425
  236. data/vendor/kreuzberg/stopwords/da_stopwords.json +172 -172
  237. data/vendor/kreuzberg/stopwords/de_stopwords.json +622 -622
  238. data/vendor/kreuzberg/stopwords/el_stopwords.json +849 -849
  239. data/vendor/kreuzberg/stopwords/en_stopwords.json +1300 -1300
  240. data/vendor/kreuzberg/stopwords/eo_stopwords.json +175 -175
  241. data/vendor/kreuzberg/stopwords/es_stopwords.json +734 -734
  242. data/vendor/kreuzberg/stopwords/et_stopwords.json +37 -37
  243. data/vendor/kreuzberg/stopwords/eu_stopwords.json +100 -100
  244. data/vendor/kreuzberg/stopwords/fa_stopwords.json +801 -801
  245. data/vendor/kreuzberg/stopwords/fi_stopwords.json +849 -849
  246. data/vendor/kreuzberg/stopwords/fr_stopwords.json +693 -693
  247. data/vendor/kreuzberg/stopwords/ga_stopwords.json +111 -111
  248. data/vendor/kreuzberg/stopwords/gl_stopwords.json +162 -162
  249. data/vendor/kreuzberg/stopwords/gu_stopwords.json +226 -226
  250. data/vendor/kreuzberg/stopwords/ha_stopwords.json +41 -41
  251. data/vendor/kreuzberg/stopwords/he_stopwords.json +196 -196
  252. data/vendor/kreuzberg/stopwords/hi_stopwords.json +227 -227
  253. data/vendor/kreuzberg/stopwords/hr_stopwords.json +181 -181
  254. data/vendor/kreuzberg/stopwords/hu_stopwords.json +791 -791
  255. data/vendor/kreuzberg/stopwords/hy_stopwords.json +47 -47
  256. data/vendor/kreuzberg/stopwords/id_stopwords.json +760 -760
  257. data/vendor/kreuzberg/stopwords/it_stopwords.json +634 -634
  258. data/vendor/kreuzberg/stopwords/ja_stopwords.json +136 -136
  259. data/vendor/kreuzberg/stopwords/kn_stopwords.json +84 -84
  260. data/vendor/kreuzberg/stopwords/ko_stopwords.json +681 -681
  261. data/vendor/kreuzberg/stopwords/ku_stopwords.json +64 -64
  262. data/vendor/kreuzberg/stopwords/la_stopwords.json +51 -51
  263. data/vendor/kreuzberg/stopwords/lt_stopwords.json +476 -476
  264. data/vendor/kreuzberg/stopwords/lv_stopwords.json +163 -163
  265. data/vendor/kreuzberg/stopwords/ml_stopwords.json +1 -1
  266. data/vendor/kreuzberg/stopwords/mr_stopwords.json +101 -101
  267. data/vendor/kreuzberg/stopwords/ms_stopwords.json +477 -477
  268. data/vendor/kreuzberg/stopwords/ne_stopwords.json +490 -490
  269. data/vendor/kreuzberg/stopwords/nl_stopwords.json +415 -415
  270. data/vendor/kreuzberg/stopwords/no_stopwords.json +223 -223
  271. data/vendor/kreuzberg/stopwords/pl_stopwords.json +331 -331
  272. data/vendor/kreuzberg/stopwords/pt_stopwords.json +562 -562
  273. data/vendor/kreuzberg/stopwords/ro_stopwords.json +436 -436
  274. data/vendor/kreuzberg/stopwords/ru_stopwords.json +561 -561
  275. data/vendor/kreuzberg/stopwords/si_stopwords.json +193 -193
  276. data/vendor/kreuzberg/stopwords/sk_stopwords.json +420 -420
  277. data/vendor/kreuzberg/stopwords/sl_stopwords.json +448 -448
  278. data/vendor/kreuzberg/stopwords/so_stopwords.json +32 -32
  279. data/vendor/kreuzberg/stopwords/st_stopwords.json +33 -33
  280. data/vendor/kreuzberg/stopwords/sv_stopwords.json +420 -420
  281. data/vendor/kreuzberg/stopwords/sw_stopwords.json +76 -76
  282. data/vendor/kreuzberg/stopwords/ta_stopwords.json +129 -129
  283. data/vendor/kreuzberg/stopwords/te_stopwords.json +54 -54
  284. data/vendor/kreuzberg/stopwords/th_stopwords.json +118 -118
  285. data/vendor/kreuzberg/stopwords/tl_stopwords.json +149 -149
  286. data/vendor/kreuzberg/stopwords/tr_stopwords.json +506 -506
  287. data/vendor/kreuzberg/stopwords/uk_stopwords.json +75 -75
  288. data/vendor/kreuzberg/stopwords/ur_stopwords.json +519 -519
  289. data/vendor/kreuzberg/stopwords/vi_stopwords.json +647 -647
  290. data/vendor/kreuzberg/stopwords/yo_stopwords.json +62 -62
  291. data/vendor/kreuzberg/stopwords/zh_stopwords.json +796 -796
  292. data/vendor/kreuzberg/stopwords/zu_stopwords.json +31 -31
  293. data/vendor/kreuzberg/tests/api_embed.rs +360 -0
  294. data/vendor/kreuzberg/tests/api_extract_multipart.rs +52 -52
  295. data/vendor/kreuzberg/tests/api_large_pdf_extraction.rs +471 -0
  296. data/vendor/kreuzberg/tests/api_large_pdf_extraction_diagnostics.rs +289 -0
  297. data/vendor/kreuzberg/tests/api_tests.rs +1472 -966
  298. data/vendor/kreuzberg/tests/archive_integration.rs +545 -543
  299. data/vendor/kreuzberg/tests/batch_orchestration.rs +587 -556
  300. data/vendor/kreuzberg/tests/batch_pooling_benchmark.rs +154 -0
  301. data/vendor/kreuzberg/tests/batch_processing.rs +328 -316
  302. data/vendor/kreuzberg/tests/bibtex_parity_test.rs +421 -421
  303. data/vendor/kreuzberg/tests/concurrency_stress.rs +541 -525
  304. data/vendor/kreuzberg/tests/config_features.rs +612 -598
  305. data/vendor/kreuzberg/tests/config_integration_test.rs +753 -0
  306. data/vendor/kreuzberg/tests/config_loading_tests.rs +416 -415
  307. data/vendor/kreuzberg/tests/core_integration.rs +519 -510
  308. data/vendor/kreuzberg/tests/csv_integration.rs +414 -414
  309. data/vendor/kreuzberg/tests/data/hierarchy_ground_truth.json +294 -0
  310. data/vendor/kreuzberg/tests/docbook_extractor_tests.rs +500 -498
  311. data/vendor/kreuzberg/tests/docx_metadata_extraction_test.rs +122 -122
  312. data/vendor/kreuzberg/tests/docx_vs_pandoc_comparison.rs +370 -370
  313. data/vendor/kreuzberg/tests/email_integration.rs +327 -325
  314. data/vendor/kreuzberg/tests/epub_native_extractor_tests.rs +275 -275
  315. data/vendor/kreuzberg/tests/error_handling.rs +402 -393
  316. data/vendor/kreuzberg/tests/fictionbook_extractor_tests.rs +228 -228
  317. data/vendor/kreuzberg/tests/format_integration.rs +165 -159
  318. data/vendor/kreuzberg/tests/helpers/mod.rs +202 -142
  319. data/vendor/kreuzberg/tests/html_table_test.rs +551 -551
  320. data/vendor/kreuzberg/tests/image_integration.rs +255 -253
  321. data/vendor/kreuzberg/tests/instrumentation_test.rs +139 -139
  322. data/vendor/kreuzberg/tests/jats_extractor_tests.rs +639 -639
  323. data/vendor/kreuzberg/tests/jupyter_extractor_tests.rs +704 -704
  324. data/vendor/kreuzberg/tests/keywords_integration.rs +479 -479
  325. data/vendor/kreuzberg/tests/keywords_quality.rs +509 -509
  326. data/vendor/kreuzberg/tests/latex_extractor_tests.rs +496 -496
  327. data/vendor/kreuzberg/tests/markdown_extractor_tests.rs +490 -490
  328. data/vendor/kreuzberg/tests/mime_detection.rs +429 -428
  329. data/vendor/kreuzberg/tests/ocr_configuration.rs +514 -510
  330. data/vendor/kreuzberg/tests/ocr_errors.rs +698 -676
  331. data/vendor/kreuzberg/tests/ocr_language_registry.rs +191 -0
  332. data/vendor/kreuzberg/tests/ocr_quality.rs +629 -627
  333. data/vendor/kreuzberg/tests/ocr_stress.rs +469 -469
  334. data/vendor/kreuzberg/tests/odt_extractor_tests.rs +674 -695
  335. data/vendor/kreuzberg/tests/opml_extractor_tests.rs +616 -616
  336. data/vendor/kreuzberg/tests/orgmode_extractor_tests.rs +822 -822
  337. data/vendor/kreuzberg/tests/page_markers.rs +297 -0
  338. data/vendor/kreuzberg/tests/pdf_hierarchy_detection.rs +301 -0
  339. data/vendor/kreuzberg/tests/pdf_hierarchy_quality.rs +589 -0
  340. data/vendor/kreuzberg/tests/pdf_integration.rs +45 -43
  341. data/vendor/kreuzberg/tests/pdf_ocr_triggering.rs +301 -0
  342. data/vendor/kreuzberg/tests/pdf_text_merging.rs +475 -0
  343. data/vendor/kreuzberg/tests/pdfium_linking.rs +340 -0
  344. data/vendor/kreuzberg/tests/pipeline_integration.rs +1446 -1411
  345. data/vendor/kreuzberg/tests/plugin_ocr_backend_test.rs +776 -771
  346. data/vendor/kreuzberg/tests/plugin_postprocessor_test.rs +577 -560
  347. data/vendor/kreuzberg/tests/plugin_system.rs +927 -921
  348. data/vendor/kreuzberg/tests/plugin_validator_test.rs +783 -783
  349. data/vendor/kreuzberg/tests/registry_integration_tests.rs +587 -586
  350. data/vendor/kreuzberg/tests/rst_extractor_tests.rs +694 -692
  351. data/vendor/kreuzberg/tests/rtf_extractor_tests.rs +775 -776
  352. data/vendor/kreuzberg/tests/security_validation.rs +416 -415
  353. data/vendor/kreuzberg/tests/stopwords_integration_test.rs +888 -888
  354. data/vendor/kreuzberg/tests/test_fastembed.rs +631 -609
  355. data/vendor/kreuzberg/tests/typst_behavioral_tests.rs +1260 -1259
  356. data/vendor/kreuzberg/tests/typst_extractor_tests.rs +648 -647
  357. data/vendor/kreuzberg/tests/xlsx_metadata_extraction_test.rs +87 -87
  358. data/vendor/kreuzberg-ffi/Cargo.toml +67 -0
  359. data/vendor/kreuzberg-ffi/README.md +851 -0
  360. data/vendor/kreuzberg-ffi/benches/result_view_benchmark.rs +227 -0
  361. data/vendor/kreuzberg-ffi/build.rs +168 -0
  362. data/vendor/kreuzberg-ffi/cbindgen.toml +37 -0
  363. data/vendor/kreuzberg-ffi/kreuzberg-ffi.pc.in +12 -0
  364. data/vendor/kreuzberg-ffi/kreuzberg.h +3012 -0
  365. data/vendor/kreuzberg-ffi/src/batch_streaming.rs +588 -0
  366. data/vendor/kreuzberg-ffi/src/config.rs +1341 -0
  367. data/vendor/kreuzberg-ffi/src/error.rs +901 -0
  368. data/vendor/kreuzberg-ffi/src/extraction.rs +555 -0
  369. data/vendor/kreuzberg-ffi/src/helpers.rs +879 -0
  370. data/vendor/kreuzberg-ffi/src/lib.rs +977 -0
  371. data/vendor/kreuzberg-ffi/src/memory.rs +493 -0
  372. data/vendor/kreuzberg-ffi/src/mime.rs +329 -0
  373. data/vendor/kreuzberg-ffi/src/panic_shield.rs +265 -0
  374. data/vendor/kreuzberg-ffi/src/plugins/document_extractor.rs +442 -0
  375. data/vendor/kreuzberg-ffi/src/plugins/mod.rs +14 -0
  376. data/vendor/kreuzberg-ffi/src/plugins/ocr_backend.rs +628 -0
  377. data/vendor/kreuzberg-ffi/src/plugins/post_processor.rs +438 -0
  378. data/vendor/kreuzberg-ffi/src/plugins/validator.rs +329 -0
  379. data/vendor/kreuzberg-ffi/src/result.rs +510 -0
  380. data/vendor/kreuzberg-ffi/src/result_pool.rs +639 -0
  381. data/vendor/kreuzberg-ffi/src/result_view.rs +773 -0
  382. data/vendor/kreuzberg-ffi/src/string_intern.rs +568 -0
  383. data/vendor/kreuzberg-ffi/src/types.rs +363 -0
  384. data/vendor/kreuzberg-ffi/src/util.rs +210 -0
  385. data/vendor/kreuzberg-ffi/src/validation.rs +848 -0
  386. data/vendor/kreuzberg-ffi/tests.disabled/README.md +48 -0
  387. data/vendor/kreuzberg-ffi/tests.disabled/config_loading_tests.rs +299 -0
  388. data/vendor/kreuzberg-ffi/tests.disabled/config_tests.rs +346 -0
  389. data/vendor/kreuzberg-ffi/tests.disabled/extractor_tests.rs +232 -0
  390. data/vendor/kreuzberg-ffi/tests.disabled/plugin_registration_tests.rs +470 -0
  391. data/vendor/kreuzberg-tesseract/.commitlintrc.json +13 -0
  392. data/vendor/kreuzberg-tesseract/.crate-ignore +2 -0
  393. data/vendor/kreuzberg-tesseract/Cargo.lock +2933 -0
  394. data/vendor/kreuzberg-tesseract/Cargo.toml +57 -0
  395. data/vendor/{rb-sys/LICENSE-MIT → kreuzberg-tesseract/LICENSE} +22 -21
  396. data/vendor/kreuzberg-tesseract/README.md +399 -0
  397. data/vendor/kreuzberg-tesseract/build.rs +1127 -0
  398. data/vendor/kreuzberg-tesseract/patches/README.md +71 -0
  399. data/vendor/kreuzberg-tesseract/patches/tesseract.diff +199 -0
  400. data/vendor/kreuzberg-tesseract/src/api.rs +1371 -0
  401. data/vendor/kreuzberg-tesseract/src/choice_iterator.rs +77 -0
  402. data/vendor/kreuzberg-tesseract/src/enums.rs +297 -0
  403. data/vendor/kreuzberg-tesseract/src/error.rs +81 -0
  404. data/vendor/kreuzberg-tesseract/src/lib.rs +145 -0
  405. data/vendor/kreuzberg-tesseract/src/monitor.rs +57 -0
  406. data/vendor/kreuzberg-tesseract/src/mutable_iterator.rs +197 -0
  407. data/vendor/kreuzberg-tesseract/src/page_iterator.rs +253 -0
  408. data/vendor/kreuzberg-tesseract/src/result_iterator.rs +286 -0
  409. data/vendor/kreuzberg-tesseract/src/result_renderer.rs +183 -0
  410. data/vendor/kreuzberg-tesseract/tests/integration_test.rs +211 -0
  411. metadata +196 -45
  412. data/vendor/kreuzberg/benches/otel_overhead.rs +0 -48
  413. data/vendor/kreuzberg/src/extractors/fictionbook.rs.backup2 +0 -738
  414. data/vendor/rb-sys/.cargo-ok +0 -1
  415. data/vendor/rb-sys/.cargo_vcs_info.json +0 -6
  416. data/vendor/rb-sys/Cargo.lock +0 -393
  417. data/vendor/rb-sys/Cargo.toml +0 -70
  418. data/vendor/rb-sys/Cargo.toml.orig +0 -57
  419. data/vendor/rb-sys/LICENSE-APACHE +0 -190
  420. data/vendor/rb-sys/bin/release.sh +0 -21
  421. data/vendor/rb-sys/build/features.rs +0 -108
  422. data/vendor/rb-sys/build/main.rs +0 -246
  423. data/vendor/rb-sys/build/stable_api_config.rs +0 -153
  424. data/vendor/rb-sys/build/version.rs +0 -48
  425. data/vendor/rb-sys/readme.md +0 -36
  426. data/vendor/rb-sys/src/bindings.rs +0 -21
  427. data/vendor/rb-sys/src/hidden.rs +0 -11
  428. data/vendor/rb-sys/src/lib.rs +0 -34
  429. data/vendor/rb-sys/src/macros.rs +0 -371
  430. data/vendor/rb-sys/src/memory.rs +0 -53
  431. data/vendor/rb-sys/src/ruby_abi_version.rs +0 -38
  432. data/vendor/rb-sys/src/special_consts.rs +0 -31
  433. data/vendor/rb-sys/src/stable_api/compiled.c +0 -179
  434. data/vendor/rb-sys/src/stable_api/compiled.rs +0 -257
  435. data/vendor/rb-sys/src/stable_api/ruby_2_6.rs +0 -316
  436. data/vendor/rb-sys/src/stable_api/ruby_2_7.rs +0 -316
  437. data/vendor/rb-sys/src/stable_api/ruby_3_0.rs +0 -324
  438. data/vendor/rb-sys/src/stable_api/ruby_3_1.rs +0 -317
  439. data/vendor/rb-sys/src/stable_api/ruby_3_2.rs +0 -315
  440. data/vendor/rb-sys/src/stable_api/ruby_3_3.rs +0 -326
  441. data/vendor/rb-sys/src/stable_api/ruby_3_4.rs +0 -327
  442. data/vendor/rb-sys/src/stable_api.rs +0 -261
  443. data/vendor/rb-sys/src/symbol.rs +0 -31
  444. data/vendor/rb-sys/src/tracking_allocator.rs +0 -332
  445. data/vendor/rb-sys/src/utils.rs +0 -89
  446. data/vendor/rb-sys/src/value_type.rs +0 -7
@@ -1,620 +1,637 @@
1
- //! OCR backend plugin trait.
2
- //!
3
- //! This module defines the trait for implementing custom OCR backends.
4
-
5
- use crate::Result;
6
- use crate::core::config::OcrConfig;
7
- use crate::plugins::Plugin;
8
- use crate::types::ExtractionResult;
9
- use async_trait::async_trait;
10
- use std::path::Path;
11
- use std::sync::Arc;
12
-
13
- /// OCR backend types.
14
- #[derive(Debug, Clone, Copy, PartialEq, Eq)]
15
- pub enum OcrBackendType {
16
- /// Tesseract OCR (native Rust binding)
17
- Tesseract,
18
- /// EasyOCR (Python-based, via FFI)
19
- EasyOCR,
20
- /// PaddleOCR (Python-based, via FFI)
21
- PaddleOCR,
22
- /// Custom/third-party OCR backend
23
- Custom,
24
- }
25
-
26
- /// Trait for OCR backend plugins.
27
- ///
28
- /// Implement this trait to add custom OCR capabilities. OCR backends can be:
29
- /// - Native Rust implementations (like Tesseract)
30
- /// - FFI bridges to Python libraries (like EasyOCR, PaddleOCR)
31
- /// - Cloud-based OCR services (Google Vision, AWS Textract, etc.)
32
- ///
33
- /// # Thread Safety
34
- ///
35
- /// OCR backends must be thread-safe (`Send + Sync`) to support concurrent processing.
36
- ///
37
- /// # Example
38
- ///
39
- /// ```rust
40
- /// use kreuzberg::plugins::{Plugin, OcrBackend, OcrBackendType};
41
- /// use kreuzberg::{Result, OcrConfig};
42
- /// use async_trait::async_trait;
43
- /// use std::path::Path;
44
- /// use kreuzberg::types::{ExtractionResult, Metadata};
45
- ///
46
- /// struct CustomOcrBackend;
47
- ///
48
- /// impl Plugin for CustomOcrBackend {
49
- /// fn name(&self) -> &str { "custom-ocr" }
50
- /// fn version(&self) -> String { "1.0.0".to_string() }
51
- /// fn initialize(&self) -> Result<()> { Ok(()) }
52
- /// fn shutdown(&self) -> Result<()> { Ok(()) }
53
- /// }
54
- ///
55
- /// #[async_trait]
56
- /// impl OcrBackend for CustomOcrBackend {
57
- /// async fn process_image(&self, image_bytes: &[u8], config: &OcrConfig) -> Result<ExtractionResult> {
58
- /// // Implement OCR logic here
59
- /// Ok(ExtractionResult {
60
- /// content: "Extracted text".to_string(),
61
- /// mime_type: "text/plain".to_string(),
62
- /// metadata: Metadata::default(),
63
- /// tables: vec![],
64
- /// detected_languages: None,
65
- /// chunks: None,
66
- /// images: None,
67
- /// })
68
- /// }
69
- ///
70
- /// async fn process_file(&self, path: &Path, config: &OcrConfig) -> Result<ExtractionResult> {
71
- /// let bytes = std::fs::read(path)?;
72
- /// self.process_image(&bytes, config).await
73
- /// }
74
- ///
75
- /// fn supports_language(&self, lang: &str) -> bool {
76
- /// matches!(lang, "eng" | "deu" | "fra")
77
- /// }
78
- ///
79
- /// fn backend_type(&self) -> OcrBackendType {
80
- /// OcrBackendType::Custom
81
- /// }
82
- /// }
83
- /// ```
84
- #[cfg_attr(not(target_arch = "wasm32"), async_trait)]
85
- #[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
86
- pub trait OcrBackend: Plugin {
87
- /// Process an image and extract text via OCR.
88
- ///
89
- /// # Arguments
90
- ///
91
- /// * `image_bytes` - Raw image data (JPEG, PNG, TIFF, etc.)
92
- /// * `config` - OCR configuration (language, PSM mode, etc.)
93
- ///
94
- /// # Returns
95
- ///
96
- /// An `ExtractionResult` containing the extracted text and metadata.
97
- ///
98
- /// # Errors
99
- ///
100
- /// - `KreuzbergError::Ocr` - OCR processing failed
101
- /// - `KreuzbergError::Validation` - Invalid image format or configuration
102
- /// - `KreuzbergError::Io` - I/O errors (these always bubble up)
103
- ///
104
- /// # Example
105
- ///
106
- /// ```rust
107
- /// # use kreuzberg::plugins::{Plugin, OcrBackend};
108
- /// # use kreuzberg::{Result, OcrConfig};
109
- /// # use async_trait::async_trait;
110
- /// # use std::path::Path;
111
- /// # use kreuzberg::types::{ExtractionResult, Metadata};
112
- /// # struct MyOcr;
113
- /// # impl Plugin for MyOcr {
114
- /// # fn name(&self) -> &str { "my-ocr" }
115
- /// # fn version(&self) -> String { "1.0.0".to_string() }
116
- /// # fn initialize(&self) -> Result<()> { Ok(()) }
117
- /// # fn shutdown(&self) -> Result<()> { Ok(()) }
118
- /// # }
119
- /// # use kreuzberg::plugins::OcrBackendType;
120
- /// # #[async_trait]
121
- /// # impl OcrBackend for MyOcr {
122
- /// # fn supports_language(&self, _: &str) -> bool { true }
123
- /// # fn backend_type(&self) -> OcrBackendType { OcrBackendType::Custom }
124
- /// # async fn process_file(&self, _: &Path, _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
125
- /// async fn process_image(&self, image_bytes: &[u8], config: &OcrConfig) -> Result<ExtractionResult> {
126
- /// // Validate image format
127
- /// if image_bytes.is_empty() {
128
- /// return Err(kreuzberg::KreuzbergError::Validation {
129
- /// message: "Empty image data".to_string(),
130
- /// source: None,
131
- /// });
132
- /// }
133
- ///
134
- /// // Perform OCR processing
135
- /// let text = format!("Extracted text in language: {}", config.language);
136
- ///
137
- /// Ok(ExtractionResult {
138
- /// content: text,
139
- /// mime_type: "text/plain".to_string(),
140
- /// metadata: Metadata::default(),
141
- /// tables: vec![],
142
- /// detected_languages: None,
143
- /// chunks: None,
144
- /// images: None,
145
- /// })
146
- /// }
147
- /// # }
148
- /// ```
149
- async fn process_image(&self, image_bytes: &[u8], config: &OcrConfig) -> Result<ExtractionResult>;
150
-
151
- /// Process a file and extract text via OCR.
152
- ///
153
- /// Default implementation reads the file and calls `process_image`.
154
- /// Override for custom file handling or optimizations.
155
- ///
156
- /// # Arguments
157
- ///
158
- /// * `path` - Path to the image file
159
- /// * `config` - OCR configuration
160
- ///
161
- /// # Errors
162
- ///
163
- /// Same as `process_image`, plus file I/O errors.
164
- async fn process_file(&self, path: &Path, config: &OcrConfig) -> Result<ExtractionResult> {
165
- use crate::core::io;
166
- let bytes = io::read_file_async(path).await?;
167
- self.process_image(&bytes, config).await
168
- }
169
-
170
- /// Check if this backend supports a given language code.
171
- ///
172
- /// # Arguments
173
- ///
174
- /// * `lang` - ISO 639-2/3 language code (e.g., "eng", "deu", "fra")
175
- ///
176
- /// # Returns
177
- ///
178
- /// `true` if the language is supported, `false` otherwise.
179
- ///
180
- /// # Example
181
- ///
182
- /// ```rust
183
- /// # use kreuzberg::plugins::{Plugin, OcrBackend};
184
- /// # use kreuzberg::Result;
185
- /// # use async_trait::async_trait;
186
- /// # use std::path::Path;
187
- /// # struct MyOcr { languages: Vec<String> }
188
- /// # impl Plugin for MyOcr {
189
- /// # fn name(&self) -> &str { "my-ocr" }
190
- /// # fn version(&self) -> String { "1.0.0".to_string() }
191
- /// # fn initialize(&self) -> Result<()> { Ok(()) }
192
- /// # fn shutdown(&self) -> Result<()> { Ok(()) }
193
- /// # }
194
- /// # use kreuzberg::plugins::OcrBackendType;
195
- /// # use kreuzberg::{ExtractionResult, OcrConfig};
196
- /// # #[async_trait]
197
- /// # impl OcrBackend for MyOcr {
198
- /// # fn backend_type(&self) -> OcrBackendType { OcrBackendType::Custom }
199
- /// # async fn process_image(&self, _: &[u8], _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
200
- /// # async fn process_file(&self, _: &Path, _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
201
- /// fn supports_language(&self, lang: &str) -> bool {
202
- /// self.languages.contains(&lang.to_string())
203
- /// }
204
- /// # }
205
- /// ```
206
- fn supports_language(&self, lang: &str) -> bool;
207
-
208
- /// Get the backend type identifier.
209
- ///
210
- /// # Returns
211
- ///
212
- /// The backend type enum value.
213
- ///
214
- /// # Example
215
- ///
216
- /// ```rust
217
- /// # use kreuzberg::plugins::{Plugin, OcrBackend, OcrBackendType};
218
- /// # use kreuzberg::Result;
219
- /// # use async_trait::async_trait;
220
- /// # use std::path::Path;
221
- /// # struct TesseractBackend;
222
- /// # impl Plugin for TesseractBackend {
223
- /// # fn name(&self) -> &str { "tesseract" }
224
- /// # fn version(&self) -> String { "1.0.0".to_string() }
225
- /// # fn initialize(&self) -> Result<()> { Ok(()) }
226
- /// # fn shutdown(&self) -> Result<()> { Ok(()) }
227
- /// # }
228
- /// # use kreuzberg::{ExtractionResult, OcrConfig};
229
- /// # #[async_trait]
230
- /// # impl OcrBackend for TesseractBackend {
231
- /// # fn supports_language(&self, _: &str) -> bool { true }
232
- /// # async fn process_image(&self, _: &[u8], _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
233
- /// # async fn process_file(&self, _: &Path, _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
234
- /// fn backend_type(&self) -> OcrBackendType {
235
- /// OcrBackendType::Tesseract
236
- /// }
237
- /// # }
238
- /// ```
239
- fn backend_type(&self) -> OcrBackendType;
240
-
241
- /// Optional: Get a list of all supported languages.
242
- ///
243
- /// Defaults to empty list. Override to provide comprehensive language support info.
244
- fn supported_languages(&self) -> Vec<String> {
245
- vec![]
246
- }
247
-
248
- /// Optional: Check if the backend supports table detection.
249
- ///
250
- /// Defaults to `false`. Override if your backend can detect and extract tables.
251
- fn supports_table_detection(&self) -> bool {
252
- false
253
- }
254
- }
255
-
256
- /// Register an OCR backend with the global registry.
257
- ///
258
- /// The OCR backend will be registered with its name from the `name()` method
259
- /// and can be used for OCR processing via the extraction pipeline.
260
- ///
261
- /// # Arguments
262
- ///
263
- /// * `backend` - The OCR backend implementation wrapped in Arc
264
- ///
265
- /// # Returns
266
- ///
267
- /// - `Ok(())` if registration succeeded
268
- /// - `Err(...)` if validation failed or initialization failed
269
- ///
270
- /// # Errors
271
- ///
272
- /// - `KreuzbergError::Validation` - Invalid backend name (empty or contains whitespace)
273
- /// - Any error from the backend's `initialize()` method
274
- ///
275
- /// # Example
276
- ///
277
- /// ```rust
278
- /// use kreuzberg::plugins::{Plugin, OcrBackend, register_ocr_backend, OcrBackendType};
279
- /// use kreuzberg::{Result, OcrConfig};
280
- /// use kreuzberg::types::{ExtractionResult, Metadata};
281
- /// use async_trait::async_trait;
282
- /// use std::sync::Arc;
283
- /// use std::path::Path;
284
- ///
285
- /// struct CustomOcr;
286
- ///
287
- /// impl Plugin for CustomOcr {
288
- /// fn name(&self) -> &str { "custom-ocr" }
289
- /// fn version(&self) -> String { "1.0.0".to_string() }
290
- /// fn initialize(&self) -> Result<()> { Ok(()) }
291
- /// fn shutdown(&self) -> Result<()> { Ok(()) }
292
- /// }
293
- ///
294
- /// #[async_trait]
295
- /// impl OcrBackend for CustomOcr {
296
- /// async fn process_image(&self, _: &[u8], _: &OcrConfig) -> Result<ExtractionResult> {
297
- /// Ok(ExtractionResult {
298
- /// content: "text".to_string(),
299
- /// mime_type: "text/plain".to_string(),
300
- /// metadata: Metadata::default(),
301
- /// tables: vec![],
302
- /// detected_languages: None,
303
- /// chunks: None,
304
- /// images: None,
305
- /// })
306
- /// }
307
- /// fn supports_language(&self, _: &str) -> bool { true }
308
- /// fn backend_type(&self) -> OcrBackendType { OcrBackendType::Custom }
309
- /// }
310
- ///
311
- /// # tokio_test::block_on(async {
312
- /// let backend = Arc::new(CustomOcr);
313
- /// register_ocr_backend(backend)?;
314
- /// # Ok::<(), kreuzberg::KreuzbergError>(())
315
- /// # });
316
- /// ```
317
- pub fn register_ocr_backend(backend: Arc<dyn OcrBackend>) -> crate::Result<()> {
318
- use crate::plugins::registry::get_ocr_backend_registry;
319
-
320
- let registry = get_ocr_backend_registry();
321
- // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
322
- let mut registry = registry
323
- .write()
324
- .expect("OCR backend registry lock poisoned - critical runtime error");
325
-
326
- registry.register(backend)
327
- }
328
-
329
- /// Unregister an OCR backend by name.
330
- ///
331
- /// Removes the OCR backend from the global registry and calls its `shutdown()` method.
332
- ///
333
- /// # Arguments
334
- ///
335
- /// * `name` - Name of the OCR backend to unregister
336
- ///
337
- /// # Returns
338
- ///
339
- /// - `Ok(())` if the backend was unregistered or didn't exist
340
- /// - `Err(...)` if the shutdown method failed
341
- ///
342
- /// # Example
343
- ///
344
- /// ```rust
345
- /// use kreuzberg::plugins::unregister_ocr_backend;
346
- ///
347
- /// # tokio_test::block_on(async {
348
- /// unregister_ocr_backend("custom-ocr")?;
349
- /// # Ok::<(), kreuzberg::KreuzbergError>(())
350
- /// # });
351
- /// ```
352
- pub fn unregister_ocr_backend(name: &str) -> crate::Result<()> {
353
- use crate::plugins::registry::get_ocr_backend_registry;
354
-
355
- let registry = get_ocr_backend_registry();
356
- // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
357
- let mut registry = registry
358
- .write()
359
- .expect("OCR backend registry lock poisoned - critical runtime error");
360
-
361
- registry.remove(name)
362
- }
363
-
364
- /// List all registered OCR backends.
365
- ///
366
- /// Returns the names of all OCR backends currently registered in the global registry.
367
- ///
368
- /// # Returns
369
- ///
370
- /// A vector of OCR backend names.
371
- ///
372
- /// # Example
373
- ///
374
- /// ```rust
375
- /// use kreuzberg::plugins::list_ocr_backends;
376
- ///
377
- /// # tokio_test::block_on(async {
378
- /// let backends = list_ocr_backends()?;
379
- /// for name in backends {
380
- /// println!("Registered OCR backend: {}", name);
381
- /// }
382
- /// # Ok::<(), kreuzberg::KreuzbergError>(())
383
- /// # });
384
- /// ```
385
- pub fn list_ocr_backends() -> crate::Result<Vec<String>> {
386
- use crate::plugins::registry::get_ocr_backend_registry;
387
-
388
- let registry = get_ocr_backend_registry();
389
- // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
390
- let registry = registry
391
- .read()
392
- .expect("OCR backend registry lock poisoned - critical runtime error");
393
-
394
- Ok(registry.list())
395
- }
396
-
397
- /// Clear all OCR backends from the global registry.
398
- ///
399
- /// Removes all OCR backends and calls their `shutdown()` methods.
400
- ///
401
- /// # Returns
402
- ///
403
- /// - `Ok(())` if all backends were cleared successfully
404
- /// - `Err(...)` if any shutdown method failed
405
- ///
406
- /// # Example
407
- ///
408
- /// ```rust
409
- /// use kreuzberg::plugins::clear_ocr_backends;
410
- ///
411
- /// # tokio_test::block_on(async {
412
- /// clear_ocr_backends()?;
413
- /// # Ok::<(), kreuzberg::KreuzbergError>(())
414
- /// # });
415
- /// ```
416
- pub fn clear_ocr_backends() -> crate::Result<()> {
417
- use crate::plugins::registry::get_ocr_backend_registry;
418
-
419
- let registry = get_ocr_backend_registry();
420
- // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
421
- let mut registry = registry
422
- .write()
423
- .expect("OCR backend registry lock poisoned - critical runtime error");
424
-
425
- registry.shutdown_all()
426
- }
427
-
428
- #[cfg(test)]
429
- mod tests {
430
- use super::*;
431
-
432
- struct MockOcrBackend {
433
- languages: Vec<String>,
434
- }
435
-
436
- impl Plugin for MockOcrBackend {
437
- fn name(&self) -> &str {
438
- "mock-ocr"
439
- }
440
-
441
- fn version(&self) -> String {
442
- "1.0.0".to_string()
443
- }
444
-
445
- fn initialize(&self) -> Result<()> {
446
- Ok(())
447
- }
448
-
449
- fn shutdown(&self) -> Result<()> {
450
- Ok(())
451
- }
452
- }
453
-
454
- #[async_trait]
455
- impl OcrBackend for MockOcrBackend {
456
- async fn process_image(&self, _image_bytes: &[u8], _config: &OcrConfig) -> Result<ExtractionResult> {
457
- Ok(ExtractionResult {
458
- content: "Mocked OCR text".to_string(),
459
- mime_type: "text/plain".to_string(),
460
- metadata: crate::types::Metadata::default(),
461
- tables: vec![],
462
- detected_languages: None,
463
- chunks: None,
464
- images: None,
465
- })
466
- }
467
-
468
- fn supports_language(&self, lang: &str) -> bool {
469
- self.languages.iter().any(|l| l == lang)
470
- }
471
-
472
- fn backend_type(&self) -> OcrBackendType {
473
- OcrBackendType::Custom
474
- }
475
-
476
- fn supported_languages(&self) -> Vec<String> {
477
- self.languages.clone()
478
- }
479
- }
480
-
481
- #[tokio::test]
482
- async fn test_ocr_backend_process_image() {
483
- let backend = MockOcrBackend {
484
- languages: vec!["eng".to_string(), "deu".to_string()],
485
- };
486
-
487
- let config = OcrConfig {
488
- backend: "mock".to_string(),
489
- language: "eng".to_string(),
490
- tesseract_config: None,
491
- };
492
-
493
- let result = backend.process_image(b"fake image data", &config).await.unwrap();
494
- assert_eq!(result.content, "Mocked OCR text");
495
- assert_eq!(result.mime_type, "text/plain");
496
- }
497
-
498
- #[test]
499
- fn test_ocr_backend_supports_language() {
500
- let backend = MockOcrBackend {
501
- languages: vec!["eng".to_string(), "deu".to_string()],
502
- };
503
-
504
- assert!(backend.supports_language("eng"));
505
- assert!(backend.supports_language("deu"));
506
- assert!(!backend.supports_language("fra"));
507
- }
508
-
509
- #[test]
510
- fn test_ocr_backend_type() {
511
- let backend = MockOcrBackend {
512
- languages: vec!["eng".to_string()],
513
- };
514
-
515
- assert_eq!(backend.backend_type(), OcrBackendType::Custom);
516
- }
517
-
518
- #[test]
519
- fn test_ocr_backend_supported_languages() {
520
- let backend = MockOcrBackend {
521
- languages: vec!["eng".to_string(), "deu".to_string(), "fra".to_string()],
522
- };
523
-
524
- let supported = backend.supported_languages();
525
- assert_eq!(supported.len(), 3);
526
- assert!(supported.contains(&"eng".to_string()));
527
- assert!(supported.contains(&"deu".to_string()));
528
- assert!(supported.contains(&"fra".to_string()));
529
- }
530
-
531
- #[test]
532
- fn test_ocr_backend_type_variants() {
533
- assert_eq!(OcrBackendType::Tesseract, OcrBackendType::Tesseract);
534
- assert_ne!(OcrBackendType::Tesseract, OcrBackendType::EasyOCR);
535
- assert_ne!(OcrBackendType::EasyOCR, OcrBackendType::PaddleOCR);
536
- assert_ne!(OcrBackendType::PaddleOCR, OcrBackendType::Custom);
537
- }
538
-
539
- #[test]
540
- fn test_ocr_backend_type_debug() {
541
- let backend_type = OcrBackendType::Tesseract;
542
- let debug_str = format!("{:?}", backend_type);
543
- assert!(debug_str.contains("Tesseract"));
544
- }
545
-
546
- #[test]
547
- fn test_ocr_backend_type_clone() {
548
- let backend_type = OcrBackendType::EasyOCR;
549
- let cloned = backend_type;
550
- assert_eq!(backend_type, cloned);
551
- }
552
-
553
- #[test]
554
- fn test_ocr_backend_default_table_detection() {
555
- let backend = MockOcrBackend {
556
- languages: vec!["eng".to_string()],
557
- };
558
- assert!(!backend.supports_table_detection());
559
- }
560
-
561
- #[tokio::test]
562
- async fn test_ocr_backend_process_file_default_impl() {
563
- use std::io::Write;
564
- use tempfile::NamedTempFile;
565
-
566
- let backend = MockOcrBackend {
567
- languages: vec!["eng".to_string()],
568
- };
569
-
570
- let mut temp_file = NamedTempFile::new().unwrap();
571
- temp_file.write_all(b"fake image data").unwrap();
572
- let path = temp_file.path();
573
-
574
- let config = OcrConfig {
575
- backend: "mock".to_string(),
576
- language: "eng".to_string(),
577
- tesseract_config: None,
578
- };
579
-
580
- let result = backend.process_file(path, &config).await.unwrap();
581
- assert_eq!(result.content, "Mocked OCR text");
582
- }
583
-
584
- #[test]
585
- fn test_ocr_backend_plugin_interface() {
586
- let backend = MockOcrBackend {
587
- languages: vec!["eng".to_string()],
588
- };
589
-
590
- assert_eq!(backend.name(), "mock-ocr");
591
- assert_eq!(backend.version(), "1.0.0");
592
- assert!(backend.initialize().is_ok());
593
- assert!(backend.shutdown().is_ok());
594
- }
595
-
596
- #[test]
597
- fn test_ocr_backend_empty_languages() {
598
- let backend = MockOcrBackend { languages: vec![] };
599
-
600
- let supported = backend.supported_languages();
601
- assert_eq!(supported.len(), 0);
602
- assert!(!backend.supports_language("eng"));
603
- }
604
-
605
- #[tokio::test]
606
- async fn test_ocr_backend_with_empty_image() {
607
- let backend = MockOcrBackend {
608
- languages: vec!["eng".to_string()],
609
- };
610
-
611
- let config = OcrConfig {
612
- backend: "mock".to_string(),
613
- language: "eng".to_string(),
614
- tesseract_config: None,
615
- };
616
-
617
- let result = backend.process_image(b"", &config).await;
618
- assert!(result.is_ok());
619
- }
620
- }
1
+ //! OCR backend plugin trait.
2
+ //!
3
+ //! This module defines the trait for implementing custom OCR backends.
4
+
5
+ use crate::Result;
6
+ use crate::core::config::OcrConfig;
7
+ use crate::plugins::Plugin;
8
+ use crate::types::ExtractionResult;
9
+ use async_trait::async_trait;
10
+ use std::path::Path;
11
+ use std::sync::Arc;
12
+
13
+ #[cfg(not(feature = "tokio-runtime"))]
14
+ use crate::KreuzbergError;
15
+
16
+ /// OCR backend types.
17
+ #[derive(Debug, Clone, Copy, PartialEq, Eq)]
18
+ pub enum OcrBackendType {
19
+ /// Tesseract OCR (native Rust binding)
20
+ Tesseract,
21
+ /// EasyOCR (Python-based, via FFI)
22
+ EasyOCR,
23
+ /// PaddleOCR (Python-based, via FFI)
24
+ PaddleOCR,
25
+ /// Custom/third-party OCR backend
26
+ Custom,
27
+ }
28
+
29
+ /// Trait for OCR backend plugins.
30
+ ///
31
+ /// Implement this trait to add custom OCR capabilities. OCR backends can be:
32
+ /// - Native Rust implementations (like Tesseract)
33
+ /// - FFI bridges to Python libraries (like EasyOCR, PaddleOCR)
34
+ /// - Cloud-based OCR services (Google Vision, AWS Textract, etc.)
35
+ ///
36
+ /// # Thread Safety
37
+ ///
38
+ /// OCR backends must be thread-safe (`Send + Sync`) to support concurrent processing.
39
+ ///
40
+ /// # Example
41
+ ///
42
+ /// ```rust
43
+ /// use kreuzberg::plugins::{Plugin, OcrBackend, OcrBackendType};
44
+ /// use kreuzberg::{Result, OcrConfig};
45
+ /// use async_trait::async_trait;
46
+ /// use std::path::Path;
47
+ /// use kreuzberg::types::{ExtractionResult, Metadata};
48
+ ///
49
+ /// struct CustomOcrBackend;
50
+ ///
51
+ /// impl Plugin for CustomOcrBackend {
52
+ /// fn name(&self) -> &str { "custom-ocr" }
53
+ /// fn version(&self) -> String { "1.0.0".to_string() }
54
+ /// fn initialize(&self) -> Result<()> { Ok(()) }
55
+ /// fn shutdown(&self) -> Result<()> { Ok(()) }
56
+ /// }
57
+ ///
58
+ /// #[async_trait]
59
+ /// impl OcrBackend for CustomOcrBackend {
60
+ /// async fn process_image(&self, image_bytes: &[u8], config: &OcrConfig) -> Result<ExtractionResult> {
61
+ /// // Implement OCR logic here
62
+ /// Ok(ExtractionResult {
63
+ /// content: "Extracted text".to_string(),
64
+ /// mime_type: "text/plain".to_string(),
65
+ /// metadata: Metadata::default(),
66
+ /// tables: vec![],
67
+ /// detected_languages: None,
68
+ /// chunks: None,
69
+ /// images: None,
70
+ /// pages: None,
71
+ /// })
72
+ /// }
73
+ ///
74
+ /// async fn process_file(&self, path: &Path, config: &OcrConfig) -> Result<ExtractionResult> {
75
+ /// let bytes = std::fs::read(path)?;
76
+ /// self.process_image(&bytes, config).await
77
+ /// }
78
+ ///
79
+ /// fn supports_language(&self, lang: &str) -> bool {
80
+ /// matches!(lang, "eng" | "deu" | "fra")
81
+ /// }
82
+ ///
83
+ /// fn backend_type(&self) -> OcrBackendType {
84
+ /// OcrBackendType::Custom
85
+ /// }
86
+ /// }
87
+ /// ```
88
+ #[cfg_attr(not(target_arch = "wasm32"), async_trait)]
89
+ #[cfg_attr(target_arch = "wasm32", async_trait(?Send))]
90
+ pub trait OcrBackend: Plugin {
91
+ /// Process an image and extract text via OCR.
92
+ ///
93
+ /// # Arguments
94
+ ///
95
+ /// * `image_bytes` - Raw image data (JPEG, PNG, TIFF, etc.)
96
+ /// * `config` - OCR configuration (language, PSM mode, etc.)
97
+ ///
98
+ /// # Returns
99
+ ///
100
+ /// An `ExtractionResult` containing the extracted text and metadata.
101
+ ///
102
+ /// # Errors
103
+ ///
104
+ /// - `KreuzbergError::Ocr` - OCR processing failed
105
+ /// - `KreuzbergError::Validation` - Invalid image format or configuration
106
+ /// - `KreuzbergError::Io` - I/O errors (these always bubble up)
107
+ ///
108
+ /// # Example
109
+ ///
110
+ /// ```rust
111
+ /// # use kreuzberg::plugins::{Plugin, OcrBackend};
112
+ /// # use kreuzberg::{Result, OcrConfig};
113
+ /// # use async_trait::async_trait;
114
+ /// # use std::path::Path;
115
+ /// # use kreuzberg::types::{ExtractionResult, Metadata};
116
+ /// # struct MyOcr;
117
+ /// # impl Plugin for MyOcr {
118
+ /// # fn name(&self) -> &str { "my-ocr" }
119
+ /// # fn version(&self) -> String { "1.0.0".to_string() }
120
+ /// # fn initialize(&self) -> Result<()> { Ok(()) }
121
+ /// # fn shutdown(&self) -> Result<()> { Ok(()) }
122
+ /// # }
123
+ /// # use kreuzberg::plugins::OcrBackendType;
124
+ /// # #[async_trait]
125
+ /// # impl OcrBackend for MyOcr {
126
+ /// # fn supports_language(&self, _: &str) -> bool { true }
127
+ /// # fn backend_type(&self) -> OcrBackendType { OcrBackendType::Custom }
128
+ /// # async fn process_file(&self, _: &Path, _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
129
+ /// async fn process_image(&self, image_bytes: &[u8], config: &OcrConfig) -> Result<ExtractionResult> {
130
+ /// // Validate image format
131
+ /// if image_bytes.is_empty() {
132
+ /// return Err(kreuzberg::KreuzbergError::Validation {
133
+ /// message: "Empty image data".to_string(),
134
+ /// source: None,
135
+ /// });
136
+ /// }
137
+ ///
138
+ /// // Perform OCR processing
139
+ /// let text = format!("Extracted text in language: {}", config.language);
140
+ ///
141
+ /// Ok(ExtractionResult {
142
+ /// content: text,
143
+ /// mime_type: "text/plain".to_string(),
144
+ /// metadata: Metadata::default(),
145
+ /// tables: vec![],
146
+ /// detected_languages: None,
147
+ /// chunks: None,
148
+ /// images: None,
149
+ /// pages: None,
150
+ /// })
151
+ /// }
152
+ /// # }
153
+ /// ```
154
+ async fn process_image(&self, image_bytes: &[u8], config: &OcrConfig) -> Result<ExtractionResult>;
155
+
156
+ /// Process a file and extract text via OCR.
157
+ ///
158
+ /// Default implementation reads the file and calls `process_image`.
159
+ /// Override for custom file handling or optimizations.
160
+ ///
161
+ /// # Arguments
162
+ ///
163
+ /// * `path` - Path to the image file
164
+ /// * `config` - OCR configuration
165
+ ///
166
+ /// # Errors
167
+ ///
168
+ /// Same as `process_image`, plus file I/O errors.
169
+ async fn process_file(&self, path: &Path, config: &OcrConfig) -> Result<ExtractionResult> {
170
+ #[cfg(feature = "tokio-runtime")]
171
+ {
172
+ use crate::core::io;
173
+ let bytes = io::read_file_async(path).await?;
174
+ self.process_image(&bytes, config).await
175
+ }
176
+ #[cfg(not(feature = "tokio-runtime"))]
177
+ {
178
+ let _ = (path, config);
179
+ Err(KreuzbergError::Other(
180
+ "File-based OCR processing requires the tokio-runtime feature".to_string(),
181
+ ))
182
+ }
183
+ }
184
+
185
+ /// Check if this backend supports a given language code.
186
+ ///
187
+ /// # Arguments
188
+ ///
189
+ /// * `lang` - ISO 639-2/3 language code (e.g., "eng", "deu", "fra")
190
+ ///
191
+ /// # Returns
192
+ ///
193
+ /// `true` if the language is supported, `false` otherwise.
194
+ ///
195
+ /// # Example
196
+ ///
197
+ /// ```rust
198
+ /// # use kreuzberg::plugins::{Plugin, OcrBackend};
199
+ /// # use kreuzberg::Result;
200
+ /// # use async_trait::async_trait;
201
+ /// # use std::path::Path;
202
+ /// # struct MyOcr { languages: Vec<String> }
203
+ /// # impl Plugin for MyOcr {
204
+ /// # fn name(&self) -> &str { "my-ocr" }
205
+ /// # fn version(&self) -> String { "1.0.0".to_string() }
206
+ /// # fn initialize(&self) -> Result<()> { Ok(()) }
207
+ /// # fn shutdown(&self) -> Result<()> { Ok(()) }
208
+ /// # }
209
+ /// # use kreuzberg::plugins::OcrBackendType;
210
+ /// # use kreuzberg::{ExtractionResult, OcrConfig};
211
+ /// # #[async_trait]
212
+ /// # impl OcrBackend for MyOcr {
213
+ /// # fn backend_type(&self) -> OcrBackendType { OcrBackendType::Custom }
214
+ /// # async fn process_image(&self, _: &[u8], _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
215
+ /// # async fn process_file(&self, _: &Path, _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
216
+ /// fn supports_language(&self, lang: &str) -> bool {
217
+ /// self.languages.contains(&lang.to_string())
218
+ /// }
219
+ /// # }
220
+ /// ```
221
+ fn supports_language(&self, lang: &str) -> bool;
222
+
223
+ /// Get the backend type identifier.
224
+ ///
225
+ /// # Returns
226
+ ///
227
+ /// The backend type enum value.
228
+ ///
229
+ /// # Example
230
+ ///
231
+ /// ```rust
232
+ /// # use kreuzberg::plugins::{Plugin, OcrBackend, OcrBackendType};
233
+ /// # use kreuzberg::Result;
234
+ /// # use async_trait::async_trait;
235
+ /// # use std::path::Path;
236
+ /// # struct TesseractBackend;
237
+ /// # impl Plugin for TesseractBackend {
238
+ /// # fn name(&self) -> &str { "tesseract" }
239
+ /// # fn version(&self) -> String { "1.0.0".to_string() }
240
+ /// # fn initialize(&self) -> Result<()> { Ok(()) }
241
+ /// # fn shutdown(&self) -> Result<()> { Ok(()) }
242
+ /// # }
243
+ /// # use kreuzberg::{ExtractionResult, OcrConfig};
244
+ /// # #[async_trait]
245
+ /// # impl OcrBackend for TesseractBackend {
246
+ /// # fn supports_language(&self, _: &str) -> bool { true }
247
+ /// # async fn process_image(&self, _: &[u8], _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
248
+ /// # async fn process_file(&self, _: &Path, _: &OcrConfig) -> Result<ExtractionResult> { todo!() }
249
+ /// fn backend_type(&self) -> OcrBackendType {
250
+ /// OcrBackendType::Tesseract
251
+ /// }
252
+ /// # }
253
+ /// ```
254
+ fn backend_type(&self) -> OcrBackendType;
255
+
256
+ /// Optional: Get a list of all supported languages.
257
+ ///
258
+ /// Defaults to empty list. Override to provide comprehensive language support info.
259
+ fn supported_languages(&self) -> Vec<String> {
260
+ vec![]
261
+ }
262
+
263
+ /// Optional: Check if the backend supports table detection.
264
+ ///
265
+ /// Defaults to `false`. Override if your backend can detect and extract tables.
266
+ fn supports_table_detection(&self) -> bool {
267
+ false
268
+ }
269
+ }
270
+
271
+ /// Register an OCR backend with the global registry.
272
+ ///
273
+ /// The OCR backend will be registered with its name from the `name()` method
274
+ /// and can be used for OCR processing via the extraction pipeline.
275
+ ///
276
+ /// # Arguments
277
+ ///
278
+ /// * `backend` - The OCR backend implementation wrapped in Arc
279
+ ///
280
+ /// # Returns
281
+ ///
282
+ /// - `Ok(())` if registration succeeded
283
+ /// - `Err(...)` if validation failed or initialization failed
284
+ ///
285
+ /// # Errors
286
+ ///
287
+ /// - `KreuzbergError::Validation` - Invalid backend name (empty or contains whitespace)
288
+ /// - Any error from the backend's `initialize()` method
289
+ ///
290
+ /// # Example
291
+ ///
292
+ /// ```rust
293
+ /// use kreuzberg::plugins::{Plugin, OcrBackend, register_ocr_backend, OcrBackendType};
294
+ /// use kreuzberg::{Result, OcrConfig};
295
+ /// use kreuzberg::types::{ExtractionResult, Metadata};
296
+ /// use async_trait::async_trait;
297
+ /// use std::sync::Arc;
298
+ /// use std::path::Path;
299
+ ///
300
+ /// struct CustomOcr;
301
+ ///
302
+ /// impl Plugin for CustomOcr {
303
+ /// fn name(&self) -> &str { "custom-ocr" }
304
+ /// fn version(&self) -> String { "1.0.0".to_string() }
305
+ /// fn initialize(&self) -> Result<()> { Ok(()) }
306
+ /// fn shutdown(&self) -> Result<()> { Ok(()) }
307
+ /// }
308
+ ///
309
+ /// #[async_trait]
310
+ /// impl OcrBackend for CustomOcr {
311
+ /// async fn process_image(&self, _: &[u8], _: &OcrConfig) -> Result<ExtractionResult> {
312
+ /// Ok(ExtractionResult {
313
+ /// content: "text".to_string(),
314
+ /// mime_type: "text/plain".to_string(),
315
+ /// metadata: Metadata::default(),
316
+ /// tables: vec![],
317
+ /// detected_languages: None,
318
+ /// chunks: None,
319
+ /// images: None,
320
+ /// pages: None,
321
+ /// })
322
+ /// }
323
+ /// fn supports_language(&self, _: &str) -> bool { true }
324
+ /// fn backend_type(&self) -> OcrBackendType { OcrBackendType::Custom }
325
+ /// }
326
+ ///
327
+ /// # tokio_test::block_on(async {
328
+ /// let backend = Arc::new(CustomOcr);
329
+ /// register_ocr_backend(backend)?;
330
+ /// # Ok::<(), kreuzberg::KreuzbergError>(())
331
+ /// # });
332
+ /// ```
333
+ pub fn register_ocr_backend(backend: Arc<dyn OcrBackend>) -> crate::Result<()> {
334
+ use crate::plugins::registry::get_ocr_backend_registry;
335
+
336
+ let registry = get_ocr_backend_registry();
337
+ // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
338
+ let mut registry = registry
339
+ .write()
340
+ .expect("OCR backend registry lock poisoned - critical runtime error");
341
+
342
+ registry.register(backend)
343
+ }
344
+
345
+ /// Unregister an OCR backend by name.
346
+ ///
347
+ /// Removes the OCR backend from the global registry and calls its `shutdown()` method.
348
+ ///
349
+ /// # Arguments
350
+ ///
351
+ /// * `name` - Name of the OCR backend to unregister
352
+ ///
353
+ /// # Returns
354
+ ///
355
+ /// - `Ok(())` if the backend was unregistered or didn't exist
356
+ /// - `Err(...)` if the shutdown method failed
357
+ ///
358
+ /// # Example
359
+ ///
360
+ /// ```rust
361
+ /// use kreuzberg::plugins::unregister_ocr_backend;
362
+ ///
363
+ /// # tokio_test::block_on(async {
364
+ /// unregister_ocr_backend("custom-ocr")?;
365
+ /// # Ok::<(), kreuzberg::KreuzbergError>(())
366
+ /// # });
367
+ /// ```
368
+ pub fn unregister_ocr_backend(name: &str) -> crate::Result<()> {
369
+ use crate::plugins::registry::get_ocr_backend_registry;
370
+
371
+ let registry = get_ocr_backend_registry();
372
+ // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
373
+ let mut registry = registry
374
+ .write()
375
+ .expect("OCR backend registry lock poisoned - critical runtime error");
376
+
377
+ registry.remove(name)
378
+ }
379
+
380
+ /// List all registered OCR backends.
381
+ ///
382
+ /// Returns the names of all OCR backends currently registered in the global registry.
383
+ ///
384
+ /// # Returns
385
+ ///
386
+ /// A vector of OCR backend names.
387
+ ///
388
+ /// # Example
389
+ ///
390
+ /// ```rust
391
+ /// use kreuzberg::plugins::list_ocr_backends;
392
+ ///
393
+ /// # tokio_test::block_on(async {
394
+ /// let backends = list_ocr_backends()?;
395
+ /// for name in backends {
396
+ /// println!("Registered OCR backend: {}", name);
397
+ /// }
398
+ /// # Ok::<(), kreuzberg::KreuzbergError>(())
399
+ /// # });
400
+ /// ```
401
+ pub fn list_ocr_backends() -> crate::Result<Vec<String>> {
402
+ use crate::plugins::registry::get_ocr_backend_registry;
403
+
404
+ let registry = get_ocr_backend_registry();
405
+ // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
406
+ let registry = registry
407
+ .read()
408
+ .expect("OCR backend registry lock poisoned - critical runtime error");
409
+
410
+ Ok(registry.list())
411
+ }
412
+
413
+ /// Clear all OCR backends from the global registry.
414
+ ///
415
+ /// Removes all OCR backends and calls their `shutdown()` methods.
416
+ ///
417
+ /// # Returns
418
+ ///
419
+ /// - `Ok(())` if all backends were cleared successfully
420
+ /// - `Err(...)` if any shutdown method failed
421
+ ///
422
+ /// # Example
423
+ ///
424
+ /// ```rust
425
+ /// use kreuzberg::plugins::clear_ocr_backends;
426
+ ///
427
+ /// # tokio_test::block_on(async {
428
+ /// clear_ocr_backends()?;
429
+ /// # Ok::<(), kreuzberg::KreuzbergError>(())
430
+ /// # });
431
+ /// ```
432
+ pub fn clear_ocr_backends() -> crate::Result<()> {
433
+ use crate::plugins::registry::get_ocr_backend_registry;
434
+
435
+ let registry = get_ocr_backend_registry();
436
+ // ~keep: Lock poisoning indicates a panic in another thread holding the lock.
437
+ let mut registry = registry
438
+ .write()
439
+ .expect("OCR backend registry lock poisoned - critical runtime error");
440
+
441
+ registry.shutdown_all()
442
+ }
443
+
444
+ #[cfg(test)]
445
+ mod tests {
446
+ use super::*;
447
+
448
+ struct MockOcrBackend {
449
+ languages: Vec<String>,
450
+ }
451
+
452
+ impl Plugin for MockOcrBackend {
453
+ fn name(&self) -> &str {
454
+ "mock-ocr"
455
+ }
456
+
457
+ fn version(&self) -> String {
458
+ "1.0.0".to_string()
459
+ }
460
+
461
+ fn initialize(&self) -> Result<()> {
462
+ Ok(())
463
+ }
464
+
465
+ fn shutdown(&self) -> Result<()> {
466
+ Ok(())
467
+ }
468
+ }
469
+
470
+ #[async_trait]
471
+ impl OcrBackend for MockOcrBackend {
472
+ async fn process_image(&self, _image_bytes: &[u8], _config: &OcrConfig) -> Result<ExtractionResult> {
473
+ Ok(ExtractionResult {
474
+ content: "Mocked OCR text".to_string(),
475
+ mime_type: "text/plain".to_string(),
476
+ metadata: crate::types::Metadata::default(),
477
+ tables: vec![],
478
+ detected_languages: None,
479
+ chunks: None,
480
+ images: None,
481
+ pages: None,
482
+ })
483
+ }
484
+
485
+ fn supports_language(&self, lang: &str) -> bool {
486
+ self.languages.iter().any(|l| l == lang)
487
+ }
488
+
489
+ fn backend_type(&self) -> OcrBackendType {
490
+ OcrBackendType::Custom
491
+ }
492
+
493
+ fn supported_languages(&self) -> Vec<String> {
494
+ self.languages.clone()
495
+ }
496
+ }
497
+
498
+ #[tokio::test]
499
+ async fn test_ocr_backend_process_image() {
500
+ let backend = MockOcrBackend {
501
+ languages: vec!["eng".to_string(), "deu".to_string()],
502
+ };
503
+
504
+ let config = OcrConfig {
505
+ backend: "mock".to_string(),
506
+ language: "eng".to_string(),
507
+ tesseract_config: None,
508
+ };
509
+
510
+ let result = backend.process_image(b"fake image data", &config).await.unwrap();
511
+ assert_eq!(result.content, "Mocked OCR text");
512
+ assert_eq!(result.mime_type, "text/plain");
513
+ }
514
+
515
+ #[test]
516
+ fn test_ocr_backend_supports_language() {
517
+ let backend = MockOcrBackend {
518
+ languages: vec!["eng".to_string(), "deu".to_string()],
519
+ };
520
+
521
+ assert!(backend.supports_language("eng"));
522
+ assert!(backend.supports_language("deu"));
523
+ assert!(!backend.supports_language("fra"));
524
+ }
525
+
526
+ #[test]
527
+ fn test_ocr_backend_type() {
528
+ let backend = MockOcrBackend {
529
+ languages: vec!["eng".to_string()],
530
+ };
531
+
532
+ assert_eq!(backend.backend_type(), OcrBackendType::Custom);
533
+ }
534
+
535
+ #[test]
536
+ fn test_ocr_backend_supported_languages() {
537
+ let backend = MockOcrBackend {
538
+ languages: vec!["eng".to_string(), "deu".to_string(), "fra".to_string()],
539
+ };
540
+
541
+ let supported = backend.supported_languages();
542
+ assert_eq!(supported.len(), 3);
543
+ assert!(supported.contains(&"eng".to_string()));
544
+ assert!(supported.contains(&"deu".to_string()));
545
+ assert!(supported.contains(&"fra".to_string()));
546
+ }
547
+
548
+ #[test]
549
+ fn test_ocr_backend_type_variants() {
550
+ assert_eq!(OcrBackendType::Tesseract, OcrBackendType::Tesseract);
551
+ assert_ne!(OcrBackendType::Tesseract, OcrBackendType::EasyOCR);
552
+ assert_ne!(OcrBackendType::EasyOCR, OcrBackendType::PaddleOCR);
553
+ assert_ne!(OcrBackendType::PaddleOCR, OcrBackendType::Custom);
554
+ }
555
+
556
+ #[test]
557
+ fn test_ocr_backend_type_debug() {
558
+ let backend_type = OcrBackendType::Tesseract;
559
+ let debug_str = format!("{:?}", backend_type);
560
+ assert!(debug_str.contains("Tesseract"));
561
+ }
562
+
563
+ #[test]
564
+ fn test_ocr_backend_type_clone() {
565
+ let backend_type = OcrBackendType::EasyOCR;
566
+ let cloned = backend_type;
567
+ assert_eq!(backend_type, cloned);
568
+ }
569
+
570
+ #[test]
571
+ fn test_ocr_backend_default_table_detection() {
572
+ let backend = MockOcrBackend {
573
+ languages: vec!["eng".to_string()],
574
+ };
575
+ assert!(!backend.supports_table_detection());
576
+ }
577
+
578
+ #[tokio::test]
579
+ async fn test_ocr_backend_process_file_default_impl() {
580
+ use std::io::Write;
581
+ use tempfile::NamedTempFile;
582
+
583
+ let backend = MockOcrBackend {
584
+ languages: vec!["eng".to_string()],
585
+ };
586
+
587
+ let mut temp_file = NamedTempFile::new().unwrap();
588
+ temp_file.write_all(b"fake image data").unwrap();
589
+ let path = temp_file.path();
590
+
591
+ let config = OcrConfig {
592
+ backend: "mock".to_string(),
593
+ language: "eng".to_string(),
594
+ tesseract_config: None,
595
+ };
596
+
597
+ let result = backend.process_file(path, &config).await.unwrap();
598
+ assert_eq!(result.content, "Mocked OCR text");
599
+ }
600
+
601
+ #[test]
602
+ fn test_ocr_backend_plugin_interface() {
603
+ let backend = MockOcrBackend {
604
+ languages: vec!["eng".to_string()],
605
+ };
606
+
607
+ assert_eq!(backend.name(), "mock-ocr");
608
+ assert_eq!(backend.version(), "1.0.0");
609
+ assert!(backend.initialize().is_ok());
610
+ assert!(backend.shutdown().is_ok());
611
+ }
612
+
613
+ #[test]
614
+ fn test_ocr_backend_empty_languages() {
615
+ let backend = MockOcrBackend { languages: vec![] };
616
+
617
+ let supported = backend.supported_languages();
618
+ assert_eq!(supported.len(), 0);
619
+ assert!(!backend.supports_language("eng"));
620
+ }
621
+
622
+ #[tokio::test]
623
+ async fn test_ocr_backend_with_empty_image() {
624
+ let backend = MockOcrBackend {
625
+ languages: vec!["eng".to_string()],
626
+ };
627
+
628
+ let config = OcrConfig {
629
+ backend: "mock".to_string(),
630
+ language: "eng".to_string(),
631
+ tesseract_config: None,
632
+ };
633
+
634
+ let result = backend.process_image(b"", &config).await;
635
+ assert!(result.is_ok());
636
+ }
637
+ }