kreuzberg 4.0.0.rc1 → 4.0.0.rc2

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