2
2
Extract API
3
3
===========
4
4
5
+ .. |IAP | replace :: :abbr: `IAP ( In-app purchases ) `
6
+ .. |OCR | replace :: :abbr: `OCR ( Optical Character Recognition ) `
7
+
5
8
Odoo provides a service to automate the processing of documents of type **invoices **, **bank statements **,
6
9
**expenses ** or **resumes **.
7
10
8
- The service scans documents using an :abbr: ` OCR ( Optical Character Recognition ) ` engine and then
11
+ The service scans documents using an | OCR | engine and then
9
12
uses :abbr: `AI ( Artificial Intelligence ) `-based algorithms to extract fields of interest such as the
10
13
total, due date, or invoice lines for *invoices *, the initial and final balances, the date for
11
14
*bank statements *, the total, date for *expenses *, or the name, email, phone number for *resumes *.
12
15
13
- This service is a paid service. Each document processing will cost you one credit.
14
- Credits can be bought on `iap.odoo.com <https://iap.odoo.com/iap/in-app-services/259?sortby=date >`_.
16
+ This service is a paid service. Each document processing will cost you one credit from your
17
+ document digitization |IAP | account. More information about |IAP | accounts can be found
18
+ :doc: `here </applications/essentials/in_app_purchase >`.
15
19
16
20
You can either use this service directly in the Accounting, Expense, or Recruitment App or through
17
21
the API. The Extract API, which is detailed in the next section, allows you to integrate our
@@ -59,8 +63,8 @@ testing is provided in the
59
63
Parse
60
64
=====
61
65
62
- Request the processing of a document from the OCR . The route will return a `document_token `,
63
- you can use it to obtain the result of your request.
66
+ Request the digitization of a document. The route will return a `document_token ` that you can use
67
+ to fetch the result of your request.
64
68
65
69
.. _extract_api/parse :
66
70
@@ -87,17 +91,15 @@ Request
87
91
.. rst-class :: o-definition-list
88
92
89
93
``account_token `` (required)
90
- The token of the account from which credits will be taken. Each successful call costs one
91
- token .
94
+ The token of the :doc: ` IAP < /applications/essentials/in_app_purchase >` account from which
95
+ credits will be charged. Each successful call costs one credit .
92
96
``version `` (required)
93
97
The version will determine the format of your requests and the format of the server response.
94
98
You should use the :ref: `latest version available <extract_api/version >`.
95
99
``documents `` (required)
96
- The document must be provided as a string in the ASCII encoding. The list should contain
97
- only one string. If multiple strings are provided only the first string corresponding to a
98
- pdf will be processed. If no pdf is found, the first string will be processed. This field
99
- is a list only for legacy reasons. The supported extensions are *pdf *, *png *, *jpg * and
100
- *bmp *.
100
+ The document must be provided as a Base64 string in the ASCII encoding.
101
+ The list should contain only one document. This field is a list only for legacy reasons.
102
+ The supported formats are *pdf *, *png * and *jpg *.
101
103
``dbuuid `` (optional)
102
104
Unique identifier of the Odoo database.
103
105
``webhook_url `` (optional)
@@ -238,7 +240,7 @@ Request
238
240
``document_token `` (required)
239
241
The ``document_token `` for which you want to get the current parsing status.
240
242
``account_token `` (required)
241
- The token of the account that was used to submit the document.
243
+ The token of the | IAP | account that was used to submit the document.
242
244
243
245
.. code-block :: js
244
246
@@ -279,7 +281,7 @@ are the name of the field and the value is the value of the field.
279
281
.. rst-class :: o-definition-list
280
282
281
283
``full_text_annotation ``
282
- Contains the unprocessed full result from the OCR for the document
284
+ Contains the unprocessed full result from the | OCR | for the document.
283
285
284
286
================================ =============================================================
285
287
status status_msg
0 commit comments