mindee 4.5.0 → 4.7.0.pre.rc1

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 (316) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +17 -0
  3. data/README.md +21 -222
  4. data/docs/code_samples/default_v2.txt +28 -0
  5. data/docs/global_products/financial_document_v1.md +19 -4
  6. data/docs/global_products/invoices_v4.md +19 -4
  7. data/lib/mindee/client.rb +11 -30
  8. data/lib/mindee/client_v2.rb +109 -0
  9. data/lib/mindee/errors/mindee_http_error_v2.rb +26 -0
  10. data/lib/mindee/errors.rb +1 -0
  11. data/lib/mindee/geometry/point.rb +2 -2
  12. data/lib/mindee/geometry/quadrilateral.rb +4 -4
  13. data/lib/mindee/geometry/utils.rb +1 -0
  14. data/lib/mindee/http/api_settings_v2.rb +61 -0
  15. data/lib/mindee/http/endpoint.rb +12 -6
  16. data/lib/mindee/http/http_error_handler.rb +17 -4
  17. data/lib/mindee/http/mindee_api_v2.rb +148 -0
  18. data/lib/mindee/http/response_validation.rb +20 -1
  19. data/lib/mindee/http/workflow_endpoint.rb +2 -2
  20. data/lib/mindee/http.rb +2 -0
  21. data/lib/mindee/image/extracted_image.rb +1 -1
  22. data/lib/mindee/image/image_extractor.rb +10 -10
  23. data/lib/mindee/input/inference_parameters.rb +116 -0
  24. data/lib/mindee/input/local_response.rb +10 -1
  25. data/lib/mindee/input/polling_options.rb +26 -0
  26. data/lib/mindee/input/sources/base64_input_source.rb +2 -2
  27. data/lib/mindee/input/sources/local_input_source.rb +19 -12
  28. data/lib/mindee/input.rb +2 -0
  29. data/lib/mindee/page_options.rb +24 -0
  30. data/lib/mindee/parsing/common/api_request.rb +2 -2
  31. data/lib/mindee/parsing/common/api_response.rb +4 -0
  32. data/lib/mindee/parsing/common/execution.rb +1 -1
  33. data/lib/mindee/parsing/common/extras/extras.rb +2 -2
  34. data/lib/mindee/parsing/common/extras/rag_extra.rb +2 -0
  35. data/lib/mindee/parsing/common/inference.rb +1 -1
  36. data/lib/mindee/parsing/common/ocr/ocr.rb +4 -6
  37. data/lib/mindee/parsing/common/orientation.rb +2 -2
  38. data/lib/mindee/parsing/common/product.rb +6 -1
  39. data/lib/mindee/parsing/standard/address_field.rb +49 -0
  40. data/lib/mindee/parsing/standard/amount_field.rb +2 -2
  41. data/lib/mindee/parsing/standard/feature_field.rb +1 -1
  42. data/lib/mindee/parsing/standard/tax_field.rb +1 -1
  43. data/lib/mindee/parsing/standard.rb +1 -0
  44. data/lib/mindee/parsing/universal/universal_list_field.rb +2 -2
  45. data/lib/mindee/parsing/universal/universal_object_field.rb +7 -4
  46. data/lib/mindee/parsing/v2/common_response.rb +18 -0
  47. data/lib/mindee/parsing/v2/error_response.rb +36 -0
  48. data/lib/mindee/parsing/v2/field/base_field.rb +60 -0
  49. data/lib/mindee/parsing/v2/field/field_confidence.rb +91 -0
  50. data/lib/mindee/parsing/v2/field/field_location.rb +36 -0
  51. data/lib/mindee/parsing/v2/field/inference_fields.rb +96 -0
  52. data/lib/mindee/parsing/v2/field/list_field.rb +88 -0
  53. data/lib/mindee/parsing/v2/field/object_field.rb +102 -0
  54. data/lib/mindee/parsing/v2/field/simple_field.rb +56 -0
  55. data/lib/mindee/parsing/v2/field.rb +9 -0
  56. data/lib/mindee/parsing/v2/inference.rb +50 -0
  57. data/lib/mindee/parsing/v2/inference_file.rb +38 -0
  58. data/lib/mindee/parsing/v2/inference_model.rb +18 -0
  59. data/lib/mindee/parsing/v2/inference_response.rb +30 -0
  60. data/lib/mindee/parsing/v2/inference_result.rb +49 -0
  61. data/lib/mindee/parsing/v2/inference_result_options.rb +21 -0
  62. data/lib/mindee/parsing/v2/job.rb +86 -0
  63. data/lib/mindee/parsing/v2/job_response.rb +30 -0
  64. data/lib/mindee/parsing/v2/job_webhook.rb +60 -0
  65. data/lib/mindee/parsing/v2/raw_text.rb +21 -0
  66. data/lib/mindee/parsing/v2.rb +15 -0
  67. data/lib/mindee/pdf/extracted_pdf.rb +5 -3
  68. data/lib/mindee/pdf/pdf_extractor.rb +11 -7
  69. data/lib/mindee/pdf/pdf_processor.rb +6 -6
  70. data/lib/mindee/pdf/pdf_tools.rb +4 -2
  71. data/lib/mindee/product/financial_document/financial_document_v1_document.rb +8 -8
  72. data/lib/mindee/product/invoice/invoice_v4_document.rb +8 -8
  73. data/lib/mindee/product/universal/universal_prediction.rb +4 -4
  74. data/lib/mindee/version.rb +2 -2
  75. data/lib/mindee.rb +6 -0
  76. data/mindee.gemspec +1 -1
  77. data/sig/custom/mini_magick.rbs +14 -7
  78. data/sig/custom/net_http.rbs +4 -4
  79. data/sig/custom/origami.rbs +9 -4
  80. data/sig/mindee/client.rbs +14 -19
  81. data/sig/mindee/client_v2.rbs +17 -0
  82. data/sig/mindee/errors/mindee_http_error.rbs +6 -5
  83. data/sig/mindee/errors/mindee_http_error_v2.rbs +12 -0
  84. data/sig/mindee/errors/mindee_input_error.rbs +3 -2
  85. data/sig/mindee/geometry/min_max.rbs +4 -3
  86. data/sig/mindee/geometry/point.rbs +5 -6
  87. data/sig/mindee/geometry/polygon.rbs +3 -3
  88. data/sig/mindee/geometry/quadrilateral.rbs +5 -8
  89. data/sig/mindee/geometry/utils.rbs +8 -8
  90. data/sig/mindee/http/api_settings_v2.rbs +23 -0
  91. data/sig/mindee/http/endpoint.rbs +12 -11
  92. data/sig/mindee/http/http_error_handler.rbs +8 -3
  93. data/sig/mindee/http/mindee_api_v2.rbs +18 -0
  94. data/sig/mindee/http/response_validation.rbs +1 -0
  95. data/sig/mindee/http/workflow_endpoint.rbs +1 -1
  96. data/sig/mindee/image/extracted_image.rbs +2 -2
  97. data/sig/mindee/image/image_compressor.rbs +1 -1
  98. data/sig/mindee/image/image_extractor.rbs +5 -5
  99. data/sig/mindee/image/image_utils.rbs +10 -10
  100. data/sig/mindee/input/inference_parameters.rbs +30 -0
  101. data/sig/mindee/input/local_response.rbs +6 -5
  102. data/sig/mindee/input/polling_options.rbs +12 -0
  103. data/sig/mindee/input/sources/base64_input_source.rbs +1 -1
  104. data/sig/mindee/input/sources/local_input_source.rbs +10 -7
  105. data/sig/mindee/input/sources/url_input_source.rbs +1 -1
  106. data/sig/mindee/logging/logger.rbs +2 -0
  107. data/sig/mindee/page_options.rbs +11 -0
  108. data/sig/mindee/parsing/common/api_request.rbs +6 -6
  109. data/sig/mindee/parsing/common/api_response.rbs +2 -2
  110. data/sig/mindee/parsing/common/document.rbs +10 -10
  111. data/sig/mindee/parsing/common/execution.rbs +15 -14
  112. data/sig/mindee/parsing/common/execution_file.rbs +3 -3
  113. data/sig/mindee/parsing/common/extras/cropper_extra.rbs +3 -2
  114. data/sig/mindee/parsing/common/extras/extras.rbs +6 -5
  115. data/sig/mindee/parsing/common/extras/full_text_ocr_extra.rbs +2 -1
  116. data/sig/mindee/parsing/common/inference.rbs +16 -9
  117. data/sig/mindee/parsing/common/job.rbs +2 -2
  118. data/sig/mindee/parsing/common/ocr/mvision_v1.rbs +2 -2
  119. data/sig/mindee/parsing/common/ocr/ocr.rbs +22 -20
  120. data/sig/mindee/parsing/common/orientation.rbs +4 -3
  121. data/sig/mindee/parsing/common/page.rbs +6 -5
  122. data/sig/mindee/parsing/common/product.rbs +4 -4
  123. data/sig/mindee/parsing/common/workflow_response.rbs +8 -4
  124. data/sig/mindee/parsing/standard/abstract_field.rbs +1 -1
  125. data/sig/mindee/parsing/standard/address_field.rbs +18 -0
  126. data/sig/mindee/parsing/standard/amount_field.rbs +6 -4
  127. data/sig/mindee/parsing/standard/base_field.rbs +1 -1
  128. data/sig/mindee/parsing/standard/boolean_field.rbs +1 -1
  129. data/sig/mindee/parsing/standard/company_registration_field.rbs +3 -2
  130. data/sig/mindee/parsing/standard/date_field.rbs +6 -6
  131. data/sig/mindee/parsing/standard/locale_field.rbs +1 -1
  132. data/sig/mindee/parsing/standard/payment_details_field.rbs +7 -6
  133. data/sig/mindee/parsing/standard/position_field.rbs +2 -2
  134. data/sig/mindee/parsing/standard/string_field.rbs +1 -1
  135. data/sig/mindee/parsing/standard/tax_field.rbs +8 -7
  136. data/sig/mindee/parsing/universal/universal_list_field.rbs +4 -5
  137. data/sig/mindee/parsing/universal/universal_object_field.rbs +17 -11
  138. data/sig/mindee/parsing/v2/common_response.rbs +11 -0
  139. data/sig/mindee/parsing/v2/error_response.rbs +16 -0
  140. data/sig/mindee/parsing/v2/field/base_field.rbs +17 -0
  141. data/sig/mindee/parsing/v2/field/field_confidence.rbs +27 -0
  142. data/sig/mindee/parsing/v2/field/field_location.rbs +16 -0
  143. data/sig/mindee/parsing/v2/field/inference_fields.rbs +19 -0
  144. data/sig/mindee/parsing/v2/field/list_field.rbs +22 -0
  145. data/sig/mindee/parsing/v2/field/object_field.rbs +21 -0
  146. data/sig/mindee/parsing/v2/field/simple_field.rbs +16 -0
  147. data/sig/mindee/parsing/v2/inference.rbs +16 -0
  148. data/sig/mindee/parsing/v2/inference_file.rbs +15 -0
  149. data/sig/mindee/parsing/v2/inference_model.rbs +11 -0
  150. data/sig/mindee/parsing/v2/inference_response.rbs +12 -0
  151. data/sig/mindee/parsing/v2/inference_result.rbs +13 -0
  152. data/sig/mindee/parsing/v2/inference_result_options.rbs +11 -0
  153. data/sig/mindee/parsing/v2/job.rbs +22 -0
  154. data/sig/mindee/parsing/v2/job_response.rbs +12 -0
  155. data/sig/mindee/parsing/v2/job_webhook.rbs +17 -0
  156. data/sig/mindee/parsing/v2/raw_text.rbs +12 -0
  157. data/sig/mindee/pdf/extracted_pdf.rbs +6 -6
  158. data/sig/mindee/pdf/pdf_compressor.rbs +4 -4
  159. data/sig/mindee/pdf/pdf_extractor.rbs +8 -7
  160. data/sig/mindee/pdf/pdf_processor.rbs +4 -4
  161. data/sig/mindee/pdf/pdf_tools.rbs +22 -16
  162. data/sig/mindee/product/barcode_reader/barcode_reader_v1.rbs +1 -1
  163. data/sig/mindee/product/barcode_reader/barcode_reader_v1_document.rbs +1 -1
  164. data/sig/mindee/product/barcode_reader/barcode_reader_v1_page.rbs +2 -2
  165. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1.rbs +1 -1
  166. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier.rbs +2 -2
  167. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_item.rbs +3 -3
  168. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_consignee.rbs +2 -2
  169. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_document.rbs +1 -1
  170. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_notify_party.rbs +2 -2
  171. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_page.rbs +2 -2
  172. data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_shipper.rbs +2 -2
  173. data/sig/mindee/product/business_card/business_card_v1.rbs +1 -1
  174. data/sig/mindee/product/business_card/business_card_v1_document.rbs +1 -1
  175. data/sig/mindee/product/business_card/business_card_v1_page.rbs +2 -2
  176. data/sig/mindee/product/cropper/cropper_v1.rbs +1 -1
  177. data/sig/mindee/product/cropper/cropper_v1_document.rbs +1 -1
  178. data/sig/mindee/product/cropper/cropper_v1_page.rbs +2 -2
  179. data/sig/mindee/product/delivery_note/delivery_note_v1.rbs +1 -1
  180. data/sig/mindee/product/delivery_note/delivery_note_v1_document.rbs +1 -1
  181. data/sig/mindee/product/delivery_note/delivery_note_v1_page.rbs +2 -2
  182. data/sig/mindee/product/driver_license/driver_license_v1.rbs +1 -1
  183. data/sig/mindee/product/driver_license/driver_license_v1_document.rbs +1 -1
  184. data/sig/mindee/product/driver_license/driver_license_v1_page.rbs +2 -2
  185. data/sig/mindee/product/financial_document/financial_document_v1.rbs +1 -1
  186. data/sig/mindee/product/financial_document/financial_document_v1_document.rbs +5 -5
  187. data/sig/mindee/product/financial_document/financial_document_v1_line_item.rbs +3 -3
  188. data/sig/mindee/product/financial_document/financial_document_v1_page.rbs +2 -2
  189. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v1.rbs +1 -1
  190. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v1_document.rbs +1 -1
  191. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v1_page.rbs +2 -2
  192. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2.rbs +1 -1
  193. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rbs +2 -2
  194. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rbs +1 -1
  195. data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rbs +2 -2
  196. data/sig/mindee/product/fr/bank_statement/bank_statement_v2.rbs +1 -1
  197. data/sig/mindee/product/fr/bank_statement/bank_statement_v2_document.rbs +1 -1
  198. data/sig/mindee/product/fr/bank_statement/bank_statement_v2_page.rbs +2 -2
  199. data/sig/mindee/product/fr/bank_statement/bank_statement_v2_transaction.rbs +3 -3
  200. data/sig/mindee/product/fr/carte_grise/carte_grise_v1.rbs +1 -1
  201. data/sig/mindee/product/fr/carte_grise/carte_grise_v1_document.rbs +1 -1
  202. data/sig/mindee/product/fr/carte_grise/carte_grise_v1_page.rbs +2 -2
  203. data/sig/mindee/product/fr/energy_bill/energy_bill_v1.rbs +1 -1
  204. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_document.rbs +1 -1
  205. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_consumer.rbs +2 -2
  206. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_supplier.rbs +2 -2
  207. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_usage.rbs +3 -3
  208. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_meter_detail.rbs +2 -2
  209. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_page.rbs +2 -2
  210. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_subscription.rbs +3 -3
  211. data/sig/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contribution.rbs +3 -3
  212. data/sig/mindee/product/fr/health_card/health_card_v1.rbs +1 -1
  213. data/sig/mindee/product/fr/health_card/health_card_v1_document.rbs +1 -1
  214. data/sig/mindee/product/fr/health_card/health_card_v1_page.rbs +2 -2
  215. data/sig/mindee/product/fr/id_card/id_card_v1.rbs +1 -1
  216. data/sig/mindee/product/fr/id_card/id_card_v1_document.rbs +1 -1
  217. data/sig/mindee/product/fr/id_card/id_card_v1_page.rbs +2 -2
  218. data/sig/mindee/product/fr/id_card/id_card_v2.rbs +1 -1
  219. data/sig/mindee/product/fr/id_card/id_card_v2_document.rbs +1 -1
  220. data/sig/mindee/product/fr/id_card/id_card_v2_page.rbs +2 -2
  221. data/sig/mindee/product/fr/payslip/payslip_v2.rbs +1 -1
  222. data/sig/mindee/product/fr/payslip/payslip_v2_bank_account_detail.rbs +2 -2
  223. data/sig/mindee/product/fr/payslip/payslip_v2_document.rbs +1 -1
  224. data/sig/mindee/product/fr/payslip/payslip_v2_employee.rbs +2 -2
  225. data/sig/mindee/product/fr/payslip/payslip_v2_employer.rbs +2 -2
  226. data/sig/mindee/product/fr/payslip/payslip_v2_employment.rbs +2 -2
  227. data/sig/mindee/product/fr/payslip/payslip_v2_page.rbs +2 -2
  228. data/sig/mindee/product/fr/payslip/payslip_v2_pay_detail.rbs +2 -2
  229. data/sig/mindee/product/fr/payslip/payslip_v2_pay_period.rbs +2 -2
  230. data/sig/mindee/product/fr/payslip/payslip_v2_pto.rbs +2 -2
  231. data/sig/mindee/product/fr/payslip/payslip_v2_salary_detail.rbs +3 -3
  232. data/sig/mindee/product/fr/payslip/payslip_v3.rbs +1 -1
  233. data/sig/mindee/product/fr/payslip/payslip_v3_bank_account_detail.rbs +2 -2
  234. data/sig/mindee/product/fr/payslip/payslip_v3_document.rbs +1 -1
  235. data/sig/mindee/product/fr/payslip/payslip_v3_employee.rbs +2 -2
  236. data/sig/mindee/product/fr/payslip/payslip_v3_employer.rbs +2 -2
  237. data/sig/mindee/product/fr/payslip/payslip_v3_employment.rbs +2 -2
  238. data/sig/mindee/product/fr/payslip/payslip_v3_page.rbs +2 -2
  239. data/sig/mindee/product/fr/payslip/payslip_v3_paid_time_off.rbs +3 -3
  240. data/sig/mindee/product/fr/payslip/payslip_v3_pay_detail.rbs +2 -2
  241. data/sig/mindee/product/fr/payslip/payslip_v3_pay_period.rbs +2 -2
  242. data/sig/mindee/product/fr/payslip/payslip_v3_salary_detail.rbs +3 -3
  243. data/sig/mindee/product/ind/indian_passport/indian_passport_v1.rbs +1 -1
  244. data/sig/mindee/product/ind/indian_passport/indian_passport_v1_document.rbs +1 -1
  245. data/sig/mindee/product/ind/indian_passport/indian_passport_v1_page.rbs +2 -2
  246. data/sig/mindee/product/international_id/international_id_v2.rbs +1 -1
  247. data/sig/mindee/product/international_id/international_id_v2_document.rbs +1 -1
  248. data/sig/mindee/product/international_id/international_id_v2_page.rbs +2 -2
  249. data/sig/mindee/product/invoice/invoice_v4.rbs +1 -1
  250. data/sig/mindee/product/invoice/invoice_v4_document.rbs +5 -5
  251. data/sig/mindee/product/invoice/invoice_v4_line_item.rbs +3 -3
  252. data/sig/mindee/product/invoice/invoice_v4_page.rbs +2 -2
  253. data/sig/mindee/product/invoice_splitter/invoice_splitter_v1.rbs +1 -1
  254. data/sig/mindee/product/invoice_splitter/invoice_splitter_v1_document.rbs +1 -1
  255. data/sig/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rbs +3 -3
  256. data/sig/mindee/product/invoice_splitter/invoice_splitter_v1_page.rbs +2 -2
  257. data/sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rbs +1 -1
  258. data/sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rbs +1 -1
  259. data/sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rbs +2 -2
  260. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1.rbs +1 -1
  261. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_added_sugar.rbs +2 -2
  262. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_calorie.rbs +2 -2
  263. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_cholesterol.rbs +2 -2
  264. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_dietary_fiber.rbs +2 -2
  265. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_document.rbs +1 -1
  266. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrient.rbs +3 -3
  267. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_page.rbs +2 -2
  268. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_protein.rbs +2 -2
  269. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_saturated_fat.rbs +2 -2
  270. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_serving_size.rbs +2 -2
  271. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_sodium.rbs +2 -2
  272. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_carbohydrate.rbs +2 -2
  273. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_fat.rbs +2 -2
  274. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_sugar.rbs +2 -2
  275. data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_trans_fat.rbs +2 -2
  276. data/sig/mindee/product/passport/passport_v1.rbs +1 -1
  277. data/sig/mindee/product/passport/passport_v1_document.rbs +1 -1
  278. data/sig/mindee/product/passport/passport_v1_page.rbs +2 -2
  279. data/sig/mindee/product/receipt/receipt_v5.rbs +1 -1
  280. data/sig/mindee/product/receipt/receipt_v5_document.rbs +1 -1
  281. data/sig/mindee/product/receipt/receipt_v5_line_item.rbs +3 -3
  282. data/sig/mindee/product/receipt/receipt_v5_page.rbs +2 -2
  283. data/sig/mindee/product/resume/resume_v1.rbs +1 -1
  284. data/sig/mindee/product/resume/resume_v1_certificate.rbs +3 -3
  285. data/sig/mindee/product/resume/resume_v1_document.rbs +1 -1
  286. data/sig/mindee/product/resume/resume_v1_education.rbs +3 -3
  287. data/sig/mindee/product/resume/resume_v1_language.rbs +3 -3
  288. data/sig/mindee/product/resume/resume_v1_page.rbs +2 -2
  289. data/sig/mindee/product/resume/resume_v1_professional_experience.rbs +3 -3
  290. data/sig/mindee/product/resume/resume_v1_social_networks_url.rbs +3 -3
  291. data/sig/mindee/product/universal/universal.rbs +5 -5
  292. data/sig/mindee/product/universal/universal_document.rbs +1 -1
  293. data/sig/mindee/product/universal/universal_page.rbs +2 -2
  294. data/sig/mindee/product/universal/universal_prediction.rbs +5 -5
  295. data/sig/mindee/product/us/bank_check/bank_check_v1.rbs +1 -1
  296. data/sig/mindee/product/us/bank_check/bank_check_v1_document.rbs +1 -1
  297. data/sig/mindee/product/us/bank_check/bank_check_v1_page.rbs +2 -2
  298. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1.rbs +1 -1
  299. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_copay.rbs +3 -3
  300. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_document.rbs +1 -1
  301. data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_page.rbs +2 -2
  302. data/sig/mindee/product/us/us_mail/us_mail_v2.rbs +1 -1
  303. data/sig/mindee/product/us/us_mail/us_mail_v2_document.rbs +1 -1
  304. data/sig/mindee/product/us/us_mail/us_mail_v2_page.rbs +2 -2
  305. data/sig/mindee/product/us/us_mail/us_mail_v2_recipient_address.rbs +3 -3
  306. data/sig/mindee/product/us/us_mail/us_mail_v2_sender_address.rbs +2 -2
  307. data/sig/mindee/product/us/us_mail/us_mail_v3.rbs +1 -1
  308. data/sig/mindee/product/us/us_mail/us_mail_v3_document.rbs +1 -1
  309. data/sig/mindee/product/us/us_mail/us_mail_v3_page.rbs +2 -2
  310. data/sig/mindee/product/us/us_mail/us_mail_v3_recipient_address.rbs +3 -3
  311. data/sig/mindee/product/us/us_mail/us_mail_v3_sender_address.rbs +2 -2
  312. data/sig/mindee/product/us/w9/w9_v1.rbs +1 -1
  313. data/sig/mindee/product/us/w9/w9_v1_document.rbs +1 -1
  314. data/sig/mindee/product/us/w9/w9_v1_page.rbs +2 -2
  315. data/sig/mindee/version.rbs +2 -2
  316. metadata +63 -6
