Class PerformOcrResult

constructor

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

  Parameters

  • Optionalsource: DeepPartial<PerformOcrResult>

  Returns PerformOcrResult

Readonlypages

ReadonlyrecognizedText

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      pages?: {
          _type?: "Page";
          blocks?: {
              _type?: "Block";
              confidence?: number;
              lines?: {
                  _type?: (...) | (...);
                  confidence?: (...) | (...);
                  roi?: (...) | (...);
                  serialize?: (...) | (...);
                  text?: (...) | (...);
                  words?: (...) | (...);
              }[];
              roi?: Point[];
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly _type?: "Block" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly lines?: { readonly _type?: "Line" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefine...;
              text?: string;
          }[];
          confidence?: number;
          roi?: Point[];
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly _type?: "Page" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly blocks?: { readonly _type?: "Block" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefin...;
          text?: string;
      }[];
      recognizedText?: string;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly recognizedText?: string | undefined; readonly pages?: { readonly _type?: "Page" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly blocks?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) =...;
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      pages?: {
          _type?: "Page";
          blocks?: {
              _type?: "Block";
              confidence?: number;
              lines?: {
                  _type?: (...) | (...);
                  confidence?: (...) | (...);
                  roi?: (...) | (...);
                  serialize?: (...) | (...);
                  text?: (...) | (...);
                  words?: (...) | (...);
              }[];
              roi?: Point[];
              serialize?: (
                  config?: ToJsonConfiguration,
              ) => { readonly _type?: "Block" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly lines?: { readonly _type?: "Line" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefine...;
              text?: string;
          }[];
          confidence?: number;
          roi?: Point[];
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly _type?: "Page" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly blocks?: { readonly _type?: "Block" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefin...;
          text?: string;
      }[];
      recognizedText?: string;
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly recognizedText?: string | undefined; readonly pages?: { readonly _type?: "Page" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly blocks?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) =...;
  }

  • Optional Readonlypages?: {
        _type?: "Page";
        blocks?: {
            _type?: "Block";
            confidence?: number;
            lines?: {
                _type?: (...) | (...);
                confidence?: (...) | (...);
                roi?: (...) | (...);
                serialize?: (...) | (...);
                text?: (...) | (...);
                words?: (...) | (...);
            }[];
            roi?: Point[];
            serialize?: (
                config?: ToJsonConfiguration,
            ) => { readonly _type?: "Block" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly lines?: { readonly _type?: "Line" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefine...;
            text?: string;
        }[];
        confidence?: number;
        roi?: Point[];
        serialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly _type?: "Page" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly blocks?: { readonly _type?: "Block" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefin...;
        text?: string;
    }[]

    The array of recognized OCR pages.

  • Optional ReadonlyrecognizedText?: string

    The OCR result as plain text.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { readonly recognizedText?: string | undefined; readonly pages?: { readonly _type?: "Page" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly blocks?: { ...; }[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) =...