Class DocumentDataExtractionResult

Contains the result of running the generic document extractor.

Hierarchy (view full)

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?: any;
            clone?: any;
            encodeImage?: any;
            encodeInPlace?: any;
            hibernate?: any;
            info?: any;
            isRetained?: any;
            release?: any;
            retain?: any;
            saveImage?: any;
            serialize?: any;
        };
        document?: null | {
            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: (...) | (...);
                    uniqueId?: (...) | (...);
                    clear?: any;
                    clone?: any;
                    encodeImage?: any;
                    encodeInPlace?: any;
                    hibernate?: any;
                    info?: any;
                    isRetained?: any;
                    release?: any;
                    retain?: any;
                    saveImage?: any;
                    serialize?: any;
                };
                parsedData?: ((...) | (...))[];
                polygonInRoot?: ((...) | (...))[];
                type?: {
                    commonType?: (...) | (...) | (...);
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?: any;
                };
                validationStatus?: FieldValidationStatus;
                value?: null | {
                    confidence?: (...) | (...);
                    text?: (...) | (...);
                    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;
        };
        documentDetectionResult?: {
            aspectRatio?: number;
            averageBrightness?: number;
            detectionScores?: {
                angleScore?: number;
                aspectRatioScore?: number;
                distanceScore?: number;
                heightScore?: number;
                lineCoverageScore?: number;
                sizeScore?: number;
                totalScore?: number;
                widthScore?: number;
                serialize?: any;
            };
            horizontalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            horizontalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            points?: (undefined | {
                x?: number;
                y?: number;
            })[];
            pointsNormalized?: (undefined | {
                x?: number;
                y?: number;
            })[];
            status?: DocumentDetectionStatus;
            verticalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            verticalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            serialize?: any;
        };
        status?: DocumentDataExtractionStatus;
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

  • Parameters

    Returns Promise<{
        croppedImage?: 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;
        };
        document?: null | {
            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: (...) | (...);
                    uniqueId?: (...) | (...);
                    clear?: any;
                    clone?: any;
                    encodeImage?: any;
                    encodeInPlace?: any;
                    hibernate?: any;
                    info?: any;
                    isRetained?: any;
                    release?: any;
                    retain?: any;
                    saveImage?: any;
                    serialize?: any;
                };
                parsedData?: ((...) | (...))[];
                polygonInRoot?: ((...) | (...))[];
                type?: {
                    commonType?: (...) | (...) | (...);
                    fullName?: (...) | (...);
                    listIndex?: (...) | (...) | (...);
                    name?: (...) | (...);
                    normalizedName?: (...) | (...);
                    serialize?: any;
                };
                validationStatus?: FieldValidationStatus;
                value?: null | {
                    confidence?: (...) | (...);
                    text?: (...) | (...);
                    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;
        };
        documentDetectionResult?: {
            aspectRatio?: number;
            averageBrightness?: number;
            detectionScores?: {
                angleScore?: number;
                aspectRatioScore?: number;
                distanceScore?: number;
                heightScore?: number;
                lineCoverageScore?: number;
                sizeScore?: number;
                totalScore?: number;
                widthScore?: number;
                serialize?: any;
            };
            horizontalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            horizontalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            points?: (undefined | {
                x?: number;
                y?: number;
            })[];
            pointsNormalized?: (undefined | {
                x?: number;
                y?: number;
            })[];
            status?: DocumentDetectionStatus;
            verticalLines?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            verticalLinesNormalized?: (undefined | {
                end?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                start?: {
                    x?: (...) | (...);
                    y?: (...) | (...);
                };
                serialize?: any;
            })[];
            serialize?: any;
        };
        status?: DocumentDataExtractionStatus;
        encodeImages?: any;
        release?: any;
        serialize?: any;
    }>

Settings

Member Visibility

Theme

On This Page

constructorcroppedImagedocumentdocumentDetectionResultstatusencodeImagesreleaseserialize