@@ -2,11 +2,12 @@
2
2
  module Mindee
3
3
  module Errors
4
4
  class MindeeHTTPError < Errors::MindeeError
5
- def status_code: -> untyped
6
- def api_code: -> untyped
7
- def api_details: -> untyped
8
- def api_message: -> untyped
9
- def initialize: (untyped, untyped, untyped) -> untyped
5
+ attr_reader api_code: Integer
6
+ attr_reader api_details: String
7
+ attr_reader api_message: String
8
+ attr_reader status_code: Integer
9
+
10
+ def initialize: (Hash[String | Symbol, untyped], String, Integer) -> void
10
11
  end
11
12
  class MindeeHTTPClientError < MindeeHTTPError
12
13
  end
@@ -0,0 +1,12 @@
1
+ # lib/mindee/errors/mindee_http_error_v2.rb
2
+ module Mindee
3
+ module Errors
4
+ # API V2 HttpError
5
+ class MindeeHTTPErrorV2 < MindeeError
6
+
7
+ attr_reader detail: String
8
+ attr_reader status: Integer
9
+ def initialize: (Hash[String, untyped] | Parsing::V2::ErrorResponse) -> void
10
+ end
11
+ end
12
+ end
@@ -6,8 +6,9 @@ module Mindee
6
6
  class MindeeSourceError < MindeeInputError
