Proof of Address 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.ProofOfAddressV1, input_doc)

# Print a summary of the API result
print(result.document)

# Print the document-level summary
# print(result.document.inference.prediction)

class ProofOfAddressV1(raw_prediction)

Proof of Address 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] = 'proof_of_address'

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[ProofOfAddressV1Document]]

Page-level prediction(s).

prediction: ProofOfAddressV1Document

Document-level prediction.

product: Product

Name and version of a given product, as sent back by the API.

class ProofOfAddressV1Document(raw_prediction, page_id=None)

Proof of Address API version 1.1 document data.

Parameters:

• raw_prediction (Dict[str, Any]) –

• page_id (Optional[int]) –

date: DateField

The date the document was issued.

dates: List[DateField]

List of dates found on the document.

issuer_address: StringField

The address of the document’s issuer.

issuer_company_registration: List[CompanyRegistrationField]

List of company registrations found for the issuer.

issuer_name: StringField

The name of the person or company issuing the document.

locale: LocaleField

The locale detected on the document.

recipient_address: StringField

The address of the recipient.

recipient_company_registration: List[CompanyRegistrationField]

List of company registrations found for the recipient.

recipient_name: StringField

The name of the person or company receiving the document.