187 строки
13 KiB
YAML
187 строки
13 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField"
|
|
name: "DocumentField"
|
|
nameWithType: "DocumentField"
|
|
summary: "Model representing the content and location of a field value."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField&text=TypedDocumentField\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getBoundingRegions()?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getBoundingRegions&text=getBoundingRegions\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getConfidence()?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getConfidence&text=getConfidence\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getContent()?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getContent&text=getContent\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getSpans()?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getSpans&text=getSpans\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getType()?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getType&text=getType\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getValue()?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField.getValue&text=getValue\" data-throw-if-not-resolved=\"False\" />"
|
|
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
methodsRef:
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
|
|
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
|
|
syntax: "public final class **DocumentField**</br> extends <xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField?alt=com.azure.ai.formrecognizer.documentanalysis.models.TypedDocumentField&text=TypedDocumentField\" data-throw-if-not-resolved=\"False\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>>"
|
|
constructors:
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.DocumentField()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.DocumentField()"
|
|
name: "DocumentField()"
|
|
nameWithType: "DocumentField.DocumentField()"
|
|
summary: "Constructs a Document<wbr>Field object."
|
|
syntax: "public DocumentField()"
|
|
desc: "Constructs a DocumentField object."
|
|
methods:
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsAddress()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsAddress()"
|
|
name: "getValueAsAddress()"
|
|
nameWithType: "DocumentField.getValueAsAddress()"
|
|
summary: "Get address value of the field."
|
|
syntax: "public AddressValue getValueAsAddress()"
|
|
desc: "Get address value of the field."
|
|
returns:
|
|
description: "the value."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.AddressValue?alt=com.azure.ai.formrecognizer.documentanalysis.models.AddressValue&text=AddressValue\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsBoolean()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsBoolean()"
|
|
name: "getValueAsBoolean()"
|
|
nameWithType: "DocumentField.getValueAsBoolean()"
|
|
summary: "Get boolean value of the field."
|
|
syntax: "public Boolean getValueAsBoolean()"
|
|
desc: "Get boolean value of the field."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsCountry()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsCountry()"
|
|
name: "getValueAsCountry()"
|
|
nameWithType: "DocumentField.getValueAsCountry()"
|
|
summary: "Get the 3-letter country code value (ISO 3166-1 alpha-3)."
|
|
syntax: "public String getValueAsCountry()"
|
|
desc: "Get the 3-letter country code value (ISO 3166-1 alpha-3)."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsCurrency()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsCurrency()"
|
|
name: "getValueAsCurrency()"
|
|
nameWithType: "DocumentField.getValueAsCurrency()"
|
|
summary: "Get the Currency value."
|
|
syntax: "public CurrencyValue getValueAsCurrency()"
|
|
desc: "Get the Currency value."
|
|
returns:
|
|
description: "the value."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.CurrencyValue?alt=com.azure.ai.formrecognizer.documentanalysis.models.CurrencyValue&text=CurrencyValue\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsDate()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsDate()"
|
|
name: "getValueAsDate()"
|
|
nameWithType: "DocumentField.getValueAsDate()"
|
|
summary: "Get the date value in YYYY-MM-DD format (ISO 8601)."
|
|
syntax: "public LocalDate getValueAsDate()"
|
|
desc: "Get the date value in YYYY-MM-DD format (ISO 8601)."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html\">LocalDate</a>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsDouble()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsDouble()"
|
|
name: "getValueAsDouble()"
|
|
nameWithType: "DocumentField.getValueAsDouble()"
|
|
summary: "Get the double/floating point value of the field."
|
|
syntax: "public Double getValueAsDouble()"
|
|
desc: "Get the double/floating point value of the field."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Double.html\">Double</a>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsList()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsList()"
|
|
name: "getValueAsList()"
|
|
nameWithType: "DocumentField.getValueAsList()"
|
|
summary: "Get the array of field values."
|
|
syntax: "public List<DocumentField> getValueAsList()"
|
|
desc: "Get the array of field values."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentField?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentField&text=DocumentField\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsLong()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsLong()"
|
|
name: "getValueAsLong()"
|
|
nameWithType: "DocumentField.getValueAsLong()"
|
|
summary: "Get the long value of the field."
|
|
syntax: "public Long getValueAsLong()"
|
|
desc: "Get the long value of the field."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsMap()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsMap()"
|
|
name: "getValueAsMap()"
|
|
nameWithType: "DocumentField.getValueAsMap()"
|
|
summary: "Get the map of named field values."
|
|
syntax: "public Map<String,DocumentField> getValueAsMap()"
|
|
desc: "Get the map of named field values."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentField?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentField&text=DocumentField\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsPhoneNumber()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsPhoneNumber()"
|
|
name: "getValueAsPhoneNumber()"
|
|
nameWithType: "DocumentField.getValueAsPhoneNumber()"
|
|
summary: "Get the phone number value in E.164 format (ex."
|
|
syntax: "public String getValueAsPhoneNumber()"
|
|
desc: "Get the phone number value in E.164 format (ex. +19876543210)."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsSelectionMark()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsSelectionMark()"
|
|
name: "getValueAsSelectionMark()"
|
|
nameWithType: "DocumentField.getValueAsSelectionMark()"
|
|
summary: "Get the selection mark value."
|
|
syntax: "public DocumentSelectionMarkState getValueAsSelectionMark()"
|
|
desc: "Get the selection mark value."
|
|
returns:
|
|
description: "the value."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSelectionMarkState?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSelectionMarkState&text=DocumentSelectionMarkState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsSignature()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsSignature()"
|
|
name: "getValueAsSignature()"
|
|
nameWithType: "DocumentField.getValueAsSignature()"
|
|
summary: "Get the presence of signature type."
|
|
syntax: "public DocumentSignatureType getValueAsSignature()"
|
|
desc: "Get the presence of signature type."
|
|
returns:
|
|
description: "the value."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.documentanalysis.models.DocumentSignatureType?alt=com.azure.ai.formrecognizer.documentanalysis.models.DocumentSignatureType&text=DocumentSignatureType\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsString()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsString()"
|
|
name: "getValueAsString()"
|
|
nameWithType: "DocumentField.getValueAsString()"
|
|
summary: "Get the string value of the field."
|
|
syntax: "public String getValueAsString()"
|
|
desc: "Get the string value of the field."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsTime()"
|
|
fullName: "com.azure.ai.formrecognizer.documentanalysis.models.DocumentField.getValueAsTime()"
|
|
name: "getValueAsTime()"
|
|
nameWithType: "DocumentField.getValueAsTime()"
|
|
summary: "Get the time value in hh:mm:ss format (ISO 8601)."
|
|
syntax: "public LocalTime getValueAsTime()"
|
|
desc: "Get the time value in hh:mm:ss format (ISO 8601)."
|
|
returns:
|
|
description: "the value."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/LocalTime.html\">LocalTime</a>"
|
|
type: "class"
|
|
desc: "Model representing the content and location of a field value."
|
|
metadata: {}
|
|
package: "com.azure.ai.formrecognizer.documentanalysis.models"
|
|
artifact: com.azure:azure-ai-formrecognizer:4.1.11
|