7
7
  end
8
8
  class MindeeMimeTypeError < MindeeSourceError
9
- def invalid_mimetype: -> untyped
10
- def initialize: (untyped) -> untyped
9
+ attr_reader invalid_mimetype: String
10
+
11
+ def initialize: (String) -> void
11
12
  end
12
13
  class MindeeImageError < MindeeInputError
13
14
  end
@@ -2,9 +2,10 @@
2
2
  module Mindee
3
3
  module Geometry
4
4
  class MinMax
5
- def min: -> untyped
6
- def max: -> untyped
7
- def initialize: (untyped, untyped) -> untyped
5
+ attr_reader max: Float
6
+ attr_reader min: Float
7
+
8
+ def initialize: (Float, Float) -> void
8
9
  end
9
10
  end
10
11
  end
@@ -2,12 +2,11 @@
2
2
  module Mindee
3
3
  module Geometry
4
4
  class Point
5
- def x: -> untyped
6
- def x=: (untyped) -> untyped
7
- def y: -> untyped
8
- def y=: (untyped) -> untyped
9
- def initialize: (untyped, untyped) -> untyped
10
- def []: (untyped) -> bot
5
+ attr_accessor x: Float
6
+ attr_accessor y: Float
7
+
8
+ def initialize: (Float, Float) -> void
9
+ def []: (Integer) -> Float
11
10
  end
