Application
Table of Contents
Classes
- PollingOptions
- Handles options tied to asynchronous parsing.
- DependencyChecker
- Utility class to check the availability of potentially incompatible libraries.
- ErrorCode
- Enum class holding error codes for exceptions.
- MindeeApiException
- Exceptions relating to library issues.
- MindeeException
- Global Mindee Exception.
- MindeeGeometryException
- Exceptions relating to geometric manipulation issues.
- MindeeImageException
- Exceptions relating to the handling of images.
- MindeeInputException
- Input exceptions.
- MindeeMimeTypeException
- Exceptions relating to mime type issues.
- MindeePdfException
- Exceptions relating to the handling of PDF documents.
- MindeeSourceException
- Exceptions relating to sources (documents) handling.
- MindeeUnhandledException
- Exceptions relating to missing dependencies.
- MindeeUnsetException
- Exceptions relating to products containing unset fields.
- BBox
- Bounding box represented as a set of minimum and maximum values for the x and y axes.
- BBoxUtils
- Utility class for BBox.
- MinMax
- Set of minimum and maximum values.
- MinMaxUtils
- Utility class for MinMax.
- Point
- Representation of the coordinates of a point.
- Polygon
- Polygon represented as a set of coordinates (vertices/points).
- PolygonUtils
- Utility class for Polygon.
- ExtractedImage
- An extracted sub-image.
- ImageCompressor
- Image compressor class to handle image compression.
- ImageExtractor
- Extract sub-images from an image.
- ImageUtils
- Miscellaneous image operations.
- Base64Input
- Base64-encoded text input.
- BytesInput
- Raw bytes input.
- FileInput
- Binary file input.
- InputSource
- Base class for input sources.
- LocalInputSource
- Base class for all input sources coming from the local machine.
- LocalResponse
- Local response loaded from a file.
- PageOptions
- Options for page handling (PDF only).
- PathInput
- Local path input.
- UrlInputSource
- A local or distant URL input.
- SummaryHelper
- Base utility class to handle information display.
- CustomFpdi
- Custom wrapper to add text rotation to FPDI.
- ExtractedPdf
- An extracted sub-Pdf.
- PdfCompressor
- PDF compression class.
- PdfExtractor
- PDF extraction class.
- PdfUtils
- PDF utility class.
- Client
- Main entrypoint for Mindee operations.
- CommonOptions
- Common base for regular prediction options and workflow options.
- PredictMethodOptions
- Handles options tied to prediction method.
- PredictOptions
- Handles options tied to Predictions.
- WorkflowOptions
- Handles options tied to Workflows.
- MindeeV1ClientException
- Exceptions relating to the Mindee client.
- MindeeV1HttpException
- Exceptions relating to HTTP calls.
- BaseApi
- Base class for API settings.
- BaseEndpoint
- Abstract class for endpoints.
- Endpoint
- Endpoint management.
- MindeeApi
- Data class containing settings for endpoints.
- MindeeWorkflowApi
- Data class containing settings for workflows.
- ResponseValidation
- Wrapper class for http requests/responses validation handling.
- WorkflowEndpoint
- Workflow router endpoint substitute.
- ImageExtractor
- Wrapper class for V1 of the BaseImageExtractor.
- ApiRequest
- Information on the API request made to the server.
- ApiResponse
- Base class for API responses.
- AsyncPredictResponse
- Async Response Wrapper class for a Predict response.
- Document
- Base class for all predictions.
- Execution
- Representation of a workflow execution.
- ExecutionFile
- Representation of a workflow execution's file data.
- CropperExtra
- Contains information on the cropping of a prediction.
- Extras
- Extras collection wrapper class.
- FullTextOcrExtra
- Full Text Ocr result.
- RagExtra
- Contains information on the Retrieval-Augmented-Generation of a prediction.
- Inference
- Base Inference class for all predictions.
- Job
- Job class for asynchronous requests.
- MVisionV1
- Mindee Vision V1.
- Ocr
- Ocr extraction from the entire document.
- OcrLine
- A list of words which are on the same line.
- OcrPage
- Ocr extraction for a single page.
- OcrWord
- A single word.
- OrientationField
- The clockwise rotation to apply (in degrees) to make the image upright.
- Page
- Base Page object for predictions.
- Prediction
- Base class for prediction responses.
- PredictResponse
- Response of a prediction request.
- Product
- Class for keeping track of a product's info.
- WorkflowResponse
- Represents the server response after a document is sent to a workflow.
- GeneratedListField
- A list of value or words for generated APIs.
- GeneratedObjectField
- A JSON-like object, with miscellaneous values.
- AddressField
- A field representing an address.
- AmountField
- A field containing an amount value.
- BaseField
- Base class for most fields.
- BooleanField
- A field containing a boolean value.
- ClassificationField
- Represents a classifier value.
- CompanyRegistrationField
- A company registration item.
- DateField
- A field containing a date value.
- LocaleField
- The locale detected on the document.
- PaymentDetailsField
- Information on a single payment.
- PositionField
- A field indicating a position or area on the document.
- StringField
- A field containing a text value.
- Taxes
- List of tax lines information.
- TaxField
- Tax line information.
- SummaryHelperV1
- Utility class to handle information display.
- PdfExtractor
- PDF extraction class.
- BarcodeReaderV1
- Barcode Reader API version 1 inference prediction.
- BarcodeReaderV1Document
- Barcode Reader API version 1.0 document data.
- BusinessCardV1
- Business Card API version 1 inference prediction.
- BusinessCardV1Document
- Business Card API version 1.0 document data.
- CropperV1
- Cropper API version 1 inference prediction.
- CropperV1Document
- Cropper API version 1.1 document data.
- CropperV1Page
- Cropper API version 1.1 page data.
- DriverLicenseV1
- Driver License API version 1 inference prediction.
- DriverLicenseV1Document
- Driver License API version 1.0 document data.
- FinancialDocumentV1
- Financial Document API version 1 inference prediction.
- FinancialDocumentV1Document
- Financial Document API version 1.14 document data.
- FinancialDocumentV1LineItem
- List of line item present on the document.
- FinancialDocumentV1LineItems
- List of line item present on the document.
- BankAccountDetailsV1
- Bank Account Details API version 1 inference prediction.
- BankAccountDetailsV1Document
- Bank Account Details API version 1.0 document data.
- BankAccountDetailsV2
- Bank Account Details API version 2 inference prediction.
- BankAccountDetailsV2Bban
- Full extraction of BBAN, including: branch code, bank code, account and key.
- BankAccountDetailsV2Document
- Bank Account Details API version 2.0 document data.
- CarteGriseV1
- Carte Grise API version 1 inference prediction.
- CarteGriseV1Document
- Carte Grise API version 1.1 document data.
- IdCardV1
- Carte Nationale d'Identité API version 1 inference prediction.
- IdCardV1Document
- Carte Nationale d'Identité API version 1.1 document data.
- IdCardV1Page
- Carte Nationale d'Identité API version 1.1 page data.
- IdCardV2
- Carte Nationale d'Identité API version 2 inference prediction.
- IdCardV2Document
- Carte Nationale d'Identité API version 2.0 document data.
- IdCardV2Page
- Carte Nationale d'Identité API version 2.0 page data.
- GeneratedV1
- Generated document (API Builder) v1 inference results.
- GeneratedV1Document
- Generated V1 document prediction results.
- GeneratedV1Page
- Generated V1 page prediction results.
- GeneratedV1Prediction
- Generated V1 document prediction results.
- InternationalIdV2
- International ID API version 2 inference prediction.
- InternationalIdV2Document
- International ID API version 2.2 document data.
- InvoiceV4
- Invoice API version 4 inference prediction.
- InvoiceV4Document
- Invoice API version 4.11 document data.
- InvoiceV4LineItem
- List of all the line items present on the invoice.
- InvoiceV4LineItems
- List of all the line items present on the invoice.
- InvoiceSplitterV1
- Invoice Splitter API version 1 inference prediction.
- InvoiceSplitterV1Document
- Invoice Splitter API version 1.4 document data.
- InvoiceSplitterV1InvoicePageGroup
- List of page groups. Each group represents a single invoice within a multi-invoice document.
- InvoiceSplitterV1InvoicePageGroups
- List of page groups. Each group represents a single invoice within a multi-invoice document.
- MultiReceiptsDetectorV1
- Multi Receipts Detector API version 1 inference prediction.
- MultiReceiptsDetectorV1Document
- Multi Receipts Detector API version 1.1 document data.
- PassportV1
- Passport API version 1 inference prediction.
- PassportV1Document
- Passport API version 1.1 document data.
- ReceiptV5
- Receipt API version 5 inference prediction.
- ReceiptV5Document
- Receipt API version 5.4 document data.
- ReceiptV5LineItem
- List of all line items on the receipt.
- ReceiptV5LineItems
- List of all line items on the receipt.
- ResumeV1
- Resume API version 1 inference prediction.
- ResumeV1Certificate
- The list of certificates obtained by the candidate.
- ResumeV1Certificates
- The list of certificates obtained by the candidate.
- ResumeV1Document
- Resume API version 1.2 document data.
- ResumeV1Education
- The list of the candidate's educational background.
- ResumeV1Educations
- The list of the candidate's educational background.
- ResumeV1Language
- The list of languages that the candidate is proficient in.
- ResumeV1Languages
- The list of languages that the candidate is proficient in.
- ResumeV1ProfessionalExperience
- The list of the candidate's professional experiences.
- ResumeV1ProfessionalExperiences
- The list of the candidate's professional experiences.
- ResumeV1SocialNetworksUrl
- The list of social network profiles of the candidate.
- ResumeV1SocialNetworksUrls
- The list of social network profiles of the candidate.
- BankCheckV1
- Bank Check API version 1 inference prediction.
- BankCheckV1Document
- Bank Check API version 1.1 document data.
- BankCheckV1Page
- Bank Check API version 1.1 page data.
- Client
- Mindee Client V2.
- BaseParameters
- Base parameters for running an inference.
- MindeeV2HttpException
- Exceptions relating to HTTP errors for the V2 API.
- MindeeV2HttpUnknownException
- Unknown HTTP error for the V2 API.
- Crop
- V2 Crop operation.
- CropFiles
- Cropped files collection wrapper.
- Split
- V2 Split operation.
- SplitFiles
- Split files collection wrapper.
- MindeeApiV2
- Data class containing settings for endpoints.
- ErrorItem
- Explicit details on a problem.
- ErrorResponse
- Error response class.
- BaseInference
- Base for all inference-based V2 products.
- BaseResponse
- Common response base class for V2.
- BaseField
- Base class for V2 fields.
- FieldLocation
- Location of a field.
- InferenceFields
- Collection of inference fields.
- ListField
- A field containing a list of other fields.
- ObjectField
- A field containing a nested set of inference fields.
- SimpleField
- A simple field with a scalar value.
- InferenceActiveOptions
- Options which were activated during the inference.
- InferenceFile
- Inference result file class.
- InferenceJob
- Information on the Job associated to a given Inference.
- InferenceModel
- Inference result model class.
- RagMetadata
- Metadata about the RAG operation.
- RawText
- Raw text as found in the document.
- RawTextPage
- Raw text extracted from the page.
- Job
- Job information for a V2 polling attempt.
- JobResponse
- Job response class.
- JobWebhook
- JobWebhook information.
- ModelWebhook
- Model webhook information.
- PaginationMetadata
- Pagination metadata.
- SearchModel
- Individual model information.
- SearchModels
- Array of search models.
- SearchResponse
- Models search response.
- ClassificationClassifier
- Classification of document type from the source file.
- ClassificationInference
- Classification inference result.
- ClassificationResponse
- Classification response.
- ClassificationResult
- Result of the document classifier inference.
- ClassificationParameters
- Parameters for a classification utility inference.
- CropInference
- The inference result for a crop utility request.
- CropItem
- Result of a cropped document region.
- CropResponse
- Represent a crop response from Mindee V2 API.
- CropResult
- Result of a crop utility inference.
- CropParameters
- Parameters for a crop utility inference.
- ExtractionInference
- ExtractionInference class.
- ExtractionResponse
- Inference response class for V2.
- ExtractionResult
- Inference result class.
- DataSchema
- Modify the Data Schema.
- DataSchemaActiveOption
- Data schema options activated during the inference.
- DataSchemaField
- Data Schema Field.
- DataSchemaReplace
- The structure to completely replace the data schema of the model.
- ExtractionParameters
- Parameters accepted by the asynchronous **inference** v2 endpoint.
- OcrInference
- Response for an Ocr utility inference.
- OcrPage
- Ocr result for a single page.
- OcrResponse
- Response for an Ocr utility inference.
- OcrResult
- Result of the Ocr utility inference.
- OcrWord
- Ocr result for a single word extracted from the document page.
- OcrParameters
- Parameters for an ocr utility inference.
- SplitParameters
- Parameters for a split utility inference.
- SplitInference
- The inference result for a split utility request.
- SplitRange
- A single document as identified when splitting a multi-document source file.
- SplitResponse
- Represent a split response from Mindee V2 API.
- SplitResult
- Result of a split utility inference.
Traits
- CustomSleepMixin
- FieldConfidenceMixin
- Trait to add position information.
- FieldPositionMixin
- Mixin trait to add position information.
Enums
Constants
- ALLOWED_MIME_TYPES : mixed = ['application/pdf', 'image/heic', 'image/png',...
- List of allowed mime types for document parsing.
- API_KEY_ENV_NAME : mixed = 'MINDEE_API_KEY'
- Default key name for the API key entry in environment variables.
- API_V2_BASE_URL_DEFAULT : mixed = 'https://api-v2.mindee.net'
- Default URL prefix for API calls.
- API_V2_BASE_URL_ENV_NAME : mixed = 'MINDEE_V2_BASE_URL'
- Default key name for the Base URL in environment variables.
- API_V2_KEY_ENV_NAME : mixed = 'MINDEE_V2_API_KEY'
- Default key name for the API key entry in environment variables.
- API_V2_REQUEST_TIMEOUT_ENV_NAME : mixed = 'MINDEE_V2_REQUEST_TIMEOUT'
- Default key name for CURL request timeout in environment variables.
- API_V2_TIMEOUT_DEFAULT : mixed = 120
- Default timeout value for curl requests.
- BASE_URL_DEFAULT : mixed = 'https://api.mindee.net'
- Default URL prefix for API calls.
- BASE_URL_ENV_NAME : mixed = 'MINDEE_BASE_URL'
- Default key name for the Base URL in environment variables.
- KEEP_ONLY : mixed = 'KEEP_ONLY'
- Only keep the selected pages.
- MINIMUM_DELAY_SECONDS : mixed = 1.0
- MINIMUM_INITIAL_DELAY_SECONDS : mixed = 1.0
- REMOVE : mixed = 'REMOVE'
- Remove the selected pages.
- REQUEST_TIMEOUT_ENV_NAME : mixed = 'MINDEE_REQUEST_TIMEOUT'
- Default key name for CURL request timeout in environment variables.
- TIMEOUT_DEFAULT : mixed = 120
- Default timeout value for curl requests.
- VERSION : mixed = '3.0.0'
Functions
- getUserAgent() : string
- Get the User Agent to send for API calls.
Constants
ALLOWED_MIME_TYPES
List of allowed mime types for document parsing.
public
mixed
ALLOWED_MIME_TYPES
= ['application/pdf', 'image/heic', 'image/png', 'image/jpg', 'image/jpeg', 'image/tiff', 'image/webp', 'application/octet-stream']
API_KEY_ENV_NAME
Default key name for the API key entry in environment variables.
public
mixed
API_KEY_ENV_NAME
= 'MINDEE_API_KEY'
API_V2_BASE_URL_DEFAULT
Default URL prefix for API calls.
public
mixed
API_V2_BASE_URL_DEFAULT
= 'https://api-v2.mindee.net'
API_V2_BASE_URL_ENV_NAME
Default key name for the Base URL in environment variables.
public
mixed
API_V2_BASE_URL_ENV_NAME
= 'MINDEE_V2_BASE_URL'
API_V2_KEY_ENV_NAME
Default key name for the API key entry in environment variables.
public
mixed
API_V2_KEY_ENV_NAME
= 'MINDEE_V2_API_KEY'
API_V2_REQUEST_TIMEOUT_ENV_NAME
Default key name for CURL request timeout in environment variables.
public
mixed
API_V2_REQUEST_TIMEOUT_ENV_NAME
= 'MINDEE_V2_REQUEST_TIMEOUT'
API_V2_TIMEOUT_DEFAULT
Default timeout value for curl requests.
public
mixed
API_V2_TIMEOUT_DEFAULT
= 120
BASE_URL_DEFAULT
Default URL prefix for API calls.
public
mixed
BASE_URL_DEFAULT
= 'https://api.mindee.net'
BASE_URL_ENV_NAME
Default key name for the Base URL in environment variables.
public
mixed
BASE_URL_ENV_NAME
= 'MINDEE_BASE_URL'
KEEP_ONLY
Only keep the selected pages.
public
mixed
KEEP_ONLY
= 'KEEP_ONLY'
MINIMUM_DELAY_SECONDS
public
mixed
MINIMUM_DELAY_SECONDS
= 1.0
MINIMUM_INITIAL_DELAY_SECONDS
public
mixed
MINIMUM_INITIAL_DELAY_SECONDS
= 1.0
REMOVE
Remove the selected pages.
public
mixed
REMOVE
= 'REMOVE'
REQUEST_TIMEOUT_ENV_NAME
Default key name for CURL request timeout in environment variables.
public
mixed
REQUEST_TIMEOUT_ENV_NAME
= 'MINDEE_REQUEST_TIMEOUT'
TIMEOUT_DEFAULT
Default timeout value for curl requests.
public
mixed
TIMEOUT_DEFAULT
= 120
VERSION
public
mixed
VERSION
= '3.0.0'
Functions
getUserAgent()
Get the User Agent to send for API calls.
getUserAgent() : string