Documentation for mindee (3.16.0)

Alphabetic Index

File Listing

README

Namespace Listing A-Z

A

AbstractField (Mindee::Parsing::Standard)
AmountField (Mindee::Parsing::Standard)
ApiRequest (Mindee::Parsing::Common)
ApiResponse (Mindee::Parsing::Common)

B

BankAccountDetails (Mindee::Product::FR)
BankAccountDetailsV1 (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV1Document (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV1Page (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV1PagePrediction (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV2 (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV2Bban (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV2Document (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV2Page (Mindee::Product::FR::BankAccountDetails)
BankAccountDetailsV2PagePrediction (Mindee::Product::FR::BankAccountDetails)
BankCheck (Mindee::Product::US)
BankCheckV1 (Mindee::Product::US::BankCheck)
BankCheckV1Document (Mindee::Product::US::BankCheck)
BankCheckV1Page (Mindee::Product::US::BankCheck)
BankCheckV1PagePrediction (Mindee::Product::US::BankCheck)
BankStatement (Mindee::Product::FR)
BankStatementV1 (Mindee::Product::FR::BankStatement)
BankStatementV1Document (Mindee::Product::FR::BankStatement)
BankStatementV1Page (Mindee::Product::FR::BankStatement)
BankStatementV1PagePrediction (Mindee::Product::FR::BankStatement)
BankStatementV1Transaction (Mindee::Product::FR::BankStatement)
BarcodeReader (Mindee::Product)
BarcodeReaderV1 (Mindee::Product::BarcodeReader)
BarcodeReaderV1Document (Mindee::Product::BarcodeReader)
BarcodeReaderV1Page (Mindee::Product::BarcodeReader)
BarcodeReaderV1PagePrediction (Mindee::Product::BarcodeReader)
Base64InputSource (Mindee::Input::Source)
BillOfLading (Mindee::Product)
BillOfLadingV1 (Mindee::Product::BillOfLading)
BillOfLadingV1Carrier (Mindee::Product::BillOfLading)
BillOfLadingV1CarrierItem (Mindee::Product::BillOfLading)
BillOfLadingV1Consignee (Mindee::Product::BillOfLading)
BillOfLadingV1Document (Mindee::Product::BillOfLading)
BillOfLadingV1NotifyParty (Mindee::Product::BillOfLading)
BillOfLadingV1Page (Mindee::Product::BillOfLading)
BillOfLadingV1PagePrediction (Mindee::Product::BillOfLading)
BillOfLadingV1Shipper (Mindee::Product::BillOfLading)
BooleanField (Mindee::Parsing::Standard)
BusinessCard (Mindee::Product)
BusinessCardV1 (Mindee::Product::BusinessCard)
BusinessCardV1Document (Mindee::Product::BusinessCard)
BusinessCardV1Page (Mindee::Product::BusinessCard)
BusinessCardV1PagePrediction (Mindee::Product::BusinessCard)
BytesInputSource (Mindee::Input::Source)

C

CarteGrise (Mindee::Product::FR)
CarteGriseV1 (Mindee::Product::FR::CarteGrise)
CarteGriseV1Document (Mindee::Product::FR::CarteGrise)
CarteGriseV1Page (Mindee::Product::FR::CarteGrise)
CarteGriseV1PagePrediction (Mindee::Product::FR::CarteGrise)
CarteVitale (Mindee::Product::FR)
CarteVitaleV1 (Mindee::Product::FR::CarteVitale)
CarteVitaleV1Document (Mindee::Product::FR::CarteVitale)
CarteVitaleV1Page (Mindee::Product::FR::CarteVitale)
CarteVitaleV1PagePrediction (Mindee::Product::FR::CarteVitale)
ClassificationField (Mindee::Parsing::Custom)
ClassificationField (Mindee::Parsing::Standard)
Client (Mindee)
Common (Mindee::Parsing)
CompanyRegistrationField (Mindee::Parsing::Standard)
Cropper (Mindee::Product)
CropperExtra (Mindee::Parsing::Common::Extras)
CropperV1 (Mindee::Product::Cropper)
CropperV1Document (Mindee::Product::Cropper)
CropperV1Page (Mindee::Product::Cropper)
CropperV1PagePrediction (Mindee::Product::Cropper)
Custom (Mindee::Parsing)
Custom (Mindee::Product)
CustomV1 (Mindee::Product::Custom)
CustomV1Document (Mindee::Product::Custom)
CustomV1Page (Mindee::Product::Custom)
CustomV1PagePrediction (Mindee::Product::Custom)

D

DateField (Mindee::Parsing::Standard)
DeliveryNote (Mindee::Product)
DeliveryNoteV1 (Mindee::Product::DeliveryNote)
DeliveryNoteV1Document (Mindee::Product::DeliveryNote)
DeliveryNoteV1Page (Mindee::Product::DeliveryNote)
DeliveryNoteV1PagePrediction (Mindee::Product::DeliveryNote)
Document (Mindee::Parsing::Common)
DriverLicense (Mindee::Product::EU)
DriverLicense (Mindee::Product::US)
DriverLicenseV1 (Mindee::Product::US::DriverLicense)
DriverLicenseV1 (Mindee::Product::EU::DriverLicense)
DriverLicenseV1Document (Mindee::Product::EU::DriverLicense)
DriverLicenseV1Document (Mindee::Product::US::DriverLicense)
DriverLicenseV1Page (Mindee::Product::EU::DriverLicense)
DriverLicenseV1Page (Mindee::Product::US::DriverLicense)
DriverLicenseV1PagePrediction (Mindee::Product::EU::DriverLicense)
DriverLicenseV1PagePrediction (Mindee::Product::US::DriverLicense)

E

EU (Mindee::Product)
Endpoint (Mindee::HTTP)
EnergyBill (Mindee::Product::FR)
EnergyBillV1 (Mindee::Product::FR::EnergyBill)
EnergyBillV1Document (Mindee::Product::FR::EnergyBill)
EnergyBillV1EnergyConsumer (Mindee::Product::FR::EnergyBill)
EnergyBillV1EnergySupplier (Mindee::Product::FR::EnergyBill)
EnergyBillV1EnergyUsage (Mindee::Product::FR::EnergyBill)
EnergyBillV1MeterDetail (Mindee::Product::FR::EnergyBill)
EnergyBillV1Page (Mindee::Product::FR::EnergyBill)
EnergyBillV1PagePrediction (Mindee::Product::FR::EnergyBill)
EnergyBillV1Subscription (Mindee::Product::FR::EnergyBill)
EnergyBillV1TaxesAndContribution (Mindee::Product::FR::EnergyBill)
Error (Mindee::HTTP)
ExtractedImage (Mindee::Extraction)
ExtractedPdf (Mindee::Extraction::PdfExtractor)
Extraction (Mindee)
Extras (Mindee::Parsing::Common)
Extras (Mindee::Parsing::Common::Extras)

F

FR (Mindee::Product)
FeatureField (Mindee::Parsing::Standard)
Field (Mindee::Parsing::Standard)
FileInputSource (Mindee::Input::Source)
FinancialDocument (Mindee::Product)
FinancialDocumentV1 (Mindee::Product::FinancialDocument)
FinancialDocumentV1Document (Mindee::Product::FinancialDocument)
FinancialDocumentV1LineItem (Mindee::Product::FinancialDocument)
FinancialDocumentV1Page (Mindee::Product::FinancialDocument)
FinancialDocumentV1PagePrediction (Mindee::Product::FinancialDocument)
FullTextOCRExtra (Mindee::Parsing::Common::Extras)

G

Generated (Mindee::Product)
Generated (Mindee::Parsing)
GeneratedListField (Mindee::Parsing::Generated)
GeneratedObjectField (Mindee::Parsing::Generated)
GeneratedV1 (Mindee::Product::Generated)
GeneratedV1Document (Mindee::Product::Generated)
GeneratedV1Page (Mindee::Product::Generated)
GeneratedV1PagePrediction (Mindee::Product::Generated)
GeneratedV1Prediction (Mindee::Product::Generated)
Geometry (Mindee)

H

HTTP (Mindee)
HealthcareCard (Mindee::Product::US)
HealthcareCardV1 (Mindee::Product::US::HealthcareCard)
HealthcareCardV1Copay (Mindee::Product::US::HealthcareCard)
HealthcareCardV1Document (Mindee::Product::US::HealthcareCard)
HealthcareCardV1Page (Mindee::Product::US::HealthcareCard)
HealthcareCardV1PagePrediction (Mindee::Product::US::HealthcareCard)

I

IND (Mindee::Product)
IdCard (Mindee::Product::FR)
IdCardV1 (Mindee::Product::FR::IdCard)
IdCardV1Document (Mindee::Product::FR::IdCard)
IdCardV1Page (Mindee::Product::FR::IdCard)
IdCardV1PagePrediction (Mindee::Product::FR::IdCard)
IdCardV2 (Mindee::Product::FR::IdCard)
IdCardV2Document (Mindee::Product::FR::IdCard)
IdCardV2Page (Mindee::Product::FR::IdCard)
IdCardV2PagePrediction (Mindee::Product::FR::IdCard)
Image (Mindee)
ImageCompressor (Mindee::Image)
ImageExtractor (Mindee::Extraction)
ImageUtils (Mindee::Image)
IndianPassport (Mindee::Product::IND)
IndianPassportV1 (Mindee::Product::IND::IndianPassport)
IndianPassportV1Document (Mindee::Product::IND::IndianPassport)
IndianPassportV1Page (Mindee::Product::IND::IndianPassport)
IndianPassportV1PagePrediction (Mindee::Product::IND::IndianPassport)
Inference (Mindee::Parsing::Common)
Input (Mindee)
InternationalId (Mindee::Product)
InternationalIdV1 (Mindee::Product::InternationalId)
InternationalIdV1Document (Mindee::Product::InternationalId)
InternationalIdV1Page (Mindee::Product::InternationalId)
InternationalIdV1PagePrediction (Mindee::Product::InternationalId)
InternationalIdV2 (Mindee::Product::InternationalId)
InternationalIdV2Document (Mindee::Product::InternationalId)
InternationalIdV2Page (Mindee::Product::InternationalId)
InternationalIdV2PagePrediction (Mindee::Product::InternationalId)
InvalidMimeTypeError (Mindee::Input::Source)
Invoice (Mindee::Product)
InvoiceSplitter (Mindee::Product)
InvoiceSplitterV1 (Mindee::Product::InvoiceSplitter)
InvoiceSplitterV1Document (Mindee::Product::InvoiceSplitter)
InvoiceSplitterV1Page (Mindee::Product::InvoiceSplitter)
InvoiceSplitterV1PageGroup (Mindee::Product::InvoiceSplitter)
InvoiceSplitterV1PagePrediction (Mindee::Product::InvoiceSplitter)
InvoiceV4 (Mindee::Product::Invoice)
InvoiceV4Document (Mindee::Product::Invoice)
InvoiceV4LineItem (Mindee::Product::Invoice)
InvoiceV4Page (Mindee::Product::Invoice)
InvoiceV4PagePrediction (Mindee::Product::Invoice)

J

Job (Mindee::Parsing::Common)
JobStatus (Mindee::Parsing::Common)

L

LicensePlate (Mindee::Product::EU)
LicensePlateV1 (Mindee::Product::EU::LicensePlate)
LicensePlateV1Document (Mindee::Product::EU::LicensePlate)
LicensePlateV1Page (Mindee::Product::EU::LicensePlate)
LicensePlateV1PagePrediction (Mindee::Product::EU::LicensePlate)
ListField (Mindee::Parsing::Custom)
ListFieldItem (Mindee::Parsing::Custom)
LocalInputSource (Mindee::Input::Source)
LocalResponse (Mindee::Input)
LocaleField (Mindee::Parsing::Standard)

M

MVisionV1 (Mindee::Parsing::Common::Ocr)
MimeTypeError (Mindee::Input::Source)
MinMax (Mindee::Geometry)
Mindee
MindeeHttpClientError (Mindee::HTTP::Error)
MindeeHttpError (Mindee::HTTP::Error)
MindeeHttpServerError (Mindee::HTTP::Error)
MultiReceiptsDetector (Mindee::Product)
MultiReceiptsDetectorV1 (Mindee::Product::MultiReceiptsDetector)
MultiReceiptsDetectorV1Document (Mindee::Product::MultiReceiptsDetector)
MultiReceiptsDetectorV1Page (Mindee::Product::MultiReceiptsDetector)
MultiReceiptsDetectorV1PagePrediction (Mindee::Product::MultiReceiptsDetector)
MultiReceiptsExtractor (Mindee::Extraction)

N

NutritionFactsLabel (Mindee::Product)
NutritionFactsLabelV1 (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1AddedSugar (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1Calorie (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1Cholesterol (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1DietaryFiber (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1Document (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1Nutrient (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1Page (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1PagePrediction (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1Protein (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1SaturatedFat (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1ServingSize (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1Sodium (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1TotalCarbohydrate (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1TotalFat (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1TotalSugar (Mindee::Product::NutritionFactsLabel)
NutritionFactsLabelV1TransFat (Mindee::Product::NutritionFactsLabel)

O

Ocr (Mindee::Parsing::Common)
Ocr (Mindee::Parsing::Common::Ocr)
OcrExtractor (Mindee::Extraction)
OcrLine (Mindee::Parsing::Common::Ocr)
OcrPage (Mindee::Parsing::Common::Ocr)
OcrWord (Mindee::Parsing::Common::Ocr)
Orientation (Mindee::Parsing::Common)

P

PDF (Mindee)
PDFCompressor (Mindee::PDF)
PDFTools (Mindee::PDF)
Page (Mindee::Parsing::Common)
Parsing (Mindee)
Passport (Mindee::Product)
PassportV1 (Mindee::Product::Passport)
PassportV1Document (Mindee::Product::Passport)
PassportV1Page (Mindee::Product::Passport)
PassportV1PagePrediction (Mindee::Product::Passport)
PathInputSource (Mindee::Input::Source)
PaymentDetailsField (Mindee::Parsing::Standard)
Payslip (Mindee::Product::FR)
PayslipV2 (Mindee::Product::FR::Payslip)
PayslipV2BankAccountDetail (Mindee::Product::FR::Payslip)
PayslipV2Document (Mindee::Product::FR::Payslip)
PayslipV2Employee (Mindee::Product::FR::Payslip)
PayslipV2Employer (Mindee::Product::FR::Payslip)
PayslipV2Employment (Mindee::Product::FR::Payslip)
PayslipV2Page (Mindee::Product::FR::Payslip)
PayslipV2PagePrediction (Mindee::Product::FR::Payslip)
PayslipV2PayDetail (Mindee::Product::FR::Payslip)
PayslipV2PayPeriod (Mindee::Product::FR::Payslip)
PayslipV2Pto (Mindee::Product::FR::Payslip)
PayslipV2SalaryDetail (Mindee::Product::FR::Payslip)
PdfExtractor (Mindee::Extraction)
PdfExtractor (Mindee::Extraction::PdfExtractor)
PdfProcessor (Mindee::PDF)
Point (Mindee::Geometry)
Polygon (Mindee::Geometry)
PositionField (Mindee::Parsing::Standard)
Prediction (Mindee::Parsing::Common)
Product (Mindee)
Product (Mindee::Parsing::Common)
ProofOfAddress (Mindee::Product)
ProofOfAddressV1 (Mindee::Product::ProofOfAddress)
ProofOfAddressV1Document (Mindee::Product::ProofOfAddress)
ProofOfAddressV1Page (Mindee::Product::ProofOfAddress)
ProofOfAddressV1PagePrediction (Mindee::Product::ProofOfAddress)

Q

Quadrilateral (Mindee::Geometry)

R

Receipt (Mindee::Product)
ReceiptV4 (Mindee::Product::Receipt)
ReceiptV4Document (Mindee::Product::Receipt)
ReceiptV4Page (Mindee::Product::Receipt)
ReceiptV4PagePrediction (Mindee::Product::Receipt)
ReceiptV5 (Mindee::Product::Receipt)
ReceiptV5Document (Mindee::Product::Receipt)
ReceiptV5LineItem (Mindee::Product::Receipt)
ReceiptV5Page (Mindee::Product::Receipt)
ReceiptV5PagePrediction (Mindee::Product::Receipt)
RequestStatus (Mindee::Parsing::Common)
ResponseValidation (Mindee::HTTP)
Resume (Mindee::Product)
ResumeV1 (Mindee::Product::Resume)
ResumeV1Certificate (Mindee::Product::Resume)
ResumeV1Document (Mindee::Product::Resume)
ResumeV1Education (Mindee::Product::Resume)
ResumeV1Language (Mindee::Product::Resume)
ResumeV1Page (Mindee::Product::Resume)
ResumeV1PagePrediction (Mindee::Product::Resume)
ResumeV1ProfessionalExperience (Mindee::Product::Resume)
ResumeV1SocialNetworksUrl (Mindee::Product::Resume)

S

Source (Mindee::Input)
Standard (Mindee::Parsing)
StringField (Mindee::Parsing::Standard)

T

TaxExtractor (Mindee::Extraction)
TaxField (Mindee::Parsing::Standard)
Taxes (Mindee::Parsing::Standard)

U

US (Mindee::Product)
UnfixablePDFError (Mindee::Input::Source)
UrlInputSource (Mindee::Input::Source)
UsMail (Mindee::Product::US)
UsMailV2 (Mindee::Product::US::UsMail)
UsMailV2Document (Mindee::Product::US::UsMail)
UsMailV2Page (Mindee::Product::US::UsMail)
UsMailV2PagePrediction (Mindee::Product::US::UsMail)
UsMailV2RecipientAddress (Mindee::Product::US::UsMail)
UsMailV2SenderAddress (Mindee::Product::US::UsMail)

W

W9 (Mindee::Product::US)
W9V1 (Mindee::Product::US::W9)
W9V1Document (Mindee::Product::US::W9)
W9V1Page (Mindee::Product::US::W9)
W9V1PagePrediction (Mindee::Product::US::W9)