gem.sh gem.sh
Home Gems Types Docs Community
  • Modules

    • module Mindee
    • module Mindee::Errors
    • module Mindee::Extraction
    • module Mindee::Geometry
    • module Mindee::HTTP
    • module Mindee::HTTP::ErrorHandler
    • module Mindee::HTTP::ResponseValidation
    • module Mindee::Image
    • module Mindee::Image::ImageCompressor
    • module Mindee::Image::ImageExtractor
    • module Mindee::Image::ImageUtils
    • module Mindee::Input
    • module Mindee::Input::Source
    • module Mindee::Logging
    • module Mindee::PDF
    • module Mindee::PDF::PDFCompressor
    • module Mindee::PDF::PDFExtractor
    • module Mindee::PDF::PDFProcessor
    • module Mindee::PDF::PDFTools
    • module Mindee::Parsing
    • module Mindee::Parsing::Common
    • module Mindee::Parsing::Common::ExecutionPriority
    • module Mindee::Parsing::Common::Extras
    • module Mindee::Parsing::Common::JobStatus
    • module Mindee::Parsing::Common::OCR
    • module Mindee::Parsing::Common::RequestStatus
    • module Mindee::Parsing::Standard
    • module Mindee::Parsing::Universal
    • module Mindee::Product
    • module Mindee::Product::BarcodeReader
    • module Mindee::Product::BillOfLading
    • module Mindee::Product::BusinessCard
    • module Mindee::Product::Cropper
    • module Mindee::Product::DeliveryNote
    • module Mindee::Product::DriverLicense
    • module Mindee::Product::EU
    • module Mindee::Product::FR
    • module Mindee::Product::FR::BankAccountDetails
    • module Mindee::Product::FR::BankStatement
    • module Mindee::Product::FR::CarteGrise
    • module Mindee::Product::FR::EnergyBill
    • module Mindee::Product::FR::HealthCard
    • module Mindee::Product::FR::IdCard
    • module Mindee::Product::FR::Payslip
    • module Mindee::Product::FinancialDocument
    • module Mindee::Product::IND
    • module Mindee::Product::IND::IndianPassport
    • module Mindee::Product::InternationalId
    • module Mindee::Product::Invoice
    • module Mindee::Product::InvoiceSplitter
    • module Mindee::Product::MultiReceiptsDetector
    • module Mindee::Product::NutritionFactsLabel
    • module Mindee::Product::Passport
    • module Mindee::Product::Receipt
    • module Mindee::Product::Resume
    • module Mindee::Product::US
    • module Mindee::Product::US::BankCheck
    • module Mindee::Product::US::HealthcareCard
    • module Mindee::Product::US::UsMail
    • module Mindee::Product::Universal
  • Classes

    • class Mindee::Client
    • class Mindee::Errors::MindeeAPIError
    • class Mindee::Errors::MindeeConfigurationError
    • class Mindee::Errors::MindeeError
    • class Mindee::Errors::MindeeGeometryError
    • class Mindee::Errors::MindeeHTTPClientError
    • class Mindee::Errors::MindeeHTTPError
    • class Mindee::Errors::MindeeHTTPServerError
    • class Mindee::Errors::MindeeImageError
    • class Mindee::Errors::MindeeInputError
    • class Mindee::Errors::MindeeMimeTypeError
    • class Mindee::Errors::MindeePDFError
    • class Mindee::Errors::MindeeSourceError
    • class Mindee::Geometry::MinMax
    • class Mindee::Geometry::Point
    • class Mindee::Geometry::Polygon
    • class Mindee::Geometry::Quadrilateral
    • class Mindee::HTTP::Endpoint
    • class Mindee::HTTP::WorkflowEndpoint
    • class Mindee::Image::ExtractedImage
    • class Mindee::Input::LocalResponse
    • class Mindee::Input::Source::Base64InputSource
    • class Mindee::Input::Source::BytesInputSource
    • class Mindee::Input::Source::FileInputSource
    • class Mindee::Input::Source::LocalInputSource
    • class Mindee::Input::Source::PathInputSource
    • class Mindee::Input::Source::URLInputSource
    • class Mindee::PDF::PDFExtractor::ExtractedPDF
    • class Mindee::PDF::PDFExtractor::PDFExtractor
    • class Mindee::PageOptions
    • class Mindee::ParseOptions
    • class Mindee::Parsing::Common::ApiRequest
    • class Mindee::Parsing::Common::ApiResponse
    • class Mindee::Parsing::Common::Document
    • class Mindee::Parsing::Common::Execution
    • class Mindee::Parsing::Common::ExecutionFile
    • class Mindee::Parsing::Common::Extras::CropperExtra
    • class Mindee::Parsing::Common::Extras::Extras
    • class Mindee::Parsing::Common::Extras::FullTextOCRExtra
    • class Mindee::Parsing::Common::Extras::RAGExtra
    • class Mindee::Parsing::Common::Inference
    • class Mindee::Parsing::Common::Job
    • class Mindee::Parsing::Common::OCR::MVisionV1
    • class Mindee::Parsing::Common::OCR::OCR
    • class Mindee::Parsing::Common::OCR::OCRLine
    • class Mindee::Parsing::Common::OCR::OCRPage
    • class Mindee::Parsing::Common::OCR::OCRWord
    • class Mindee::Parsing::Common::Orientation
    • class Mindee::Parsing::Common::Page
    • class Mindee::Parsing::Common::Prediction
    • class Mindee::Parsing::Common::Product
    • class Mindee::Parsing::Common::WorkflowResponse
    • class Mindee::Parsing::Standard::AbstractField
    • class Mindee::Parsing::Standard::AmountField
    • class Mindee::Parsing::Standard::BaseField
    • class Mindee::Parsing::Standard::BooleanField
    • class Mindee::Parsing::Standard::ClassificationField
    • class Mindee::Parsing::Standard::CompanyRegistrationField
    • class Mindee::Parsing::Standard::DateField
    • class Mindee::Parsing::Standard::FeatureField
    • class Mindee::Parsing::Standard::LocaleField
    • class Mindee::Parsing::Standard::PaymentDetailsField
    • class Mindee::Parsing::Standard::PositionField
    • class Mindee::Parsing::Standard::StringField
    • class Mindee::Parsing::Standard::TaxField
    • class Mindee::Parsing::Standard::Taxes
    • class Mindee::Parsing::Universal::UniversalListField
    • class Mindee::Parsing::Universal::UniversalObjectField
    • class Mindee::Product::BarcodeReader::BarcodeReaderV1
    • class Mindee::Product::BarcodeReader::BarcodeReaderV1Document
    • class Mindee::Product::BarcodeReader::BarcodeReaderV1Page
    • class Mindee::Product::BarcodeReader::BarcodeReaderV1PagePrediction
    • class Mindee::Product::BillOfLading::BillOfLadingV1
    • class Mindee::Product::BillOfLading::BillOfLadingV1Carrier
    • class Mindee::Product::BillOfLading::BillOfLadingV1CarrierItem
    • class Mindee::Product::BillOfLading::BillOfLadingV1CarrierItems
    • class Mindee::Product::BillOfLading::BillOfLadingV1Consignee
    • class Mindee::Product::BillOfLading::BillOfLadingV1Document
    • class Mindee::Product::BillOfLading::BillOfLadingV1NotifyParty
    • class Mindee::Product::BillOfLading::BillOfLadingV1Page
    • class Mindee::Product::BillOfLading::BillOfLadingV1PagePrediction
    • class Mindee::Product::BillOfLading::BillOfLadingV1Shipper
    • class Mindee::Product::BusinessCard::BusinessCardV1
    • class Mindee::Product::BusinessCard::BusinessCardV1Document
    • class Mindee::Product::BusinessCard::BusinessCardV1Page
    • class Mindee::Product::BusinessCard::BusinessCardV1PagePrediction
    • class Mindee::Product::Cropper::CropperV1
    • class Mindee::Product::Cropper::CropperV1Document
    • class Mindee::Product::Cropper::CropperV1Page
    • class Mindee::Product::Cropper::CropperV1PagePrediction
    • class Mindee::Product::DeliveryNote::DeliveryNoteV1
    • class Mindee::Product::DeliveryNote::DeliveryNoteV1Document
    • class Mindee::Product::DeliveryNote::DeliveryNoteV1Page
    • class Mindee::Product::DeliveryNote::DeliveryNoteV1PagePrediction
    • class Mindee::Product::DriverLicense::DriverLicenseV1
    • class Mindee::Product::DriverLicense::DriverLicenseV1Document
    • class Mindee::Product::DriverLicense::DriverLicenseV1Page
    • class Mindee::Product::DriverLicense::DriverLicenseV1PagePrediction
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV1
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV1Document
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV1Page
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV1PagePrediction
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2Bban
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2Document
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2Page
    • class Mindee::Product::FR::BankAccountDetails::BankAccountDetailsV2PagePrediction
    • class Mindee::Product::FR::BankStatement::BankStatementV2
    • class Mindee::Product::FR::BankStatement::BankStatementV2Document
    • class Mindee::Product::FR::BankStatement::BankStatementV2Page
    • class Mindee::Product::FR::BankStatement::BankStatementV2PagePrediction
    • class Mindee::Product::FR::BankStatement::BankStatementV2Transaction
    • class Mindee::Product::FR::BankStatement::BankStatementV2Transactions
    • class Mindee::Product::FR::CarteGrise::CarteGriseV1
    • class Mindee::Product::FR::CarteGrise::CarteGriseV1Document
    • class Mindee::Product::FR::CarteGrise::CarteGriseV1Page
    • class Mindee::Product::FR::CarteGrise::CarteGriseV1PagePrediction
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1Document
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyConsumer
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1EnergySupplier
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyUsage
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1EnergyUsages
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1MeterDetail
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1Page
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1PagePrediction
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1Subscription
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1Subscriptions
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1TaxesAndContribution
    • class Mindee::Product::FR::EnergyBill::EnergyBillV1TaxesAndContributions
    • class Mindee::Product::FR::HealthCard::HealthCardV1
    • class Mindee::Product::FR::HealthCard::HealthCardV1Document
    • class Mindee::Product::FR::HealthCard::HealthCardV1Page
    • class Mindee::Product::FR::HealthCard::HealthCardV1PagePrediction
    • class Mindee::Product::FR::IdCard::IdCardV1
    • class Mindee::Product::FR::IdCard::IdCardV1Document
    • class Mindee::Product::FR::IdCard::IdCardV1Page
    • class Mindee::Product::FR::IdCard::IdCardV1PagePrediction
    • class Mindee::Product::FR::IdCard::IdCardV2
    • class Mindee::Product::FR::IdCard::IdCardV2Document
    • class Mindee::Product::FR::IdCard::IdCardV2Page
    • class Mindee::Product::FR::IdCard::IdCardV2PagePrediction
    • class Mindee::Product::FR::Payslip::PayslipV2
    • class Mindee::Product::FR::Payslip::PayslipV2BankAccountDetail
    • class Mindee::Product::FR::Payslip::PayslipV2Document
    • class Mindee::Product::FR::Payslip::PayslipV2Employee
    • class Mindee::Product::FR::Payslip::PayslipV2Employer
    • class Mindee::Product::FR::Payslip::PayslipV2Employment
    • class Mindee::Product::FR::Payslip::PayslipV2Page
    • class Mindee::Product::FR::Payslip::PayslipV2PagePrediction
    • class Mindee::Product::FR::Payslip::PayslipV2PayDetail
    • class Mindee::Product::FR::Payslip::PayslipV2PayPeriod
    • class Mindee::Product::FR::Payslip::PayslipV2Pto
    • class Mindee::Product::FR::Payslip::PayslipV2SalaryDetail
    • class Mindee::Product::FR::Payslip::PayslipV2SalaryDetails
    • class Mindee::Product::FR::Payslip::PayslipV3
    • class Mindee::Product::FR::Payslip::PayslipV3BankAccountDetail
    • class Mindee::Product::FR::Payslip::PayslipV3Document
    • class Mindee::Product::FR::Payslip::PayslipV3Employee
    • class Mindee::Product::FR::Payslip::PayslipV3Employer
    • class Mindee::Product::FR::Payslip::PayslipV3Employment
    • class Mindee::Product::FR::Payslip::PayslipV3Page
    • class Mindee::Product::FR::Payslip::PayslipV3PagePrediction
    • class Mindee::Product::FR::Payslip::PayslipV3PaidTimeOff
    • class Mindee::Product::FR::Payslip::PayslipV3PaidTimeOffs
    • class Mindee::Product::FR::Payslip::PayslipV3PayDetail
    • class Mindee::Product::FR::Payslip::PayslipV3PayPeriod
    • class Mindee::Product::FR::Payslip::PayslipV3SalaryDetail
    • class Mindee::Product::FR::Payslip::PayslipV3SalaryDetails
    • class Mindee::Product::FinancialDocument::FinancialDocumentV1
    • class Mindee::Product::FinancialDocument::FinancialDocumentV1Document
    • class Mindee::Product::FinancialDocument::FinancialDocumentV1LineItem
    • class Mindee::Product::FinancialDocument::FinancialDocumentV1LineItems
    • class Mindee::Product::FinancialDocument::FinancialDocumentV1Page
    • class Mindee::Product::FinancialDocument::FinancialDocumentV1PagePrediction
    • class Mindee::Product::IND::IndianPassport::IndianPassportV1
    • class Mindee::Product::IND::IndianPassport::IndianPassportV1Document
    • class Mindee::Product::IND::IndianPassport::IndianPassportV1Page
    • class Mindee::Product::IND::IndianPassport::IndianPassportV1PagePrediction
    • class Mindee::Product::InternationalId::InternationalIdV2
    • class Mindee::Product::InternationalId::InternationalIdV2Document
    • class Mindee::Product::InternationalId::InternationalIdV2Page
    • class Mindee::Product::InternationalId::InternationalIdV2PagePrediction
    • class Mindee::Product::Invoice::InvoiceV4
    • class Mindee::Product::Invoice::InvoiceV4Document
    • class Mindee::Product::Invoice::InvoiceV4LineItem
    • class Mindee::Product::Invoice::InvoiceV4LineItems
    • class Mindee::Product::Invoice::InvoiceV4Page
    • class Mindee::Product::Invoice::InvoiceV4PagePrediction
    • class Mindee::Product::InvoiceSplitter::InvoiceSplitterV1
    • class Mindee::Product::InvoiceSplitter::InvoiceSplitterV1Document
    • class Mindee::Product::InvoiceSplitter::InvoiceSplitterV1InvoicePageGroup
    • class Mindee::Product::InvoiceSplitter::InvoiceSplitterV1InvoicePageGroups
    • class Mindee::Product::InvoiceSplitter::InvoiceSplitterV1Page
    • class Mindee::Product::InvoiceSplitter::InvoiceSplitterV1PagePrediction
    • class Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1
    • class Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1Document
    • class Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1Page
    • class Mindee::Product::MultiReceiptsDetector::MultiReceiptsDetectorV1PagePrediction
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1AddedSugar
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Calorie
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Cholesterol
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1DietaryFiber
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Document
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Nutrient
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Nutrients
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Page
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1PagePrediction
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Protein
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1SaturatedFat
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1ServingSize
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1Sodium
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TotalCarbohydrate
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TotalFat
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TotalSugar
    • class Mindee::Product::NutritionFactsLabel::NutritionFactsLabelV1TransFat
    • class Mindee::Product::Passport::PassportV1
    • class Mindee::Product::Passport::PassportV1Document
    • class Mindee::Product::Passport::PassportV1Page
    • class Mindee::Product::Passport::PassportV1PagePrediction
    • class Mindee::Product::Receipt::ReceiptV5
    • class Mindee::Product::Receipt::ReceiptV5Document
    • class Mindee::Product::Receipt::ReceiptV5LineItem
    • class Mindee::Product::Receipt::ReceiptV5LineItems
    • class Mindee::Product::Receipt::ReceiptV5Page
    • class Mindee::Product::Receipt::ReceiptV5PagePrediction
    • class Mindee::Product::Resume::ResumeV1
    • class Mindee::Product::Resume::ResumeV1Certificate
    • class Mindee::Product::Resume::ResumeV1Certificates
    • class Mindee::Product::Resume::ResumeV1Document
    • class Mindee::Product::Resume::ResumeV1Education
    • class Mindee::Product::Resume::ResumeV1Educations
    • class Mindee::Product::Resume::ResumeV1Language
    • class Mindee::Product::Resume::ResumeV1Languages
    • class Mindee::Product::Resume::ResumeV1Page
    • class Mindee::Product::Resume::ResumeV1PagePrediction
    • class Mindee::Product::Resume::ResumeV1ProfessionalExperience
    • class Mindee::Product::Resume::ResumeV1ProfessionalExperiences
    • class Mindee::Product::Resume::ResumeV1SocialNetworksUrl
    • class Mindee::Product::Resume::ResumeV1SocialNetworksUrls
    • class Mindee::Product::US::BankCheck::BankCheckV1
    • class Mindee::Product::US::BankCheck::BankCheckV1Document
    • class Mindee::Product::US::BankCheck::BankCheckV1Page
    • class Mindee::Product::US::BankCheck::BankCheckV1PagePrediction
    • class Mindee::Product::US::HealthcareCard::HealthcareCardV1
    • class Mindee::Product::US::HealthcareCard::HealthcareCardV1Copay
    • class Mindee::Product::US::HealthcareCard::HealthcareCardV1Copays
    • class Mindee::Product::US::HealthcareCard::HealthcareCardV1Document
    • class Mindee::Product::US::HealthcareCard::HealthcareCardV1Page
    • class Mindee::Product::US::HealthcareCard::HealthcareCardV1PagePrediction
    • class Mindee::Product::US::UsMail::UsMailV2
    • class Mindee::Product::US::UsMail::UsMailV2Document
    • class Mindee::Product::US::UsMail::UsMailV2Page
    • class Mindee::Product::US::UsMail::UsMailV2PagePrediction
    • class Mindee::Product::US::UsMail::UsMailV2RecipientAddress
    • class Mindee::Product::US::UsMail::UsMailV2RecipientAddresses
    • class Mindee::Product::US::UsMail::UsMailV2SenderAddress
    • class Mindee::Product::US::UsMail::UsMailV3
    • class Mindee::Product::US::UsMail::UsMailV3Document
    • class Mindee::Product::US::UsMail::UsMailV3Page
    • class Mindee::Product::US::UsMail::UsMailV3PagePrediction
    • class Mindee::Product::US::UsMail::UsMailV3RecipientAddress
    • class Mindee::Product::US::UsMail::UsMailV3RecipientAddresses
    • class Mindee::Product::US::UsMail::UsMailV3SenderAddress
    • class Mindee::Product::Universal::Universal
    • class Mindee::Product::Universal::UniversalDocument
    • class Mindee::Product::Universal::UniversalPage
    • class Mindee::Product::Universal::UniversalPagePrediction
    • class Mindee::Product::Universal::UniversalPrediction
    • class Mindee::WorkflowOptions
    Overview
    H
    Home
    R
    Reference
    T
    Types
    C
    Changelogs
  • Documentation
    • README
    • Advanced file operations
    • Getting started
    • Global products
    • Barcode reader v1
    • Bill of lading v1
    • Business card v1
    • Cropper v1
    • Delivery notes v1
    • Driver license v1
    • Expense receipts v5
    • Financial document v1
    • International id v2
    • Invoice splitter v1
    • Invoices v4
    • Multi receipts detector v1
    • Nutrition facts v1
    • Passport v1
    • Resume v1
    • Universal
    • Loading a document
    • Localized products
    • Bank account details v2
    • Bank check v1
    • Bank statement fr v2
    • Carte grise v1
    • Energy bill fra v1
    • French healthcard v1
    • Idcard fr v2
    • Ind passport v1
    • Payslip fra v3
    • Us healthcare cards v1
    • Us mail v3
  • More
    • Versions
    • Source
    • Playground
    • Stats
    • Metadata
    • Wiki
    • Announcements
    Community
    • Articles
    • Tutorials
    • Videos
    • Community
  1. Gems
  2. mindee
  3. 4.4.1

