Class GenericDocument

Generic document.

Hierarchy (view full)

Constructors

constructor

Properties

children confidence confidenceWeight crop fields quad quadInRoot type

Methods

encodeImages release serialize

Constructors

constructor

Properties

Readonly children

children: GenericDocument[]

List of document sub-documents.

Readonly confidence

confidence: number

The average confidence in the accuracy of the document recognition result.

Default is 0

Readonly confidenceWeight

confidenceWeight: number

The weight of the confidence. Can be used to calculate the weighted average confidence of two documents.

Default is 0

Readonly crop

crop: null | ImageRef

Image crop of the document.

Readonly fields

fields: Field[]

List of document fields.

Readonly quad

quad: Point[]

Coordinates of the document in the parent document coordinate system.

Readonly quadInRoot

quadInRoot: Point[]

Coordinates of the document in the root document coordinate system.

Readonly type

type: GenericDocumentType

Document type.

Methods

encodeImages

  • encodeImages(): Promise<void>

  • Returns Promise<void>

release

  • release(): void

  • Returns void

serialize

  • serialize(config?): Promise<{
        children?: (undefined | ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: {} | undefined; } | undefined; ... 9 more ...; encodeImages?: {} | undefined; }))[];
        confidence?: number;
        confidenceWeight?: number;
        crop?: null | {
            buffer: undefined | string;
            uniqueId?: string;
            clear?: any;
            clone?: any;
            encodeImage?: any;
            encodeInPlace?: any;
            hibernate?: any;
            info?: any;
            isRetained?: any;
            release?: any;
            retain?: any;
            saveImage?: any;
            serialize?: any;
        };
        fields?: (undefined | {
            confidenceWeight?: number;
            image?: null | {
                buffer: undefined | string;
                uniqueId?: string;
                clear?: any;
                clone?: any;
                encodeImage?: any;
                encodeInPlace?: any;
                hibernate?: any;
                info?: any;
                isRetained?: any;
                release?: any;
                retain?: any;
                saveImage?: any;
                serialize?: any;
            };
            parsedData?: (undefined | {
                type?: (...) | (...);
                value?: (...) | (...);
                serialize?: any;
            })[];
            polygonInRoot?: (undefined | {
                x?: (...) | (...);
                y?: (...) | (...);
            })[];
            type?: {
                commonType?: null | CommonFieldType;
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                serialize?: any;
            };
            validationStatus?: FieldValidationStatus;
            value?: null | {
                confidence?: number;
                text?: string;
                serialize?: any;
            };
            encodeImages?: any;
            release?: any;
            serialize?: any;
        })[];
        quad?: (undefined | {
            x?: number;
            y?: number;
        })[];
        quadInRoot?: (undefined | {
            x?: number;
            y?: number;
        })[];
        type?: {
            fullName?: string;
            listIndex?: null | number;
            name?: string;
            normalizedName?: string;
            serialize?: any;
        };
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

  • Parameters

    Returns Promise<{
        children?: (undefined | ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: {} | undefined; } | undefined; ... 9 more ...; encodeImages?: {} | undefined; }))[];
        confidence?: number;
        confidenceWeight?: number;
        crop?: null | {
            buffer: undefined | string;
            uniqueId?: string;
            clear?: any;
            clone?: any;
            encodeImage?: any;
            encodeInPlace?: any;
            hibernate?: any;
            info?: any;
            isRetained?: any;
            release?: any;
            retain?: any;
            saveImage?: any;
            serialize?: any;
        };
        fields?: (undefined | {
            confidenceWeight?: number;
            image?: null | {
                buffer: undefined | string;
                uniqueId?: string;
                clear?: any;
                clone?: any;
                encodeImage?: any;
                encodeInPlace?: any;
                hibernate?: any;
                info?: any;
                isRetained?: any;
                release?: any;
                retain?: any;
                saveImage?: any;
                serialize?: any;
            };
            parsedData?: (undefined | {
                type?: (...) | (...);
                value?: (...) | (...);
                serialize?: any;
            })[];
            polygonInRoot?: (undefined | {
                x?: (...) | (...);
                y?: (...) | (...);
            })[];
            type?: {
                commonType?: null | CommonFieldType;
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                serialize?: any;
            };
            validationStatus?: FieldValidationStatus;
            value?: null | {
                confidence?: number;
                text?: string;
                serialize?: any;
            };
            encodeImages?: any;
            release?: any;
            serialize?: any;
        })[];
        quad?: (undefined | {
            x?: number;
            y?: number;
        })[];
        quadInRoot?: (undefined | {
            x?: number;
            y?: number;
        })[];
        type?: {
            fullName?: string;
            listIndex?: null | number;
            name?: string;
            normalizedName?: string;
            serialize?: any;
        };
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

Settings

Member Visibility

Theme

On This Page

constructorchildrenconfidenceconfidenceWeightcropfieldsquadquadInRoottypeencodeImagesreleaseserialize