155 строки
11 KiB
YAML
155 строки
11 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.ai.formrecognizer.models.FieldValue"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue"
|
|
name: "FieldValue"
|
|
nameWithType: "FieldValue"
|
|
summary: "Represents the strongly-typed value of a field recognized from the input document and provides methods for converting it to the appropriate type."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- 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 **FieldValue**"
|
|
constructors:
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.FieldValue(java.lang.Object,com.azure.ai.formrecognizer.models.FieldValueType)"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.FieldValue(Object value, FieldValueType valueType)"
|
|
name: "FieldValue(Object value, FieldValueType valueType)"
|
|
nameWithType: "FieldValue.FieldValue(Object value, FieldValueType valueType)"
|
|
summary: "Constructs a Field<wbr>Value object"
|
|
parameters:
|
|
- description: "The actual value of the field."
|
|
name: "value"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
|
|
- description: "The type of the field."
|
|
name: "valueType"
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldValueType?alt=com.azure.ai.formrecognizer.models.FieldValueType&text=FieldValueType\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public FieldValue(Object value, FieldValueType valueType)"
|
|
desc: "Constructs a FieldValue object"
|
|
methods:
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asCountryRegion()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asCountryRegion()"
|
|
name: "asCountryRegion()"
|
|
nameWithType: "FieldValue.asCountryRegion()"
|
|
summary: "Gets the value of the field as a country or region in the world."
|
|
syntax: "public String asCountryRegion()"
|
|
desc: "Gets the value of the field as a country or region in the world."
|
|
returns:
|
|
description: "the value of the field as COUNTRY_REGION."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asDate()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asDate()"
|
|
name: "asDate()"
|
|
nameWithType: "FieldValue.asDate()"
|
|
summary: "Gets the value of the field as a <xref uid=\"java.time.LocalDate\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LocalDate\"></xref>."
|
|
syntax: "public LocalDate asDate()"
|
|
desc: "Gets the value of the field as a <xref uid=\"java.time.LocalDate\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LocalDate\"></xref>."
|
|
returns:
|
|
description: "the value of the field as a <xref uid=\"java.time.LocalDate\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LocalDate\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/LocalDate.html\">LocalDate</a>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asFloat()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asFloat()"
|
|
name: "asFloat()"
|
|
nameWithType: "FieldValue.asFloat()"
|
|
summary: "Gets the value of the field as a <xref uid=\"java.lang.Float\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Float\"></xref>."
|
|
syntax: "public Float asFloat()"
|
|
desc: "Gets the value of the field as a <xref uid=\"java.lang.Float\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Float\"></xref>."
|
|
returns:
|
|
description: "the value of the field as a <xref uid=\"java.lang.Float\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Float\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Float.html\">Float</a>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asList()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asList()"
|
|
name: "asList()"
|
|
nameWithType: "FieldValue.asList()"
|
|
summary: "Gets the value of the field as a <xref uid=\"java.util.List\" data-throw-if-not-resolved=\"false\" data-raw-source=\"List\"></xref>."
|
|
syntax: "public List<FormField> asList()"
|
|
desc: "Gets the value of the field as a <xref uid=\"java.util.List\" data-throw-if-not-resolved=\"false\" data-raw-source=\"List\"></xref>."
|
|
returns:
|
|
description: "the value of the field as an unmodifiable <xref uid=\"java.util.List\" data-throw-if-not-resolved=\"false\" data-raw-source=\"List\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/List.html\">List</a><<xref href=\"com.azure.ai.formrecognizer.models.FormField?alt=com.azure.ai.formrecognizer.models.FormField&text=FormField\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asLong()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asLong()"
|
|
name: "asLong()"
|
|
nameWithType: "FieldValue.asLong()"
|
|
summary: "Gets the value of the field as a <xref uid=\"java.lang.Long\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Long\"></xref>."
|
|
syntax: "public Long asLong()"
|
|
desc: "Gets the value of the field as a <xref uid=\"java.lang.Long\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Long\"></xref>."
|
|
returns:
|
|
description: "the value of the field as a <xref uid=\"java.lang.Long\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Long\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Long.html\">Long</a>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asMap()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asMap()"
|
|
name: "asMap()"
|
|
nameWithType: "FieldValue.asMap()"
|
|
summary: "Gets the value of the field as a <xref uid=\"java.util.Map\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Map\"></xref>."
|
|
syntax: "public Map<String,FormField> asMap()"
|
|
desc: "Gets the value of the field as a <xref uid=\"java.util.Map\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Map\"></xref>."
|
|
returns:
|
|
description: "the value of the field as an unmodifiable <xref uid=\"java.util.Map\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Map\"></xref>."
|
|
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.models.FormField?alt=com.azure.ai.formrecognizer.models.FormField&text=FormField\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asPhoneNumber()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asPhoneNumber()"
|
|
name: "asPhoneNumber()"
|
|
nameWithType: "FieldValue.asPhoneNumber()"
|
|
summary: "Gets the value of the field as a phone number."
|
|
syntax: "public String asPhoneNumber()"
|
|
desc: "Gets the value of the field as a phone number."
|
|
returns:
|
|
description: "the value of the field as a phone number."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asSelectionMarkState()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asSelectionMarkState()"
|
|
name: "asSelectionMarkState()"
|
|
nameWithType: "FieldValue.asSelectionMarkState()"
|
|
summary: "Gets the value of the field as a selection mark state."
|
|
syntax: "public SelectionMarkState asSelectionMarkState()"
|
|
desc: "Gets the value of the field as a selection mark state."
|
|
returns:
|
|
description: "the value of the field as an unmodifiable selection mark state."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.models.SelectionMarkState?alt=com.azure.ai.formrecognizer.models.SelectionMarkState&text=SelectionMarkState\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asString()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asString()"
|
|
name: "asString()"
|
|
nameWithType: "FieldValue.asString()"
|
|
summary: "Gets the value of the field as a <xref uid=\"java.lang.String\" data-throw-if-not-resolved=\"false\" data-raw-source=\"String\"></xref>."
|
|
syntax: "public String asString()"
|
|
desc: "Gets the value of the field as a <xref uid=\"java.lang.String\" data-throw-if-not-resolved=\"false\" data-raw-source=\"String\"></xref>."
|
|
returns:
|
|
description: "the value of the field as a <xref uid=\"java.lang.String\" data-throw-if-not-resolved=\"false\" data-raw-source=\"String\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.asTime()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.asTime()"
|
|
name: "asTime()"
|
|
nameWithType: "FieldValue.asTime()"
|
|
summary: "Gets the value of the field as a <xref uid=\"java.time.LocalTime\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LocalTime\"></xref>."
|
|
syntax: "public LocalTime asTime()"
|
|
desc: "Gets the value of the field as a <xref uid=\"java.time.LocalTime\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LocalTime\"></xref>."
|
|
returns:
|
|
description: "the value of the field as a <xref uid=\"java.time.LocalTime\" data-throw-if-not-resolved=\"false\" data-raw-source=\"LocalTime\"></xref>."
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/LocalTime.html\">LocalTime</a>"
|
|
- uid: "com.azure.ai.formrecognizer.models.FieldValue.getValueType()"
|
|
fullName: "com.azure.ai.formrecognizer.models.FieldValue.getValueType()"
|
|
name: "getValueType()"
|
|
nameWithType: "FieldValue.getValueType()"
|
|
summary: "Gets the type of the value of the field."
|
|
syntax: "public FieldValueType getValueType()"
|
|
desc: "Gets the type of the value of the field."
|
|
returns:
|
|
description: "the <xref uid=\"com.azure.ai.formrecognizer.models.FieldValueType\" data-throw-if-not-resolved=\"false\" data-raw-source=\"type\"></xref> of the field."
|
|
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldValueType?alt=com.azure.ai.formrecognizer.models.FieldValueType&text=FieldValueType\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "Represents the strongly-typed value of a field recognized from the input document and provides methods for converting it to the appropriate type."
|
|
metadata: {}
|
|
package: "com.azure.ai.formrecognizer.models"
|
|
artifact: com.azure:azure-ai-formrecognizer:4.1.11
|