react-native-scanbot-sdk
    Preparing search index...

    Class DocumentQualityAnalyzerCompatibilityModeConfiguration

    Configuration for the compatibility mode of the Document Quality Analyzer. In this mode, the analyzer will return results that are identical to older versions of the SDK.

    Index
    inspectSmallText: boolean

    Inspect small text (typically less than 12 pixels height) when analyzing the document quality. If true, processing will be slower, but when the quality issue with a document is the low resolution of the text, then the issue will be caught.

    Default is false.

    minimumAcceptableQuality: DocumentQuality

    This setting describes how the Document Quality Analyzer in v8 compatibility mode will behave. Minimum compatibility-mode quality that gets converted to DocumentQualityAssessment.ACCEPTABLE. Compatibility-mode quality levels equal to or higher than minimumAcceptableQuality result in an ACCEPTABLE quality assessment.

    Default is REASONABLE.

    minimumUncertainQuality: DocumentQuality

    Minimum compatibility-mode quality that gets converted to DocumentQualityAssessment.UNCERTAIN. Compatibility-mode quality levels between minimumUncertainQuality (inclusive) and minimumAcceptableQuality (exclusive) result in an UNCERTAIN quality assessment.

    Default is POOR.

    mode: "V8"

    Compatibility mode to use.

    Default is V8.

    • Parameters

      Returns {
          inspectSmallText?: boolean;
          minimumAcceptableQuality?: DocumentQuality;
          minimumUncertainQuality?: DocumentQuality;
          mode?: "V8";
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly mode?: "V8" | undefined; minimumAcceptableQuality?: DocumentQuality | undefined; minimumUncertainQuality?: DocumentQuality | undefined; inspectSmallText?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
      }

      • OptionalinspectSmallText?: boolean

        Inspect small text (typically less than 12 pixels height) when analyzing the document quality. If true, processing will be slower, but when the quality issue with a document is the low resolution of the text, then the issue will be caught.

        Default is false.

      • OptionalminimumAcceptableQuality?: DocumentQuality

        This setting describes how the Document Quality Analyzer in v8 compatibility mode will behave. Minimum compatibility-mode quality that gets converted to DocumentQualityAssessment.ACCEPTABLE. Compatibility-mode quality levels equal to or higher than minimumAcceptableQuality result in an ACCEPTABLE quality assessment.

        Default is REASONABLE.

      • OptionalminimumUncertainQuality?: DocumentQuality

        Minimum compatibility-mode quality that gets converted to DocumentQualityAssessment.UNCERTAIN. Compatibility-mode quality levels between minimumUncertainQuality (inclusive) and minimumAcceptableQuality (exclusive) result in an UNCERTAIN quality assessment.

        Default is POOR.

      • Optional Readonlymode?: "V8"

        Compatibility mode to use.

        Default is V8.

      • Optionalserialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly mode?: "V8" | undefined; minimumAcceptableQuality?: DocumentQuality | undefined; minimumUncertainQuality?: DocumentQuality | undefined; inspectSmallText?: boolean | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }