kreuzberg 4.0.0.pre.rc.13 → 4.0.0.pre.rc.15

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 (369) 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 +538 -538
  6. data/Gemfile +8 -8
  7. data/Gemfile.lock +104 -2
  8. data/README.md +454 -454
  9. data/Rakefile +33 -25
  10. data/Steepfile +47 -47
  11. data/examples/async_patterns.rb +341 -341
  12. data/ext/kreuzberg_rb/extconf.rb +45 -45
  13. data/ext/kreuzberg_rb/native/.cargo/config.toml +2 -2
  14. data/ext/kreuzberg_rb/native/Cargo.lock +6750 -6941
  15. data/ext/kreuzberg_rb/native/Cargo.toml +53 -54
  16. data/ext/kreuzberg_rb/native/README.md +425 -425
  17. data/ext/kreuzberg_rb/native/build.rs +52 -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 +3158 -3158
  23. data/extconf.rb +28 -28
  24. data/kreuzberg.gemspec +214 -214
  25. data/lib/kreuzberg/api_proxy.rb +142 -142
  26. data/lib/kreuzberg/cache_api.rb +81 -81
  27. data/lib/kreuzberg/cli.rb +55 -55
  28. data/lib/kreuzberg/cli_proxy.rb +127 -127
  29. data/lib/kreuzberg/config.rb +724 -724
  30. data/lib/kreuzberg/error_context.rb +80 -80
  31. data/lib/kreuzberg/errors.rb +118 -118
  32. data/lib/kreuzberg/extraction_api.rb +340 -340
  33. data/lib/kreuzberg/mcp_proxy.rb +186 -186
  34. data/lib/kreuzberg/ocr_backend_protocol.rb +113 -113
  35. data/lib/kreuzberg/post_processor_protocol.rb +86 -86
  36. data/lib/kreuzberg/result.rb +279 -279
  37. data/lib/kreuzberg/setup_lib_path.rb +80 -80
  38. data/lib/kreuzberg/validator_protocol.rb +89 -89
  39. data/lib/kreuzberg/version.rb +5 -5
  40. data/lib/kreuzberg.rb +109 -109
  41. data/lib/{pdfium.dll → libpdfium.so} +0 -0
  42. data/sig/kreuzberg/internal.rbs +184 -184
  43. data/sig/kreuzberg.rbs +546 -546
  44. data/spec/binding/cache_spec.rb +227 -227
  45. data/spec/binding/cli_proxy_spec.rb +85 -85
  46. data/spec/binding/cli_spec.rb +55 -55
  47. data/spec/binding/config_spec.rb +345 -345
  48. data/spec/binding/config_validation_spec.rb +283 -283
  49. data/spec/binding/error_handling_spec.rb +213 -213
  50. data/spec/binding/errors_spec.rb +66 -66
  51. data/spec/binding/plugins/ocr_backend_spec.rb +307 -307
  52. data/spec/binding/plugins/postprocessor_spec.rb +269 -269
  53. data/spec/binding/plugins/validator_spec.rb +274 -274
  54. data/spec/fixtures/config.toml +39 -39
  55. data/spec/fixtures/config.yaml +41 -41
  56. data/spec/fixtures/invalid_config.toml +4 -4
  57. data/spec/smoke/package_spec.rb +178 -178
  58. data/spec/spec_helper.rb +42 -42
  59. data/vendor/Cargo.toml +2 -2
  60. data/vendor/kreuzberg/Cargo.toml +5 -5
  61. data/vendor/kreuzberg/README.md +230 -230
  62. data/vendor/kreuzberg/benches/otel_overhead.rs +48 -48
  63. data/vendor/kreuzberg/build.rs +887 -843
  64. data/vendor/kreuzberg/src/api/error.rs +81 -81
  65. data/vendor/kreuzberg/src/api/handlers.rs +199 -199
  66. data/vendor/kreuzberg/src/api/mod.rs +87 -79
  67. data/vendor/kreuzberg/src/api/server.rs +353 -353
  68. data/vendor/kreuzberg/src/api/types.rs +170 -170
  69. data/vendor/kreuzberg/src/cache/mod.rs +1167 -1167
  70. data/vendor/kreuzberg/src/chunking/mod.rs +1877 -1877
  71. data/vendor/kreuzberg/src/chunking/processor.rs +220 -220
  72. data/vendor/kreuzberg/src/core/batch_mode.rs +95 -95
  73. data/vendor/kreuzberg/src/core/config.rs +1080 -1080
  74. data/vendor/kreuzberg/src/core/extractor.rs +1156 -1156
  75. data/vendor/kreuzberg/src/core/io.rs +329 -329
  76. data/vendor/kreuzberg/src/core/mime.rs +605 -605
  77. data/vendor/kreuzberg/src/core/mod.rs +47 -47
  78. data/vendor/kreuzberg/src/core/pipeline.rs +1184 -1184
  79. data/vendor/kreuzberg/src/embeddings.rs +500 -500
  80. data/vendor/kreuzberg/src/error.rs +431 -431
  81. data/vendor/kreuzberg/src/extraction/archive.rs +954 -954
  82. data/vendor/kreuzberg/src/extraction/docx.rs +398 -398
  83. data/vendor/kreuzberg/src/extraction/email.rs +854 -854
  84. data/vendor/kreuzberg/src/extraction/excel.rs +688 -688
  85. data/vendor/kreuzberg/src/extraction/html.rs +634 -601
  86. data/vendor/kreuzberg/src/extraction/image.rs +491 -491
  87. data/vendor/kreuzberg/src/extraction/libreoffice.rs +574 -574
  88. data/vendor/kreuzberg/src/extraction/markdown.rs +213 -213
  89. data/vendor/kreuzberg/src/extraction/mod.rs +81 -81
  90. data/vendor/kreuzberg/src/extraction/office_metadata/app_properties.rs +398 -398
  91. data/vendor/kreuzberg/src/extraction/office_metadata/core_properties.rs +247 -247
  92. data/vendor/kreuzberg/src/extraction/office_metadata/custom_properties.rs +240 -240
  93. data/vendor/kreuzberg/src/extraction/office_metadata/mod.rs +130 -130
  94. data/vendor/kreuzberg/src/extraction/office_metadata/odt_properties.rs +284 -284
  95. data/vendor/kreuzberg/src/extraction/pptx.rs +3100 -3100
  96. data/vendor/kreuzberg/src/extraction/structured.rs +490 -490
  97. data/vendor/kreuzberg/src/extraction/table.rs +328 -328
  98. data/vendor/kreuzberg/src/extraction/text.rs +269 -269
  99. data/vendor/kreuzberg/src/extraction/xml.rs +333 -333
  100. data/vendor/kreuzberg/src/extractors/archive.rs +447 -447
  101. data/vendor/kreuzberg/src/extractors/bibtex.rs +470 -470
  102. data/vendor/kreuzberg/src/extractors/docbook.rs +504 -504
  103. data/vendor/kreuzberg/src/extractors/docx.rs +400 -400
  104. data/vendor/kreuzberg/src/extractors/email.rs +157 -157
  105. data/vendor/kreuzberg/src/extractors/epub.rs +708 -708
  106. data/vendor/kreuzberg/src/extractors/excel.rs +345 -345
  107. data/vendor/kreuzberg/src/extractors/fictionbook.rs +492 -492
  108. data/vendor/kreuzberg/src/extractors/html.rs +407 -407
  109. data/vendor/kreuzberg/src/extractors/image.rs +219 -219
  110. data/vendor/kreuzberg/src/extractors/jats.rs +1054 -1054
  111. data/vendor/kreuzberg/src/extractors/jupyter.rs +368 -368
  112. data/vendor/kreuzberg/src/extractors/latex.rs +653 -653
  113. data/vendor/kreuzberg/src/extractors/markdown.rs +701 -701
  114. data/vendor/kreuzberg/src/extractors/mod.rs +429 -429
  115. data/vendor/kreuzberg/src/extractors/odt.rs +628 -628
  116. data/vendor/kreuzberg/src/extractors/opml.rs +635 -635
  117. data/vendor/kreuzberg/src/extractors/orgmode.rs +529 -529
  118. data/vendor/kreuzberg/src/extractors/pdf.rs +749 -749
  119. data/vendor/kreuzberg/src/extractors/pptx.rs +267 -267
  120. data/vendor/kreuzberg/src/extractors/rst.rs +577 -577
  121. data/vendor/kreuzberg/src/extractors/rtf.rs +809 -809
  122. data/vendor/kreuzberg/src/extractors/security.rs +484 -484
  123. data/vendor/kreuzberg/src/extractors/security_tests.rs +367 -367
  124. data/vendor/kreuzberg/src/extractors/structured.rs +142 -142
  125. data/vendor/kreuzberg/src/extractors/text.rs +265 -265
  126. data/vendor/kreuzberg/src/extractors/typst.rs +651 -651
  127. data/vendor/kreuzberg/src/extractors/xml.rs +147 -147
  128. data/vendor/kreuzberg/src/image/dpi.rs +164 -164
  129. data/vendor/kreuzberg/src/image/mod.rs +6 -6
  130. data/vendor/kreuzberg/src/image/preprocessing.rs +417 -417
  131. data/vendor/kreuzberg/src/image/resize.rs +89 -89
  132. data/vendor/kreuzberg/src/keywords/config.rs +154 -154
  133. data/vendor/kreuzberg/src/keywords/mod.rs +237 -237
  134. data/vendor/kreuzberg/src/keywords/processor.rs +275 -275
  135. data/vendor/kreuzberg/src/keywords/rake.rs +293 -293
  136. data/vendor/kreuzberg/src/keywords/types.rs +68 -68
  137. data/vendor/kreuzberg/src/keywords/yake.rs +163 -163
  138. data/vendor/kreuzberg/src/language_detection/mod.rs +985 -985
  139. data/vendor/kreuzberg/src/language_detection/processor.rs +219 -219
  140. data/vendor/kreuzberg/src/lib.rs +113 -113
  141. data/vendor/kreuzberg/src/mcp/mod.rs +35 -35
  142. data/vendor/kreuzberg/src/mcp/server.rs +2076 -2076
  143. data/vendor/kreuzberg/src/ocr/cache.rs +469 -469
  144. data/vendor/kreuzberg/src/ocr/error.rs +37 -37
  145. data/vendor/kreuzberg/src/ocr/hocr.rs +216 -216
  146. data/vendor/kreuzberg/src/ocr/mod.rs +58 -58
  147. data/vendor/kreuzberg/src/ocr/processor.rs +863 -863
  148. data/vendor/kreuzberg/src/ocr/table/mod.rs +4 -4
  149. data/vendor/kreuzberg/src/ocr/table/tsv_parser.rs +144 -144
  150. data/vendor/kreuzberg/src/ocr/tesseract_backend.rs +452 -452
  151. data/vendor/kreuzberg/src/ocr/types.rs +393 -393
  152. data/vendor/kreuzberg/src/ocr/utils.rs +47 -47
  153. data/vendor/kreuzberg/src/ocr/validation.rs +206 -206
  154. data/vendor/kreuzberg/src/panic_context.rs +154 -154
  155. data/vendor/kreuzberg/src/pdf/bindings.rs +44 -44
  156. data/vendor/kreuzberg/src/pdf/bundled.rs +452 -346
  157. data/vendor/kreuzberg/src/pdf/error.rs +130 -130
  158. data/vendor/kreuzberg/src/pdf/images.rs +139 -139
  159. data/vendor/kreuzberg/src/pdf/metadata.rs +489 -489
  160. data/vendor/kreuzberg/src/pdf/mod.rs +68 -68
  161. data/vendor/kreuzberg/src/pdf/rendering.rs +368 -368
  162. data/vendor/kreuzberg/src/pdf/table.rs +420 -420
  163. data/vendor/kreuzberg/src/pdf/text.rs +240 -240
  164. data/vendor/kreuzberg/src/plugins/extractor.rs +1044 -1044
  165. data/vendor/kreuzberg/src/plugins/mod.rs +212 -212
  166. data/vendor/kreuzberg/src/plugins/ocr.rs +639 -639
  167. data/vendor/kreuzberg/src/plugins/processor.rs +650 -650
  168. data/vendor/kreuzberg/src/plugins/registry.rs +1339 -1339
  169. data/vendor/kreuzberg/src/plugins/traits.rs +258 -258
  170. data/vendor/kreuzberg/src/plugins/validator.rs +967 -967
  171. data/vendor/kreuzberg/src/stopwords/mod.rs +1470 -1470
  172. data/vendor/kreuzberg/src/text/mod.rs +25 -25
  173. data/vendor/kreuzberg/src/text/quality.rs +697 -697
  174. data/vendor/kreuzberg/src/text/quality_processor.rs +219 -219
  175. data/vendor/kreuzberg/src/text/string_utils.rs +217 -217
  176. data/vendor/kreuzberg/src/text/token_reduction/cjk_utils.rs +164 -164
  177. data/vendor/kreuzberg/src/text/token_reduction/config.rs +100 -100
  178. data/vendor/kreuzberg/src/text/token_reduction/core.rs +796 -796
  179. data/vendor/kreuzberg/src/text/token_reduction/filters.rs +902 -902
  180. data/vendor/kreuzberg/src/text/token_reduction/mod.rs +160 -160
  181. data/vendor/kreuzberg/src/text/token_reduction/semantic.rs +619 -619
  182. data/vendor/kreuzberg/src/text/token_reduction/simd_text.rs +147 -147
  183. data/vendor/kreuzberg/src/types.rs +1055 -1055
  184. data/vendor/kreuzberg/src/utils/mod.rs +17 -17
  185. data/vendor/kreuzberg/src/utils/quality.rs +959 -959
  186. data/vendor/kreuzberg/src/utils/string_utils.rs +381 -381
  187. data/vendor/kreuzberg/stopwords/af_stopwords.json +53 -53
  188. data/vendor/kreuzberg/stopwords/ar_stopwords.json +482 -482
  189. data/vendor/kreuzberg/stopwords/bg_stopwords.json +261 -261
  190. data/vendor/kreuzberg/stopwords/bn_stopwords.json +400 -400
  191. data/vendor/kreuzberg/stopwords/br_stopwords.json +1205 -1205
  192. data/vendor/kreuzberg/stopwords/ca_stopwords.json +280 -280
  193. data/vendor/kreuzberg/stopwords/cs_stopwords.json +425 -425
  194. data/vendor/kreuzberg/stopwords/da_stopwords.json +172 -172
  195. data/vendor/kreuzberg/stopwords/de_stopwords.json +622 -622
  196. data/vendor/kreuzberg/stopwords/el_stopwords.json +849 -849
  197. data/vendor/kreuzberg/stopwords/en_stopwords.json +1300 -1300
  198. data/vendor/kreuzberg/stopwords/eo_stopwords.json +175 -175
  199. data/vendor/kreuzberg/stopwords/es_stopwords.json +734 -734
  200. data/vendor/kreuzberg/stopwords/et_stopwords.json +37 -37
  201. data/vendor/kreuzberg/stopwords/eu_stopwords.json +100 -100
  202. data/vendor/kreuzberg/stopwords/fa_stopwords.json +801 -801
  203. data/vendor/kreuzberg/stopwords/fi_stopwords.json +849 -849
  204. data/vendor/kreuzberg/stopwords/fr_stopwords.json +693 -693
  205. data/vendor/kreuzberg/stopwords/ga_stopwords.json +111 -111
  206. data/vendor/kreuzberg/stopwords/gl_stopwords.json +162 -162
  207. data/vendor/kreuzberg/stopwords/gu_stopwords.json +226 -226
  208. data/vendor/kreuzberg/stopwords/ha_stopwords.json +41 -41
  209. data/vendor/kreuzberg/stopwords/he_stopwords.json +196 -196
  210. data/vendor/kreuzberg/stopwords/hi_stopwords.json +227 -227
  211. data/vendor/kreuzberg/stopwords/hr_stopwords.json +181 -181
  212. data/vendor/kreuzberg/stopwords/hu_stopwords.json +791 -791
  213. data/vendor/kreuzberg/stopwords/hy_stopwords.json +47 -47
  214. data/vendor/kreuzberg/stopwords/id_stopwords.json +760 -760
  215. data/vendor/kreuzberg/stopwords/it_stopwords.json +634 -634
  216. data/vendor/kreuzberg/stopwords/ja_stopwords.json +136 -136
  217. data/vendor/kreuzberg/stopwords/kn_stopwords.json +84 -84
  218. data/vendor/kreuzberg/stopwords/ko_stopwords.json +681 -681
  219. data/vendor/kreuzberg/stopwords/ku_stopwords.json +64 -64
  220. data/vendor/kreuzberg/stopwords/la_stopwords.json +51 -51
  221. data/vendor/kreuzberg/stopwords/lt_stopwords.json +476 -476
  222. data/vendor/kreuzberg/stopwords/lv_stopwords.json +163 -163
  223. data/vendor/kreuzberg/stopwords/ml_stopwords.json +1 -1
  224. data/vendor/kreuzberg/stopwords/mr_stopwords.json +101 -101
  225. data/vendor/kreuzberg/stopwords/ms_stopwords.json +477 -477
  226. data/vendor/kreuzberg/stopwords/ne_stopwords.json +490 -490
  227. data/vendor/kreuzberg/stopwords/nl_stopwords.json +415 -415
  228. data/vendor/kreuzberg/stopwords/no_stopwords.json +223 -223
  229. data/vendor/kreuzberg/stopwords/pl_stopwords.json +331 -331
  230. data/vendor/kreuzberg/stopwords/pt_stopwords.json +562 -562
  231. data/vendor/kreuzberg/stopwords/ro_stopwords.json +436 -436
  232. data/vendor/kreuzberg/stopwords/ru_stopwords.json +561 -561
  233. data/vendor/kreuzberg/stopwords/si_stopwords.json +193 -193
  234. data/vendor/kreuzberg/stopwords/sk_stopwords.json +420 -420
  235. data/vendor/kreuzberg/stopwords/sl_stopwords.json +448 -448
  236. data/vendor/kreuzberg/stopwords/so_stopwords.json +32 -32
  237. data/vendor/kreuzberg/stopwords/st_stopwords.json +33 -33
  238. data/vendor/kreuzberg/stopwords/sv_stopwords.json +420 -420
  239. data/vendor/kreuzberg/stopwords/sw_stopwords.json +76 -76
  240. data/vendor/kreuzberg/stopwords/ta_stopwords.json +129 -129
  241. data/vendor/kreuzberg/stopwords/te_stopwords.json +54 -54
  242. data/vendor/kreuzberg/stopwords/th_stopwords.json +118 -118
  243. data/vendor/kreuzberg/stopwords/tl_stopwords.json +149 -149
  244. data/vendor/kreuzberg/stopwords/tr_stopwords.json +506 -506
  245. data/vendor/kreuzberg/stopwords/uk_stopwords.json +75 -75
  246. data/vendor/kreuzberg/stopwords/ur_stopwords.json +519 -519
  247. data/vendor/kreuzberg/stopwords/vi_stopwords.json +647 -647
  248. data/vendor/kreuzberg/stopwords/yo_stopwords.json +62 -62
  249. data/vendor/kreuzberg/stopwords/zh_stopwords.json +796 -796
  250. data/vendor/kreuzberg/stopwords/zu_stopwords.json +31 -31
  251. data/vendor/kreuzberg/tests/api_extract_multipart.rs +52 -52
  252. data/vendor/kreuzberg/tests/api_tests.rs +966 -966
  253. data/vendor/kreuzberg/tests/archive_integration.rs +545 -545
  254. data/vendor/kreuzberg/tests/batch_orchestration.rs +556 -556
  255. data/vendor/kreuzberg/tests/batch_processing.rs +318 -318
  256. data/vendor/kreuzberg/tests/bibtex_parity_test.rs +421 -421
  257. data/vendor/kreuzberg/tests/concurrency_stress.rs +533 -533
  258. data/vendor/kreuzberg/tests/config_features.rs +612 -612
  259. data/vendor/kreuzberg/tests/config_loading_tests.rs +416 -416
  260. data/vendor/kreuzberg/tests/core_integration.rs +510 -510
  261. data/vendor/kreuzberg/tests/csv_integration.rs +414 -414
  262. data/vendor/kreuzberg/tests/docbook_extractor_tests.rs +500 -500
  263. data/vendor/kreuzberg/tests/docx_metadata_extraction_test.rs +122 -122
  264. data/vendor/kreuzberg/tests/docx_vs_pandoc_comparison.rs +370 -370
  265. data/vendor/kreuzberg/tests/email_integration.rs +327 -327
  266. data/vendor/kreuzberg/tests/epub_native_extractor_tests.rs +275 -275
  267. data/vendor/kreuzberg/tests/error_handling.rs +402 -402
  268. data/vendor/kreuzberg/tests/fictionbook_extractor_tests.rs +228 -228
  269. data/vendor/kreuzberg/tests/format_integration.rs +165 -164
  270. data/vendor/kreuzberg/tests/helpers/mod.rs +142 -142
  271. data/vendor/kreuzberg/tests/html_table_test.rs +551 -551
  272. data/vendor/kreuzberg/tests/image_integration.rs +255 -255
  273. data/vendor/kreuzberg/tests/instrumentation_test.rs +139 -139
  274. data/vendor/kreuzberg/tests/jats_extractor_tests.rs +639 -639
  275. data/vendor/kreuzberg/tests/jupyter_extractor_tests.rs +704 -704
  276. data/vendor/kreuzberg/tests/keywords_integration.rs +479 -479
  277. data/vendor/kreuzberg/tests/keywords_quality.rs +509 -509
  278. data/vendor/kreuzberg/tests/latex_extractor_tests.rs +496 -496
  279. data/vendor/kreuzberg/tests/markdown_extractor_tests.rs +490 -490
  280. data/vendor/kreuzberg/tests/mime_detection.rs +429 -429
  281. data/vendor/kreuzberg/tests/ocr_configuration.rs +514 -514
  282. data/vendor/kreuzberg/tests/ocr_errors.rs +698 -698
  283. data/vendor/kreuzberg/tests/ocr_quality.rs +629 -629
  284. data/vendor/kreuzberg/tests/ocr_stress.rs +469 -469
  285. data/vendor/kreuzberg/tests/odt_extractor_tests.rs +674 -674
  286. data/vendor/kreuzberg/tests/opml_extractor_tests.rs +616 -616
  287. data/vendor/kreuzberg/tests/orgmode_extractor_tests.rs +822 -822
  288. data/vendor/kreuzberg/tests/pdf_integration.rs +45 -45
  289. data/vendor/kreuzberg/tests/pdfium_linking.rs +374 -374
  290. data/vendor/kreuzberg/tests/pipeline_integration.rs +1436 -1436
  291. data/vendor/kreuzberg/tests/plugin_ocr_backend_test.rs +776 -776
  292. data/vendor/kreuzberg/tests/plugin_postprocessor_test.rs +560 -560
  293. data/vendor/kreuzberg/tests/plugin_system.rs +927 -927
  294. data/vendor/kreuzberg/tests/plugin_validator_test.rs +783 -783
  295. data/vendor/kreuzberg/tests/registry_integration_tests.rs +587 -587
  296. data/vendor/kreuzberg/tests/rst_extractor_tests.rs +694 -694
  297. data/vendor/kreuzberg/tests/rtf_extractor_tests.rs +775 -775
  298. data/vendor/kreuzberg/tests/security_validation.rs +416 -416
  299. data/vendor/kreuzberg/tests/stopwords_integration_test.rs +888 -888
  300. data/vendor/kreuzberg/tests/test_fastembed.rs +631 -631
  301. data/vendor/kreuzberg/tests/typst_behavioral_tests.rs +1260 -1260
  302. data/vendor/kreuzberg/tests/typst_extractor_tests.rs +648 -648
  303. data/vendor/kreuzberg/tests/xlsx_metadata_extraction_test.rs +87 -87
  304. data/vendor/kreuzberg-tesseract/.commitlintrc.json +13 -13
  305. data/vendor/kreuzberg-tesseract/.crate-ignore +2 -2
  306. data/vendor/kreuzberg-tesseract/Cargo.lock +2933 -2933
  307. data/vendor/kreuzberg-tesseract/Cargo.toml +2 -2
  308. data/vendor/kreuzberg-tesseract/LICENSE +22 -22
  309. data/vendor/kreuzberg-tesseract/README.md +399 -399
  310. data/vendor/kreuzberg-tesseract/build.rs +1354 -1354
  311. data/vendor/kreuzberg-tesseract/patches/README.md +71 -71
  312. data/vendor/kreuzberg-tesseract/patches/tesseract.diff +199 -199
  313. data/vendor/kreuzberg-tesseract/src/api.rs +1371 -1371
  314. data/vendor/kreuzberg-tesseract/src/choice_iterator.rs +77 -77
  315. data/vendor/kreuzberg-tesseract/src/enums.rs +297 -297
  316. data/vendor/kreuzberg-tesseract/src/error.rs +81 -81
  317. data/vendor/kreuzberg-tesseract/src/lib.rs +145 -145
  318. data/vendor/kreuzberg-tesseract/src/monitor.rs +57 -57
  319. data/vendor/kreuzberg-tesseract/src/mutable_iterator.rs +197 -197
  320. data/vendor/kreuzberg-tesseract/src/page_iterator.rs +253 -253
  321. data/vendor/kreuzberg-tesseract/src/result_iterator.rs +286 -286
  322. data/vendor/kreuzberg-tesseract/src/result_renderer.rs +183 -183
  323. data/vendor/kreuzberg-tesseract/tests/integration_test.rs +211 -211
  324. data/vendor/rb-sys/.cargo_vcs_info.json +5 -5
  325. data/vendor/rb-sys/Cargo.lock +393 -393
  326. data/vendor/rb-sys/Cargo.toml +70 -70
  327. data/vendor/rb-sys/Cargo.toml.orig +57 -57
  328. data/vendor/rb-sys/LICENSE-APACHE +190 -190
  329. data/vendor/rb-sys/LICENSE-MIT +21 -21
  330. data/vendor/rb-sys/build/features.rs +111 -111
  331. data/vendor/rb-sys/build/main.rs +286 -286
  332. data/vendor/rb-sys/build/stable_api_config.rs +155 -155
  333. data/vendor/rb-sys/build/version.rs +50 -50
  334. data/vendor/rb-sys/readme.md +36 -36
  335. data/vendor/rb-sys/src/bindings.rs +21 -21
  336. data/vendor/rb-sys/src/hidden.rs +11 -11
  337. data/vendor/rb-sys/src/lib.rs +35 -35
  338. data/vendor/rb-sys/src/macros.rs +371 -371
  339. data/vendor/rb-sys/src/memory.rs +53 -53
  340. data/vendor/rb-sys/src/ruby_abi_version.rs +38 -38
  341. data/vendor/rb-sys/src/special_consts.rs +31 -31
  342. data/vendor/rb-sys/src/stable_api/compiled.c +179 -179
  343. data/vendor/rb-sys/src/stable_api/compiled.rs +257 -257
  344. data/vendor/rb-sys/src/stable_api/ruby_2_7.rs +324 -324
  345. data/vendor/rb-sys/src/stable_api/ruby_3_0.rs +332 -332
  346. data/vendor/rb-sys/src/stable_api/ruby_3_1.rs +325 -325
  347. data/vendor/rb-sys/src/stable_api/ruby_3_2.rs +323 -323
  348. data/vendor/rb-sys/src/stable_api/ruby_3_3.rs +339 -339
  349. data/vendor/rb-sys/src/stable_api/ruby_3_4.rs +339 -339
  350. data/vendor/rb-sys/src/stable_api.rs +260 -260
  351. data/vendor/rb-sys/src/symbol.rs +31 -31
  352. data/vendor/rb-sys/src/tracking_allocator.rs +330 -330
  353. data/vendor/rb-sys/src/utils.rs +89 -89
  354. data/vendor/rb-sys/src/value_type.rs +7 -7
  355. metadata +81 -22
  356. data/vendor/kreuzberg-ffi/Cargo.toml +0 -63
  357. data/vendor/kreuzberg-ffi/README.md +0 -851
  358. data/vendor/kreuzberg-ffi/build.rs +0 -176
  359. data/vendor/kreuzberg-ffi/cbindgen.toml +0 -27
  360. data/vendor/kreuzberg-ffi/kreuzberg-ffi-install.pc +0 -12
  361. data/vendor/kreuzberg-ffi/kreuzberg-ffi.pc.in +0 -12
  362. data/vendor/kreuzberg-ffi/kreuzberg.h +0 -1087
  363. data/vendor/kreuzberg-ffi/src/lib.rs +0 -3616
  364. data/vendor/kreuzberg-ffi/src/panic_shield.rs +0 -247
  365. data/vendor/kreuzberg-ffi/tests.disabled/README.md +0 -48
  366. data/vendor/kreuzberg-ffi/tests.disabled/config_loading_tests.rs +0 -299
  367. data/vendor/kreuzberg-ffi/tests.disabled/config_tests.rs +0 -346
  368. data/vendor/kreuzberg-ffi/tests.disabled/extractor_tests.rs +0 -232
  369. data/vendor/kreuzberg-ffi/tests.disabled/plugin_registration_tests.rs +0 -470
