Interface HsClassificationInteraction

Encapsulates typed und untyped workflow metadata for case properties

interface HsClassificationInteraction {
    attrs: {
        def: string;
        frequency: number;
        id: string;
        isPart: boolean;
        kindOf: string;
        name: string;
        number: string | number;
        path: string;
        value: string;
    }[];
    bbox?: Bbox;
    category: string;
    confidence?: number;
    display?: boolean;
    errors?: ErrorModel[];
    hasOther: boolean;
    heading: string;
    headings: string;
    id: string;
    input?: string;
    inputType: string;
    isAnsweredWithRule: boolean;
    label: string;
    language: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    name: string;
    options?: string[];
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    ruleMismatch: boolean;
    searchValue?: string;
    selectedDefinition: string;
    selectedString: string;
    semanticAmbiguity: boolean;
    source?: string;
    templateValue?: string;
    type: string;
    unselectedString: string;
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

  • Meta<string>
    • HsClassificationInteraction

Properties

attrs: {
    def: string;
    frequency: number;
    id: string;
    isPart: boolean;
    kindOf: string;
    name: string;
    number: string | number;
    path: string;
    value: string;
}[]

Type declaration

  • def: string
  • frequency: number
  • id: string
  • isPart: boolean
  • kindOf: string
  • name: string
  • number: string | number
  • path: string
  • value: string
bbox?: Bbox

Bounding box of extracted value

category: string
confidence?: number

Confidence supplied by data extraction or 1.0 if entered by human

display?: boolean
errors?: ErrorModel[]

could be validation errors

hasOther: boolean
heading: string
headings: string
id: string
input?: string

The input value which was initially supplied for the property

inputType: string
isAnsweredWithRule: boolean
label: string
language: string
lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

modifiedAt?: number

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

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

Field last changed by

Type declaration

  • Optional displayName?: string
  • Optional id?: string
name: string
options?: string[]
reason?: any
required?: boolean
reviewNeeded?: boolean
ruleMismatch: boolean
searchValue?: string

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

selectedDefinition: string
selectedString: string
semanticAmbiguity: boolean
source?: string
templateValue?: string

Template value which was used to generate the value

type: string
unselectedString: string
userEdited?: boolean

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

value?: string

The current value of the property