DocumentSelectionMarkField interface

Package:

@azure/ai-form-recognizer

A DocumentField that is has a value indicating a selection mark state (such as a checkbox or radio button), represented as a string.

Extends

DocumentFieldCommon

Properties

kind	Field kind: "selectionMark".
value	The state of the selection mark. One of: "selected" "unselected" This value may be undefined, and other variants may be introduced in the future.

Inherited Properties

boundingRegions	Bounding regions covering the field.
confidence	Confidence of correctly extracting the field.
content	The verbatim extracted text content of the field.
spans	Location of the field in the reading order concatenated content.

Property Details

kind

Field kind: "selectionMark".

kind: "selectionMark"

Property Value

"selectionMark"

value

The state of the selection mark. One of:

• "selected"
• "unselected"

This value may be undefined, and other variants may be introduced in the future.

value?: string

Property Value

string

Inherited Property Details

boundingRegions

Bounding regions covering the field.

boundingRegions?: BoundingRegion[]

Property Value

BoundingRegion[]

Inherited From DocumentFieldCommon.boundingRegions

confidence

Confidence of correctly extracting the field.

confidence?: number

Property Value

number

Inherited From DocumentFieldCommon.confidence

content

The verbatim extracted text content of the field.

content?: string

Property Value

string

Inherited From DocumentFieldCommon.content

spans

Location of the field in the reading order concatenated content.

spans?: DocumentSpan[]

Property Value

DocumentSpan[]

Inherited From DocumentFieldCommon.spans