Interface HsClassificationResponse

Encapsulates typed und untyped workflow metadata for case properties

interface HsClassificationResponse {
    assumedInteractions: HsClassificationInteraction[];
    bbox?: Bbox;
    confidence?: number;
    currentItemDef: string;
    currentItemInteraction: string;
    currentItemName: string;
    currentItemPaths: string[];
    currentQuestionInteraction: HsClassificationInteraction;
    currentSIP: string;
    dataBuildDate: string;
    dataVersion: string;
    display?: boolean;
    duration: number;
    errorDetail: string;
    errors?: ErrorModel[];
    hsCode: string;
    hsYear: string;
    id: null;
    input?: string;
    itemOutOfScopeError: string;
    languageCode: string;
    lastChangedBy?: string;
    mixedContentError: null;
    modifiedAt?: number;
    modifiedBy?: {
        displayName?: string;
        id?: string;
    };
    multiItemError: string;
    options?: string[];
    potentialHeadings: string[];
    productDescription: string;
    profileId: string;
    rational: string;
    reason?: any;
    required?: boolean;
    reviewNeeded?: boolean;
    schedule: string;
    searchValue?: string;
    source?: string;
    systemError: string;
    tariffScheduleEffectiveDate: string;
    tariffScheduleSource: string;
    templateValue?: string;
    txId: string;
    userEdited?: boolean;
    value?: string;
}

Hierarchy (view full)

Properties

assumedInteractions bbox? confidence? currentItemDef currentItemInteraction currentItemName currentItemPaths currentQuestionInteraction currentSIP dataBuildDate dataVersion display? duration errorDetail errors? hsCode hsYear id input? itemOutOfScopeError languageCode lastChangedBy? mixedContentError modifiedAt? modifiedBy? multiItemError options? potentialHeadings productDescription profileId rational reason? required? reviewNeeded? schedule searchValue? source? systemError tariffScheduleEffectiveDate tariffScheduleSource templateValue? txId userEdited? value?

Properties

assumedInteractions

assumedInteractions: HsClassificationInteraction[]

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

currentItemDef

currentItemDef: string

currentItemInteraction

currentItemInteraction: string

currentItemName

currentItemName: string

currentItemPaths

currentItemPaths: string[]

currentQuestionInteraction

currentQuestionInteraction: HsClassificationInteraction

currentSIP

currentSIP: string

dataBuildDate

dataBuildDate: string

dataVersion

dataVersion: string

Optional display

display?: boolean

duration

duration: number

errorDetail

errorDetail: string

Optional errors

errors?: ErrorModel[]

could be validation errors

hsCode

hsCode: string

hsYear

hsYear: string

id

id: null

Optional input

input?: string

The input value which was initially supplied for the property

itemOutOfScopeError

itemOutOfScopeError: string

languageCode

languageCode: string

Optional lastChangedBy

lastChangedBy?: string

Encoded user (username, userId, etc.)

Deprecated

mixedContentError

mixedContentError: null

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

multiItemError

multiItemError: string

Optional options

options?: string[]

potentialHeadings

potentialHeadings: string[]

productDescription

productDescription: string

profileId

profileId: string

rational

rational: string

Optional reason

reason?: any

Optional required

required?: boolean

Optional reviewNeeded

reviewNeeded?: boolean

schedule

schedule: string

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

systemError

systemError: string

tariffScheduleEffectiveDate

tariffScheduleEffectiveDate: string

tariffScheduleSource

tariffScheduleSource: string

Optional templateValue

templateValue?: string

Template value which was used to generate the value

txId

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

assumedInteractionsbboxconfidencecurrentItemDefcurrentItemInteractioncurrentItemNamecurrentItemPathscurrentQuestionInteractioncurrentSIPdataBuildDatedataVersiondisplaydurationerrorDetailerrorshsCodehsYearidinputitemOutOfScopeErrorlanguageCodelastChangedBymixedContentErrormodifiedAtmodifiedBymultiItemErroroptionspotentialHeadingsproductDescriptionprofileIdrationalreasonrequiredreviewNeededschedulesearchValuesourcesystemErrortariffScheduleEffectiveDatetariffScheduleSourcetemplateValuetxIduserEditedvalue