Class GenericDocument

Generic document.

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?: ({ 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: 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; } & {})>;
            } & {};
            parsedData?: {
                type?: FieldDataFormat;
                value?: string;
                serialize?(config?): { readonly type?: FieldDataFormat | undefined; readonly value?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            polygonInRoot?: Point[];
            type?: {
                commonType?: null | CommonFieldType;
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                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?: number;
                text?: string;
                serialize?(config?): {
                    confidence?: number;
                    text?: string;
                    serialize?(config?): { readonly text?: string | undefined; readonly confidence?: number | 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 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<{ 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...;
    }>

  • Parameters

    Returns 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: 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: 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; } & {})>;
            } & {};
            parsedData?: {
                type?: FieldDataFormat;
                value?: string;
                serialize?(config?): { readonly type?: FieldDataFormat | undefined; readonly value?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
            }[];
            polygonInRoot?: Point[];
            type?: {
                commonType?: null | CommonFieldType;
                fullName?: string;
                listIndex?: null | number;
                name?: string;
                normalizedName?: string;
                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?: number;
                text?: string;
                serialize?(config?): {
                    confidence?: number;
                    text?: string;
                    serialize?(config?): { readonly text?: string | undefined; readonly confidence?: number | 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 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<{ 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...;
    }>

Settings

Member Visibility

Theme

On This Page

constructorchildrenconfidenceconfidenceWeightcropfieldsquadquadInRoottypeencodeImagesreleaseserialize