Interface LineItemDescriptionModel

Encapsulates typed und untyped workflow metadata for case properties

interface LineItemDescriptionModel {
    bbox?: Bbox;
    components?: {
        CSIDescription?: string;
        emailDescription?: string;
        materialDescription?: string;
        originalItemDescription?: string;
        shortenedOriginalItemDescription?: string;
        tariffNumberDescription?: string;
        translatedDescription?: string;
        webDescription?: string;
    };
    composites?: {
        CSIDescriptionComposite?: string;
        emailDescriptionComposite?: string;
        originalItemDescriptionComposite?: string;
        translatedDescriptionComposite?: string;
        webDescriptionComposite?: string;
    };
    confidence?: number;
    display?: boolean;
    errors?: ErrorModel[];
    input?: string;
    lastChangedBy?: string;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    options?: string[];
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    searchValue?: string;
    source?: string;
    templateValue?: string;
    translation?: Translation;
    userEdited?: boolean;
    value?: string;
    webResults?: {
        imageUrl?: string;
        link?: string;
        title?: string;
    }[];
}

Hierarchy (view full)

Properties

bbox? components? composites? confidence? display? errors? input? lastChangedBy? modifiedAt? modifiedBy? options? reason? required? reviewNeeded? searchValue? source? templateValue? translation? userEdited? value? webResults?

Properties

Optional bbox

bbox?: Bbox

Bounding box of extracted value

Optional components

components?: {
    CSIDescription?: string;
    emailDescription?: string;
    materialDescription?: string;
    originalItemDescription?: string;
    shortenedOriginalItemDescription?: string;
    tariffNumberDescription?: string;
    translatedDescription?: string;
    webDescription?: string;
}

Type declaration

  • Optional CSIDescription?: string
  • Optional emailDescription?: string
  • Optional materialDescription?: string
  • Optional originalItemDescription?: string
  • Optional shortenedOriginalItemDescription?: string
  • Optional tariffNumberDescription?: string
  • Optional translatedDescription?: string
  • Optional webDescription?: string

Optional composites

composites?: {
    CSIDescriptionComposite?: string;
    emailDescriptionComposite?: string;
    originalItemDescriptionComposite?: string;
    translatedDescriptionComposite?: string;
    webDescriptionComposite?: string;
}

Type declaration

  • Optional CSIDescriptionComposite?: string
  • Optional emailDescriptionComposite?: string
  • Optional originalItemDescriptionComposite?: string
  • Optional translatedDescriptionComposite?: string
  • Optional webDescriptionComposite?: 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

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 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[]

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 templateValue

templateValue?: string

Template value which was used to generate the value

Optional translation

translation?: Translation

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

Optional webResults

webResults?: {
    imageUrl?: string;
    link?: string;
    title?: string;
}[]

Type declaration

  • Optional imageUrl?: string
  • Optional link?: string
  • Optional title?: string

Settings

Member Visibility

Theme

On This Page

bboxcomponentscompositesconfidencedisplayerrorsinputlastChangedBymodifiedAtmodifiedByoptionsreasonrequiredreviewNeededsearchValuesourcetemplateValuetranslationuserEditedvaluewebResults