Package com.azure.ai.formrecognizer.models

Class DocumentField

  • public final class DocumentField
extends Object
    An object representing the content and location of a field value.

    • Constructor Detail

      • DocumentField

        public DocumentField()

    • Method Detail

      • getType

        public DocumentFieldType getType()
        Get the type property: Data type of the field value.
        Returns:
        the type value.

      • getValueString

        public String getValueString()
        Get the valueString property: String value.
        Returns:
        the valueString value.

      • getValueDate

        public LocalDate getValueDate()
        Get the valueDate property: Date value in YYYY-MM-DD format (ISO 8601).
        Returns:
        the valueDate value.

      • getValueTime

        public LocalTime getValueTime()
        Get the valueTime property: Time value in hh:mm:ss format (ISO 8601).
        Returns:
        the valueTime value.

      • getValuePhoneNumber

        public String getValuePhoneNumber()
        Get the valuePhoneNumber property: Phone number value in E.164 format (ex. +19876543210).
        Returns:
        the valuePhoneNumber value.

      • getValueFloat

        public Float getValueFloat()
        Get the valueFloat property: Floating point value.
        Returns:
        the valueFloat value.

      • getValueInteger

        public Long getValueInteger()
        Get the valueInteger property: Integer value.
        Returns:
        the valueInteger value.

      • getValueSelectionMark

        public SelectionMarkState getValueSelectionMark()
        Get the valueSelectionMark property: Selection mark value.
        Returns:
        the valueSelectionMark value.

      • getValueSignature

        public DocumentSignatureType getValueSignature()
        Get the valueSignature property: Presence of signature.
        Returns:
        the valueSignature value.

      • getValueCountryRegion

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

      • getValueList

        public List<DocumentField> getValueList()
        Get the valueList property: Array of field values.
        Returns:
        the valueList value.

      • getValueMap

        public Map<String,​DocumentField> getValueMap()
        Get the valueMap property: Dictionary of named field values.
        Returns:
        the valueMap value.

      • getContent

        public String getContent()
        Get the content property: Field content.
        Returns:
        the content value.

      • getBoundingRegions

        public List<BoundingRegion> getBoundingRegions()
        Get the boundingRegions property: Bounding regions covering the field.
        Returns:
        the boundingRegions value.

      • getSpans

        public List<DocumentSpan> getSpans()
        Get the spans property: Location of the field in the reading order concatenated content.
        Returns:
        the spans value.

      • getConfidence

        public Float getConfidence()
        Get the confidence property: Confidence of correctly extracting the field.
        Returns:
        the confidence value.