Index (Mindee Java Helper Library 5.0.0 API)

A B C D E F G H I J K L M N O P Q R S T U V W X Y
All Classes All Packages

A

a - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's license plate number.
accountHoldersNames - Variable in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of the account holders names.
accountName() - Method in annotation type com.mindee.v1.http.CustomEndpointInfo: The name of the account that owns the API.
accountName() - Method in annotation type com.mindee.v1.http.EndpointInfo
address - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The physical address of the document holder.
address1 - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The first line of the address of the passport holder.
address2 - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The second line of the address of the passport holder.
address3 - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The third line of the address of the passport holder.
AddressField - Class in com.mindee.v1.parsing.standard: Represent a postal address field broken down into its individual components.
AddressField(String, Double, Polygon) - Constructor for class com.mindee.v1.parsing.standard.AddressField: Address field constructor only containing the value.
AddressField(String, String, String, String, String, String, String, String, String, String, Double, Polygon, Integer) - Constructor for class com.mindee.v1.parsing.standard.AddressField
alias - Variable in class com.mindee.v2.clientoptions.BaseParameters: Optional alias for the file.
alias - Variable in class com.mindee.v2.clientoptions.BaseParameters.BaseBuilder
alias(String) - Method in class com.mindee.v1.clientoptions.WorkflowOptions.WorkflowOptionsBuilder
alias(String) - Method in class com.mindee.v2.clientoptions.BaseParameters.BaseBuilder: Set an alias for the uploaded document.
allWords(Boolean) - Method in class com.mindee.v1.clientoptions.PredictOptions.PredictOptionsBuilder
alternateName - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The alternate name of the card holder.
AmountField - Class in com.mindee.v1.parsing.standard: Represent an amount.
AmountField(Double, Double, Polygon, Integer) - Constructor for class com.mindee.v1.parsing.standard.AmountField
apiKey(String) - Method in class com.mindee.v2.MindeeSettings.MindeeSettingsBuilder
ApiRequest - Class in com.mindee.v1.parsing.common: Information from Mindee about the api request.
ApiRequest() - Constructor for class com.mindee.v1.parsing.common.ApiRequest
ApiResponse - Class in com.mindee.v1.parsing.common: Base class for all responses from the Mindee API.
ApiResponse() - Constructor for class com.mindee.v1.parsing.common.ApiResponse
applyPageOptions(PageOptions) - Method in class com.mindee.input.LocalInputSource: Applies PDF-specific operations on the current file based on the specified PageOptions.
arrayToString(List<T>, int[]) - Static method in class com.mindee.v1.parsing.SummaryHelperV1
arrayToString(List<T>, String) - Static method in class com.mindee.parsing.SummaryHelper: Given a list of fields, return a string.
asAmountField() - Method in class com.mindee.v1.parsing.generated.GeneratedFeature: Represent the feature as a standard AmountField.
asAmountField() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Represent the object as a standard AmountField.
asBooleanField() - Method in class com.mindee.v1.parsing.generated.GeneratedFeature: Represent the feature as a standard BooleanField.
asBooleanField() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Represent the object as a standard BooleanField.
asClassificationField() - Method in class com.mindee.v1.parsing.generated.GeneratedFeature: Represent the feature as a standard ClassificationField.
asClassificationField() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Represent the object as a standard ClassificationField.
asDateField() - Method in class com.mindee.v1.parsing.generated.GeneratedFeature: Represent the feature as a standard DateField.
asDateField() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Represent the object as a standard DateField.
asInputSource() - Method in class com.mindee.image.ExtractedImage: Return the image in a format suitable for sending to MindeeClient for parsing.
asInputSource() - Method in class com.mindee.image.PDFPageImage: Return the image in a format suitable for sending to MindeeClient for parsing.
asInputSource() - Method in class com.mindee.pdf.ExtractedPDF: Return the file in a format suitable for sending to MindeeClient for parsing.
asStringField() - Method in class com.mindee.v1.parsing.generated.GeneratedFeature: Represent the feature as a standard StringField.
asStringField() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Represent the object as a standard StringField.
AsyncPredictResponse<T extends Inference> - Class in com.mindee.v1.parsing.common: Represent a `predict` response from Mindee API.
AsyncPredictResponse() - Constructor for class com.mindee.v1.parsing.common.AsyncPredictResponse
asyncUrlFromEndpoint(Function<Endpoint, String>) - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
asyncUrlFromWorkflow(Function<String, String>) - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
authority - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The name of the issuing authority.
authority - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The name of the issuing authority.

B

b - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's first release date.
BankAccountDetailsV2 - Class in com.mindee.v1.product.fr.bankaccountdetails: Bank Account Details API version 2 inference prediction.
BankAccountDetailsV2() - Constructor for class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2
BankAccountDetailsV2Bban - Class in com.mindee.v1.product.fr.bankaccountdetails: Full extraction of BBAN, including: branch code, bank code, account and key.
BankAccountDetailsV2Bban() - Constructor for class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban
BankAccountDetailsV2Document - Class in com.mindee.v1.product.fr.bankaccountdetails: Bank Account Details API version 2.0 document data.
BankAccountDetailsV2Document() - Constructor for class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document
BarcodeReaderV1 - Class in com.mindee.v1.product.barcodereader: Barcode Reader API version 1 inference prediction.
BarcodeReaderV1() - Constructor for class com.mindee.v1.product.barcodereader.BarcodeReaderV1
BarcodeReaderV1Document - Class in com.mindee.v1.product.barcodereader: Barcode Reader API version 1.0 document data.
BarcodeReaderV1Document() - Constructor for class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document
BaseBuilder(String) - Constructor for class com.mindee.v2.clientoptions.BaseParameters.BaseBuilder
BaseField - Class in com.mindee.v1.parsing.standard: Represent basics of a field.
BaseField - Class in com.mindee.v2.parsing.inference.field: Base class for V2 fields.
BaseField() - Constructor for class com.mindee.v1.parsing.standard.BaseField: Default constructor.
BaseField() - Constructor for class com.mindee.v2.parsing.inference.field.BaseField
BaseField(FieldConfidence, List<FieldLocation>) - Constructor for class com.mindee.v2.parsing.inference.field.BaseField: Creates a new BaseField instance.
BaseField(Double, Polygon, Integer) - Constructor for class com.mindee.v1.parsing.standard.BaseField: JSON constructor.
BaseInference<TResult> - Class in com.mindee.v2.parsing: Inference object for the V2 API.
BaseInference() - Constructor for class com.mindee.v2.parsing.BaseInference
BaseInference(String, InferenceJob, InferenceModel, InferenceFile, TResult) - Constructor for class com.mindee.v2.parsing.BaseInference: Creates a new BaseInference instance.
BaseLocalResponse - Class in com.mindee.parsing: A Mindee response saved locally.
BaseLocalResponse(File) - Constructor for class com.mindee.parsing.BaseLocalResponse: Load from a File.
BaseLocalResponse(InputStream) - Constructor for class com.mindee.parsing.BaseLocalResponse: Load from an InputStream.
BaseLocalResponse(String) - Constructor for class com.mindee.parsing.BaseLocalResponse: Load from a String.
BaseLocalResponse(Path) - Constructor for class com.mindee.parsing.BaseLocalResponse: Load from a Path.
BaseParameters - Class in com.mindee.v2.clientoptions
BaseParameters(String, String, String[]) - Constructor for class com.mindee.v2.clientoptions.BaseParameters: Creates a new BaseParameters instance.
BaseParameters.BaseBuilder<T extends BaseParameters.BaseBuilder<T>> - Class in com.mindee.v2.clientoptions
BasePDFExtractor - Class in com.mindee.pdf: PDF extraction class.
BasePDFExtractor(LocalInputSource) - Constructor for class com.mindee.pdf.BasePDFExtractor: Init from a LocalInputSource.
BasePollingOptions - Class in com.mindee.clientoptions: Options to pass for asynchronous parsing with polling.
BasePollingOptions(Double, Double, Integer, double, double, int, double, double, int) - Constructor for class com.mindee.clientoptions.BasePollingOptions
baseUrl(String) - Method in class com.mindee.v2.MindeeSettings.MindeeSettingsBuilder
bban - Variable in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of BBAN, including: branch code, bank code, account and key.
Bbox - Class in com.mindee.geometry: True representation of a mathematical bounding box.
Bbox(double, double, double, double) - Constructor for class com.mindee.geometry.Bbox: The default constructor.
BboxUtils - Class in com.mindee.geometry: Methods for working with BBoxes.
billingAddress - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The customer's address used for billing.
billingAddress - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The customer billing address.
birthDate - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The date of birth of the card holder.
birthDate - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The date of birth of the card holder.
birthDate - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The birth date of the passport holder, ISO format: YYYY-MM-DD.
birthDate - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The date of birth of the document holder.
birthDate - Variable in class com.mindee.v1.product.passport.PassportV1Document: The date of birth of the passport holder.
birthPlace - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The place of birth of the card holder.
birthPlace - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The place of birth of the card holder.
birthPlace - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The birth place of the passport holder.
birthPlace - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The place of birth of the document holder.
birthPlace - Variable in class com.mindee.v1.product.passport.PassportV1Document: The place of birth of the passport holder.
BooleanField - Class in com.mindee.v1.parsing.standard: Represent a date.
BooleanField(Boolean, Double, Polygon, Integer) - Constructor for class com.mindee.v1.parsing.standard.BooleanField
build() - Method in class com.mindee.geometry.Point.PointBuilder
build() - Method in class com.mindee.input.PageOptions.Builder
build() - Method in class com.mindee.input.URLInputSource.Builder: Build the URLInputSource object.
build() - Method in class com.mindee.v1.clientoptions.PollingOptions.PollingOptionsBuilder
build() - Method in class com.mindee.v1.clientoptions.PredictOptions.PredictOptionsBuilder
build() - Method in class com.mindee.v1.clientoptions.WorkflowOptions.WorkflowOptionsBuilder
build() - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
build() - Method in class com.mindee.v1.http.RequestParameters.RequestParametersBuilder
build() - Method in class com.mindee.v2.clientoptions.PollingOptions.PollingOptionsBuilder
build() - Method in class com.mindee.v2.http.MindeeHttpApiV2.MindeeHttpApiV2Builder
build() - Method in class com.mindee.v2.MindeeSettings.MindeeSettingsBuilder
build() - Method in class com.mindee.v2.product.classification.params.ClassificationParameters.Builder: Build an immutable ClassificationParameters instance.
build() - Method in class com.mindee.v2.product.crop.params.CropParameters.Builder: Build an immutable CropParameters instance.
build() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters.Builder: Build an immutable ExtractionParameters instance.
build() - Method in class com.mindee.v2.product.ocr.params.OcrParameters.Builder: Build an immutable OcrParameters instance.
build() - Method in class com.mindee.v2.product.split.params.SplitParameters.Builder: Build an immutable SplitParameters instance.
builder() - Static method in class com.mindee.geometry.Point
builder() - Static method in class com.mindee.v1.clientoptions.PollingOptions
builder() - Static method in class com.mindee.v1.clientoptions.PredictOptions
builder() - Static method in class com.mindee.v1.clientoptions.WorkflowOptions
builder() - Static method in class com.mindee.v1.http.MindeeHttpApiV1
builder() - Static method in class com.mindee.v1.http.RequestParameters
builder() - Static method in class com.mindee.v2.clientoptions.PollingOptions
builder() - Static method in class com.mindee.v2.http.MindeeHttpApiV2
builder() - Static method in class com.mindee.v2.MindeeSettings
builder(String) - Static method in class com.mindee.input.URLInputSource: Creates a new builder for an URLInputSource.
builder(String) - Static method in class com.mindee.v2.product.classification.params.ClassificationParameters: Create a new builder.
builder(String) - Static method in class com.mindee.v2.product.crop.params.CropParameters: Create a new builder.
builder(String) - Static method in class com.mindee.v2.product.extraction.params.ExtractionParameters: Create a new builder.
builder(String) - Static method in class com.mindee.v2.product.ocr.params.OcrParameters: Create a new builder.
builder(String) - Static method in class com.mindee.v2.product.split.params.SplitParameters: Create a new builder.
builder(URL) - Static method in class com.mindee.input.URLInputSource
Builder() - Constructor for class com.mindee.input.PageOptions.Builder
Builder(String) - Constructor for class com.mindee.input.URLInputSource.Builder: String constructor.
Builder(URL) - Constructor for class com.mindee.input.URLInputSource.Builder: URL constructor.
buildHttpBody(MultipartEntityBuilder) - Method in class com.mindee.v2.clientoptions.BaseParameters
buildHttpBody(MultipartEntityBuilder) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters

C

