Package com.azure.ai.documentintelligence.models

Class DocumentFieldType

java.lang.Object
com.azure.core.util.ExpandableStringEnum<DocumentFieldType>
com.azure.ai.documentintelligence.models.DocumentFieldType
public final class DocumentFieldType extends com.azure.core.util.ExpandableStringEnum<DocumentFieldType>
Semantic data type of the field value.

  • Field Details

    • STRING

      public static final DocumentFieldType STRING
      Plain text.

    • DATE

      public static final DocumentFieldType DATE
      Date, normalized to ISO 8601 (YYYY-MM-DD) format.

    • TIME

      public static final DocumentFieldType TIME
      Time, normalized to ISO 8601 (hh:mm:ss) format.

    • PHONE_NUMBER

      public static final DocumentFieldType PHONE_NUMBER
      Phone number, normalized to E.164 (+{CountryCode}{SubscriberNumber}) format.

    • NUMBER

      public static final DocumentFieldType NUMBER
      Floating point number, normalized to double precision floating point.

    • INTEGER

      public static final DocumentFieldType INTEGER
      Integer number, normalized to 64-bit signed integer.

    • SELECTION_MARK

      public static final DocumentFieldType SELECTION_MARK
      Is field selected?.

    • COUNTRY_REGION

      public static final DocumentFieldType COUNTRY_REGION
      Country/region, normalized to ISO 3166-1 alpha-3 format (ex. USA).

    • SIGNATURE

      public static final DocumentFieldType SIGNATURE
      Is signature present?.

    • ARRAY

      public static final DocumentFieldType ARRAY
      List of subfields of the same type.

    • OBJECT

      public static final DocumentFieldType OBJECT
      Named list of subfields of potentially different types.

    • CURRENCY

      public static final DocumentFieldType CURRENCY
      Currency amount with optional currency symbol and unit.

    • ADDRESS

      public static final DocumentFieldType ADDRESS
      Parsed address.

    • BOOLEAN

      public static final DocumentFieldType BOOLEAN
      Boolean value, normalized to true or false.

    • SELECTION_GROUP

      public static final DocumentFieldType SELECTION_GROUP
      Array of selected string values.

  • Constructor Details

    • DocumentFieldType

      @Deprecated public DocumentFieldType()
      Deprecated.
      Use the fromString(String) factory method.
      Creates a new instance of DocumentFieldType value.

  • Method Details

    • fromString

      public static DocumentFieldType fromString(String name)
      Creates or finds a DocumentFieldType from its string representation.
      Parameters:
      name - a name to look for.
      Returns:
      the corresponding DocumentFieldType.

    • values

      public static Collection<DocumentFieldType> values()
      Gets known DocumentFieldType values.
      Returns:
      known DocumentFieldType values.