Repository files navigation

Document AI Toolbox: Document AI Toolbox aims to reduce the friction of managing, manipulating, and extracting information from outputs of Document AIBatchProcessDocuments() (JSON files written to user-managed GCS buckets) andProcessDocument() methods, programmatically.

Disclaimer

The Document AI Toolbox is in an experimental state. This library is a work-in-progress and is likely to have backwards-incompatible changes. Users of the toolbox might need to rewrite their code when upgrading the toolbox version.

In order to use this library, you first need to go through the following steps:

Enabling Document AI may not be technically required to use this library, unlessProcessDocument() is intended to be used.But you must enable the Storage API to access GCS buckets that contains the output ofBatchProcessDocument().You will need to enable the BigQuery API if you intend to use the BigQuery features.

1. Select or create a Cloud Platform project.
2. Enable billing for your project.
3. Enable the Storage API.
4. Enable the Document AI API.
5. Enable the BigQuery API.
6. Setup Authentication.

Install this library in avirtualenv using pip.virtualenv is a tool tocreate isolated Python environments. The basic problem it addresses is one ofdependencies and versions, and indirectly permissions.

Withvirtualenv, it's possible to install this library without needing systeminstall permissions, and without clashing with the installed systemdependencies.

Code samples and snippets live in the samples/ folder.

Our client libraries are compatible with all currentactive andmaintenance versions ofPython.

Python >= 3.8

Python <= 3.7

NOTE:Python 3.7 was marked asunsupported by the python community in June 2023.We recommend that all developers upgrade to Python 3.8 and newer as soon asthey can. Support for Python 3.7 will be removed from all client libraries afterJanuary 1 2024. Client libraries that support Python 3.7 will continue to be availablefor download, but releases after January 1 2024 will only target Python 3.8 andnewer.

If you are using anend-of-lifeversion of Python, we recommend that you update as soon as possible to an actively supported version.

pip install virtualenvvirtualenv <your-env>source <your-env>/bin/activate<your-env>/bin/pip install google-cloud-documentai-toolbox

pip install virtualenvvirtualenv <your-env><your-env>\Scripts\activate<your-env>\Scripts\pip.exe install google-cloud-documentai-toolbox

• Read theDocument AI product documentation to learnmore about the product and see How-to Guides.
• Read theClient Library Documentation for Document AI Toolboxto see other available methods on the client.
• View thisREADME to see the full list of CloudAPIs that we cover.