12
11
  end
13
12
  end
@@ -1,9 +1,9 @@
1
1
  # lib/mindee/geometry/polygon.rb
2
2
  module Mindee
3
3
  module Geometry
4
- class Polygon < Array[untyped]
5
- def centroid: -> untyped
6
- def point_in_y?: (untyped) -> untyped
4
+ class Polygon < Array[Point]
5
+ def centroid: -> Point
6
+ def point_in_y?: (Point) -> bool
7
7
  end
8
8
  end
9
9
  end
@@ -2,14 +2,11 @@
2
2
  module Mindee
3
3
  module Geometry
4
4
  class Quadrilateral
5
- def top_left: -> Point
6
- def top_left=: (Point) -> bool
7
- def top_right: -> Point
8
- def top_right=: (Point) -> untyped
9
- def bottom_right: -> Point
10
- def bottom_right=: (Point) -> untyped
11
- def bottom_left: -> Point
12
- def bottom_left=: (Point) -> untyped
5
+ attr_accessor bottom_left: Point
6
+ attr_accessor bottom_right: Point
7
+ attr_accessor top_left: Point
8
+ attr_accessor top_right: Point
9
+
13
10
  def initialize: (Point, Point, Point, Point) -> void
14
11
  def []: (Integer) -> Point
15
12
  def size: -> Integer
