DocumentSignatureField interface

  • Reference
Package:
@azure/ai-form-recognizer

A DocumentField that indicates the state of a signature, represented as a string.

Extends
DocumentFieldCommon

Properties

kind

Field kind: "signature".
value

The state of the signature field. One of:

  • "unsigned"
  • "signed"

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: "signature".

kind: "signature"

Property Value

"signature"

value

The state of the signature field. One of:

  • "unsigned"
  • "signed"

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

value: "signed" | "unsigned"

Property Value

"signed" | "unsigned"

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