Class DocumentDataExtractionResult

Contains the result of running the document data extractor.

Constructors

constructor

Properties

croppedImage document documentDetectionResult status

Methods

encodeImages release serialize

Constructors

constructor

Properties

Readonly croppedImage

croppedImage: null | ImageRef

Crop of the document if it was detected.

Readonly document

document: null | GenericDocument

The extracted document.

Readonly documentDetectionResult

documentDetectionResult: DocumentDetectionResult

Result of the document detection in the input image.

Readonly status

status: DocumentDataExtractionStatus

The status of the extraction process.

Methods

encodeImages

  • encodeImages(): Promise<void>

  • Returns Promise<void>

release

  • release(): void

  • Returns void

serialize

  • serialize(config?): Promise<{
        croppedImage?: null | {
            buffer: undefined | string;
            uniqueId?: string;
            clear?(): Promise<void>;
            encodeImage?(options?): Promise<null | string>;
            encodeInPlace?(): Promise<void>;
            hibernate?(): Promise<void>;
            info?(): Promise<null | ImageInfo>;
            isRetained?(): boolean;
            release?(): void;
            retain?(): void;
            saveImage?(path, options?): Promise<boolean>;
            serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
        } & {};
        document?: null | {
            children?: {
                children?: { readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...;
                confidence?: number;
                confidenceWeight?: number;
                crop?: null | {
                    buffer: ...;
                    uniqueId?: ...;
                    clear?(): ...;
                    encodeImage?(options?): ...;
                    encodeInPlace?(): ...;
                    hibernate?(): ...;
                    info?(): ...;
                    isRetained?(): ...;
                    release?(): ...;
                    retain?(): ...;
                    saveImage?(path, options?): ...;
                    serialize?(imageSerializationMode): ...;
                } & {};
                fields?: {
                    confidenceWeight?: ...;
                    image?: ...;
                    parsedData?: ...;
                    polygonInRoot?: ...;
                    type?: ...;
                    validationStatus?: ...;
                    value?: ...;
                    encodeImages?(): ...;
                    release?(): ...;
                    serialize?(config?): ...;
                }[];
                quad?: Point[];
                quadInRoot?: Point[];
                type?: {
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                };
                encodeImages?(): Promise<void>;
                release?(): void;
                serialize?(config?): Promise<({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...)>;
            }[];
            confidence?: number;
            confidenceWeight?: number;
            crop?: null | {
                buffer: undefined | string;
                uniqueId?: string;
                clear?(): Promise<void>;
                encodeImage?(options?): Promise<null | string>;
                encodeInPlace?(): Promise<void>;
                hibernate?(): Promise<void>;
                info?(): Promise<null | ImageInfo>;
                isRetained?(): boolean;
                release?(): void;
                retain?(): void;
                saveImage?(path, options?): Promise<boolean>;
                serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
            } & {};
            fields?: {
                confidenceWeight?: number;
                image?: null | {
                    buffer: ...;
                    uniqueId?: ...;
                    clear?(): ...;
                    encodeImage?(options?): ...;
                    encodeInPlace?(): ...;
                    hibernate?(): ...;
                    info?(): ...;
                    isRetained?(): ...;
                    release?(): ...;
                    retain?(): ...;
                    saveImage?(path, options?): ...;
                    serialize?(imageSerializationMode): ...;
                } & {};
                parsedData?: {
                    type?: ...;
                    value?: ...;
                    serialize?(config?): ...;
                }[];
                polygonInRoot?: Point[];
                type?: {
                    commonType?: (...) | (...) | (...);
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                };
                validationStatus?: FieldValidationStatus;
                value?: null | {
                    confidence?: ...;
                    text?: ...;
                    serialize?(config?): ...;
                } & {};
                encodeImages?(): Promise<void>;
                release?(): void;
                serialize?(config?): Promise<({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...)>;
            }[];
            quad?: Point[];
            quadInRoot?: Point[];
            type?: {
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            };
            encodeImages?(): Promise<void>;
            release?(): void;
            serialize?(config?): Promise<{
                children?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...)[];
                confidence?: number;
                confidenceWeight?: number;
                crop?: null | {
                    buffer: (...) | (...);
                    uniqueId?: (...) | (...);
                    clear?(): Promise<(...)>;
                    encodeImage?(options?): Promise<(...)>;
                    encodeInPlace?(): Promise<(...)>;
                    hibernate?(): Promise<(...)>;
                    info?(): Promise<(...)>;
                    isRetained?(): boolean;
                    release?(): void;
                    retain?(): void;
                    saveImage?(path, options?): Promise<(...)>;
                    serialize?(imageSerializationMode): Promise<(...)>;
                } & {};
                fields?: {
                    confidenceWeight?: (...) | (...);
                    image?: (...) | (...) | (...);
                    parsedData?: (...) | (...);
                    polygonInRoot?: (...) | (...);
                    type?: (...) | (...);
                    validationStatus?: (...) | (...);
                    value?: (...) | (...) | (...);
                    encodeImages?(): Promise<(...)>;
                    release?(): void;
                    serialize?(config?): Promise<(...)>;
                }[];
                quad?: Point[];
                quadInRoot?: Point[];
                type?: {
                    fullName?: string;
                    listIndex?: null | number;
                    name?: string;
                    normalizedName?: string;
                    serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                };
                encodeImages?(): Promise<void>;
                release?(): void;
                serialize?(config?): Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImage...;
            }>;
        } & {};
        documentDetectionResult?: {
            aspectRatio?: number;
            averageBrightness?: number;
            detectionScores?: {
                angleScore?: number;
                aspectRatioScore?: number;
                distanceScore?: number;
                heightScore?: number;
                lineCoverageScore?: number;
                sizeScore?: number;
                totalScore?: number;
                widthScore?: number;
                serialize?(config?): { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; readonly angleScore?: number | undefined; readonly sizeScore?: number | undefined; readonly aspectRatioScore?: number | undefined; readonly lineCoverageScore?: number | undefined; readonly widthScore?: number | undefined; readon...;
            };
            displacement?: DocumentDisplacement;
            displacementVector?: Point;
            horizontalLines?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            horizontalLinesNormalized?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            points?: Point[];
            pointsNormalized?: Point[];
            status?: DocumentDetectionStatus;
            verticalLines?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            verticalLinesNormalized?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            serialize?(config?): { readonly status?: DocumentDetectionStatus | undefined; readonly detectionScores?: { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; ... 6 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 10 more ...; serialize?: ((confi...;
        };
        status?: DocumentDataExtractionStatus;
        encodeImages?(): Promise<void>;
        release?(): void;
        serialize?(config?): Promise<{ readonly status?: DocumentDataExtractionStatus | undefined; readonly document?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJ...;
    }>

  • Parameters

    Returns Promise<{
        croppedImage?: null | {
            buffer: undefined | string;
            uniqueId?: string;
            clear?(): Promise<void>;
            encodeImage?(options?): Promise<null | string>;
            encodeInPlace?(): Promise<void>;
            hibernate?(): Promise<void>;
            info?(): Promise<null | ImageInfo>;
            isRetained?(): boolean;
            release?(): void;
            retain?(): void;
            saveImage?(path, options?): Promise<boolean>;
            serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
        } & {};
        document?: null | {
            children?: {
                children?: { readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...;
                confidence?: number;
                confidenceWeight?: number;
                crop?: null | {
                    buffer: ...;
                    uniqueId?: ...;
                    clear?(): ...;
                    encodeImage?(options?): ...;
                    encodeInPlace?(): ...;
                    hibernate?(): ...;
                    info?(): ...;
                    isRetained?(): ...;
                    release?(): ...;
                    retain?(): ...;
                    saveImage?(path, options?): ...;
                    serialize?(imageSerializationMode): ...;
                } & {};
                fields?: {
                    confidenceWeight?: ...;
                    image?: ...;
                    parsedData?: ...;
                    polygonInRoot?: ...;
                    type?: ...;
                    validationStatus?: ...;
                    value?: ...;
                    encodeImages?(): ...;
                    release?(): ...;
                    serialize?(config?): ...;
                }[];
                quad?: Point[];
                quadInRoot?: Point[];
                type?: {
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                };
                encodeImages?(): Promise<void>;
                release?(): void;
                serialize?(config?): Promise<({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...)>;
            }[];
            confidence?: number;
            confidenceWeight?: number;
            crop?: null | {
                buffer: undefined | string;
                uniqueId?: string;
                clear?(): Promise<void>;
                encodeImage?(options?): Promise<null | string>;
                encodeInPlace?(): Promise<void>;
                hibernate?(): Promise<void>;
                info?(): Promise<null | ImageInfo>;
                isRetained?(): boolean;
                release?(): void;
                retain?(): void;
                saveImage?(path, options?): Promise<boolean>;
                serialize?(imageSerializationMode): Promise<null | ({ readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {})>;
            } & {};
            fields?: {
                confidenceWeight?: number;
                image?: null | {
                    buffer: ...;
                    uniqueId?: ...;
                    clear?(): ...;
                    encodeImage?(options?): ...;
                    encodeInPlace?(): ...;
                    hibernate?(): ...;
                    info?(): ...;
                    isRetained?(): ...;
                    release?(): ...;
                    retain?(): ...;
                    saveImage?(path, options?): ...;
                    serialize?(imageSerializationMode): ...;
                } & {};
                parsedData?: {
                    type?: ...;
                    value?: ...;
                    serialize?(config?): ...;
                }[];
                polygonInRoot?: Point[];
                type?: {
                    commonType?: (...) | (...) | (...);
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                };
                validationStatus?: FieldValidationStatus;
                value?: null | {
                    confidence?: ...;
                    text?: ...;
                    serialize?(config?): ...;
                } & {};
                encodeImages?(): Promise<void>;
                release?(): void;
                serialize?(config?): Promise<({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly commonType?: CommonFieldType | null | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...)>;
            }[];
            quad?: Point[];
            quadInRoot?: Point[];
            type?: {
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            };
            encodeImages?(): Promise<void>;
            release?(): void;
            serialize?(config?): Promise<{
                children?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImages?: (() ...)[];
                confidence?: number;
                confidenceWeight?: number;
                crop?: null | {
                    buffer: (...) | (...);
                    uniqueId?: (...) | (...);
                    clear?(): Promise<(...)>;
                    encodeImage?(options?): Promise<(...)>;
                    encodeInPlace?(): Promise<(...)>;
                    hibernate?(): Promise<(...)>;
                    info?(): Promise<(...)>;
                    isRetained?(): boolean;
                    release?(): void;
                    retain?(): void;
                    saveImage?(path, options?): Promise<(...)>;
                    serialize?(imageSerializationMode): Promise<(...)>;
                } & {};
                fields?: {
                    confidenceWeight?: (...) | (...);
                    image?: (...) | (...) | (...);
                    parsedData?: (...) | (...);
                    polygonInRoot?: (...) | (...);
                    type?: (...) | (...);
                    validationStatus?: (...) | (...);
                    value?: (...) | (...) | (...);
                    encodeImages?(): Promise<(...)>;
                    release?(): void;
                    serialize?(config?): Promise<(...)>;
                }[];
                quad?: Point[];
                quadInRoot?: Point[];
                type?: {
                    fullName?: string;
                    listIndex?: null | number;
                    name?: string;
                    normalizedName?: string;
                    serialize?(config?): { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                };
                encodeImages?(): Promise<void>;
                release?(): void;
                serialize?(config?): Promise<{ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 9 more ...; encodeImage...;
            }>;
        } & {};
        documentDetectionResult?: {
            aspectRatio?: number;
            averageBrightness?: number;
            detectionScores?: {
                angleScore?: number;
                aspectRatioScore?: number;
                distanceScore?: number;
                heightScore?: number;
                lineCoverageScore?: number;
                sizeScore?: number;
                totalScore?: number;
                widthScore?: number;
                serialize?(config?): { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; readonly angleScore?: number | undefined; readonly sizeScore?: number | undefined; readonly aspectRatioScore?: number | undefined; readonly lineCoverageScore?: number | undefined; readonly widthScore?: number | undefined; readon...;
            };
            displacement?: DocumentDisplacement;
            displacementVector?: Point;
            horizontalLines?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            horizontalLinesNormalized?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            points?: Point[];
            pointsNormalized?: Point[];
            status?: DocumentDetectionStatus;
            verticalLines?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            verticalLinesNormalized?: {
                end?: Point;
                start?: Point;
                serialize?(config?): { readonly start?: Point | undefined; readonly end?: Point | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            serialize?(config?): { readonly status?: DocumentDetectionStatus | undefined; readonly detectionScores?: { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; ... 6 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 10 more ...; serialize?: ((confi...;
        };
        status?: DocumentDataExtractionStatus;
        encodeImages?(): Promise<void>;
        release?(): void;
        serialize?(config?): Promise<{ readonly status?: DocumentDataExtractionStatus | undefined; readonly document?: ({ readonly type?: { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | ... 1 more ... | undefined; serialize?: ((config?: ToJ...;
    }>

Settings

Member Visibility

Theme

On This Page

constructorcroppedImagedocumentdocumentDetectionResultstatusencodeImagesreleaseserialize