mindee-lite 5.0.0.beta1

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 (510) hide show
  1. checksums.yaml +7 -0
  2. data/.editorconfig +24 -0
  3. data/.gitattributes +14 -0
  4. data/.gitignore +76 -0
  5. data/.gitmodules +3 -0
  6. data/.pre-commit-config.yaml +36 -0
  7. data/.rubocop.yml +49 -0
  8. data/.yardopts +4 -0
  9. data/CHANGELOG.md +515 -0
  10. data/CODE_OF_CONDUCT.md +129 -0
  11. data/CONTRIBUTING.md +107 -0
  12. data/Gemfile +14 -0
  13. data/LICENSE +21 -0
  14. data/README.md +42 -0
  15. data/Rakefile +40 -0
  16. data/Steepfile +30 -0
  17. data/bin/console +14 -0
  18. data/bin/mindee.rb +30 -0
  19. data/bin/v1/parser.rb +153 -0
  20. data/bin/v1/products.rb +88 -0
  21. data/bin/v2/parser.rb +235 -0
  22. data/bin/v2/products.rb +34 -0
  23. data/docs/code_samples/bank_account_details_v1.txt +24 -0
  24. data/docs/code_samples/bank_account_details_v2.txt +24 -0
  25. data/docs/code_samples/bank_statement_fr_v2_async.txt +24 -0
  26. data/docs/code_samples/barcode_reader_v1.txt +24 -0
  27. data/docs/code_samples/cropper_v1.txt +21 -0
  28. data/docs/code_samples/default.txt +30 -0
  29. data/docs/code_samples/default_async.txt +29 -0
  30. data/docs/code_samples/expense_receipts_v5.txt +25 -0
  31. data/docs/code_samples/expense_receipts_v5_async.txt +24 -0
  32. data/docs/code_samples/financial_document_v1.txt +25 -0
  33. data/docs/code_samples/financial_document_v1_async.txt +24 -0
  34. data/docs/code_samples/idcard_fr_v1.txt +24 -0
  35. data/docs/code_samples/idcard_fr_v2.txt +24 -0
  36. data/docs/code_samples/international_id_v2_async.txt +24 -0
  37. data/docs/code_samples/invoice_splitter_v1_async.txt +24 -0
  38. data/docs/code_samples/invoices_v4.txt +25 -0
  39. data/docs/code_samples/invoices_v4_async.txt +24 -0
  40. data/docs/code_samples/multi_receipts_detector_v1.txt +24 -0
  41. data/docs/code_samples/passport_v1.txt +24 -0
  42. data/docs/code_samples/resume_v1_async.txt +24 -0
  43. data/docs/code_samples/v2_classification.txt +30 -0
  44. data/docs/code_samples/v2_crop.txt +30 -0
  45. data/docs/code_samples/v2_extraction.txt +42 -0
  46. data/docs/code_samples/v2_extraction_webhook.txt +45 -0
  47. data/docs/code_samples/v2_ocr.txt +30 -0
  48. data/docs/code_samples/v2_split.txt +30 -0
  49. data/docs/code_samples/workflow_execution.txt +28 -0
  50. data/docs/code_samples/workflow_polling.txt +35 -0
  51. data/examples/auto_invoice_splitter_extraction.rb +48 -0
  52. data/examples/auto_multi_receipts_detector_extraction.rb +30 -0
  53. data/lib/mindee/dependency.rb +29 -0
  54. data/lib/mindee/error/mindee_error.rb +17 -0
  55. data/lib/mindee/error/mindee_http_error.rb +36 -0
  56. data/lib/mindee/error/mindee_http_error_v2.rb +45 -0
  57. data/lib/mindee/error/mindee_http_unknown_error_v2.rb +18 -0
  58. data/lib/mindee/error/mindee_input_error.rb +30 -0
  59. data/lib/mindee/error.rb +6 -0
  60. data/lib/mindee/geometry/min_max.rb +23 -0
  61. data/lib/mindee/geometry/point.rb +41 -0
  62. data/lib/mindee/geometry/polygon.rb +37 -0
  63. data/lib/mindee/geometry/quadrilateral.rb +50 -0
  64. data/lib/mindee/geometry/utils.rb +88 -0
  65. data/lib/mindee/geometry.rb +7 -0
  66. data/lib/mindee/http/.rubocop.yml +7 -0
  67. data/lib/mindee/http/http_error_handler.rb +106 -0
  68. data/lib/mindee/http/response_validation.rb +81 -0
  69. data/lib/mindee/http.rb +3 -0
  70. data/lib/mindee/image/extracted_image.rb +89 -0
  71. data/lib/mindee/image/image_compressor.rb +29 -0
  72. data/lib/mindee/image/image_extractor.rb +118 -0
  73. data/lib/mindee/image/image_utils.rb +165 -0
  74. data/lib/mindee/image.rb +6 -0
  75. data/lib/mindee/input/base_parameters.rb +149 -0
  76. data/lib/mindee/input/local_response.rb +80 -0
  77. data/lib/mindee/input/polling_options.rb +26 -0
  78. data/lib/mindee/input/sources/base64_input_source.rb +31 -0
  79. data/lib/mindee/input/sources/bytes_input_source.rb +21 -0
  80. data/lib/mindee/input/sources/file_input_source.rb +20 -0
  81. data/lib/mindee/input/sources/local_input_source.rb +216 -0
  82. data/lib/mindee/input/sources/path_input_source.rb +20 -0
  83. data/lib/mindee/input/sources/url_input_source.rb +130 -0
  84. data/lib/mindee/input/sources.rb +8 -0
  85. data/lib/mindee/input.rb +4 -0
  86. data/lib/mindee/logging/logger.rb +24 -0
  87. data/lib/mindee/logging.rb +3 -0
  88. data/lib/mindee/page_options.rb +24 -0
  89. data/lib/mindee/pdf/extracted_pdf.rb +70 -0
  90. data/lib/mindee/pdf/pdf_compressor.rb +121 -0
  91. data/lib/mindee/pdf/pdf_extractor.rb +121 -0
  92. data/lib/mindee/pdf/pdf_processor.rb +91 -0
  93. data/lib/mindee/pdf/pdf_tools.rb +201 -0
  94. data/lib/mindee/pdf.rb +7 -0
  95. data/lib/mindee/v1/client.rb +490 -0
  96. data/lib/mindee/v1/extraction/multi_receipts_extractor.rb +32 -0
  97. data/lib/mindee/v1/extraction.rb +3 -0
  98. data/lib/mindee/v1/http/.rubocop.yml +7 -0
  99. data/lib/mindee/v1/http/endpoint.rb +221 -0
  100. data/lib/mindee/v1/http/workflow_endpoint.rb +93 -0
  101. data/lib/mindee/v1/http.rb +4 -0
  102. data/lib/mindee/v1/parsing/common/api_request.rb +38 -0
  103. data/lib/mindee/v1/parsing/common/api_response.rb +63 -0
  104. data/lib/mindee/v1/parsing/common/document.rb +86 -0
  105. data/lib/mindee/v1/parsing/common/execution.rb +78 -0
  106. data/lib/mindee/v1/parsing/common/execution_file.rb +26 -0
  107. data/lib/mindee/v1/parsing/common/execution_priority.rb +38 -0
  108. data/lib/mindee/v1/parsing/common/extras/cropper_extra.rb +32 -0
  109. data/lib/mindee/v1/parsing/common/extras/extras.rb +62 -0
  110. data/lib/mindee/v1/parsing/common/extras/full_text_ocr_extra.rb +35 -0
  111. data/lib/mindee/v1/parsing/common/extras/rag_extra.rb +28 -0
  112. data/lib/mindee/v1/parsing/common/extras.rb +6 -0
  113. data/lib/mindee/v1/parsing/common/inference.rb +69 -0
  114. data/lib/mindee/v1/parsing/common/job.rb +48 -0
  115. data/lib/mindee/v1/parsing/common/ocr/mvision_v1.rb +52 -0
  116. data/lib/mindee/v1/parsing/common/ocr/ocr.rb +180 -0
  117. data/lib/mindee/v1/parsing/common/ocr.rb +3 -0
  118. data/lib/mindee/v1/parsing/common/orientation.rb +28 -0
  119. data/lib/mindee/v1/parsing/common/page.rb +49 -0
  120. data/lib/mindee/v1/parsing/common/prediction.rb +19 -0
  121. data/lib/mindee/v1/parsing/common/product.rb +26 -0
  122. data/lib/mindee/v1/parsing/common/workflow_response.rb +30 -0
  123. data/lib/mindee/v1/parsing/common.rb +15 -0
  124. data/lib/mindee/v1/parsing/standard/abstract_field.rb +74 -0
  125. data/lib/mindee/v1/parsing/standard/address_field.rb +51 -0
  126. data/lib/mindee/v1/parsing/standard/amount_field.rb +28 -0
  127. data/lib/mindee/v1/parsing/standard/base_field.rb +30 -0
  128. data/lib/mindee/v1/parsing/standard/boolean_field.rb +29 -0
  129. data/lib/mindee/v1/parsing/standard/classification_field.rb +18 -0
  130. data/lib/mindee/v1/parsing/standard/company_registration_field.rb +45 -0
  131. data/lib/mindee/v1/parsing/standard/date_field.rb +40 -0
  132. data/lib/mindee/v1/parsing/standard/feature_field.rb +26 -0
  133. data/lib/mindee/v1/parsing/standard/locale_field.rb +52 -0
  134. data/lib/mindee/v1/parsing/standard/payment_details_field.rb +44 -0
  135. data/lib/mindee/v1/parsing/standard/position_field.rb +61 -0
  136. data/lib/mindee/v1/parsing/standard/string_field.rb +26 -0
  137. data/lib/mindee/v1/parsing/standard/tax_field.rb +110 -0
  138. data/lib/mindee/v1/parsing/standard.rb +15 -0
  139. data/lib/mindee/v1/parsing/universal/universal_list_field.rb +60 -0
  140. data/lib/mindee/v1/parsing/universal/universal_object_field.rb +123 -0
  141. data/lib/mindee/v1/parsing/universal.rb +4 -0
  142. data/lib/mindee/v1/parsing.rb +5 -0
  143. data/lib/mindee/v1/product/.rubocop.yml +12 -0
  144. data/lib/mindee/v1/product/barcode_reader/barcode_reader_v1.rb +47 -0
  145. data/lib/mindee/v1/product/barcode_reader/barcode_reader_v1_document.rb +47 -0
  146. data/lib/mindee/v1/product/barcode_reader/barcode_reader_v1_page.rb +38 -0
  147. data/lib/mindee/v1/product/cropper/cropper_v1.rb +47 -0
  148. data/lib/mindee/v1/product/cropper/cropper_v1_document.rb +15 -0
  149. data/lib/mindee/v1/product/cropper/cropper_v1_page.rb +55 -0
  150. data/lib/mindee/v1/product/financial_document/financial_document_v1.rb +47 -0
  151. data/lib/mindee/v1/product/financial_document/financial_document_v1_document.rb +329 -0
  152. data/lib/mindee/v1/product/financial_document/financial_document_v1_line_item.rb +124 -0
  153. data/lib/mindee/v1/product/financial_document/financial_document_v1_line_items.rb +64 -0
  154. data/lib/mindee/v1/product/financial_document/financial_document_v1_page.rb +38 -0
  155. data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1.rb +49 -0
  156. data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_document.rb +49 -0
  157. data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_page.rb +40 -0
  158. data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2.rb +49 -0
  159. data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_bban.rb +63 -0
  160. data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_document.rb +60 -0
  161. data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_page.rb +40 -0
  162. data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2.rb +49 -0
  163. data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_document.rb +169 -0
  164. data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_page.rb +40 -0
  165. data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_transaction.rb +78 -0
  166. data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_transactions.rb +56 -0
  167. data/lib/mindee/v1/product/fr/id_card/id_card_v1.rb +49 -0
  168. data/lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb +106 -0
  169. data/lib/mindee/v1/product/fr/id_card/id_card_v1_page.rb +57 -0
  170. data/lib/mindee/v1/product/fr/id_card/id_card_v2.rb +49 -0
  171. data/lib/mindee/v1/product/fr/id_card/id_card_v2_document.rb +143 -0
  172. data/lib/mindee/v1/product/fr/id_card/id_card_v2_page.rb +65 -0
  173. data/lib/mindee/v1/product/international_id/international_id_v2.rb +47 -0
  174. data/lib/mindee/v1/product/international_id/international_id_v2_document.rb +164 -0
  175. data/lib/mindee/v1/product/international_id/international_id_v2_page.rb +38 -0
  176. data/lib/mindee/v1/product/invoice/invoice_v4.rb +47 -0
  177. data/lib/mindee/v1/product/invoice/invoice_v4_document.rb +300 -0
  178. data/lib/mindee/v1/product/invoice/invoice_v4_line_item.rb +124 -0
  179. data/lib/mindee/v1/product/invoice/invoice_v4_line_items.rb +64 -0
  180. data/lib/mindee/v1/product/invoice/invoice_v4_page.rb +38 -0
  181. data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1.rb +47 -0
  182. data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_document.rb +66 -0
  183. data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rb +58 -0
  184. data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rb +50 -0
  185. data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_page.rb +38 -0
  186. data/lib/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1.rb +47 -0
  187. data/lib/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb +38 -0
  188. data/lib/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb +38 -0
  189. data/lib/mindee/v1/product/passport/passport_v1.rb +47 -0
  190. data/lib/mindee/v1/product/passport/passport_v1_document.rb +112 -0
  191. data/lib/mindee/v1/product/passport/passport_v1_page.rb +38 -0
  192. data/lib/mindee/v1/product/receipt/receipt_v5.rb +47 -0
  193. data/lib/mindee/v1/product/receipt/receipt_v5_document.rb +187 -0
  194. data/lib/mindee/v1/product/receipt/receipt_v5_line_item.rb +88 -0
  195. data/lib/mindee/v1/product/receipt/receipt_v5_line_items.rb +56 -0
  196. data/lib/mindee/v1/product/receipt/receipt_v5_page.rb +38 -0
  197. data/lib/mindee/v1/product/resume/resume_v1.rb +47 -0
  198. data/lib/mindee/v1/product/resume/resume_v1_certificate.rb +82 -0
  199. data/lib/mindee/v1/product/resume/resume_v1_certificates.rb +60 -0
  200. data/lib/mindee/v1/product/resume/resume_v1_document.rb +340 -0
  201. data/lib/mindee/v1/product/resume/resume_v1_education.rb +106 -0
  202. data/lib/mindee/v1/product/resume/resume_v1_educations.rb +66 -0
  203. data/lib/mindee/v1/product/resume/resume_v1_language.rb +66 -0
  204. data/lib/mindee/v1/product/resume/resume_v1_languages.rb +56 -0
  205. data/lib/mindee/v1/product/resume/resume_v1_page.rb +38 -0
  206. data/lib/mindee/v1/product/resume/resume_v1_professional_experience.rb +122 -0
  207. data/lib/mindee/v1/product/resume/resume_v1_professional_experiences.rb +70 -0
  208. data/lib/mindee/v1/product/resume/resume_v1_social_networks_url.rb +66 -0
  209. data/lib/mindee/v1/product/resume/resume_v1_social_networks_urls.rb +56 -0
  210. data/lib/mindee/v1/product/universal/universal.rb +48 -0
  211. data/lib/mindee/v1/product/universal/universal_document.rb +35 -0
  212. data/lib/mindee/v1/product/universal/universal_page.rb +54 -0
  213. data/lib/mindee/v1/product/universal/universal_prediction.rb +128 -0
  214. data/lib/mindee/v1/product.rb +18 -0
  215. data/lib/mindee/v1.rb +7 -0
  216. data/lib/mindee/v2/client.rb +132 -0
  217. data/lib/mindee/v2/file_operation/crop.rb +51 -0
  218. data/lib/mindee/v2/file_operation/crop_files.rb +25 -0
  219. data/lib/mindee/v2/file_operation/split.rb +37 -0
  220. data/lib/mindee/v2/file_operation/split_files.rb +25 -0
  221. data/lib/mindee/v2/file_operation.rb +6 -0
  222. data/lib/mindee/v2/http/.rubocop.yml +7 -0
  223. data/lib/mindee/v2/http/api_v2_settings.rb +65 -0
  224. data/lib/mindee/v2/http/mindee_api_v2.rb +230 -0
  225. data/lib/mindee/v2/http.rb +4 -0
  226. data/lib/mindee/v2/parsing/base_inference.rb +44 -0
  227. data/lib/mindee/v2/parsing/base_response.rb +15 -0
  228. data/lib/mindee/v2/parsing/common_response.rb +20 -0
  229. data/lib/mindee/v2/parsing/error_item.rb +21 -0
  230. data/lib/mindee/v2/parsing/error_response.rb +51 -0
  231. data/lib/mindee/v2/parsing/field/base_field.rb +63 -0
  232. data/lib/mindee/v2/parsing/field/field_confidence.rb +128 -0
  233. data/lib/mindee/v2/parsing/field/field_location.rb +33 -0
  234. data/lib/mindee/v2/parsing/field/inference_fields.rb +105 -0
  235. data/lib/mindee/v2/parsing/field/list_field.rb +79 -0
  236. data/lib/mindee/v2/parsing/field/object_field.rb +138 -0
  237. data/lib/mindee/v2/parsing/field/simple_field.rb +60 -0
  238. data/lib/mindee/v2/parsing/field.rb +9 -0
  239. data/lib/mindee/v2/parsing/inference_active_options.rb +67 -0
  240. data/lib/mindee/v2/parsing/inference_file.rb +38 -0
  241. data/lib/mindee/v2/parsing/inference_job.rb +25 -0
  242. data/lib/mindee/v2/parsing/inference_model.rb +30 -0
  243. data/lib/mindee/v2/parsing/job.rb +93 -0
  244. data/lib/mindee/v2/parsing/job_response.rb +30 -0
  245. data/lib/mindee/v2/parsing/job_webhook.rb +59 -0
  246. data/lib/mindee/v2/parsing/rag_metadata.rb +17 -0
  247. data/lib/mindee/v2/parsing/raw_text.rb +27 -0
  248. data/lib/mindee/v2/parsing/raw_text_page.rb +24 -0
  249. data/lib/mindee/v2/parsing/search/pagination_metadata.rb +44 -0
  250. data/lib/mindee/v2/parsing/search/search_model.rb +38 -0
  251. data/lib/mindee/v2/parsing/search/search_models.rb +34 -0
  252. data/lib/mindee/v2/parsing/search/search_response.rb +38 -0
  253. data/lib/mindee/v2/parsing/search.rb +6 -0
  254. data/lib/mindee/v2/parsing.rb +16 -0
  255. data/lib/mindee/v2/product/base_product.rb +28 -0
  256. data/lib/mindee/v2/product/classification/classification.rb +20 -0
  257. data/lib/mindee/v2/product/classification/classification_classifier.rb +25 -0
  258. data/lib/mindee/v2/product/classification/classification_inference.rb +35 -0
  259. data/lib/mindee/v2/product/classification/classification_response.rb +32 -0
  260. data/lib/mindee/v2/product/classification/classification_result.rb +27 -0
  261. data/lib/mindee/v2/product/classification/params/classification_parameters.rb +47 -0
  262. data/lib/mindee/v2/product/crop/crop.rb +20 -0
  263. data/lib/mindee/v2/product/crop/crop_inference.rb +34 -0
  264. data/lib/mindee/v2/product/crop/crop_item.rb +39 -0
  265. data/lib/mindee/v2/product/crop/crop_response.rb +40 -0
  266. data/lib/mindee/v2/product/crop/crop_result.rb +34 -0
  267. data/lib/mindee/v2/product/crop/params/crop_parameters.rb +47 -0
  268. data/lib/mindee/v2/product/extraction/extraction.rb +21 -0
  269. data/lib/mindee/v2/product/extraction/extraction_inference.rb +40 -0
  270. data/lib/mindee/v2/product/extraction/extraction_response.rb +32 -0
  271. data/lib/mindee/v2/product/extraction/extraction_result.rb +44 -0
  272. data/lib/mindee/v2/product/extraction/params/data_schema.rb +51 -0
  273. data/lib/mindee/v2/product/extraction/params/data_schema_field.rb +69 -0
  274. data/lib/mindee/v2/product/extraction/params/data_schema_replace.rb +39 -0
  275. data/lib/mindee/v2/product/extraction/params/extraction_parameters.rb +125 -0
  276. data/lib/mindee/v2/product/ocr/ocr.rb +20 -0
  277. data/lib/mindee/v2/product/ocr/ocr_inference.rb +34 -0
  278. data/lib/mindee/v2/product/ocr/ocr_page.rb +33 -0
  279. data/lib/mindee/v2/product/ocr/ocr_response.rb +32 -0
  280. data/lib/mindee/v2/product/ocr/ocr_result.rb +34 -0
  281. data/lib/mindee/v2/product/ocr/ocr_word.rb +29 -0
  282. data/lib/mindee/v2/product/ocr/params/ocr_parameters.rb +47 -0
  283. data/lib/mindee/v2/product/split/params/split_parameters.rb +48 -0
  284. data/lib/mindee/v2/product/split/split.rb +19 -0
  285. data/lib/mindee/v2/product/split/split_inference.rb +34 -0
  286. data/lib/mindee/v2/product/split/split_range.rb +38 -0
  287. data/lib/mindee/v2/product/split/split_response.rb +40 -0
  288. data/lib/mindee/v2/product/split/split_result.rb +34 -0
  289. data/lib/mindee/v2/product.rb +7 -0
  290. data/lib/mindee/v2.rb +7 -0
  291. data/lib/mindee/version.rb +26 -0
  292. data/lib/mindee.rb +135 -0
  293. data/mindee-lite.gemspec +36 -0
  294. data/mindee.gemspec +44 -0
  295. data/sig/custom/marcel.rbs +3 -0
  296. data/sig/custom/mini_magick.rbs +31 -0
  297. data/sig/custom/net_http.rbs +43 -0
  298. data/sig/custom/origami.rbs +59 -0
  299. data/sig/mindee/dependency.rbs +13 -0
  300. data/sig/mindee/error/mindee_error.rbs +13 -0
  301. data/sig/mindee/error/mindee_http_error.rbs +17 -0
  302. data/sig/mindee/error/mindee_http_error_v2.rbs +15 -0
  303. data/sig/mindee/error/mindee_http_unknown_error_v2.rbs +9 -0
  304. data/sig/mindee/error/mindee_input_error.rbs +18 -0
  305. data/sig/mindee/geometry/min_max.rbs +11 -0
  306. data/sig/mindee/geometry/point.rbs +14 -0
  307. data/sig/mindee/geometry/polygon.rbs +12 -0
  308. data/sig/mindee/geometry/quadrilateral.rbs +15 -0
  309. data/sig/mindee/geometry/utils.rbs +13 -0
  310. data/sig/mindee/http/http_error_handler.rbs +15 -0
  311. data/sig/mindee/http/response_validation.rbs +11 -0
  312. data/sig/mindee/image/extracted_image.rbs +21 -0
  313. data/sig/mindee/image/image_compressor.rbs +8 -0
  314. data/sig/mindee/image/image_extractor.rbs +13 -0
  315. data/sig/mindee/image/image_utils.rbs +19 -0
  316. data/sig/mindee/input/base_parameters.rbs +35 -0
  317. data/sig/mindee/input/local_response.rbs +14 -0
  318. data/sig/mindee/input/polling_options.rbs +12 -0
  319. data/sig/mindee/input/sources/base64_input_source.rbs +11 -0
  320. data/sig/mindee/input/sources/bytes_input_source.rbs +10 -0
  321. data/sig/mindee/input/sources/file_input_source.rbs +10 -0
  322. data/sig/mindee/input/sources/local_input_source.rbs +30 -0
  323. data/sig/mindee/input/sources/path_input_source.rbs +10 -0
  324. data/sig/mindee/input/sources/url_input_source.rbs +20 -0
  325. data/sig/mindee/logging/logger.rbs +11 -0
  326. data/sig/mindee/page_options.rbs +11 -0
  327. data/sig/mindee/pdf/extracted_pdf.rbs +17 -0
  328. data/sig/mindee/pdf/pdf_compressor.rbs +15 -0
  329. data/sig/mindee/pdf/pdf_extractor.rbs +19 -0
  330. data/sig/mindee/pdf/pdf_processor.rbs +12 -0
  331. data/sig/mindee/pdf/pdf_tools.rbs +31 -0
  332. data/sig/mindee/v1/client.rbs +84 -0
  333. data/sig/mindee/v1/extraction/multi_receipts_extractor.rbs +8 -0
  334. data/sig/mindee/v1/http/endpoint.rbs +41 -0
  335. data/sig/mindee/v1/http/workflow_endpoint.rbs +22 -0
  336. data/sig/mindee/v1/parsing/common/api_request.rbs +22 -0
  337. data/sig/mindee/v1/parsing/common/api_response.rbs +31 -0
  338. data/sig/mindee/v1/parsing/common/document.rbs +32 -0
  339. data/sig/mindee/v1/parsing/common/execution.rbs +26 -0
  340. data/sig/mindee/v1/parsing/common/execution_file.rbs +16 -0
  341. data/sig/mindee/v1/parsing/common/execution_priority.rbs +16 -0
  342. data/sig/mindee/v1/parsing/common/extras/cropper_extra.rbs +18 -0
  343. data/sig/mindee/v1/parsing/common/extras/extras.rbs +24 -0
  344. data/sig/mindee/v1/parsing/common/extras/full_text_ocr_extra.rbs +22 -0
  345. data/sig/mindee/v1/parsing/common/extras/rag_extra.rbs +19 -0
  346. data/sig/mindee/v1/parsing/common/inference.rbs +31 -0
  347. data/sig/mindee/v1/parsing/common/job.rbs +24 -0
  348. data/sig/mindee/v1/parsing/common/ocr/mvision_v1.rbs +20 -0
  349. data/sig/mindee/v1/parsing/common/ocr/ocr.rbs +56 -0
  350. data/sig/mindee/v1/parsing/common/orientation.rbs +15 -0
  351. data/sig/mindee/v1/parsing/common/page.rbs +19 -0
  352. data/sig/mindee/v1/parsing/common/prediction.rbs +14 -0
  353. data/sig/mindee/v1/parsing/common/product.rbs +16 -0
  354. data/sig/mindee/v1/parsing/common/workflow_response.rbs +22 -0
  355. data/sig/mindee/v1/parsing/standard/abstract_field.rbs +30 -0
  356. data/sig/mindee/v1/parsing/standard/address_field.rbs +28 -0
  357. data/sig/mindee/v1/parsing/standard/amount_field.rbs +16 -0
  358. data/sig/mindee/v1/parsing/standard/base_field.rbs +16 -0
  359. data/sig/mindee/v1/parsing/standard/boolean_field.rbs +16 -0
  360. data/sig/mindee/v1/parsing/standard/classification_field.rbs +12 -0
  361. data/sig/mindee/v1/parsing/standard/company_registration_field.rbs +20 -0
  362. data/sig/mindee/v1/parsing/standard/date_field.rbs +20 -0
  363. data/sig/mindee/v1/parsing/standard/feature_field.rbs +12 -0
  364. data/sig/mindee/v1/parsing/standard/locale_field.rbs +24 -0
  365. data/sig/mindee/v1/parsing/standard/payment_details_field.rbs +19 -0
  366. data/sig/mindee/v1/parsing/standard/position_field.rbs +26 -0
  367. data/sig/mindee/v1/parsing/standard/string_field.rbs +16 -0
  368. data/sig/mindee/v1/parsing/standard/tax_field.rbs +33 -0
  369. data/sig/mindee/v1/parsing/universal/universal_list_field.rbs +21 -0
  370. data/sig/mindee/v1/parsing/universal/universal_object_field.rbs +38 -0
  371. data/sig/mindee/v1/product/barcode_reader/barcode_reader_v1.rbs +13 -0
  372. data/sig/mindee/v1/product/barcode_reader/barcode_reader_v1_document.rbs +16 -0
  373. data/sig/mindee/v1/product/barcode_reader/barcode_reader_v1_page.rbs +17 -0
  374. data/sig/mindee/v1/product/cropper/cropper_v1.rbs +13 -0
  375. data/sig/mindee/v1/product/cropper/cropper_v1_document.rbs +14 -0
  376. data/sig/mindee/v1/product/cropper/cropper_v1_page.rbs +19 -0
  377. data/sig/mindee/v1/product/financial_document/financial_document_v1.rbs +13 -0
  378. data/sig/mindee/v1/product/financial_document/financial_document_v1_document.rbs +49 -0
  379. data/sig/mindee/v1/product/financial_document/financial_document_v1_line_item.rbs +35 -0
  380. data/sig/mindee/v1/product/financial_document/financial_document_v1_line_items.rbs +15 -0
  381. data/sig/mindee/v1/product/financial_document/financial_document_v1_page.rbs +17 -0
  382. data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v1.rbs +15 -0
  383. data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_document.rbs +19 -0
  384. data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_page.rbs +19 -0
  385. data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v2.rbs +15 -0
  386. data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_bban.rbs +25 -0
  387. data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_document.rbs +20 -0
  388. data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_page.rbs +19 -0
  389. data/sig/mindee/v1/product/fr/bank_statement/bank_statement_v2.rbs +15 -0
  390. data/sig/mindee/v1/product/fr/bank_statement/bank_statement_v2_document.rbs +31 -0
  391. data/sig/mindee/v1/product/fr/bank_statement/bank_statement_v2_page.rbs +19 -0
  392. data/sig/mindee/v1/product/fr/bank_statement/bank_statement_v2_transaction.rbs +27 -0
  393. data/sig/mindee/v1/product/fr/bank_statement/bank_statement_v2_transactions.rbs +17 -0
  394. data/sig/mindee/v1/product/fr/id_card/id_card_v1.rbs +15 -0
  395. data/sig/mindee/v1/product/fr/id_card/id_card_v1_document.rbs +26 -0
  396. data/sig/mindee/v1/product/fr/id_card/id_card_v1_page.rbs +20 -0
  397. data/sig/mindee/v1/product/fr/id_card/id_card_v2.rbs +15 -0
  398. data/sig/mindee/v1/product/fr/id_card/id_card_v2_document.rbs +31 -0
  399. data/sig/mindee/v1/product/fr/id_card/id_card_v2_page.rbs +21 -0
  400. data/sig/mindee/v1/product/international_id/international_id_v2.rbs +13 -0
  401. data/sig/mindee/v1/product/international_id/international_id_v2_document.rbs +31 -0
  402. data/sig/mindee/v1/product/international_id/international_id_v2_page.rbs +17 -0
  403. data/sig/mindee/v1/product/invoice/invoice_v4.rbs +13 -0
  404. data/sig/mindee/v1/product/invoice/invoice_v4_document.rbs +45 -0
  405. data/sig/mindee/v1/product/invoice/invoice_v4_line_item.rbs +35 -0
  406. data/sig/mindee/v1/product/invoice/invoice_v4_line_items.rbs +15 -0
  407. data/sig/mindee/v1/product/invoice/invoice_v4_page.rbs +17 -0
  408. data/sig/mindee/v1/product/invoice_splitter/invoice_splitter_v1.rbs +13 -0
  409. data/sig/mindee/v1/product/invoice_splitter/invoice_splitter_v1_document.rbs +17 -0
  410. data/sig/mindee/v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rbs +21 -0
  411. data/sig/mindee/v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rbs +15 -0
  412. data/sig/mindee/v1/product/invoice_splitter/invoice_splitter_v1_page.rbs +17 -0
  413. data/sig/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1.rbs +14 -0
  414. data/sig/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1_document.rbs +15 -0
  415. data/sig/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1_page.rbs +17 -0
  416. data/sig/mindee/v1/product/passport/passport_v1.rbs +13 -0
  417. data/sig/mindee/v1/product/passport/passport_v1_document.rbs +25 -0
  418. data/sig/mindee/v1/product/passport/passport_v1_page.rbs +17 -0
  419. data/sig/mindee/v1/product/receipt/receipt_v5.rbs +13 -0
  420. data/sig/mindee/v1/product/receipt/receipt_v5_document.rbs +33 -0
  421. data/sig/mindee/v1/product/receipt/receipt_v5_line_item.rbs +27 -0
  422. data/sig/mindee/v1/product/receipt/receipt_v5_line_items.rbs +15 -0
  423. data/sig/mindee/v1/product/receipt/receipt_v5_page.rbs +17 -0
  424. data/sig/mindee/v1/product/resume/resume_v1.rbs +13 -0
  425. data/sig/mindee/v1/product/resume/resume_v1_certificate.rbs +27 -0
  426. data/sig/mindee/v1/product/resume/resume_v1_certificates.rbs +17 -0
  427. data/sig/mindee/v1/product/resume/resume_v1_document.rbs +69 -0
  428. data/sig/mindee/v1/product/resume/resume_v1_education.rbs +33 -0
  429. data/sig/mindee/v1/product/resume/resume_v1_educations.rbs +17 -0
  430. data/sig/mindee/v1/product/resume/resume_v1_language.rbs +23 -0
  431. data/sig/mindee/v1/product/resume/resume_v1_languages.rbs +17 -0
  432. data/sig/mindee/v1/product/resume/resume_v1_page.rbs +19 -0
  433. data/sig/mindee/v1/product/resume/resume_v1_professional_experience.rbs +37 -0
  434. data/sig/mindee/v1/product/resume/resume_v1_professional_experiences.rbs +17 -0
  435. data/sig/mindee/v1/product/resume/resume_v1_social_networks_url.rbs +23 -0
  436. data/sig/mindee/v1/product/resume/resume_v1_social_networks_urls.rbs +17 -0
  437. data/sig/mindee/v1/product/universal/universal.rbs +16 -0
  438. data/sig/mindee/v1/product/universal/universal_document.rbs +12 -0
  439. data/sig/mindee/v1/product/universal/universal_page.rbs +18 -0
  440. data/sig/mindee/v1/product/universal/universal_prediction.rbs +30 -0
  441. data/sig/mindee/v2/client.rbs +29 -0
  442. data/sig/mindee/v2/file_operation/crop.rbs +10 -0
  443. data/sig/mindee/v2/file_operation/crop_files.rbs +9 -0
  444. data/sig/mindee/v2/file_operation/split.rbs +11 -0
  445. data/sig/mindee/v2/file_operation/split_files.rbs +9 -0
  446. data/sig/mindee/v2/http/api_v2_settings.rbs +27 -0
  447. data/sig/mindee/v2/http/mindee_api_v2.rbs +52 -0
  448. data/sig/mindee/v2/parsing/base_inference.rbs +18 -0
  449. data/sig/mindee/v2/parsing/base_response.rbs +11 -0
  450. data/sig/mindee/v2/parsing/common_response.rbs +12 -0
  451. data/sig/mindee/v2/parsing/error_item.rbs +13 -0
  452. data/sig/mindee/v2/parsing/error_response.rbs +20 -0
  453. data/sig/mindee/v2/parsing/field/base_field.rbs +17 -0
  454. data/sig/mindee/v2/parsing/field/field_confidence.rbs +30 -0
  455. data/sig/mindee/v2/parsing/field/field_location.rbs +16 -0
  456. data/sig/mindee/v2/parsing/field/inference_fields.rbs +20 -0
  457. data/sig/mindee/v2/parsing/field/list_field.rbs +23 -0
  458. data/sig/mindee/v2/parsing/field/object_field.rbs +27 -0
  459. data/sig/mindee/v2/parsing/field/simple_field.rbs +16 -0
  460. data/sig/mindee/v2/parsing/inference_active_options.rbs +26 -0
  461. data/sig/mindee/v2/parsing/inference_file.rbs +17 -0
  462. data/sig/mindee/v2/parsing/inference_job.rbs +13 -0
  463. data/sig/mindee/v2/parsing/inference_model.rbs +12 -0
  464. data/sig/mindee/v2/parsing/job.rbs +24 -0
  465. data/sig/mindee/v2/parsing/job_response.rbs +14 -0
  466. data/sig/mindee/v2/parsing/job_webhook.rbs +19 -0
  467. data/sig/mindee/v2/parsing/rag_metadata.rbs +13 -0
  468. data/sig/mindee/v2/parsing/raw_text.rbs +12 -0
  469. data/sig/mindee/v2/parsing/raw_text_page.rbs +11 -0
  470. data/sig/mindee/v2/parsing/search/pagination_metadata.rbs +20 -0
  471. data/sig/mindee/v2/parsing/search/search_model.rbs +19 -0
  472. data/sig/mindee/v2/parsing/search/search_response.rbs +17 -0
  473. data/sig/mindee/v2/parsing/search_models.rbs +14 -0
  474. data/sig/mindee/v2/product/base_product.rbs +19 -0
  475. data/sig/mindee/v2/product/classification/classification.rbs +10 -0
  476. data/sig/mindee/v2/product/classification/classification_classifier.rbs +15 -0
  477. data/sig/mindee/v2/product/classification/classification_inference.rbs +15 -0
  478. data/sig/mindee/v2/product/classification/classification_response.rbs +23 -0
  479. data/sig/mindee/v2/product/classification/classification_result.rbs +15 -0
  480. data/sig/mindee/v2/product/classification/params/classification_parameters/classification_parameters.rbs +23 -0
  481. data/sig/mindee/v2/product/crop/crop.rbs +10 -0
  482. data/sig/mindee/v2/product/crop/crop_inference.rbs +14 -0
  483. data/sig/mindee/v2/product/crop/crop_item.rbs +18 -0
  484. data/sig/mindee/v2/product/crop/crop_response.rbs +25 -0
  485. data/sig/mindee/v2/product/crop/crop_result.rbs +14 -0
  486. data/sig/mindee/v2/product/crop/params/crop_parameters/crop_parameters.rbs +23 -0
  487. data/sig/mindee/v2/product/extraction/extraction.rbs +15 -0
  488. data/sig/mindee/v2/product/extraction/extraction_inference.rbs +19 -0
  489. data/sig/mindee/v2/product/extraction/extraction_response.rbs +24 -0
  490. data/sig/mindee/v2/product/extraction/extraction_result.rbs +18 -0
  491. data/sig/mindee/v2/product/extraction/params/data_schema.rbs +21 -0
  492. data/sig/mindee/v2/product/extraction/params/data_schema_field.rbs +29 -0
  493. data/sig/mindee/v2/product/extraction/params/data_schema_replace.rbs +21 -0
  494. data/sig/mindee/v2/product/extraction/params/extraction_parameters.rbs +38 -0
  495. data/sig/mindee/v2/product/ocr/ocr.rbs +10 -0
  496. data/sig/mindee/v2/product/ocr/ocr_inference.rbs +14 -0
  497. data/sig/mindee/v2/product/ocr/ocr_page.rbs +15 -0
  498. data/sig/mindee/v2/product/ocr/ocr_response.rbs +23 -0
  499. data/sig/mindee/v2/product/ocr/ocr_result.rbs +14 -0
  500. data/sig/mindee/v2/product/ocr/ocr_word.rbs +15 -0
  501. data/sig/mindee/v2/product/ocr/params/ocr_parameters/ocr_parameters.rbs +24 -0
  502. data/sig/mindee/v2/product/split/params/split_parameters/split_parameters.rbs +23 -0
  503. data/sig/mindee/v2/product/split/split.rbs +10 -0
  504. data/sig/mindee/v2/product/split/split_inference.rbs +14 -0
  505. data/sig/mindee/v2/product/split/split_range.rbs +18 -0
  506. data/sig/mindee/v2/product/split/split_response.rbs +25 -0
  507. data/sig/mindee/v2/product/split/split_result.rbs +14 -0
  508. data/sig/mindee/version.rbs +6 -0
  509. data/sig/mindee.rbs +62 -0
  510. metadata +600 -0
data/CHANGELOG.md ADDED
@@ -0,0 +1,515 @@
1
+ # Mindee Ruby API Library Changelog
2
+
3
+ ## v5.0.0.beta1 - 2026-04-07
4
+ ### ¡Breaking Changes!
5
+ * :boom: :recycle: update V1 & V2 syntaxes to match other SDKs
6
+ * :recycle: move V1 client to V1 module
7
+ * :recycle: move V2 client to V2 module
8
+ * :recycle: move legacy products to 'V1' module
9
+ * :recycle: add parsing and extraction to v1 module
10
+ * :recycle: move V1 HTTP to V1 module
11
+ * :recycle: move V2 HTTP module to V2 namespace
12
+ * :recycle: move data schema to extraction parameters namespace
13
+ * :arrow_up: :boom: drop support for ruby < 3.2
14
+ * :recycle: :boom: change raw_http attribute in responses to be actual json strings
15
+ * :recycle: :boom: make logging configurable and default output to stderr
16
+ * :recycle: :boom: remove useless `PDFExtractor` module
17
+ * :recycle: :boom: change `Errors` module to `Error`
18
+ * :recycle: :boom: change Ocr modules and classes to OCR to keep consistency
19
+ * :boom: remove support for the following V1 products:
20
+ * :coffin: US Bank Check V1
21
+ * :coffin: Bill of Lading V1
22
+ * :coffin: Business Card V1
23
+ * :coffin: FR Carte Grise V1
24
+ * :coffin: Delivery Notes V1
25
+ * :coffin: Driver License V1
26
+ * :coffin: FR Energy Bill V1
27
+ * :coffin: Nutrition Facts V1
28
+
29
+ ### Changes
30
+ * :sparkles: :arrow_up: add support for mindee-lite gem
31
+ * :sparkles: add support for crop operation
32
+ * :sparkles: add support for split operation
33
+ * :sparkles: add support for model search
34
+ * :sparkles: add support for V2 CLI
35
+ * :wrench: :arrow_up: add better tooling and pre-commit hook
36
+ * :arrow_up: and bump all dependencies
37
+
38
+ ### Fixes
39
+ * :bug: fix webhook IDs not sending properly
40
+ * :bug: fix miscellaneous issues leading to saved `ExtractedPDF` instances having invalid names
41
+ * :recycle: fix miscellaneous typing issues relating to `ExtractedPDF` and `ExtractedImage` classes
42
+
43
+
44
+ ## v4.13.0 - 2026-03-03
45
+ ### Changes
46
+ * :sparkles: add support for V2 Classification product
47
+ * :sparkles: add support for V2 Crop product
48
+ * :sparkles: add support for V2 Ocr product
49
+ * :sparkles: add support for V2 Split product
50
+ * :recycle: make polling follow API urls instead of re-constructing them
51
+ * :sparkles: add support for generic product accessors in V2
52
+ * :recycle: add proper tests for ruby 4
53
+ ### Fixes
54
+ * :recycle: fix tests file paths
55
+
56
+
57
+ ## v4.12.0 - 2026-02-25
58
+ ### Changes
59
+ * :sparkles: add job information to inference
60
+ * :sparkles: add more inference info
61
+
62
+
63
+ ## v4.11.0 - 2026-02-11
64
+ ### Changes
65
+ * :sparkles: add complementary accessors for ObjectField
66
+
67
+
68
+ ## v4.10.1 - 2026-02-05
69
+ ### Fixes
70
+ * :bug: fix NoMethodError in JobWebhook when error is nil (#222) (Co-authored-by: haris_delalic <haris.delalic@datamolino.com>)
71
+
72
+
73
+ ## v4.10.0 - 2025-12-19
74
+ ### Changes
75
+ :sparkles: add support for dataschema parameter
76
+
77
+
78
+ ## v4.9.0 - 2025-12-02
79
+ ### Changes
80
+ * :sparkles: add support for text_context parameter
81
+
82
+
83
+ ## v4.8.0 - 2025-11-18
84
+ ### Changes
85
+ * :sparkles: add support for better errors
86
+ * :sparkles: add support for RAG metadata
87
+ ### Fixes
88
+ * :recycle: harmonize test structure with other libraries
89
+
90
+
91
+ ## v4.7.2 - 2025-10-13
92
+ ### Changes
93
+ * :recycle: harmonize getting page count from a local input source
94
+
95
+
96
+ ## v4.7.1 - 2025-09-19
97
+ ### Fixes
98
+ * :sparkles: add missing `to_s` method on raw_text
99
+
100
+
101
+ ## v4.7.0 - 2025-09-18
102
+ Including RC changes and fixes.
103
+ ### Changes
104
+ * :sparkles: add support for V2 Mindee API
105
+ * :sparkles: add missing accessors for PDF fixing options in `LocalInputSource`
106
+ * :recycle: add many missing internal types
107
+ ### Fixes
108
+ * :recycle: update existing PDF fixing syntax
109
+ * :bug: fix for polygon points not correctly initialized
110
+ * :bug: fix user agent not being able to access version number
111
+ * :bug: fix invalid types for many V1 features
112
+ * :bug: fix V1 errors sometimes having the wrong code
113
+ * :bug: fix many presumably immutable fields having non-readonly parameters
114
+ * :bug: fix broken `resources` accessor in `ApiRequest` object
115
+
116
+
117
+ ## v4.7.0-rc3 - 2025-08-29
118
+ ### Fixes
119
+ * :bug: fix user agent not being able to access version number
120
+
121
+
122
+ ## v4.7.0-rc2 - 2025-08-20
123
+ ### Changes
124
+ * :sparkles: add missing accessors for PDF fixing options in `LocalInputSource`
125
+ ### Fixes
126
+ * :recycle: update existing PDF fixing syntax
127
+ * :memo: fix typos & documentation
128
+
129
+
130
+ ## v4.7.0-rc1 - 2025-08-13
131
+ ### Changes
132
+ * :sparkles: add support for client V2 & associated features
133
+ ### Fixes
134
+ * :recycle: add many missing internal types
135
+ * :bug: fix invalid types for many V1 features
136
+ * :bug: fix V1 errors sometimes having the wrong code
137
+ * :bug: fix many presumably immutable fields having non-readonly parameters
138
+ * :bug: fix broken `resources` accessor in `ApiRequest` object
139
+
140
+
141
+ ## v4.6.0 - 2025-06-03
142
+ ### Changes
143
+ * :sparkles: add support for address fields
144
+
145
+
146
+ ## v4.5.0 - 2025-05-27
147
+ ### Changes
148
+ * :sparkles: add support for Financial Document v1.14
149
+ * :sparkles: add support for US Healthcare Cards v1.3
150
+ * :sparkles: add support for Invoice v4.11
151
+ ### Fixes
152
+ * :recycle: switch to 'Transfer-Encoding: chunked' to prevent Net::HTTP from writing temporary files
153
+
154
+
155
+ ## v4.4.1 - 2025-05-13
156
+ ### Fixes
157
+ * :bug: fix bad option in CLI
158
+ * :bug: don't open the PDF unless needed
159
+
160
+
161
+ ## v4.4.0 - 2025-04-23
162
+ ### Changes
163
+ * :sparkles: add support for workflow polling
164
+ * :sparkles: add extras accessor from inference
165
+ ### Fixes
166
+ * :recycle: fix misc typing issues
167
+ * :bug: fix improper return format for `raw_http`
168
+
169
+
170
+ ## v4.3.0 - 2025-04-08
171
+ ### Changes
172
+ * :sparkles: add support for Financial Document V1.12
173
+ * :sparkles: add support for Invoices V4.10
174
+ * :sparkles: add support for US Healthcare Cards V1.2
175
+
176
+
177
+ ## v4.2.0 - 2025-03-28
178
+ ### Changes
179
+ * :coffin: remove support for US W9
180
+
181
+
182
+ ## v4.1.2 - 2025-03-26
183
+ ### Fixes
184
+ * :wrench: loosen version restrictions on most dependencies
185
+
186
+
187
+ ## v4.1.1 - 2025-03-25
188
+ ### Fixes
189
+ * :wrench: loosen pinning on base64 dependency
190
+
191
+
192
+ ## v4.1.0 - 2025-03-25
193
+ ### Changes
194
+ * :sparkles: bump FR EnergyBillV1 to V1.2 & US HealthcareCardV1 to V1.1
195
+ * :sparkles: restore support for US Mail V2
196
+ * :sparkles: add support for RAG in workflow executions
197
+ ### Fixes
198
+ * :recycle: update CLI syntax for easier product creation
199
+
200
+
201
+ ## v4.0.0 - 2025-02-27
202
+ ### ¡Breaking Changes!
203
+ * :boom: drop support for ruby versions < 3.0
204
+ * :boom: refactor error-handling
205
+ * :boom: merge enqueue_and_parse() into parse()
206
+ * :boom: allow access to page-level extras, even when the page predictions are empty
207
+ * :boom: deprecate CustomV1 & GeneratedV1 in favor of Universal
208
+ ### Changes
209
+ * :sparkles: add support for logging
210
+ * :sparkles: add typing support through RBS
211
+ * :sparkles: add support for multiple feature classes, inheriting from Array
212
+ * :recycle: refactor internal modules
213
+ * :recycle: refactor test module
214
+ * :coffin: remove support for US Mail V2
215
+ * :coffin: remove support for FR Bank Statement V1
216
+ * :recycle: update `UrlInputSource` to `URLInputSource`
217
+ * :memo: update documentation structure
218
+ ### Fixes
219
+ * :bug: fix miscellaneous bugs relating to image extraction
220
+ * :bug: fix miscellaneous bugs relating to pdf extraction
221
+ * :bug: fix improper saving mechanism
222
+
223
+
224
+ ## v3.20.0 - 2025-02-26
225
+ ### Changes
226
+ * :sparkles: add support for FR Banks Statement V2
227
+
228
+
229
+ ## v3.19.1 - 2025-01-21
230
+ ### Changes
231
+ * :bug: fix extras failing at document level if missing from prediction
232
+
233
+
234
+ ## v3.19.0 - 2025-01-14
235
+ ### Changes
236
+ * :sparkles: add support for US Mail V3
237
+ * :recycle: increase async retry timers
238
+
239
+
240
+ ## v3.18.0 - 2024-12-13
241
+ ### Changes
242
+ * :sparkles: allow local downloading of remote sources
243
+ * :coffin: remove support for (FR) Carte Vitale V1 in favor of French Health Card V1
244
+ ### Fixes
245
+ * :bug: fix tax-extraction script
246
+
247
+
248
+ ## v3.17.0 - 2024-11-28
249
+ ### Changes
250
+ * :sparkles: add support for workflows
251
+ * :sparkles: add support for French Health Card V1
252
+ * :sparkles: add support for Driver License V1
253
+ * :sparkles: add support for Payslip FR V3
254
+ * :coffin: remove support for international ID V1
255
+
256
+ ## v3.16.0 - 2024-11-14
257
+ ### Changes
258
+ * :sparkles: add support for business cards V1
259
+ * :sparkles: add support for delivery note V1.1
260
+ * :sparkles: add support for indian passport V1
261
+ * :sparkles: add support for resume V1.1
262
+ ### Fixes
263
+ * :recycle: adjust default values for async delays
264
+
265
+
266
+ ## v3.15.0 - 2024-10-29
267
+ ### Changes
268
+ * :sparkles: add support for image compression
269
+ * :sparkles: add support for PDF compression
270
+ ### Fixes
271
+ * :recycle: refactor pdf & image namespaces
272
+ * :memo: fix rubocop directives unexpectedly appearing in Yard documentation
273
+ * :arrow_up: bump version for mini_magick
274
+
275
+
276
+ ## v3.14.0 - 2024-10-11
277
+ ### Changes
278
+ * :sparkles: add support for Financial Document v1.10
279
+ * :sparkles: add support for Invoice v4.8
280
+ ### Fixes
281
+ * :bug: fix multi-receipts extraction not working as intended
282
+
283
+
284
+ ## v3.13.0 - 2024-09-18
285
+ ### Changes
286
+ * :sparkles: add support for BillOfLadingV1
287
+ * :sparkles: add support for (US) UsMailV2
288
+ * :sparkles: add support for (FR) EnergyBillV1
289
+ * :sparkles: add support for (FR) PayslipV1
290
+ * :sparkles: add support for NutritionFactsLabelV1
291
+ * :sparkles: add support for cropper Extra
292
+ * :sparkles: add support for full text Extra
293
+ * :sparkles: add support for invoice splitter auto-extraction
294
+ ### Fixes
295
+ * :bug: fixed a bug that prevented longer decimals from appearing in the string representation of some objects
296
+ * :bug: fixed a bug that caused non-table elements to unexpectedly appear truncated when printed to the console
297
+ * :memo: fix a few documentation errors & typos
298
+ * :wrench: updated CI dependencies
299
+
300
+
301
+ ## v3.12.0 - 2024-07-24
302
+ ### Changes
303
+ * :sparkles: add support for Multi-Receipts Extraction
304
+ * :sparkles: add support for Healthcare Card V1
305
+ * :sparkles: add support for Invoice V4.7
306
+ * :sparkles: add support for Financial Document V1.9
307
+ * :recycle: update display for company registration fields
308
+
309
+
310
+ ## v3.11.0 - 2024-06-10
311
+ ### Changes
312
+ * :sparkles: add custom tax extraction feature (#76)
313
+
314
+
315
+ ## v3.10.0 - 2024-05-31
316
+ ### Changes
317
+ * :sparkles: add support for us mail v2 (#98)
318
+ * :sparkles: add support for boolean fields
319
+ * :sparkles: add support for webhooks (#97)
320
+ ### Fixes
321
+ * :recycle: tweak display for LocaleField
322
+
323
+
324
+ ## v3.9.0 - 2024-05-16
325
+ ### Changes
326
+ * :sparkles: update financial document to v1.7 & receipts to v5.2
327
+
328
+
329
+ ## v3.8.0 - 2024-05-02
330
+ ### Changes
331
+ * :recycle: update products to newer syntax
332
+ * :sparkles: update financial document to v1.6 & invoice to v4.6
333
+
334
+
335
+ ## v3.7.0 - 2024-03-28
336
+ ### Changes
337
+ * :sparkles: update Invoice to v4.5
338
+ ### Fixes
339
+ * :bug: fix invalid error codes
340
+
341
+
342
+ ## v3.6.1 - 2024-03-07
343
+ ### Changes
344
+ * :recycle: update error handling to account for future evolutions
345
+ * :memo: update miscellaneous product documentations
346
+ * :memo: add used environment variables to readme
347
+
348
+
349
+ ## v3.6.0 - 2024-02-21
350
+ ### Changes
351
+ * :sparkles: add support for resume V1
352
+
353
+
354
+ ## v3.5.0 - 2024-02-16
355
+ ### Changes
356
+ * :sparkles: add support for Generated V1 API
357
+ * :recycle: documents now aren't automatically converted to b64 when enqueued as non-PDF files
358
+ * :recycle: increase max async delay to 60 tries
359
+ * :sparkles: add support for FR bank statements
360
+ * :sparkles: add support for International ID V2
361
+ * :sparkles: add support for EU Driver License V1
362
+ * :recycle: update existing products
363
+ * :arrow_up: upgrade test lib
364
+ ### Fixes
365
+ * :memo: add missing default async sample code
366
+ * :bug: fix rst display issues
367
+ * :bug: fix display issues for single page models
368
+ * :bug: fix miscellaneous issues related to data display (no changes expected on existing models)
369
+ * :bug: fix CLI breaking for custom products
370
+ * :bug: fix encoding issue that prevented UNICODE file names from being properly sent to the server
371
+
372
+
373
+ ## v3.4.0 - 2024-01-30
374
+ ### Changes
375
+ * :arrow_up: update invoices to v4.4
376
+ * :sparkles: add support for `raw_value` in string fields
377
+
378
+
379
+ ## v3.3.1 - 2023-12-15
380
+ ### Changes
381
+ * :recycle: tweak async delays & retry
382
+ * :recycle: tweak default async sample delays & retry
383
+ * :memo: update md doc & fix typos
384
+
385
+
386
+ ## v3.3.0 - 2023-11-17
387
+ ### Changes
388
+ * :sparkles: add support for Carte Grise V1
389
+ * :sparkles: add page number attributes to doc
390
+ * :arrow_up: update tests, docs & display format for some products
391
+ ### Fixes
392
+ * :bug: fix page id not working on newer custom models
393
+
394
+
395
+ ## v3.2.0 - 2023-09-15
396
+ ### Changes
397
+ * :sparkles: add support for Multi Receipts Detector V1
398
+ * :sparkles: add support for Barcode Reader V1
399
+ * :sparkles: add support for W9 V1
400
+ * :sparkles: add support for FR ID Card V2
401
+ * :sparkles: add support for async in CLI
402
+ * :sparkles: add support for async auto-polling
403
+ * :sparkles: add direct access to `raw_http` response
404
+ * :memo: upgrade reference & guide documentation
405
+ * :test_tube: **EXPERIMENTAL** add PDF repair option
406
+ ### Fixes
407
+ * :bug: fix display issues with `PositionField`
408
+
409
+
410
+ ## v3.1.1 - 2023-08-10
411
+ ### Fixes
412
+ * :bug: fixed non-pdf files being improperly handled by Ruby requests
413
+
414
+
415
+ ## v3.1.0 - 2023-08-08
416
+ ### Changes
417
+ * :sparkles: add support for US Driver License
418
+ * :recycle: update unit tests & dependencies
419
+ * :arrow_up: update Bank Checks (#46)
420
+ ### Fixes
421
+ * :bug: fix `all_words` display (#47)
422
+ * :bug: fix empty `position_field` (#47)
423
+ * :bug: fix byte repacking issues for PDF files (#45)
424
+
425
+
426
+ ## v3.0.0 - 2023-06-29
427
+ ### ¡Breaking Changes!
428
+ * :boom: update `Client` creation & document upload
429
+ * :boom: update custom `Endpoint` creation syntax
430
+ * :art: improve product class syntax & structure
431
+ * :recycle: harmonize naming with other client libraries
432
+ * :art: moved most parsing modules into their own respective modules
433
+ * :art: separated common, standard & custom parsing features into their own modules
434
+ ### Changes
435
+ * :sparkles: add support for asynchronous endpoints
436
+ * :sparkles: add support for Invoice Splitter V1
437
+ * :sparkles: add support for OCR Full-text parsing on compatible APIs
438
+ * :sparkles: add support for FR Bank Account Details V2
439
+ * :sparkles: allow for the implementation of pages to differ from main document
440
+ * :sparkles: add url input source
441
+ * :coffin: remove Shipping Containers
442
+ * :recycle: moved all products into the `Product` module (from `Parsing`)
443
+ * :recycle: better implementation of geometric operations
444
+ * :pencil2: document all previously non-documented class
445
+ * :recycle: match file hierarchy with module nesting
446
+ * :recycle: rewrite tutorials to match new syntax
447
+ ### Fixes
448
+ * :bug: fix: pages now use the proper `orientation` property
449
+ * :zap: optimize: only a single endpoint is now created on document upload
450
+
451
+
452
+ ## v2.2.1 - 2023-05-22
453
+ ### Fixes
454
+ * :bug: added base attribute to tax field
455
+
456
+
457
+ ## v2.2.0 - 2023-05-16
458
+ ### Changes
459
+ * :sparkles: add support for Receipts v5
460
+ * :pushpin: more specific dependency pinning; update some dependencies
461
+
462
+
463
+ ## v2.1.1 - 2023-04-21
464
+ ### Changes
465
+ * :memo: minor docstring improvements
466
+ * :coffin: remove redundant local checks
467
+ * :memo: publish documentation
468
+ * :memo: add code samples
469
+
470
+
471
+ ## v2.1.0 - 2023-01-30
472
+ ### Changes
473
+ * :sparkles: Add financial document v1 support (Co-authored-by: Oriol Gual)
474
+ * :sparkles: Add Proof of Address v1 support
475
+
476
+
477
+ ## v2.0.0 - 2023-01-13
478
+ ### ¡Breaking Changes!
479
+ * :sparkles: add improved PDF merge system
480
+ * :boom: it should be up to the user to handle API errors
481
+ * :wastebasket: remove deprecated APIs
482
+ * :recycle: refactor CLI tool
483
+ ### Changes
484
+ * :sparkles: add support for Invoice v4.1 and Receipt v4.1
485
+ * :sparkles: add EU license plates
486
+ * :sparkles: add shipping containers support
487
+ * :sparkles: add US bank check support
488
+ * :sparkles: add all French documents
489
+ * :memo: Add YARD for generating docs
490
+ * :white_check_mark: add testing on Ruby 3.2
491
+ * :sparkles: allow setting the request timeout from env
492
+
493
+
494
+ ## v1.2.0 - 2022-12-26
495
+ ### Changes
496
+ * :arrow_up: switch to origamindee => adds support for Ruby 3
497
+
498
+
499
+ ## v1.1.2 - 2022-12-23
500
+ ### Changes
501
+ * :recycle: use of `append_page` is better for adding pages to a new PDF
502
+
503
+
504
+ ## v1.1.1 - 2022-08-08
505
+ ### Fixes
506
+ * :bug: Fix for missing attribute accessor
507
+
508
+
509
+ ## v1.1.0 - 2022-08-04
510
+ ### Changes
511
+ * :sparkles: Add support for custom API classification field (#5)
512
+
513
+
514
+ ## v1.0.0 - 2022-07-28
515
+ * :tada: First release!
@@ -0,0 +1,129 @@
1
+
2
+ # Contributor Covenant Code of Conduct
3
+
4
+ ## Our Pledge
5
+
6
+ We as members, contributors, and leaders pledge to make participation in our
7
+ community a harassment-free experience for everyone, regardless of age, body
8
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
9
+ identity and expression, level of experience, education, socio-economic status,
10
+ nationality, personal appearance, race, religion, or sexual identity
11
+ and orientation.
12
+
13
+ We pledge to act and interact in ways that contribute to an open, welcoming,
14
+ diverse, inclusive, and healthy community.
15
+
16
+ ## Our Standards
17
+
18
+ Examples of behavior that contributes to a positive environment for our
19
+ community include:
20
+
21
+ * Demonstrating empathy and kindness toward other people
22
+ * Being respectful of differing opinions, viewpoints, and experiences
23
+ * Giving and gracefully accepting constructive feedback
24
+ * Accepting responsibility and apologizing to those affected by our mistakes,
25
+ and learning from the experience
26
+ * Focusing on what is best not just for us as individuals, but for the
27
+ overall community
28
+
29
+ Examples of unacceptable behavior include:
30
+
31
+ * The use of sexualized language or imagery, and sexual attention or
32
+ advances of any kind
33
+ * Trolling, insulting or derogatory comments, and personal or political attacks
34
+ * Public or private harassment
35
+ * Publishing others' private information, such as a physical or email
36
+ address, without their explicit permission
37
+ * Other conduct which could reasonably be considered inappropriate in a
38
+ professional setting
39
+
40
+ ## Enforcement Responsibilities
41
+
42
+ Community leaders are responsible for clarifying and enforcing our standards of
43
+ acceptable behavior and will take appropriate and fair corrective action in
44
+ response to any behavior that they deem inappropriate, threatening, offensive,
45
+ or harmful.
46
+
47
+ Community leaders have the right and responsibility to remove, edit, or reject
48
+ comments, commits, code, wiki edits, issues, and other contributions that are
49
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
50
+ decisions when appropriate.
51
+
52
+ ## Scope
53
+
54
+ This Code of Conduct applies within all community spaces, and also applies when
55
+ an individual is officially representing the community in public spaces.
56
+ Examples of representing our community include using an official e-mail address,
57
+ posting via an official social media account, or acting as an appointed
58
+ representative at an online or offline event.
59
+
60
+ ## Enforcement
61
+
62
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
63
+ reported to the community leaders responsible for enforcement at
64
+ [INSERT CONTACT METHOD].
65
+ All complaints will be reviewed and investigated promptly and fairly.
66
+
67
+ All community leaders are obligated to respect the privacy and security of the
68
+ reporter of any incident.
69
+
70
+ ## Enforcement Guidelines
71
+
72
+ Community leaders will follow these Community Impact Guidelines in determining
73
+ the consequences for any action they deem in violation of this Code of Conduct:
74
+
75
+ ### 1. Correction
76
+
77
+ **Community Impact**: Use of inappropriate language or other behavior deemed
78
+ unprofessional or unwelcome in the community.
79
+
80
+ **Consequence**: A private, written warning from community leaders, providing
81
+ clarity around the nature of the violation and an explanation of why the
82
+ behavior was inappropriate. A public apology may be requested.
83
+
84
+ ### 2. Warning
85
+
86
+ **Community Impact**: A violation through a single incident or series
87
+ of actions.
88
+
89
+ **Consequence**: A warning with consequences for continued behavior. No
90
+ interaction with the people involved, including unsolicited interaction with
91
+ those enforcing the Code of Conduct, for a specified period of time. This
92
+ includes avoiding interactions in community spaces as well as external channels
93
+ like social media. Violating these terms may lead to a temporary or
94
+ permanent ban.
95
+
96
+ ### 3. Temporary Ban
97
+
98
+ **Community Impact**: A serious violation of community standards, including
99
+ sustained inappropriate behavior.
100
+
101
+ **Consequence**: A temporary ban from any sort of interaction or public
102
+ communication with the community for a specified period of time. No public or
103
+ private interaction with the people involved, including unsolicited interaction
104
+ with those enforcing the Code of Conduct, is allowed during this period.
105
+ Violating these terms may lead to a permanent ban.
106
+
107
+ ### 4. Permanent Ban
108
+
109
+ **Community Impact**: Demonstrating a pattern of violation of community
110
+ standards, including sustained inappropriate behavior, harassment of an
111
+ individual, or aggression toward or disparagement of classes of individuals.
112
+
113
+ **Consequence**: A permanent ban from any sort of public interaction within
114
+ the community.
115
+
116
+ ## Attribution
117
+
118
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119
+ version 2.0, available at
120
+ https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121
+
122
+ Community Impact Guidelines were inspired by [Mozilla's code of conduct
123
+ enforcement ladder](https://github.com/mozilla/diversity).
124
+
125
+ [homepage]: https://www.contributor-covenant.org
126
+
127
+ For answers to common questions about this code of conduct, see the FAQ at
128
+ https://www.contributor-covenant.org/faq. Translations are available at
129
+ https://www.contributor-covenant.org/translations.