Use Machine Learning to Extract Information from Documents with Swagger UI

You will use Swagger UI, via any web browser, to call the Document Information Extraction APIs. Swagger UI allows developers to effortlessly interact and try out every single operation an API exposes for easy consumption. For more information, see Swagger UI.

In the service key you created for Document Information Extraction in the previous tutorial: Use Trial to Set Up Account for Document Information Extraction and Get Service Key or Use Free Tier to Set Up Account for Document Information Extraction and Get Service Key, you should find (outside the uaa section of the service key) an entry called url and another entry called swagger (as highlighted in the image below).

1. To access the Document Information Extraction Swagger UI, add the swagger value (/document-information-extraction/v1) to the url value, paste it in any web browser and press Enter.

   

2. To be able to use the Swagger UI endpoints you need to authorize yourself. In the top right corner, click Authorize.

   

3. Get the access_token value created in the previous tutorial: Get OAuth Access Token for Document Information Extraction Using Any Web Browser, then add Bearer in front of it, and enter in the Value field.

   Bearer <access_token>
   

   

4. Click Authorize, and then click Close.

   

Use the GET /capabilities endpoint to see the list of document fields and enrichment data for each document type you can process with Document Information Extraction.

Click the endpoint name to expand it, click Try it out, and then Execute.

You should receive a response like the following:

If you get an error response code 401 (Unauthorized), your token is probably incorrect. Check if you have added the word Bearer before the token and if the token value is complete and has been properly copied from the access_token value you received in the previous tutorial: Get OAuth Access Token for Document Information Extraction via Web Browser.

When you create a service instance for Document Information Extraction, a default client is automatically created. A client is used in most of the endpoints to distinguish and separate data.

Trial users can only create one client. To see your list of clients:

1. Expand the GET /clients endpoint.

2. Click Try it out.

3. Enter a maximum number of clients to be listed in the limit field.

4. Click Execute.

You should receive a response like the following:

Use the DELETE /clients endpoint to delete the default client.

1. Expand the DELETE /clients endpoint.

2. Click Try it out.

3. Enter in the payload field the client id (default) you want to delete.

4. Click Execute.

You should receive a response like the following:

Use the POST /clients endpoint to create your own client. The clientId value created here will be used in other service endpoints.

1. Expand the POST /clients endpoint.

2. Click Try it out.

3. Enter your clientId and clientName values in the payload field in the format you see in Examples for payload parameter (c_00 and client 00, for example).

4. Click Execute.

You should receive a response like the following:

You can repeat step 3 to see the clientId and clientName of the client you have just created.

CAUTION:

Be aware of the following Document Information Extraction trial account limitations:​

• Maximum 40 uploaded document pages per week​ (the documents can have more than 1 page)

• Maximum 1 created clientId

• Maximum 10 created enrichment dataIds

Document Information Extraction uses a globally pre-trained machine learning model that currently obtains better accuracy results with invoices and payment advices in the languages listed in Supported Languages and Countries. The team is working to support additional document types and languages in the near future.

Use the POST /document/jobs endpoint to upload to the service any document file in PDF or single-page PNG and JPEG format that has content in headers and tables, such as an invoice.

As an alternative to uploading your own document to the service, you can use any of the following sample invoice files (right click on the link, then click Save link as to download the files locally):

• Sample Invoice 1

• Sample Invoice 2

• Sample Invoice 3

Do the following:

1. Expand the POST /document/jobs endpoint.

2. Click Try it out.

3. Upload a document file.

4. In options, enter the list of fields to be extracted from the uploaded file (documentNumber, taxId, purchaseOrderNumber, shippingAmount, netAmount, senderAddress, senderName, grossAmount, for example), the client you created in step 5 (c_00, for example), and the document type (invoice, for example). In this case, you can use the following:

   JSON

   Copy

   {
      "extraction":{
         "headerFields":[
            "documentNumber",
            "taxId",
            "purchaseOrderNumber",
            "shippingAmount",
            "netAmount",
            "senderAddress",
            "senderName",
            "grossAmount",
            "currencyCode",
            "receiverContact",
            "documentDate",
            "taxAmount",
            "taxRate",
            "receiverName",
            "receiverAddress"
         ],
         "lineItemFields":[
            "description",
            "netAmount",
            "quantity",
            "unitPrice",
            "materialNumber"
         ]
      },
      "clientId":"c_00",
      "documentType":"invoice",
      "receivedDate":"2020-02-17",
      "enrichment":{
         "sender":{
            "top":5,
            "type":"businessEntity",
            "subtype":"supplier"
         },
         "employee":{
            "type":"employee"
         }
      }
   }
   

5. Click Execute.

After you have clicked Execute, you should receive a response like the following:

Copy the id from the Response body to see the result of the extraction in the next step.

You can now use the GET /document/jobs/{id} endpoint to receive the prediction.

1. Expand the GET /document/jobs/{id} endpoint.

2. Click Try it out.

3. Set extractedValues to true to get the extracted values.

4. Enter the id received in the POST /document/jobs endpoint as the id.

5. Click Execute.

You should receive a response like the following:

In the response, you will find some general information about the document you uploaded. In headerFields, such as documentDate and taxAmount, and in lineItems, such as description and quantity, you will find the prediction for the extracted fields.

The prediction is made with a probability indicated by the confidence field which represents how certain the model is about its prediction. A confidence of 1 means that the model is 100% sure about its prediction.

If the status of the document (indicated by the status field) is PENDING instead of DONE, then it means that the service is still extracting some fields and the returned JSON file does not yet contain all the requested fields.

You have now successfully used our machine learning model to get field value predictions for the document you uploaded to the Document Information Extraction service.

You can repeat step 4 and delete the client you created in step 5.

Congratulations, you have completed this tutorial.