@@ -1,13 +1,13 @@
1
1
  # lib/mindee/geometry/utils.rb
2
2
  module Mindee
3
3
  module Geometry
4
- def self.quadrilateral_from_prediction: (untyped) -> untyped
5
- def self.polygon_from_prediction: (untyped) -> untyped
6
- def self.get_bbox: (untyped) -> [untyped, untyped, untyped, untyped]
7
- def self.get_bounding_box: (untyped) -> Quadrilateral
8
- def self.get_centroid: (untyped) -> untyped
9
- def self.get_min_max_y: (untyped) -> untyped
10
- def self.get_min_max_x: (untyped) -> untyped
11
- def self.below?: (untyped, untyped, untyped, untyped) -> bool
4
+ def self.quadrilateral_from_prediction: (Array[Array[Float]]) -> Quadrilateral
5
+ def self.polygon_from_prediction: (Array[Array[Float]]) -> Polygon
6
+ def self.get_bbox: (Array[Point]) -> [Float, Float, Float, Float]
7
+ def self.get_bounding_box: (Array[Point]) -> Quadrilateral
8
+ def self.get_centroid: (Array[Point]) -> Point
9
+ def self.get_min_max_y: (Array[Point]) -> MinMax
10
+ def self.get_min_max_x: (Array[Point]) -> MinMax
11
+ def self.below?: (Array[Point], Array[Point], Float, Float) -> bool
12
12
  end
13
13
  end
@@ -0,0 +1,23 @@
1
+ # lib/mindee/http/api_settings_v2.rb
2
+ module Mindee
3
+ module HTTP
4
+ class ApiSettingsV2
5
+ MINDEE_V2_API_KEY_ENV_NAME: String
6
+ MINDEE_V2_API_KEY_DEFAULT: String?
7
+ MINDEE_V2_BASE_URL_ENV_NAME: String
8
+ MINDEE_V2_BASE_URL_DEFAULT: String
9
+ MINDEE_V2_REQUEST_TIMEOUT_ENV_NAME: String
10
+ MINDEE_V2_TIMEOUT_DEFAULT: Integer
11
+ USER_AGENT: String
12
+
13
+ def logger: () -> Logger
14
+ attr_reader api_key: String?
15
+ attr_reader base_url: String
16
+ attr_reader request_timeout: Integer
17
+ attr_reader user_agent: String
18
+
19
+ def initialize: (?api_key: String?) -> void
20
+ def check_api_key: -> void
21
+ end
22
+ end
23
+ end
@@ -2,25 +2,26 @@
2
2
  module Mindee
3
3
  module HTTP
4
4
  API_KEY_ENV_NAME: String
5
- API_KEY_DEFAULT: nil
5
+ API_KEY_DEFAULT: String?
6
6
  BASE_URL_ENV_NAME: String
7
7
  BASE_URL_DEFAULT: String
8
8
  REQUEST_TIMEOUT_ENV_NAME: String
9
9
  TIMEOUT_DEFAULT: Integer
10
10
  USER_AGENT: String
11
11
  class Endpoint
12
- def logger: () -> untyped
13
- def api_key: -> String?
14
- def request_timeout: -> Integer
15
- def url_root: -> String
16
- def base_url: -> String
17
- def initialize: (String, String, String | nil, ?api_key: String) -> String
18
- def predict: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Net::HTTPResponse, Hash[Symbol, untyped]]
19
- def predict_async: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Net::HTTPResponse, Hash[Symbol, untyped]]
20
- def parse_async: (String) -> [Net::HTTPResponse, Hash[Symbol, untyped]]
12
+ attr_reader api_key: String
13
+ attr_reader base_url: String
14
+ attr_reader request_timeout: Integer
15
+ attr_reader url_root: String
16
+
17
+ def logger: () -> Logger
18
+ def initialize: (String, String, String?, ?api_key: String) -> String
19
+ def predict: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Hash[String | Symbol, untyped], String]
20
+ def predict_async: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> [Hash[String | Symbol, untyped], String]
21
+ def parse_async: (String) -> [Hash[String | Symbol, untyped], String]
21
22
  def predict_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> Net::HTTPResponse
22
23
  def document_queue_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, ParseOptions) -> Net::HTTPResponse
23
- def document_queue_req_get: (untyped) -> Net::HTTPResponse
24
+ def document_queue_req_get: (String) -> Net::HTTPResponse
24
25
  def check_api_key: -> void
25
26
  end
26
27
  end
@@ -2,9 +2,14 @@
2
2
  module Mindee
3
3
  module HTTP
4
4
  module ErrorHandler
