Quickly and easily connect to Mindee's API services using Python.
Here's the TL;DR of getting started.
First, get an API Key
Then, install this library:
pip install mindeeFinally, Python away!
from mindee import Client, documents
# Init a new client
mindee_client = Client(api_key="my-api-key")
# Load a file from disk
input_doc = mindee_client.doc_from_path("/path/to/the/file.ext")
# Parse the document as an invoice by passing the appropriate type
api_response = input_doc.parse(documents.TypeInvoiceV4)
# Print a brief summary of the parsed data
print(api_response.document)from mindee import Client, documents
# Init a new client
mindee_client = Client(api_key="my-api-key")
# Load a file from disk
input_doc = mindee_client.doc_from_path("/path/to/the/file.ext")
# Parse the document as a USA bank check by passing the appropriate type
api_response = input_doc.parse(documents.us.TypeBankCheckV1)
# Print a brief summary of the parsed data
print(api_response.document)from mindee import Client, documents
# Init a new client and add your custom endpoint (document)
mindee_client = Client(api_key="my-api-key").add_endpoint(
account_name="john",
endpoint_name="wnine",
)
# Load a file from disk and parse it.
# The endpoint name must be specified since it can't be determined from the class.
api_response = mindee_client.doc_from_path(
"/path/to/the/file.ext"
).parse(documents.TypeCustomV1, endpoint_name="wnine")
# Print a brief summary of the parsed data
print(api_response.document)
# Iterate over all the fields in the document
for field_name, field_values in api_response.document.fields.items():
print(field_name, "=", field_values)There's more to it than that for those that need more features, or want to customize the experience.
All the juicy details are described in the Official Guide.
You can also take a look at the Reference Documentation.
Copyright © Mindee
Available as open source under the terms of the MIT License.