Class PerformOcrResult

constructor

• new PerformOcrResult(source?): PerformOcrResult

• Parameters

  • Optional source: DeepPartial<PerformOcrResult>

  Returns PerformOcrResult

Readonly pages

Readonly recognizedText

serialize

• serialize(config?): {
      pages?: {
          _type?: "Page";
          blocks?: {
              _type?: "Block";
              confidence?: number;
              lines?: {
                  _type?: (...) | (...);
                  confidence?: (...) | (...);
                  roi?: (...) | (...);
                  text?: (...) | (...);
                  words?: (...) | (...);
                  serialize?(config?): { readonly _type?: "Line" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly words?: { readonly _type?: "Word" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined...;
              }[];
              roi?: Point[];
              text?: string;
              serialize?(config?): { 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...;
          }[];
          confidence?: number;
          roi?: Point[];
          text?: string;
          serialize?(config?): { 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...;
      }[];
      recognizedText?: string;
      serialize?(config?): { 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

  • Optional config: ToJsonConfiguration

  Returns {
      pages?: {
          _type?: "Page";
          blocks?: {
              _type?: "Block";
              confidence?: number;
              lines?: {
                  _type?: (...) | (...);
                  confidence?: (...) | (...);
                  roi?: (...) | (...);
                  text?: (...) | (...);
                  words?: (...) | (...);
                  serialize?(config?): { readonly _type?: "Line" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly words?: { readonly _type?: "Word" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined...;
              }[];
              roi?: Point[];
              text?: string;
              serialize?(config?): { 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...;
          }[];
          confidence?: number;
          roi?: Point[];
          text?: string;
          serialize?(config?): { 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...;
      }[];
      recognizedText?: string;
      serialize?(config?): { 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 Readonly pages?: {
        _type?: "Page";
        blocks?: {
            _type?: "Block";
            confidence?: number;
            lines?: {
                _type?: (...) | (...);
                confidence?: (...) | (...);
                roi?: (...) | (...);
                text?: (...) | (...);
                words?: (...) | (...);
                serialize?(config?): { readonly _type?: "Line" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly words?: { readonly _type?: "Word" | undefined; ... 4 more ...; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; }[] | undefined...;
            }[];
            roi?: Point[];
            text?: string;
            serialize?(config?): { 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...;
        }[];
        confidence?: number;
        roi?: Point[];
        text?: string;
        serialize?(config?): { 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...;
    }[]

    The array of recognized OCR pages.

  • Optional Readonly recognizedText?: string

    The OCR result as plain text.

  • serialize?:function

    • serialize(config?): { 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

      • Optional config: ToJsonConfiguration

      Returns { 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) =...