Interface TextDetectionModel

Encapsulates typed und untyped workflow metadata for case properties

interface TextDetectionModel {
    bbox?: Bbox;
    confidence?: number;
    display?: boolean;
    errors?: ErrorModel[];
    id: string;
    input?: string;
    lastChangedBy?: string;
    metadata?: object;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: string[];
    path: string;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    tags?: string[];
    userEdited?: boolean;
    value?: string;
    version: number;
}

Hierarchy (view full)

Properties

bbox? confidence? display? errors? id input? lastChangedBy? metadata? modifiedAt? modifiedBy? options? path reason? required? reviewNeeded? searchValue? source? tags? userEdited? value? version

Properties

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional confidence

confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

Optional display

display?: boolean

Optional errors

errors?: ErrorModel[]

could be validation errors

id

id: string

Optional input

input?: string

The input value which was initially supplied for the property

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

Optional metadata

metadata?: object

Optional modifiedAt

modifiedAt?: number

Last modification date (user or machine), as a UTC unix timestamp

Optional modifiedBy

modifiedBy?: {
    displayName?: string;
    id?: string;
}

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string

Optional options

options?: string[]

path

path: string

Optional reason

reason?: any

Optional required

required?: boolean

Optional reviewNeeded

reviewNeeded?: boolean

Optional searchValue

searchValue?: string

Normalized searchValue, for any related queries. Needs to be a string, even if value is of a different type.

Optional source

source?: string

Optional tags

tags?: string[]

Optional userEdited

userEdited?: boolean

Mark this property as user-edited (as opposed to machine-generated)

Optional value

value?: string

The current value of the property

version

version: number

Settings

Member Visibility

Theme

On This Page

bboxconfidencedisplayerrorsidinputlastChangedBymetadatamodifiedAtmodifiedByoptionspathreasonrequiredreviewNeededsearchValuesourcetagsuserEditedvalueversion