|
| 1 | +# Zuva DocAI connector |
| 2 | + |
| 3 | +The Zuva DocAI connector enables developers to implement contracts AI features into their applications. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +You will need a Zuva account and a DocAI token. See [Obtaining Credentials](#obtaining-credentials). |
| 8 | + |
| 9 | +## Supported Operations |
| 10 | + |
| 11 | +### File Management |
| 12 | + |
| 13 | +Upload your file for analysis. Note that files automatically expire 48 hours after being uploaded. |
| 14 | + |
| 15 | +- `Submit File`: Upload a file to Zuva's servers |
| 16 | +- `Delete File`: Remove a file from Zuva's servers |
| 17 | + |
| 18 | +### Extraction |
| 19 | + |
| 20 | +Extract specific information from your document, such as its title or governing law. You will |
| 21 | +need the field ID of the fields you would like to extract. Field IDs can be found in the [Field Library](https://docai.zuva.ai/field-library) |
| 22 | +(sign-in required), from [AI trainer](https://zuva.ai/ai-trainer/) if you have trained custom fields, or |
| 23 | +programmatically using the [Fields endpoint](#fields). |
| 24 | + |
| 25 | +- `Create Field Extraction Request`: Initiate asynchronous extraction of fields from a document. |
| 26 | +- `Get Field Extraction Request Status`: Check the status of an existing extraction request. |
| 27 | +- `Get Field Extraction Request Text Results`: Get text results from a completed extraction request. |
| 28 | + |
| 29 | +### Language Classification |
| 30 | + |
| 31 | +Discover the language of your document. |
| 32 | + |
| 33 | +- `Create Language Classification Request`: Initiate asynchronous classification of the document language. |
| 34 | +- `Get Language Classification Request Status`: Get status and results of language classification. |
| 35 | + |
| 36 | +### Document Classification |
| 37 | + |
| 38 | +Categorize your document: is it a contract and, if so, what type of contract (real estate agreement, employment agreement etc.)? |
| 39 | + |
| 40 | +- `Create Document Classification Request`: Initiate asynchronous classification of the document type. |
| 41 | +- `Get Document Classification Request Status`: Get status and results of document classification. |
| 42 | + |
| 43 | +### Optical Character Recognition (OCR) |
| 44 | + |
| 45 | +Obtain the text of your documents, regardless of their original file type (pdf, docx, png ...), as well |
| 46 | +as images of the document. |
| 47 | + |
| 48 | +- `Create OCR Request`: Initiate asynchronous OCR processing of a file. |
| 49 | +- `Get OCR Request Status`: Check whether OCR processing of a file is complete. |
| 50 | +- `Get OCR Results Text`: Retrieve the text from a processed file. |
| 51 | +- `Get OCR Results Images`: Retrieve the images from a processed file. |
| 52 | + |
| 53 | +### Fields |
| 54 | + |
| 55 | +Find out what fields are available to you. |
| 56 | + |
| 57 | +- `Get All Fields`: Return a list of all available fields (both built-in and custom). |
| 58 | + |
| 59 | +## Obtaining Credentials |
| 60 | + |
| 61 | +Zuva DocAI has multiple regional servers. You will need to create an API token for the |
| 62 | +specific region that you wish to use. |
| 63 | + |
| 64 | +1. Create and/or sign into your account at [zuva.ai](https://zuva.ai/). |
| 65 | +2. Navigate to the [DocAI console](https://docai.zuva.ai/) |
| 66 | +3. Select the region you would like to use. |
| 67 | +4. Copy the base URL for the region to your Zuva DocAI connection. |
| 68 | +5. Create a token and copy it to use in your Zuva DocAI connection. |
| 69 | + |
| 70 | +See the [DocAI documentation](https://zuva.ai/documentation/) for more information about Zuva accounts and tokens. |
| 71 | + |
| 72 | +## Differences between the connector and the DocAI API |
| 73 | + |
| 74 | +This connector makes use of a C# script to modify both requests and responses. As a result, the |
| 75 | +connector functionality does not correspond one-to-one with the documentation for |
| 76 | +the underlying API. In particular, the connector: |
| 77 | +1. Exposes an extra `is_finished` boolean, which can be used to tell if the request is either complete or failed |
| 78 | +2. All requests operate on single files, rather than batches of multiple files. |
| 79 | + |
| 80 | +## Known issues and limitations |
| 81 | + |
| 82 | +The connector does not support any of Zuva's endpoints related to training custom fields. |
0 commit comments