All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Annotation Types Summary Class Description AddressField Represent a postal address field broken down into its individual components.AmountField Represent an amount.ApiRequest Information from Mindee about the api request.ApiResponse Base class for all responses from the Mindee API.AsyncPredictResponse<T extends Inference> Represent a `predict` response from Mindee API.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.BarcodeReaderV1 Barcode Reader API version 1 inference prediction.BarcodeReaderV1Document Barcode Reader API version 1.0 document data.BaseField Represent basics of a field.BaseField Base class for V2 fields.BaseInference<TResult> Inference object for the V2 API.BaseLocalResponse A Mindee response saved locally.BaseParameters BaseParameters.BaseBuilder<T extends BaseParameters.BaseBuilder<T>> BasePDFExtractor PDF extraction class.BasePollingOptions Options to pass for asynchronous parsing with polling.Bbox True representation of a mathematical bounding box.BboxUtils Methods for working with BBoxes.BooleanField Represent a date.CarteGriseV1 Carte Grise API version 1 inference prediction.CarteGriseV1Document Carte Grise API version 1.1 document data.ClassificationClassifier Classification of the document type from the source file.ClassificationField Represents a classifier value.ClassificationInference The inference result for a classification utility request.ClassificationParameters ClassificationParameters.Builder ClassificationResponse Response for a classification utility inference.ClassificationResult Result of the document classifier inference.CommandLineInterface Command Line Interface for the Mindee client.CommandLineInterface.ProductCommandHandler Adds all commands from CommandLineInterfaceProducts automatically.CommandLineInterfaceProducts Product-wrapper class for CLI use.CommonResponse Common response information from Mindee API V2.CompanyRegistrationField Represent a company registration.Crop CropInference The inference result for a classification utility request.CropItem Result of a cropped document region.CropParameters CropParameters.Builder 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.CropResponse Response for a crop utility inference.CropResult Result of a crop utility inference.CustomEndpointInfo Endpoint settings for custom documents.DataSchemaActiveOptions Data schema options activated during the inference.DateField Represent a date.Document<DocT extends Inference> Define the parsed document.DriverLicenseV1 Driver License API version 1 inference prediction.DriverLicenseV1Document Driver License API version 1.0 document data.DynamicField Dynamically-typed field (simple / object / list).DynamicField.FieldType Possible field kinds.DynamicFieldDeserializer Custom deserializer forDynamicField.Endpoint Endpoint for custom documents.EndpointInfo Base info for all endpoints.Error Error information from an API response.ErrorDetails Represent error details.ErrorDetailsDeserializer JSON deserializer for the error portion of the return.ErrorItem Error item model.ErrorResponse Error response detailing a problem.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.ExtractedImages ExtractedPDF An extracted sub-PDF.ExtractedPDFs ExtractionInference Inference object for the V2 API.ExtractionParameters Options to pass when calling methods using the API V2.ExtractionParameters.Builder Fluent builder forExtractionParameters.ExtractionResponse Response for an extraction inference.ExtractionResult The inference result for an extraction request.Extras Optional information.FieldConfidence Confidence level of a field as returned by the V2 API.FieldLocation Location data for a field.FinancialDocumentV1 Financial Document API version 1 inference prediction.FinancialDocumentV1Document Financial Document API version 1.14 document data.FinancialDocumentV1LineItem List of line item present on the document.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.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.2 document data.Inference<TPagePrediction,TDocumentPrediction extends Prediction> Common inference data.InferenceActiveOptions Options which were activated during the inference.InferenceExtras Inference-level optional info.InferenceFields Inference fields map.InferenceFile File info for V2 API.InferenceJob Information on the Job associated to a given Inference.InferenceModel Model information for a V2 API inference.InputSourceUtils Utilities for working with files.InternationalIdV2 International ID API version 2 inference prediction.InternationalIdV2Document International ID API version 2.2 document data.InvoiceSplitterV1 Invoice Splitter API version 1 inference prediction.InvoiceSplitterV1Document Invoice Splitter API version 1.4 document data.InvoiceSplitterV1InvoicePageGroup List of page groups.InvoiceV4 Invoice API version 4 inference prediction.InvoiceV4Document Invoice API version 4.11 document data.InvoiceV4LineItem List of all the line items present on the invoice.Job Job Details for enqueued jobs.Job Information on the processing of a file sent to the Mindee API.JobResponse Represents an asynchronous polling response.JobWebhook JobWebhook info.LineItemField Represent a single line in a field printable as an rST table.ListField Field holding a list of fields.LocalDateTimeDeserializer Deserializer for LocalDateTime.LocaleField The local of the page.LocalInputSource A source document for Mindee API operations.LocalResponse A Mindee response saved locally.LocalResponse A Mindee response saved locally.MindeeApiCommon Defines common methods for mindee APIs.MindeeApiV1 Defines required methods for an API.MindeeApiV2 Defines required methods for an API.MindeeClient Main entrypoint for Mindee operations.MindeeClient Entry point for the Mindee **V2** API features.MindeeException Represent a Mindee exception.MindeeHttpApiV1 HTTP Client class.MindeeHttpApiV1.MindeeHttpApiV1Builder MindeeHttpApiV2 HTTP Client class for the V2 API.MindeeHttpApiV2.MindeeHttpApiV2Builder MindeeHttpExceptionV1 Represent a Mindee exception.MindeeHttpExceptionV2 Represent a Mindee exception.MindeeSettings Mindee API configuration.MindeeSettings Mindee API V2 configuration.MindeeSettings.MindeeSettingsBuilder MinMax Minimum and maximum values.ModelWebhook Model webhook info.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.ObjectField Field holding a map of sub-fields.Ocr Ocr result information.OcrInference The inference result for an OCR utility request.OcrPage Represents a page.OcrPage OCR result for a single page.OcrParameters OcrParameters.Builder OcrResponse Response for an OCR utility inference.OcrResult Result of the OCR utility inference.OcrWord OCR result for a single word extracted from the document 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.PageOptions.Builder Builder for page options.PageOptionsOperation Possible page operations on a document.Pages<TPagePrediction> List of all pages in the inference.PaginationMetadata PaginationMetadata data associated with model search.PassportV1 Passport API version 1 inference prediction.PassportV1Document Passport API version 1.1 document data.PaymentDetailsField Represent a payment detail.PDFCompression Compress a PDF.PDFCompressor PDF compression class.PDFExtractor PDF extraction class.PDFInputOperation Various operations required for PDF input files.PDFInputOperator Allows performing various operations on PDFs.PDFPageImage A page in a PDF extracted as an image.PDFRasterization Rasterize a PDF into images.PDFRasterizer Default PDF rasterization implementation.Point A relative set of coordinates (X, Y) on the document.Point.PointBuilder PollingOptions PollingOptions PollingOptions.PollingOptionsBuilder PollingOptions.PollingOptionsBuilder Polygon Contains any number of vertex coordinates (Points).PolygonDeserializer JSON deserializer for polygons.PolygonUtils Methods for working with Polygons.PositionDataField 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.Product The product on which the document was parsed.ProductInfo Base info for all v2 products.ProductProcessor Interface to process CLI products.Rag Retrieval-Augmented Generation info class.RagMetadata RAG metadata.RawText Raw text as found in the document.RawTextPage Raw text extracted from the page.ReceiptV5 Receipt API version 5 inference prediction.ReceiptV5Document Receipt API version 5.4 document data.ReceiptV5LineItem List of all line items on the receipt.RequestParameters Parameters for making API calls to the endpoint.RequestParameters.RequestParametersBuilder SearchModel Models search response.SearchResponse Models search response.SimpleField Field holding a single scalar value.SimpleFieldDeserializer Custom deserializer forSimpleField.Split SplitInference The inference result for a split utility request.SplitParameters SplitParameters.Builder SplitPDF The split PDF.SplitRange A single document as identified when splitting a multi-document source file.SplitResponse Response for a crop utility inference.SplitResult Result of the document splitter inference.StringField Represent a string field.SummaryHelper Various static methods to help generate the prediction summaries.SummaryHelperV1 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.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.