V1.1
Overview
In the extraction model configuration, you decide which fields from the extracted table data in the DocIntel are mapped to JSON. You can map fields from multiple tables by configuring them in the yaml file. Only the fields defined in the configuration file are mapped and sent to the system.
Some fields that are not part of the DocIntel schema may not get mapped to the JSON. for such fields you can configure Smart columns that enable you to map the missing columns.
You need to configure the checkbox type fields explicitly in the extraction-model yaml.
Template
kind: document
metadata:
name: extraction/v1/documents/extraction-model
spec:
extractionType: Invoice
types:
- name: "Invoice"
fields:
- name: "Case_Id"
example: ""
type: "String"
- name: "DocumentType"
example: ""
type: "String"
- name: "RejectReason"
example: ""
type: "String"
- name: "Weight"
example: ""
type: "Number"
searchKeywords:
- Catchweight
- weight
- product weight
- peso
- name: "PayAlone"
example: ""
type: "Bool"| Parameter | Description |
|---|---|
| Name | Determines the name of the field in JSON. |
| Example | Adds an example of the field value. |
| Type | Determines the datatype of the field. |
| SearchKeywords | Adds keywords to search for a smart column and map it to the JSON. NOTE The smart column appears in the Eyeball screen, if it is configured in the eyeball client configuration yaml file. For details, see this article. |
For example, for an Invoice extraction, one of the fields could be Weight and its parameters could be the following:
name: "Weight" | The name of the field in the JSON is Weight. |
example: true | An example of the weight. |
type: "Number" | The data type of the field is Number. The data type of the field is Bool for checkbox. |
searchKeywords: | The keywords to search in weight field could be catchweight, Weight, Product weight and Peso. |
For example, in the above template the PayAlone is a checkbox type field:
- name: "PayAlone" example: "" type: "Bool"
V1.0
Overview
In the extraction model configuration, you decide which fields from the extracted data in the DocIntel are mapped to JSON. Only the fields defined in the configuration file are mapped and sent to the system.
Template
kind: document
metadata:
name: extraction/v1/documents/extraction-model
spec:
extractionType: Invoice
types:
- name: "Invoice"
fields:
- name: "Case_Id"
example: ""
type: "String"
- name: "DocumentType"
example: ""
type: "String"
- name: "RejectReason"
example: ""
type: "String" | Parameter | Description |
|---|---|
| Name | Determines the name of the field in JSON. |
| Example | Adds an example of the field value. |
| Type | Determines the datatype of the field. |
For example, for an Invoice extraction, one of the fields could be Document type and its parameters could be the following:
name: "DocumentType" | The name of the field in the JSON is DocumentType. |
example: true | An example of the document type. |
type: "String" | The data type of the field is String. |
