Skip to main content
Deno 2 is finally here 🎉️
Learn more
Module

x/aiformrecognizer/src/interfaces/document-analysis-models.ts>DocumentField

y10/ai-form-recognizer
Latest
interface DocumentField
import { type DocumentField } from "https://deno.land/x/aiformrecognizer@v1.2.0/src/interfaces/document-analysis-models.ts";

An object representing the content and location of a field value.

Properties

type: DocumentFieldType

Data type of the field value.

optional
valueString: string

String value.

optional
valueDate: Date

Date value in YYYY-MM-DD format (ISO 8601).

optional
valueTime: string

Time value in hh:mm:ss format (ISO 8601). This value should be an ISO-8601 formatted string representing time. E.g. "HH:MM:SS" or "HH:MM:SS.mm".

optional
valuePhoneNumber: string

Phone number value in E.164 format (ex. +19876543210).

optional
valueNumber: number

Floating point value.

optional
valueInteger: number

Integer value.

optional
valueSelectionMark: SelectionMarkState

Selection mark value.

optional
valueSignature: DocumentSignatureType

Presence of signature.

optional
valueCountryRegion: string

3-letter country code value (ISO 3166-1 alpha-3).

optional
valueArray: DocumentField[]

Array of field values.

optional
valueObject: { [propertyName: string]: DocumentField; }

Dictionary of named field values.

optional
valueCurrency: CurrencyValue

Currency value.

optional
valueAddress: AddressValue

Address value.

optional
content: string

Field content.

optional
boundingRegions: BoundingRegion[]

Bounding regions covering the field.

optional
spans: DocumentSpan[]

Location of the field in the reading order concatenated content.

optional
confidence: number

Confidence of correctly extracting the field.