DocumentFieldType Class

Reference

Package:: com.azure.ai.documentintelligence.models

Maven Artifact:: com.azure:azure-ai-documentintelligence:1.0.0

java.lang.Object
- com.azure.core.util.ExpandableStringEnum<T>
- - com.azure.ai.documentintelligence.models.DocumentFieldType

public final class DocumentFieldType
extends ExpandableStringEnum<DocumentFieldType>

Semantic data type of the field value.

Field Summary

Modifier and Type	Field and Description
static final DocumentFieldType	ADDRESS Parsed address.
static final DocumentFieldType	ARRAY List of subfields of the same type.
static final DocumentFieldType	BOOLEAN Boolean value, normalized to true or false.
static final DocumentFieldType	COUNTRY_REGION Country/region, normalized to ISO 3166-1 alpha-3 format (ex.
static final DocumentFieldType	CURRENCY Currency amount with optional currency symbol and unit.
static final DocumentFieldType	DATE Date, normalized to ISO 8601 (YYYY-MM-DD) format.
static final DocumentFieldType	INTEGER Integer number, normalized to 64-bit signed integer.
static final DocumentFieldType	NUMBER Floating point number, normalized to double precision floating point.
static final DocumentFieldType	OBJECT Named list of subfields of potentially different types.
static final DocumentFieldType	PHONE_NUMBER Phone number, normalized to E.164 (+{CountryCode}{SubscriberNumber}) format.
static final DocumentFieldType	SELECTION_GROUP Array of selected string values.
static final DocumentFieldType	SELECTION_MARK Is field selected?.
static final DocumentFieldType	SIGNATURE Is signature present?.
static final DocumentFieldType	STRING Plain text.
static final DocumentFieldType	TIME Time, normalized to ISO 8601 (hh:mm:ss) format.

Constructor Summary

Constructor	Description
DocumentFieldType()	Deprecated Use the fromString(String name) factory method. Creates a new instance of DocumentFieldType value.

Constructor

Description

DocumentFieldType()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of DocumentFieldType value.

Method Summary

Modifier and Type	Method and Description
static DocumentFieldType	fromString(String name) Creates or finds a DocumentFieldType from its string representation.
static Collection<DocumentFieldType>	values() Gets known DocumentFieldType values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

ADDRESS

public static final DocumentFieldType ADDRESS

Parsed address.

ARRAY

public static final DocumentFieldType ARRAY

List of subfields of the same type.

BOOLEAN

public static final DocumentFieldType BOOLEAN

Boolean value, normalized to true or false.

COUNTRY_REGION

public static final DocumentFieldType COUNTRY_REGION

Country/region, normalized to ISO 3166-1 alpha-3 format (ex. USA).

CURRENCY

public static final DocumentFieldType CURRENCY

Currency amount with optional currency symbol and unit.

DATE

public static final DocumentFieldType DATE

Date, normalized to ISO 8601 (YYYY-MM-DD) format.

INTEGER

public static final DocumentFieldType INTEGER

Integer number, normalized to 64-bit signed integer.

NUMBER

public static final DocumentFieldType NUMBER

Floating point number, normalized to double precision floating point.

OBJECT

public static final DocumentFieldType OBJECT

Named list of subfields of potentially different types.

PHONE_NUMBER

public static final DocumentFieldType PHONE_NUMBER

Phone number, normalized to E.164 (+{CountryCode}{SubscriberNumber}) format.

SELECTION_GROUP

public static final DocumentFieldType SELECTION_GROUP

Array of selected string values.

SELECTION_MARK

public static final DocumentFieldType SELECTION_MARK

Is field selected?.

SIGNATURE

public static final DocumentFieldType SIGNATURE

Is signature present?.

STRING

public static final DocumentFieldType STRING

Plain text.

TIME

public static final DocumentFieldType TIME

Time, normalized to ISO 8601 (hh:mm:ss) format.

Constructor Details