-
Notifications
You must be signed in to change notification settings - Fork 223
/
com.azure.ai.formrecognizer.models.FormField.yml
103 lines (103 loc) · 6.75 KB
/
com.azure.ai.formrecognizer.models.FormField.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
### YamlMime:JavaType
uid: "com.azure.ai.formrecognizer.models.FormField"
fullName: "com.azure.ai.formrecognizer.models.FormField"
name: "FormField"
nameWithType: "FormField"
summary: "Represents a field recognized in an input document."
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 **FormField**"
constructors:
- uid: "com.azure.ai.formrecognizer.models.FormField.FormField(java.lang.String,com.azure.ai.formrecognizer.models.FieldData,com.azure.ai.formrecognizer.models.FieldData,com.azure.ai.formrecognizer.models.FieldValue,float)"
fullName: "com.azure.ai.formrecognizer.models.FormField.FormField(String name, FieldData labelData, FieldData valueData, FieldValue value, float confidence)"
name: "FormField(String name, FieldData labelData, FieldData valueData, FieldValue value, float confidence)"
nameWithType: "FormField.FormField(String name, FieldData labelData, FieldData valueData, FieldValue value, float confidence)"
summary: "Constructs a Form<wbr>Field object."
parameters:
- description: "The name the field or label."
name: "name"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The text, bounding box, and field elements for the field label."
name: "labelData"
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldData?alt=com.azure.ai.formrecognizer.models.FieldData&text=FieldData\" data-throw-if-not-resolved=\"False\" />"
- description: "The text, bounding box, and field elements for the field value."
name: "valueData"
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldData?alt=com.azure.ai.formrecognizer.models.FieldData&text=FieldData\" data-throw-if-not-resolved=\"False\" />"
- description: "The value of the recognized field."
name: "value"
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldValue?alt=com.azure.ai.formrecognizer.models.FieldValue&text=FieldValue\" data-throw-if-not-resolved=\"False\" />"
- description: "The confidence of the recognized field."
name: "confidence"
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
syntax: "public FormField(String name, FieldData labelData, FieldData valueData, FieldValue value, float confidence)"
desc: "Constructs a FormField object."
methods:
- uid: "com.azure.ai.formrecognizer.models.FormField.getConfidence()"
fullName: "com.azure.ai.formrecognizer.models.FormField.getConfidence()"
name: "getConfidence()"
nameWithType: "FormField.getConfidence()"
summary: "Get the estimated confidence value of the recognized field."
syntax: "public float getConfidence()"
desc: "Get the estimated confidence value of the recognized field."
returns:
description: "the confidence value."
type: "<xref href=\"float?alt=float&text=float\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormField.getLabelData()"
fullName: "com.azure.ai.formrecognizer.models.FormField.getLabelData()"
name: "getLabelData()"
nameWithType: "FormField.getLabelData()"
summary: "Get the text, bounding box, and field elements for the field label."
syntax: "public FieldData getLabelData()"
desc: "Get the text, bounding box, and field elements for the field label."
returns:
description: "the text, bounding box, and field elements for the field value."
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldData?alt=com.azure.ai.formrecognizer.models.FieldData&text=FieldData\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormField.getName()"
fullName: "com.azure.ai.formrecognizer.models.FormField.getName()"
name: "getName()"
nameWithType: "FormField.getName()"
summary: "Get the name of the field in the provided document."
syntax: "public String getName()"
desc: "Get the name of the field in the provided document."
returns:
description: "the name of field or label."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.ai.formrecognizer.models.FormField.getValue()"
fullName: "com.azure.ai.formrecognizer.models.FormField.getValue()"
name: "getValue()"
nameWithType: "FormField.getValue()"
summary: "Get the value of the recognized field."
syntax: "public FieldValue getValue()"
desc: "Get the value of the recognized field."
returns:
description: "Value of the recognized field."
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldValue?alt=com.azure.ai.formrecognizer.models.FieldValue&text=FieldValue\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.ai.formrecognizer.models.FormField.getValueData()"
fullName: "com.azure.ai.formrecognizer.models.FormField.getValueData()"
name: "getValueData()"
nameWithType: "FormField.getValueData()"
summary: "Get the text, bounding box, and field elements for the field value."
syntax: "public FieldData getValueData()"
desc: "Get the text, bounding box, and field elements for the field value."
returns:
description: "the text, bounding box, and field elements for the field value."
type: "<xref href=\"com.azure.ai.formrecognizer.models.FieldData?alt=com.azure.ai.formrecognizer.models.FieldData&text=FieldData\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents a field recognized in an input document."
metadata: {}
package: "com.azure.ai.formrecognizer.models"
artifact: com.azure:azure-ai-formrecognizer:4.1.8