5
- def extract_error: (untyped) -> nil
6
- def create_error_obj: (untyped) -> (Hash[String, String] | Hash[untyped, untyped])?
7
- def self.handle_error: (untyped, untyped) -> untyped
5
+ def extract_error: (Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]?
6
+ def create_error_obj: (Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
7
+ def self.generate_v2_error: (Hash[String, Integer | String]) -> Errors::MindeeHTTPErrorV2
8
+ def generate_v2_error: (Hash[Symbol, String | Integer]) -> Errors::MindeeHTTPErrorV2
9
+
10
+ def self.handle_error: (String, Net::HTTPResponse) -> Errors::MindeeHTTPError
11
+ def handle_error: (String, Net::HTTPResponse) -> Errors::MindeeHTTPError
12
+ def handle_v2_error: (Hash[String | Symbol, untyped]) -> void
8
13
  end
9
14
  end
10
15
  end
@@ -0,0 +1,18 @@
1
+ # lib/mindee/http/mindee_api_v2.rb
2
+ module Mindee
3
+ module HTTP
4
+ class MindeeApiV2
5
+ attr_reader settings: ApiSettingsV2
6
+
7
+ def initialize: (?api_key: String?) -> void
8
+ def req_post_inference_enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::InferenceParameters) -> Parsing::V2::JobResponse
9
+ def req_get_inference: (String) -> Parsing::V2::InferenceResponse
10
+ def req_get_job: (String) -> Parsing::V2::JobResponse
11
+ def process_response: (Net::HTTPResponse?) -> Hash[String | Symbol, untyped]
12
+ def poll: (String) -> Net::HTTPResponse
13
+ def inference_job_req_get: (String) -> Net::HTTPResponse
14
+ def inference_result_req_get: (String) -> Net::HTTPResponse
15
+ def enqueue: (Input::Source::LocalInputSource | Input::Source::URLInputSource, Input::InferenceParameters) -> Net::HTTPResponse?
16
+ end
17
+ end
18
+ end
@@ -3,6 +3,7 @@ module Mindee
3
3
  module HTTP
4
4
  module ResponseValidation
5
5
  def self.valid_sync_response?: (Net::HTTPResponse) -> bool
6
+ def self.valid_v2_response?: (Net::HTTPResponse) -> bool
6
7
  def self.valid_async_response?: (Net::HTTPResponse) -> bool
7
8
  def self.clean_request!: (Net::HTTPResponse) -> void
8
9
  end
@@ -10,7 +10,7 @@ module Mindee
10
10
 
11
11
  def initialize: (untyped, ?api_key: String) -> String
12
12
 
13
- def execute_workflow: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> [untyped, untyped]
13
+ def execute_workflow: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> [Hash[String, untyped], String]
14
14
 
15
15
  def workflow_execution_req_post: (Input::Source::LocalInputSource | Input::Source::URLInputSource, WorkflowOptions) -> Net::HTTPResponse?
16
16
 
@@ -2,13 +2,13 @@
2
2
  module Mindee
3
3
  module Image
4
4
  class ExtractedImage
5
- def logger: () -> untyped
5
+ def logger: () -> Logger
6
6
  def page_id: -> Integer
7
7
  def element_id: -> Integer
8
8
  def buffer: -> StringIO
9
9
  def internal_file_name: -> String
10
10
  def initialize: (Input::Source::LocalInputSource, Integer, Integer) -> Integer
11
- def write_to_file: (String, ?String?) -> nil
11
+ def write_to_file: (String, ?String?) -> void
12
12
  def as_source: -> Input::Source::BytesInputSource
13
13
  end
14
14
  end
@@ -2,7 +2,7 @@
2
2
  module Mindee
3
3
  module Image
4
4
  module ImageCompressor
5
- def self.compress_image: (singleton(MiniMagick::Image) | MiniMagick::Image | StringIO, ?quality: Integer, ?max_width: Integer?, ?max_height: Integer?) -> StringIO
5
+ def self.compress_image: (MiniMagick::Image | StringIO | File, ?quality: Integer | Float?, ?max_width: Integer | Float?, ?max_height: Integer | Float?) -> StringIO
6
6
  end
7
7
  end
8
8
  end
@@ -2,12 +2,12 @@
2
2
  module Mindee
3
3
  module Image
4
4
  module ImageExtractor
5
- def self.attach_image_as_new_file: (untyped, ?format: String) -> untyped
5
+ def self.attach_image_as_new_file: (StringIO | File, ?format: String) -> Origami::PDF
6
6
  def self.to_blob: () -> String
7
- def self.extract_multiple_images_from_source: (untyped, untyped, untyped) -> Array[untyped]
8
- def self.extract_images_from_polygons: (untyped, untyped, untyped, untyped) -> Array[untyped]
9
- def self.create_extracted_image: (StringIO, String, untyped, untyped) -> untyped
10
- def self.load_input_source_pdf_page_as_stringio: (untyped, untyped) -> untyped
7
+ def self.extract_multiple_images_from_source: (Input::Source::LocalInputSource, Integer, Array[Array[Geometry::Point] |Geometry::Polygon | Geometry::Quadrilateral]) -> Array[ExtractedImage]
8
+ def self.extract_images_from_polygons: (Input::Source::LocalInputSource, StringIO | File, Integer, Array[Array[Geometry::Point] | Geometry::Polygon | Geometry::Quadrilateral]) -> Array[ExtractedImage]
9
+ def self.create_extracted_image: (StringIO | File, String, Integer, Integer) -> void
10
+ def self.load_input_source_pdf_page_as_stringio: (Input::Source::LocalInputSource, Integer) -> (StringIO | File)
11
11
  end
12
12
  end
13
13
  end
@@ -2,17 +2,17 @@
2
2
  module Mindee
3
3
  module Image
4
4
  module ImageUtils
5
- def self.resize_image: (singleton(MiniMagick::Image) | MiniMagick::Image, Integer, Integer) -> void
6
- def self.compress_image_quality: (singleton(MiniMagick::Image) | MiniMagick::Image, untyped) -> untyped
7
- def self.to_image: (singleton(MiniMagick::Image) | MiniMagick::Image | StringIO | IO | File | Tempfile?) -> (singleton(MiniMagick::Image) | MiniMagick::Image)
8
- def self.image_to_stringio: (singleton(MiniMagick::Image) | MiniMagick::Image, ?String) -> StringIO
9
- def self.calculate_new_dimensions: (singleton(MiniMagick::Image) | MiniMagick::Image, ?max_width: Integer | Float?, ?max_height: Integer | Float?) -> [Integer, Integer]
10
- def self.calculate_dimensions_from_media_box: (singleton(MiniMagick::Image) | MiniMagick::Image, Array[Integer]?) -> [Integer, Integer]
11
- def self.pdf_to_magick_image: (StringIO, Integer) -> singleton(MiniMagick::Image)
5
+ def self.resize_image: (MiniMagick::Image, Integer, Integer) -> void
6
+ def self.compress_image_quality: (MiniMagick::Image, untyped) -> void
7
+ def self.to_image: (MiniMagick::Image | StringIO | IO | File | Tempfile?) -> (MiniMagick::Image)
8
+ def self.image_to_stringio: (MiniMagick::Image, ?String) -> StringIO
9
+ def self.calculate_new_dimensions: (MiniMagick::Image, ?max_width: Integer | Float?, ?max_height: Integer | Float?) -> [Integer, Integer]
10
+ def self.calculate_dimensions_from_media_box: (MiniMagick::Image, Array[Integer]?) -> [Integer, Integer]
11
+ def self.pdf_to_magick_image: (StringIO | File, Integer) -> MiniMagick::Image
12
12
  def self.normalize_polygon: (Geometry::Quadrilateral | Geometry::Polygon | Array[Geometry::Point]) -> Geometry::Quadrilateral
