Class Word

constructor

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

  Parameters

  • Optionalsource: DeepPartial<Word>

  Returns Word

Readonly_type

Readonlyconfidence

Readonlyglyphs

Readonlyroi

Readonlytext

serialize

• serialize(
      config?: ToJsonConfiguration,
  ): {
      _type?: "Word";
      confidence?: number;
      glyphs?: {
          _type?: "Glyph";
          confidence?: number;
          roi?: Point[];
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          text?: string;
      }[];
      roi?: Point[];
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly _type?: "Word" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly glyphs?: { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | und...;
      text?: string;
  }

  Parameters

  • Optionalconfig: ToJsonConfiguration

  Returns {
      _type?: "Word";
      confidence?: number;
      glyphs?: {
          _type?: "Glyph";
          confidence?: number;
          roi?: Point[];
          serialize?: (
              config?: ToJsonConfiguration,
          ) => { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
          text?: string;
      }[];
      roi?: Point[];
      serialize?: (
          config?: ToJsonConfiguration,
      ) => { readonly _type?: "Word" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly glyphs?: { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | und...;
      text?: string;
  }

  • Optional Readonly_type?: "Word"

  • Optional Readonlyconfidence?: number

    Text confidence. Range is [0-1].

  • Optional Readonlyglyphs?: {
        _type?: "Glyph";
        confidence?: number;
        roi?: Point[];
        serialize?: (
            config?: ToJsonConfiguration,
        ) => { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; serialize?: ((config?: ToJsonConfiguration | undefined) => ...) | undefined; };
        text?: string;
    }[]

    List of glyphs.

  • Optional Readonlyroi?: Point[]

    Quad where the text was found in image coordinates. The order of the points is clockwise starting from the top left.

  • Optionalserialize?: (
        config?: ToJsonConfiguration,
    ) => { readonly _type?: "Word" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | undefined; readonly glyphs?: { readonly _type?: "Glyph" | undefined; readonly text?: string | undefined; readonly confidence?: number | undefined; readonly roi?: Point[] | und...

  • Optional Readonlytext?: string

    The recognized text.