Bagikan melalui

DocumentField Class

  • Reference
Package:
com.azure.ai.formrecognizer.documentanalysis.models
Maven Artifact:
com.azure:azure-ai-formrecognizer:4.1.11

public final class DocumentField
extends TypedDocumentField<Object>

Model representing the content and location of a field value.

Constructor Summary

Constructor Description
DocumentField()

Constructs a DocumentField object.

Method Summary

Modifier and Type Method and Description
AddressValue getValueAsAddress()

Get address value of the field.
Boolean getValueAsBoolean()

Get boolean value of the field.
String getValueAsCountry()

Get the 3-letter country code value (ISO 3166-1 alpha-3).
CurrencyValue getValueAsCurrency()

Get the Currency value.
LocalDate getValueAsDate()

Get the date value in YYYY-MM-DD format (ISO 8601).
Double getValueAsDouble()

Get the double/floating point value of the field.
List<DocumentField> getValueAsList()

Get the array of field values.
Long getValueAsLong()

Get the long value of the field.
Map<String,DocumentField> getValueAsMap()

Get the map of named field values.
String getValueAsPhoneNumber()

Get the phone number value in E.164 format (ex.
DocumentSelectionMarkState getValueAsSelectionMark()

Get the selection mark value.
DocumentSignatureType getValueAsSignature()

Get the presence of signature type.
String getValueAsString()

Get the string value of the field.
LocalTime getValueAsTime()

Get the time value in hh:mm:ss format (ISO 8601).

Methods inherited from TypedDocumentField

getBoundingRegions getConfidence getContent getSpans getType getValue

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DocumentField

public DocumentField()

Constructs a DocumentField object.

Method Details

getValueAsAddress

public AddressValue getValueAsAddress()

Get address value of the field.

Returns:

the value.

getValueAsBoolean

public Boolean getValueAsBoolean()

Get boolean value of the field.

Returns:

the value.

getValueAsCountry

public String getValueAsCountry()

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

Returns:

the value.

getValueAsCurrency

public CurrencyValue getValueAsCurrency()

Get the Currency value.

Returns:

the value.

getValueAsDate

public LocalDate getValueAsDate()

Get the date value in YYYY-MM-DD format (ISO 8601).

Returns:

the value.

getValueAsDouble

public Double getValueAsDouble()

Get the double/floating point value of the field.

Returns:

the value.

getValueAsList

public List getValueAsList()

Get the array of field values.

Returns:

the value.

getValueAsLong

public Long getValueAsLong()

Get the long value of the field.

Returns:

the value.

getValueAsMap

public Map getValueAsMap()

Get the map of named field values.

Returns:

the value.

getValueAsPhoneNumber

public String getValueAsPhoneNumber()

Get the phone number value in E.164 format (ex. +19876543210).

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.

getValueAsString

public String getValueAsString()

Get the string value of the field.

Returns:

the value.

getValueAsTime

public LocalTime getValueAsTime()

Get the time value in hh:mm:ss format (ISO 8601).

Returns:

the value.

Applies to