13
- def self.read_page_content: (StringIO) -> singleton(MiniMagick::Image)
14
- def self.crop_image: (singleton(MiniMagick::Image), Geometry::MinMax, Geometry::MinMax) -> singleton(MiniMagick::Image)
15
- def self.write_image_to_buffer: (singleton(MiniMagick::Image) | MiniMagick::Image, StringIO) -> Net::BufferedIO
13
+ def self.read_page_content: (StringIO | File) -> (MiniMagick::Image)
14
+ def self.crop_image: (MiniMagick::Image, Geometry::MinMax, Geometry::MinMax) -> (MiniMagick::Image)
15
+ def self.write_image_to_buffer: (MiniMagick::Image, StringIO) -> void
16
16
  def self.determine_file_extension: (Input::Source::LocalInputSource) -> String?
17
17
  end
18
18
  end
@@ -0,0 +1,30 @@
1
+ # lib/mindee/input/inference_parameters.rb
2
+ module Mindee
3
+ module Input
4
+ class InferenceParameters
5
+ attr_reader close_file: bool
6
+ attr_reader file_alias: String?
7
+ attr_reader model_id: String
8
+ attr_reader polling_options: PollingOptions
9
+ attr_reader rag: bool?
10
+ attr_reader webhook_ids: Array[String]?
11
+
12
+ def initialize: (
13
+ String,
14
+ ?rag: bool?,
15
+ ?file_alias: String?,
16
+ ?webhook_ids: Array[String]?,
17
+ ?polling_options: Hash[Symbol | String, untyped] | PollingOptions?,
18
+ ?close_file: bool?
19
+ ) -> void
20
+
21
+ def self.from_hash: (params: Hash[String | Symbol, untyped]) -> InferenceParameters
22
+
23
+ def validate_async_params: -> void
24
+
25
+ private
26
+
27
+ def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions?) -> PollingOptions
28
+ end
29
+ end
30
+ end
@@ -3,11 +3,12 @@ module Mindee
3
3
  module Input
4
4
  class LocalResponse
5
5
  def file: -> StringIO
6
- def initialize: (untyped) -> Integer
7
- def as_hash: -> nil
8
- def self.process_secret_key: (untyped) -> untyped
9
- def get_hmac_signature: (untyped) -> untyped
10
- def valid_hmac_signature?: (untyped, untyped) -> untyped
6
+ def initialize: (File | IO | StringIO | String | Pathname) -> void
7
+ def as_hash: -> Hash[String | Symbol, untyped]
8
+ def self.process_secret_key: (String) -> String
9
+ def get_hmac_signature: (String) -> String
10
+ def valid_hmac_signature?: (String, String) -> bool
11
+ def deserialize_response: (singleton(Parsing::V2::JobResponse) | singleton(Parsing::V2::InferenceResponse))-> (Parsing::V2::JobResponse | Parsing::V2::InferenceResponse)
11
12
  end
12
13
  end
13
14
  end
@@ -0,0 +1,12 @@
1
+ # lib/mindee/input/polling_options.rb
2
+ module Mindee
3
+ module Input
4
+ class PollingOptions
5
+ attr_reader delay_sec: Integer | Float
6
+ attr_reader initial_delay_sec: Integer | Float
7
+ attr_reader max_retries: Integer
8
+
9
+ def initialize: (?initial_delay_sec: Float, ?delay_sec: Float, ?max_retries: Integer) -> Integer
10
+ end
11
+ end
12
+ end
@@ -4,7 +4,7 @@ module Mindee
4
4
  module Source
5
5
  class Base64InputSource < LocalInputSource
6
6
  def initialize: (String, String, ?repair_pdf: bool) -> void
7
- def read_contents: (?close: bool) -> [String, String, Hash[Symbol, untyped]]
7
+ def read_contents: (?close: bool) -> [String?, Hash[:filename, String]]
8
8
  end
9
9
  end
10
10
  end
@@ -4,17 +4,20 @@ module Mindee
4
4
  module Source
5
5
  ALLOWED_MIME_TYPES: Array[String]
6
6
  class LocalInputSource
7
- def filename: -> String
8
- def file_mimetype: -> String
9
- def io_stream: -> StringIO
7
+ attr_reader file_mimetype: String
8
+ attr_reader filename: String
9
+ attr_reader io_stream: StringIO | File
10
10
  def initialize: (StringIO | File, String, ?repair_pdf: bool) -> void
11
- def logger: () -> untyped
12
- def rescue_broken_pdf: (StringIO) -> StringIO
11
+ def logger: () -> Logger
12
+
13
+
14
+ def rescue_broken_pdf: (StringIO | File) -> (StringIO | File)
13
15
  def pdf?: -> bool
16
+ def apply_page_options: (PageOptions) -> StringIO?
14
17
  def process_pdf: (PageOptions) -> StringIO?
15
- def read_contents: (?close: bool) -> [String, String?, Hash[:filename, String]]
18
+ def read_contents: (?close: bool) -> [String?, Hash[:filename, String]]
16
19
  def count_pages: -> Integer
17
- def write_to_file: (String) -> void
20
+ def write_to_file: (String?) -> void
18
21
  def compress!: (?quality: Integer, ?max_width: Integer?, ?max_height: Integer?, ?force_source_text: bool, ?disable_source_text: bool) -> Integer
19
22
  def source_text?: -> bool?
20
23
  end
@@ -4,7 +4,7 @@ module Mindee
4
4
  module Source
5
5
  class URLInputSource
6
6
  def url: -> String
7
- def logger: () -> untyped
7
+ def logger: () -> Logger
8
8
  def initialize: (String) -> void
9
9
  def write_to_file: (String, ?filename: String?, ?username: String?, ?password: String?, ?token: String?, ?max_redirects: Integer) -> String
10
10
  def as_local_input_source: (?filename: String?, ?username: String?, ?password: String?, ?token: String?, ?max_redirects: Integer) -> BytesInputSource?
@@ -3,6 +3,8 @@ module Mindee
3
3
  @logger: Logger
4
4
 
5
5
  def self.logger: -> Logger
6
+ def debug: (?untyped?) -> void
7
+ def info: (?untyped?) -> void
6
8
 
7
9
  def self.logger=: (Logger) -> Logger
8
10
  end