mindee

Quickly and easily connect to Mindee's API services using Ruby.

Types
Docs
Guides
Zeitwerk
Namespace
Optimized

Version

4.4.1

Authors

Mindee, SA

Dependencies

base64, marcel, mini_magick, origamindee, pdf-reader, prism, rake, rbs, rspec, rubocop, steep, yard

Quick Start

bundle add mindee

Getting Started

Learn more about the Mindee gem.

Installation

Learn more about how to install and configure the gem

Documentation

Learn more about the details

Guides

Learn more about the gem in the written guides

Reference

Learn more about the classes and modules

Documentation

docs/advanced_file_operations.md

Read about "Advanced file operations" in mindee

Read more

docs/getting_started.md

Read about "Getting started" in mindee

Read more

docs/global_products.md

Read about "Global products" in mindee

Read more

docs/global_products/barcode_reader_v1.md

Read about "Barcode reader v1" in mindee

Read more

Playground

Test, play and inspect the gem for yourself

irb(main):001:0>

            

Playground

Run a Ruby playground with the mindee gem pre-installed

Play

Top-Level Modules

  • Mindee

Top-Level Instance Methods

  • # logger
Home
Gems
Docs
Contribute
Monitoring
Twitter GitHub Mastodon

© 2025 gem.sh - Beautiful documentation for any Ruby gem