Class DocumentClassifierResult

constructor

• new DocumentClassifierResult(
      source?: DeepPartial<DocumentClassifierResult>,
  ): DocumentClassifierResult

  Parameters

  • Optionalsource: DeepPartial<DocumentClassifierResult>

  Returns DocumentClassifierResult

Readonlyconfidence

ReadonlydocumentScanningResult

ReadonlydocumentType

Readonlystatus

encodeImages

• encodeImages(): Promise<void>

  Returns Promise<void>

release

• release(): void

  Returns void

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): Promise<
      {
          confidence?: number;
          documentScanningResult?: {
              croppedImage?: | {
                  buffer?: string;
                  clear?: () => Promise<void>;
                  encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
                  encodeInPlace?: () => Promise<void>;
                  hibernate?: () => Promise<void>;
                  info?: () => Promise<(...) | (...)>;
                  isRetained?: () => boolean;
                  release?: () => void;
                  retain?: () => void;
                  saveImage?: (
                      path: string,
                      options?: SaveImageOptions,
                  ) => Promise<boolean>;
                  serialize?: (
                      imageSerializationMode: ImageSerializationMode,
                  ) => Promise<(...) | (...)>;
                  uniqueId?: string;
              } & {}
              | null;
              detectionResult?: {
                  aspectRatio?: number;
                  averageBrightness?: number;
                  detectionScores?: {
                      angleScore?: number;
                      aspectRatioScore?: number;
                      distanceScore?: number;
                      heightScore?: number;
                      lineCoverageScore?: 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...;
                      sizeScore?: number;
                      totalScore?: number;
                      widthScore?: number;
                  };
                  displacement?: DocumentDisplacement;
                  displacementVector?: Point;
                  horizontalLines?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
                  horizontalLinesNormalized?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
                  points?: Point[];
                  pointsNormalized?: Point[];
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { 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?: DocumentDetectionStatus;
                  verticalLines?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
                  verticalLinesNormalized?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
              };
              encodeImages?: () => Promise<void>;
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => Promise<
                  (
                      { readonly detectionResult?: { readonly status?: DocumentDetectionStatus | undefined; readonly detectionScores?: { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; ... 6 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 10 ...
                  ),
              >;
          };
          documentType?: DocumentType;
          encodeImages?: () => Promise<void>;
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => Promise<{ readonly documentType?: DocumentType | undefined; readonly confidence?: number | undefined; readonly status?: DocumentClassifierStatus | undefined; readonly documentScanningResult?: { ...; } | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => Promise<...>) | undefined; release?: (() => ...;
          status?: DocumentClassifierStatus;
      },
  >

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns Promise<
      {
          confidence?: number;
          documentScanningResult?: {
              croppedImage?: | {
                  buffer?: string;
                  clear?: () => Promise<void>;
                  encodeImage?: (options?: EncodeImageOptions) => Promise<(...) | (...)>;
                  encodeInPlace?: () => Promise<void>;
                  hibernate?: () => Promise<void>;
                  info?: () => Promise<(...) | (...)>;
                  isRetained?: () => boolean;
                  release?: () => void;
                  retain?: () => void;
                  saveImage?: (
                      path: string,
                      options?: SaveImageOptions,
                  ) => Promise<boolean>;
                  serialize?: (
                      imageSerializationMode: ImageSerializationMode,
                  ) => Promise<(...) | (...)>;
                  uniqueId?: string;
              } & {}
              | null;
              detectionResult?: {
                  aspectRatio?: number;
                  averageBrightness?: number;
                  detectionScores?: {
                      angleScore?: number;
                      aspectRatioScore?: number;
                      distanceScore?: number;
                      heightScore?: number;
                      lineCoverageScore?: 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...;
                      sizeScore?: number;
                      totalScore?: number;
                      widthScore?: number;
                  };
                  displacement?: DocumentDisplacement;
                  displacementVector?: Point;
                  horizontalLines?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
                  horizontalLinesNormalized?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
                  points?: Point[];
                  pointsNormalized?: Point[];
                  serialize?: (
                      config?: ToJsonConfiguration,
                  ) => { 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?: DocumentDetectionStatus;
                  verticalLines?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
                  verticalLinesNormalized?: {
                      end?: Point;
                      serialize?: (config?: ...) => ...;
                      start?: Point;
                  }[];
              };
              encodeImages?: () => Promise<void>;
              release?: () => void;
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => Promise<
                  (
                      { readonly detectionResult?: { readonly status?: DocumentDetectionStatus | undefined; readonly detectionScores?: { readonly totalScore?: number | undefined; readonly distanceScore?: number | undefined; ... 6 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; } | undefined; ... 10 ...
                  ),
              >;
          };
          documentType?: DocumentType;
          encodeImages?: () => Promise<void>;
          release?: () => void;
          serialize?: (
              config?: ToJsonConfiguration,
          ) => Promise<{ readonly documentType?: DocumentType | undefined; readonly confidence?: number | undefined; readonly status?: DocumentClassifierStatus | undefined; readonly documentScanningResult?: { ...; } | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => Promise<...>) | undefined; release?: (() => ...;
          status?: DocumentClassifierStatus;
      },
  >