Delivery note V1

Sample Code:

from mindee import Client, product, AsyncPredictResponse

# 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 enqueue it.
result: AsyncPredictResponse = mindee_client.enqueue_and_parse(
    product.DeliveryNoteV1,
    input_doc,
)

# Print a brief summary of the parsed data
print(result.document)

class DeliveryNoteV1(raw_prediction)

Delivery note API version 1 inference prediction.

Parameters:

raw_prediction (Dict[str, Any]) –

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] = 'delivery_notes'

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

Page-level prediction(s).

prediction: DeliveryNoteV1Document

Document-level prediction.

product: Product

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

class DeliveryNoteV1Document(raw_prediction, page_id=None)

Delivery note API version 1.1 document data.

Parameters:

• raw_prediction (Dict[str, Any]) –

• page_id (Optional[int]) –

customer_address: StringField

The address of the customer receiving the goods.

customer_name: StringField

The name of the customer receiving the goods.

delivery_date: DateField

The date on which the delivery is scheduled to arrive.

delivery_number: StringField

A unique identifier for the delivery note.

supplier_address: StringField

The address of the supplier providing the goods.

supplier_name: StringField

The name of the supplier providing the goods.

total_amount: AmountField

The total monetary value of the goods being delivered.