Class ClassificationField

Represents a classifier value.

Hierarchy (View Summary)

BaseField
- ClassificationField

Index

Constructors

Properties

confidence pageId? reconstructed value?

Methods

compare toString arraySum

Constructors

constructor

new ClassificationField(
__namedParameters: BaseFieldConstructor,
): ClassificationField
Parameters
- __namedParameters: BaseFieldConstructor
Returns ClassificationField
Overrides BaseField.constructor
- Defined in src/v1/parsing/standard/classification.ts:12

Properties

confidence

confidence: number

The confidence score of the prediction.

`Optional`pageId

pageId?: number

Page ID for multi-page document.

reconstructed

reconstructed: boolean

true when the field was reconstructed or computed using other fields.

`Optional`value

value?: string

The classification.

Methods

compare

compare(other: BaseField): boolean
Compares two field values for semantic equality.
Parameters
- other: BaseField
Returns boolean
Inherited from BaseField.compare
- Defined in src/v1/parsing/standard/base.ts:54

toString

toString(): string
Default string representation.

Returns string
Inherited from BaseField.toString
- Defined in src/v1/parsing/standard/base.ts:80

`Static`arraySum

arraySum(array: BaseField[]): number
Parameters
- array: BaseField[]
  Array of Fields
Returns number
Sum of all the Fields values in the array
Inherited from BaseField.arraySum
- Defined in src/v1/parsing/standard/base.ts:67