Interface UserInput

Identifies user input as a document

interface UserInput {
    _isNew?: boolean;
    analyzerMetadata?: AnalyzerMetadataModel;
    annotateOnlyFirstLineItem?: boolean;
    annotatedAggregated?: AggregatedCaseDataModel;
    annotatedExecutionStrategy?: ExecutionStrategy;
    annotatedLineItem?: LineItemModel;
    caseId?: string;
    classificationStatus?: ClassificationStatus;
    code?: string;
    customValidationMessages?: ValidationError[];
    customerId?: string;
    documentCode?: DocumentCode;
    documentReference?: Meta<string>;
    documentStatus?: DocumentStatus;
    documentType?: DigicustDocumentType;
    extractId?: string;
    fileName?: string;
    id?: string;
    isCondensed?: boolean;
    isPseudonymized?: boolean;
    issueDate?: DateTimeModel;
    modifiedBy?: {
        date?: Date;
        displayName?: string;
        id?: string;
    };
    pageCount?: number;
    pages?: DocumentPage[];
    priority?: "beforeNormalization" | "fallback" | "afterNormalization" | "replace";
    processing?: ProcessingModel;
    projectId?: string;
    queueId?: string;
    receivedAt?: Date;
    reference?: string;
    sourceMaterialId?: string;
    specialFileFormat?: "xlsx" | "xml" | "csv";
    subDocumentStatus?: SubDocumentStatus;
    uploadedFiles?: UploadedFileModel[];
    userDocumentStatus?: UserDocumentStatus;
    userEdited?: boolean;
}

Hierarchy (view full)

Properties

_isNew? analyzerMetadata? annotateOnlyFirstLineItem? annotatedAggregated? annotatedExecutionStrategy? annotatedLineItem? caseId? classificationStatus? code? customValidationMessages? customerId? documentCode? documentReference? documentStatus? documentType? extractId? fileName? id? isCondensed? isPseudonymized? issueDate? modifiedBy? pageCount? pages? priority? processing? projectId? queueId? receivedAt? reference? sourceMaterialId? specialFileFormat? subDocumentStatus? uploadedFiles? userDocumentStatus? userEdited?

Properties

Optional _isNew

_isNew?: boolean

Optional analyzerMetadata

analyzerMetadata?: AnalyzerMetadataModel

Optional annotateOnlyFirstLineItem

annotateOnlyFirstLineItem?: boolean

Optional annotatedAggregated

annotatedAggregated?: AggregatedCaseDataModel

Optional annotatedExecutionStrategy

annotatedExecutionStrategy?: ExecutionStrategy

Optional annotatedLineItem

annotatedLineItem?: LineItemModel

Optional caseId

caseId?: string

Optional classificationStatus

classificationStatus?: ClassificationStatus

Optional code

code?: string

Optional customValidationMessages

customValidationMessages?: ValidationError[]

Optional customerId

customerId?: string

Optional documentCode

documentCode?: DocumentCode

Optional documentReference

documentReference?: Meta<string>

Optional documentStatus

documentStatus?: DocumentStatus

Optional documentType

documentType?: DigicustDocumentType

Optional extractId

extractId?: string

Optional fileName

fileName?: string

Optional id

id?: string

Optional isCondensed

isCondensed?: boolean

Optional isPseudonymized

isPseudonymized?: boolean

Optional issueDate

issueDate?: DateTimeModel

Optional modifiedBy

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

Type declaration

  • Optional date?: Date
  • Optional displayName?: string
  • Optional id?: string

Optional pageCount

pageCount?: number

Optional pages

pages?: DocumentPage[]

Optional priority

priority?: "beforeNormalization" | "fallback" | "afterNormalization" | "replace"

Optional processing

processing?: ProcessingModel

Optional projectId

projectId?: string

Optional queueId

queueId?: string

Optional receivedAt

receivedAt?: Date

Optional reference

reference?: string

Optional sourceMaterialId

sourceMaterialId?: string

Optional specialFileFormat

specialFileFormat?: "xlsx" | "xml" | "csv"

Special file format that requires different processing than normal OCR. Examples: 'xlsx', 'xml', 'csv' for structured data files.

Optional subDocumentStatus

subDocumentStatus?: SubDocumentStatus

Optional uploadedFiles

uploadedFiles?: UploadedFileModel[]

Optional userDocumentStatus

userDocumentStatus?: UserDocumentStatus

Optional userEdited

userEdited?: boolean

Settings

Member Visibility

Theme

On This Page

_isNewanalyzerMetadataannotateOnlyFirstLineItemannotatedAggregatedannotatedExecutionStrategyannotatedLineItemcaseIdclassificationStatuscodecustomValidationMessagescustomerIddocumentCodedocumentReferencedocumentStatusdocumentTypeextractIdfileNameidisCondensedisPseudonymizedissueDatemodifiedBypageCountpagespriorityprocessingprojectIdqueueIdreceivedAtreferencesourceMaterialIdspecialFileFormatsubDocumentStatusuploadedFilesuserDocumentStatususerEdited