Pre-evaluation notification

post https://preevaluation

Notify an AI process has taken place. The data related to the document after the AI phase is completed are provided and can be changed by the caller

Responses

Response body

object

simple

array of objects

Simple field AI extracted values

simple

object

fields

array of objects

fields

object

captedValue

object

fieldId

string

fieldName

string

displayName

string

fieldType

string

barcode checkMark signature stamp text

alternateAiValues

array of objects

alternateAiValues

object

confidence

double

required

value

string

required

page

int32

instanceId

string

instance of the values. It can be null when user saves new values and it is always present when user get entity values from server

unbounded

array of objects

Unbounded field AI extracted values

unbounded

object

entityId

uuid

required

the entity id

entityName

string

required

the entity names

captedValues

array of objects

required

the annotated values for the entity

captedValues*

object

fields

array of objects

fields

object

captedValue

object

fieldId

string

fieldName

string

displayName

string

fieldType

string

barcode checkMark signature stamp text

alternateAiValues

array of objects

alternateAiValues

object

confidence

double

required

value

string

required

page

int32

instanceId

string

instance of the values. It can be null when user saves new values and it is always present when user get entity values from server

categorizationModelData

object

categorizedPages

array of objects

categorizedPages

object

categoryId

string

categoryName

string

pageNumber

int32

pageCategoryData

array of objects

Holds information what pages belong to this categoryId. After document splitting all listed pages will be added to the same document.Also it holds a bounding box that should be

pageCategoryData

object

box

object

page

int32

instanceId

string

categorizationModelDataAnnotations

object

categorizedPages

array of objects

categorizedPages

object

categoryId

string

categoryName

string

pageNumber

int32

pageCategoryData

array of objects

Holds information what pages belong to this categoryId. After document splitting all listed pages will be added to the same document.Also it holds a bounding box that should be

pageCategoryData

object

box

object

page

int32

instanceId

string

documentSummary

string

documentSummaryAnnotation

string

400

exception

Language


xxxxxxxxxx
1
curl --request POST \
2
     --url https://preevaluation/ \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200ok