Mindee Python SDK Reference

This is purely a reference manual.

Please refer to the documentation to learn how to actually use the client.

https://developers.mindee.com/docs/python-sdk

Contents:

• Client Options
  • Polling Options
    • PollingOptions
• Mindee Errors
  • MimeTypeError
    • MimeTypeError.add_note()
    • MimeTypeError.with_traceback()
    • MimeTypeError.args
  • MindeeClientError
    • MindeeClientError.add_note()
    • MindeeClientError.with_traceback()
    • MindeeClientError.args
  • MindeeError
    • MindeeError.add_note()
    • MindeeError.with_traceback()
    • MindeeError.args
  • MindeeGeometryError
    • MindeeGeometryError.add_note()
    • MindeeGeometryError.with_traceback()
    • MindeeGeometryError.args
  • MindeeHTTPClientError
    • MindeeHTTPClientError.add_note()
    • MindeeHTTPClientError.with_traceback()
    • MindeeHTTPClientError.api_code
    • MindeeHTTPClientError.api_details
    • MindeeHTTPClientError.api_message
    • MindeeHTTPClientError.args
    • MindeeHTTPClientError.status_code
  • MindeeHTTPError
    • MindeeHTTPError.add_note()
    • MindeeHTTPError.with_traceback()
    • MindeeHTTPError.api_code
    • MindeeHTTPError.api_details
    • MindeeHTTPError.api_message
    • MindeeHTTPError.args
    • MindeeHTTPError.status_code
  • MindeeHTTPServerError
    • MindeeHTTPServerError.add_note()
    • MindeeHTTPServerError.with_traceback()
    • MindeeHTTPServerError.api_code
    • MindeeHTTPServerError.api_details
    • MindeeHTTPServerError.api_message
    • MindeeHTTPServerError.args
    • MindeeHTTPServerError.status_code
  • MindeeImageError
    • MindeeImageError.add_note()
    • MindeeImageError.with_traceback()
    • MindeeImageError.args
  • MindeePDFError
    • MindeePDFError.add_note()
    • MindeePDFError.with_traceback()
    • MindeePDFError.args
  • handle_error()
• Geometry Helpers
  • BBox
    • BBox.count()
    • BBox.index()
    • BBox.area
    • BBox.height
    • BBox.width
    • BBox.x_max
    • BBox.x_min
    • BBox.y_max
    • BBox.y_min
  • MinMax
    • MinMax.count()
    • MinMax.index()
    • MinMax.max
    • MinMax.min
  • Point
    • Point.count()
    • Point.index()
    • Point.x
    • Point.y
  • Polygon
    • Polygon.append()
    • Polygon.clear()
    • Polygon.copy()
    • Polygon.count()
    • Polygon.extend()
    • Polygon.index()
    • Polygon.insert()
    • Polygon.is_point_in_x()
    • Polygon.is_point_in_y()
    • Polygon.pop()
    • Polygon.remove()
    • Polygon.reverse()
    • Polygon.sort()
    • Polygon.centroid
  • Quadrilateral
    • Quadrilateral.count()
    • Quadrilateral.index()
    • Quadrilateral.bottom_left
    • Quadrilateral.bottom_right
    • Quadrilateral.centroid
    • Quadrilateral.top_left
    • Quadrilateral.top_right
  • get_bbox()
  • get_bounding_box()
  • get_centroid()
  • get_min_max_x()
  • get_min_max_y()
  • is_point_in_x()
  • is_point_in_y()
  • merge_polygons()
  • quadrilateral_from_prediction()
• Image Helpers
  • compress_image()
