Class Inference<DocT, PageT>Abstract

Type Parameters

  • DocT extends Prediction = Prediction

    an extension of a Prediction. Is generic by default to allow for easier optional PageT generic typing.

  • PageT extends DocT = DocT

    an extension of a DocT (Prediction). Should only be set if a document's pages have specific implementation.

Hierarchy

Constructors

constructor

Properties

endpointName? endpointVersion? extras? isRotationApplied? pages prediction product

Methods

toString cleanOutString

Constructors

constructor

Properties

Optional endpointName

endpointName?: string

Name of a document's endpoint. Has a default value for OTS APIs.

Optional endpointVersion

endpointVersion?: string

A document's version. Has a default value for OTS APIs.

Optional extras

extras?: ExtraField[] = []

Extraneous fields relating to specific tools for some APIs.

Optional isRotationApplied

isRotationApplied?: boolean

A boolean denoting whether a given inference result was rotated.

pages

pages: Page<PageT>[] = []

Wrapper for a document's pages prediction.

prediction

prediction: DocT

A document's top-level Prediction.

product

product: Product

Name and version of a given product.

Methods

toString

Static cleanOutString

  • Takes in an input string and replaces line breaks with \n.

    Returns

    cleaned out string

    Parameters

    • outStr: string

      string to cleanup

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc