Package com.azure.ai.formrecognizer.documentanalysis.models

Class DocumentField

java.lang.Object
com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField<Object>
com.azure.ai.formrecognizer.documentanalysis.models.DocumentField
public final class DocumentField extends TypedDocumentField<Object>
An object representing the content and location of a field value.

  • Constructor Details

    • DocumentField

      public DocumentField()

  • Method Details

    • getValueAsString

      public String getValueAsString()
      Get the string value of the field.
      Returns:
      the value.

    • getValueAsDate

      public LocalDate getValueAsDate()
      Get the date value in YYYY-MM-DD format (ISO 8601).
      Returns:
      the value.

    • getValueAsTime

      public LocalTime getValueAsTime()
      Get the time value in hh:mm:ss format (ISO 8601).
      Returns:
      the value.

    • getValueAsPhoneNumber

      public String getValueAsPhoneNumber()
      Get the phone number value in E.164 format (ex. +19876543210).
      Returns:
      the value.

    • getValueAsDouble

      public Double getValueAsDouble()
      Get the double/floating point value of the field.
      Returns:
      the value.

    • getValueAsLong

      public Long getValueAsLong()
      Get the long value of the field.
      Returns:
      the value.

    • getValueAsSelectionMark

      public DocumentSelectionMarkState getValueAsSelectionMark()
      Get the selection mark value.
      Returns:
      the value.

    • getValueAsSignature

      public DocumentSignatureType getValueAsSignature()
      Get the presence of signature type.
      Returns:
      the value.

    • getValueAsCountry

      public String getValueAsCountry()
      Get the 3-letter country code value (ISO 3166-1 alpha-3).
      Returns:
      the value.

    • getValueAsList

      public List<DocumentField> getValueAsList()
      Get the array of field values.
      Returns:
      the value.

    • getValueAsMap

      public Map<String,DocumentField> getValueAsMap()
      Get the map of named field values.
      Returns:
      the value.

    • getValueAsCurrency

      public CurrencyValue getValueAsCurrency()
      Get the Currency value.
      Returns:
      the value.

    • getValueAsAddress

      public AddressValue getValueAsAddress()
      Get address value of the field.
      Returns:
      the value.