c1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle owner's full name including maiden name.
c3 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle owner's address.
c41 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Number of owners of the license certificate.
c4A - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Mentions about the ownership of the vehicle.
calculateNewDimensions(BufferedImage, Integer, Integer) - Static method in class com.mindee.image.ImageUtils
call() - Method in class com.mindee.v1.CommandLineInterface.ProductCommandHandler
canEqual(Object) - Method in class com.mindee.v1.parsing.common.ApiRequest
canEqual(Object) - Method in class com.mindee.v1.parsing.common.ApiResponse
canEqual(Object) - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse
canEqual(Object) - Method in class com.mindee.v1.parsing.common.Cropper
canEqual(Object) - Method in class com.mindee.v1.parsing.common.Document
canEqual(Object) - Method in class com.mindee.v1.parsing.common.Execution
canEqual(Object) - Method in class com.mindee.v1.parsing.common.ExecutionFile
canEqual(Object) - Method in class com.mindee.v1.parsing.common.Extras
canEqual(Object) - Method in class com.mindee.v1.parsing.common.FullTextOcr
canEqual(Object) - Method in class com.mindee.v1.parsing.common.InferenceExtras
canEqual(Object) - Method in class com.mindee.v1.parsing.common.Job
canEqual(Object) - Method in class com.mindee.v1.parsing.common.ocr.Word
canEqual(Object) - Method in class com.mindee.v1.parsing.common.Orientation
canEqual(Object) - Method in class com.mindee.v1.parsing.common.PredictResponse
canEqual(Object) - Method in class com.mindee.v1.parsing.common.Rag
canEqual(Object) - Method in class com.mindee.v1.parsing.common.WorkflowResponse
canEqual(Object) - Method in class com.mindee.v1.parsing.standard.BaseField
canEqual(Object) - Method in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document
canEqual(Object) - Method in class com.mindee.v1.product.cropper.CropperV1Document
canEqual(Object) - Method in class com.mindee.v1.product.cropper.CropperV1Page
canEqual(Object) - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document
canEqual(Object) - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document
canEqual(Object) - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document
canEqual(Object) - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document
canEqual(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document
canEqual(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Page
canEqual(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document
canEqual(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Page
canEqual(Object) - Method in class com.mindee.v1.product.generated.GeneratedV1Document
canEqual(Object) - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document
canEqual(Object) - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document
canEqual(Object) - Method in class com.mindee.v1.product.invoice.InvoiceV4Document
canEqual(Object) - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document
canEqual(Object) - Method in class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document
canEqual(Object) - Method in class com.mindee.v1.product.passport.PassportV1Document
canEqual(Object) - Method in class com.mindee.v1.product.receipt.ReceiptV5Document
canEqual(Object) - Method in class com.mindee.v2.clientoptions.BaseParameters
canEqual(Object) - Method in class com.mindee.v2.parsing.BaseInference
canEqual(Object) - Method in class com.mindee.v2.parsing.CommonResponse
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.DataSchemaActiveOptions
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.field.BaseField
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.field.DynamicField
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.field.FieldLocation
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.field.InferenceFields
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.field.ListField
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.field.ObjectField
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.field.SimpleField
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.InferenceFile
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.InferenceJob
canEqual(Object) - Method in class com.mindee.v2.parsing.inference.InferenceModel
canEqual(Object) - Method in class com.mindee.v2.parsing.JobResponse
canEqual(Object) - Method in class com.mindee.v2.parsing.search.ModelWebhook
canEqual(Object) - Method in class com.mindee.v2.parsing.search.PaginationMetadata
canEqual(Object) - Method in class com.mindee.v2.parsing.search.SearchModel
canEqual(Object) - Method in class com.mindee.v2.parsing.search.SearchResponse
canEqual(Object) - Method in class com.mindee.v2.product.crop.CropItem
canEqual(Object) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters
canEqual(Object) - Method in class com.mindee.v2.product.ocr.OcrPage
canEqual(Object) - Method in class com.mindee.v2.product.ocr.OcrWord
canEqual(Object) - Method in class com.mindee.v2.product.split.SplitRange
cardAccessNumber - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The card access number (CAN).
CarteGriseV1 - Class in com.mindee.v1.product.fr.cartegrise: Carte Grise API version 1 inference prediction.
CarteGriseV1() - Constructor for class com.mindee.v1.product.fr.cartegrise.CarteGriseV1
CarteGriseV1Document - Class in com.mindee.v1.product.fr.cartegrise: Carte Grise API version 1.1 document data.
CarteGriseV1Document() - Constructor for class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document
category - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The category or class of the driver license.
category - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The purchase category.
category - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The purchase category.
category - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The purchase category of the receipt.
Certain - com.mindee.v2.parsing.inference.field.FieldConfidence
ClassificationClassifier - Class in com.mindee.v2.product.classification: Classification of the document type from the source file.
ClassificationClassifier() - Constructor for class com.mindee.v2.product.classification.ClassificationClassifier
ClassificationField - Class in com.mindee.v1.parsing.standard: Represents a classifier value.
ClassificationField(String) - Constructor for class com.mindee.v1.parsing.standard.ClassificationField
ClassificationInference - Class in com.mindee.v2.product.classification: The inference result for a classification utility request.
ClassificationInference() - Constructor for class com.mindee.v2.product.classification.ClassificationInference
ClassificationParameters - Class in com.mindee.v2.product.classification.params
ClassificationParameters(String, String, String[]) - Constructor for class com.mindee.v2.product.classification.params.ClassificationParameters
ClassificationParameters.Builder - Class in com.mindee.v2.product.classification.params
ClassificationResponse - Class in com.mindee.v2.product.classification: Response for a classification utility inference.
ClassificationResponse() - Constructor for class com.mindee.v2.product.classification.ClassificationResponse
ClassificationResult - Class in com.mindee.v2.product.classification: Result of the document classifier inference.
ClassificationResult() - Constructor for class com.mindee.v2.product.classification.ClassificationResult
ClassificationResult(ClassificationClassifier) - Constructor for class com.mindee.v2.product.classification.ClassificationResult: Creates a new ClassificationResult instance.
cleanSummary(String) - Static method in class com.mindee.parsing.SummaryHelper
cleanup() - Method in class com.mindee.input.URLInputSource
codes1D - Variable in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document: List of decoded 1D barcodes.
codes2D - Variable in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document: List of decoded 2D barcodes.
com.mindee - package com.mindee
com.mindee.clientoptions - package com.mindee.clientoptions
com.mindee.geometry - package com.mindee.geometry
com.mindee.http - package com.mindee.http
com.mindee.image - package com.mindee.image
com.mindee.input - package com.mindee.input
com.mindee.parsing - package com.mindee.parsing
com.mindee.pdf - package com.mindee.pdf
com.mindee.v1 - package com.mindee.v1
com.mindee.v1.cli - package com.mindee.v1.cli
com.mindee.v1.clientoptions - package com.mindee.v1.clientoptions
com.mindee.v1.fileoperations - package com.mindee.v1.fileoperations
com.mindee.v1.http - package com.mindee.v1.http
com.mindee.v1.parsing - package com.mindee.v1.parsing
com.mindee.v1.parsing.common - package com.mindee.v1.parsing.common
com.mindee.v1.parsing.common.ocr - package com.mindee.v1.parsing.common.ocr
com.mindee.v1.parsing.generated - package com.mindee.v1.parsing.generated
com.mindee.v1.parsing.standard - package com.mindee.v1.parsing.standard
com.mindee.v1.product.barcodereader - package com.mindee.v1.product.barcodereader
com.mindee.v1.product.cropper - package com.mindee.v1.product.cropper
com.mindee.v1.product.driverlicense - package com.mindee.v1.product.driverlicense
com.mindee.v1.product.financialdocument - package com.mindee.v1.product.financialdocument
com.mindee.v1.product.fr.bankaccountdetails - package com.mindee.v1.product.fr.bankaccountdetails
com.mindee.v1.product.fr.cartegrise - package com.mindee.v1.product.fr.cartegrise
com.mindee.v1.product.fr.idcard - package com.mindee.v1.product.fr.idcard
com.mindee.v1.product.generated - package com.mindee.v1.product.generated
com.mindee.v1.product.ind.indianpassport - package com.mindee.v1.product.ind.indianpassport
com.mindee.v1.product.internationalid - package com.mindee.v1.product.internationalid
com.mindee.v1.product.invoice - package com.mindee.v1.product.invoice
com.mindee.v1.product.invoicesplitter - package com.mindee.v1.product.invoicesplitter
com.mindee.v1.product.multireceiptsdetector - package com.mindee.v1.product.multireceiptsdetector
com.mindee.v1.product.passport - package com.mindee.v1.product.passport
com.mindee.v1.product.receipt - package com.mindee.v1.product.receipt
com.mindee.v2 - package com.mindee.v2
com.mindee.v2.clientoptions - package com.mindee.v2.clientoptions
com.mindee.v2.fileoperations - package com.mindee.v2.fileoperations
com.mindee.v2.http - package com.mindee.v2.http
com.mindee.v2.parsing - package com.mindee.v2.parsing
com.mindee.v2.parsing.error - package com.mindee.v2.parsing.error
com.mindee.v2.parsing.inference - package com.mindee.v2.parsing.inference
com.mindee.v2.parsing.inference.field - package com.mindee.v2.parsing.inference.field
com.mindee.v2.parsing.search - package com.mindee.v2.parsing.search
com.mindee.v2.product.classification - package com.mindee.v2.product.classification
com.mindee.v2.product.classification.params - package com.mindee.v2.product.classification.params
com.mindee.v2.product.crop - package com.mindee.v2.product.crop
com.mindee.v2.product.crop.params - package com.mindee.v2.product.crop.params
com.mindee.v2.product.extraction - package com.mindee.v2.product.extraction
com.mindee.v2.product.extraction.params - package com.mindee.v2.product.extraction.params
com.mindee.v2.product.ocr - package com.mindee.v2.product.ocr
com.mindee.v2.product.ocr.params - package com.mindee.v2.product.ocr.params
com.mindee.v2.product.split - package com.mindee.v2.product.split
com.mindee.v2.product.split.params - package com.mindee.v2.product.split.params
combine(Polygon) - Method in class com.mindee.geometry.Polygon: Merge the coordinates of the two polygons.
combine(Polygon, Polygon) - Static method in class com.mindee.geometry.PolygonUtils: Merge the coordinates of the two polygons.
CommandLineInterface - Class in com.mindee.v1: Command Line Interface for the Mindee client.
CommandLineInterface() - Constructor for class com.mindee.v1.CommandLineInterface
CommandLineInterface.ProductCommandHandler - Class in com.mindee.v1: Adds all commands from CommandLineInterfaceProducts automatically.
CommandLineInterfaceProducts - Class in com.mindee.v1.cli: Product-wrapper class for CLI use.
CommandLineInterfaceProducts(ProductProcessor) - Constructor for class com.mindee.v1.cli.CommandLineInterfaceProducts: Default constructor.
CommonResponse - Class in com.mindee.v2.parsing: Common response information from Mindee API V2.
CommonResponse() - Constructor for class com.mindee.v2.parsing.CommonResponse
CompanyRegistrationField - Class in com.mindee.v1.parsing.standard: Represent a company registration.
CompanyRegistrationField(String, String) - Constructor for class com.mindee.v1.parsing.standard.CompanyRegistrationField
compareOnX(Polygon) - Method in class com.mindee.geometry.Polygon: Compare two polygons based on their X coordinates.
compareOnY(Polygon) - Method in class com.mindee.geometry.Polygon: Compare two polygons based on their Y coordinates.
compress() - Method in class com.mindee.input.LocalInputSource
compress(int) - Method in class com.mindee.input.LocalInputSource
compress(int, boolean, boolean) - Method in class com.mindee.input.LocalInputSource
compress(int, Integer, Integer) - Method in class com.mindee.input.LocalInputSource
compress(int, Integer, Integer, Boolean) - Method in class com.mindee.input.LocalInputSource
compress(int, Integer, Integer, Boolean, Boolean) - Method in class com.mindee.input.LocalInputSource
compressImage(byte[]) - Static method in class com.mindee.image.ImageCompressor
compressImage(byte[], Integer) - Static method in class com.mindee.image.ImageCompressor
compressImage(byte[], Integer, Integer) - Static method in class com.mindee.image.ImageCompressor
compressImage(byte[], Integer, Integer, Integer) - Static method in class com.mindee.image.ImageCompressor
compressImage(BufferedImage, Integer, Integer, Integer) - Static method in class com.mindee.image.ImageCompressor
compressPDF(byte[]) - Method in interface com.mindee.pdf.PDFCompression
compressPDF(byte[], int) - Method in interface com.mindee.pdf.PDFCompression
compressPDF(byte[], int, Boolean) - Method in interface com.mindee.pdf.PDFCompression
compressPDF(byte[], int, Boolean, Boolean) - Method in interface com.mindee.pdf.PDFCompression
compressPDF(byte[], int, Boolean, Boolean) - Method in class com.mindee.pdf.PDFCompressor
confidence(Boolean) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters.Builder: Boost the precision and accuracy of all extractions.
country - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: ISO 3166-1 alpha-3 country code (3 letters format).
country - Variable in class com.mindee.v1.product.passport.PassportV1Document: The country's 3 letter code (ISO 3166-1 alpha-3).
countryCode - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The alpha-3 ISO 3166 code of the country where the driver license was issued.
countryOfIssue - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The country where the document was issued.
createConnection(URL) - Method in class com.mindee.input.URLInputSource
Crop - Class in com.mindee.v2.fileoperations
Crop(LocalInputSource) - Constructor for class com.mindee.v2.fileoperations.Crop
CropInference - Class in com.mindee.v2.product.crop: The inference result for a classification utility request.
CropInference() - Constructor for class com.mindee.v2.product.crop.CropInference
CropItem - Class in com.mindee.v2.product.crop: Result of a cropped document region.
CropItem() - Constructor for class com.mindee.v2.product.crop.CropItem
CropItem(String, FieldLocation, ExtractionResponse) - Constructor for class com.mindee.v2.product.crop.CropItem: Creates a new CropItem instance.
CropParameters - Class in com.mindee.v2.product.crop.params
CropParameters(String, String, String[]) - Constructor for class com.mindee.v2.product.crop.params.CropParameters
CropParameters.Builder - Class in com.mindee.v2.product.crop.params
cropper(Boolean) - Method in class com.mindee.v1.clientoptions.PredictOptions.PredictOptionsBuilder
Cropper - Class in com.mindee.v1.parsing.common: Cropping result.
Cropper() - Constructor for class com.mindee.v1.parsing.common.Cropper
CropperV1 - Class in com.mindee.v1.product.cropper: Cropper API version 1 inference prediction.
CropperV1() - Constructor for class com.mindee.v1.product.cropper.CropperV1
CropperV1Document - Class in com.mindee.v1.product.cropper: Cropper API version 1.1 document data.
CropperV1Document() - Constructor for class com.mindee.v1.product.cropper.CropperV1Document
CropperV1Page - Class in com.mindee.v1.product.cropper: Cropper API version 1.1 page data.
CropperV1Page() - Constructor for class com.mindee.v1.product.cropper.CropperV1Page
cropping - Variable in class com.mindee.v1.product.cropper.CropperV1Page: List of documents found in the image.
CropResponse - Class in com.mindee.v2.product.crop: Response for a crop utility inference.
CropResponse() - Constructor for class com.mindee.v2.product.crop.CropResponse
CropResult - Class in com.mindee.v2.product.crop: Result of a crop utility inference.
CropResult() - Constructor for class com.mindee.v2.product.crop.CropResult
CropResult(ArrayList<CropItem>) - Constructor for class com.mindee.v2.product.crop.CropResult: Creates a new CropResult instance.
CustomEndpointInfo - Annotation Type in com.mindee.v1.http: Endpoint settings for custom documents.
customerAddress - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The address of the customer.
customerAddress - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The address of the customer.
customerCompanyRegistrations - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of company registration numbers associated to the customer.
customerCompanyRegistrations - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: List of company registration numbers associated to the customer.
customerId - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The customer account number or identifier from the supplier.
customerId - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The customer account number or identifier from the supplier.
customerName - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The name of the customer.
customerName - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The name of the customer or client.

D

d1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's brand.
d3 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's commercial name.
dataSchema(String) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters.Builder: Provide additional text context used by the model during inference.
DataSchemaActiveOptions - Class in com.mindee.v2.parsing.inference: Data schema options activated during the inference.
DataSchemaActiveOptions() - Constructor for class com.mindee.v2.parsing.inference.DataSchemaActiveOptions
date - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The date the purchase was made.
date - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The date the purchase was made.
date - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The date the purchase was made.
DateField - Class in com.mindee.v1.parsing.standard: Represent a date.
DateField(LocalDate, Double, Polygon, Integer, Boolean) - Constructor for class com.mindee.v1.parsing.standard.DateField
dateOfBirth - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The date of birth of the driver license holder.
ddNumber - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The DD number of the driver license.
Default() - Constructor for class com.mindee.v1.parsing.common.WorkflowResponse.Default
deserialize(JsonParser, DeserializationContext) - Method in class com.mindee.geometry.PolygonDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.mindee.v1.parsing.common.ErrorDetailsDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.mindee.v1.parsing.common.LocalDateTimeDeserializer: Deserialize a LocalDateTime from a JSON string.
deserialize(JsonParser, DeserializationContext) - Method in class com.mindee.v1.parsing.generated.GeneratedV1PredictionDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.mindee.v1.parsing.standard.TaxesDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.mindee.v2.parsing.inference.field.DynamicFieldDeserializer
deserialize(JsonParser, DeserializationContext) - Method in class com.mindee.v2.parsing.inference.field.SimpleFieldDeserializer
deserializeAsyncResponse(Class<T>) - Method in class com.mindee.v1.parsing.LocalResponse: Deserialize this local JSON payload into a specific AsyncPredictResponse.
deserializeResponse(Class<T>) - Method in class com.mindee.v2.parsing.LocalResponse: Deserialize this local JSON payload into a specific CommonResponse subtype: InferenceResponse, JobResponse.
deserializeSyncResponse(Class<T>) - Method in class com.mindee.v1.parsing.LocalResponse: Deserialize this local JSON payload into a specific PredictResponse.
Dimensions(Integer, Integer) - Constructor for class com.mindee.image.ImageUtils.Dimensions
Document<DocT extends Inference> - Class in com.mindee.v1.parsing.common: Define the parsed document.
Document() - Constructor for class com.mindee.v1.parsing.common.Document
documentNumber - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The document number or identifier (invoice number or receipt number).
documentNumber - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The document number.
documentNumber - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The unique identifier assigned to the document.
documentQueueGet(Class<DocT>, Endpoint, String) - Method in class com.mindee.v1.http.MindeeApiV1: Get a document from the predict queue.
documentQueueGet(Class<DocT>, Endpoint, String) - Method in class com.mindee.v1.http.MindeeHttpApiV1: GET job status and document for an enqueued job.
documentSide - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Page: The side of the document which is visible.
documentSide - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Page: The sides of the document which are visible.
documentType - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.
documentType - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Page: The document type or format.
documentType - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The type of personal identification document.
documentType - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: Document type: INVOICE or CREDIT NOTE.
documentType - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
documentType - Variable in class com.mindee.v2.product.split.SplitRange: The document type, as identified on given classification values.
documentTypeExtended - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: Document type extended.
documentTypeExtended - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: Document type extended.
documentUrlFromEndpoint(Function<Endpoint, String>) - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
DriverLicenseV1 - Class in com.mindee.v1.product.driverlicense: Driver License API version 1 inference prediction.
DriverLicenseV1() - Constructor for class com.mindee.v1.product.driverlicense.DriverLicenseV1
DriverLicenseV1Document - Class in com.mindee.v1.product.driverlicense: Driver License API version 1.0 document data.
DriverLicenseV1Document() - Constructor for class com.mindee.v1.product.driverlicense.DriverLicenseV1Document
dueDate - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The date on which the payment is due.
dueDate - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The date on which the payment is due.
DynamicField - Class in com.mindee.v2.parsing.inference.field: Dynamically-typed field (simple / object / list).
DynamicField() - Constructor for class com.mindee.v2.parsing.inference.field.DynamicField
DynamicField(DynamicField.FieldType, SimpleField, ListField, ObjectField) - Constructor for class com.mindee.v2.parsing.inference.field.DynamicField: Creates a new DynamicField instance.
DynamicField.FieldType - Enum in com.mindee.v2.parsing.inference.field: Possible field kinds.
DynamicFieldDeserializer - Class in com.mindee.v2.parsing.inference.field: Custom deserializer for DynamicField.
DynamicFieldDeserializer() - Constructor for class com.mindee.v2.parsing.inference.field.DynamicFieldDeserializer

E

e - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The Vehicle Identification Number (VIN).
encodeToJpegByteArray(BufferedImage, float) - Static method in class com.mindee.image.ImageCompressor
Endpoint - Class in com.mindee.v1.http: Endpoint for custom documents.
Endpoint(Class<DocT>) - Constructor for class com.mindee.v1.http.Endpoint
Endpoint(String, String) - Constructor for class com.mindee.v1.http.Endpoint
Endpoint(String, String, String) - Constructor for class com.mindee.v1.http.Endpoint
EndpointInfo - Annotation Type in com.mindee.v1.http: Base info for all endpoints.
endpointName() - Method in annotation type com.mindee.v1.http.CustomEndpointInfo: The name of the product associated to the expected model.
endpointName() - Method in annotation type com.mindee.v1.http.EndpointInfo
enqueue(LocalInputSource, BaseParameters) - Method in class com.mindee.v2.MindeeClient: Enqueue a document in the asynchronous queue.
enqueue(URLInputSource, BaseParameters) - Method in class com.mindee.v2.MindeeClient: Enqueue a document in the asynchronous queue.
enqueue(Class<T>, LocalInputSource) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue.
enqueue(Class<T>, LocalInputSource, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue.
enqueue(Class<T>, LocalInputSource, PredictOptions, PageOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue.
enqueue(Class<T>, Endpoint, LocalInputSource) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction async API queue.
enqueue(Class<T>, Endpoint, LocalInputSource, PredictOptions, PageOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction async API queue.
enqueue(Class<T>, Endpoint, URL) - Method in class com.mindee.v1.MindeeClient: Send a remote file to a Generated prediction async API queue.
enqueue(Class<T>, Endpoint, URL, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a remote file to a Generated prediction async API queue.
enqueue(Class<T>, URL) - Method in class com.mindee.v1.MindeeClient: Send a remote file to an async queue.
enqueue(Class<T>, URL, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a remote file to an async queue.
enqueueAndGetResult(Class<TResponse>, LocalInputSource, BaseParameters) - Method in class com.mindee.v2.MindeeClient: Send a local file to an async queue, poll, and parse when complete.
enqueueAndGetResult(Class<TResponse>, LocalInputSource, BaseParameters, PollingOptions) - Method in class com.mindee.v2.MindeeClient: Send a local file to an async queue, poll, and parse when complete.
enqueueAndGetResult(Class<TResponse>, URLInputSource, BaseParameters) - Method in class com.mindee.v2.MindeeClient: Send a remote file to an async queue, poll, and parse when complete.
enqueueAndGetResult(Class<TResponse>, URLInputSource, BaseParameters, PollingOptions) - Method in class com.mindee.v2.MindeeClient: Send a remote file to an async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, LocalInputSource) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, LocalInputSource, PollingOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, LocalInputSource, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, LocalInputSource, PredictOptions, PageOptions, PollingOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, LocalInputSource, PredictOptions, PollingOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to an async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, Endpoint, LocalInputSource) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction API async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, Endpoint, LocalInputSource, PollingOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction API async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, Endpoint, LocalInputSource, PredictOptions, PageOptions, PollingOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction API async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, Endpoint, URL) - Method in class com.mindee.v1.MindeeClient: Send a remote file to a Generated prediction API async queue, poll, and parse when complete.
enqueueAndParse(Class<T>, URL) - Method in class com.mindee.v1.MindeeClient: Send a remote file to an async queue, poll, and parse when complete.
equals(Object) - Method in class com.mindee.geometry.Point
equals(Object) - Method in class com.mindee.geometry.Polygon
equals(Object) - Method in class com.mindee.input.PageOptions
equals(Object) - Method in class com.mindee.pdf.SplitPDF
equals(Object) - Method in class com.mindee.v1.clientoptions.PredictOptions
equals(Object) - Method in class com.mindee.v1.clientoptions.WorkflowOptions
equals(Object) - Method in class com.mindee.v1.http.RequestParameters
equals(Object) - Method in class com.mindee.v1.parsing.common.ApiRequest
equals(Object) - Method in class com.mindee.v1.parsing.common.ApiResponse
equals(Object) - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse
equals(Object) - Method in class com.mindee.v1.parsing.common.Cropper
equals(Object) - Method in class com.mindee.v1.parsing.common.Document
equals(Object) - Method in class com.mindee.v1.parsing.common.Execution
equals(Object) - Method in class com.mindee.v1.parsing.common.ExecutionFile
equals(Object) - Method in class com.mindee.v1.parsing.common.Extras
equals(Object) - Method in class com.mindee.v1.parsing.common.FullTextOcr
equals(Object) - Method in class com.mindee.v1.parsing.common.InferenceExtras
equals(Object) - Method in class com.mindee.v1.parsing.common.Job
equals(Object) - Method in class com.mindee.v1.parsing.common.ocr.Word
equals(Object) - Method in class com.mindee.v1.parsing.common.Orientation
equals(Object) - Method in class com.mindee.v1.parsing.common.PredictResponse
equals(Object) - Method in class com.mindee.v1.parsing.common.Rag
equals(Object) - Method in class com.mindee.v1.parsing.common.WorkflowResponse
equals(Object) - Method in class com.mindee.v1.parsing.standard.BaseField
equals(Object) - Method in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document
equals(Object) - Method in class com.mindee.v1.product.cropper.CropperV1Document
equals(Object) - Method in class com.mindee.v1.product.cropper.CropperV1Page
equals(Object) - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document
equals(Object) - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document
equals(Object) - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document
equals(Object) - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document
equals(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document
equals(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Page
equals(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document
equals(Object) - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Page
equals(Object) - Method in class com.mindee.v1.product.generated.GeneratedV1Document
equals(Object) - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document
equals(Object) - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document
equals(Object) - Method in class com.mindee.v1.product.invoice.InvoiceV4Document
equals(Object) - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document
equals(Object) - Method in class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document
equals(Object) - Method in class com.mindee.v1.product.passport.PassportV1Document
equals(Object) - Method in class com.mindee.v1.product.receipt.ReceiptV5Document
equals(Object) - Method in class com.mindee.v2.clientoptions.BaseParameters
equals(Object) - Method in class com.mindee.v2.parsing.BaseInference
equals(Object) - Method in class com.mindee.v2.parsing.CommonResponse
equals(Object) - Method in class com.mindee.v2.parsing.error.ErrorItem
equals(Object) - Method in class com.mindee.v2.parsing.error.ErrorResponse
equals(Object) - Method in class com.mindee.v2.parsing.inference.DataSchemaActiveOptions
equals(Object) - Method in class com.mindee.v2.parsing.inference.field.BaseField
equals(Object) - Method in class com.mindee.v2.parsing.inference.field.DynamicField
equals(Object) - Method in class com.mindee.v2.parsing.inference.field.FieldLocation
equals(Object) - Method in class com.mindee.v2.parsing.inference.field.InferenceFields
equals(Object) - Method in class com.mindee.v2.parsing.inference.field.ListField
equals(Object) - Method in class com.mindee.v2.parsing.inference.field.ObjectField
equals(Object) - Method in class com.mindee.v2.parsing.inference.field.SimpleField
equals(Object) - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions
equals(Object) - Method in class com.mindee.v2.parsing.inference.InferenceFile
equals(Object) - Method in class com.mindee.v2.parsing.inference.InferenceJob
equals(Object) - Method in class com.mindee.v2.parsing.inference.InferenceModel
equals(Object) - Method in class com.mindee.v2.parsing.Job
equals(Object) - Method in class com.mindee.v2.parsing.JobResponse
equals(Object) - Method in class com.mindee.v2.parsing.JobWebhook
equals(Object) - Method in class com.mindee.v2.parsing.search.ModelWebhook
equals(Object) - Method in class com.mindee.v2.parsing.search.PaginationMetadata
equals(Object) - Method in class com.mindee.v2.parsing.search.SearchModel
equals(Object) - Method in class com.mindee.v2.parsing.search.SearchResponse
equals(Object) - Method in class com.mindee.v2.product.classification.ClassificationResult
equals(Object) - Method in class com.mindee.v2.product.crop.CropItem
equals(Object) - Method in class com.mindee.v2.product.crop.CropResult
equals(Object) - Method in class com.mindee.v2.product.extraction.ExtractionResult
equals(Object) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters
equals(Object) - Method in class com.mindee.v2.product.ocr.OcrPage
equals(Object) - Method in class com.mindee.v2.product.ocr.OcrResult
equals(Object) - Method in class com.mindee.v2.product.ocr.OcrWord
equals(Object) - Method in class com.mindee.v2.product.split.SplitRange
equals(Object) - Method in class com.mindee.v2.product.split.SplitResult
Error - Class in com.mindee.v1.parsing.common: Error information from an API response.
Error() - Constructor for class com.mindee.v1.parsing.common.Error
ErrorDetails - Class in com.mindee.v1.parsing.common: Represent error details.
ErrorDetails(String) - Constructor for class com.mindee.v1.parsing.common.ErrorDetails
ErrorDetailsDeserializer - Class in com.mindee.v1.parsing.common: JSON deserializer for the error portion of the return.
ErrorDetailsDeserializer() - Constructor for class com.mindee.v1.parsing.common.ErrorDetailsDeserializer
ErrorDetailsDeserializer(Class<?>) - Constructor for class com.mindee.v1.parsing.common.ErrorDetailsDeserializer
ErrorItem - Class in com.mindee.v2.parsing.error: Error item model.
ErrorItem() - Constructor for class com.mindee.v2.parsing.error.ErrorItem
ErrorItem(String, String) - Constructor for class com.mindee.v2.parsing.error.ErrorItem: Creates a new ErrorItem instance.
ErrorResponse - Class in com.mindee.v2.parsing.error: Error response detailing a problem.
ErrorResponse() - Constructor for class com.mindee.v2.parsing.error.ErrorResponse
ErrorResponse(String, String, int, String, List<ErrorItem>) - Constructor for class com.mindee.v2.parsing.error.ErrorResponse: Creates a new ErrorResponse instance.
executeWorkflow(String, LocalInputSource) - Method in class com.mindee.v1.MindeeClient: Send a local file to a workflow execution.
executeWorkflow(String, LocalInputSource, WorkflowOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a workflow execution.
executeWorkflowPost(Class<DocT>, String, RequestParameters) - Method in class com.mindee.v1.http.MindeeApiV1: Execute a workflow.
executeWorkflowPost(Class<DocT>, String, RequestParameters) - Method in class com.mindee.v1.http.MindeeHttpApiV1: POST a prediction request for a workflow response.
Execution<DocT extends Inference> - Class in com.mindee.v1.parsing.common: Representation of a workflow execution.
Execution() - Constructor for class com.mindee.v1.parsing.common.Execution
Execution(String, LocalDateTime, ExecutionFile, String, DocT, String, LocalDateTime, LocalDateTime, GeneratedV1Document, String, String, LocalDateTime, String) - Constructor for class com.mindee.v1.parsing.common.Execution: Creates a new Execution instance.
ExecutionFile - Class in com.mindee.v1.parsing.common: Representation of a workflow execution's file data.
ExecutionFile() - Constructor for class com.mindee.v1.parsing.common.ExecutionFile
ExecutionFile(String, String) - Constructor for class com.mindee.v1.parsing.common.ExecutionFile: Creates a new ExecutionFile instance.
ExecutionPriority - Enum in com.mindee.v1.parsing.common: Execution priority for a workflow.
expiryDate - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The expiry date of the driver license.
expiryDate - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The expiry date of the identification card.
expiryDate - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The expiry date of the identification card.
expiryDate - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The date when the passport will expire, ISO format: YYYY-MM-DD.
expiryDate - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The date when the document becomes invalid.
expiryDate - Variable in class com.mindee.v1.product.passport.PassportV1Document: The expiry date of the passport.
ExtractedImage - Class in com.mindee.image: An extracted sub-image.
ExtractedImage(BufferedImage, String, String, int) - Constructor for class com.mindee.image.ExtractedImage: Default constructor.
ExtractedImages - Class in com.mindee.image
ExtractedImages() - Constructor for class com.mindee.image.ExtractedImages
ExtractedPDF - Class in com.mindee.pdf: An extracted sub-PDF.
ExtractedPDF(byte[], String) - Constructor for class com.mindee.pdf.ExtractedPDF: Default constructor.
ExtractedPDFs - Class in com.mindee.pdf
ExtractedPDFs() - Constructor for class com.mindee.pdf.ExtractedPDFs
extractImage(FieldT, int, int) - Method in class com.mindee.image.ImageExtractor: Extract a single image from a field having position data.
extractImage(FieldT, int, int, String) - Method in class com.mindee.image.ImageExtractor: Extract a single image from a field having position data.
extractImagesFromPage(List<FieldT>, int) - Method in class com.mindee.image.ImageExtractor: Extract multiple images on a given page from a list of fields having position data.
extractImagesFromPage(List<FieldT>, int, String) - Method in class com.mindee.image.ImageExtractor: Extract multiple images on a given page from a list of fields having position data.
extractInvoices(List<InvoiceSplitterV1InvoicePageGroup>) - Method in class com.mindee.v1.fileoperations.PDFExtractor: Extract invoices from the given page indexes (from an invoice-splitter prediction).
extractInvoices(List<InvoiceSplitterV1InvoicePageGroup>, boolean) - Method in class com.mindee.v1.fileoperations.PDFExtractor: Extract invoices from the given page indexes (from an invoice-splitter prediction).
ExtractionInference - Class in com.mindee.v2.product.extraction: Inference object for the V2 API.
ExtractionInference() - Constructor for class com.mindee.v2.product.extraction.ExtractionInference
ExtractionInference(InferenceActiveOptions) - Constructor for class com.mindee.v2.product.extraction.ExtractionInference: Creates a new ExtractionInference instance.
ExtractionParameters - Class in com.mindee.v2.product.extraction.params: Options to pass when calling methods using the API V2.
ExtractionParameters.Builder - Class in com.mindee.v2.product.extraction.params: Fluent builder for ExtractionParameters.
ExtractionResponse - Class in com.mindee.v2.product.extraction: Response for an extraction inference.
ExtractionResponse() - Constructor for class com.mindee.v2.product.extraction.ExtractionResponse
ExtractionResult - Class in com.mindee.v2.product.extraction: The inference result for an extraction request.
ExtractionResult() - Constructor for class com.mindee.v2.product.extraction.ExtractionResult
ExtractionResult(InferenceFields, RawText, RagMetadata) - Constructor for class com.mindee.v2.product.extraction.ExtractionResult: Creates a new ExtractionResult instance.
extractMultiple(ArrayList<SplitRange>) - Method in class com.mindee.v2.fileoperations.Split
extractMultiple(List<CropItem>) - Method in class com.mindee.v2.fileoperations.Crop
extractSingle(CropItem) - Method in class com.mindee.v2.fileoperations.Crop
extractSingle(SplitRange) - Method in class com.mindee.v2.fileoperations.Split
extractSinglePage(List<Integer>, boolean) - Method in class com.mindee.pdf.BasePDFExtractor
extractSubDocuments(List<List<Integer>>) - Method in class com.mindee.pdf.BasePDFExtractor: Given a list of page indexes, extracts the corresponding documents.
Extras - Class in com.mindee.v1.parsing.common: Optional information.
Extras() - Constructor for class com.mindee.v1.parsing.common.Extras

F

f1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum admissible weight.
f2 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum admissible weight within the license's state.
f3 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum authorized weight with coupling.
fetchFile() - Method in class com.mindee.input.URLInputSource: Fetches the file from a remote source.
FieldConfidence - Enum in com.mindee.v2.parsing.inference.field: Confidence level of a field as returned by the V2 API.
FieldLocation - Class in com.mindee.v2.parsing.inference.field: Location data for a field.
FieldLocation() - Constructor for class com.mindee.v2.parsing.inference.field.FieldLocation
FieldLocation(Polygon, int) - Constructor for class com.mindee.v2.parsing.inference.field.FieldLocation: Creates a new FieldLocation instance.
file - Variable in class com.mindee.parsing.BaseLocalResponse
file - Variable in class com.mindee.v2.parsing.BaseInference: File info.
file(byte[]) - Method in class com.mindee.v1.http.RequestParameters.RequestParametersBuilder
filename - Variable in class com.mindee.pdf.BasePDFExtractor
fileName(String) - Method in class com.mindee.v1.http.RequestParameters.RequestParametersBuilder
fileNumber - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The file number of the passport document.
FinancialDocumentV1 - Class in com.mindee.v1.product.financialdocument: Financial Document API version 1 inference prediction.
FinancialDocumentV1() - Constructor for class com.mindee.v1.product.financialdocument.FinancialDocumentV1
FinancialDocumentV1Document - Class in com.mindee.v1.product.financialdocument: Financial Document API version 1.14 document data.
FinancialDocumentV1Document() - Constructor for class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document
FinancialDocumentV1LineItem - Class in com.mindee.v1.product.financialdocument: List of line item present on the document.
FinancialDocumentV1LineItem() - Constructor for class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem
firstName - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The first name of the driver license holder.
formatAmount(Double) - Static method in class com.mindee.parsing.SummaryHelper
formatForDisplay(Boolean, Integer) - Static method in class com.mindee.parsing.SummaryHelper: Truncates a boolean string if it's too long for the requested width.
formatForDisplay(String, Integer) - Static method in class com.mindee.parsing.SummaryHelper: Truncates a string if it's too long for the requested width.
formatString(String) - Static method in class com.mindee.parsing.SummaryHelper
formulaNumber - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The document's formula number.
fromJson(String) - Static method in enum com.mindee.v2.parsing.inference.field.FieldConfidence
fullText(Boolean) - Method in class com.mindee.v1.clientoptions.PredictOptions.PredictOptionsBuilder
fullText(Boolean) - Method in class com.mindee.v1.clientoptions.WorkflowOptions.WorkflowOptionsBuilder
FullTextOcr - Class in com.mindee.v1.parsing.common: Full Text OCR result.
FullTextOcr() - Constructor for class com.mindee.v1.parsing.common.FullTextOcr

G

g - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's weight with coupling if tractor different than category M1.
g1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's national empty weight.
gender - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The gender of the card holder.
gender - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The gender of the card holder.
gender - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The gender of the passport holder.
gender - Variable in class com.mindee.v1.product.passport.PassportV1Document: The gender of the passport holder.
generate(Polygon) - Static method in class com.mindee.geometry.BboxUtils: Generate a BBox from a single Polygon.
generate(List<Polygon>) - Static method in class com.mindee.geometry.BboxUtils: Generate a BBox from a list of Polygons.
GeneratedFeature - Class in com.mindee.v1.parsing.generated: A generic feature which can represent any OTS Mindee return prediction.
GeneratedFeature(boolean) - Constructor for class com.mindee.v1.parsing.generated.GeneratedFeature: Whether the original feature is a list.
GeneratedObject - Class in com.mindee.v1.parsing.generated: An object within a feature.
GeneratedObject() - Constructor for class com.mindee.v1.parsing.generated.GeneratedObject
GeneratedV1 - Class in com.mindee.v1.product.generated: Define a simple model to encapsulate data from any API.
GeneratedV1() - Constructor for class com.mindee.v1.product.generated.GeneratedV1
GeneratedV1Document - Class in com.mindee.v1.product.generated: Document data for generated documents.
GeneratedV1Document(Map<String, GeneratedFeature>) - Constructor for class com.mindee.v1.product.generated.GeneratedV1Document: Creates a new GeneratedV1Document instance.
GeneratedV1PredictionDeserializer - Class in com.mindee.v1.parsing.generated: JSON deserializer for generated documents v1.x.
GeneratedV1PredictionDeserializer() - Constructor for class com.mindee.v1.parsing.generated.GeneratedV1PredictionDeserializer
GeneratedV1PredictionDeserializer(Class<?>) - Constructor for class com.mindee.v1.parsing.generated.GeneratedV1PredictionDeserializer
getA() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's license plate number.
getAccountHoldersNames() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of the account holders names.
getAccountName() - Method in class com.mindee.v1.http.Endpoint: The name of the account that owns the API.
getAccountNumber() - Method in class com.mindee.v1.parsing.standard.PaymentDetailsField: The account number.
getActiveOptions() - Method in class com.mindee.v2.product.extraction.ExtractionInference: Active options for the inference.
getAddress() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The physical address of the document holder.
getAddress1() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The first line of the address of the passport holder.
getAddress2() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The second line of the address of the passport holder.
getAddress3() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The third line of the address of the passport holder.
getAddressComplement() - Method in class com.mindee.v1.parsing.standard.AddressField: Additional address complement.
getAlias() - Method in class com.mindee.v1.clientoptions.WorkflowOptions: Alias to give to the file.
getAlias() - Method in class com.mindee.v1.parsing.common.ExecutionFile: Optional alias for the file.
getAlias() - Method in class com.mindee.v2.clientoptions.BaseParameters: Optional alias for the file.
getAlias() - Method in class com.mindee.v2.parsing.inference.InferenceFile: Optional file alias.
getAllLines() - Method in class com.mindee.v1.parsing.common.ocr.OcrPage: All the words on the page, ordered in lines.
getAllWords() - Method in class com.mindee.v1.clientoptions.PredictOptions: Whether to include the full text for each page.
getAllWords() - Method in class com.mindee.v1.parsing.common.ocr.OcrPage: All the words on the page, in semi-random order.
getAlternateName() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The alternate name of the card holder.
getApiKey() - Method in class com.mindee.v1.MindeeSettings
getApiKey() - Method in class com.mindee.v2.MindeeSettings
getApiRequest() - Method in class com.mindee.v1.parsing.common.ApiResponse: Information from Mindee about the api request.
getAsBbox() - Method in class com.mindee.geometry.Polygon: Get the polygon as a Bbox.
getAsPolygon() - Method in class com.mindee.geometry.Bbox: Get the Bbox as a Polygon.
getAsPolygon(String) - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Get the specified key as a Polygon object.
getAuthority() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The name of the issuing authority.
getAuthority() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The name of the issuing authority.
getAvailableAt() - Method in class com.mindee.v1.parsing.common.Execution: The time at which the file was uploaded to a workflow.
getAvailableAt() - Method in class com.mindee.v1.parsing.common.Job: The time at which the job finished.
getB() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's first release date.
getBase() - Method in class com.mindee.v1.parsing.standard.TaxField: The tax base.
getBaseUrl() - Method in class com.mindee.v1.MindeeSettings
getBaseUrl() - Method in class com.mindee.v2.MindeeSettings
getBatchName() - Method in class com.mindee.v1.parsing.common.Execution: Identifier for the batch to which the execution belongs.
getBban() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of BBAN, including: branch code, bank code, account and key.
getBbanBankCode() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban: The BBAN bank code outputted as a string.
getBbanBranchCode() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban: The BBAN branch code outputted as a string.
getBbanKey() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban: The BBAN key outputted as a string.
getBbanNumber() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban: The BBAN Account number outputted as a string.
getBigDecimalValue() - Method in class com.mindee.v2.parsing.inference.field.SimpleField: Retrieves the value of the field as a BigDecimal.
getBillingAddress() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The customer's address used for billing.
getBillingAddress() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The customer billing address.
getBirthDate() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The date of birth of the card holder.
getBirthDate() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The date of birth of the card holder.
getBirthDate() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The birth date of the passport holder, ISO format: YYYY-MM-DD.
getBirthDate() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The date of birth of the document holder.
getBirthDate() - Method in class com.mindee.v1.product.passport.PassportV1Document: The date of birth of the passport holder.
getBirthPlace() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The place of birth of the card holder.
getBirthPlace() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The place of birth of the card holder.
getBirthPlace() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The birth place of the passport holder.
getBirthPlace() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The place of birth of the document holder.
getBirthPlace() - Method in class com.mindee.v1.product.passport.PassportV1Document: The place of birth of the passport holder.
getBooleanValue() - Method in class com.mindee.v2.parsing.inference.field.SimpleField: Retrieves the value of the field as a Boolean.
getBoundingBox() - Method in class com.mindee.geometry.Polygon: Get a bounding box that encloses the Polygon.
getBoundingBox() - Method in class com.mindee.v1.parsing.standard.BaseField: The bounding box equivalent of the polygon.
getBoundingBox() - Method in class com.mindee.v1.parsing.standard.PositionField: Straight rectangle.
getC1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle owner's full name including maiden name.
getC3() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle owner's address.
getC41() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Number of owners of the license certificate.
getC4A() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Mentions about the ownership of the vehicle.
getCardAccessNumber() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The card access number (CAN).
getCategory() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The category or class of the driver license.
getCategory() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The purchase category.
getCategory() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The purchase category.
getCategory() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The purchase category of the receipt.
getCentroid() - Method in class com.mindee.geometry.Polygon: Get the central coordinates (centroid) of the Polygon.
getCentroid(List<Point>) - Static method in class com.mindee.geometry.PolygonUtils: Get the central coordinates (centroid) of a list of Points.
getCity() - Method in class com.mindee.v1.parsing.standard.AddressField: City or locality.
getClassification() - Method in class com.mindee.v2.product.classification.ClassificationResult: Classification of the document type from the source file.
getCode() - Method in exception com.mindee.v1.http.MindeeHttpExceptionV1: Error code (not HTTP code).
getCode() - Method in class com.mindee.v1.parsing.common.Error: A code to identify it.
getCode() - Method in class com.mindee.v1.parsing.standard.TaxField: The tax code.
getCode() - Method in class com.mindee.v2.parsing.error.ErrorResponse: A machine-readable code specific to the occurrence of the problem.
getCodes1D() - Method in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document: List of decoded 1D barcodes.
getCodes2D() - Method in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document: List of decoded 2D barcodes.
getCompletedAt() - Method in class com.mindee.v2.parsing.Job: Date and time of the Job completion.
getConfidence() - Method in class com.mindee.v1.parsing.common.ocr.Word: The confidence about the zone of the value extracted.
getConfidence() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Get the confidence score, if present.
getConfidence() - Method in class com.mindee.v1.parsing.standard.BaseField: The confidence about the zone of the value extracted.
getConfidence() - Method in class com.mindee.v2.parsing.inference.field.BaseField: Confidence associated with the field.
getConfidence() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions: Whether the confidence feature was activated.
getConfidence() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters: Boost the precision and accuracy of all extractions.
getContent() - Method in class com.mindee.v1.parsing.common.FullTextOcr: List of positions within the image.
getContent() - Method in class com.mindee.v2.parsing.inference.RawTextPage: Page content as a single string.
getContent() - Method in class com.mindee.v2.product.ocr.OcrPage: Full text content extracted from the document page.
getContent() - Method in class com.mindee.v2.product.ocr.OcrWord: Text content of the word.
getCoordinates() - Method in class com.mindee.geometry.Polygon: Position information as a list of points in clockwise order.
getCountry() - Method in class com.mindee.v1.parsing.standard.AddressField: Country.
getCountry() - Method in class com.mindee.v1.parsing.standard.LocaleField: The country which has been detected.
getCountry() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: ISO 3166-1 alpha-3 country code (3 letters format).
getCountry() - Method in class com.mindee.v1.product.passport.PassportV1Document: The country's 3 letter code (ISO 3166-1 alpha-3).
getCountryCode() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The alpha-3 ISO 3166 code of the country where the driver license was issued.
getCountryOfIssue() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The country where the document was issued.
getCreatedAt() - Method in class com.mindee.v1.parsing.common.Execution: The time at which the execution started.
getCreatedAt() - Method in class com.mindee.v2.parsing.Job: Date and time of the Job creation.
getCreatedAt() - Method in class com.mindee.v2.parsing.JobWebhook: Date and time the webhook was created at.
getCropper() - Method in class com.mindee.v1.clientoptions.PredictOptions: Whether to include cropper results for each page.
getCropper() - Method in class com.mindee.v1.parsing.common.Extras: Cropping result.
getCropping() - Method in class com.mindee.v1.parsing.common.Cropper: List of positions within the image.
getCropping() - Method in class com.mindee.v1.product.cropper.CropperV1Page: List of documents found in the image.
getCrops() - Method in class com.mindee.v2.product.crop.CropResult: List of objects and their cropping coordinates identified in the source document.
getCurrency() - Method in class com.mindee.v1.parsing.standard.LocaleField: The currency which has been detected.
getCustomerAddress() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The address of the customer.
getCustomerAddress() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The address of the customer.
getCustomerCompanyRegistrations() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of company registration numbers associated to the customer.
getCustomerCompanyRegistrations() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: List of company registration numbers associated to the customer.
getCustomerId() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The customer account number or identifier from the supplier.
getCustomerId() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The customer account number or identifier from the supplier.
getCustomerName() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The name of the customer.
getCustomerName() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The name of the customer or client.
getD1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's brand.
getD3() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's commercial name.
getDataSchema() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions: Data schema options provided for the inference.
getDataSchema() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters: Dynamic changes to the data schema of the model for this inference.
getDate() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The date the purchase was made.
getDate() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The date the purchase was made.
getDate() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The date the purchase was made.
getDateOfBirth() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The date of birth of the driver license holder.
getDdNumber() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The DD number of the driver license.
getDefaultPageOptions() - Method in class com.mindee.v1.CommandLineInterface
getDescription() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The item description.
getDescription() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The item description.
getDescription() - Method in class com.mindee.v1.product.receipt.ReceiptV5LineItem: The item description.
getDetail() - Method in exception com.mindee.v2.http.MindeeHttpExceptionV2: Error details.
getDetail() - Method in class com.mindee.v2.parsing.error.ErrorItem: Explicit information on the issue.
getDetail() - Method in class com.mindee.v2.parsing.error.ErrorResponse: A human-readable explanation specific to the occurrence of the problem.
getDetails() - Method in exception com.mindee.v1.http.MindeeHttpExceptionV1: Error details.
getDetails() - Method in class com.mindee.v1.parsing.common.Error: Details about it.
getDocument() - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse: Get the document optional.
getDocument() - Method in class com.mindee.v1.parsing.common.PredictResponse: Set the prediction model used to parse the document.
getDocumentNumber() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The document number or identifier (invoice number or receipt number).
getDocumentNumber() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The document number.
getDocumentNumber() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The unique identifier assigned to the document.
getDocumentObj() - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse: Get the document object if it is present.
getDocumentSide() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Page: The side of the document which is visible.
getDocumentSide() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Page: The sides of the document which are visible.
getDocumentType() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The type of the document: INVOICE or CREDIT NOTE if it is an invoice, CREDIT CARD RECEIPT or EXPENSE RECEIPT if it is a receipt.
getDocumentType() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Page: The document type or format.
getDocumentType() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The type of personal identification document.
getDocumentType() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: Document type: INVOICE or CREDIT NOTE.
getDocumentType() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The type of receipt: EXPENSE RECEIPT or CREDIT CARD RECEIPT.
getDocumentType() - Method in class com.mindee.v2.product.classification.ClassificationClassifier: The document type, as identified on given classification values.
getDocumentType() - Method in class com.mindee.v2.product.split.SplitRange: The document type, as identified on given classification values.
getDocumentTypeExtended() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: Document type extended.
getDocumentTypeExtended() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: Document type extended.
getDoubleValue() - Method in class com.mindee.v2.parsing.inference.field.SimpleField: Retrieves the value of the field as a Double.
getDueDate() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The date on which the payment is due.
getDueDate() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The date on which the payment is due.
getE() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The Vehicle Identification Number (VIN).
getEndpointName() - Method in class com.mindee.v1.http.Endpoint: The name of the product associated to the expected model.
getError() - Method in class com.mindee.v1.parsing.common.ApiRequest: Information about an error that occurred during the API request.
getError() - Method in class com.mindee.v1.parsing.common.Job: Information about an error that occurred during the job processing.
getError() - Method in class com.mindee.v2.parsing.Job: Status of the job.
getError() - Method in class com.mindee.v2.parsing.JobWebhook: An error encountered while processing the webhook.
getErrors() - Method in class com.mindee.v2.parsing.error.ErrorResponse: The HTTP status code returned by the server.
getExecution() - Method in class com.mindee.v1.parsing.common.WorkflowResponse: Set the prediction model used to parse the document.
getExpiryDate() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The expiry date of the driver license.
getExpiryDate() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The expiry date of the identification card.
getExpiryDate() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The expiry date of the identification card.
getExpiryDate() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The date when the passport will expire, ISO format: YYYY-MM-DD.
getExpiryDate() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The date when the document becomes invalid.
getExpiryDate() - Method in class com.mindee.v1.product.passport.PassportV1Document: The expiry date of the passport.
getExtractionResponse() - Method in class com.mindee.v2.product.classification.ClassificationClassifier: The extraction response associated with the classification.
getExtractionResponse() - Method in class com.mindee.v2.product.crop.CropItem: The extraction response associated with the crop.
getExtractionResponse() - Method in class com.mindee.v2.product.split.SplitRange: The extraction response associated with the split.
getExtras() - Method in class com.mindee.v1.parsing.common.Inference
getExtras() - Method in class com.mindee.v1.parsing.common.Page: Optional information.
getF1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum admissible weight.
getF2() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum admissible weight within the license's state.
getF3() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum authorized weight with coupling.
getField(Class<T>) - Method in class com.mindee.v2.parsing.inference.field.DynamicField: Returns the field as the specified class.
getFields() - Method in class com.mindee.v1.product.generated.GeneratedV1Document: Hashmap containing the fields of the document.
getFields() - Method in class com.mindee.v2.parsing.inference.field.ObjectField: Sub-fields keyed by their name.
getFields() - Method in class com.mindee.v2.product.extraction.ExtractionResult: Extracted fields, the key corresponds to the field's name in the data schema.
getFile() - Method in class com.mindee.input.LocalInputSource
getFile() - Method in class com.mindee.parsing.BaseLocalResponse
getFile() - Method in class com.mindee.pdf.SplitPDF: The file.
getFile() - Method in class com.mindee.v1.http.RequestParameters
getFile() - Method in class com.mindee.v1.parsing.common.Execution: File representation within a workflow execution.
getFile() - Method in class com.mindee.v2.parsing.BaseInference: File info.
getFileAlias() - Method in class com.mindee.v2.parsing.Job: Optional alias of the file.
getFileBytes() - Method in class com.mindee.pdf.ExtractedPDF
getFileExtension(String) - Static method in class com.mindee.input.InputSourceUtils: Returns the file's extension.
getFilename() - Method in class com.mindee.image.ExtractedImage
getFilename() - Method in class com.mindee.image.PDFPageImage: Generate a filename for the image.
getFilename() - Method in class com.mindee.input.LocalInputSource
getFilename() - Method in class com.mindee.pdf.ExtractedPDF
getFilename() - Method in class com.mindee.v1.parsing.common.Document: The original file name of the parsed document.
getFileName() - Method in class com.mindee.v1.http.RequestParameters
getFileName() - Method in class com.mindee.v2.parsing.Job: Name of the file.
getFileNumber() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The file number of the passport document.
getFileUrl() - Method in class com.mindee.v1.http.RequestParameters
getFirstName() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The first name of the driver license holder.
getFormulaNumber() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The document's formula number.
getFullText() - Method in class com.mindee.v1.clientoptions.PredictOptions: Whether to include the full text data for async APIs.
getFullText() - Method in class com.mindee.v1.clientoptions.WorkflowOptions: Whether to include the full text data for async APIs.
getFullTextOcr() - Method in class com.mindee.v1.parsing.common.Extras: Full Text OCR result.
getFullTextOcr() - Method in class com.mindee.v1.parsing.common.InferenceExtras: Full Text OCR result.
getG() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's weight with coupling if tractor different than category M1.
getG1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's national empty weight.
getGender() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The gender of the card holder.
getGender() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The gender of the card holder.
getGender() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The gender of the passport holder.
getGender() - Method in class com.mindee.v1.product.passport.PassportV1Document: The gender of the passport holder.
getGivenNames() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The given name(s) of the card holder.
getGivenNames() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The given name(s) of the card holder.
getGivenNames() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The given names of the passport holder.
getGivenNames() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The list of the document holder's given names.
getGivenNames() - Method in class com.mindee.v1.product.passport.PassportV1Document: The given name(s) of the passport holder.
getHmacSignature(String) - Method in class com.mindee.parsing.BaseLocalResponse: Get the HMAC signature of the payload.
getI() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The car registration date of the given certificate.
getIban() - Method in class com.mindee.v1.parsing.standard.PaymentDetailsField: The full IBAN.
getIban() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of the IBAN number.
getId() - Method in class com.mindee.v1.parsing.common.Document: Document identifier, generated on each API call.
getId() - Method in class com.mindee.v1.parsing.common.Execution: Identifier for the execution.
getId() - Method in class com.mindee.v1.parsing.common.Job: Identifier for the job.
getId() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The unique identifier of the driver license.
getId() - Method in class com.mindee.v2.parsing.BaseInference: Inference ID.
getId() - Method in class com.mindee.v2.parsing.inference.InferenceJob: UUID of the Job.
getId() - Method in class com.mindee.v2.parsing.inference.InferenceModel: The ID of the model.
getId() - Method in class com.mindee.v2.parsing.Job: ID of the job.
getId() - Method in class com.mindee.v2.parsing.JobWebhook: ID of the webhook.
getId() - Method in class com.mindee.v2.parsing.search.ModelWebhook: ID of the webhook.
getId() - Method in class com.mindee.v2.parsing.search.SearchModel: ID of the model.
getIdNumber() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The identification card number.
getIdNumber() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The identification number of the passport document.
getIdNumber() - Method in class com.mindee.v1.product.passport.PassportV1Document: The passport's identification number.
getImage() - Method in class com.mindee.image.ExtractedImage
getImage() - Method in class com.mindee.image.PDFPageImage
getInference() - Method in class com.mindee.v1.parsing.common.Document: Define the inference model of values.
getInference() - Method in class com.mindee.v1.parsing.common.Execution: Deserialized inference object.
getInference() - Method in class com.mindee.v2.product.classification.ClassificationResponse: The inference result for a classification utility request.
getInference() - Method in class com.mindee.v2.product.crop.CropResponse: The inference result for a crop utility request.
getInference() - Method in class com.mindee.v2.product.extraction.ExtractionResponse: Inference result.
getInference() - Method in class com.mindee.v2.product.ocr.OcrResponse: The inference result for an OCR utility request.
getInference() - Method in class com.mindee.v2.product.split.SplitResponse: The inference result for a split utility request.
getInitialDelaySec() - Method in class com.mindee.clientoptions.BasePollingOptions: Wait this many seconds before the first polling attempt.
getIntervalSec() - Method in class com.mindee.clientoptions.BasePollingOptions: Wait this many seconds between each polling attempt.
getInvoiceNumber() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The invoice number or identifier only if document is an invoice.
getInvoiceNumber() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The invoice number or identifier.
getInvoicePageGroups() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document: List of page groups.
getIsComputed() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Get the information on whether the date field was extracted.
getIsComputed() - Method in class com.mindee.v1.parsing.standard.DateField: Whether the field was computed or retrieved directly from the document.
getIssuanceDate() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The date when the passport was issued, ISO format: YYYY-MM-DD.
getIssuanceDate() - Method in class com.mindee.v1.product.passport.PassportV1Document: The date the passport was issued.
getIssuancePlace() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The place where the passport was issued.
getIssuedAt() - Method in class com.mindee.v1.parsing.common.Job: The time at which the job started.
getIssueDate() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The date of issue of the identification card.
getIssueDate() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The date when the document was issued.
getIssuedDate() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The date when the driver license was issued.
getIssuingAuthority() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The authority that issued the driver license.
getItems() - Method in class com.mindee.v2.parsing.inference.field.ListField: Items of the list.
getJ() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's category.
getJ1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's national type.
getJ2() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's body type (CE).
getJ3() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's body type (National designation).
getJob() - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse: Details for the submitted job.
getJob() - Method in class com.mindee.v2.parsing.BaseInference: Job the inference belongs to.
getJob() - Method in class com.mindee.v2.parsing.JobResponse: Representation of the Job.
getJob(String) - Method in class com.mindee.v2.MindeeClient: Get the status of an inference that was previously enqueued.
getLanguage() - Method in class com.mindee.v1.parsing.common.FullTextOcr: Language used in the text.
getLanguage() - Method in class com.mindee.v1.parsing.standard.LocaleField: The language which has been detected.
getLastName() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The last name of the driver license holder.
getLegalGuardian() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The name of the legal guardian of the passport holder (if applicable).
getLineItems() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of line item present on the document.
getLineItems() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: List of all the line items present on the invoice.
getLineItems() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: List of all line items on the receipt.
getListField() - Method in class com.mindee.v2.parsing.inference.field.DynamicField
getListField(String) - Method in class com.mindee.v2.parsing.inference.field.InferenceFields: Retrieves the field as a `ListField`.
getListField(String) - Method in class com.mindee.v2.parsing.inference.field.ObjectField: Retrieves a list sub-field from the fields map as a ListField.
getListFields() - Method in class com.mindee.v2.parsing.inference.field.ObjectField: Retrieves all subfields from the fields map as a LinkedHashMap of ListField objects, keyed by their field names.
getLocale() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The locale of the document.
getLocale() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The locale of the document.
getLocale() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The locale of the document.
getLocalFilename() - Method in class com.mindee.input.URLInputSource
getLocation() - Method in class com.mindee.v2.product.crop.CropItem: Location which includes cropping coordinates for the detected object, within the source document.
getLocations() - Method in class com.mindee.v2.parsing.inference.field.BaseField: Field's location.
getMatchingDocumentId() - Method in class com.mindee.v1.parsing.common.Rag: The document ID that was matched.
getMax() - Method in class com.mindee.geometry.MinMax
getMaxRetries() - Method in class com.mindee.clientoptions.BasePollingOptions: Maximum number of times to poll.
getMaxX() - Method in class com.mindee.geometry.Bbox
getMaxY() - Method in class com.mindee.geometry.Bbox
getMessage() - Method in class com.mindee.v1.parsing.common.Error: More precise information about the current error.
getMimeType() - Method in class com.mindee.v2.parsing.inference.InferenceFile: Mime type, as read by the server.
getMin() - Method in class com.mindee.geometry.MinMax
getMinMaxX() - Method in class com.mindee.geometry.Polygon: Get the maximum and minimum Y coordinates.
getMinMaxX(List<Point>) - Static method in class com.mindee.geometry.PolygonUtils: Get the maximum and minimum X coordinates in a given list of Points.
getMinMaxY() - Method in class com.mindee.geometry.Polygon: Get the maximum and minimum Y coordinates.
getMinMaxY(List<Point>) - Static method in class com.mindee.geometry.PolygonUtils: Get the maximum and minimum Y coordinates in a given list of Points.
getMinX() - Method in class com.mindee.geometry.Bbox
getMinY() - Method in class com.mindee.geometry.Bbox
getModel() - Method in class com.mindee.v2.parsing.BaseInference: Model info.
getModelId() - Method in class com.mindee.v2.clientoptions.BaseParameters: Model ID to use for the inference (required).
getModelId() - Method in class com.mindee.v2.parsing.Job: ID of the model.
getModels() - Method in class com.mindee.v2.parsing.search.SearchResponse
getModelType() - Method in class com.mindee.v2.parsing.search.SearchModel: Type of the model.
getMrz() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The Machine Readable Zone (MRZ) of the driver license.
getMrz1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Machine Readable Zone, first line.
getMrz1() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: Machine Readable Zone, first line.
getMrz1() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The Machine Readable Zone, first line.
getMrz1() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The first line of the machine-readable zone (MRZ) of the passport document.
getMrz1() - Method in class com.mindee.v1.product.passport.PassportV1Document: Machine Readable Zone, first line.
getMrz2() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Machine Readable Zone, second line.
getMrz2() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: Machine Readable Zone, second line.
getMrz2() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The Machine Readable Zone, second line.
getMrz2() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The second line of the machine-readable zone (MRZ) of the passport document.
getMrz2() - Method in class com.mindee.v1.product.passport.PassportV1Document: Machine Readable Zone, second line.
getMrz3() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The Machine Readable Zone, third line.
getMrzLine1() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The Machine Readable Zone, first line.
getMrzLine2() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The Machine Readable Zone, second line.
getMrzLine3() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The Machine Readable Zone, third line.
getMVisionV1() - Method in class com.mindee.v1.parsing.common.ocr.Ocr
getName() - Method in class com.mindee.v1.parsing.common.ExecutionFile: File name.
getName() - Method in class com.mindee.v1.parsing.common.Product: Name of the product used.
getName() - Method in class com.mindee.v2.parsing.inference.InferenceFile: File name.
getName() - Method in class com.mindee.v2.parsing.search.ModelWebhook: Name of the webhook.
getName() - Method in class com.mindee.v2.parsing.search.SearchModel: Name of the model.
getNameOfMother() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The name of the mother of the passport holder.
getNameOfSpouse() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The name of the spouse of the passport holder (if applicable).
getNationality() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The nationality of the card holder.
getNationality() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The country of citizenship of the document holder.
getNPages() - Method in class com.mindee.v1.parsing.common.Document: Number of pages in the document.
getObjectField() - Method in class com.mindee.v2.parsing.inference.field.DynamicField
getObjectField(String) - Method in class com.mindee.v2.parsing.inference.field.InferenceFields: Retrieves the field as an `ObjectField`.
getObjectField(String) - Method in class com.mindee.v2.parsing.inference.field.ObjectField: Retrieves an object sub-field from the fields map as a ObjectField.
getObjectFields() - Method in class com.mindee.v2.parsing.inference.field.ObjectField: Retrieves all subfields from the fields map as a LinkedHashMap of ObjectField objects, keyed by their field names.
getObjectItems() - Method in class com.mindee.v2.parsing.inference.field.ListField: Retrieves the items as ObjectField objects.
getObjectType() - Method in class com.mindee.v2.product.crop.CropItem: Type or classification of the detected object.
getOcr() - Method in class com.mindee.v1.parsing.common.Document: Ocr result information.
getOldPassportDateOfIssue() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
getOldPassportNumber() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The number of the old passport (if applicable).
getOldPassportPlaceOfIssue() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The place of issue of the old passport (if applicable).
getOnMinPages() - Method in class com.mindee.input.PageOptions: Apply the operation only if the document has at least this many pages. 0 by default.
getOperation() - Method in class com.mindee.input.PageOptions: Operation to apply on the document, given the `pageIndexes` specified.
getOrientation() - Method in class com.mindee.v1.parsing.common.Page: The orientation which was applied from the original page.
getOriginalFilename() - Method in class com.mindee.image.PDFPageImage
getOriginalIndex() - Method in class com.mindee.image.PDFPageImage
getOwnerFirstName() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's owner first name.
getOwnerSurname() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's owner surname.
getP1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle engine's displacement (cm3).
getP2() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum net power (kW).
getP3() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's fuel type or energy source.
getP6() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's administrative power (fiscal horsepower).
getPage() - Method in class com.mindee.v2.parsing.inference.field.FieldLocation: 0-based page index of where the polygon is located.
getPage() - Method in class com.mindee.v2.parsing.search.PaginationMetadata: 1-indexed page number.
getPageCount() - Method in class com.mindee.image.ImageExtractor: Get the number of pages in the file.
getPageCount() - Method in class com.mindee.input.LocalInputSource: Get the number of pages in the document.
getPageCount() - Method in class com.mindee.v2.parsing.inference.InferenceFile: Page Count.
getPageCount(byte[]) - Method in interface com.mindee.pdf.PDFInputOperation: Get the number of pages in a PDF file.
getPageCount(byte[]) - Method in class com.mindee.pdf.PDFInputOperator
getPageId() - Method in class com.mindee.image.ExtractedImage
getPageId() - Method in class com.mindee.v1.parsing.common.Page: The id of the page.
getPageId() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Get the page ID, if present.
getPageId() - Method in class com.mindee.v1.parsing.standard.BaseField: The index of the page where the current field was found.
getPageIndexes() - Method in class com.mindee.input.PageOptions: Zero-based list of page indexes.
getPageIndexes() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1InvoicePageGroup: List of page indexes that belong to the same invoice (group).
getPageNumber() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The page number of the passport document.
getPageRange() - Method in class com.mindee.v2.product.split.SplitRange: 0-based page indexes, where the first integer indicates the start page and the second integer indicates the end page.
getPageRangeDistinct() - Method in class com.mindee.v2.product.split.SplitRange: Returns a list of distinct page ranges.
getPages() - Method in class com.mindee.v1.parsing.common.Inference: The prediction on each pages of the document.
getPages() - Method in class com.mindee.v1.parsing.common.ocr.MvisionV1
getPages() - Method in class com.mindee.v2.parsing.inference.RawText: Page Number the text was found on.
getPages() - Method in class com.mindee.v2.product.ocr.OcrResult: List of OCR results for each page in the document.
getPagination() - Method in class com.mindee.v2.parsing.search.SearchResponse
getParamsProductInfo(Class<? extends BaseParameters>) - Method in class com.mindee.v2.http.MindeeApiV2
getPaymentDate() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The date on which the payment is due / fullfilled.
getPaymentDate() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The date on which the payment is due / was full-filled.
getPDFCompressor() - Method in class com.mindee.input.LocalInputSource: Get the PDFCompression instance.
getPDFInputOperator() - Method in class com.mindee.input.LocalInputSource: Get the PDFInputOperation instance.
getPDFRasterizer() - Method in class com.mindee.image.ImageExtractor: Get the PDF rasterization implementation.
getPerPage() - Method in class com.mindee.v2.parsing.search.PaginationMetadata: Number of items per page.
getPersonalNumber() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The unique identifier assigned to the document holder.
getPlaceOfBirth() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The place of birth of the driver license holder.
getPoBox() - Method in class com.mindee.v1.parsing.standard.AddressField: PO-box number.
getPointer() - Method in class com.mindee.v2.parsing.error.ErrorItem: A JSON Pointer to the location of the body property.
getPollingUrl() - Method in class com.mindee.v2.parsing.Job: Polling URL.
getPolygon() - Method in interface com.mindee.geometry.PositionDataField
getPolygon() - Method in class com.mindee.v1.parsing.common.ocr.Word: Define the coordinates of the zone in the page where the values have been found.
getPolygon() - Method in class com.mindee.v1.parsing.generated.GeneratedObject: Get the polygon, if present.
getPolygon() - Method in class com.mindee.v1.parsing.standard.BaseField: Define the coordinates of the zone in the page where the value has been found.
getPolygon() - Method in class com.mindee.v1.parsing.standard.PositionField: Free polygon with up to 30 vertices.
getPolygon() - Method in class com.mindee.v2.parsing.inference.field.FieldLocation: Free polygon made up of points.
getPolygon() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions: Whether the polygon feature was activated.
getPolygon() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters: Calculate bounding box polygons for all fields.
getPolygon() - Method in class com.mindee.v2.product.ocr.OcrWord: Position information as a list of points in clockwise order.
getPoNumber() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The purchase order number, only if the document is an invoice.
getPoNumber() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The purchase order number.
getPostalCode() - Method in class com.mindee.v1.parsing.standard.AddressField: Postal or ZIP code.
getPrediction() - Method in class com.mindee.v1.parsing.common.Inference: The prediction on the document level.
getPrediction() - Method in class com.mindee.v1.parsing.common.Page: The prediction model type.
getPredictOptions() - Method in class com.mindee.v1.http.RequestParameters
getPriority() - Method in class com.mindee.v1.clientoptions.WorkflowOptions: Priority to give to the execution.
getPriority() - Method in class com.mindee.v1.parsing.common.Execution: Priority of the execution.
getProduct() - Method in class com.mindee.v1.parsing.common.Inference: Type of product.
getProductCode() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The product code referring to the item.
getProductCode() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The product code of the item.
getPublicUrl() - Method in class com.mindee.v1.clientoptions.WorkflowOptions: A unique, encrypted URL for accessing the document validation interface without requiring authentication.
getQ() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's power to weight ratio.
getQuadrangle() - Method in class com.mindee.v1.parsing.standard.PositionField: Free polygon with 4 vertices.
getQuantity() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The item quantity.
getQuantity() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The item quantity.
getQuantity() - Method in class com.mindee.v1.product.receipt.ReceiptV5LineItem: The item quantity.
getRag() - Method in class com.mindee.v1.clientoptions.PredictOptions: If set, will enable Retrieval-Augmented Generation.
getRag() - Method in class com.mindee.v1.clientoptions.WorkflowOptions: Whether to enable Retrieval-Augmented generation.
getRag() - Method in class com.mindee.v1.parsing.common.InferenceExtras: Retrieval-Augmented Generation results.
getRag() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions: Whether the RAG feature was activated.
getRag() - Method in class com.mindee.v2.product.extraction.ExtractionResult: If 'rag' was activated, contains metadata about the RAG operation.
getRag() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters: Enhance extraction accuracy with Retrieval-Augmented Generation.
getRate() - Method in class com.mindee.v1.parsing.standard.TaxField: The tax rate in percentage.
getRawResponse() - Method in class com.mindee.v1.parsing.common.ApiResponse: The raw server response.
getRawResponse() - Method in class com.mindee.v2.parsing.CommonResponse: The raw server response.
getRawText() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions: Whether the Raw Text feature was activated.
getRawText() - Method in class com.mindee.v2.product.extraction.ExtractionResult: If 'rawText' was activated, contains the extracted text of the document.
getRawText() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters: Extract the full text content from the document as strings.
getRawValue() - Method in class com.mindee.v1.parsing.standard.AddressField: The address exactly as it appears on the document.
getRawValue() - Method in class com.mindee.v1.parsing.standard.StringField: The value as it appears on the document.
getReceiptNumber() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The receipt number or identifier only if document is a receipt.
getReceiptNumber() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The receipt number or identifier.
getReceipts() - Method in class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document: Positions of the receipts on the document.
getRectangle() - Method in class com.mindee.v1.parsing.standard.PositionField: Rectangle that may be oriented (can go beyond the canvas).
getReferenceNumbers() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of Reference numbers, including PO number, only if the document is an invoice.
getReferenceNumbers() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: List of all reference numbers on the invoice, including the purchase order number.
getReplace() - Method in class com.mindee.v2.parsing.inference.DataSchemaActiveOptions: Whether the data schema was replaced for the inference.
getResources() - Method in class com.mindee.v1.parsing.common.ApiRequest
getResponseProductInfo(Class<? extends CommonResponse>) - Method in class com.mindee.v2.http.MindeeApiV2
getResult() - Method in class com.mindee.v2.parsing.BaseInference: Result of the inference.
getResult(Class<TResponse>, String) - Method in class com.mindee.v2.MindeeClient: Get the result of an inference that was previously enqueued.
getResultUrl() - Method in class com.mindee.v2.parsing.Job: Result URL, when available.
getRetrievedDocumentId() - Method in class com.mindee.v2.parsing.inference.RagMetadata: The UUID of the matched document used during the RAG operation.
getReviewedAt() - Method in class com.mindee.v1.parsing.common.Execution: The time at which the file was tagged as reviewed.
getReviewedPrediction() - Method in class com.mindee.v1.parsing.common.Execution: Reviewed fields and values.
getRoutingNumber() - Method in class com.mindee.v1.parsing.standard.PaymentDetailsField: The routing number.
getS1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's number of seats.
getS2() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's number of standing rooms (person).
getSaveFormat() - Method in class com.mindee.image.ExtractedImage
getSaveFormat() - Method in class com.mindee.image.PDFPageImage
getSex() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The biological sex of the document holder.
getShippingAddress() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The customer's address used for shipping.
getShippingAddress() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: Customer's delivery address.
getSimpleField() - Method in class com.mindee.v2.parsing.inference.field.DynamicField
getSimpleField(String) - Method in class com.mindee.v2.parsing.inference.field.InferenceFields: Retrieves the field as a `SimpleField`.
getSimpleField(String) - Method in class com.mindee.v2.parsing.inference.field.ObjectField: Retrieves a single sub-field from the fields map as a SimpleField.
getSimpleFields() - Method in class com.mindee.v2.parsing.inference.field.ObjectField: Retrieves all sub-fields from the fields map as a LinkedHashMap of SimpleField objects, keyed by their field names.
getSimpleItems() - Method in class com.mindee.v2.parsing.inference.field.ListField: Retrieves the items as SimpleField objects.
getSplitFile(LocalInputSource, PageOptions) - Method in class com.mindee.v1.MindeeClient: Retrieves the file after applying page operations to it.
getSplits() - Method in class com.mindee.v2.product.split.SplitResult: List of documents identified within a multi-document source file.
getState() - Method in class com.mindee.v1.parsing.standard.AddressField: State, province or region.
getState() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
getStateOfIssue() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The state or territory where the document was issued.
getStatus() - Method in class com.mindee.v1.parsing.common.ApiRequest: The status of the request.
getStatus() - Method in class com.mindee.v1.parsing.common.Execution: Execution Status.
getStatus() - Method in class com.mindee.v1.parsing.common.Job: Job Status.
getStatus() - Method in exception com.mindee.v2.http.MindeeHttpExceptionV2: Standard HTTP status code.
getStatus() - Method in class com.mindee.v2.parsing.error.ErrorResponse: The HTTP status code returned by the server.
getStatus() - Method in class com.mindee.v2.parsing.Job: Status of the job.
getStatus() - Method in class com.mindee.v2.parsing.JobWebhook: Status of the webhook.
getStatusCode() - Method in exception com.mindee.v1.http.MindeeHttpExceptionV1: Standard HTTP status code.
getStatusCode() - Method in class com.mindee.v1.parsing.common.ApiRequest: Status code of the request.
getStreetName() - Method in class com.mindee.v1.parsing.standard.AddressField: Street name.
getStreetNumber() - Method in class com.mindee.v1.parsing.standard.AddressField: Street number.
getStringValue() - Method in class com.mindee.v2.parsing.inference.field.SimpleField: Retrieves the value of the field as a String.
getSubcategory() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The purchase subcategory for transport, food and shooping.
getSubcategory() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The purchase subcategory for transport, food and shopping.
getSubcategory() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The purchase subcategory of the receipt for transport and food.
getSupplierAddress() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The address of the supplier or merchant.
getSupplierAddress() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The address of the supplier or merchant.
getSupplierAddress() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The address of the supplier or merchant.
getSupplierCompanyRegistrations() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of company registration numbers associated to the supplier.
getSupplierCompanyRegistrations() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: List of company registration numbers associated to the supplier.
getSupplierCompanyRegistrations() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: List of company registration numbers associated to the supplier.
getSupplierEmail() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The email of the supplier or merchant.
getSupplierEmail() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The email address of the supplier or merchant.
getSupplierName() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The name of the supplier or merchant.
getSupplierName() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The name of the supplier or merchant.
getSupplierName() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The name of the supplier or merchant.
getSupplierPaymentDetails() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of payment details associated to the supplier (only for invoices).
getSupplierPaymentDetails() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: List of payment details associated to the supplier of the invoice.
getSupplierPhoneNumber() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The phone number of the supplier or merchant.
getSupplierPhoneNumber() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The phone number of the supplier or merchant.
getSupplierPhoneNumber() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The phone number of the supplier or merchant.
getSupplierWebsite() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The website URL of the supplier or merchant.
getSupplierWebsite() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The website URL of the supplier or merchant.
getSurname() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The surname of the card holder.
getSurname() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The surname of the card holder.
getSurname() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The surname of the passport holder.
getSurname() - Method in class com.mindee.v1.product.passport.PassportV1Document: The surname of the passport holder.
getSurnames() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The list of the document holder's family names.
getSwift() - Method in class com.mindee.v1.parsing.standard.PaymentDetailsField: The SWIFT value.
getSwiftCode() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of the SWIFT code.
getTaxAmount() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The item tax amount.
getTaxAmount() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The item tax amount.
getTaxes() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of all taxes on the document.
getTaxes() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: List of taxes.
getTaxes() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The list of taxes present on the receipt.
getTaxRate() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The item tax rate in percentage.
getTaxRate() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The item tax rate in percentage.
getText() - Method in class com.mindee.v1.parsing.common.ocr.Word: Represent the content.
getTextContext() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions: Whether the text context feature was activated.
getTextContext() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters: Additional text context used by the model during inference.
getTime() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The time the purchase was made (only for receipts).
getTime() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The time the purchase was made.
getTip() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The total amount of tip and gratuity.
getTip() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The total amount of tip and gratuity.
getTitle() - Method in class com.mindee.v2.parsing.error.ErrorResponse: A short, human-readable summary of the problem.
getTotalAmount() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The total amount paid: includes taxes, tips, fees, and other charges.
getTotalAmount() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The item total amount.
getTotalAmount() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The total amount of the invoice: includes taxes, tips, fees, and other charges.
getTotalAmount() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The item total amount.
getTotalAmount() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The total amount paid: includes taxes, discounts, fees, tips, and gratuity.
getTotalAmount() - Method in class com.mindee.v1.product.receipt.ReceiptV5LineItem: The item total amount.
getTotalItems() - Method in class com.mindee.v2.parsing.search.PaginationMetadata: Total items.
getTotalNet() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The net amount paid: does not include taxes, fees, and discounts.
getTotalNet() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The net amount of the invoice: does not include taxes, fees, and discounts.
getTotalNet() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The net amount paid: does not include taxes, fees, and discounts.
getTotalPageNumber() - Method in class com.mindee.pdf.SplitPDF: The total page number.
getTotalPages() - Method in class com.mindee.v2.parsing.search.PaginationMetadata: Total number of pages.
getTotalTax() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The sum of all taxes present on the document.
getTotalTax() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document: The total tax: the sum of all the taxes for this invoice.
getTotalTax() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document: The sum of all taxes.
getType() - Method in class com.mindee.v1.parsing.common.Execution: Execution type.
getType() - Method in class com.mindee.v1.parsing.standard.CompanyRegistrationField: Type of the company registration number.
getType() - Method in class com.mindee.v2.parsing.inference.field.DynamicField: Type of the wrapped field.
getU1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's sound level (dB).
getU2() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle engine's rotation speed (RPM).
getUnitMeasure() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The item unit of measure.
getUnitMeasure() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The item unit of measure.
getUnitPrice() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: The item unit price.
getUnitPrice() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: The item unit price.
getUnitPrice() - Method in class com.mindee.v1.product.receipt.ReceiptV5LineItem: The item unit price.
getUploadedAt() - Method in class com.mindee.v1.parsing.common.Execution: The time at which the file was uploaded to a workflow.
getUrl() - Method in class com.mindee.input.URLInputSource
getUrl() - Method in class com.mindee.v1.parsing.common.ApiRequest: The original url.
getUrl() - Method in class com.mindee.v2.parsing.search.ModelWebhook: URL of the webhook.
getUserAgent() - Method in class com.mindee.http.MindeeApiCommon: Retrieves the user agent.
getV7() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's CO2 emission (g/km).
getValue() - Method in class com.mindee.v1.parsing.common.ErrorDetails: More precise information about the current error.
getValue() - Method in enum com.mindee.v1.parsing.common.ExecutionPriority
getValue() - Method in class com.mindee.v1.parsing.common.Orientation: Degrees of the rotation.
getValue() - Method in class com.mindee.v1.parsing.standard.AmountField: An amount value.
getValue() - Method in class com.mindee.v1.parsing.standard.BooleanField: The value as a Boolean.
getValue() - Method in class com.mindee.v1.parsing.standard.ClassificationField: The value as a String.
getValue() - Method in class com.mindee.v1.parsing.standard.CompanyRegistrationField: The value of the field.
getValue() - Method in class com.mindee.v1.parsing.standard.DateField: The value as LocalDate object.
getValue() - Method in class com.mindee.v1.parsing.standard.LocaleField: Concatenation of lang and country codes.
getValue() - Method in class com.mindee.v1.parsing.standard.StringField: The value of the field.
getValue() - Method in class com.mindee.v1.parsing.standard.TaxField: The tax amount.
getValue() - Method in class com.mindee.v2.parsing.inference.field.SimpleField: Value (string, boolean, double, or null).
getVersion() - Method in class com.mindee.v1.http.Endpoint: The version number of the API.
getVersion() - Method in class com.mindee.v1.parsing.common.Product: Version of the product used.
getWebhookIds() - Method in class com.mindee.v2.clientoptions.BaseParameters: Webhook IDs to call after all processing is finished.
getWebhooks() - Method in class com.mindee.v2.parsing.Job: Polling URL.
getWebhooks() - Method in class com.mindee.v2.parsing.search.SearchModel: Webhooks associated with the model.
getWords() - Method in class com.mindee.v2.product.ocr.OcrPage: List of words extracted from the document page.
getWorkflowId() - Method in class com.mindee.v1.clientoptions.PredictOptions: If set, will enqueue to a workflow queue instead of a product's endpoint.
getWorkflowId() - Method in class com.mindee.v1.parsing.common.Execution: Identifier for the workflow.
getWorkflowOptions() - Method in class com.mindee.v1.http.RequestParameters
getX() - Method in class com.mindee.geometry.Point
getX1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Next technical control date.
getY() - Method in class com.mindee.geometry.Point
getY1() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the regional proportional tax of the registration (in euros).
getY2() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the additional parafiscal tax of the registration (in euros).
getY3() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the additional CO2 tax of the registration (in euros).
getY4() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the fee for managing the registration (in euros).
getY5() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the fee for delivery of the registration certificate in euros.
getY6() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Total amount of registration fee to be paid in euros.
givenNames - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The given name(s) of the card holder.
givenNames - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The given name(s) of the card holder.
givenNames - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The given names of the passport holder.
givenNames - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The list of the document holder's given names.
givenNames - Variable in class com.mindee.v1.product.passport.PassportV1Document: The given name(s) of the passport holder.
greaterThan(FieldConfidence) - Method in enum com.mindee.v2.parsing.inference.field.FieldConfidence: Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is greater.
greaterThanOrEqual(FieldConfidence) - Method in enum com.mindee.v2.parsing.inference.field.FieldConfidence: Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is greater than or equal to the specified level.

H

hashCode() - Method in class com.mindee.geometry.Point
hashCode() - Method in class com.mindee.geometry.Polygon
hashCode() - Method in class com.mindee.input.PageOptions
hashCode() - Method in class com.mindee.pdf.SplitPDF
hashCode() - Method in class com.mindee.v1.clientoptions.PredictOptions
hashCode() - Method in class com.mindee.v1.clientoptions.WorkflowOptions
hashCode() - Method in class com.mindee.v1.http.RequestParameters
hashCode() - Method in class com.mindee.v1.parsing.common.ApiRequest
hashCode() - Method in class com.mindee.v1.parsing.common.ApiResponse
hashCode() - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse
hashCode() - Method in class com.mindee.v1.parsing.common.Cropper
hashCode() - Method in class com.mindee.v1.parsing.common.Document
hashCode() - Method in class com.mindee.v1.parsing.common.Execution
hashCode() - Method in class com.mindee.v1.parsing.common.ExecutionFile
hashCode() - Method in class com.mindee.v1.parsing.common.Extras
hashCode() - Method in class com.mindee.v1.parsing.common.FullTextOcr
hashCode() - Method in class com.mindee.v1.parsing.common.InferenceExtras
hashCode() - Method in class com.mindee.v1.parsing.common.Job
hashCode() - Method in class com.mindee.v1.parsing.common.ocr.Word
hashCode() - Method in class com.mindee.v1.parsing.common.Orientation
hashCode() - Method in class com.mindee.v1.parsing.common.PredictResponse
hashCode() - Method in class com.mindee.v1.parsing.common.Rag
hashCode() - Method in class com.mindee.v1.parsing.common.WorkflowResponse
hashCode() - Method in class com.mindee.v1.parsing.standard.BaseField
hashCode() - Method in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document
hashCode() - Method in class com.mindee.v1.product.cropper.CropperV1Document
hashCode() - Method in class com.mindee.v1.product.cropper.CropperV1Page
hashCode() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document
hashCode() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document
hashCode() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document
hashCode() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document
hashCode() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document
hashCode() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Page
hashCode() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document
hashCode() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Page
hashCode() - Method in class com.mindee.v1.product.generated.GeneratedV1Document
hashCode() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document
hashCode() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document
hashCode() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document
hashCode() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document
hashCode() - Method in class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document
hashCode() - Method in class com.mindee.v1.product.passport.PassportV1Document
hashCode() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document
hashCode() - Method in class com.mindee.v2.clientoptions.BaseParameters
hashCode() - Method in class com.mindee.v2.parsing.BaseInference
hashCode() - Method in class com.mindee.v2.parsing.CommonResponse
hashCode() - Method in class com.mindee.v2.parsing.error.ErrorItem
hashCode() - Method in class com.mindee.v2.parsing.error.ErrorResponse
hashCode() - Method in class com.mindee.v2.parsing.inference.DataSchemaActiveOptions
hashCode() - Method in class com.mindee.v2.parsing.inference.field.BaseField
hashCode() - Method in class com.mindee.v2.parsing.inference.field.DynamicField
hashCode() - Method in class com.mindee.v2.parsing.inference.field.FieldLocation
hashCode() - Method in class com.mindee.v2.parsing.inference.field.InferenceFields
hashCode() - Method in class com.mindee.v2.parsing.inference.field.ListField
hashCode() - Method in class com.mindee.v2.parsing.inference.field.ObjectField
hashCode() - Method in class com.mindee.v2.parsing.inference.field.SimpleField
hashCode() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions
hashCode() - Method in class com.mindee.v2.parsing.inference.InferenceFile
hashCode() - Method in class com.mindee.v2.parsing.inference.InferenceJob
hashCode() - Method in class com.mindee.v2.parsing.inference.InferenceModel
hashCode() - Method in class com.mindee.v2.parsing.Job
hashCode() - Method in class com.mindee.v2.parsing.JobResponse
hashCode() - Method in class com.mindee.v2.parsing.JobWebhook
hashCode() - Method in class com.mindee.v2.parsing.search.ModelWebhook
hashCode() - Method in class com.mindee.v2.parsing.search.PaginationMetadata
hashCode() - Method in class com.mindee.v2.parsing.search.SearchModel
hashCode() - Method in class com.mindee.v2.parsing.search.SearchResponse
hashCode() - Method in class com.mindee.v2.product.classification.ClassificationResult
hashCode() - Method in class com.mindee.v2.product.crop.CropItem
hashCode() - Method in class com.mindee.v2.product.crop.CropResult
hashCode() - Method in class com.mindee.v2.product.extraction.ExtractionResult
hashCode() - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters
hashCode() - Method in class com.mindee.v2.product.ocr.OcrPage
hashCode() - Method in class com.mindee.v2.product.ocr.OcrResult
hashCode() - Method in class com.mindee.v2.product.ocr.OcrWord
hashCode() - Method in class com.mindee.v2.product.split.SplitRange
hashCode() - Method in class com.mindee.v2.product.split.SplitResult
hasPrediction() - Method in class com.mindee.v1.parsing.common.Pages: Returns whether any predictions are set.
height - Variable in class com.mindee.image.ImageUtils.Dimensions
High - com.mindee.v2.parsing.inference.field.FieldConfidence
HIGH - com.mindee.v1.parsing.common.ExecutionPriority
httpClientBuilder(HttpClientBuilder) - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
httpClientBuilder(HttpClientBuilder) - Method in class com.mindee.v2.http.MindeeHttpApiV2.MindeeHttpApiV2Builder

I

i - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The car registration date of the given certificate.
iban - Variable in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of the IBAN number.
id - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The unique identifier of the driver license.
id - Variable in class com.mindee.v2.parsing.BaseInference: Inference ID.
IdCardV1 - Class in com.mindee.v1.product.fr.idcard: Carte Nationale d'Identité API version 1 inference prediction.
IdCardV1() - Constructor for class com.mindee.v1.product.fr.idcard.IdCardV1
IdCardV1Document - Class in com.mindee.v1.product.fr.idcard: Carte Nationale d'Identité API version 1.1 document data.
IdCardV1Document() - Constructor for class com.mindee.v1.product.fr.idcard.IdCardV1Document
IdCardV1Page - Class in com.mindee.v1.product.fr.idcard: Carte Nationale d'Identité API version 1.1 page data.
IdCardV1Page() - Constructor for class com.mindee.v1.product.fr.idcard.IdCardV1Page
IdCardV2 - Class in com.mindee.v1.product.fr.idcard: Carte Nationale d'Identité API version 2 inference prediction.
IdCardV2() - Constructor for class com.mindee.v1.product.fr.idcard.IdCardV2
IdCardV2Document - Class in com.mindee.v1.product.fr.idcard: Carte Nationale d'Identité API version 2.0 document data.
IdCardV2Document() - Constructor for class com.mindee.v1.product.fr.idcard.IdCardV2Document
IdCardV2Page - Class in com.mindee.v1.product.fr.idcard: Carte Nationale d'Identité API version 2.0 page data.
IdCardV2Page() - Constructor for class com.mindee.v1.product.fr.idcard.IdCardV2Page
idNumber - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The identification card number.
idNumber - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The identification number of the passport document.
idNumber - Variable in class com.mindee.v1.product.passport.PassportV1Document: The passport's identification number.
ImageCompressor - Class in com.mindee.image: Image compression class.
ImageCompressor() - Constructor for class com.mindee.image.ImageCompressor
ImageExtractor - Class in com.mindee.image: Extract sub-images from an image.
ImageExtractor(LocalInputSource) - Constructor for class com.mindee.image.ImageExtractor
ImageUtils - Class in com.mindee.image: Image utility class.
ImageUtils() - Constructor for class com.mindee.image.ImageUtils
ImageUtils.Dimensions - Class in com.mindee.image: Dimension class for pages/images.
IndianPassportV1 - Class in com.mindee.v1.product.ind.indianpassport: Passport - India API version 1 inference prediction.
IndianPassportV1() - Constructor for class com.mindee.v1.product.ind.indianpassport.IndianPassportV1
IndianPassportV1Document - Class in com.mindee.v1.product.ind.indianpassport: Passport - India API version 1.2 document data.
IndianPassportV1Document() - Constructor for class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document
Inference<TPagePrediction,TDocumentPrediction extends Prediction> - Class in com.mindee.v1.parsing.common: Common inference data.
Inference() - Constructor for class com.mindee.v1.parsing.common.Inference
InferenceActiveOptions - Class in com.mindee.v2.parsing.inference: Options which were activated during the inference.
InferenceActiveOptions() - Constructor for class com.mindee.v2.parsing.inference.InferenceActiveOptions
InferenceExtras - Class in com.mindee.v1.parsing.common: Inference-level optional info.
InferenceExtras() - Constructor for class com.mindee.v1.parsing.common.InferenceExtras
InferenceFields - Class in com.mindee.v2.parsing.inference.field: Inference fields map.
InferenceFields() - Constructor for class com.mindee.v2.parsing.inference.field.InferenceFields
InferenceFile - Class in com.mindee.v2.parsing.inference: File info for V2 API.
InferenceFile() - Constructor for class com.mindee.v2.parsing.inference.InferenceFile
InferenceFile(String, String, int, String) - Constructor for class com.mindee.v2.parsing.inference.InferenceFile: Creates a new InferenceFile instance.
InferenceJob - Class in com.mindee.v2.parsing.inference: Information on the Job associated to a given Inference.
InferenceJob() - Constructor for class com.mindee.v2.parsing.inference.InferenceJob
InferenceJob(String) - Constructor for class com.mindee.v2.parsing.inference.InferenceJob: Creates a new InferenceJob instance.
InferenceModel - Class in com.mindee.v2.parsing.inference: Model information for a V2 API inference.
InferenceModel() - Constructor for class com.mindee.v2.parsing.inference.InferenceModel
InferenceModel(String) - Constructor for class com.mindee.v2.parsing.inference.InferenceModel: Creates a new InferenceModel instance.
initialDelaySec(Double) - Method in class com.mindee.v1.clientoptions.PollingOptions.PollingOptionsBuilder
initialDelaySec(Double) - Method in class com.mindee.v2.clientoptions.PollingOptions.PollingOptionsBuilder
InputSourceUtils - Class in com.mindee.input: Utilities for working with files.
InternationalIdV2 - Class in com.mindee.v1.product.internationalid: International ID API version 2 inference prediction.
InternationalIdV2() - Constructor for class com.mindee.v1.product.internationalid.InternationalIdV2
InternationalIdV2Document - Class in com.mindee.v1.product.internationalid: International ID API version 2.2 document data.
InternationalIdV2Document() - Constructor for class com.mindee.v1.product.internationalid.InternationalIdV2Document
intervalSec(Double) - Method in class com.mindee.v1.clientoptions.PollingOptions.PollingOptionsBuilder
intervalSec(Double) - Method in class com.mindee.v2.clientoptions.PollingOptions.PollingOptionsBuilder
invoiceNumber - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The invoice number or identifier only if document is an invoice.
invoiceNumber - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The invoice number or identifier.
invoicePageGroups - Variable in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document: List of page groups.
InvoiceSplitterV1 - Class in com.mindee.v1.product.invoicesplitter: Invoice Splitter API version 1 inference prediction.
InvoiceSplitterV1() - Constructor for class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1
InvoiceSplitterV1Document - Class in com.mindee.v1.product.invoicesplitter: Invoice Splitter API version 1.4 document data.
InvoiceSplitterV1Document() - Constructor for class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document
InvoiceSplitterV1InvoicePageGroup - Class in com.mindee.v1.product.invoicesplitter: List of page groups.
InvoiceSplitterV1InvoicePageGroup() - Constructor for class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1InvoicePageGroup
InvoiceV4 - Class in com.mindee.v1.product.invoice: Invoice API version 4 inference prediction.
InvoiceV4() - Constructor for class com.mindee.v1.product.invoice.InvoiceV4
InvoiceV4Document - Class in com.mindee.v1.product.invoice: Invoice API version 4.11 document data.
InvoiceV4Document() - Constructor for class com.mindee.v1.product.invoice.InvoiceV4Document
InvoiceV4LineItem - Class in com.mindee.v1.product.invoice: List of all the line items present on the invoice.
InvoiceV4LineItem() - Constructor for class com.mindee.v1.product.invoice.InvoiceV4LineItem
isEmpty() - Method in class com.mindee.geometry.Polygon: Returns true if there are no coordinates.
isEmpty() - Method in class com.mindee.v1.parsing.common.Prediction: Returns true if there are no predictions values.
isEmpty() - Method in class com.mindee.v1.parsing.standard.AmountField
isEmpty() - Method in class com.mindee.v1.parsing.standard.BaseField: Whether the field is empty or not.
isEmpty() - Method in class com.mindee.v1.parsing.standard.BooleanField
isEmpty() - Method in class com.mindee.v1.parsing.standard.ClassificationField
isEmpty() - Method in class com.mindee.v1.parsing.standard.CompanyRegistrationField
isEmpty() - Method in class com.mindee.v1.parsing.standard.DateField
isEmpty() - Method in class com.mindee.v1.parsing.standard.LocaleField
isEmpty() - Method in class com.mindee.v1.parsing.standard.PaymentDetailsField
isEmpty() - Method in class com.mindee.v1.parsing.standard.StringField
isEmpty() - Method in class com.mindee.v1.parsing.standard.TaxField
isEmpty() - Method in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document
isEmpty() - Method in class com.mindee.v1.product.cropper.CropperV1Document
isEmpty() - Method in class com.mindee.v1.product.cropper.CropperV1Page
isEmpty() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document
isEmpty() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document
isEmpty() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem
isEmpty() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban
isEmpty() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document
isEmpty() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document
isEmpty() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document
isEmpty() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Page
isEmpty() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document
isEmpty() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Page
isEmpty() - Method in class com.mindee.v1.product.generated.GeneratedV1Document
isEmpty() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document
isEmpty() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document
isEmpty() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document
isEmpty() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem
isEmpty() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document
isEmpty() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1InvoicePageGroup
isEmpty() - Method in class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document
isEmpty() - Method in class com.mindee.v1.product.passport.PassportV1Document
isEmpty() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document
isEmpty() - Method in class com.mindee.v1.product.receipt.ReceiptV5LineItem
isInvalidStatusCode(int) - Method in class com.mindee.http.MindeeApiCommon: Checks if the status code is out of the 2xx-3xx range.
isList() - Method in class com.mindee.v1.parsing.generated.GeneratedFeature
isPDF() - Method in class com.mindee.input.LocalInputSource: Returns true if the file is a PDF.
isPDF(byte[]) - Method in interface com.mindee.pdf.PDFInputOperation: Returns true if the file is a PDF.
isPDF(byte[]) - Method in class com.mindee.pdf.PDFInputOperator: Returns true if the file is a PDF.
isPointInPolygonY(Point, Polygon) - Static method in class com.mindee.geometry.PolygonUtils: Determine if a Point is within a Polygon's Y axis.
isPointInY(Point, Double, Double) - Static method in class com.mindee.geometry.PolygonUtils: Determine if a Point is within two Y coordinates.
isPredictionEmpty() - Method in class com.mindee.v1.parsing.common.Page: Returns true if there are no predictions in this page.
isRotationApplied() - Method in class com.mindee.v1.parsing.common.Inference: Whether a rotation was applied to parse the document.
issuanceDate - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The date when the passport was issued, ISO format: YYYY-MM-DD.
issuanceDate - Variable in class com.mindee.v1.product.passport.PassportV1Document: The date the passport was issued.
issuancePlace - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The place where the passport was issued.
issueDate - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The date of issue of the identification card.
issueDate - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The date when the document was issued.
issuedDate - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The date when the driver license was issued.
issuingAuthority - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The authority that issued the driver license.
isValidHmacSignature(String, String) - Method in class com.mindee.parsing.BaseLocalResponse: Verify that the payload's signature matches the one received from the server.

J

j - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's category.
j1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's national type.
j2 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's body type (CE).
j3 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's body type (National designation).
job - Variable in class com.mindee.v2.parsing.BaseInference: Job the inference belongs to.
Job - Class in com.mindee.v1.parsing.common: Job Details for enqueued jobs.
Job - Class in com.mindee.v2.parsing: Information on the processing of a file sent to the Mindee API.
Job() - Constructor for class com.mindee.v1.parsing.common.Job
Job() - Constructor for class com.mindee.v2.parsing.Job
Job(LocalDateTime, String, LocalDateTime, String, Error) - Constructor for class com.mindee.v1.parsing.common.Job: Creates a new Job instance.
Job(LocalDateTime, LocalDateTime, String, String, ErrorResponse, String, String, String, String, String, List<JobWebhook>) - Constructor for class com.mindee.v2.parsing.Job: Creates a new Job instance.
JobResponse - Class in com.mindee.v2.parsing: Represents an asynchronous polling response.
JobResponse() - Constructor for class com.mindee.v2.parsing.JobResponse
JobWebhook - Class in com.mindee.v2.parsing: JobWebhook info.
JobWebhook() - Constructor for class com.mindee.v2.parsing.JobWebhook
JobWebhook(String, ErrorResponse, LocalDateTime, String) - Constructor for class com.mindee.v2.parsing.JobWebhook: Creates a new JobWebhook instance.

K

KEEP_ONLY - com.mindee.input.PageOptionsOperation: Keep only the specified pages, removing all others.

L

lastName - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The last name of the driver license holder.
legalGuardian - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The name of the legal guardian of the passport holder (if applicable).
lessThan(FieldConfidence) - Method in enum com.mindee.v2.parsing.inference.field.FieldConfidence: Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is less than the specified level.
lessThanOrEqual(FieldConfidence) - Method in enum com.mindee.v2.parsing.inference.field.FieldConfidence: Compares the current FieldConfidence level with another FieldConfidence level to determine if the current level is less than or equal to the specified level.
LineItemField - Interface in com.mindee.v1.parsing.standard: Represent a single line in a field printable as an rST table.
lineItems - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of line item present on the document.
lineItems - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: List of all the line items present on the invoice.
lineItems - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: List of all line items on the receipt.
lineSeparator(int[], String) - Static method in class com.mindee.parsing.SummaryHelper: Format an rST table line separator.
LIST_FIELD - com.mindee.v2.parsing.inference.field.DynamicField.FieldType
ListField - Class in com.mindee.v2.parsing.inference.field: Field holding a list of fields.
ListField() - Constructor for class com.mindee.v2.parsing.inference.field.ListField
ListField(List<DynamicField>) - Constructor for class com.mindee.v2.parsing.inference.field.ListField: Creates a new ListField instance.
LocalDateTimeDeserializer - Class in com.mindee.v1.parsing.common: Deserializer for LocalDateTime.
LocalDateTimeDeserializer() - Constructor for class com.mindee.v1.parsing.common.LocalDateTimeDeserializer
locale - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The locale of the document.
locale - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The locale of the document.
locale - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The locale of the document.
LocaleField - Class in com.mindee.v1.parsing.standard: The local of the page.
LocaleField(String, String, String, String) - Constructor for class com.mindee.v1.parsing.standard.LocaleField
LocalInputSource - Class in com.mindee.input: A source document for Mindee API operations.
LocalInputSource(byte[], String) - Constructor for class com.mindee.input.LocalInputSource
LocalInputSource(File) - Constructor for class com.mindee.input.LocalInputSource
LocalInputSource(InputStream, String) - Constructor for class com.mindee.input.LocalInputSource
LocalInputSource(String) - Constructor for class com.mindee.input.LocalInputSource
LocalInputSource(String, String) - Constructor for class com.mindee.input.LocalInputSource
LocalInputSource(Path) - Constructor for class com.mindee.input.LocalInputSource
LocalResponse - Class in com.mindee.v1.parsing: A Mindee response saved locally.
LocalResponse - Class in com.mindee.v2.parsing: A Mindee response saved locally.
LocalResponse(File) - Constructor for class com.mindee.v1.parsing.LocalResponse
LocalResponse(File) - Constructor for class com.mindee.v2.parsing.LocalResponse
LocalResponse(InputStream) - Constructor for class com.mindee.v1.parsing.LocalResponse
LocalResponse(InputStream) - Constructor for class com.mindee.v2.parsing.LocalResponse
LocalResponse(String) - Constructor for class com.mindee.v1.parsing.LocalResponse
LocalResponse(String) - Constructor for class com.mindee.v2.parsing.LocalResponse
LocalResponse(Path) - Constructor for class com.mindee.v1.parsing.LocalResponse
LocalResponse(Path) - Constructor for class com.mindee.v2.parsing.LocalResponse
Low - com.mindee.v2.parsing.inference.field.FieldConfidence
LOW - com.mindee.v1.parsing.common.ExecutionPriority

M

main(String[]) - Static method in class com.mindee.v1.CommandLineInterface: Instantiates all products one by one in a separate picocli instance and relays the command to them.
makeFilename(List<Integer>) - Method in class com.mindee.pdf.BasePDFExtractor: Make a nice filename for the split.
makeUnknownError(int) - Method in class com.mindee.v2.http.MindeeApiV2: Creates an "unknown error" response from an HTTP status code.
maxRetries(Integer) - Method in class com.mindee.v1.clientoptions.PollingOptions.PollingOptionsBuilder
maxRetries(Integer) - Method in class com.mindee.v2.clientoptions.PollingOptions.PollingOptionsBuilder
Medium - com.mindee.v2.parsing.inference.field.FieldConfidence
MEDIUM - com.mindee.v1.parsing.common.ExecutionPriority
merge(List<Bbox>) - Static method in class com.mindee.geometry.BboxUtils: Merge a list of BBoxes.
MindeeApiCommon - Class in com.mindee.http: Defines common methods for mindee APIs.
MindeeApiCommon() - Constructor for class com.mindee.http.MindeeApiCommon
MindeeApiV1 - Class in com.mindee.v1.http: Defines required methods for an API.
MindeeApiV1() - Constructor for class com.mindee.v1.http.MindeeApiV1
MindeeApiV2 - Class in com.mindee.v2.http: Defines required methods for an API.
MindeeApiV2() - Constructor for class com.mindee.v2.http.MindeeApiV2
MindeeClient - Class in com.mindee.v1: Main entrypoint for Mindee operations.
MindeeClient - Class in com.mindee.v2: Entry point for the Mindee **V2** API features.
MindeeClient() - Constructor for class com.mindee.v1.MindeeClient: Create a default MindeeClient.
MindeeClient() - Constructor for class com.mindee.v2.MindeeClient: Uses an API key read from the environment variables.
MindeeClient(PDFInputOperation, MindeeApiV1) - Constructor for class com.mindee.v1.MindeeClient: Create a MindeeClient.
MindeeClient(MindeeApiV1) - Constructor for class com.mindee.v1.MindeeClient: Create a MindeeClient using a MindeeApi.
MindeeClient(MindeeApiV2) - Constructor for class com.mindee.v2.MindeeClient: Inject a custom HTTP API implementation.
MindeeClient(String) - Constructor for class com.mindee.v1.MindeeClient: Create a default MindeeClient.
MindeeClient(String) - Constructor for class com.mindee.v2.MindeeClient: Uses the supplied API key.
MindeeException - Exception in com.mindee: Represent a Mindee exception.
MindeeException(String) - Constructor for exception com.mindee.MindeeException
MindeeException(String, Throwable) - Constructor for exception com.mindee.MindeeException
MindeeHttpApiV1 - Class in com.mindee.v1.http: HTTP Client class.
MindeeHttpApiV1(MindeeSettings) - Constructor for class com.mindee.v1.http.MindeeHttpApiV1
MindeeHttpApiV1.MindeeHttpApiV1Builder - Class in com.mindee.v1.http
MindeeHttpApiV2 - Class in com.mindee.v2.http: HTTP Client class for the V2 API.
MindeeHttpApiV2(MindeeSettings) - Constructor for class com.mindee.v2.http.MindeeHttpApiV2
MindeeHttpApiV2.MindeeHttpApiV2Builder - Class in com.mindee.v2.http
MindeeHttpExceptionV1 - Exception in com.mindee.v1.http: Represent a Mindee exception.
MindeeHttpExceptionV1(int, String, String, String) - Constructor for exception com.mindee.v1.http.MindeeHttpExceptionV1
MindeeHttpExceptionV2 - Exception in com.mindee.v2.http: Represent a Mindee exception.
MindeeHttpExceptionV2(int, String) - Constructor for exception com.mindee.v2.http.MindeeHttpExceptionV2
mindeeSettings(MindeeSettings) - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
mindeeSettings(MindeeSettings) - Method in class com.mindee.v2.http.MindeeHttpApiV2.MindeeHttpApiV2Builder
MindeeSettings - Class in com.mindee.v1: Mindee API configuration.
MindeeSettings - Class in com.mindee.v2: Mindee API V2 configuration.
MindeeSettings() - Constructor for class com.mindee.v1.MindeeSettings
MindeeSettings() - Constructor for class com.mindee.v2.MindeeSettings
MindeeSettings(String) - Constructor for class com.mindee.v1.MindeeSettings
MindeeSettings(String) - Constructor for class com.mindee.v2.MindeeSettings
MindeeSettings(String, String) - Constructor for class com.mindee.v1.MindeeSettings
MindeeSettings(String, String) - Constructor for class com.mindee.v2.MindeeSettings
MindeeSettings.MindeeSettingsBuilder - Class in com.mindee.v2
MinMax - Class in com.mindee.geometry: Minimum and maximum values.
MinMax(Double, Double) - Constructor for class com.mindee.geometry.MinMax
model - Variable in class com.mindee.v2.parsing.BaseInference: Model info.
modelId - Variable in class com.mindee.v2.clientoptions.BaseParameters.BaseBuilder
modelId - Variable in class com.mindee.v2.clientoptions.BaseParameters: Model ID to use for the inference (required).
ModelWebhook - Class in com.mindee.v2.parsing.search: Model webhook info.
ModelWebhook() - Constructor for class com.mindee.v2.parsing.search.ModelWebhook
ModelWebhook(String, String, String) - Constructor for class com.mindee.v2.parsing.search.ModelWebhook: Creates a new ModelWebhook instance.
mrz - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The Machine Readable Zone (MRZ) of the driver license.
mrz1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Machine Readable Zone, first line.
mrz1 - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: Machine Readable Zone, first line.
mrz1 - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The Machine Readable Zone, first line.
mrz1 - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The first line of the machine-readable zone (MRZ) of the passport document.
mrz1 - Variable in class com.mindee.v1.product.passport.PassportV1Document: Machine Readable Zone, first line.
mrz2 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Machine Readable Zone, second line.
mrz2 - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: Machine Readable Zone, second line.
mrz2 - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The Machine Readable Zone, second line.
mrz2 - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The second line of the machine-readable zone (MRZ) of the passport document.
mrz2 - Variable in class com.mindee.v1.product.passport.PassportV1Document: Machine Readable Zone, second line.
mrz3 - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The Machine Readable Zone, third line.
mrzLine1 - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The Machine Readable Zone, first line.
mrzLine2 - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The Machine Readable Zone, second line.
mrzLine3 - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The Machine Readable Zone, third line.
MultiReceiptsDetectorV1 - Class in com.mindee.v1.product.multireceiptsdetector: Multi Receipts Detector API version 1 inference prediction.
MultiReceiptsDetectorV1() - Constructor for class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1
MultiReceiptsDetectorV1Document - Class in com.mindee.v1.product.multireceiptsdetector: Multi Receipts Detector API version 1.1 document data.
MultiReceiptsDetectorV1Document() - Constructor for class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document
MvisionV1 - Class in com.mindee.v1.parsing.common.ocr: List all pages that have ocr results.
MvisionV1() - Constructor for class com.mindee.v1.parsing.common.ocr.MvisionV1

N

nameOfMother - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The name of the mother of the passport holder.
nameOfSpouse - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The name of the spouse of the passport holder (if applicable).
nationality - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The nationality of the card holder.
nationality - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The country of citizenship of the document holder.

O

OBJECT_FIELD - com.mindee.v2.parsing.inference.field.DynamicField.FieldType
ObjectField - Class in com.mindee.v2.parsing.inference.field: Field holding a map of sub-fields.
ObjectField() - Constructor for class com.mindee.v2.parsing.inference.field.ObjectField
ObjectField(InferenceFields) - Constructor for class com.mindee.v2.parsing.inference.field.ObjectField: Creates a new ObjectField instance.
Ocr - Class in com.mindee.v1.parsing.common.ocr: Ocr result information.
Ocr() - Constructor for class com.mindee.v1.parsing.common.ocr.Ocr
OcrInference - Class in com.mindee.v2.product.ocr: The inference result for an OCR utility request.
OcrInference() - Constructor for class com.mindee.v2.product.ocr.OcrInference
OcrPage - Class in com.mindee.v1.parsing.common.ocr: Represents a page.
OcrPage - Class in com.mindee.v2.product.ocr: OCR result for a single page.
OcrPage() - Constructor for class com.mindee.v2.product.ocr.OcrPage
OcrPage(String, ArrayList<OcrWord>) - Constructor for class com.mindee.v2.product.ocr.OcrPage: Creates a new OcrPage instance.
OcrPage(List<Word>) - Constructor for class com.mindee.v1.parsing.common.ocr.OcrPage
OcrParameters - Class in com.mindee.v2.product.ocr.params
OcrParameters(String, String, String[]) - Constructor for class com.mindee.v2.product.ocr.params.OcrParameters
OcrParameters.Builder - Class in com.mindee.v2.product.ocr.params
OcrResponse - Class in com.mindee.v2.product.ocr: Response for an OCR utility inference.
OcrResponse() - Constructor for class com.mindee.v2.product.ocr.OcrResponse
OcrResult - Class in com.mindee.v2.product.ocr: Result of the OCR utility inference.
OcrResult() - Constructor for class com.mindee.v2.product.ocr.OcrResult
OcrResult(ArrayList<OcrPage>) - Constructor for class com.mindee.v2.product.ocr.OcrResult: Creates a new OcrResult instance.
OcrWord - Class in com.mindee.v2.product.ocr: OCR result for a single word extracted from the document page.
OcrWord() - Constructor for class com.mindee.v2.product.ocr.OcrWord
OcrWord(String, Polygon) - Constructor for class com.mindee.v2.product.ocr.OcrWord: Creates a new OcrWord instance.
of(ListField) - Static method in class com.mindee.v2.parsing.inference.field.DynamicField
of(ObjectField) - Static method in class com.mindee.v2.parsing.inference.field.DynamicField
of(SimpleField) - Static method in class com.mindee.v2.parsing.inference.field.DynamicField
oldPassportDateOfIssue - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The date of issue of the old passport (if applicable), ISO format: YYYY-MM-DD.
oldPassportNumber - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The number of the old passport (if applicable).
oldPassportPlaceOfIssue - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The place of issue of the old passport (if applicable).
onMinPages(Integer) - Method in class com.mindee.input.PageOptions.Builder
operation(PageOptionsOperation) - Method in class com.mindee.input.PageOptions.Builder
Orientation - Class in com.mindee.v1.parsing.common: The orientation which was applied from the original page.
Orientation() - Constructor for class com.mindee.v1.parsing.common.Orientation
ownerFirstName - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's owner first name.
ownerSurname - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's owner surname.

P

p1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle engine's displacement (cm3).
p2 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's maximum net power (kW).
p3 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's fuel type or energy source.
p6 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's administrative power (fiscal horsepower).
Page<TPagePrediction> - Class in com.mindee.v1.parsing.common: Define a page in the parsed document.
Page() - Constructor for class com.mindee.v1.parsing.common.Page
pageIndexes(Integer[]) - Method in class com.mindee.input.PageOptions.Builder
pageIndexes(List<Integer>) - Method in class com.mindee.input.PageOptions.Builder
pageNumber - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The page number of the passport document.
PageOptions - Class in com.mindee.input: Represent options to cut a document.
PageOptions(List<Integer>) - Constructor for class com.mindee.input.PageOptions: Deprecated.
Use the Builder pattern instead.
PageOptions(List<Integer>, PageOptionsOperation) - Constructor for class com.mindee.input.PageOptions: Deprecated.
Use the Builder pattern instead.
PageOptions(List<Integer>, PageOptionsOperation, Integer) - Constructor for class com.mindee.input.PageOptions
PageOptions.Builder - Class in com.mindee.input: Builder for page options.
PageOptionsOperation - Enum in com.mindee.input: Possible page operations on a document.
pageRange - Variable in class com.mindee.v2.product.split.SplitRange: 0-based page indexes, where the first integer indicates the start page and the second integer indicates the end page.
pages - Variable in class com.mindee.v1.parsing.common.Inference: The prediction on each pages of the document.
Pages<TPagePrediction> - Class in com.mindee.v1.parsing.common: List of all pages in the inference.
Pages() - Constructor for class com.mindee.v1.parsing.common.Pages
PaginationMetadata - Class in com.mindee.v2.parsing.search: PaginationMetadata data associated with model search.
PaginationMetadata() - Constructor for class com.mindee.v2.parsing.search.PaginationMetadata
PaginationMetadata(int, int, int, int) - Constructor for class com.mindee.v2.parsing.search.PaginationMetadata: Creates a new PaginationMetadata instance.
parse(Class<T>, LocalInputSource) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Standard prediction API and parse the results.
parse(Class<T>, LocalInputSource, PageOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Standard prediction API and parse the results.
parse(Class<T>, LocalInputSource, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Standard prediction API and parse the results.
parse(Class<T>, LocalInputSource, PredictOptions, PageOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Standard prediction API and parse the results.
parse(Class<T>, Endpoint, LocalInputSource) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction API and parse the results.
parse(Class<T>, Endpoint, LocalInputSource, PageOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction API and parse the results.
parse(Class<T>, Endpoint, LocalInputSource, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Generated prediction API and parse the results.
parse(Class<T>, Endpoint, LocalInputSource, PredictOptions, PageOptions) - Method in class com.mindee.v1.MindeeClient: Send a local file to a Standard prediction API and parse the results.
parse(Class<T>, Endpoint, URL) - Method in class com.mindee.v1.MindeeClient: Send a remote file to a Generated prediction API and parse the results.
parse(Class<T>, Endpoint, URL, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a remote file to a Generated prediction API and parse the results.
parse(Class<T>, URL) - Method in class com.mindee.v1.MindeeClient: Send a remote file to a Standard prediction API and parse the results.
parse(Class<T>, URL, PredictOptions) - Method in class com.mindee.v1.MindeeClient: Send a remote file to a Standard prediction API and parse the results.
parseQueued(Class<T>, Endpoint, String) - Method in class com.mindee.v1.MindeeClient: Parse a document from a Generated prediction API async queue.
parseQueued(Class<T>, String) - Method in class com.mindee.v1.MindeeClient: Parse a document from an async queue.
PassportV1 - Class in com.mindee.v1.product.passport: Passport API version 1 inference prediction.
PassportV1() - Constructor for class com.mindee.v1.product.passport.PassportV1
PassportV1Document - Class in com.mindee.v1.product.passport: Passport API version 1.1 document data.
PassportV1Document() - Constructor for class com.mindee.v1.product.passport.PassportV1Document
paymentDate - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The date on which the payment is due / fullfilled.
paymentDate - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The date on which the payment is due / was full-filled.
PaymentDetailsField - Class in com.mindee.v1.parsing.standard: Represent a payment detail.
PaymentDetailsField(String, String, String, String) - Constructor for class com.mindee.v1.parsing.standard.PaymentDetailsField
PDFCompression - Interface in com.mindee.pdf: Compress a PDF.
PDFCompressor - Class in com.mindee.pdf: PDF compression class.
PDFCompressor() - Constructor for class com.mindee.pdf.PDFCompressor
PDFExtractor - Class in com.mindee.v1.fileoperations: PDF extraction class.
PDFExtractor(LocalInputSource) - Constructor for class com.mindee.v1.fileoperations.PDFExtractor: Init from a LocalInputSource.
PDFInputOperation - Interface in com.mindee.pdf: Various operations required for PDF input files.
PDFInputOperator - Class in com.mindee.pdf: Allows performing various operations on PDFs.
PDFInputOperator() - Constructor for class com.mindee.pdf.PDFInputOperator
pdfOperation - Variable in class com.mindee.v1.MindeeClient
PDFPageImage - Class in com.mindee.image: A page in a PDF extracted as an image.
PDFPageImage(BufferedImage, int, String, String) - Constructor for class com.mindee.image.PDFPageImage
PDFRasterization - Interface in com.mindee.image: Rasterize a PDF into images.
PDFRasterizer - Class in com.mindee.image: Default PDF rasterization implementation.
PDFRasterizer() - Constructor for class com.mindee.image.PDFRasterizer
PDFToImages(byte[], String) - Method in interface com.mindee.image.PDFRasterization: Rasterize a PDF into a list of images, one image per page.
PDFToImages(byte[], String) - Method in class com.mindee.image.PDFRasterizer
personalNumber - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The unique identifier assigned to the document holder.
placeOfBirth - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: The place of birth of the driver license holder.
Point - Class in com.mindee.geometry: A relative set of coordinates (X, Y) on the document.
Point(Double, Double) - Constructor for class com.mindee.geometry.Point
Point.PointBuilder - Class in com.mindee.geometry
PollingOptions - Class in com.mindee.v1.clientoptions
PollingOptions - Class in com.mindee.v2.clientoptions
PollingOptions(Double, Double, Integer) - Constructor for class com.mindee.v1.clientoptions.PollingOptions
PollingOptions(Double, Double, Integer) - Constructor for class com.mindee.v2.clientoptions.PollingOptions
PollingOptions.PollingOptionsBuilder - Class in com.mindee.v1.clientoptions
PollingOptions.PollingOptionsBuilder - Class in com.mindee.v2.clientoptions
polygon(Boolean) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters.Builder: Calculate bounding box polygons for all fields.
Polygon - Class in com.mindee.geometry: Contains any number of vertex coordinates (Points).
Polygon(Collection<List<Double>>) - Constructor for class com.mindee.geometry.Polygon: Create a Polygon from a list of a list of floats.
Polygon(List<Point>) - Constructor for class com.mindee.geometry.Polygon: Create a Polygon from a list of Points.
PolygonDeserializer - Class in com.mindee.geometry: JSON deserializer for polygons.
PolygonDeserializer() - Constructor for class com.mindee.geometry.PolygonDeserializer
PolygonDeserializer(Class<?>) - Constructor for class com.mindee.geometry.PolygonDeserializer
PolygonUtils - Class in com.mindee.geometry: Methods for working with Polygons.
poNumber - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The purchase order number, only if the document is an invoice.
poNumber - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The purchase order number.
PositionDataField - Interface in com.mindee.geometry: A field with position data.
PositionField - Class in com.mindee.v1.parsing.standard: A detected element in the image.
PositionField() - Constructor for class com.mindee.v1.parsing.standard.PositionField
predictAsyncPost(Class<DocT>, Endpoint, RequestParameters) - Method in class com.mindee.v1.http.MindeeApiV1: Send a file to the prediction queue.
predictAsyncPost(Class<DocT>, Endpoint, RequestParameters) - Method in class com.mindee.v1.http.MindeeHttpApiV1: POST a prediction request for a custom product.
Prediction - Class in com.mindee.v1.parsing.common: Base class for all predictions.
Prediction() - Constructor for class com.mindee.v1.parsing.common.Prediction
predictOptions(PredictOptions) - Method in class com.mindee.v1.http.RequestParameters.RequestParametersBuilder
PredictOptions - Class in com.mindee.v1.clientoptions: Parameters for making predict API calls.
PredictOptions.PredictOptionsBuilder - Class in com.mindee.v1.clientoptions
predictPost(Class<DocT>, Endpoint, RequestParameters) - Method in class com.mindee.v1.http.MindeeApiV1: Send a file to the prediction API.
predictPost(Class<DocT>, Endpoint, RequestParameters) - Method in class com.mindee.v1.http.MindeeHttpApiV1: POST a prediction request for a custom product.
PredictResponse<T extends Inference> - Class in com.mindee.v1.parsing.common: Represent a `predict` response from Mindee API.
PredictResponse() - Constructor for class com.mindee.v1.parsing.common.PredictResponse
priority(ExecutionPriority) - Method in class com.mindee.v1.clientoptions.WorkflowOptions.WorkflowOptionsBuilder
Product - Class in com.mindee.v1.parsing.common: The product on which the document was parsed.
Product() - Constructor for class com.mindee.v1.parsing.common.Product
ProductCommandHandler(CommandLineInterfaceProducts, Method) - Constructor for class com.mindee.v1.CommandLineInterface.ProductCommandHandler: Reads all products from the CommandLineInterfaceProducts file and makes them accessible.
ProductInfo - Annotation Type in com.mindee.v2.http: Base info for all v2 products.
ProductProcessor - Interface in com.mindee.v1.cli: Interface to process CLI products.
publicUrl(String) - Method in class com.mindee.v1.clientoptions.WorkflowOptions.WorkflowOptionsBuilder

Q

q - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's power to weight ratio.

R

rag(Boolean) - Method in class com.mindee.v1.clientoptions.PredictOptions.PredictOptionsBuilder
rag(Boolean) - Method in class com.mindee.v1.clientoptions.WorkflowOptions.WorkflowOptionsBuilder
rag(Boolean) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters.Builder: Enhance extraction accuracy with Retrieval-Augmented Generation.
Rag - Class in com.mindee.v1.parsing.common: Retrieval-Augmented Generation info class.
Rag() - Constructor for class com.mindee.v1.parsing.common.Rag
RagMetadata - Class in com.mindee.v2.parsing.inference: RAG metadata.
RagMetadata() - Constructor for class com.mindee.v2.parsing.inference.RagMetadata
RagMetadata(String) - Constructor for class com.mindee.v2.parsing.inference.RagMetadata: Creates a new RagMetadata instance.
rawText(Boolean) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters.Builder: Extract the full text content from the document as strings.
RawText - Class in com.mindee.v2.parsing.inference: Raw text as found in the document.
RawText() - Constructor for class com.mindee.v2.parsing.inference.RawText
RawText(List<RawTextPage>) - Constructor for class com.mindee.v2.parsing.inference.RawText: Creates a new RawText instance.
RawTextPage - Class in com.mindee.v2.parsing.inference: Raw text extracted from the page.
RawTextPage() - Constructor for class com.mindee.v2.parsing.inference.RawTextPage
RawTextPage(String) - Constructor for class com.mindee.v2.parsing.inference.RawTextPage: Creates a new RawTextPage instance.
readRawResponse(HttpEntity) - Method in class com.mindee.http.MindeeApiCommon
receiptNumber - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The receipt number or identifier only if document is a receipt.
receiptNumber - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The receipt number or identifier.
receipts - Variable in class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document: Positions of the receipts on the document.
ReceiptV5 - Class in com.mindee.v1.product.receipt: Receipt API version 5 inference prediction.
ReceiptV5() - Constructor for class com.mindee.v1.product.receipt.ReceiptV5
ReceiptV5Document - Class in com.mindee.v1.product.receipt: Receipt API version 5.4 document data.
ReceiptV5Document() - Constructor for class com.mindee.v1.product.receipt.ReceiptV5Document
ReceiptV5LineItem - Class in com.mindee.v1.product.receipt: List of all line items on the receipt.
ReceiptV5LineItem() - Constructor for class com.mindee.v1.product.receipt.ReceiptV5LineItem
referenceNumbers - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of Reference numbers, including PO number, only if the document is an invoice.
referenceNumbers - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: List of all reference numbers on the invoice, including the purchase order number.
REMOVE - com.mindee.input.PageOptionsOperation: Remove the specified pages, keeping all others.
removeAlphaChannel(BufferedImage) - Static method in class com.mindee.image.ImageCompressor
reqGetJob(String) - Method in class com.mindee.v2.http.MindeeApiV2: Attempts to poll the queue.
reqGetJob(String) - Method in class com.mindee.v2.http.MindeeHttpApiV2
reqGetResult(Class<TResponse>, String) - Method in class com.mindee.v2.http.MindeeApiV2: Retrieves the inference from a 302 redirect.
reqGetResult(Class<TResponse>, String) - Method in class com.mindee.v2.http.MindeeHttpApiV2
reqGetSearchModels(String, String) - Method in class com.mindee.v2.http.MindeeApiV2: Retrieves a list of models.
reqGetSearchModels(String, String) - Method in class com.mindee.v2.http.MindeeHttpApiV2
reqPostEnqueue(LocalInputSource, BaseParameters) - Method in class com.mindee.v2.http.MindeeApiV2: Send a file to the prediction queue with a local file.
reqPostEnqueue(LocalInputSource, BaseParameters) - Method in class com.mindee.v2.http.MindeeHttpApiV2: Enqueues a doc with the POST method.
reqPostEnqueue(URLInputSource, BaseParameters) - Method in class com.mindee.v2.http.MindeeApiV2: Send a file to the prediction queue with a remote file.
reqPostEnqueue(URLInputSource, BaseParameters) - Method in class com.mindee.v2.http.MindeeHttpApiV2: Enqueues a doc with the POST method.
RequestParameters - Class in com.mindee.v1.http: Parameters for making API calls to the endpoint.
RequestParameters.RequestParametersBuilder - Class in com.mindee.v1.http
resize(BufferedImage, Integer, Integer) - Static method in class com.mindee.image.ImageCompressor
result - Variable in class com.mindee.v2.parsing.BaseInference: Result of the inference.

S

s1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's number of seats.
s2 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's number of standing rooms (person).
saveAllToDisk(String) - Method in class com.mindee.image.ExtractedImages
saveAllToDisk(Path) - Method in class com.mindee.image.ExtractedImages
saveToFile(String) - Method in class com.mindee.input.URLInputSource: Fetches the file from the URL and saves it to the specified filepath.
SearchModel - Class in com.mindee.v2.parsing.search: Models search response.
SearchModel() - Constructor for class com.mindee.v2.parsing.search.SearchModel
SearchModel(String, String, String, List<ModelWebhook>) - Constructor for class com.mindee.v2.parsing.search.SearchModel: Creates a new SearchModel instance.
searchModels() - Method in class com.mindee.v2.MindeeClient: Return all models.
searchModels(String) - Method in class com.mindee.v2.MindeeClient: Search for models by name.
searchModels(String, String) - Method in class com.mindee.v2.MindeeClient: Search for models by name and type.
SearchResponse - Class in com.mindee.v2.parsing.search: Models search response.
SearchResponse() - Constructor for class com.mindee.v2.parsing.search.SearchResponse
SearchResponse(List<SearchModel>, PaginationMetadata) - Constructor for class com.mindee.v2.parsing.search.SearchResponse
self() - Method in class com.mindee.v2.clientoptions.BaseParameters.BaseBuilder
setApiRequest(ApiRequest) - Method in class com.mindee.v1.parsing.common.ApiResponse: Information from Mindee about the api request.
setConfidence(FieldConfidence) - Method in class com.mindee.v2.parsing.inference.field.BaseField: Confidence associated with the field.
setDocument(Document<T>) - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse: Set the prediction model used to parse the document.
setDocument(Document<T>) - Method in class com.mindee.v1.parsing.common.PredictResponse: Set the prediction model used to parse the document.
setExecution(Execution<DocT>) - Method in class com.mindee.v1.parsing.common.WorkflowResponse: Set the prediction model used to parse the document.
setFullTextOcr(FullTextOcr) - Method in class com.mindee.v1.parsing.common.Extras: Full Text OCR result.
setFullTextOcr(String) - Method in class com.mindee.v1.parsing.common.InferenceExtras: Full Text OCR result.
setJob(Job) - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse: Details for the submitted job.
setJob(Job) - Method in class com.mindee.v2.parsing.JobResponse: Representation of the Job.
setLocations(List<FieldLocation>) - Method in class com.mindee.v2.parsing.inference.field.BaseField: Field's location.
setMatchingDocumentId(String) - Method in class com.mindee.v1.parsing.common.Rag: The document ID that was matched.
setRag(Rag) - Method in class com.mindee.v1.parsing.common.InferenceExtras: Retrieval-Augmented Generation results.
setRawResponse(String) - Method in class com.mindee.v1.parsing.common.ApiResponse
setRawResponse(String) - Method in class com.mindee.v2.parsing.CommonResponse: The raw server response.
sex - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The biological sex of the document holder.
shippingAddress - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The customer's address used for shipping.
shippingAddress - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: Customer's delivery address.
SIMPLE_FIELD - com.mindee.v2.parsing.inference.field.DynamicField.FieldType
SimpleField - Class in com.mindee.v2.parsing.inference.field: Field holding a single scalar value.
SimpleField(Object, FieldConfidence, List<FieldLocation>) - Constructor for class com.mindee.v2.parsing.inference.field.SimpleField
SimpleFieldDeserializer - Class in com.mindee.v2.parsing.inference.field: Custom deserializer for SimpleField.
SimpleFieldDeserializer() - Constructor for class com.mindee.v2.parsing.inference.field.SimpleFieldDeserializer
slug() - Method in annotation type com.mindee.v2.http.ProductInfo
sourcePdf - Variable in class com.mindee.pdf.BasePDFExtractor
split(byte[], PageOptions) - Method in interface com.mindee.pdf.PDFInputOperation: Split a PDF file.
split(byte[], PageOptions) - Method in class com.mindee.pdf.PDFInputOperator
Split - Class in com.mindee.v2.fileoperations
Split(LocalInputSource) - Constructor for class com.mindee.v2.fileoperations.Split
SplitInference - Class in com.mindee.v2.product.split: The inference result for a split utility request.
SplitInference() - Constructor for class com.mindee.v2.product.split.SplitInference
splitNameStrict(String) - Static method in class com.mindee.input.InputSourceUtils: Split the filename into a name and an extension.
SplitParameters - Class in com.mindee.v2.product.split.params
SplitParameters(String, String, String[]) - Constructor for class com.mindee.v2.product.split.params.SplitParameters
SplitParameters.Builder - Class in com.mindee.v2.product.split.params
SplitPDF - Class in com.mindee.pdf: The split PDF.
SplitPDF(byte[], int) - Constructor for class com.mindee.pdf.SplitPDF: Creates a new SplitPDF instance.
SplitRange - Class in com.mindee.v2.product.split: A single document as identified when splitting a multi-document source file.
SplitRange() - Constructor for class com.mindee.v2.product.split.SplitRange
SplitRange(List<Integer>, String, ExtractionResponse) - Constructor for class com.mindee.v2.product.split.SplitRange: Creates a new SplitRange instance.
SplitResponse - Class in com.mindee.v2.product.split: Response for a crop utility inference.
SplitResponse() - Constructor for class com.mindee.v2.product.split.SplitResponse
SplitResult - Class in com.mindee.v2.product.split: Result of the document splitter inference.
SplitResult() - Constructor for class com.mindee.v2.product.split.SplitResult
SplitResult(ArrayList<SplitRange>) - Constructor for class com.mindee.v2.product.split.SplitResult: Creates a new SplitResult instance.
standardProductAsyncOutput(Class<T>, File) - Method in interface com.mindee.v1.cli.ProductProcessor: Process a product asynchronously.
standardProductAsyncOutput(Class<T>, File) - Method in class com.mindee.v1.CommandLineInterface
standardProductOutput(Class<T>, File) - Method in interface com.mindee.v1.cli.ProductProcessor: Process a product synchronously.
standardProductOutput(Class<T>, File) - Method in class com.mindee.v1.CommandLineInterface
state - Variable in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document: Second part of the ISO 3166-2 code, consisting of two letters indicating the US State.
stateOfIssue - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The state or territory where the document was issued.
StringField - Class in com.mindee.v1.parsing.standard: Represent a string field.
StringField(String, Double, Polygon) - Constructor for class com.mindee.v1.parsing.standard.StringField
StringField(String, String, Double, Polygon, Integer) - Constructor for class com.mindee.v1.parsing.standard.StringField
subcategory - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The purchase subcategory for transport, food and shooping.
subcategory - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The purchase subcategory for transport, food and shopping.
subcategory - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The purchase subcategory of the receipt for transport and food.
SummaryHelper - Class in com.mindee.parsing: Various static methods to help generate the prediction summaries.
SummaryHelper() - Constructor for class com.mindee.parsing.SummaryHelper
SummaryHelperV1 - Class in com.mindee.v1.parsing: Various static methods to help generate the prediction summaries.
SummaryHelperV1() - Constructor for class com.mindee.v1.parsing.SummaryHelperV1
supplierAddress - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The address of the supplier or merchant.
supplierAddress - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The address of the supplier or merchant.
supplierAddress - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The address of the supplier or merchant.
supplierCompanyRegistrations - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of company registration numbers associated to the supplier.
supplierCompanyRegistrations - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: List of company registration numbers associated to the supplier.
supplierCompanyRegistrations - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: List of company registration numbers associated to the supplier.
supplierEmail - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The email of the supplier or merchant.
supplierEmail - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The email address of the supplier or merchant.
supplierName - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The name of the supplier or merchant.
supplierName - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The name of the supplier or merchant.
supplierName - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The name of the supplier or merchant.
supplierPaymentDetails - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of payment details associated to the supplier (only for invoices).
supplierPaymentDetails - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: List of payment details associated to the supplier of the invoice.
supplierPhoneNumber - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The phone number of the supplier or merchant.
supplierPhoneNumber - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The phone number of the supplier or merchant.
supplierPhoneNumber - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The phone number of the supplier or merchant.
supplierWebsite - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The website URL of the supplier or merchant.
supplierWebsite - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The website URL of the supplier or merchant.
surname - Variable in class com.mindee.v1.product.fr.idcard.IdCardV1Document: The surname of the card holder.
surname - Variable in class com.mindee.v1.product.fr.idcard.IdCardV2Document: The surname of the card holder.
surname - Variable in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document: The surname of the passport holder.
surname - Variable in class com.mindee.v1.product.passport.PassportV1Document: The surname of the passport holder.
surnames - Variable in class com.mindee.v1.product.internationalid.InternationalIdV2Document: The list of the document holder's family names.
swiftCode - Variable in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document: Full extraction of the SWIFT code.

T

taxes - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: List of all taxes on the document.
taxes - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: List of taxes.
taxes - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The list of taxes present on the receipt.
Taxes - Class in com.mindee.v1.parsing.standard: Represent all the tax lines.
Taxes() - Constructor for class com.mindee.v1.parsing.standard.Taxes
TaxesDeserializer - Class in com.mindee.v1.parsing.standard: JSON deserializer for custom documents v1.x.
TaxesDeserializer() - Constructor for class com.mindee.v1.parsing.standard.TaxesDeserializer
TaxesDeserializer(Class<?>) - Constructor for class com.mindee.v1.parsing.standard.TaxesDeserializer
TaxField - Class in com.mindee.v1.parsing.standard: Represent a tax line.
TaxField(Double, String, Double, Double) - Constructor for class com.mindee.v1.parsing.standard.TaxField
textContext(String) - Method in class com.mindee.v2.product.extraction.params.ExtractionParameters.Builder: Provide additional text context used by the model during inference.
time - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The time the purchase was made (only for receipts).
time - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The time the purchase was made.
tip - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The total amount of tip and gratuity.
tip - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The total amount of tip and gratuity.
toFieldList() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban: Output the object in a format suitable for inclusion in an rST field list.
toJson() - Method in enum com.mindee.v2.parsing.inference.field.FieldConfidence
toLines() - Method in class com.mindee.v1.parsing.common.ocr.OcrPage: Order all the words on the page into lines.
toLocalInputSource() - Method in class com.mindee.input.URLInputSource: Create a LocalInputSource instance from this object.
toString() - Method in class com.mindee.geometry.Point.PointBuilder
toString() - Method in class com.mindee.geometry.Point
toString() - Method in class com.mindee.geometry.Polygon: Default string representation.
toString() - Method in class com.mindee.input.PageOptions
toString() - Method in class com.mindee.pdf.SplitPDF
toString() - Method in class com.mindee.v1.clientoptions.PollingOptions.PollingOptionsBuilder
toString() - Method in class com.mindee.v1.clientoptions.PredictOptions.PredictOptionsBuilder
toString() - Method in class com.mindee.v1.clientoptions.PredictOptions
toString() - Method in class com.mindee.v1.clientoptions.WorkflowOptions
toString() - Method in class com.mindee.v1.clientoptions.WorkflowOptions.WorkflowOptionsBuilder
toString() - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
toString() - Method in exception com.mindee.v1.http.MindeeHttpExceptionV1
toString() - Method in class com.mindee.v1.http.RequestParameters.RequestParametersBuilder
toString() - Method in class com.mindee.v1.http.RequestParameters
toString() - Method in class com.mindee.v1.parsing.common.ApiRequest
toString() - Method in class com.mindee.v1.parsing.common.ApiResponse
toString() - Method in class com.mindee.v1.parsing.common.AsyncPredictResponse
toString() - Method in class com.mindee.v1.parsing.common.Document
toString() - Method in class com.mindee.v1.parsing.common.Error
toString() - Method in class com.mindee.v1.parsing.common.ErrorDetails
toString() - Method in class com.mindee.v1.parsing.common.Execution
toString() - Method in class com.mindee.v1.parsing.common.ExecutionFile
toString() - Method in class com.mindee.v1.parsing.common.Inference
toString() - Method in class com.mindee.v1.parsing.common.ocr.MvisionV1
toString() - Method in class com.mindee.v1.parsing.common.ocr.Ocr
toString() - Method in class com.mindee.v1.parsing.common.ocr.OcrPage
toString() - Method in class com.mindee.v1.parsing.common.Page
toString() - Method in class com.mindee.v1.parsing.common.Pages
toString() - Method in class com.mindee.v1.parsing.common.PredictResponse
toString() - Method in class com.mindee.v1.parsing.common.WorkflowResponse
toString() - Method in class com.mindee.v1.parsing.standard.AmountField
toString() - Method in class com.mindee.v1.parsing.standard.BooleanField: The value of the field.
toString() - Method in class com.mindee.v1.parsing.standard.ClassificationField
toString() - Method in class com.mindee.v1.parsing.standard.CompanyRegistrationField
toString() - Method in class com.mindee.v1.parsing.standard.DateField: The value of the field.
toString() - Method in class com.mindee.v1.parsing.standard.LocaleField
toString() - Method in class com.mindee.v1.parsing.standard.PaymentDetailsField
toString() - Method in class com.mindee.v1.parsing.standard.PositionField
toString() - Method in class com.mindee.v1.parsing.standard.StringField
toString() - Method in class com.mindee.v1.parsing.standard.Taxes: Default string representation.
toString() - Method in class com.mindee.v1.parsing.standard.TaxField
toString() - Method in class com.mindee.v1.product.barcodereader.BarcodeReaderV1Document
toString() - Method in class com.mindee.v1.product.cropper.CropperV1Document
toString() - Method in class com.mindee.v1.product.cropper.CropperV1Page
toString() - Method in class com.mindee.v1.product.driverlicense.DriverLicenseV1Document
toString() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document
toString() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem
toString() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Bban
toString() - Method in class com.mindee.v1.product.fr.bankaccountdetails.BankAccountDetailsV2Document
toString() - Method in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document
toString() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Document
toString() - Method in class com.mindee.v1.product.fr.idcard.IdCardV1Page
toString() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Document
toString() - Method in class com.mindee.v1.product.fr.idcard.IdCardV2Page
toString() - Method in class com.mindee.v1.product.generated.GeneratedV1Document
toString() - Method in class com.mindee.v1.product.ind.indianpassport.IndianPassportV1Document
toString() - Method in class com.mindee.v1.product.internationalid.InternationalIdV2Document
toString() - Method in class com.mindee.v1.product.invoice.InvoiceV4Document
toString() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem
toString() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1Document
toString() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1InvoicePageGroup
toString() - Method in class com.mindee.v1.product.multireceiptsdetector.MultiReceiptsDetectorV1Document
toString() - Method in class com.mindee.v1.product.passport.PassportV1Document
toString() - Method in class com.mindee.v1.product.receipt.ReceiptV5Document
toString() - Method in class com.mindee.v1.product.receipt.ReceiptV5LineItem
toString() - Method in class com.mindee.v2.clientoptions.BaseParameters
toString() - Method in class com.mindee.v2.clientoptions.PollingOptions.PollingOptionsBuilder
toString() - Method in class com.mindee.v2.http.MindeeHttpApiV2.MindeeHttpApiV2Builder
toString() - Method in exception com.mindee.v2.http.MindeeHttpExceptionV2
toString() - Method in class com.mindee.v2.MindeeSettings.MindeeSettingsBuilder
toString() - Method in class com.mindee.v2.parsing.BaseInference
toString() - Method in class com.mindee.v2.parsing.CommonResponse
toString() - Method in class com.mindee.v2.parsing.error.ErrorResponse: For prettier display.
toString() - Method in class com.mindee.v2.parsing.inference.DataSchemaActiveOptions
toString() - Method in class com.mindee.v2.parsing.inference.field.BaseField
toString() - Method in class com.mindee.v2.parsing.inference.field.DynamicField
toString() - Method in class com.mindee.v2.parsing.inference.field.FieldLocation
toString() - Method in class com.mindee.v2.parsing.inference.field.InferenceFields
toString() - Method in class com.mindee.v2.parsing.inference.field.ListField
toString() - Method in class com.mindee.v2.parsing.inference.field.ObjectField
toString() - Method in class com.mindee.v2.parsing.inference.field.SimpleField
toString() - Method in class com.mindee.v2.parsing.inference.InferenceActiveOptions
toString() - Method in class com.mindee.v2.parsing.inference.InferenceFile
toString() - Method in class com.mindee.v2.parsing.inference.InferenceJob
toString() - Method in class com.mindee.v2.parsing.inference.InferenceModel
toString() - Method in class com.mindee.v2.parsing.inference.RawText
toString() - Method in class com.mindee.v2.parsing.inference.RawTextPage: Page contents as a string.
toString() - Method in class com.mindee.v2.parsing.JobResponse
toString() - Method in class com.mindee.v2.parsing.search.PaginationMetadata: String representation of the pagination metadata.
toString() - Method in class com.mindee.v2.parsing.search.SearchModel
toString() - Method in class com.mindee.v2.parsing.search.SearchResponse: String representation of the search response.
toString() - Method in class com.mindee.v2.product.classification.ClassificationClassifier
toString() - Method in class com.mindee.v2.product.classification.ClassificationResult
toString() - Method in class com.mindee.v2.product.crop.CropItem
toString() - Method in class com.mindee.v2.product.crop.CropResult
toString() - Method in class com.mindee.v2.product.extraction.ExtractionInference
toString() - Method in class com.mindee.v2.product.extraction.ExtractionResult
toString() - Method in class com.mindee.v2.product.ocr.OcrResult
toString() - Method in class com.mindee.v2.product.split.SplitResult
toString(int) - Method in class com.mindee.v2.parsing.inference.field.InferenceFields
toStringBase() - Method in class com.mindee.v2.parsing.BaseInference
toStringFromList() - Method in class com.mindee.v2.parsing.inference.field.ObjectField
toStringPrecise() - Method in class com.mindee.geometry.Polygon: String representation with precise coordinates.
toTableLine() - Method in class com.mindee.v1.parsing.standard.CompanyRegistrationField: Output the line in a format suitable for inclusion in an rST table.
toTableLine() - Method in interface com.mindee.v1.parsing.standard.LineItemField
toTableLine() - Method in class com.mindee.v1.parsing.standard.TaxField: Output the line in a format suitable for inclusion in an rST table.
toTableLine() - Method in class com.mindee.v1.product.financialdocument.FinancialDocumentV1LineItem: Output the line in a format suitable for inclusion in an rST table.
toTableLine() - Method in class com.mindee.v1.product.invoice.InvoiceV4LineItem: Output the line in a format suitable for inclusion in an rST table.
toTableLine() - Method in class com.mindee.v1.product.invoicesplitter.InvoiceSplitterV1InvoicePageGroup: Output the line in a format suitable for inclusion in an rST table.
toTableLine() - Method in class com.mindee.v1.product.receipt.ReceiptV5LineItem: Output the line in a format suitable for inclusion in an rST table.
totalAmount - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The total amount paid: includes taxes, tips, fees, and other charges.
totalAmount - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The total amount of the invoice: includes taxes, tips, fees, and other charges.
totalAmount - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The total amount paid: includes taxes, discounts, fees, tips, and gratuity.
totalNet - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The net amount paid: does not include taxes, fees, and discounts.
totalNet - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The net amount of the invoice: does not include taxes, fees, and discounts.
totalNet - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The net amount paid: does not include taxes, fees, and discounts.
totalTax - Variable in class com.mindee.v1.product.financialdocument.FinancialDocumentV1Document: The sum of all taxes present on the document.
totalTax - Variable in class com.mindee.v1.product.invoice.InvoiceV4Document: The total tax: the sum of all the taxes for this invoice.
totalTax - Variable in class com.mindee.v1.product.receipt.ReceiptV5Document: The sum of all taxes.

U

u1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's sound level (dB).
u2 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle engine's rotation speed (RPM).
urlFromEndpoint(Function<Endpoint, String>) - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
urlInputSource(URLInputSource) - Method in class com.mindee.v1.http.RequestParameters.RequestParametersBuilder
URLInputSource - Class in com.mindee.input: Input source wrapper to load remote files locally.
URLInputSource.Builder - Class in com.mindee.input: Builder class for an URLInputSource.

V

v7 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: The vehicle's CO2 emission (g/km).
validateSecure() - Method in class com.mindee.input.URLInputSource: Ensures the URL can be sent to the Mindee server.
valueOf(String) - Static method in enum com.mindee.input.PageOptionsOperation: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mindee.v1.parsing.common.ExecutionPriority: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mindee.v2.parsing.inference.field.DynamicField.FieldType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.mindee.v2.parsing.inference.field.FieldConfidence: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.mindee.input.PageOptionsOperation: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mindee.v1.parsing.common.ExecutionPriority: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mindee.v2.parsing.inference.field.DynamicField.FieldType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.mindee.v2.parsing.inference.field.FieldConfidence: Returns an array containing the constants of this enum type, in the order they are declared.
version() - Method in annotation type com.mindee.v1.http.CustomEndpointInfo: The version number of the API.
version() - Method in annotation type com.mindee.v1.http.EndpointInfo

W

webhookIds - Variable in class com.mindee.v2.clientoptions.BaseParameters.BaseBuilder
webhookIds - Variable in class com.mindee.v2.clientoptions.BaseParameters: Webhook IDs to call after all processing is finished.
webhookIds(String[]) - Method in class com.mindee.v2.clientoptions.BaseParameters.BaseBuilder: Provide IDs of webhooks to forward the API response to.
width - Variable in class com.mindee.image.ImageUtils.Dimensions
withCredentials(String, String) - Method in class com.mindee.input.URLInputSource.Builder: Builder method to set the username and password for remote authentication.
withLocalFilename(String) - Method in class com.mindee.input.URLInputSource.Builder: Builder method to set the local filename for the downloaded file.
withToken(String) - Method in class com.mindee.input.URLInputSource.Builder: Builder method to set the token for remote access.
Word - Class in com.mindee.v1.parsing.common.ocr: Represents a word.
Word() - Constructor for class com.mindee.v1.parsing.common.ocr.Word
workflowId(String) - Method in class com.mindee.v1.clientoptions.PredictOptions.PredictOptionsBuilder
workflowOptions(WorkflowOptions) - Method in class com.mindee.v1.http.RequestParameters.RequestParametersBuilder
WorkflowOptions - Class in com.mindee.v1.clientoptions: Workflow-specific options.
WorkflowOptions.WorkflowOptionsBuilder - Class in com.mindee.v1.clientoptions
WorkflowResponse<DocT extends Inference> - Class in com.mindee.v1.parsing.common: Represents the server response after a document is sent to a workflow.
WorkflowResponse() - Constructor for class com.mindee.v1.parsing.common.WorkflowResponse
WorkflowResponse.Default - Class in com.mindee.v1.parsing.common: Default product is GeneratedV1.
workflowUrlFromEndpoint(Function<String, String>) - Method in class com.mindee.v1.http.MindeeHttpApiV1.MindeeHttpApiV1Builder
writeToFile(String) - Method in class com.mindee.image.ExtractedImage: Write the image to a file.
writeToFile(String) - Method in class com.mindee.image.PDFPageImage: Write the image to a file.
writeToFile(String) - Method in class com.mindee.pdf.ExtractedPDF: Write the PDF to a file.
writeToFile(Path) - Method in class com.mindee.image.ExtractedImage: Write the image to a file.

X

x(Double) - Method in class com.mindee.geometry.Point.PointBuilder
x1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Next technical control date.

Y

y(Double) - Method in class com.mindee.geometry.Point.PointBuilder
y1 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the regional proportional tax of the registration (in euros).
y2 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the additional parafiscal tax of the registration (in euros).
y3 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the additional CO2 tax of the registration (in euros).
y4 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the fee for managing the registration (in euros).
y5 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Amount of the fee for delivery of the registration certificate in euros.
y6 - Variable in class com.mindee.v1.product.fr.cartegrise.CarteGriseV1Document: Total amount of registration fee to be paid in euros.

A B C D E F G H I J K L M N O P Q R S T U V W X Y
All Classes All Packages