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 bbox? category confidence? display? errors? hasOther heading headings id input? inputType isAnsweredWithRule label language lastChangedBy? modifiedAt? modifiedBy? name options? reason? required? reviewNeeded? ruleMismatch searchValue? selectedDefinition selectedString semanticAmbiguity source? templateValue? type unselectedString userEdited? value?

Properties

attrs

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

Optional bbox

bbox?: Bbox

Bounding box of extracted value

category

category: string

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

hasOther

hasOther: boolean

heading

heading: string

headings

headings: string

id

id: string

Optional input

input?: string

The input value which was initially supplied for the property

inputType

inputType: string

isAnsweredWithRule

isAnsweredWithRule: boolean

label

label: string

language

language: string

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

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

name

name: string

Optional options

options?: string[]

Optional reason

reason?: any

Optional required

required?: boolean

Optional reviewNeeded

reviewNeeded?: boolean

ruleMismatch

ruleMismatch: boolean

Optional searchValue

searchValue?: string

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

selectedDefinition

selectedDefinition: string

selectedString

selectedString: string

semanticAmbiguity

semanticAmbiguity: boolean

Optional source

source?: string

Optional templateValue

templateValue?: string

Template value which was used to generate the value

type

type: string

unselectedString

unselectedString: 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

Settings

Member Visibility

Theme

On This Page

attrsbboxcategoryconfidencedisplayerrorshasOtherheadingheadingsidinputinputTypeisAnsweredWithRulelabellanguagelastChangedBymodifiedAtmodifiedBynameoptionsreasonrequiredreviewNeededruleMismatchsearchValueselectedDefinitionselectedStringsemanticAmbiguitysourcetemplateValuetypeunselectedStringuserEditedvalue