Skip to content

Commit af424ac

Browse files
authored
docs: Update to README (#58)
* docs: Update to README * Added Code Font to function names
1 parent 29d62af commit af424ac

File tree

1 file changed

+13
-11
lines changed
  • packages/google-cloud-documentai-toolbox

1 file changed

+13
-11
lines changed

packages/google-cloud-documentai-toolbox/README.rst

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
1-
2-
**Disclaimer**
3-
4-
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.
5-
61
Document AI Toolbox
72
=================================
83

94
|experimental| |versions|
105

11-
`Document AI Toolbox`_: Document AI Toolbox aims to reduce the friction of managing, manipulating, and extracting information from outputs of Document AI’s BatchProcessDocument (JSON files written to user-managed GCS buckets) and ProcessDocument methods, programmatically.
6+
`Document AI Toolbox`_: Document AI Toolbox aims to reduce the friction of managing, manipulating, and extracting information from outputs of Document AI ``BatchProcessDocuments()`` (JSON files written to user-managed GCS buckets) and ``ProcessDocument()`` methods, programmatically.
7+
8+
**Disclaimer**
9+
10+
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.
1211

1312
.. |experimental| image:: https://img.shields.io/badge/support-experimental-red.svg
1413
:target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels
@@ -21,19 +20,22 @@ Quick Start
2120

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

24-
Enabling Document AI may not be technically required to use this library, unless ProcessDocument is inteded to be used.
25-
But you must enable the Storage API to access GCS buckets that contains the output of BatchProcessDocument.
23+
Enabling Document AI may not be technically required to use this library, unless ``ProcessDocument()`` is intended to be used.
24+
But you must enable the Storage API to access GCS buckets that contains the output of ``BatchProcessDocument()``.
25+
You will need to enable the BigQuery API if you intend to use the BigQuery features.
2626

2727
1. `Select or create a Cloud Platform project.`_
2828
2. `Enable billing for your project.`_
2929
3. `Enable the Storage API.`_
3030
4. `Enable the Document AI API.`_
31-
5. `Setup Authentication.`_
31+
5. `Enable the BigQuery API.`_
32+
6. `Setup Authentication.`_
3233

3334
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
3435
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
3536
.. _Enable the Storage API.: https://cloud.google.com/storage/docs
3637
.. _Enable the Document AI API.: https://cloud.google.com/document-ai/docs
38+
.. _Enable the BigQuery API.: https://cloud.google.com/bigquery/docs
3739
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
3840

3941
Installation
@@ -99,7 +101,7 @@ Windows
99101
Next Steps
100102
~~~~~~~~~~
101103

102-
- Read the `Document AI Product documentation`_ to learn
104+
- Read the `Document AI product documentation`_ to learn
103105
more about the product and see How-to Guides.
104106
- Read the `Client Library Documentation`_ for Document AI Toolbox
105107
to see other available methods on the client.
@@ -108,5 +110,5 @@ Next Steps
108110

109111
.. _`Client Library Documentation`: https://cloud.google.com/python/docs/reference/documentai-toolbox/latest
110112
.. _`Document AI documentation`: https://cloud.google.com/document-ai
111-
.. _`Document AI Product documentation`: https://cloud.google.com/document-ai/docs/overview
113+
.. _`Document AI product documentation`: https://cloud.google.com/document-ai/docs/overview
112114
.. _`README`: https://github.com/googleapis/python-documentai-toolbox/blob/main/README.rst

0 commit comments

Comments
 (0)