Application
Table of Contents
Classes
- Client
- Main entrypoint for Mindee operations.
- MindeeApiException
- Exceptions relating to library issues.
- MindeeClientException
- Exceptions relating to the Mindee client.
- MindeeException
- Global Mindee Exception.
- MindeeGeometryException
- Exceptions relating to geometric manipulation issues.
- MindeeHttpClientException
- Exceptions relating to client-side HTTP calls.
- MindeeHttpException
- Exceptions relating to HTTP calls.
- MindeeHttpServerException
- Exceptions relating to server-side HTTP calls.
- MindeeMimeTypeException
- Exceptions relating to mime type issues.
- MindeeSourceException
- Exceptions relating to sources (documents) handling.
- 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.
- BaseEndpoint
- Abstract class for endpoints.
- Endpoint
- Endpoint management.
- MindeeApi
- Data class containing settings for endpoints.
- ResponseValidation
- Wrapper class for http requests/responses validation handling.
- Base64Input
- Base64-encoded text input.
- BytesInput
- Raw bytes input.
- EnqueueAndParseMethodOptions
- Handles options tied to asynchronous parsing.
- FileInput
- Binary file input.
- InputSource
- Base class for input sources.
- LocalInputSource
- Base class for all input sources coming from the local machine.
- PageOptions
- Options for page handling (PDF only).
- PathInput
- Local path input.
- PredictMethodOptions
- Handles options tied to prediction method.
- PredictOptions
- Handles options tied to Predictions.
- URLInputSource
- A local or distant URL input.
- 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.
- CropperExtra
- Contains information on the cropping of a prediction.
- Extras
- Extras collection wrapper class.
- 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.
- SummaryHelper
- Utility class to handle information display.
- ClassificationField
- A classification field.
- CustomLine
- Represents a single line.
- ListField
- A list of value or words.
- ListFieldValue
- A single Value or word.
- GeneratedListField
- A list of value or words for generated APIs.
- GeneratedObjectField
- A JSON-like object, with miscellaneous values.
- AmountField
- A field containing an amount value.
- BaseField
- Base class for most fields.
- 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.
- BarcodeReaderV1
- Barcode Reader API version 1 inference prediction.
- BarcodeReaderV1Document
- Barcode Reader 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.
- CustomV1
- Custom document (API Builder) v1 inference results.
- CustomV1Document
- Custom V1 document prediction results.
- CustomV1Page
- Custom V1 page prediction results.
- DriverLicenseV1
- Driver License API version 1 inference prediction.
- DriverLicenseV1Document
- Driver License API version 1.0 document data.
- DriverLicenseV1Page
- Driver License API version 1.0 page data.
- LicensePlateV1
- License Plate API version 1 inference prediction.
- LicensePlateV1Document
- License Plate API version 1.1 document data.
- FinancialDocumentV1
- Financial Document API version 1 inference prediction.
- FinancialDocumentV1Document
- Financial Document API version 1.6 document data.
- FinancialDocumentV1LineItem
- List of line item details.
- FinancialDocumentV1LineItems
- List of line item details.
- 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.
- CarteVitaleV1
- Carte Vitale API version 1 inference prediction.
- CarteVitaleV1Document
- Carte Vitale 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.0 document data.
- InvoiceV4
- Invoice API version 4 inference prediction.
- InvoiceV4Document
- Invoice API version 4.6 document data.
- InvoiceV4LineItem
- List of line item details.
- InvoiceV4LineItems
- List of line item details.
- InvoiceSplitterV1
- Inference prediction for Invoice Splitter, API version 1.
- InvoiceSplitterV1Document
- Document data for Invoice Splitter, API version 1.
- InvoiceSplitterV1PageGroup
- Pages indexes in a group for Invoice Splitter V1.
- MultiReceiptsDetectorV1
- Multi Receipts Detector API version 1 inference prediction.
- MultiReceiptsDetectorV1Document
- Multi Receipts Detector API version 1.0 document data.
- PassportV1
- Passport API version 1 inference prediction.
- PassportV1Document
- Passport API version 1.1 document data.
- ProofOfAddressV1
- Proof of Address API version 1 inference prediction.
- ProofOfAddressV1Document
- Proof of Address API version 1.1 document data.
- ReceiptV5
- Receipt API version 5 inference prediction.
- ReceiptV5Document
- Receipt API version 5.1 document data.
- ReceiptV5LineItem
- List of line item details.
- ReceiptV5LineItems
- List of line item details.
- 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.0 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.
- DriverLicenseV1
- Driver License API version 1 inference prediction.
- DriverLicenseV1Document
- Driver License API version 1.1 document data.
- DriverLicenseV1Page
- Driver License API version 1.1 page data.
- W9V1
- W9 API version 1 inference prediction.
- W9V1Document
- W9 API version 1.0 document data.
- W9V1Page
- W9 API version 1.0 page data.
Traits
- FieldConfidenceMixin
- Trait to add position information.
- FieldPositionMixin
- Mixin trait to add position information.
Constants
- ALLOWED_MIME_TYPES = ['application/pdf', 'image/heic', 'image/png', 'image/jpg', 'image/jpeg', 'image/tiff', 'image/webp']
- List of allowed mime types for document parsing.
- API_KEY_ENV_NAME = 'MINDEE_API_KEY'
- Default key name for the API key entry in environment variables.
- BASE_URL_DEFAULT = 'https://api.mindee.net/v1'
- Default URL prefix for API calls.
- BASE_URL_ENV_NAME = 'MINDEE_BASE_URL'
- Default key name for the Base URL in environment variables.
- KEEP_ONLY = 'KEEP_ONLY'
- Only keep the selected pages.
- REMOVE = 'REMOVE'
- Remove the selected pages.
- REQUEST_TIMEOUT_ENV_NAME = 'MINDEE_REQUEST_TIMEOUT'
- Default key name for CURL request timeout in environment variables.
- TIMEOUT_DEFAULT = 120
- Default timeout value for curl requests.
- USER_AGENT = 'mindee-api-php@v' . \Mindee\VERSION . ' php-v' . PHP_VERSION . ' ' . PHP_OS
- VERSION = '1.4.3'
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']
API_KEY_ENV_NAME
Default key name for the API key entry in environment variables.
public
mixed
API_KEY_ENV_NAME
= 'MINDEE_API_KEY'
BASE_URL_DEFAULT
Default URL prefix for API calls.
public
mixed
BASE_URL_DEFAULT
= 'https://api.mindee.net/v1'
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'
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
USER_AGENT
public
mixed
USER_AGENT
= 'mindee-api-php@v' . \Mindee\VERSION . ' php-v' . PHP_VERSION . ' ' . PHP_OS
VERSION
public
mixed
VERSION
= '1.4.3'