Bank Check V1
Sample Code:
from mindee import Client, PredictResponse, product
# Init a new client
mindee_client = Client(api_key="my-api-key")
# Load a file from disk
input_doc = mindee_client.source_from_path("/path/to/the/file.ext")
# Load a file from disk and parse it.
# The endpoint name must be specified since it cannot be determined from the class.
result: PredictResponse = mindee_client.parse(product.us.BankCheckV1, input_doc)
# Print a summary of the API result
print(result.document)
# Print the document-level summary
# print(result.document.inference.prediction)
- class BankCheckV1(raw_prediction)
Bank Check API version 1 inference prediction.
- static get_endpoint_info(klass)
Retrives the endpoint information for an Inference.
Should never retrieve info for CustomV1, as a custom endpoint should be created to use CustomV1.
- Parameters:
klass (
Type[Inference]) – product subclass to access endpoint information.- Return type:
Dict[str,str]
- endpoint_name: Optional[str] = 'bank_check'
Name of the endpoint.
- endpoint_version: Optional[str] = '1'
Version of the endpoint.
- is_rotation_applied: Optional[bool]
Whether the document has had any rotation applied to it.
- page_id: Optional[int]
Optional page id for page-level predictions.
-
pages:
List[Page[BankCheckV1Page]] Page-level prediction(s).
-
prediction:
BankCheckV1Document Document-level prediction.
- product: Product
Name and version of a given product, as sent back by the API.
- class BankCheckV1Document(raw_prediction, page_id=None)
Bank Check API version 1.1 document data.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
-
account_number:
StringField The check payer’s account number.
-
amount:
AmountField The amount of the check.
-
check_number:
StringField The issuer’s check number.
-
payees:
List[StringField] List of the check’s payees (recipients).
-
routing_number:
StringField The check issuer’s routing number.
- class BankCheckV1Page(raw_prediction, page_id=None)
Bank Check API version 1.1 page data.
- Parameters:
raw_prediction (Dict[str, Any]) –
page_id (Optional[int]) –
- account_number: StringField
The check payer’s account number.
- amount: AmountField
The amount of the check.
- check_number: StringField
The issuer’s check number.
-
check_position:
PositionField The position of the check on the document.
- date: DateField
The date the check was issued.
- payees: List[StringField]
List of the check’s payees (recipients).
- routing_number: StringField
The check issuer’s routing number.
-
signatures_positions:
List[PositionField] List of signature positions