@@ -1,500 +1,500 @@
1
- //! Embedding generation support for RAG (Retrieval-Augmented Generation) systems.
2
- //!
3
- //! This module provides text embedding generation using ONNX models via fastembed-rs.
4
- //! Embeddings can be generated for text chunks to enable semantic search and RAG pipelines.
5
- //!
6
- //! # Features
7
- //!
8
- //! - Multiple pre-configured models optimized for different use cases
9
- //! - Preset configurations for common RAG scenarios
10
- //! - Full customization of model location and parameters
11
- //! - Batch processing for efficient embedding generation
12
- //! - Optional GPU acceleration via ONNX Runtime execution providers
13
- //!
14
- //! # ONNX Runtime Requirement
15
- //!
16
- //! **CRITICAL**: This module requires ONNX Runtime to be installed on the system.
17
- //! The `embeddings` feature uses dynamic loading (`ort-load-dynamic`), which detects
18
- //! the ONNX Runtime library at runtime.
19
- //!
20
- //! ## Installation Instructions
21
- //!
22
- //! - **macOS**: `brew install onnxruntime`
23
- //! - **Linux (Ubuntu/Debian)**: `apt install libonnxruntime libonnxruntime-dev`
24
- //! - **Linux (Fedora)**: `dnf install onnxruntime onnxruntime-devel`
25
- //! - **Linux (Arch)**: `pacman -S onnxruntime`
26
- //! - **Windows (MSVC)**: Download from https://github.com/microsoft/onnxruntime/releases and add to PATH
27
- //!
28
- //! Alternatively, set the `ORT_DYLIB_PATH` environment variable to the ONNX Runtime library path.
29
- //!
30
- //! For Docker/containers, install via package manager in your base image.
31
- //! Verified packages: Ubuntu 22.04+, Fedora 38+, Arch Linux.
32
- //!
33
- //! ## Platform Limitations
34
- //!
35
- //! **Windows MinGW builds are not supported**. ONNX Runtime requires the MSVC toolchain on Windows.
36
- //! Please use Windows MSVC builds or disable the embeddings feature.
37
- //!
38
- //! # Example
39
- //!
40
- //! ```rust,ignore
41
- //! use kreuzberg::{extract_file, ExtractionConfig, ChunkingConfig, EmbeddingConfig};
42
- //!
43
- //! let config = ExtractionConfig {
44
- //! chunking: Some(ChunkingConfig {
45
- //! preset: Some("balanced".to_string()),
46
- //! embedding: Some(EmbeddingConfig::default()),
47
- //! ..Default::default()
48
- //! }),
49
- //! ..Default::default()
50
- //! };
51
- //!
52
- //! let result = extract_file("document.pdf", None, &config).await?;
53
- //! for chunk in result.chunks.unwrap() {
54
- //! if let Some(embedding) = chunk.embedding {
55
- //! println!("Chunk has {} dimension embedding", embedding.len());
56
- //! }
57
- //! }
58
- //! ```
59
-
60
- #[cfg(feature = "embeddings")]
61
- use fastembed::{EmbeddingModel, InitOptions, TextEmbedding};
62
-
63
- #[cfg(feature = "embeddings")]
64
- use std::sync::{Arc, Mutex, RwLock};
65
-
66
- #[cfg(feature = "embeddings")]
67
- use std::collections::HashMap;
68
-
69
- #[cfg(feature = "embeddings")]
70
- use lazy_static::lazy_static;
71
-
72
- /// Wrapper for TextEmbedding that prevents cleanup during process shutdown.
73
- ///
74
- /// # Problem
75
- ///
76
- /// When the process terminates, global static objects are dropped. The `TextEmbedding`
77
- /// objects from fastembed contain ONNX Runtime sessions (via `ort v2.0.0-rc.10`), and
78
- /// during their `Drop` implementation, ONNX Runtime's C++ destructor tries to acquire
79
- /// mutexes for cleanup.
80
- ///
81
- /// At process shutdown time, the C++ runtime may have already begun tearing down
82
- /// threading infrastructure, causing mutex operations to fail with:
83
- /// "mutex lock failed: Invalid argument"
84
- ///
85
- /// This manifests as:
86
- /// ```text
87
- /// libc++abi: terminating due to uncaught exception of type std::__1::system_error:
88
- /// mutex lock failed: Invalid argument
89
- /// ```
90
- ///
91
- /// This is a known issue in `ort` (see pykeio/ort#441), fixed in later versions via commit
92
- /// 317be20 ("fix: let `Environment` drop"), but we're using v2.0.0-rc.10 through fastembed
93
- /// v5.3.1 which predates the fix.
94
- ///
95
- /// # Solution
96
- ///
97
- /// We use `Box::leak` to intentionally leak `TextEmbedding` objects during process
98
- /// shutdown, preventing their `Drop` implementation from running. This is acceptable because:
99
- ///
100
- /// 1. The OS will reclaim all process memory anyway
101
- /// 2. Avoiding the crash is more important than cleanup
102
- /// 3. This only affects process termination, not runtime behavior
103
- /// 4. Models are long-lived and would survive until process exit anyway
104
- /// 5. The memory leak is bounded (one model per unique config)
105
- ///
106
- /// # Remaining Issue
107
- ///
108
- /// Even with this fix, you may still see the mutex error during final process cleanup.
109
- /// This is because `ort` v2.0.0-rc.10 also holds the ONNX Runtime `Environment` as a
110
- /// static variable, which gets dropped during C++ static destruction after Rust cleanup.
111
- /// This error occurs *after* all Rust code has finished and can be safely ignored - all
112
- /// tests pass before the error occurs.
113
- ///
114
- /// The error will be resolved when fastembed upgrades to ort >= 2.0.0 (post-rc.10) which
115
- /// contains the proper fix.
116
- ///
117
- /// # Safety
118
- ///
119
- /// The leak is contained to process shutdown and does not affect runtime behavior.
120
- /// All normal usage patterns (creating embeddings, caching models) work identically.
121
- /// We use static references to the leaked models, which is safe because:
122
- /// - The pointers are never null (we leak valid Box<TextEmbedding>)
123
- /// - The models live until process exit
124
- /// - We never manually deallocate the leaked memory
125
- /// - Mutex provides interior mutability for the embed() method
126
- ///
127
- /// Thread-safe wrapper for leaked TextEmbedding that allows interior mutability.
128
- ///
129
- /// This wrapper holds a raw pointer to a leaked `TextEmbedding` and provides
130
- /// safe access through the Mutex lock in MODEL_CACHE.
131
- #[cfg(feature = "embeddings")]
132
- pub(crate) struct LeakedModel {
133
- ptr: *mut TextEmbedding,
134
- }
135
-
136
- #[cfg(feature = "embeddings")]
137
- impl LeakedModel {
138
- fn new(model: TextEmbedding) -> Self {
139
- Self {
140
- ptr: Box::into_raw(Box::new(model)),
141
- }
142
- }
143
-
144
- /// Get a mutable reference to the model.
145
- ///
146
- /// # Safety
147
- ///
148
- /// This is safe to call only when:
149
- /// 1. The caller has exclusive access (guaranteed by Mutex in MODEL_CACHE)
150
- /// 2. The pointer is valid (guaranteed by Box::into_raw and never deallocating)
151
- #[allow(unsafe_code, clippy::mut_from_ref)]
152
- unsafe fn get_mut(&self) -> &mut TextEmbedding {
153
- unsafe { &mut *self.ptr }
154
- }
155
- }
156
-
157
- #[cfg(feature = "embeddings")]
158
- #[allow(unsafe_code)]
159
- unsafe impl Send for LeakedModel {}
160
- #[cfg(feature = "embeddings")]
161
- #[allow(unsafe_code)]
162
- unsafe impl Sync for LeakedModel {}
163
-
164
- #[cfg(feature = "embeddings")]
165
- type CachedEmbedding = Arc<Mutex<LeakedModel>>;
166
-
167
- #[cfg(feature = "embeddings")]
168
- lazy_static! {
169
- static ref MODEL_CACHE: RwLock<HashMap<String, CachedEmbedding>> = RwLock::new(HashMap::new());
170
- }
171
-
172
- /// Returns installation instructions for ONNX Runtime.
173
- #[cfg(feature = "embeddings")]
174
- fn onnx_runtime_install_message() -> String {
175
- #[cfg(all(windows, target_env = "gnu"))]
176
- {
177
- return "ONNX Runtime embeddings are not supported on Windows MinGW builds. \
178
- ONNX Runtime requires MSVC toolchain. \
179
- Please use Windows MSVC builds or disable embeddings feature."
180
- .to_string();
181
- }
182
-
183
- #[cfg(not(all(windows, target_env = "gnu")))]
184
- {
185
- "ONNX Runtime is required for embeddings functionality. \
186
- Install: \
187
- macOS: 'brew install onnxruntime', \
188
- Linux (Ubuntu/Debian): 'apt install libonnxruntime libonnxruntime-dev', \
189
- Linux (Fedora): 'dnf install onnxruntime onnxruntime-devel', \
190
- Linux (Arch): 'pacman -S onnxruntime', \
191
- Windows (MSVC): Download from https://github.com/microsoft/onnxruntime/releases and add to PATH. \
192
- \
193
- Alternatively, set ORT_DYLIB_PATH environment variable to the ONNX Runtime library path. \
194
- \
195
- For Docker/containers: Install via package manager in your base image. \
196
- Verified packages: Ubuntu 22.04+, Fedora 38+, Arch Linux."
197
- .to_string()
198
- }
199
- }
200
-
201
- /// Get or initialize a text embedding model from cache.
202
- ///
203
- /// This function ensures models are initialized only once and reused across
204
- /// the application, avoiding redundant downloads and initialization overhead.
205
- #[cfg(feature = "embeddings")]
206
- #[allow(private_interfaces)]
207
- pub fn get_or_init_model(
208
- model: EmbeddingModel,
209
- cache_dir: Option<std::path::PathBuf>,
210
- ) -> crate::Result<CachedEmbedding> {
211
- let cache_directory = cache_dir.unwrap_or_else(|| {
212
- let mut path = std::env::current_dir().unwrap_or_else(|_| std::path::PathBuf::from("."));
213
- path.push(".kreuzberg");
214
- path.push("embeddings");
215
- path
216
- });
217
-
218
- let model_key = format!("{:?}_{}", model, cache_directory.display());
219
-
220
- {
221
- match MODEL_CACHE.read() {
222
- Ok(cache) => {
223
- if let Some(cached_model) = cache.get(&model_key) {
224
- return Ok(Arc::clone(cached_model));
225
- }
226
- }
227
- Err(poison_error) => {
228
- let cache = poison_error.get_ref();
229
- if let Some(cached_model) = cache.get(&model_key) {
230
- return Ok(Arc::clone(cached_model));
231
- }
232
- }
233
- }
234
- }
235
-
236
- {
237
- let mut cache = match MODEL_CACHE.write() {
238
- Ok(guard) => guard,
239
- Err(poison_error) => poison_error.into_inner(),
240
- };
241
-
242
- if let Some(cached_model) = cache.get(&model_key) {
243
- return Ok(Arc::clone(cached_model));
244
- }
245
-
246
- let mut init_options = InitOptions::new(model);
247
- init_options = init_options.with_cache_dir(cache_directory);
248
-
249
- let embedding_model = TextEmbedding::try_new(init_options).map_err(|e| {
250
- let error_msg = e.to_string();
251
-
252
- // Detect ONNX Runtime loading errors by checking for common patterns
253
- if error_msg.contains("onnxruntime")
254
- || error_msg.contains("ORT")
255
- || error_msg.contains("libonnxruntime")
256
- || error_msg.contains("onnxruntime.dll")
257
- || error_msg.contains("Unable to load")
258
- || error_msg.contains("library load failed")
259
- {
260
- crate::KreuzbergError::MissingDependency(format!("ONNX Runtime - {}", onnx_runtime_install_message()))
261
- } else {
262
- crate::KreuzbergError::Plugin {
263
- message: format!("Failed to initialize embedding model: {}", e),
264
- plugin_name: "embeddings".to_string(),
265
- }
266
- }
267
- })?;
268
-
269
- let leaked_model = LeakedModel::new(embedding_model);
270
- let arc_model = Arc::new(Mutex::new(leaked_model));
271
- cache.insert(model_key, Arc::clone(&arc_model));
272
-
273
- Ok(arc_model)
274
- }
275
- }
276
-
277
- /// Preset configurations for common RAG use cases.
278
- ///
279
- /// Each preset combines chunk size, overlap, and embedding model
280
- /// to provide an optimized configuration for specific scenarios.
281
- #[derive(Debug, Clone)]
282
- pub struct EmbeddingPreset {
283
- pub name: &'static str,
284
- pub chunk_size: usize,
285
- pub overlap: usize,
286
- #[cfg(feature = "embeddings")]
287
- pub model: EmbeddingModel,
288
- #[cfg(not(feature = "embeddings"))]
289
- pub model_name: &'static str,
290
- pub dimensions: usize,
291
- pub description: &'static str,
292
- }
293
-
294
- /// All available embedding presets.
295
- pub const EMBEDDING_PRESETS: &[EmbeddingPreset] = &[
296
- EmbeddingPreset {
297
- name: "fast",
298
- chunk_size: 512,
299
- overlap: 50,
300
- #[cfg(feature = "embeddings")]
301
- model: EmbeddingModel::AllMiniLML6V2Q,
302
- #[cfg(not(feature = "embeddings"))]
303
- model_name: "AllMiniLML6V2Q",
304
- dimensions: 384,
305
- description: "Fast embedding with quantized model (384 dims, ~22M params). Best for: Quick prototyping, development, resource-constrained environments.",
306
- },
307
- EmbeddingPreset {
308
- name: "balanced",
309
- chunk_size: 1024,
310
- overlap: 100,
311
- #[cfg(feature = "embeddings")]
312
- model: EmbeddingModel::BGEBaseENV15,
313
- #[cfg(not(feature = "embeddings"))]
314
- model_name: "BGEBaseENV15",
315
- dimensions: 768,
316
- description: "Balanced quality and speed (768 dims, ~109M params). Best for: General-purpose RAG, production deployments, English documents.",
317
- },
318
- EmbeddingPreset {
319
- name: "quality",
320
- chunk_size: 2000,
321
- overlap: 200,
322
- #[cfg(feature = "embeddings")]
323
- model: EmbeddingModel::BGELargeENV15,
324
- #[cfg(not(feature = "embeddings"))]
325
- model_name: "BGELargeENV15",
326
- dimensions: 1024,
327
- description: "High quality with larger context (1024 dims, ~335M params). Best for: Complex documents, maximum accuracy, sufficient compute resources.",
328
- },
329
- EmbeddingPreset {
330
- name: "multilingual",
331
- chunk_size: 1024,
332
- overlap: 100,
333
- #[cfg(feature = "embeddings")]
334
- model: EmbeddingModel::MultilingualE5Base,
335
- #[cfg(not(feature = "embeddings"))]
336
- model_name: "MultilingualE5Base",
337
- dimensions: 768,
338
- description: "Multilingual support (768 dims, 100+ languages). Best for: International documents, mixed-language content, global applications.",
339
- },
340
- ];
341
-
342
- /// Get a preset by name.
343
- pub fn get_preset(name: &str) -> Option<&'static EmbeddingPreset> {
344
- EMBEDDING_PRESETS.iter().find(|p| p.name == name)
345
- }
346
-
347
- /// List all available preset names.
348
- pub fn list_presets() -> Vec<&'static str> {
349
- EMBEDDING_PRESETS.iter().map(|p| p.name).collect()
350
- }
351
-
352
- /// Generate embeddings for text chunks using the specified configuration.
353
- ///
354
- /// This function modifies chunks in-place, populating their `embedding` field
355
- /// with generated embedding vectors. It uses batch processing for efficiency.
356
- ///
357
- /// # Arguments
358
- ///
359
- /// * `chunks` - Mutable reference to vector of chunks to generate embeddings for
360
- /// * `config` - Embedding configuration specifying model and parameters
361
- ///
362
- /// # Returns
363
- ///
364
- /// Returns `Ok(())` if embeddings were generated successfully, or an error if
365
- /// model initialization or embedding generation fails.
366
- ///
367
- /// # Example
368
- ///
369
- /// ```rust,ignore
370
- /// let mut chunks = vec![
371
- /// Chunk { content: "Hello world".to_string(), embedding: None, metadata: ... },
372
- /// Chunk { content: "Second chunk".to_string(), embedding: None, metadata: ... },
373
- /// ];
374
- /// let config = EmbeddingConfig::default();
375
- /// generate_embeddings_for_chunks(&mut chunks, &config)?;
376
- /// // Now chunks have embeddings populated
377
- /// ```
378
- #[cfg(feature = "embeddings")]
379
- pub fn generate_embeddings_for_chunks(
380
- chunks: &mut [crate::types::Chunk],
381
- config: &crate::core::config::EmbeddingConfig,
382
- ) -> crate::Result<()> {
383
- if chunks.is_empty() {
384
- return Ok(());
385
- }
386
-
387
- let fastembed_model = match &config.model {
388
- crate::core::config::EmbeddingModelType::Preset { name } => {
389
- let preset = get_preset(name).ok_or_else(|| crate::KreuzbergError::Plugin {
390
- message: format!("Unknown embedding preset: {}", name),
391
- plugin_name: "embeddings".to_string(),
392
- })?;
393
- preset.model.clone()
394
- }
395
- #[cfg(feature = "embeddings")]
396
- crate::core::config::EmbeddingModelType::FastEmbed { model, .. } => match model.as_str() {
397
- "AllMiniLML6V2Q" => fastembed::EmbeddingModel::AllMiniLML6V2Q,
398
- "BGEBaseENV15" => fastembed::EmbeddingModel::BGEBaseENV15,
399
- "BGELargeENV15" => fastembed::EmbeddingModel::BGELargeENV15,
400
- "MultilingualE5Base" => fastembed::EmbeddingModel::MultilingualE5Base,
401
- _ => {
402
- return Err(crate::KreuzbergError::Plugin {
403
- message: format!("Unknown fastembed model: {}", model),
404
- plugin_name: "embeddings".to_string(),
405
- });
406
- }
407
- },
408
- crate::core::config::EmbeddingModelType::Custom { .. } => {
409
- return Err(crate::KreuzbergError::Plugin {
410
- message: "Custom ONNX models are not yet supported for embedding generation".to_string(),
411
- plugin_name: "embeddings".to_string(),
412
- });
413
- }
414
- };
415
-
416
- let model = get_or_init_model(fastembed_model, config.cache_dir.clone())?;
417
-
418
- let texts: Vec<String> = chunks.iter().map(|chunk| chunk.content.clone()).collect();
419
-
420
- let embeddings_result = {
421
- let locked_model = model.lock().map_err(|e| crate::KreuzbergError::Plugin {
422
- message: format!("Failed to acquire model lock: {}", e),
423
- plugin_name: "embeddings".to_string(),
424
- })?;
425
-
426
- #[allow(unsafe_code)]
427
- let model_mut = unsafe { locked_model.get_mut() };
428
-
429
- model_mut
430
- .embed(texts, Some(config.batch_size))
431
- .map_err(|e| crate::KreuzbergError::Plugin {
432
- message: format!("Failed to generate embeddings: {}", e),
433
- plugin_name: "embeddings".to_string(),
434
- })?
435
- };
436
-
437
- for (chunk, mut embedding) in chunks.iter_mut().zip(embeddings_result.into_iter()) {
438
- if config.normalize {
439
- let magnitude: f32 = embedding.iter().map(|x| x * x).sum::<f32>().sqrt();
440
- if magnitude > 0.0 {
441
- embedding.iter_mut().for_each(|x| *x /= magnitude);
442
- }
443
- }
444
-
445
- chunk.embedding = Some(embedding);
446
- }
447
-
448
- Ok(())
449
- }
450
-
451
- #[cfg(test)]
452
- mod tests {
453
- use super::*;
454
-
455
- #[test]
456
- fn test_get_preset() {
457
- assert!(get_preset("balanced").is_some());
458
- assert!(get_preset("fast").is_some());
459
- assert!(get_preset("quality").is_some());
460
- assert!(get_preset("multilingual").is_some());
461
- assert!(get_preset("nonexistent").is_none());
462
- }
463
-
464
- #[test]
465
- fn test_list_presets() {
466
- let presets = list_presets();
467
- assert_eq!(presets.len(), 4);
468
- assert!(presets.contains(&"fast"));
469
- assert!(presets.contains(&"balanced"));
470
- assert!(presets.contains(&"quality"));
471
- assert!(presets.contains(&"multilingual"));
472
- }
473
-
474
- #[test]
475
- fn test_preset_dimensions() {
476
- let balanced = get_preset("balanced").unwrap();
477
- assert_eq!(balanced.dimensions, 768);
478
-
479
- let fast = get_preset("fast").unwrap();
480
- assert_eq!(fast.dimensions, 384);
481
-
482
- let quality = get_preset("quality").unwrap();
483
- assert_eq!(quality.dimensions, 1024);
484
- }
485
-
486
- #[test]
487
- fn test_preset_chunk_sizes() {
488
- let fast = get_preset("fast").unwrap();
489
- assert_eq!(fast.chunk_size, 512);
490
- assert_eq!(fast.overlap, 50);
491
-
492
- let quality = get_preset("quality").unwrap();
493
- assert_eq!(quality.chunk_size, 2000);
494
- assert_eq!(quality.overlap, 200);
495
- }
496
-
497
- #[cfg(feature = "embeddings")]
498
- #[test]
499
- fn test_lock_poisoning_recovery_semantics() {}
500
- }
1
+ //! Embedding generation support for RAG (Retrieval-Augmented Generation) systems.
2
+ //!
3
+ //! This module provides text embedding generation using ONNX models via fastembed-rs.
4
+ //! Embeddings can be generated for text chunks to enable semantic search and RAG pipelines.
5
+ //!
6
+ //! # Features
7
+ //!
8
+ //! - Multiple pre-configured models optimized for different use cases
9
+ //! - Preset configurations for common RAG scenarios
10
+ //! - Full customization of model location and parameters
11
+ //! - Batch processing for efficient embedding generation
12
+ //! - Optional GPU acceleration via ONNX Runtime execution providers
13
+ //!
14
+ //! # ONNX Runtime Requirement
15
+ //!
16
+ //! **CRITICAL**: This module requires ONNX Runtime to be installed on the system.
17
+ //! The `embeddings` feature uses dynamic loading (`ort-load-dynamic`), which detects
18
+ //! the ONNX Runtime library at runtime.
19
+ //!
20
+ //! ## Installation Instructions
21
+ //!
22
+ //! - **macOS**: `brew install onnxruntime`
23
+ //! - **Linux (Ubuntu/Debian)**: `apt install libonnxruntime libonnxruntime-dev`
24
+ //! - **Linux (Fedora)**: `dnf install onnxruntime onnxruntime-devel`
25
+ //! - **Linux (Arch)**: `pacman -S onnxruntime`
26
+ //! - **Windows (MSVC)**: Download from https://github.com/microsoft/onnxruntime/releases and add to PATH
27
+ //!
28
+ //! Alternatively, set the `ORT_DYLIB_PATH` environment variable to the ONNX Runtime library path.
29
+ //!
30
+ //! For Docker/containers, install via package manager in your base image.
31
+ //! Verified packages: Ubuntu 22.04+, Fedora 38+, Arch Linux.
32
+ //!
33
+ //! ## Platform Limitations
34
+ //!
35
+ //! **Windows MinGW builds are not supported**. ONNX Runtime requires the MSVC toolchain on Windows.
36
+ //! Please use Windows MSVC builds or disable the embeddings feature.
37
+ //!
38
+ //! # Example
39
+ //!
40
+ //! ```rust,ignore
41
+ //! use kreuzberg::{extract_file, ExtractionConfig, ChunkingConfig, EmbeddingConfig};
42
+ //!
43
+ //! let config = ExtractionConfig {
44
+ //! chunking: Some(ChunkingConfig {
45
+ //! preset: Some("balanced".to_string()),
46
+ //! embedding: Some(EmbeddingConfig::default()),
47
+ //! ..Default::default()
48
+ //! }),
49
+ //! ..Default::default()
50
+ //! };
51
+ //!
52
+ //! let result = extract_file("document.pdf", None, &config).await?;
53
+ //! for chunk in result.chunks.unwrap() {
54
+ //! if let Some(embedding) = chunk.embedding {
55
+ //! println!("Chunk has {} dimension embedding", embedding.len());
56
+ //! }
57
+ //! }
58
+ //! ```
59
+
60
+ #[cfg(feature = "embeddings")]
61
+ use fastembed::{EmbeddingModel, InitOptions, TextEmbedding};
62
+
63
+ #[cfg(feature = "embeddings")]
64
+ use std::sync::{Arc, Mutex, RwLock};
65
+
66
+ #[cfg(feature = "embeddings")]
67
+ use std::collections::HashMap;
68
+
69
+ #[cfg(feature = "embeddings")]
70
+ use lazy_static::lazy_static;
71
+
72
+ /// Wrapper for TextEmbedding that prevents cleanup during process shutdown.
73
+ ///
74
+ /// # Problem
75
+ ///
76
+ /// When the process terminates, global static objects are dropped. The `TextEmbedding`
77
+ /// objects from fastembed contain ONNX Runtime sessions (via `ort v2.0.0-rc.10`), and
78
+ /// during their `Drop` implementation, ONNX Runtime's C++ destructor tries to acquire
79
+ /// mutexes for cleanup.
80
+ ///
81
+ /// At process shutdown time, the C++ runtime may have already begun tearing down
82
+ /// threading infrastructure, causing mutex operations to fail with:
83
+ /// "mutex lock failed: Invalid argument"
84
+ ///
85
+ /// This manifests as:
86
+ /// ```text
87
+ /// libc++abi: terminating due to uncaught exception of type std::__1::system_error:
88
+ /// mutex lock failed: Invalid argument
89
+ /// ```
90
+ ///
91
+ /// This is a known issue in `ort` (see pykeio/ort#441), fixed in later versions via commit
92
+ /// 317be20 ("fix: let `Environment` drop"), but we're using v2.0.0-rc.10 through fastembed
93
+ /// v5.3.1 which predates the fix.
94
+ ///
95
+ /// # Solution
96
+ ///
97
+ /// We use `Box::leak` to intentionally leak `TextEmbedding` objects during process
98
+ /// shutdown, preventing their `Drop` implementation from running. This is acceptable because:
99
+ ///
100
+ /// 1. The OS will reclaim all process memory anyway
101
+ /// 2. Avoiding the crash is more important than cleanup
102
+ /// 3. This only affects process termination, not runtime behavior
103
+ /// 4. Models are long-lived and would survive until process exit anyway
104
+ /// 5. The memory leak is bounded (one model per unique config)
105
+ ///
106
+ /// # Remaining Issue
107
+ ///
108
+ /// Even with this fix, you may still see the mutex error during final process cleanup.
109
+ /// This is because `ort` v2.0.0-rc.10 also holds the ONNX Runtime `Environment` as a
110
+ /// static variable, which gets dropped during C++ static destruction after Rust cleanup.
111
+ /// This error occurs *after* all Rust code has finished and can be safely ignored - all
112
+ /// tests pass before the error occurs.
113
+ ///
114
+ /// The error will be resolved when fastembed upgrades to ort >= 2.0.0 (post-rc.10) which
115
+ /// contains the proper fix.
116
+ ///
117
+ /// # Safety
118
+ ///
119
+ /// The leak is contained to process shutdown and does not affect runtime behavior.
120
+ /// All normal usage patterns (creating embeddings, caching models) work identically.
121
+ /// We use static references to the leaked models, which is safe because:
122
+ /// - The pointers are never null (we leak valid Box<TextEmbedding>)
123
+ /// - The models live until process exit
124
+ /// - We never manually deallocate the leaked memory
125
+ /// - Mutex provides interior mutability for the embed() method
126
+ ///
127
+ /// Thread-safe wrapper for leaked TextEmbedding that allows interior mutability.
128
+ ///
129
+ /// This wrapper holds a raw pointer to a leaked `TextEmbedding` and provides
130
+ /// safe access through the Mutex lock in MODEL_CACHE.
131
+ #[cfg(feature = "embeddings")]
132
+ pub(crate) struct LeakedModel {
133
+ ptr: *mut TextEmbedding,
134
+ }
135
+
136
+ #[cfg(feature = "embeddings")]
137
+ impl LeakedModel {
138
+ fn new(model: TextEmbedding) -> Self {
139
+ Self {
140
+ ptr: Box::into_raw(Box::new(model)),
141
+ }
142
+ }
143
+
144
+ /// Get a mutable reference to the model.
145
+ ///
146
+ /// # Safety
147
+ ///
148
+ /// This is safe to call only when:
149
+ /// 1. The caller has exclusive access (guaranteed by Mutex in MODEL_CACHE)
150
+ /// 2. The pointer is valid (guaranteed by Box::into_raw and never deallocating)
151
+ #[allow(unsafe_code, clippy::mut_from_ref)]
152
+ unsafe fn get_mut(&self) -> &mut TextEmbedding {
153
+ unsafe { &mut *self.ptr }
154
+ }
155
+ }
156
+
157
+ #[cfg(feature = "embeddings")]
158
+ #[allow(unsafe_code)]
159
+ unsafe impl Send for LeakedModel {}
160
+ #[cfg(feature = "embeddings")]
161
+ #[allow(unsafe_code)]
162
+ unsafe impl Sync for LeakedModel {}
163
+
164
+ #[cfg(feature = "embeddings")]
165
+ type CachedEmbedding = Arc<Mutex<LeakedModel>>;
166
+
167
+ #[cfg(feature = "embeddings")]
168
+ lazy_static! {
169
+ static ref MODEL_CACHE: RwLock<HashMap<String, CachedEmbedding>> = RwLock::new(HashMap::new());
170
+ }
171
+
172
+ /// Returns installation instructions for ONNX Runtime.
173
+ #[cfg(feature = "embeddings")]
174
+ fn onnx_runtime_install_message() -> String {
175
+ #[cfg(all(windows, target_env = "gnu"))]
176
+ {
177
+ return "ONNX Runtime embeddings are not supported on Windows MinGW builds. \
178
+ ONNX Runtime requires MSVC toolchain. \
179
+ Please use Windows MSVC builds or disable embeddings feature."
180
+ .to_string();
181
+ }
182
+
183
+ #[cfg(not(all(windows, target_env = "gnu")))]
184
+ {
185
+ "ONNX Runtime is required for embeddings functionality. \
186
+ Install: \
187
+ macOS: 'brew install onnxruntime', \
188
+ Linux (Ubuntu/Debian): 'apt install libonnxruntime libonnxruntime-dev', \
189
+ Linux (Fedora): 'dnf install onnxruntime onnxruntime-devel', \
190
+ Linux (Arch): 'pacman -S onnxruntime', \
191
+ Windows (MSVC): Download from https://github.com/microsoft/onnxruntime/releases and add to PATH. \
192
+ \
193
+ Alternatively, set ORT_DYLIB_PATH environment variable to the ONNX Runtime library path. \
194
+ \
195
+ For Docker/containers: Install via package manager in your base image. \
196
+ Verified packages: Ubuntu 22.04+, Fedora 38+, Arch Linux."
197
+ .to_string()
198
+ }
199
+ }
200
+
201
+ /// Get or initialize a text embedding model from cache.
202
+ ///
203
+ /// This function ensures models are initialized only once and reused across
204
+ /// the application, avoiding redundant downloads and initialization overhead.
205
+ #[cfg(feature = "embeddings")]
206
+ #[allow(private_interfaces)]
207
+ pub fn get_or_init_model(
208
+ model: EmbeddingModel,
209
+ cache_dir: Option<std::path::PathBuf>,
210
+ ) -> crate::Result<CachedEmbedding> {
211
+ let cache_directory = cache_dir.unwrap_or_else(|| {
212
+ let mut path = std::env::current_dir().unwrap_or_else(|_| std::path::PathBuf::from("."));
213
+ path.push(".kreuzberg");
214
+ path.push("embeddings");
215
+ path
216
+ });
217
+
218
+ let model_key = format!("{:?}_{}", model, cache_directory.display());
219
+
220
+ {
221
+ match MODEL_CACHE.read() {
222
+ Ok(cache) => {
223
+ if let Some(cached_model) = cache.get(&model_key) {
224
+ return Ok(Arc::clone(cached_model));
225
+ }
226
+ }
227
+ Err(poison_error) => {
228
+ let cache = poison_error.get_ref();
229
+ if let Some(cached_model) = cache.get(&model_key) {
230
+ return Ok(Arc::clone(cached_model));
231
+ }
232
+ }
233
+ }
234
+ }
235
+
236
+ {
237
+ let mut cache = match MODEL_CACHE.write() {
238
+ Ok(guard) => guard,
239
+ Err(poison_error) => poison_error.into_inner(),
240
+ };
241
+
242
+ if let Some(cached_model) = cache.get(&model_key) {
243
+ return Ok(Arc::clone(cached_model));
244
+ }
245
+
246
+ let mut init_options = InitOptions::new(model);
247
+ init_options = init_options.with_cache_dir(cache_directory);
248
+
249
+ let embedding_model = TextEmbedding::try_new(init_options).map_err(|e| {
250
+ let error_msg = e.to_string();
251
+
252
+ // Detect ONNX Runtime loading errors by checking for common patterns
253
+ if error_msg.contains("onnxruntime")
254
+ || error_msg.contains("ORT")
255
+ || error_msg.contains("libonnxruntime")
256
+ || error_msg.contains("onnxruntime.dll")
257
+ || error_msg.contains("Unable to load")
258
+ || error_msg.contains("library load failed")
259
+ {
260
+ crate::KreuzbergError::MissingDependency(format!("ONNX Runtime - {}", onnx_runtime_install_message()))
261
+ } else {
262
+ crate::KreuzbergError::Plugin {
263
+ message: format!("Failed to initialize embedding model: {}", e),
264
+ plugin_name: "embeddings".to_string(),
265
+ }
266
+ }
267
+ })?;
268
+
269
+ let leaked_model = LeakedModel::new(embedding_model);
270
+ let arc_model = Arc::new(Mutex::new(leaked_model));
271
+ cache.insert(model_key, Arc::clone(&arc_model));
272
+
273
+ Ok(arc_model)
274
+ }
275
+ }
276
+
277
+ /// Preset configurations for common RAG use cases.
278
+ ///
279
+ /// Each preset combines chunk size, overlap, and embedding model
280
+ /// to provide an optimized configuration for specific scenarios.
281
+ #[derive(Debug, Clone)]
282
+ pub struct EmbeddingPreset {
283
+ pub name: &'static str,
284
+ pub chunk_size: usize,
285
+ pub overlap: usize,
286
+ #[cfg(feature = "embeddings")]
287
+ pub model: EmbeddingModel,
288
+ #[cfg(not(feature = "embeddings"))]
289
+ pub model_name: &'static str,
290
+ pub dimensions: usize,
291
+ pub description: &'static str,
292
+ }
293
+
294
+ /// All available embedding presets.
295
+ pub const EMBEDDING_PRESETS: &[EmbeddingPreset] = &[
296
+ EmbeddingPreset {
297
+ name: "fast",
298
+ chunk_size: 512,
299
+ overlap: 50,
300
+ #[cfg(feature = "embeddings")]
301
+ model: EmbeddingModel::AllMiniLML6V2Q,
302
+ #[cfg(not(feature = "embeddings"))]
303
+ model_name: "AllMiniLML6V2Q",
304
+ dimensions: 384,
305
+ description: "Fast embedding with quantized model (384 dims, ~22M params). Best for: Quick prototyping, development, resource-constrained environments.",
306
+ },
307
+ EmbeddingPreset {
308
+ name: "balanced",
309
+ chunk_size: 1024,
310
+ overlap: 100,
311
+ #[cfg(feature = "embeddings")]
312
+ model: EmbeddingModel::BGEBaseENV15,
313
+ #[cfg(not(feature = "embeddings"))]
314
+ model_name: "BGEBaseENV15",
315
+ dimensions: 768,
316
+ description: "Balanced quality and speed (768 dims, ~109M params). Best for: General-purpose RAG, production deployments, English documents.",
317
+ },
318
+ EmbeddingPreset {
319
+ name: "quality",
320
+ chunk_size: 2000,
321
+ overlap: 200,
322
+ #[cfg(feature = "embeddings")]
323
+ model: EmbeddingModel::BGELargeENV15,
324
+ #[cfg(not(feature = "embeddings"))]
325
+ model_name: "BGELargeENV15",
326
+ dimensions: 1024,
327
+ description: "High quality with larger context (1024 dims, ~335M params). Best for: Complex documents, maximum accuracy, sufficient compute resources.",
328
+ },
329
+ EmbeddingPreset {
330
+ name: "multilingual",
331
+ chunk_size: 1024,
332
+ overlap: 100,
333
+ #[cfg(feature = "embeddings")]
334
+ model: EmbeddingModel::MultilingualE5Base,
335
+ #[cfg(not(feature = "embeddings"))]
336
+ model_name: "MultilingualE5Base",
337
+ dimensions: 768,
338
+ description: "Multilingual support (768 dims, 100+ languages). Best for: International documents, mixed-language content, global applications.",
339
+ },
340
+ ];
341
+
342
+ /// Get a preset by name.
343
+ pub fn get_preset(name: &str) -> Option<&'static EmbeddingPreset> {
344
+ EMBEDDING_PRESETS.iter().find(|p| p.name == name)
345
+ }
346
+
347
+ /// List all available preset names.
348
+ pub fn list_presets() -> Vec<&'static str> {
349
+ EMBEDDING_PRESETS.iter().map(|p| p.name).collect()
350
+ }
351
+
352
+ /// Generate embeddings for text chunks using the specified configuration.
353
+ ///
354
+ /// This function modifies chunks in-place, populating their `embedding` field
355
+ /// with generated embedding vectors. It uses batch processing for efficiency.
356
+ ///
357
+ /// # Arguments
358
+ ///
359
+ /// * `chunks` - Mutable reference to vector of chunks to generate embeddings for
360
+ /// * `config` - Embedding configuration specifying model and parameters
361
+ ///
362
+ /// # Returns
363
+ ///
364
+ /// Returns `Ok(())` if embeddings were generated successfully, or an error if
365
+ /// model initialization or embedding generation fails.
366
+ ///
367
+ /// # Example
368
+ ///
369
+ /// ```rust,ignore
370
+ /// let mut chunks = vec![
371
+ /// Chunk { content: "Hello world".to_string(), embedding: None, metadata: ... },
372
+ /// Chunk { content: "Second chunk".to_string(), embedding: None, metadata: ... },
373
+ /// ];
374
+ /// let config = EmbeddingConfig::default();
375
+ /// generate_embeddings_for_chunks(&mut chunks, &config)?;
376
+ /// // Now chunks have embeddings populated
377
+ /// ```
378
+ #[cfg(feature = "embeddings")]
379
+ pub fn generate_embeddings_for_chunks(
380
+ chunks: &mut [crate::types::Chunk],
381
+ config: &crate::core::config::EmbeddingConfig,
382
+ ) -> crate::Result<()> {
383
+ if chunks.is_empty() {
384
+ return Ok(());
385
+ }
386
+
387
+ let fastembed_model = match &config.model {
388
+ crate::core::config::EmbeddingModelType::Preset { name } => {
389
+ let preset = get_preset(name).ok_or_else(|| crate::KreuzbergError::Plugin {
390
+ message: format!("Unknown embedding preset: {}", name),
391
+ plugin_name: "embeddings".to_string(),
392
+ })?;
393
+ preset.model.clone()
394
+ }
395
+ #[cfg(feature = "embeddings")]
396
+ crate::core::config::EmbeddingModelType::FastEmbed { model, .. } => match model.as_str() {
397
+ "AllMiniLML6V2Q" => fastembed::EmbeddingModel::AllMiniLML6V2Q,
398
+ "BGEBaseENV15" => fastembed::EmbeddingModel::BGEBaseENV15,
399
+ "BGELargeENV15" => fastembed::EmbeddingModel::BGELargeENV15,
400
+ "MultilingualE5Base" => fastembed::EmbeddingModel::MultilingualE5Base,
401
+ _ => {
402
+ return Err(crate::KreuzbergError::Plugin {
403
+ message: format!("Unknown fastembed model: {}", model),
404
+ plugin_name: "embeddings".to_string(),
405
+ });
406
+ }
407
+ },
408
+ crate::core::config::EmbeddingModelType::Custom { .. } => {
409
+ return Err(crate::KreuzbergError::Plugin {
410
+ message: "Custom ONNX models are not yet supported for embedding generation".to_string(),
411
+ plugin_name: "embeddings".to_string(),
412
+ });
413
+ }
414
+ };
415
+
416
+ let model = get_or_init_model(fastembed_model, config.cache_dir.clone())?;
417
+
418
+ let texts: Vec<String> = chunks.iter().map(|chunk| chunk.content.clone()).collect();
419
+
420
+ let embeddings_result = {
421
+ let locked_model = model.lock().map_err(|e| crate::KreuzbergError::Plugin {
422
+ message: format!("Failed to acquire model lock: {}", e),
423
+ plugin_name: "embeddings".to_string(),
424
+ })?;
425
+
426
+ #[allow(unsafe_code)]
427
+ let model_mut = unsafe { locked_model.get_mut() };
428
+
429
+ model_mut
430
+ .embed(texts, Some(config.batch_size))
431
+ .map_err(|e| crate::KreuzbergError::Plugin {
432
+ message: format!("Failed to generate embeddings: {}", e),
433
+ plugin_name: "embeddings".to_string(),
434
+ })?
435
+ };
436
+
437
+ for (chunk, mut embedding) in chunks.iter_mut().zip(embeddings_result.into_iter()) {
438
+ if config.normalize {
439
+ let magnitude: f32 = embedding.iter().map(|x| x * x).sum::<f32>().sqrt();
440
+ if magnitude > 0.0 {
441
+ embedding.iter_mut().for_each(|x| *x /= magnitude);
442
+ }
443
+ }
444
+
445
+ chunk.embedding = Some(embedding);
446
+ }
447
+
448
+ Ok(())
449
+ }
450
+
451
+ #[cfg(test)]
452
+ mod tests {
453
+ use super::*;
454
+
455
+ #[test]
456
+ fn test_get_preset() {
457
+ assert!(get_preset("balanced").is_some());
458
+ assert!(get_preset("fast").is_some());
459
+ assert!(get_preset("quality").is_some());
460
+ assert!(get_preset("multilingual").is_some());
461
+ assert!(get_preset("nonexistent").is_none());
462
+ }
463
+
464
+ #[test]
465
+ fn test_list_presets() {
466
+ let presets = list_presets();
467
+ assert_eq!(presets.len(), 4);
468
+ assert!(presets.contains(&"fast"));
469
+ assert!(presets.contains(&"balanced"));
470
+ assert!(presets.contains(&"quality"));
471
+ assert!(presets.contains(&"multilingual"));
472
+ }
473
+
474
+ #[test]
475
+ fn test_preset_dimensions() {
476
+ let balanced = get_preset("balanced").unwrap();
477
+ assert_eq!(balanced.dimensions, 768);
478
+
479
+ let fast = get_preset("fast").unwrap();
480
+ assert_eq!(fast.dimensions, 384);
481
+
482
+ let quality = get_preset("quality").unwrap();
483
+ assert_eq!(quality.dimensions, 1024);
484
+ }
485
+
486
+ #[test]
487
+ fn test_preset_chunk_sizes() {
488
+ let fast = get_preset("fast").unwrap();
489
+ assert_eq!(fast.chunk_size, 512);
490
+ assert_eq!(fast.overlap, 50);
491
+
492
+ let quality = get_preset("quality").unwrap();
493
+ assert_eq!(quality.chunk_size, 2000);
494
+ assert_eq!(quality.overlap, 200);
495
+ }
496
+
497
+ #[cfg(feature = "embeddings")]
498
+ #[test]
499
+ fn test_lock_poisoning_recovery_semantics() {}
500
+ }