Class GenericDocument

constructor

• new GenericDocument(source?: DeepPartial<GenericDocument>): GenericDocument

  Parameters

  • Optionalsource: DeepPartial<GenericDocument>

  Returns GenericDocument

Readonlychildren

Readonlyconfidence

ReadonlyconfidenceWeight

Readonlycrop

Readonlyfields

Readonlyquad

ReadonlyquadInRoot

Readonlytype

encodeImages

• encodeImages(): Promise<void>

  Returns Promise<void>

release

• release(): void

  Returns void

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): 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?: | {
              buffer?: string;
              clear?: () => Promise<void>;
              encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
              encodeInPlace?: () => Promise<void>;
              hibernate?: () => Promise<void>;
              info?: () => Promise<ImageInfo | null>;
              isRetained?: () => boolean;
              release?: () => void;
              retain?: () => void;
              saveImage?: (
                  path: string,
                  options?: SaveImageOptions,
              ) => Promise<boolean>;
              serialize?: (
                  imageSerializationMode: ImageSerializationMode,
              ) => Promise<
                  | (
                      { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}
                  )
                  | null,
              >;
              uniqueId?: string;
          } & {}
          | null;
          encodeImages?: () => Promise<void>;
          fields?: {
              confidenceWeight?: number;
              encodeImages?: () => Promise<void>;
              image?:
                  | {
                      buffer?: string;
                      clear?: () => Promise<(...)>;
                      encodeImage?: (options?: (...) | (...)) => Promise<(...)>;
                      encodeInPlace?: () => Promise<(...)>;
                      hibernate?: () => Promise<(...)>;
                      info?: () => Promise<(...)>;
                      isRetained?: () => boolean;
                      release?: () => void;
                      retain?: () => void;
                      saveImage?: (path: string, options?: (...) | (...)) => Promise<(...)>;
                      serialize?: (
                          imageSerializationMode: ImageSerializationMode,
                      ) => Promise<(...)>;
                      uniqueId?: string;
                  } & {}
                  | null;
              parsedData?: {
                  serialize?: (
                      config?: (...) | (...),
                  ) => { readonly type?: FieldDataFormat | undefined; readonly value?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                  type?: FieldDataFormat;
                  value?: string;
              }[];
              polygonInRoot?: Point[];
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => 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) => ...
                  ),
              >;
              type?: {
                  commonType?: CommonFieldType
                  | null;
                  fullName?: string;
                  listIndex?: number | null;
                  name?: string;
                  normalizedName?: string;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { 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?: | {
                  confidence?: number;
                  serialize?: (
                      config?: (...) | (...),
                  ) => { confidence?: ...; serialize?: ...; text?: ... };
                  text?: string;
              } & {}
              | null;
          }[];
          quad?: Point[];
          quadInRoot?: Point[];
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => 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...;
          type?: {
              fullName?: string;
              listIndex?: number | null;
              name?: string;
              normalizedName?: string;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          };
      },
  >

  Parameters

  • Optionalconfig: ToJsonConfiguration

  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?: | {
              buffer?: string;
              clear?: () => Promise<void>;
              encodeImage?: (options?: EncodeImageOptions) => Promise<string | null>;
              encodeInPlace?: () => Promise<void>;
              hibernate?: () => Promise<void>;
              info?: () => Promise<ImageInfo | null>;
              isRetained?: () => boolean;
              release?: () => void;
              retain?: () => void;
              saveImage?: (
                  path: string,
                  options?: SaveImageOptions,
              ) => Promise<boolean>;
              serialize?: (
                  imageSerializationMode: ImageSerializationMode,
              ) => Promise<
                  | (
                      { readonly uniqueId?: string | undefined; readonly buffer?: string | undefined; serialize?: ((imageSerializationMode: ImageSerializationMode) => Promise<(... & {}) | null>) | undefined; ... 8 more ...; retain?: (() => void) | undefined; } & {}
                  )
                  | null,
              >;
              uniqueId?: string;
          } & {}
          | null;
          encodeImages?: () => Promise<void>;
          fields?: {
              confidenceWeight?: number;
              encodeImages?: () => Promise<void>;
              image?:
                  | {
                      buffer?: string;
                      clear?: () => Promise<(...)>;
                      encodeImage?: (options?: (...) | (...)) => Promise<(...)>;
                      encodeInPlace?: () => Promise<(...)>;
                      hibernate?: () => Promise<(...)>;
                      info?: () => Promise<(...)>;
                      isRetained?: () => boolean;
                      release?: () => void;
                      retain?: () => void;
                      saveImage?: (path: string, options?: (...) | (...)) => Promise<(...)>;
                      serialize?: (
                          imageSerializationMode: ImageSerializationMode,
                      ) => Promise<(...)>;
                      uniqueId?: string;
                  } & {}
                  | null;
              parsedData?: {
                  serialize?: (
                      config?: (...) | (...),
                  ) => { readonly type?: FieldDataFormat | undefined; readonly value?: string | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
                  type?: FieldDataFormat;
                  value?: string;
              }[];
              polygonInRoot?: Point[];
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => 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) => ...
                  ),
              >;
              type?: {
                  commonType?: CommonFieldType
                  | null;
                  fullName?: string;
                  listIndex?: number | null;
                  name?: string;
                  normalizedName?: string;
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { 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?: | {
                  confidence?: number;
                  serialize?: (
                      config?: (...) | (...),
                  ) => { confidence?: ...; serialize?: ...; text?: ... };
                  text?: string;
              } & {}
              | null;
          }[];
          quad?: Point[];
          quadInRoot?: Point[];
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => 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...;
          type?: {
              fullName?: string;
              listIndex?: number | null;
              name?: string;
              normalizedName?: string;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly name?: string | undefined; readonly fullName?: string | undefined; readonly normalizedName?: string | undefined; readonly listIndex?: number | null | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          };
      },
  >