All Classes

Class	Description
AmountField	Represent an amount.
Anchor	An anchor column.
ApiRequest	Information from Mindee about the api request.
ApiResponse	Base class for all responses from the Mindee API.
AsyncPollingOptions	Options to pass for asynchronous parsing with polling.
AsyncPollingOptions.AsyncPollingOptionsBuilder
AsyncPredictResponse<T extends Inference>	Represent a `predict` response from Mindee API.
BankAccountDetailsV1	Bank Account Details API version 1 inference prediction.
BankAccountDetailsV1Document	Bank Account Details API version 1.0 document data.
BankAccountDetailsV2	Bank Account Details API version 2 inference prediction.
BankAccountDetailsV2Bban	Full extraction of BBAN, including: branch code, bank code, account and key.
BankAccountDetailsV2Document	Bank Account Details API version 2.0 document data.
BankCheckV1	Bank Check API version 1 inference prediction.
BankCheckV1Document	Bank Check API version 1.1 document data.
BankCheckV1Page	Bank Check API version 1.1 page data.
BarcodeReaderV1	Barcode Reader API version 1 inference prediction.
BarcodeReaderV1Document	Barcode Reader API version 1.0 document data.
BaseField	Represent basics of a field.
Bbox	True representation of a mathematical bounding box.
BboxUtils	Methods for working with BBoxes.
BillOfLadingV1	Bill of Lading API version 1 inference prediction.
BillOfLadingV1Carrier	The shipping company responsible for transporting the goods.
BillOfLadingV1CarrierItem	The goods being shipped.
BillOfLadingV1Consignee	The party to whom the goods are being shipped.
BillOfLadingV1Document	Bill of Lading API version 1.1 document data.
BillOfLadingV1NotifyParty	The party to be notified of the arrival of the goods.
BillOfLadingV1Shipper	The party responsible for shipping the goods.
BooleanField	Represent a date.
BoundingBoxUtils	Methods for working with BoundingBoxes.
BusinessCardV1	Business Card API version 1 inference prediction.
BusinessCardV1Document	Business Card API version 1.0 document data.
CarteGriseV1	Carte Grise API version 1 inference prediction.
CarteGriseV1Document	Carte Grise API version 1.1 document data.
ClassificationField	A field holding a classification value.
ClassificationField	Represents a classifier value.
CommandLineInterface	Command Line Interface for the Mindee client.
CompanyRegistrationField	Represent a company registration.
Cropper	Cropping result.
CropperV1	Cropper API version 1 inference prediction.
CropperV1Document	Cropper API version 1.1 document data.
CropperV1Page	Cropper API version 1.1 page data.
CustomEndpointInfo	Endpoint settings for custom documents.
CustomV1	Define a simple model to encapsulate data from a custom API builder model.
CustomV1Document	Document data for custom documents, API version 1.x.
CustomV1DocumentPredictionDeserializer	JSON deserializer for custom documents v1.x.
CustomV1Page	Page data for custom documents, API version 1.x.
DateField	Represent a date.
DeliveryNoteV1	Delivery note API version 1 inference prediction.
DeliveryNoteV1Document	Delivery note API version 1.1 document data.
Document<DocT extends Inference>	Define the parsed document.
DriverLicenseV1	Driver License API version 1 inference prediction.
DriverLicenseV1	Driver License API version 1 inference prediction.
DriverLicenseV1	Driver License API version 1 inference prediction.
DriverLicenseV1Document	Driver License API version 1.0 document data.
DriverLicenseV1Document	Driver License API version 1.0 document data.
DriverLicenseV1Document	Driver License API version 1.1 document data.
DriverLicenseV1Page	Driver License API version 1.0 page data.
DriverLicenseV1Page	Driver License API version 1.1 page data.
Endpoint	Endpoint for custom documents.
EndpointInfo	Base info for all endpoints.
EnergyBillV1	Energy Bill API version 1 inference prediction.
EnergyBillV1Document	Energy Bill API version 1.0 document data.
EnergyBillV1EnergyConsumer	The entity that consumes the energy.
EnergyBillV1EnergySupplier	The company that supplies the energy.
EnergyBillV1EnergyUsage	Details of energy consumption.
EnergyBillV1MeterDetail	Information about the energy meter.
EnergyBillV1Subscription	The subscription details fee for the energy service.
EnergyBillV1TaxesAndContribution	Details of Taxes and Contributions.
Error	Error information from an API response.
ErrorDetails	Represent error details.
ErrorDetailsDeserializer	JSON deserializer for the error portion of the return.
Execution<DocT extends Inference>	Representation of a workflow execution.
ExecutionFile	Representation of a workflow execution's file data.
ExecutionPriority	Execution priority for a workflow.
ExtractedImage	An extracted sub-image.
ExtractedPDF	An extracted sub-PDF.
Extras	Optional information.
FinancialDocumentV1	Financial Document API version 1 inference prediction.
FinancialDocumentV1Document	Financial Document API version 1.11 document data.
FinancialDocumentV1LineItem	List of line item details.
FullTextOcr	Full Text OCR result.
GeneratedFeature	A generic feature which can represent any OTS Mindee return prediction.
GeneratedObject	An object within a feature.
GeneratedV1	Define a simple model to encapsulate data from any API.
GeneratedV1Document	Document data for generated documents.
GeneratedV1PredictionDeserializer	JSON deserializer for generated documents v1.x.
HealthCardV1	Health Card API version 1 inference prediction.
HealthCardV1Document	Health Card API version 1.0 document data.
HealthcareCardV1	Healthcare Card API version 1 inference prediction.
HealthcareCardV1Copay	Is a fixed amount for a covered service.
HealthcareCardV1Document	Healthcare Card API version 1.0 document data.
IdCardV1	Carte Nationale d'Identité API version 1 inference prediction.
IdCardV1Document	Carte Nationale d'Identité API version 1.1 document data.
IdCardV1Page	Carte Nationale d'Identité API version 1.1 page data.
IdCardV2	Carte Nationale d'Identité API version 2 inference prediction.
IdCardV2Document	Carte Nationale d'Identité API version 2.0 document data.
IdCardV2Page	Carte Nationale d'Identité API version 2.0 page data.
ImageCompressor	Image compression class.
ImageExtractor	Extract sub-images from an image.
ImageUtils	Image utility class.
ImageUtils.Dimensions	Dimension class for pages/images.
IndianPassportV1	Passport - India API version 1 inference prediction.
IndianPassportV1Document	Passport - India API version 1.1 document data.
Inference<TPagePrediction,TDocumentPrediction extends Prediction>	Common inference data.
InferenceExtras	Inference-level optional info.
InputSourceUtils	Utilities for working with files.
InternationalIdV2	International ID API version 2 inference prediction.
InternationalIdV2Document	International ID API version 2.1 document data.
InvoiceSplitterV1	The invoice splitter V1 inference.
InvoiceSplitterV1Document	Document data for Invoice Splitter, API version 1.
InvoiceSplitterV1Document.PageIndexes	Represents a grouping of pages.
InvoiceV4	Invoice API version 4 inference prediction.
InvoiceV4Document	Invoice API version 4.9 document data.
InvoiceV4LineItem	List of line item details.
Job	Job Details for enqueued jobs.
LicensePlateV1	License Plate API version 1 inference prediction.
LicensePlateV1Document	License Plate API version 1.1 document data.
Line	Represent a single line.
LineGenerator	Get lines.
LineItemField	Represent a single line in a field printable as an rST table.
LineItems	Line items details.
LineItemsGenerator	WARNING: This feature is experimental!
ListField	A field containing a list of values.
ListFieldValue	A single value in a ListField.
LocaleField	The local of the page.
LocalInputSource	A source document for Mindee API operations.
LocalResponse	A Mindee response saved locally.
MindeeApi	Defines required methods for an API.
MindeeClient	Main entrypoint for Mindee operations.
MindeeException	Represent a Mindee exception.
MindeeHttpApi	HTTP Client class.
MindeeHttpApi.MindeeHttpApiBuilder
MindeeHttpException	Represent a Mindee exception.
MindeeSettings	Mindee API configuration.
MinMax	Minimum and maximum values.
MultiReceiptsDetectorV1	Multi Receipts Detector API version 1 inference prediction.
MultiReceiptsDetectorV1Document	Multi Receipts Detector API version 1.1 document data.
MvisionV1	List all pages that have ocr results.
NutritionFactsLabelV1	Nutrition Facts Label API version 1 inference prediction.
NutritionFactsLabelV1AddedSugar	The amount of added sugars in the product.
NutritionFactsLabelV1Calorie	The amount of calories in the product.
NutritionFactsLabelV1Cholesterol	The amount of cholesterol in the product.
NutritionFactsLabelV1DietaryFiber	The amount of dietary fiber in the product.
NutritionFactsLabelV1Document	Nutrition Facts Label API version 1.0 document data.
NutritionFactsLabelV1Nutrient	The amount of nutrients in the product.
NutritionFactsLabelV1Protein	The amount of protein in the product.
NutritionFactsLabelV1SaturatedFat	The amount of saturated fat in the product.
NutritionFactsLabelV1ServingSize	The size of a single serving of the product.
NutritionFactsLabelV1Sodium	The amount of sodium in the product.
NutritionFactsLabelV1TotalCarbohydrate	The total amount of carbohydrates in the product.
NutritionFactsLabelV1TotalFat	The total amount of fat in the product.
NutritionFactsLabelV1TotalSugar	The total amount of sugars in the product.
NutritionFactsLabelV1TransFat	The amount of trans fat in the product.
Ocr	Ocr result information.
OcrPage	Represents a page.
Orientation	The orientation which was applied from the original page.
Page<TPagePrediction>	Define a page in the parsed document.
PageOptions	Represent options to cut a document.
PageOptionsOperation	Possible page operations on a document.
Pages<TPagePrediction>	List of all pages in the inference.
PassportV1	Passport API version 1 inference prediction.
PassportV1Document	Passport API version 1.1 document data.
PaymentDetailsField	Represent a payment detail.
PayslipV2	Payslip API version 2 inference prediction.
PayslipV2BankAccountDetail	Information about the employee's bank account.
PayslipV2Document	Payslip API version 2.0 document data.
PayslipV2Employee	Information about the employee.
PayslipV2Employer	Information about the employer.
PayslipV2Employment	Information about the employment.
PayslipV2PayDetail	Detailed information about the pay.
PayslipV2PayPeriod	Information about the pay period.
PayslipV2Pto	Information about paid time off.
PayslipV2SalaryDetail	Detailed information about the earnings.
PayslipV3	Payslip API version 3 inference prediction.
PayslipV3BankAccountDetail	Information about the employee's bank account.
PayslipV3Document	Payslip API version 3.0 document data.
PayslipV3Employee	Information about the employee.
PayslipV3Employer	Information about the employer.
PayslipV3Employment	Information about the employment.
PayslipV3PaidTimeOff	Information about paid time off.
PayslipV3PayDetail	Detailed information about the pay.
PayslipV3PayPeriod	Information about the pay period.
PayslipV3SalaryDetail	Detailed information about the earnings.
PdfBoxApi	Allows performing various operations on PDFs.
PdfCompressor	PDF compression class.
PDFExtractor	PDF extraction class.
PdfOperation	Minimum PDF operations.
PdfPageImage	A page in a PDF extracted as an image.
PDFUtils	Utilities for working with PDFs.
Point	A relative set of coordinates (X, Y) on the document.
Point.PointBuilder
Polygon	Contains any number of vertex coordinates (Points).
Polygon.PolygonBuilder
PolygonDeserializer	JSON deserializer for polygons.
PolygonUtils	Methods for working with Polygons.
PositionData	A field with position data.
PositionField	A detected element in the image.
Prediction	Base class for all predictions.
PredictOptions	Parameters for making predict API calls.
PredictOptions.PredictOptionsBuilder
PredictResponse<T extends Inference>	Represent a `predict` response from Mindee API.
PreparedLines	An anchor and its initial lines.
Product	The product on which the document was parsed.
ProofOfAddressV1	Proof of Address API version 1 inference prediction.
ProofOfAddressV1Document	Proof of Address API version 1.1 document data.
ReceiptV4	The receipt V4 inference.
ReceiptV4Document	Document data for Receipt, API version 4.
ReceiptV5	Receipt API version 5 inference prediction.
ReceiptV5Document	Receipt API version 5.3 document data.
ReceiptV5LineItem	List of line item details.
RequestParameters	Parameters for making API calls to the endpoint.
RequestParameters.RequestParametersBuilder
ResumeV1	Resume API version 1 inference prediction.
ResumeV1Certificate	The list of certificates obtained by the candidate.
ResumeV1Document	Resume API version 1.2 document data.
ResumeV1Education	The list of the candidate's educational background.
ResumeV1Language	The list of languages that the candidate is proficient in.
ResumeV1ProfessionalExperience	The list of the candidate's professional experiences.
ResumeV1SocialNetworksUrl	The list of social network profiles of the candidate.
SplitPdf	The split PDF.
SplitQuery	Represent parameter to split a PDF.
StringField	Represent a string field.
SummaryHelper	Various static methods to help generate the prediction summaries.
Taxes	Represent all the tax lines.
TaxesDeserializer	JSON deserializer for custom documents v1.x.
TaxField	Represent a tax line.
URLInputSource	Input source wrapper to load remote files locally.
URLInputSource.Builder	Builder class for an URLInputSource.
UsMailV2	US Mail API version 2 inference prediction.
UsMailV2Document	US Mail API version 2.0 document data.
UsMailV2RecipientAddress	The addresses of the recipients.
UsMailV2SenderAddress	The address of the sender.
UsMailV3	US Mail API version 3 inference prediction.
UsMailV3Document	US Mail API version 3.0 document data.
UsMailV3RecipientAddress	The addresses of the recipients.
UsMailV3SenderAddress	The address of the sender.
W9V1	W9 API version 1 inference prediction.
W9V1Document	W9 API version 1.0 document data.
W9V1Page	W9 API version 1.0 page data.
Word	Represents a word.
WorkflowOptions	Workflow-specific options.
WorkflowOptions.WorkflowOptionsBuilder
WorkflowResponse<DocT extends Inference>	Represents the server response after a document is sent to a workflow.
WorkflowResponse.Default	Default product is GeneratedV1.