@@ -0,0 +1,11 @@
1
+ # lib/mindee/page_options.rb
2
+
3
+ module Mindee
4
+ class PageOptions
5
+ attr_accessor page_indexes: Array[Integer]
6
+ attr_accessor operation: :KEEP_ONLY | :REMOVE
7
+ attr_accessor on_min_pages: Integer?
8
+
9
+ def initialize: (params: Hash[String | Symbol, untyped]) -> void
10
+ end
11
+ end
@@ -3,12 +3,12 @@ module Mindee
3
3
  module Parsing
4
4
  module Common
5
5
  class ApiRequest
6
- def error: -> untyped
7
- def ressources: -> untyped
8
- def status: -> untyped
9
- def status_code: -> untyped
10
- def url: -> untyped
11
- def initialize: (untyped) -> untyped
6
+ def error: -> Hash[String, untyped]
7
+ def ressources: -> Array[String]
8
+ def status: -> [RequestStatus, Symbol]
9
+ def status_code: -> Integer
10
+ def url: -> String
11
+ def initialize: (Hash[String, untyped]) -> void
12
12
  end
13
13
  end
14
14
  end
@@ -15,12 +15,12 @@ module Mindee
15
15
 
16
16
 
17
17
  class ApiResponse
18
- def logger: () -> untyped
18
+ def logger: () -> Logger
19
19
  def document: -> Parsing::Common::Document?
20
20
  def job: -> Parsing::Common::Job?
21
21
  def api_request: -> Parsing::Common::ApiRequest?
22
22
  def raw_http: -> String
23
- def initialize: (singleton(Parsing::Common::Inference), Hash[Symbol | String, untyped] | Net::HTTPResponse, String) -> void
23
+ def initialize: (singleton(Parsing::Common::Inference), Hash[String | Symbol, untyped] | Net::HTTPResponse, String) -> void
24
24
  end
25
25
  end
26
26
  end
@@ -3,17 +3,17 @@ module Mindee
3
3
  module Parsing
4
4
  module Common
5
5
  class Document
6
- def inference: -> untyped
7
- def name: -> untyped
8
- def id: -> untyped
9
- def extras: -> nil
10
- def ocr: -> nil
11
- def n_pages: -> untyped
12
- def self.load_ocr: (untyped) -> Parsing::Common::OCR::OCR?
13
- def self.extract_extras: (untyped) -> Parsing::Common::Extras::Extras?
14
- def initialize: (untyped, untyped) -> untyped
6
+ def inference: -> Inference
7
+ def name: -> String
8
+ def id: -> String
9
+ def extras: -> Extras::Extras?
10
+ def ocr: -> OCR::OCR?
11
+ def n_pages: -> Integer
12
+ def self.load_ocr: (Hash[String | Symbol, untyped]) -> Parsing::Common::OCR::OCR?
13
+ def self.extract_extras: (Hash[String | Symbol, untyped]) -> Parsing::Common::Extras::Extras?
14
+ def initialize: (singleton(Parsing::Common::Inference), Hash[String | Symbol, untyped]) -> void
15
15
  def to_s: -> String
16
- def inject_full_text_ocr: (untyped) -> untyped
16
+ def inject_full_text_ocr: (Hash[String | Symbol, untyped]) -> void
17
17
  end
18
18
  end
19
19
  end
@@ -3,20 +3,21 @@ module Mindee
3
3
  module Parsing
4
4
  module Common
5
5
  class Execution
6
- def batch_name: -> untyped
7
- def created_at: -> untyped
8
- def file: -> untyped
9
- def id: -> untyped
10
- def inference: -> untyped
11
- def priority: -> untyped
12
- def reviewed_at: -> untyped
13
- def available_at: -> untyped
14
- def reviewed_prediction: -> untyped
15
- def status: -> untyped
16
- def type: -> untyped
17
- def uploaded_at: -> untyped
18
- def workflow_id: -> untyped
19
- def initialize: (untyped, untyped) -> untyped
6
+ attr_reader available_at: Time?
7
+ attr_reader batch_name: String
8
+ attr_reader created_at: Time
9
+ attr_reader file: ExecutionFile
10
+ attr_reader id: String
11
+ attr_reader inference: Inference
12
+ attr_reader priority: Symbol?
13
+ attr_reader reviewed_at: Time?
14
+ attr_reader reviewed_prediction: Prediction?
15
+ attr_reader status: Symbol
16
+ attr_reader type: String?
17
+ attr_reader uploaded_at: Time?
18
+ attr_reader workflow_id: String
19
+
20
+ def initialize: (singleton(Parsing::Common::Inference), Hash[String | Symbol, untyped]) -> void
20
21
  end
21
22
  end
22
23
  end
@@ -3,9 +3,9 @@ module Mindee
3
3
  module Parsing
4
4
  module Common
5
5
  class ExecutionFile
6
- def name: -> untyped
7
- def alias: -> untyped
8
- def initialize: (untyped) -> untyped
6
+ def name: -> String
7
+ def alias: -> String?
8
+ def initialize: (Hash[String | Symbol, untyped]) -> void
9
9
  end
10
10
  end
11
11
  end
@@ -4,8 +4,9 @@ module Mindee
4
4
  module Common
5
5
  module Extras
6
6
  class CropperExtra
7
- def croppings: -> Array[Standard::PositionField]
8
- def initialize: (untyped, ?nil) -> untyped
7
+ attr_reader croppings: Array[Standard::PositionField]
8
+
9
+ def initialize: (Hash[String | Symbol, untyped], ?Integer?) -> void
9
10
  def to_s: -> String
10
11
  end
11
12
  end
@@ -4,12 +4,13 @@ module Mindee
4
4
  module Common
5
5
  module Extras
6
6
  class Extras
7
- def cropper: -> untyped
8
- def full_text_ocr: -> untyped
9
- def initialize: (untyped) -> void
10
- def new: (untyped) -> void
7
+ attr_reader cropper: CropperExtra?
8
+ attr_reader full_text_ocr: FullTextOCRExtra
9
+ attr_reader rag: RAGExtra?
10
+
11
+ def initialize: (Hash[String | Symbol, untyped]) -> void
11
12
  def to_s: -> String
12
- def add_artificial_extra: (untyped) -> nil
13
+ def add_artificial_extra: (Hash[String | Symbol, untyped]) -> void
13
14
  end
14
15
  def empty?: -> bool
15
16
  end
@@ -6,8 +6,9 @@ module Mindee
6
6
  class FullTextOCRExtra
7
7
  def contents: -> String?
8
8
  def language: -> String?
9
- def initialize: (untyped) -> nil
9
+ def initialize: (Hash[String | Symbol, untyped]) -> nil
10
10
  def to_s: -> String
11
+ def <<: (?untyped?) -> untyped
11
12
  end
12
13
  end
13
14
  end