• Mindee Input
  • Base64Input
    • Base64Input.apply_page_options()
    • Base64Input.close()
    • Base64Input.compress()
    • Base64Input.fix_pdf()
    • Base64Input.has_source_text()
    • Base64Input.is_pdf()
    • Base64Input.is_pdf_empty()
    • Base64Input.merge_pdf_pages()
    • Base64Input.process_pdf()
    • Base64Input.read_contents()
    • Base64Input.file_mimetype
    • Base64Input.file_object
    • Base64Input.filename
    • Base64Input.filepath
    • Base64Input.page_count
  • BytesInput
    • BytesInput.apply_page_options()
    • BytesInput.close()
    • BytesInput.compress()
    • BytesInput.fix_pdf()
    • BytesInput.has_source_text()
    • BytesInput.is_pdf()
    • BytesInput.is_pdf_empty()
    • BytesInput.merge_pdf_pages()
    • BytesInput.process_pdf()
    • BytesInput.read_contents()
    • BytesInput.file_mimetype
    • BytesInput.file_object
    • BytesInput.filename
    • BytesInput.filepath
    • BytesInput.page_count
  • FileInput
    • FileInput.apply_page_options()
    • FileInput.close()
    • FileInput.compress()
    • FileInput.fix_pdf()
    • FileInput.has_source_text()
    • FileInput.is_pdf()
    • FileInput.is_pdf_empty()
    • FileInput.merge_pdf_pages()
    • FileInput.process_pdf()
    • FileInput.read_contents()
    • FileInput.file_mimetype
    • FileInput.file_object
    • FileInput.filename
    • FileInput.filepath
    • FileInput.page_count
  • LocalInputSource
    • LocalInputSource.apply_page_options()
    • LocalInputSource.close()
    • LocalInputSource.compress()
    • LocalInputSource.fix_pdf()
    • LocalInputSource.has_source_text()
    • LocalInputSource.is_pdf()
    • LocalInputSource.is_pdf_empty()
    • LocalInputSource.merge_pdf_pages()
    • LocalInputSource.process_pdf()
    • LocalInputSource.read_contents()
    • LocalInputSource.file_mimetype
    • LocalInputSource.file_object
    • LocalInputSource.filename
    • LocalInputSource.filepath
    • LocalInputSource.page_count
  • LocalResponse
    • LocalResponse.deserialize_response()
    • LocalResponse.get_hmac_signature()
    • LocalResponse.is_valid_hmac_signature()
    • LocalResponse.ResponseT
    • LocalResponse.as_dict
  • PageOptions
    • PageOptions.count()
    • PageOptions.index()
    • PageOptions.on_min_pages
    • PageOptions.operation
    • PageOptions.page_indexes
  • PathInput
    • PathInput.apply_page_options()
    • PathInput.close()
    • PathInput.compress()
    • PathInput.fix_pdf()
    • PathInput.has_source_text()
    • PathInput.is_pdf()
    • PathInput.is_pdf_empty()
    • PathInput.merge_pdf_pages()
    • PathInput.process_pdf()
    • PathInput.read_contents()
    • PathInput.file_mimetype
    • PathInput.file_object
    • PathInput.filename
    • PathInput.filepath
    • PathInput.page_count
  • URLInputSource
    • URLInputSource.as_local_input_source()
    • URLInputSource.save_to_file()
    • URLInputSource.url
• Mindee HTTP
  • Response Validation
    • clean_request_json()
    • is_valid_async_response()
    • is_valid_sync_response()
  • Settings Mixin
    • SettingsMixin
• Parsing Utilities
  • Common Parsing Utilities
    • Common Response
    • String Dict
    • Summary Helper
• PDF Helpers
  • PDFCharData
    • PDFCharData.bottom
    • PDFCharData.char
    • PDFCharData.font_fill_color
    • PDFCharData.font_flags
    • PDFCharData.font_name
    • PDFCharData.font_size
    • PDFCharData.font_stroke_color
    • PDFCharData.font_weight
    • PDFCharData.left
    • PDFCharData.page_id
    • PDFCharData.right
    • PDFCharData.top
  • compress_pdf()
  • extract_text_from_pdf()
  • lerp()
  • pdf_has_source_text()
• V1 Utilities
  • V1 Client
    • Client
    • get_bound_classname()
  • V1 Client Options
    • Predict Options
    • Workflow Options
  • V1 Error
    • Mindee API Error
    • Mindee Product Error
  • V1 Mindee HTTP
    • Base Endpoint
    • Base Settings
    • Endpoint
    • MindeeAPI
    • Workflow Endpoint
    • Workflow Settings
  • V1 Parsing Utilities
    • V1 Standard Fields
    • V1 Common Fields
    • V1 Custom Fields
    • V1 Generated Fields
  • V1 PDF
    • Multi-Receipts Extractor
    • PDF Extractor
  • V1 Products
    • Region-Specific
    • International
• V2 Utilities
  • V2 Client Options
    • Base Parameters
  • V2 Error
    • Mindee API V2 Error
    • Mindee HTTP Error V2
  • File Operations
    • Crop
    • Crop Files
    • Split
    • Split Files
  • V2 Mindee HTTP
    • Mindee API V2
    • Response Validation V2
  • V2 Parsing
    • Inference V2
    • V2 Parsing Error
    • V2 Parsing Job
    • V2 Search
  • V2 Products
    • Classification
    • Crop
    • Extraction
    • OCR
    • Split
• Client V2
  • Client
    • Client.close()
    • Client.enqueue()
    • Client.enqueue_and_get_result()
    • Client.get_job()
    • Client.get_result()
    • Client.get_result_from_url()
    • Client.search_models()
• Client Mixin
  • client_mixin
• Mindee Logger