/
AnalyzedDocument.yml
88 lines (84 loc) · 2.67 KB
/
AnalyzedDocument.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
### YamlMime:TSType
name: AnalyzedDocument
uid: '@azure/ai-form-recognizer.AnalyzedDocument'
package: '@azure/ai-form-recognizer'
summary: >-
An extracted document object.
An AnalyzedDocument is an instance of one of the document types within a
model. Its fields correspond to the field
schema of the document type.
fullName: AnalyzedDocument
remarks: ''
isDeprecated: false
type: interface
properties:
- name: boundingRegions
uid: '@azure/ai-form-recognizer.AnalyzedDocument.boundingRegions'
package: '@azure/ai-form-recognizer'
summary: Bounding regions covering the document.
fullName: boundingRegions
remarks: ''
isDeprecated: false
syntax:
content: 'boundingRegions?: BoundingRegion[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.BoundingRegion" />[]
- name: confidence
uid: '@azure/ai-form-recognizer.AnalyzedDocument.confidence'
package: '@azure/ai-form-recognizer'
summary: The service's confidence that it has correctly extracted the document.
fullName: confidence
remarks: ''
isDeprecated: false
syntax:
content: 'confidence: number'
return:
description: ''
type: number
- name: docType
uid: '@azure/ai-form-recognizer.AnalyzedDocument.docType'
package: '@azure/ai-form-recognizer'
summary: >-
The type of the document that was extracted. A model can have multiple
document types (for example, in a composed
model), so this property indicates which document type the fields of this
document correspond to.
fullName: docType
remarks: ''
isDeprecated: false
syntax:
content: 'docType: string'
return:
description: ''
type: string
- name: fields
uid: '@azure/ai-form-recognizer.AnalyzedDocument.fields'
package: '@azure/ai-form-recognizer'
summary: >-
The extracted fields, which correspond to the document type's field
schema.
fullName: fields
remarks: ''
isDeprecated: false
syntax:
content: 'fields: {[field: string]: DocumentField}'
return:
description: ''
type: >-
{[field: string]: <xref uid="@azure/ai-form-recognizer.DocumentField"
/>}
- name: spans
uid: '@azure/ai-form-recognizer.AnalyzedDocument.spans'
package: '@azure/ai-form-recognizer'
summary: >-
Locations of the document's elements in the `content` text
(reading-order-concatenated content).
fullName: spans
remarks: ''
isDeprecated: false
syntax:
content: 'spans: DocumentSpan[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentSpan" />[]