mindee 4.13.0 → 5.0.0.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.
- checksums.yaml +4 -4
- data/.editorconfig +24 -0
- data/.pre-commit-config.yaml +36 -0
- data/.rubocop.yml +3 -2
- data/CHANGELOG.md +50 -3
- data/CONTRIBUTING.md +17 -0
- data/Gemfile +9 -1
- data/README.md +7 -7
- data/Rakefile +21 -15
- data/Steepfile +0 -1
- data/bin/mindee.rb +19 -118
- data/bin/v1/parser.rb +153 -0
- data/bin/v1/products.rb +88 -0
- data/bin/v2/parser.rb +235 -0
- data/bin/v2/products.rb +34 -0
- data/docs/code_samples/bank_account_details_v1.txt +2 -2
- data/docs/code_samples/bank_account_details_v2.txt +2 -2
- data/docs/code_samples/bank_statement_fr_v2_async.txt +2 -2
- data/docs/code_samples/barcode_reader_v1.txt +2 -2
- data/docs/code_samples/cropper_v1.txt +2 -2
- data/docs/code_samples/default.txt +2 -2
- data/docs/code_samples/default_async.txt +2 -3
- data/docs/code_samples/expense_receipts_v5.txt +2 -2
- data/docs/code_samples/expense_receipts_v5_async.txt +2 -2
- data/docs/code_samples/financial_document_v1.txt +2 -2
- data/docs/code_samples/financial_document_v1_async.txt +2 -2
- data/docs/code_samples/idcard_fr_v1.txt +2 -2
- data/docs/code_samples/idcard_fr_v2.txt +2 -2
- data/docs/code_samples/international_id_v2_async.txt +2 -2
- data/docs/code_samples/invoice_splitter_v1_async.txt +2 -2
- data/docs/code_samples/invoices_v4.txt +2 -2
- data/docs/code_samples/invoices_v4_async.txt +2 -2
- data/docs/code_samples/multi_receipts_detector_v1.txt +2 -2
- data/docs/code_samples/passport_v1.txt +2 -2
- data/docs/code_samples/resume_v1_async.txt +2 -2
- data/docs/code_samples/v2_classification.txt +1 -1
- data/docs/code_samples/v2_crop.txt +2 -2
- data/docs/code_samples/v2_extraction.txt +3 -3
- data/docs/code_samples/v2_extraction_webhook.txt +3 -3
- data/docs/code_samples/v2_ocr.txt +2 -2
- data/docs/code_samples/v2_split.txt +1 -1
- data/docs/code_samples/workflow_execution.txt +2 -2
- data/docs/code_samples/workflow_polling.txt +2 -3
- data/examples/auto_invoice_splitter_extraction.rb +6 -6
- data/examples/auto_multi_receipts_detector_extraction.rb +4 -4
- data/lib/mindee/dependencies.rb +29 -0
- data/lib/mindee/{errors → error}/mindee_error.rb +1 -1
- data/lib/mindee/{errors → error}/mindee_http_error.rb +1 -1
- data/lib/mindee/{errors → error}/mindee_http_error_v2.rb +5 -5
- data/lib/mindee/{errors → error}/mindee_http_unknown_error_v2.rb +1 -1
- data/lib/mindee/{errors → error}/mindee_input_error.rb +2 -2
- data/lib/mindee/error.rb +6 -0
- data/lib/mindee/geometry/polygon.rb +2 -2
- data/lib/mindee/http/.rubocop.yml +0 -1
- data/lib/mindee/http/http_error_handler.rb +7 -7
- data/lib/mindee/http/response_validation.rb +3 -2
- data/lib/mindee/http.rb +0 -4
- data/lib/mindee/image/extracted_image.rb +25 -12
- data/lib/mindee/image/image_extractor.rb +17 -17
- data/lib/mindee/image/image_utils.rb +3 -3
- data/lib/mindee/input/base_parameters.rb +5 -2
- data/lib/mindee/input/local_response.rb +6 -8
- data/lib/mindee/input/sources/local_input_source.rb +18 -14
- data/lib/mindee/input/sources/path_input_source.rb +1 -1
- data/lib/mindee/input/sources/url_input_source.rb +4 -4
- data/lib/mindee/input.rb +0 -2
- data/lib/mindee/logging/logger.rb +9 -1
- data/lib/mindee/page_options.rb +1 -1
- data/lib/mindee/pdf/extracted_pdf.rb +55 -45
- data/lib/mindee/pdf/pdf_compressor.rb +2 -0
- data/lib/mindee/pdf/pdf_extractor.rb +95 -94
- data/lib/mindee/pdf/pdf_processor.rb +6 -1
- data/lib/mindee/pdf/pdf_tools.rb +19 -0
- data/lib/mindee/v1/client.rb +490 -0
- data/lib/mindee/v1/extraction/multi_receipts_extractor.rb +32 -0
- data/lib/mindee/v1/http/.rubocop.yml +7 -0
- data/lib/mindee/v1/http/endpoint.rb +221 -0
- data/lib/mindee/v1/http/workflow_endpoint.rb +93 -0
- data/lib/mindee/v1/http.rb +4 -0
- data/lib/mindee/v1/parsing/common/api_request.rb +38 -0
- data/lib/mindee/v1/parsing/common/api_response.rb +63 -0
- data/lib/mindee/v1/parsing/common/document.rb +86 -0
- data/lib/mindee/v1/parsing/common/execution.rb +78 -0
- data/lib/mindee/v1/parsing/common/execution_file.rb +26 -0
- data/lib/mindee/v1/parsing/common/execution_priority.rb +38 -0
- data/lib/mindee/v1/parsing/common/extras/cropper_extra.rb +32 -0
- data/lib/mindee/v1/parsing/common/extras/extras.rb +62 -0
- data/lib/mindee/v1/parsing/common/extras/full_text_ocr_extra.rb +35 -0
- data/lib/mindee/v1/parsing/common/extras/rag_extra.rb +28 -0
- data/lib/mindee/v1/parsing/common/inference.rb +69 -0
- data/lib/mindee/v1/parsing/common/job.rb +48 -0
- data/lib/mindee/v1/parsing/common/ocr/mvision_v1.rb +52 -0
- data/lib/mindee/v1/parsing/common/ocr/ocr.rb +180 -0
- data/lib/mindee/v1/parsing/common/orientation.rb +28 -0
- data/lib/mindee/v1/parsing/common/page.rb +49 -0
- data/lib/mindee/v1/parsing/common/prediction.rb +19 -0
- data/lib/mindee/v1/parsing/common/product.rb +26 -0
- data/lib/mindee/v1/parsing/common/workflow_response.rb +30 -0
- data/lib/mindee/v1/parsing/standard/abstract_field.rb +74 -0
- data/lib/mindee/v1/parsing/standard/address_field.rb +51 -0
- data/lib/mindee/v1/parsing/standard/amount_field.rb +28 -0
- data/lib/mindee/v1/parsing/standard/base_field.rb +30 -0
- data/lib/mindee/v1/parsing/standard/boolean_field.rb +29 -0
- data/lib/mindee/v1/parsing/standard/classification_field.rb +18 -0
- data/lib/mindee/v1/parsing/standard/company_registration_field.rb +45 -0
- data/lib/mindee/v1/parsing/standard/date_field.rb +40 -0
- data/lib/mindee/v1/parsing/standard/feature_field.rb +26 -0
- data/lib/mindee/v1/parsing/standard/locale_field.rb +52 -0
- data/lib/mindee/v1/parsing/standard/payment_details_field.rb +44 -0
- data/lib/mindee/v1/parsing/standard/position_field.rb +61 -0
- data/lib/mindee/v1/parsing/standard/string_field.rb +26 -0
- data/lib/mindee/v1/parsing/standard/tax_field.rb +110 -0
- data/lib/mindee/v1/parsing/universal/universal_list_field.rb +60 -0
- data/lib/mindee/v1/parsing/universal/universal_object_field.rb +123 -0
- data/lib/mindee/{product → v1/product}/.rubocop.yml +1 -2
- data/lib/mindee/{product/fr/id_card/id_card_v1.rb → v1/product/barcode_reader/barcode_reader_v1.rb} +12 -12
- data/lib/mindee/v1/product/barcode_reader/barcode_reader_v1_document.rb +47 -0
- data/lib/mindee/{product/fr/bank_statement/bank_statement_v2_page.rb → v1/product/barcode_reader/barcode_reader_v1_page.rb} +10 -10
- data/lib/mindee/{product/us/bank_check/bank_check_v1.rb → v1/product/cropper/cropper_v1.rb} +12 -12
- data/lib/mindee/v1/product/cropper/cropper_v1_document.rb +15 -0
- data/lib/mindee/v1/product/cropper/cropper_v1_page.rb +55 -0
- data/lib/mindee/{product/ind/indian_passport/indian_passport_v1.rb → v1/product/financial_document/financial_document_v1.rb} +13 -13
- data/lib/mindee/v1/product/financial_document/financial_document_v1_document.rb +329 -0
- data/lib/mindee/v1/product/financial_document/financial_document_v1_line_item.rb +124 -0
- data/lib/mindee/{product/fr/energy_bill/energy_bill_v1_subscriptions.rb → v1/product/financial_document/financial_document_v1_line_items.rb} +19 -20
- data/lib/mindee/v1/product/financial_document/financial_document_v1_page.rb +38 -0
- data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1.rb +49 -0
- data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_document.rb +49 -0
- data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v1_page.rb +40 -0
- data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2.rb +49 -0
- data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_bban.rb +63 -0
- data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_document.rb +60 -0
- data/lib/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_page.rb +40 -0
- data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2.rb +49 -0
- data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_document.rb +169 -0
- data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_page.rb +40 -0
- data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_transaction.rb +78 -0
- data/lib/mindee/v1/product/fr/bank_statement/bank_statement_v2_transactions.rb +56 -0
- data/lib/mindee/v1/product/fr/id_card/id_card_v1.rb +49 -0
- data/lib/mindee/v1/product/fr/id_card/id_card_v1_document.rb +106 -0
- data/lib/mindee/v1/product/fr/id_card/id_card_v1_page.rb +57 -0
- data/lib/mindee/v1/product/fr/id_card/id_card_v2.rb +49 -0
- data/lib/mindee/v1/product/fr/id_card/id_card_v2_document.rb +143 -0
- data/lib/mindee/v1/product/fr/id_card/id_card_v2_page.rb +65 -0
- data/lib/mindee/{product/fr/payslip/payslip_v2.rb → v1/product/international_id/international_id_v2.rb} +12 -12
- data/lib/mindee/v1/product/international_id/international_id_v2_document.rb +164 -0
- data/lib/mindee/{product/fr/energy_bill/energy_bill_v1_page.rb → v1/product/international_id/international_id_v2_page.rb} +10 -10
- data/lib/mindee/{product/fr/payslip/payslip_v3.rb → v1/product/invoice/invoice_v4.rb} +14 -14
- data/lib/mindee/v1/product/invoice/invoice_v4_document.rb +300 -0
- data/lib/mindee/v1/product/invoice/invoice_v4_line_item.rb +124 -0
- data/lib/mindee/{product/fr/energy_bill/energy_bill_v1_taxes_and_contributions.rb → v1/product/invoice/invoice_v4_line_items.rb} +19 -20
- data/lib/mindee/{product/fr/payslip/payslip_v2_page.rb → v1/product/invoice/invoice_v4_page.rb} +10 -10
- data/lib/mindee/{product/fr/energy_bill/energy_bill_v1.rb → v1/product/invoice_splitter/invoice_splitter_v1.rb} +12 -12
- data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_document.rb +66 -0
- data/lib/mindee/v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rb +58 -0
- data/lib/mindee/{product/us/healthcare_card/healthcare_card_v1_copays.rb → v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rb} +10 -12
- data/lib/mindee/{product/fr/health_card/health_card_v1_page.rb → v1/product/invoice_splitter/invoice_splitter_v1_page.rb} +10 -10
- data/lib/mindee/{product/fr/bank_account_details/bank_account_details_v1.rb → v1/product/multi_receipts_detector/multi_receipts_detector_v1.rb} +12 -12
- data/lib/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb +38 -0
- data/lib/mindee/{product/fr/bank_account_details/bank_account_details_v1_page.rb → v1/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb} +10 -10
- data/lib/mindee/{product/fr/carte_grise/carte_grise_v1.rb → v1/product/passport/passport_v1.rb} +12 -12
- data/lib/mindee/{product/fr/id_card/id_card_v1_document.rb → v1/product/passport/passport_v1_document.rb} +42 -33
- data/lib/mindee/{product/fr/carte_grise/carte_grise_v1_page.rb → v1/product/passport/passport_v1_page.rb} +10 -10
- data/lib/mindee/v1/product/receipt/receipt_v5.rb +47 -0
- data/lib/mindee/v1/product/receipt/receipt_v5_document.rb +187 -0
- data/lib/mindee/v1/product/receipt/receipt_v5_line_item.rb +88 -0
- data/lib/mindee/{product/fr/bank_statement/bank_statement_v2_transactions.rb → v1/product/receipt/receipt_v5_line_items.rb} +14 -12
- data/lib/mindee/{product/fr/payslip/payslip_v3_page.rb → v1/product/receipt/receipt_v5_page.rb} +10 -10
- data/lib/mindee/{product/us/us_mail/us_mail_v3.rb → v1/product/resume/resume_v1.rb} +13 -13
- data/lib/mindee/v1/product/resume/resume_v1_certificate.rb +82 -0
- data/lib/mindee/{product/fr/payslip/payslip_v2_salary_details.rb → v1/product/resume/resume_v1_certificates.rb} +20 -23
- data/lib/mindee/v1/product/resume/resume_v1_document.rb +340 -0
- data/lib/mindee/v1/product/resume/resume_v1_education.rb +106 -0
- data/lib/mindee/{product/us/us_mail/us_mail_v3_recipient_addresses.rb → v1/product/resume/resume_v1_educations.rb} +24 -23
- data/lib/mindee/v1/product/resume/resume_v1_language.rb +66 -0
- data/lib/mindee/{product/fr/payslip/payslip_v3_paid_time_offs.rb → v1/product/resume/resume_v1_languages.rb} +16 -25
- data/lib/mindee/{product/us/us_mail/us_mail_v3_page.rb → v1/product/resume/resume_v1_page.rb} +10 -10
- data/lib/mindee/v1/product/resume/resume_v1_professional_experience.rb +122 -0
- data/lib/mindee/{product/fr/energy_bill/energy_bill_v1_energy_usages.rb → v1/product/resume/resume_v1_professional_experiences.rb} +26 -25
- data/lib/mindee/v1/product/resume/resume_v1_social_networks_url.rb +66 -0
- data/lib/mindee/v1/product/resume/resume_v1_social_networks_urls.rb +56 -0
- data/lib/mindee/{product/fr/bank_statement/bank_statement_v2.rb → v1/product/universal/universal.rb} +16 -15
- data/lib/mindee/v1/product/universal/universal_document.rb +35 -0
- data/lib/mindee/v1/product/universal/universal_page.rb +54 -0
- data/lib/mindee/v1/product/universal/universal_prediction.rb +128 -0
- data/lib/mindee/{product.rb → v1/product.rb} +0 -14
- data/lib/mindee/v1.rb +7 -0
- data/lib/mindee/v2/client.rb +132 -0
- data/lib/mindee/v2/file_operations/crop.rb +51 -0
- data/lib/mindee/v2/file_operations/crop_files.rb +25 -0
- data/lib/mindee/v2/file_operations/split.rb +37 -0
- data/lib/mindee/v2/file_operations/split_files.rb +25 -0
- data/lib/mindee/v2/file_operations.rb +6 -0
- data/lib/mindee/v2/http/.rubocop.yml +7 -0
- data/lib/mindee/v2/http/api_v2_settings.rb +65 -0
- data/lib/mindee/v2/http/mindee_api_v2.rb +230 -0
- data/lib/mindee/v2/http.rb +4 -0
- data/lib/mindee/v2/parsing/base_inference.rb +6 -6
- data/lib/mindee/v2/parsing/base_response.rb +3 -1
- data/lib/mindee/{parsing/v2 → v2/parsing}/common_response.rb +6 -4
- data/lib/mindee/{parsing/v2 → v2/parsing}/error_item.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/error_response.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/field/base_field.rb +3 -3
- data/lib/mindee/{parsing/v2 → v2/parsing}/field/field_confidence.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/field/field_location.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/field/inference_fields.rb +3 -3
- data/lib/mindee/{parsing/v2 → v2/parsing}/field/list_field.rb +5 -5
- data/lib/mindee/{parsing/v2 → v2/parsing}/field/object_field.rb +11 -8
- data/lib/mindee/{parsing/v2 → v2/parsing}/field/simple_field.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/inference_active_options.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/inference_file.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/inference_job.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/inference_model.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/job.rb +3 -3
- data/lib/mindee/{parsing/v2 → v2/parsing}/job_response.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/job_webhook.rb +2 -3
- data/lib/mindee/{parsing/v2 → v2/parsing}/rag_metadata.rb +2 -2
- data/lib/mindee/{parsing/v2 → v2/parsing}/raw_text.rb +6 -4
- data/lib/mindee/{parsing/v2 → v2/parsing}/raw_text_page.rb +4 -2
- data/lib/mindee/v2/parsing/search/pagination_metadata.rb +44 -0
- data/lib/mindee/v2/parsing/search/search_model.rb +38 -0
- data/lib/mindee/v2/parsing/search/search_models.rb +34 -0
- data/lib/mindee/v2/parsing/search/search_response.rb +38 -0
- data/lib/mindee/v2/parsing/search.rb +6 -0
- data/lib/mindee/v2/parsing.rb +16 -0
- data/lib/mindee/v2/product/base_product.rb +1 -0
- data/lib/mindee/v2/product/classification/classification.rb +1 -0
- data/lib/mindee/v2/product/classification/classification_inference.rb +1 -0
- data/lib/mindee/v2/product/classification/params/classification_parameters.rb +1 -0
- data/lib/mindee/v2/product/crop/crop.rb +1 -0
- data/lib/mindee/v2/product/crop/crop_item.rb +12 -2
- data/lib/mindee/v2/product/crop/crop_response.rb +8 -0
- data/lib/mindee/v2/product/crop/params/crop_parameters.rb +1 -0
- data/lib/mindee/v2/product/extraction/extraction.rb +3 -1
- data/lib/mindee/v2/product/extraction/extraction_inference.rb +19 -4
- data/lib/mindee/v2/product/extraction/extraction_response.rb +11 -2
- data/lib/mindee/v2/product/extraction/extraction_result.rb +31 -2
- data/lib/mindee/v2/product/extraction/params/data_schema.rb +51 -0
- data/lib/mindee/v2/product/extraction/params/data_schema_field.rb +69 -0
- data/lib/mindee/v2/product/extraction/params/data_schema_replace.rb +39 -0
- data/lib/mindee/v2/product/extraction/params/extraction_parameters.rb +110 -3
- data/lib/mindee/v2/product/ocr/ocr.rb +6 -5
- data/lib/mindee/v2/product/ocr/ocr_inference.rb +4 -4
- data/lib/mindee/v2/product/ocr/ocr_page.rb +5 -5
- data/lib/mindee/v2/product/ocr/ocr_response.rb +4 -4
- data/lib/mindee/v2/product/ocr/ocr_result.rb +4 -4
- data/lib/mindee/v2/product/ocr/ocr_word.rb +2 -2
- data/lib/mindee/v2/product/ocr/params/ocr_parameters.rb +5 -4
- data/lib/mindee/v2/product/split/params/split_parameters.rb +2 -0
- data/lib/mindee/v2/product/split/split_range.rb +8 -0
- data/lib/mindee/v2/product/split/split_response.rb +8 -0
- data/lib/mindee/v2.rb +5 -2
- data/lib/mindee/version.rb +1 -1
- data/lib/mindee.rb +59 -23
- data/mindee-lite.gemspec +36 -0
- data/mindee.gemspec +13 -13
- data/sig/custom/marcel.rbs +1 -1
- data/sig/custom/net_http.rbs +1 -1
- data/sig/custom/origami.rbs +1 -1
- data/sig/mindee/dependencies.rbs +13 -0
- data/sig/mindee/{errors → error}/mindee_error.rbs +2 -2
- data/sig/mindee/{errors → error}/mindee_http_error.rbs +3 -3
- data/sig/mindee/{errors → error}/mindee_http_error_v2.rbs +4 -4
- data/sig/mindee/{errors → error}/mindee_http_unknown_error_v2.rbs +2 -2
- data/sig/mindee/{errors → error}/mindee_input_error.rbs +2 -2
- data/sig/mindee/http/http_error_handler.rbs +4 -4
- data/sig/mindee/image/extracted_image.rbs +8 -2
- data/sig/mindee/image/image_extractor.rbs +2 -2
- data/sig/mindee/input/base_parameters.rbs +1 -1
- data/sig/mindee/input/local_response.rbs +1 -1
- data/sig/mindee/input/sources/local_input_source.rbs +0 -1
- data/sig/mindee/pdf/extracted_pdf.rbs +11 -9
- data/sig/mindee/pdf/pdf_extractor.rbs +12 -10
- data/sig/mindee/pdf/pdf_tools.rbs +2 -0
- data/sig/mindee/v1/client.rbs +84 -0
- data/sig/mindee/v1/extraction/multi_receipts_extractor.rbs +8 -0
- data/sig/mindee/v1/http/endpoint.rbs +41 -0
- data/sig/mindee/v1/http/workflow_endpoint.rbs +22 -0
- data/sig/mindee/v1/parsing/common/api_request.rbs +22 -0
- data/sig/mindee/v1/parsing/common/api_response.rbs +31 -0
- data/sig/mindee/v1/parsing/common/document.rbs +32 -0
- data/sig/mindee/v1/parsing/common/execution.rbs +26 -0
- data/sig/mindee/v1/parsing/common/execution_file.rbs +16 -0
- data/sig/mindee/v1/parsing/common/execution_priority.rbs +16 -0
- data/sig/mindee/v1/parsing/common/extras/cropper_extra.rbs +18 -0
- data/sig/mindee/v1/parsing/common/extras/extras.rbs +24 -0
- data/sig/mindee/v1/parsing/common/extras/full_text_ocr_extra.rbs +22 -0
- data/sig/mindee/v1/parsing/common/extras/rag_extra.rbs +19 -0
- data/sig/mindee/v1/parsing/common/inference.rbs +31 -0
- data/sig/mindee/v1/parsing/common/job.rbs +24 -0
- data/sig/mindee/v1/parsing/common/ocr/mvision_v1.rbs +20 -0
- data/sig/mindee/v1/parsing/common/ocr/ocr.rbs +56 -0
- data/sig/mindee/v1/parsing/common/orientation.rbs +15 -0
- data/sig/mindee/v1/parsing/common/page.rbs +19 -0
- data/sig/mindee/v1/parsing/common/prediction.rbs +14 -0
- data/sig/mindee/v1/parsing/common/product.rbs +16 -0
- data/sig/mindee/v1/parsing/common/workflow_response.rbs +22 -0
- data/sig/mindee/v1/parsing/standard/abstract_field.rbs +30 -0
- data/sig/mindee/v1/parsing/standard/address_field.rbs +28 -0
- data/sig/mindee/v1/parsing/standard/amount_field.rbs +16 -0
- data/sig/mindee/v1/parsing/standard/base_field.rbs +16 -0
- data/sig/mindee/v1/parsing/standard/boolean_field.rbs +16 -0
- data/sig/mindee/v1/parsing/standard/classification_field.rbs +12 -0
- data/sig/mindee/v1/parsing/standard/company_registration_field.rbs +20 -0
- data/sig/mindee/v1/parsing/standard/date_field.rbs +20 -0
- data/sig/mindee/v1/parsing/standard/feature_field.rbs +12 -0
- data/sig/mindee/v1/parsing/standard/locale_field.rbs +24 -0
- data/sig/mindee/v1/parsing/standard/payment_details_field.rbs +19 -0
- data/sig/mindee/v1/parsing/standard/position_field.rbs +26 -0
- data/sig/mindee/v1/parsing/standard/string_field.rbs +16 -0
- data/sig/mindee/v1/parsing/standard/tax_field.rbs +33 -0
- data/sig/mindee/v1/parsing/universal/universal_list_field.rbs +21 -0
- data/sig/mindee/v1/parsing/universal/universal_object_field.rbs +38 -0
- data/sig/mindee/{product → v1/product}/barcode_reader/barcode_reader_v1.rbs +4 -2
- data/sig/mindee/{product → v1/product}/barcode_reader/barcode_reader_v1_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/barcode_reader/barcode_reader_v1_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/cropper/cropper_v1.rbs +4 -2
- data/sig/mindee/{product → v1/product}/cropper/cropper_v1_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/cropper/cropper_v1_page.rbs +6 -3
- data/sig/mindee/{product → v1/product}/financial_document/financial_document_v1.rbs +4 -2
- data/sig/mindee/{product → v1/product}/financial_document/financial_document_v1_document.rbs +4 -2
- data/sig/mindee/v1/product/financial_document/financial_document_v1_line_item.rbs +35 -0
- data/sig/mindee/{product → v1/product}/financial_document/financial_document_v1_line_items.rbs +3 -1
- data/sig/mindee/{product → v1/product}/financial_document/financial_document_v1_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_account_details/bank_account_details_v1.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_account_details/bank_account_details_v1_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_account_details/bank_account_details_v1_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_account_details/bank_account_details_v2.rbs +4 -2
- data/sig/mindee/v1/product/fr/bank_account_details/bank_account_details_v2_bban.rbs +25 -0
- data/sig/mindee/{product → v1/product}/fr/bank_account_details/bank_account_details_v2_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_account_details/bank_account_details_v2_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_statement/bank_statement_v2.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_statement/bank_statement_v2_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/bank_statement/bank_statement_v2_page.rbs +4 -2
- data/sig/mindee/v1/product/fr/bank_statement/bank_statement_v2_transaction.rbs +27 -0
- data/sig/mindee/{product → v1/product}/fr/bank_statement/bank_statement_v2_transactions.rbs +3 -1
- data/sig/mindee/v1/product/fr/id_card/id_card_v1.rbs +15 -0
- data/sig/mindee/{product → v1/product}/fr/id_card/id_card_v1_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/id_card/id_card_v1_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/id_card/id_card_v2.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/id_card/id_card_v2_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/fr/id_card/id_card_v2_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/international_id/international_id_v2.rbs +4 -2
- data/sig/mindee/{product → v1/product}/international_id/international_id_v2_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/international_id/international_id_v2_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/invoice/invoice_v4.rbs +4 -2
- data/sig/mindee/{product → v1/product}/invoice/invoice_v4_document.rbs +4 -2
- data/sig/mindee/{product/fr/energy_bill/energy_bill_v1_taxes_and_contribution.rbs → v1/product/invoice/invoice_v4_line_item.rbs} +22 -8
- data/sig/mindee/{product → v1/product}/invoice/invoice_v4_line_items.rbs +3 -1
- data/sig/mindee/{product → v1/product}/invoice/invoice_v4_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/invoice_splitter/invoice_splitter_v1.rbs +4 -2
- data/sig/mindee/{product → v1/product}/invoice_splitter/invoice_splitter_v1_document.rbs +5 -3
- data/sig/mindee/{product/us/healthcare_card/healthcare_card_v1_copay.rbs → v1/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rbs} +11 -7
- data/sig/mindee/{product → v1/product}/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rbs +3 -1
- data/sig/mindee/{product → v1/product}/invoice_splitter/invoice_splitter_v1_page.rbs +4 -2
- data/sig/mindee/v1/product/multi_receipts_detector/multi_receipts_detector_v1.rbs +14 -0
- data/sig/mindee/{product → v1/product}/multi_receipts_detector/multi_receipts_detector_v1_document.rbs +5 -3
- data/sig/mindee/{product → v1/product}/multi_receipts_detector/multi_receipts_detector_v1_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/passport/passport_v1.rbs +4 -2
- data/sig/mindee/{product → v1/product}/passport/passport_v1_document.rbs +4 -2
- data/sig/mindee/{product → v1/product}/passport/passport_v1_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/receipt/receipt_v5.rbs +4 -2
- data/sig/mindee/{product → v1/product}/receipt/receipt_v5_document.rbs +4 -2
- data/sig/mindee/{product/fr/bank_statement/bank_statement_v2_transaction.rbs → v1/product/receipt/receipt_v5_line_item.rbs} +16 -7
- data/sig/mindee/{product → v1/product}/receipt/receipt_v5_line_items.rbs +3 -1
- data/sig/mindee/{product → v1/product}/receipt/receipt_v5_page.rbs +4 -2
- data/sig/mindee/{product → v1/product}/resume/resume_v1.rbs +4 -2
- data/sig/mindee/v1/product/resume/resume_v1_certificate.rbs +27 -0
- data/sig/mindee/{product/fr/payslip/payslip_v3_paid_time_offs.rbs → v1/product/resume/resume_v1_certificates.rbs} +6 -4
- data/sig/mindee/v1/product/resume/resume_v1_document.rbs +69 -0
- data/sig/mindee/v1/product/resume/resume_v1_education.rbs +33 -0
- data/sig/mindee/{product/fr/payslip/payslip_v2_salary_details.rbs → v1/product/resume/resume_v1_educations.rbs} +6 -4
- data/sig/mindee/v1/product/resume/resume_v1_language.rbs +23 -0
- data/sig/mindee/{product/fr/payslip/payslip_v3_salary_details.rbs → v1/product/resume/resume_v1_languages.rbs} +6 -4
- data/sig/mindee/{product/us/us_mail/us_mail_v3_page.rbs → v1/product/resume/resume_v1_page.rbs} +8 -6
- data/sig/mindee/v1/product/resume/resume_v1_professional_experience.rbs +37 -0
- data/sig/mindee/{product/fr/energy_bill/energy_bill_v1_subscriptions.rbs → v1/product/resume/resume_v1_professional_experiences.rbs} +6 -4
- data/sig/mindee/v1/product/resume/resume_v1_social_networks_url.rbs +23 -0
- data/sig/mindee/{product/fr/energy_bill/energy_bill_v1_energy_usages.rbs → v1/product/resume/resume_v1_social_networks_urls.rbs} +6 -4
- data/sig/mindee/{product → v1/product}/universal/universal.rbs +4 -2
- data/sig/mindee/{product → v1/product}/universal/universal_document.rbs +4 -2
- data/sig/mindee/v1/product/universal/universal_page.rbs +18 -0
- data/sig/mindee/v1/product/universal/universal_prediction.rbs +30 -0
- data/sig/mindee/v2/client.rbs +29 -0
- data/sig/mindee/v2/file_operation/crop.rbs +10 -0
- data/sig/mindee/v2/file_operation/crop_files.rbs +9 -0
- data/sig/mindee/v2/file_operation/split.rbs +11 -0
- data/sig/mindee/v2/file_operation/split_files.rbs +9 -0
- data/sig/mindee/v2/http/api_v2_settings.rbs +27 -0
- data/sig/mindee/v2/http/mindee_api_v2.rbs +52 -0
- data/sig/mindee/v2/parsing/base_inference.rbs +3 -3
- data/sig/mindee/v2/parsing/base_response.rbs +1 -1
- data/sig/mindee/v2/parsing/common_response.rbs +12 -0
- data/sig/mindee/v2/parsing/error_item.rbs +13 -0
- data/sig/mindee/{parsing/v2 → v2/parsing}/error_response.rbs +4 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/field/base_field.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/field/field_confidence.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/field/field_location.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/field/inference_fields.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/field/list_field.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/field/object_field.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/field/simple_field.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/inference_active_options.rbs +6 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/inference_file.rbs +5 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/inference_job.rbs +3 -2
- data/sig/mindee/{parsing/v2 → v2/parsing}/inference_model.rbs +4 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/job.rbs +4 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/job_response.rbs +5 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/job_webhook.rbs +5 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/rag_metadata.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/raw_text.rbs +3 -3
- data/sig/mindee/{parsing/v2 → v2/parsing}/raw_text_page.rbs +2 -2
- data/sig/mindee/v2/parsing/search/pagination_metadata.rbs +20 -0
- data/sig/mindee/v2/parsing/search/search_model.rbs +19 -0
- data/sig/mindee/v2/parsing/search/search_response.rbs +17 -0
- data/sig/mindee/v2/parsing/search_models.rbs +14 -0
- data/sig/mindee/v2/product/classification/classification_response.rbs +1 -1
- data/sig/mindee/v2/product/crop/crop_item.rbs +4 -1
- data/sig/mindee/v2/product/crop/crop_response.rbs +3 -1
- data/sig/mindee/v2/product/extraction/extraction.rbs +3 -0
- data/sig/mindee/v2/product/extraction/extraction_inference.rbs +5 -0
- data/sig/mindee/v2/product/extraction/extraction_response.rbs +8 -2
- data/sig/mindee/v2/product/extraction/extraction_result.rbs +9 -1
- data/sig/mindee/v2/product/extraction/params/data_schema.rbs +21 -0
- data/sig/mindee/v2/product/extraction/params/data_schema_field.rbs +29 -0
- data/sig/mindee/v2/product/extraction/params/data_schema_replace.rbs +21 -0
- data/sig/mindee/v2/product/extraction/params/extraction_parameters.rbs +27 -1
- data/sig/mindee/v2/product/ocr/ocr.rbs +2 -2
- data/sig/mindee/v2/product/ocr/ocr_inference.rbs +3 -3
- data/sig/mindee/v2/product/ocr/ocr_page.rbs +3 -3
- data/sig/mindee/v2/product/ocr/ocr_response.rbs +6 -6
- data/sig/mindee/v2/product/ocr/ocr_result.rbs +3 -3
- data/sig/mindee/v2/product/ocr/ocr_word.rbs +2 -2
- data/sig/mindee/v2/product/ocr/params/ocr_parameters/ocr_parameters.rbs +3 -3
- data/sig/mindee/v2/product/split/split_range.rbs +4 -1
- data/sig/mindee/v2/product/split/split_response.rbs +3 -1
- data/sig/mindee.rbs +12 -9
- metadata +360 -568
- data/bin/cli_products.rb +0 -166
- data/docs/code_samples/bank_check_v1.txt +0 -24
- data/docs/code_samples/bill_of_lading_v1_async.txt +0 -24
- data/docs/code_samples/business_card_v1_async.txt +0 -24
- data/docs/code_samples/carte_grise_v1.txt +0 -24
- data/docs/code_samples/delivery_notes_v1_async.txt +0 -24
- data/docs/code_samples/driver_license_v1_async.txt +0 -24
- data/docs/code_samples/energy_bill_fra_v1_async.txt +0 -24
- data/docs/code_samples/french_healthcard_v1_async.txt +0 -24
- data/docs/code_samples/ind_passport_v1_async.txt +0 -24
- data/docs/code_samples/nutrition_facts_v1_async.txt +0 -24
- data/docs/code_samples/payslip_fra_v2_async.txt +0 -24
- data/docs/code_samples/payslip_fra_v3_async.txt +0 -24
- data/docs/code_samples/us_healthcare_cards_v1_async.txt +0 -24
- data/docs/code_samples/us_mail_v3_async.txt +0 -24
- data/lib/mindee/client.rb +0 -488
- data/lib/mindee/client_v2.rb +0 -161
- data/lib/mindee/errors.rb +0 -6
- data/lib/mindee/extraction/multi_receipts_extractor.rb +0 -30
- data/lib/mindee/http/api_settings_v2.rb +0 -63
- data/lib/mindee/http/endpoint.rb +0 -219
- data/lib/mindee/http/mindee_api_v2.rb +0 -215
- data/lib/mindee/http/workflow_endpoint.rb +0 -91
- data/lib/mindee/input/data_schema.rb +0 -126
- data/lib/mindee/input/inference_parameters.rb +0 -119
- data/lib/mindee/parsing/common/api_request.rb +0 -36
- data/lib/mindee/parsing/common/api_response.rb +0 -61
- data/lib/mindee/parsing/common/document.rb +0 -84
- data/lib/mindee/parsing/common/execution.rb +0 -75
- data/lib/mindee/parsing/common/execution_file.rb +0 -24
- data/lib/mindee/parsing/common/execution_priority.rb +0 -36
- data/lib/mindee/parsing/common/extras/cropper_extra.rb +0 -30
- data/lib/mindee/parsing/common/extras/extras.rb +0 -58
- data/lib/mindee/parsing/common/extras/full_text_ocr_extra.rb +0 -33
- data/lib/mindee/parsing/common/extras/rag_extra.rb +0 -26
- data/lib/mindee/parsing/common/inference.rb +0 -67
- data/lib/mindee/parsing/common/job.rb +0 -46
- data/lib/mindee/parsing/common/ocr/mvision_v1.rb +0 -50
- data/lib/mindee/parsing/common/ocr/ocr.rb +0 -178
- data/lib/mindee/parsing/common/orientation.rb +0 -26
- data/lib/mindee/parsing/common/page.rb +0 -47
- data/lib/mindee/parsing/common/prediction.rb +0 -17
- data/lib/mindee/parsing/common/product.rb +0 -24
- data/lib/mindee/parsing/common/workflow_response.rb +0 -28
- data/lib/mindee/parsing/standard/abstract_field.rb +0 -72
- data/lib/mindee/parsing/standard/address_field.rb +0 -49
- data/lib/mindee/parsing/standard/amount_field.rb +0 -26
- data/lib/mindee/parsing/standard/base_field.rb +0 -28
- data/lib/mindee/parsing/standard/boolean_field.rb +0 -27
- data/lib/mindee/parsing/standard/classification_field.rb +0 -16
- data/lib/mindee/parsing/standard/company_registration_field.rb +0 -43
- data/lib/mindee/parsing/standard/date_field.rb +0 -38
- data/lib/mindee/parsing/standard/feature_field.rb +0 -24
- data/lib/mindee/parsing/standard/locale_field.rb +0 -50
- data/lib/mindee/parsing/standard/payment_details_field.rb +0 -42
- data/lib/mindee/parsing/standard/position_field.rb +0 -59
- data/lib/mindee/parsing/standard/string_field.rb +0 -24
- data/lib/mindee/parsing/standard/tax_field.rb +0 -108
- data/lib/mindee/parsing/universal/universal_list_field.rb +0 -58
- data/lib/mindee/parsing/universal/universal_object_field.rb +0 -121
- data/lib/mindee/parsing/v2/inference.rb +0 -44
- data/lib/mindee/parsing/v2/inference_response.rb +0 -33
- data/lib/mindee/parsing/v2/inference_result.rb +0 -42
- data/lib/mindee/parsing/v2.rb +0 -16
- data/lib/mindee/product/barcode_reader/barcode_reader_v1.rb +0 -45
- data/lib/mindee/product/barcode_reader/barcode_reader_v1_document.rb +0 -44
- data/lib/mindee/product/barcode_reader/barcode_reader_v1_page.rb +0 -36
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1.rb +0 -45
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier.rb +0 -52
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_item.rb +0 -101
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_items.rb +0 -62
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_consignee.rb +0 -58
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_document.rb +0 -163
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_notify_party.rb +0 -58
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_page.rb +0 -36
- data/lib/mindee/product/bill_of_lading/bill_of_lading_v1_shipper.rb +0 -58
- data/lib/mindee/product/business_card/business_card_v1.rb +0 -45
- data/lib/mindee/product/business_card/business_card_v1_document.rb +0 -112
- data/lib/mindee/product/business_card/business_card_v1_page.rb +0 -36
- data/lib/mindee/product/cropper/cropper_v1.rb +0 -45
- data/lib/mindee/product/cropper/cropper_v1_document.rb +0 -13
- data/lib/mindee/product/cropper/cropper_v1_page.rb +0 -53
- data/lib/mindee/product/delivery_note/delivery_note_v1.rb +0 -45
- data/lib/mindee/product/delivery_note/delivery_note_v1_document.rb +0 -82
- data/lib/mindee/product/delivery_note/delivery_note_v1_page.rb +0 -36
- data/lib/mindee/product/driver_license/driver_license_v1.rb +0 -45
- data/lib/mindee/product/driver_license/driver_license_v1_document.rb +0 -121
- data/lib/mindee/product/driver_license/driver_license_v1_page.rb +0 -36
- data/lib/mindee/product/financial_document/financial_document_v1.rb +0 -45
- data/lib/mindee/product/financial_document/financial_document_v1_document.rb +0 -326
- data/lib/mindee/product/financial_document/financial_document_v1_line_item.rb +0 -121
- data/lib/mindee/product/financial_document/financial_document_v1_line_items.rb +0 -62
- data/lib/mindee/product/financial_document/financial_document_v1_page.rb +0 -36
- data/lib/mindee/product/fr/bank_account_details/bank_account_details_v1_document.rb +0 -46
- data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2.rb +0 -47
- data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rb +0 -60
- data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_document.rb +0 -57
- data/lib/mindee/product/fr/bank_account_details/bank_account_details_v2_page.rb +0 -38
- data/lib/mindee/product/fr/bank_statement/bank_statement_v2_document.rb +0 -166
- data/lib/mindee/product/fr/bank_statement/bank_statement_v2_transaction.rb +0 -75
- data/lib/mindee/product/fr/carte_grise/carte_grise_v1_document.rb +0 -242
- data/lib/mindee/product/fr/energy_bill/energy_bill_v1_document.rb +0 -265
- data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_consumer.rb +0 -48
- data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_supplier.rb +0 -48
- data/lib/mindee/product/fr/energy_bill/energy_bill_v1_energy_usage.rb +0 -121
- data/lib/mindee/product/fr/energy_bill/energy_bill_v1_meter_detail.rb +0 -54
- data/lib/mindee/product/fr/energy_bill/energy_bill_v1_subscription.rb +0 -103
- data/lib/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contribution.rb +0 -103
- data/lib/mindee/product/fr/health_card/health_card_v1.rb +0 -47
- data/lib/mindee/product/fr/health_card/health_card_v1_document.rb +0 -61
- data/lib/mindee/product/fr/id_card/id_card_v1_page.rb +0 -55
- data/lib/mindee/product/fr/id_card/id_card_v2.rb +0 -47
- data/lib/mindee/product/fr/id_card/id_card_v2_document.rb +0 -140
- data/lib/mindee/product/fr/id_card/id_card_v2_page.rb +0 -63
- data/lib/mindee/product/fr/payslip/payslip_v2_bank_account_detail.rb +0 -54
- data/lib/mindee/product/fr/payslip/payslip_v2_document.rb +0 -143
- data/lib/mindee/product/fr/payslip/payslip_v2_employee.rb +0 -78
- data/lib/mindee/product/fr/payslip/payslip_v2_employer.rb +0 -78
- data/lib/mindee/product/fr/payslip/payslip_v2_employment.rb +0 -73
- data/lib/mindee/product/fr/payslip/payslip_v2_pay_detail.rb +0 -122
- data/lib/mindee/product/fr/payslip/payslip_v2_pay_period.rb +0 -66
- data/lib/mindee/product/fr/payslip/payslip_v2_pto.rb +0 -65
- data/lib/mindee/product/fr/payslip/payslip_v2_salary_detail.rb +0 -87
- data/lib/mindee/product/fr/payslip/payslip_v3_bank_account_detail.rb +0 -54
- data/lib/mindee/product/fr/payslip/payslip_v3_document.rb +0 -178
- data/lib/mindee/product/fr/payslip/payslip_v3_employee.rb +0 -78
- data/lib/mindee/product/fr/payslip/payslip_v3_employer.rb +0 -78
- data/lib/mindee/product/fr/payslip/payslip_v3_employment.rb +0 -78
- data/lib/mindee/product/fr/payslip/payslip_v3_paid_time_off.rb +0 -95
- data/lib/mindee/product/fr/payslip/payslip_v3_pay_detail.rb +0 -122
- data/lib/mindee/product/fr/payslip/payslip_v3_pay_period.rb +0 -66
- data/lib/mindee/product/fr/payslip/payslip_v3_salary_detail.rb +0 -97
- data/lib/mindee/product/fr/payslip/payslip_v3_salary_details.rb +0 -65
- data/lib/mindee/product/ind/indian_passport/indian_passport_v1_document.rb +0 -206
- data/lib/mindee/product/ind/indian_passport/indian_passport_v1_page.rb +0 -38
- data/lib/mindee/product/international_id/international_id_v2.rb +0 -45
- data/lib/mindee/product/international_id/international_id_v2_document.rb +0 -161
- data/lib/mindee/product/international_id/international_id_v2_page.rb +0 -36
- data/lib/mindee/product/invoice/invoice_v4.rb +0 -45
- data/lib/mindee/product/invoice/invoice_v4_document.rb +0 -297
- data/lib/mindee/product/invoice/invoice_v4_line_item.rb +0 -121
- data/lib/mindee/product/invoice/invoice_v4_line_items.rb +0 -62
- data/lib/mindee/product/invoice/invoice_v4_page.rb +0 -36
- data/lib/mindee/product/invoice_splitter/invoice_splitter_v1.rb +0 -45
- data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_document.rb +0 -63
- data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rb +0 -55
- data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_groups.rb +0 -48
- data/lib/mindee/product/invoice_splitter/invoice_splitter_v1_page.rb +0 -36
- data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rb +0 -45
- data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_document.rb +0 -35
- data/lib/mindee/product/multi_receipts_detector/multi_receipts_detector_v1_page.rb +0 -36
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1.rb +0 -45
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_added_sugar.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_calorie.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_cholesterol.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_dietary_fiber.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_document.rb +0 -211
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrient.rb +0 -93
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrients.rb +0 -68
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_page.rb +0 -36
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_protein.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_saturated_fat.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_serving_size.rb +0 -47
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_sodium.rb +0 -61
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_carbohydrate.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_fat.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_sugar.rb +0 -55
- data/lib/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_trans_fat.rb +0 -55
- data/lib/mindee/product/passport/passport_v1.rb +0 -45
- data/lib/mindee/product/passport/passport_v1_document.rb +0 -109
- data/lib/mindee/product/passport/passport_v1_page.rb +0 -36
- data/lib/mindee/product/receipt/receipt_v5.rb +0 -45
- data/lib/mindee/product/receipt/receipt_v5_document.rb +0 -184
- data/lib/mindee/product/receipt/receipt_v5_line_item.rb +0 -85
- data/lib/mindee/product/receipt/receipt_v5_line_items.rb +0 -54
- data/lib/mindee/product/receipt/receipt_v5_page.rb +0 -36
- data/lib/mindee/product/resume/resume_v1.rb +0 -45
- data/lib/mindee/product/resume/resume_v1_certificate.rb +0 -79
- data/lib/mindee/product/resume/resume_v1_certificates.rb +0 -58
- data/lib/mindee/product/resume/resume_v1_document.rb +0 -337
- data/lib/mindee/product/resume/resume_v1_education.rb +0 -103
- data/lib/mindee/product/resume/resume_v1_educations.rb +0 -64
- data/lib/mindee/product/resume/resume_v1_language.rb +0 -63
- data/lib/mindee/product/resume/resume_v1_languages.rb +0 -54
- data/lib/mindee/product/resume/resume_v1_page.rb +0 -36
- data/lib/mindee/product/resume/resume_v1_professional_experience.rb +0 -119
- data/lib/mindee/product/resume/resume_v1_professional_experiences.rb +0 -68
- data/lib/mindee/product/resume/resume_v1_social_networks_url.rb +0 -63
- data/lib/mindee/product/resume/resume_v1_social_networks_urls.rb +0 -54
- data/lib/mindee/product/universal/universal.rb +0 -46
- data/lib/mindee/product/universal/universal_document.rb +0 -32
- data/lib/mindee/product/universal/universal_page.rb +0 -51
- data/lib/mindee/product/universal/universal_prediction.rb +0 -122
- data/lib/mindee/product/us/bank_check/bank_check_v1_document.rb +0 -74
- data/lib/mindee/product/us/bank_check/bank_check_v1_page.rb +0 -64
- data/lib/mindee/product/us/healthcare_card/healthcare_card_v1.rb +0 -47
- data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_copay.rb +0 -67
- data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_document.rb +0 -167
- data/lib/mindee/product/us/healthcare_card/healthcare_card_v1_page.rb +0 -38
- data/lib/mindee/product/us/us_mail/us_mail_v3_document.rb +0 -115
- data/lib/mindee/product/us/us_mail/us_mail_v3_recipient_address.rb +0 -113
- data/lib/mindee/product/us/us_mail/us_mail_v3_sender_address.rb +0 -66
- data/sig/mindee/client.rbs +0 -61
- data/sig/mindee/client_v2.rbs +0 -21
- data/sig/mindee/extraction/multi_receipts_extractor.rbs +0 -6
- data/sig/mindee/http/api_settings_v2.rbs +0 -23
- data/sig/mindee/http/endpoint.rbs +0 -29
- data/sig/mindee/http/mindee_api_v2.rbs +0 -38
- data/sig/mindee/http/workflow_endpoint.rbs +0 -20
- data/sig/mindee/input/data_schema.rbs +0 -34
- data/sig/mindee/input/inference_parameters.rbs +0 -32
- data/sig/mindee/parsing/common/api_request.rbs +0 -15
- data/sig/mindee/parsing/common/api_response.rbs +0 -27
- data/sig/mindee/parsing/common/document.rbs +0 -20
- data/sig/mindee/parsing/common/execution.rbs +0 -24
- data/sig/mindee/parsing/common/execution_file.rbs +0 -12
- data/sig/mindee/parsing/common/execution_priority.rbs +0 -13
- data/sig/mindee/parsing/common/extras/cropper_extra.rbs +0 -15
- data/sig/mindee/parsing/common/extras/extras.rbs +0 -19
- data/sig/mindee/parsing/common/extras/full_text_ocr_extra.rbs +0 -16
- data/sig/mindee/parsing/common/extras/rag_extra.rbs +0 -15
- data/sig/mindee/parsing/common/inference.rbs +0 -26
- data/sig/mindee/parsing/common/job.rbs +0 -16
- data/sig/mindee/parsing/common/ocr/mvision_v1.rbs +0 -15
- data/sig/mindee/parsing/common/ocr/ocr.rbs +0 -41
- data/sig/mindee/parsing/common/orientation.rbs +0 -13
- data/sig/mindee/parsing/common/page.rbs +0 -16
- data/sig/mindee/parsing/common/prediction.rbs +0 -11
- data/sig/mindee/parsing/common/product.rbs +0 -13
- data/sig/mindee/parsing/common/workflow_response.rbs +0 -17
- data/sig/mindee/parsing/standard/abstract_field.rbs +0 -19
- data/sig/mindee/parsing/standard/address_field.rbs +0 -18
- data/sig/mindee/parsing/standard/amount_field.rbs +0 -14
- data/sig/mindee/parsing/standard/base_field.rbs +0 -12
- data/sig/mindee/parsing/standard/boolean_field.rbs +0 -12
- data/sig/mindee/parsing/standard/classification_field.rbs +0 -10
- data/sig/mindee/parsing/standard/company_registration_field.rbs +0 -15
- data/sig/mindee/parsing/standard/date_field.rbs +0 -14
- data/sig/mindee/parsing/standard/feature_field.rbs +0 -10
- data/sig/mindee/parsing/standard/locale_field.rbs +0 -16
- data/sig/mindee/parsing/standard/payment_details_field.rbs +0 -16
- data/sig/mindee/parsing/standard/position_field.rbs +0 -17
- data/sig/mindee/parsing/standard/string_field.rbs +0 -12
- data/sig/mindee/parsing/standard/tax_field.rbs +0 -24
- data/sig/mindee/parsing/universal/universal_list_field.rbs +0 -16
- data/sig/mindee/parsing/universal/universal_object_field.rbs +0 -29
- data/sig/mindee/parsing/v2/common_response.rbs +0 -11
- data/sig/mindee/parsing/v2/error_item.rbs +0 -13
- data/sig/mindee/parsing/v2/inference.rbs +0 -18
- data/sig/mindee/parsing/v2/inference_response.rbs +0 -21
- data/sig/mindee/parsing/v2/inference_result.rbs +0 -15
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1.rbs +0 -11
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier.rbs +0 -14
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_item.rbs +0 -19
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_carrier_items.rbs +0 -13
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_consignee.rbs +0 -15
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_document.rbs +0 -25
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_notify_party.rbs +0 -15
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_page.rbs +0 -15
- data/sig/mindee/product/bill_of_lading/bill_of_lading_v1_shipper.rbs +0 -15
- data/sig/mindee/product/business_card/business_card_v1.rbs +0 -11
- data/sig/mindee/product/business_card/business_card_v1_document.rbs +0 -23
- data/sig/mindee/product/business_card/business_card_v1_page.rbs +0 -15
- data/sig/mindee/product/delivery_note/delivery_note_v1.rbs +0 -11
- data/sig/mindee/product/delivery_note/delivery_note_v1_document.rbs +0 -19
- data/sig/mindee/product/delivery_note/delivery_note_v1_page.rbs +0 -15
- data/sig/mindee/product/driver_license/driver_license_v1.rbs +0 -11
- data/sig/mindee/product/driver_license/driver_license_v1_document.rbs +0 -25
- data/sig/mindee/product/driver_license/driver_license_v1_page.rbs +0 -15
- data/sig/mindee/product/financial_document/financial_document_v1_line_item.rbs +0 -21
- data/sig/mindee/product/fr/bank_account_details/bank_account_details_v2_bban.rbs +0 -17
- data/sig/mindee/product/fr/carte_grise/carte_grise_v1.rbs +0 -13
- data/sig/mindee/product/fr/carte_grise/carte_grise_v1_document.rbs +0 -55
- data/sig/mindee/product/fr/carte_grise/carte_grise_v1_page.rbs +0 -17
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1.rbs +0 -13
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_document.rbs +0 -34
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_consumer.rbs +0 -15
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_supplier.rbs +0 -15
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_energy_usage.rbs +0 -23
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_meter_detail.rbs +0 -16
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_page.rbs +0 -17
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_subscription.rbs +0 -21
- data/sig/mindee/product/fr/energy_bill/energy_bill_v1_taxes_and_contributions.rbs +0 -15
- data/sig/mindee/product/fr/health_card/health_card_v1.rbs +0 -13
- data/sig/mindee/product/fr/health_card/health_card_v1_document.rbs +0 -18
- data/sig/mindee/product/fr/health_card/health_card_v1_page.rbs +0 -17
- data/sig/mindee/product/fr/id_card/id_card_v1.rbs +0 -13
- data/sig/mindee/product/fr/payslip/payslip_v2.rbs +0 -13
- data/sig/mindee/product/fr/payslip/payslip_v2_bank_account_detail.rbs +0 -16
- data/sig/mindee/product/fr/payslip/payslip_v2_document.rbs +0 -24
- data/sig/mindee/product/fr/payslip/payslip_v2_employee.rbs +0 -20
- data/sig/mindee/product/fr/payslip/payslip_v2_employer.rbs +0 -20
- data/sig/mindee/product/fr/payslip/payslip_v2_employment.rbs +0 -19
- data/sig/mindee/product/fr/payslip/payslip_v2_page.rbs +0 -17
- data/sig/mindee/product/fr/payslip/payslip_v2_pay_detail.rbs +0 -23
- data/sig/mindee/product/fr/payslip/payslip_v2_pay_period.rbs +0 -18
- data/sig/mindee/product/fr/payslip/payslip_v2_pto.rbs +0 -16
- data/sig/mindee/product/fr/payslip/payslip_v2_salary_detail.rbs +0 -19
- data/sig/mindee/product/fr/payslip/payslip_v3.rbs +0 -13
- data/sig/mindee/product/fr/payslip/payslip_v3_bank_account_detail.rbs +0 -16
- data/sig/mindee/product/fr/payslip/payslip_v3_document.rbs +0 -26
- data/sig/mindee/product/fr/payslip/payslip_v3_employee.rbs +0 -20
- data/sig/mindee/product/fr/payslip/payslip_v3_employer.rbs +0 -20
- data/sig/mindee/product/fr/payslip/payslip_v3_employment.rbs +0 -20
- data/sig/mindee/product/fr/payslip/payslip_v3_page.rbs +0 -17
- data/sig/mindee/product/fr/payslip/payslip_v3_paid_time_off.rbs +0 -20
- data/sig/mindee/product/fr/payslip/payslip_v3_pay_detail.rbs +0 -23
- data/sig/mindee/product/fr/payslip/payslip_v3_pay_period.rbs +0 -18
- data/sig/mindee/product/fr/payslip/payslip_v3_salary_detail.rbs +0 -20
- data/sig/mindee/product/ind/indian_passport/indian_passport_v1.rbs +0 -13
- data/sig/mindee/product/ind/indian_passport/indian_passport_v1_document.rbs +0 -37
- data/sig/mindee/product/ind/indian_passport/indian_passport_v1_page.rbs +0 -17
- data/sig/mindee/product/invoice/invoice_v4_line_item.rbs +0 -21
- data/sig/mindee/product/invoice_splitter/invoice_splitter_v1_invoice_page_group.rbs +0 -14
- data/sig/mindee/product/multi_receipts_detector/multi_receipts_detector_v1.rbs +0 -11
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1.rbs +0 -11
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_added_sugar.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_calorie.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_cholesterol.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_dietary_fiber.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_document.rbs +0 -28
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrient.rbs +0 -18
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_nutrients.rbs +0 -13
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_page.rbs +0 -15
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_protein.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_saturated_fat.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_serving_size.rbs +0 -13
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_sodium.rbs +0 -15
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_carbohydrate.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_fat.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_total_sugar.rbs +0 -14
- data/sig/mindee/product/nutrition_facts_label/nutrition_facts_label_v1_trans_fat.rbs +0 -14
- data/sig/mindee/product/receipt/receipt_v5_line_item.rbs +0 -17
- data/sig/mindee/product/resume/resume_v1_certificate.rbs +0 -17
- data/sig/mindee/product/resume/resume_v1_certificates.rbs +0 -13
- data/sig/mindee/product/resume/resume_v1_document.rbs +0 -39
- data/sig/mindee/product/resume/resume_v1_education.rbs +0 -20
- data/sig/mindee/product/resume/resume_v1_educations.rbs +0 -13
- data/sig/mindee/product/resume/resume_v1_language.rbs +0 -15
- data/sig/mindee/product/resume/resume_v1_languages.rbs +0 -13
- data/sig/mindee/product/resume/resume_v1_page.rbs +0 -15
- data/sig/mindee/product/resume/resume_v1_professional_experience.rbs +0 -22
- data/sig/mindee/product/resume/resume_v1_professional_experiences.rbs +0 -13
- data/sig/mindee/product/resume/resume_v1_social_networks_url.rbs +0 -15
- data/sig/mindee/product/resume/resume_v1_social_networks_urls.rbs +0 -13
- data/sig/mindee/product/universal/universal_page.rbs +0 -14
- data/sig/mindee/product/universal/universal_prediction.rbs +0 -19
- data/sig/mindee/product/us/bank_check/bank_check_v1.rbs +0 -13
- data/sig/mindee/product/us/bank_check/bank_check_v1_document.rbs +0 -20
- data/sig/mindee/product/us/bank_check/bank_check_v1_page.rbs +0 -19
- data/sig/mindee/product/us/healthcare_card/healthcare_card_v1.rbs +0 -13
- data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_copays.rbs +0 -15
- data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_document.rbs +0 -30
- data/sig/mindee/product/us/healthcare_card/healthcare_card_v1_page.rbs +0 -17
- data/sig/mindee/product/us/us_mail/us_mail_v3.rbs +0 -13
- data/sig/mindee/product/us/us_mail/us_mail_v3_document.rbs +0 -21
- data/sig/mindee/product/us/us_mail/us_mail_v3_recipient_address.rbs +0 -23
- data/sig/mindee/product/us/us_mail/us_mail_v3_recipient_addresses.rbs +0 -15
- data/sig/mindee/product/us/us_mail/us_mail_v3_sender_address.rbs +0 -18
- data/sig/mindee/product/us/w9/w9_v1.rbs +0 -13
- data/sig/mindee/product/us/w9/w9_v1_document.rbs +0 -14
- data/sig/mindee/product/us/w9/w9_v1_page.rbs +0 -29
- /data/lib/mindee/{extraction.rb → v1/extraction.rb} +0 -0
- /data/lib/mindee/{parsing → v1/parsing}/common/extras.rb +0 -0
- /data/lib/mindee/{parsing → v1/parsing}/common/ocr.rb +0 -0
- /data/lib/mindee/{parsing → v1/parsing}/common.rb +0 -0
- /data/lib/mindee/{parsing → v1/parsing}/standard.rb +0 -0
- /data/lib/mindee/{parsing → v1/parsing}/universal.rb +0 -0
- /data/lib/mindee/{parsing.rb → v1/parsing.rb} +0 -0
- /data/lib/mindee/{parsing/v2 → v2/parsing}/field.rb +0 -0
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative '../input'
|
|
4
|
+
require_relative '../http'
|
|
5
|
+
require_relative 'product'
|
|
6
|
+
require_relative 'parsing/job'
|
|
7
|
+
require_relative '../logging'
|
|
8
|
+
|
|
9
|
+
module Mindee
|
|
10
|
+
module V2
|
|
11
|
+
# Mindee V2 API Client.
|
|
12
|
+
class Client
|
|
13
|
+
# @return [V2::HTTP::MindeeApiV2]
|
|
14
|
+
private attr_reader :mindee_api
|
|
15
|
+
|
|
16
|
+
# @param api_key [String]
|
|
17
|
+
def initialize(api_key: '')
|
|
18
|
+
@mindee_api = Mindee::V2::HTTP::MindeeApiV2.new(api_key: api_key)
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
# Retrieves a result from a given queue or URL to the result.
|
|
22
|
+
# @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
|
|
23
|
+
# @param resource [String] ID of the inference or URL to the result.
|
|
24
|
+
# @return [Mindee::V2::Parsing::BaseResponse]
|
|
25
|
+
def get_result(product, resource)
|
|
26
|
+
@mindee_api.req_get_result(product, resource)
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
# Retrieves an inference from a given queue or URL to the job.
|
|
30
|
+
# @param job_id [String] ID of the job.
|
|
31
|
+
# @return [Mindee::V2::Parsing::JobResponse]
|
|
32
|
+
def get_job(job_id)
|
|
33
|
+
@mindee_api.req_get_job(job_id)
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
# Enqueue a document for async parsing.
|
|
37
|
+
# @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
|
|
38
|
+
# @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
|
|
39
|
+
# The source of the input document (local file or URL).
|
|
40
|
+
# @param params [Hash, Input::BaseParameters] Parameters for the inference.
|
|
41
|
+
# @return [Mindee::V2::Parsing::JobResponse]
|
|
42
|
+
def enqueue(
|
|
43
|
+
product,
|
|
44
|
+
input_source,
|
|
45
|
+
params
|
|
46
|
+
)
|
|
47
|
+
normalized_params = normalize_parameters(product.params_type, params)
|
|
48
|
+
normalized_params.validate_async_params
|
|
49
|
+
logger.debug("Enqueueing document to model '#{normalized_params.model_id}'.")
|
|
50
|
+
|
|
51
|
+
@mindee_api.req_post_enqueue(input_source, normalized_params)
|
|
52
|
+
end
|
|
53
|
+
|
|
54
|
+
# Enqueues to an asynchronous endpoint and automatically polls for a response.
|
|
55
|
+
#
|
|
56
|
+
# @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
|
|
57
|
+
# @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
|
|
58
|
+
# The source of the input document (local file or URL).
|
|
59
|
+
# @param params [Hash, Input::BaseParameters] Parameters for the inference.
|
|
60
|
+
# @return [Parsing::BaseResponse]
|
|
61
|
+
def enqueue_and_get_result(
|
|
62
|
+
product,
|
|
63
|
+
input_source,
|
|
64
|
+
params
|
|
65
|
+
)
|
|
66
|
+
enqueue_response = enqueue(product, input_source, params)
|
|
67
|
+
normalized_params = normalize_parameters(product.params_type, params)
|
|
68
|
+
normalized_params.validate_async_params
|
|
69
|
+
|
|
70
|
+
if enqueue_response.job.id.nil? || enqueue_response.job.id.empty?
|
|
71
|
+
logger.error("Failed enqueueing:\n#{enqueue_response.raw_http}")
|
|
72
|
+
raise Mindee::Error::MindeeError, 'Enqueueing of the document failed.'
|
|
73
|
+
end
|
|
74
|
+
|
|
75
|
+
job_id = enqueue_response.job.id
|
|
76
|
+
logger.debug("Successfully enqueued document with job id: #{job_id}.")
|
|
77
|
+
|
|
78
|
+
sleep(normalized_params.polling_options.initial_delay_sec)
|
|
79
|
+
retry_counter = 1
|
|
80
|
+
poll_results = get_job(job_id)
|
|
81
|
+
|
|
82
|
+
while retry_counter < normalized_params.polling_options.max_retries
|
|
83
|
+
if poll_results.job.status == 'Failed'
|
|
84
|
+
break
|
|
85
|
+
elsif !poll_results.job.result_url.nil?
|
|
86
|
+
return get_result(product, poll_results.job.result_url)
|
|
87
|
+
end
|
|
88
|
+
|
|
89
|
+
logger.debug(
|
|
90
|
+
"Successfully enqueued inference with job id: #{job_id}.\n" \
|
|
91
|
+
"Attempt n°#{retry_counter}/#{normalized_params.polling_options.max_retries}.\n" \
|
|
92
|
+
"Job status: #{poll_results.job.status}."
|
|
93
|
+
)
|
|
94
|
+
|
|
95
|
+
sleep(normalized_params.polling_options.delay_sec)
|
|
96
|
+
poll_results = get_job(job_id)
|
|
97
|
+
retry_counter += 1
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
error = poll_results.job.error
|
|
101
|
+
unless error.nil?
|
|
102
|
+
err_to_raise = Mindee::Error::MindeeHTTPErrorV2.new(error)
|
|
103
|
+
# NOTE: purposefully decoupled from the line above, otherwise rubocop thinks `error` is a `message` param.
|
|
104
|
+
raise err_to_raise
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
sec_count = normalized_params.polling_options.delay_sec * retry_counter
|
|
108
|
+
raise Mindee::Error::MindeeError,
|
|
109
|
+
"Asynchronous parsing request timed out after #{sec_count} seconds"
|
|
110
|
+
end
|
|
111
|
+
|
|
112
|
+
# Searches for a list of available models for the given API key.
|
|
113
|
+
# @param model_name [String]
|
|
114
|
+
# @param model_type [String]
|
|
115
|
+
# @return [Mindee::V2::Parsing::Search::SearchResponse]
|
|
116
|
+
def search_models(model_name, model_type)
|
|
117
|
+
@mindee_api.search_models(model_name, model_type)
|
|
118
|
+
end
|
|
119
|
+
|
|
120
|
+
private
|
|
121
|
+
|
|
122
|
+
# If needed, converts the parsing options provided as a hash into a proper BaseParameters subclass object.
|
|
123
|
+
# @param params [Hash, Class<BaseParameters>] Params.
|
|
124
|
+
# @return [BaseParameters]
|
|
125
|
+
def normalize_parameters(param_class, params)
|
|
126
|
+
return param_class.from_hash(params: params) if params.is_a?(Hash)
|
|
127
|
+
|
|
128
|
+
params
|
|
129
|
+
end
|
|
130
|
+
end
|
|
131
|
+
end
|
|
132
|
+
end
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Mindee
|
|
4
|
+
module V2
|
|
5
|
+
module FileOperation
|
|
6
|
+
# Crop operations.
|
|
7
|
+
module Crop
|
|
8
|
+
# Extracts a single crop as complete PDFs from the document.
|
|
9
|
+
#
|
|
10
|
+
# @param input_source [LocalInputSource] Local Input Source to extract sub-receipts from.
|
|
11
|
+
# @param crop [FieldLocation] Crop to extract.
|
|
12
|
+
# @return [ExtractedImage]
|
|
13
|
+
def self.extract_single_crop(input_source, crop)
|
|
14
|
+
polygons = [crop.polygon]
|
|
15
|
+
Mindee::Image::ImageExtractor.extract_multiple_images_from_source(
|
|
16
|
+
input_source, crop.page, polygons
|
|
17
|
+
).first
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
# Extracts multiple crop zones from an image.
|
|
21
|
+
#
|
|
22
|
+
# @param input_source [LocalInputSource] Local Input Source to extract sub-receipts from.
|
|
23
|
+
# @param crops [Array<CropItem>] List of crops.
|
|
24
|
+
# @return [CropFiles] Individual extracted zones as an array of ExtractedImage.
|
|
25
|
+
# @raise [MindeeError] if the crops array is empty.
|
|
26
|
+
def self.extract_crops(input_source, crops)
|
|
27
|
+
if crops.nil? || crops.empty?
|
|
28
|
+
raise Mindee::Error::MindeeError,
|
|
29
|
+
'No possible candidates found for Crop extraction.'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
polygons = Array.new(input_source.page_count) { [] }
|
|
33
|
+
|
|
34
|
+
crops.each do |crop|
|
|
35
|
+
polygons[crop.location.page] << crop.location.polygon
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
images = [] # @type var images: Array[Image::ExtractedImage]
|
|
39
|
+
polygons.each_with_index do |page_polygons, page_index|
|
|
40
|
+
extracted = Mindee::Image::ImageExtractor.extract_multiple_images_from_source(
|
|
41
|
+
input_source, page_index, page_polygons
|
|
42
|
+
)
|
|
43
|
+
images.concat(extracted)
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
CropFiles.new(images)
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
51
|
+
end
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Mindee
|
|
4
|
+
module V2
|
|
5
|
+
module FileOperation
|
|
6
|
+
# Collection of cropped files.
|
|
7
|
+
class CropFiles < Array
|
|
8
|
+
# Save all extracted crops to disk.
|
|
9
|
+
#
|
|
10
|
+
# @param path [String, Pathname] Path to save the extracted crops to.
|
|
11
|
+
# @param prefix [String] Prefix to add to the filename, defaults to 'crop'.
|
|
12
|
+
# @param file_format [String, nil] File format to save the crops as, defaults to jpg if nil.]
|
|
13
|
+
def save_all_to_disk(path, prefix: 'crop', file_format: nil)
|
|
14
|
+
FileUtils.mkdir_p(path)
|
|
15
|
+
each.with_index(1) do |crop, idx|
|
|
16
|
+
filename = "#{prefix}_#{format('%03d', idx)}.jpg"
|
|
17
|
+
file_path = File.join(path.to_s, filename)
|
|
18
|
+
|
|
19
|
+
crop.write_to_file(file_path, file_format)
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Mindee
|
|
4
|
+
module V2
|
|
5
|
+
module FileOperation
|
|
6
|
+
# Split operations.
|
|
7
|
+
module Split
|
|
8
|
+
# Extracts a single split as a complete PDF from the document.
|
|
9
|
+
#
|
|
10
|
+
# @param input_source [LocalInputSource] Input source to split.
|
|
11
|
+
# @param split [Array<Integer>] List of pages to keep.
|
|
12
|
+
# @return [ExtractedPDF] Extracted PDF
|
|
13
|
+
def self.extract_single_split(input_source, split)
|
|
14
|
+
extract_splits(input_source, [split]).first
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
# Extracts splits as complete PDFs from the document.
|
|
18
|
+
#
|
|
19
|
+
# @param input_source [LocalInputSource] Input source to split.
|
|
20
|
+
# @param splits [Array<Array<Integer>>] List of sub-lists of pages to keep.
|
|
21
|
+
# @return [SplitFiles] A list of extracted invoices.
|
|
22
|
+
# @raise [MindeeError] if no indexes are provided.
|
|
23
|
+
def self.extract_splits(input_source, splits)
|
|
24
|
+
raise Mindee::Error::MindeeError, 'No indexes provided.' if splits.nil? || splits.empty?
|
|
25
|
+
|
|
26
|
+
pdf_extractor = Mindee::PDF::PDFExtractor.new(input_source)
|
|
27
|
+
|
|
28
|
+
page_groups = splits.map do |split|
|
|
29
|
+
(split[0]..split[1]).to_a
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
SplitFiles.new(pdf_extractor.extract_sub_documents(page_groups))
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module Mindee
|
|
4
|
+
module V2
|
|
5
|
+
module FileOperation
|
|
6
|
+
# Collection of split files.
|
|
7
|
+
class SplitFiles < Array
|
|
8
|
+
# Save all extracted splits to disk.
|
|
9
|
+
#
|
|
10
|
+
# @param path [String, Pathname] Path to save the extracted splits to.
|
|
11
|
+
# @param prefix [String] Prefix to add to the filename, defaults to 'split'.
|
|
12
|
+
def save_all_to_disk(path, prefix: 'split')
|
|
13
|
+
FileUtils.mkdir_p(path)
|
|
14
|
+
|
|
15
|
+
each.with_index(1) do |split, idx|
|
|
16
|
+
filename = "#{prefix}_#{format('%03d', idx)}.pdf"
|
|
17
|
+
file_path = File.join(path.to_s, filename)
|
|
18
|
+
|
|
19
|
+
split.write_to_file(file_path)
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
end
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative '../../version'
|
|
4
|
+
|
|
5
|
+
module Mindee
|
|
6
|
+
module V2
|
|
7
|
+
module HTTP
|
|
8
|
+
# API client for version 2.
|
|
9
|
+
class ApiV2Settings
|
|
10
|
+
# V2 API key's default environment key name.
|
|
11
|
+
MINDEE_V2_API_KEY_ENV_NAME = 'MINDEE_V2_API_KEY'
|
|
12
|
+
# V2 API key's default value.
|
|
13
|
+
MINDEE_V2_API_KEY_DEFAULT = nil
|
|
14
|
+
|
|
15
|
+
# V2 base URL default environment key name.
|
|
16
|
+
MINDEE_V2_BASE_URL_ENV_NAME = 'MINDEE_V2_BASE_URL'
|
|
17
|
+
# V2 base URL default value.
|
|
18
|
+
MINDEE_V2_BASE_URL_DEFAULT = 'https://api-v2.mindee.net'
|
|
19
|
+
|
|
20
|
+
# HTTP request timeout default environment key name.
|
|
21
|
+
MINDEE_V2_REQUEST_TIMEOUT_ENV_NAME = 'MINDEE_V2_REQUEST_TIMEOUT'
|
|
22
|
+
# HTTP request timeout default value.
|
|
23
|
+
MINDEE_V2_TIMEOUT_DEFAULT = 120
|
|
24
|
+
|
|
25
|
+
# Default value for the user agent (same as V1).
|
|
26
|
+
USER_AGENT = "mindee-api-ruby@v#{Mindee::VERSION} ruby-v#{RUBY_VERSION} #{Mindee::PLATFORM}".freeze
|
|
27
|
+
|
|
28
|
+
# @return [String]
|
|
29
|
+
attr_reader :api_key
|
|
30
|
+
# @return [Integer]
|
|
31
|
+
attr_reader :request_timeout
|
|
32
|
+
# @return [String]
|
|
33
|
+
attr_reader :base_url
|
|
34
|
+
# @return [String]
|
|
35
|
+
attr_reader :user_agent
|
|
36
|
+
|
|
37
|
+
def initialize(api_key: nil)
|
|
38
|
+
@request_timeout = ENV.fetch(MINDEE_V2_REQUEST_TIMEOUT_ENV_NAME, MINDEE_V2_TIMEOUT_DEFAULT).to_i
|
|
39
|
+
if api_key.nil? && !ENV.fetch(MINDEE_V2_API_KEY_ENV_NAME, MINDEE_V2_API_KEY_DEFAULT).to_s.empty?
|
|
40
|
+
logger.debug('API key set from environment')
|
|
41
|
+
end
|
|
42
|
+
@api_key = if api_key.nil? || api_key.empty?
|
|
43
|
+
ENV.fetch(MINDEE_V2_API_KEY_ENV_NAME,
|
|
44
|
+
MINDEE_V2_API_KEY_DEFAULT)
|
|
45
|
+
else
|
|
46
|
+
api_key
|
|
47
|
+
end
|
|
48
|
+
@base_url = ENV.fetch(MINDEE_V2_BASE_URL_ENV_NAME, MINDEE_V2_BASE_URL_DEFAULT).chomp('/')
|
|
49
|
+
@user_agent = USER_AGENT
|
|
50
|
+
end
|
|
51
|
+
|
|
52
|
+
# Checks API key for a value.
|
|
53
|
+
# @return
|
|
54
|
+
# @raise [Error::MindeeAPIError] Raises if the api key is empty or nil.
|
|
55
|
+
def check_api_key
|
|
56
|
+
return unless @api_key.nil? || @api_key.to_s.empty?
|
|
57
|
+
|
|
58
|
+
raise Error::MindeeAPIError,
|
|
59
|
+
"Missing API key. check your Client Configuration.\nYou can set this using the " \
|
|
60
|
+
"'#{MINDEE_V2_API_KEY_ENV_NAME}' environment variable."
|
|
61
|
+
end
|
|
62
|
+
end
|
|
63
|
+
end
|
|
64
|
+
end
|
|
65
|
+
end
|
|
@@ -0,0 +1,230 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require_relative '../../input'
|
|
4
|
+
require_relative '../../http'
|
|
5
|
+
require_relative '../../error'
|
|
6
|
+
|
|
7
|
+
module Mindee
|
|
8
|
+
module V2
|
|
9
|
+
module HTTP
|
|
10
|
+
# API client for version 2.
|
|
11
|
+
class MindeeApiV2
|
|
12
|
+
# @return [ApiV2Settings]
|
|
13
|
+
attr_reader :settings
|
|
14
|
+
|
|
15
|
+
# @param api_key [String, nil]
|
|
16
|
+
def initialize(api_key: nil)
|
|
17
|
+
@settings = ApiV2Settings.new(api_key: api_key)
|
|
18
|
+
end
|
|
19
|
+
|
|
20
|
+
# Sends a file to the queue.
|
|
21
|
+
#
|
|
22
|
+
# @param input_source [Input::Source::LocalInputSource, Input::Source::URLInputSource]
|
|
23
|
+
# @param params [Input::BaseParameters]
|
|
24
|
+
# @return [Mindee::V2::Parsing::JobResponse]
|
|
25
|
+
# @raise [Mindee::Error::MindeeHttpErrorV2]
|
|
26
|
+
def req_post_enqueue(input_source, params)
|
|
27
|
+
@settings.check_api_key
|
|
28
|
+
response = enqueue(
|
|
29
|
+
input_source,
|
|
30
|
+
params
|
|
31
|
+
)
|
|
32
|
+
Mindee::V2::Parsing::JobResponse.new(process_response(response))
|
|
33
|
+
end
|
|
34
|
+
|
|
35
|
+
# Retrieves a result from a given queue.
|
|
36
|
+
# @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
|
|
37
|
+
# @param resource [String] ID of the inference or URL to the result.
|
|
38
|
+
# @return [Mindee::V2::Parsing::BaseResponse]
|
|
39
|
+
def req_get_result(product, resource)
|
|
40
|
+
return req_get_result_url(product.response_type, resource) if uri?(resource)
|
|
41
|
+
|
|
42
|
+
@settings.check_api_key
|
|
43
|
+
response = result_req_get(
|
|
44
|
+
resource,
|
|
45
|
+
product
|
|
46
|
+
)
|
|
47
|
+
product.response_type.new(process_response(response))
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
# Retrieves a queued job.
|
|
51
|
+
#
|
|
52
|
+
# @param job_id [String] ID of the job or URL to the job.
|
|
53
|
+
# @return [Mindee::V2::Parsing::JobResponse]
|
|
54
|
+
def req_get_job(job_id)
|
|
55
|
+
@settings.check_api_key
|
|
56
|
+
response = poll("#{@settings.base_url}/v2/jobs/#{job_id}")
|
|
57
|
+
Mindee::V2::Parsing::JobResponse.new(process_response(response))
|
|
58
|
+
end
|
|
59
|
+
|
|
60
|
+
# Retrieves a list of models.
|
|
61
|
+
# @param model_name [String, nil]
|
|
62
|
+
# @param model_type [String, nil]
|
|
63
|
+
# @return [Mindee::V2::Parsing::Search::SearchResponse]
|
|
64
|
+
def search_models(model_name, model_type)
|
|
65
|
+
Mindee::V2::Parsing::Search::SearchResponse.new(process_response(req_get_search_models(model_name,
|
|
66
|
+
model_type)))
|
|
67
|
+
end
|
|
68
|
+
|
|
69
|
+
private
|
|
70
|
+
|
|
71
|
+
# Retrieves a list of models.
|
|
72
|
+
# @param model_name [String, nil]
|
|
73
|
+
# @param model_type [String, nil]
|
|
74
|
+
# @return [Net::HTTPResponse]
|
|
75
|
+
def req_get_search_models(model_name, model_type)
|
|
76
|
+
url = "#{@settings.base_url}/v2/search/models"
|
|
77
|
+
uri = URI(url)
|
|
78
|
+
|
|
79
|
+
query_params = {} # @type var query_params: Hash[Symbol, String | nil]
|
|
80
|
+
query_params[:name] = model_name if model_name
|
|
81
|
+
query_params[:model_type] = model_type if model_type
|
|
82
|
+
uri.query = URI.encode_www_form(query_params) unless query_params.empty?
|
|
83
|
+
|
|
84
|
+
headers = {
|
|
85
|
+
'Authorization' => @settings.api_key,
|
|
86
|
+
'User-Agent' => @settings.user_agent,
|
|
87
|
+
}
|
|
88
|
+
req = Net::HTTP::Get.new(uri, headers)
|
|
89
|
+
req['Transfer-Encoding'] = 'chunked'
|
|
90
|
+
|
|
91
|
+
Net::HTTP.start(uri.hostname, uri.port, use_ssl: true, read_timeout: @settings.request_timeout) do |http|
|
|
92
|
+
return http.request(req)
|
|
93
|
+
end
|
|
94
|
+
raise Mindee::Error::MindeeError, 'Could not resolve server response.'
|
|
95
|
+
end
|
|
96
|
+
|
|
97
|
+
# @param resource [String] Resource to check.
|
|
98
|
+
# @return [Boolean]
|
|
99
|
+
def uri?(resource)
|
|
100
|
+
uri = URI.parse(resource)
|
|
101
|
+
throw Mindee::Error::MindeeError, 'HTTP is not supported.' if uri.scheme == 'http'
|
|
102
|
+
uri.scheme == 'https'
|
|
103
|
+
rescue URI::BadURIError, URI::InvalidURIError
|
|
104
|
+
false
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
# Retrieves a queued job.
|
|
108
|
+
#
|
|
109
|
+
# @param url [String]
|
|
110
|
+
# @return [Mindee::V2::Parsing::JobResponse]
|
|
111
|
+
def req_get_job_url(url)
|
|
112
|
+
@settings.check_api_key
|
|
113
|
+
response = poll(url)
|
|
114
|
+
Mindee::V2::Parsing::JobResponse.new(process_response(response))
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
# Retrieves a queued job.
|
|
118
|
+
#
|
|
119
|
+
# @param result_class [Class<Mindee::V2::Parsing::BaseResponse>]
|
|
120
|
+
# @param url [String]
|
|
121
|
+
# @return [Mindee::V2::Parsing::BaseResponse]
|
|
122
|
+
def req_get_result_url(result_class, url)
|
|
123
|
+
@settings.check_api_key
|
|
124
|
+
response = poll(url)
|
|
125
|
+
result_class.new(process_response(response))
|
|
126
|
+
end
|
|
127
|
+
|
|
128
|
+
# Converts an HTTP response to a parsed response object.
|
|
129
|
+
#
|
|
130
|
+
# @param response [Net::HTTPResponse, nil]
|
|
131
|
+
# @return [Hash]
|
|
132
|
+
# @raise Throws if the server returned an error.
|
|
133
|
+
def process_response(response)
|
|
134
|
+
if !response.nil? && response.respond_to?(:body) &&
|
|
135
|
+
Mindee::HTTP::ResponseValidation.valid_v2_response?(response)
|
|
136
|
+
return JSON.parse(response.body, object_class: Hash)
|
|
137
|
+
end
|
|
138
|
+
|
|
139
|
+
response_body = if response.nil? || !response.respond_to?(:body)
|
|
140
|
+
'{ "status": -1,
|
|
141
|
+
"detail": "Empty server response." }'
|
|
142
|
+
else
|
|
143
|
+
response.body
|
|
144
|
+
end
|
|
145
|
+
raise Mindee::HTTP::ErrorHandler.generate_v2_error(JSON.parse(response_body).transform_keys(&:to_sym))
|
|
146
|
+
end
|
|
147
|
+
|
|
148
|
+
# Polls a queue for either a result or a job.
|
|
149
|
+
# @param url [String] URL, passed as a string.
|
|
150
|
+
# @return [Net::HTTPResponse]
|
|
151
|
+
def poll(url)
|
|
152
|
+
uri = URI(url)
|
|
153
|
+
headers = {
|
|
154
|
+
'Authorization' => @settings.api_key,
|
|
155
|
+
'User-Agent' => @settings.user_agent,
|
|
156
|
+
}
|
|
157
|
+
req = Net::HTTP::Get.new(uri, headers)
|
|
158
|
+
req['Transfer-Encoding'] = 'chunked'
|
|
159
|
+
|
|
160
|
+
Net::HTTP.start(uri.hostname, uri.port, use_ssl: true, read_timeout: @settings.request_timeout) do |http|
|
|
161
|
+
return http.request(req)
|
|
162
|
+
end
|
|
163
|
+
raise Mindee::Error::MindeeError, 'Could not resolve server response.'
|
|
164
|
+
end
|
|
165
|
+
|
|
166
|
+
# Polls the API for the result of an inference.
|
|
167
|
+
#
|
|
168
|
+
# @param queue_id [String] ID of the queue.
|
|
169
|
+
# @param product [Class<Mindee::V2::Product::BaseProduct>] The return class.
|
|
170
|
+
# @return [Net::HTTPResponse]
|
|
171
|
+
def result_req_get(queue_id, product)
|
|
172
|
+
poll("#{@settings.base_url}/v2/products/#{product.slug}/results/#{queue_id}")
|
|
173
|
+
end
|
|
174
|
+
|
|
175
|
+
# Handle parameters for the enqueue form
|
|
176
|
+
# @param form_data [Array] Array of form fields
|
|
177
|
+
# @param params [V2::Product::Extraction::Params::ExtractionParameters] Inference options.
|
|
178
|
+
def enqueue_form_options(form_data, params)
|
|
179
|
+
form_data.push(['rag', params.rag.to_s]) unless params.rag.nil?
|
|
180
|
+
form_data.push(['raw_text', params.raw_text.to_s]) unless params.raw_text.nil?
|
|
181
|
+
form_data.push(['polygon', params.polygon.to_s]) unless params.polygon.nil?
|
|
182
|
+
form_data.push(['confidence', params.confidence.to_s]) unless params.confidence.nil?
|
|
183
|
+
form_data.push ['text_context', params.text_context] if params.text_context
|
|
184
|
+
form_data.push ['data_schema', params.data_schema.to_s] if params.data_schema
|
|
185
|
+
unless params.webhook_ids.nil? || params.webhook_ids.empty?
|
|
186
|
+
params.webhook_ids.each do |webhook_id|
|
|
187
|
+
form_data.push ['webhook_ids[]', webhook_id]
|
|
188
|
+
end
|
|
189
|
+
end
|
|
190
|
+
form_data
|
|
191
|
+
end
|
|
192
|
+
|
|
193
|
+
# @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
|
|
194
|
+
# @param params [Input::BaseParameters] Inference options.
|
|
195
|
+
# @return [Net::HTTPResponse, nil]
|
|
196
|
+
def enqueue(input_source, params)
|
|
197
|
+
uri = URI("#{@settings.base_url}/v2/products/#{params.slug}/enqueue")
|
|
198
|
+
|
|
199
|
+
form_data = if input_source.is_a?(Mindee::Input::Source::URLInputSource)
|
|
200
|
+
[['url', input_source.url]] # : Array[Array[untyped]]
|
|
201
|
+
else
|
|
202
|
+
file_data, file_metadata = input_source.read_contents(close: params.close_file)
|
|
203
|
+
[['file', file_data, file_metadata]] # : Array[Array[untyped]]
|
|
204
|
+
end
|
|
205
|
+
form_data.push(['model_id', params.model_id])
|
|
206
|
+
form_data.push ['file_alias', params.file_alias] if params.file_alias
|
|
207
|
+
if params.is_a?(V2::Product::Extraction::Params::ExtractionParameters)
|
|
208
|
+
form_data = enqueue_form_options(form_data, params)
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
form_data = params.append_form_data(form_data)
|
|
212
|
+
|
|
213
|
+
headers = {
|
|
214
|
+
'Authorization' => @settings.api_key,
|
|
215
|
+
'User-Agent' => @settings.user_agent,
|
|
216
|
+
}
|
|
217
|
+
req = Net::HTTP::Post.new(uri, headers)
|
|
218
|
+
|
|
219
|
+
req.set_form(form_data, 'multipart/form-data')
|
|
220
|
+
req['Transfer-Encoding'] = 'chunked'
|
|
221
|
+
|
|
222
|
+
Net::HTTP.start(uri.hostname, uri.port, use_ssl: true, read_timeout: @settings.request_timeout) do |http|
|
|
223
|
+
return http.request(req)
|
|
224
|
+
end
|
|
225
|
+
raise Mindee::Error::MindeeError, 'Could not resolve server response.'
|
|
226
|
+
end
|
|
227
|
+
end
|
|
228
|
+
end
|
|
229
|
+
end
|
|
230
|
+
end
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
3
|
require_relative '../product/base_product'
|
|
4
|
-
require_relative '
|
|
4
|
+
require_relative '../parsing'
|
|
5
5
|
|
|
6
6
|
module Mindee
|
|
7
7
|
module V2
|
|
@@ -10,9 +10,9 @@ module Mindee
|
|
|
10
10
|
class BaseInference < Mindee::V2::Product::BaseProduct
|
|
11
11
|
# @return [InferenceJob] Metadata about the job.
|
|
12
12
|
attr_reader :job
|
|
13
|
-
# @return [Parsing::
|
|
13
|
+
# @return [V2::Parsing::InferenceModel] Model info for the inference.
|
|
14
14
|
attr_reader :model
|
|
15
|
-
# @return [Parsing::
|
|
15
|
+
# @return [V2::Parsing::InferenceFile] File info for the inference.
|
|
16
16
|
attr_reader :file
|
|
17
17
|
# @return [String] ID of the inference.
|
|
18
18
|
attr_reader :id
|
|
@@ -21,10 +21,10 @@ module Mindee
|
|
|
21
21
|
raise ArgumentError, 'Server response must be a Hash' unless http_response.is_a?(Hash)
|
|
22
22
|
|
|
23
23
|
super()
|
|
24
|
-
@model = Mindee::Parsing::
|
|
25
|
-
@file = Mindee::Parsing::
|
|
24
|
+
@model = Mindee::V2::Parsing::InferenceModel.new(http_response['model'])
|
|
25
|
+
@file = Mindee::V2::Parsing::InferenceFile.new(http_response['file'])
|
|
26
26
|
@id = http_response['id']
|
|
27
|
-
@job = Mindee::Parsing::
|
|
27
|
+
@job = Mindee::V2::Parsing::InferenceJob.new(http_response['job']) if http_response.key?('job')
|
|
28
28
|
end
|
|
29
29
|
|
|
30
30
|
# String representation.
|
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require_relative 'common_response'
|
|
4
|
+
|
|
3
5
|
module Mindee
|
|
4
6
|
module V2
|
|
5
7
|
module Parsing
|
|
6
8
|
# Base class for V2 inference responses.
|
|
7
|
-
class BaseResponse < Mindee::Parsing::
|
|
9
|
+
class BaseResponse < Mindee::V2::Parsing::CommonResponse
|
|
8
10
|
# @return [BaseInference] The inference result for a split utility request
|
|
9
11
|
attr_reader :inference
|
|
10
12
|
end
|
|
@@ -1,16 +1,18 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require 'json'
|
|
4
|
+
|
|
3
5
|
module Mindee
|
|
4
|
-
module
|
|
5
|
-
module
|
|
6
|
+
module V2
|
|
7
|
+
module Parsing
|
|
6
8
|
# Base class for inference and job responses on the V2 API.
|
|
7
9
|
class CommonResponse
|
|
8
|
-
# @return [
|
|
10
|
+
# @return [String]
|
|
9
11
|
attr_reader :raw_http
|
|
10
12
|
|
|
11
13
|
# @param http_response [Hash]
|
|
12
14
|
def initialize(http_response)
|
|
13
|
-
@raw_http = http_response
|
|
15
|
+
@raw_http = JSON.generate(http_response)
|
|
14
16
|
end
|
|
15
17
|
end
|
|
16
18
|
end
|