-
Notifications
You must be signed in to change notification settings - Fork 180
/
DocumentSignatureField.yml
108 lines (103 loc) · 3.41 KB
/
DocumentSignatureField.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
104
105
106
107
108
### YamlMime:TSType
name: DocumentSignatureField
uid: '@azure/ai-form-recognizer.DocumentSignatureField'
package: '@azure/ai-form-recognizer'
summary: >-
A DocumentField that indicates the state of a signature, represented as a
string.
fullName: DocumentSignatureField
remarks: ''
isDeprecated: false
type: interface
properties:
- name: kind
uid: '@azure/ai-form-recognizer.DocumentSignatureField.kind'
package: '@azure/ai-form-recognizer'
summary: 'Field kind: "signature".'
fullName: kind
remarks: ''
isDeprecated: false
syntax:
content: 'kind: "signature"'
return:
description: ''
type: '"signature"'
- name: value
uid: '@azure/ai-form-recognizer.DocumentSignatureField.value'
package: '@azure/ai-form-recognizer'
summary: >-
The state of the signature field. One of:
- "unsigned"
- "signed"
This value may be undefined, and other variants may be introduced in the
future.
fullName: value
remarks: ''
isDeprecated: false
syntax:
content: 'value: "signed" | "unsigned"'
return:
description: ''
type: '"signed" | "unsigned"'
inheritedProperties:
- name: boundingRegions
uid: '@azure/ai-form-recognizer.DocumentSignatureField.boundingRegions'
package: '@azure/ai-form-recognizer'
summary: Bounding regions covering the field.
fullName: boundingRegions
remarks: ''
isDeprecated: false
syntax:
content: 'boundingRegions?: BoundingRegion[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.BoundingRegion" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[DocumentFieldCommon.boundingRegions](xref:@azure/ai-form-recognizer.DocumentFieldCommon.boundingRegions)
- name: confidence
uid: '@azure/ai-form-recognizer.DocumentSignatureField.confidence'
package: '@azure/ai-form-recognizer'
summary: Confidence of correctly extracting the field.
fullName: confidence
remarks: ''
isDeprecated: false
syntax:
content: 'confidence?: number'
return:
description: ''
type: number
inheritanceDescription: >-
<b>Inherited From</b>
[DocumentFieldCommon.confidence](xref:@azure/ai-form-recognizer.DocumentFieldCommon.confidence)
- name: content
uid: '@azure/ai-form-recognizer.DocumentSignatureField.content'
package: '@azure/ai-form-recognizer'
summary: The verbatim extracted text content of the field.
fullName: content
remarks: ''
isDeprecated: false
syntax:
content: 'content?: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[DocumentFieldCommon.content](xref:@azure/ai-form-recognizer.DocumentFieldCommon.content)
- name: spans
uid: '@azure/ai-form-recognizer.DocumentSignatureField.spans'
package: '@azure/ai-form-recognizer'
summary: Location of the field in the reading order concatenated content.
fullName: spans
remarks: ''
isDeprecated: false
syntax:
content: 'spans?: DocumentSpan[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentSpan" />[]
inheritanceDescription: >-
<b>Inherited From</b>
[DocumentFieldCommon.spans](xref:@azure/ai-form-recognizer.DocumentFieldCommon.spans)
extends: <xref uid="@azure/ai-form-recognizer.DocumentFieldCommon" />