-
Notifications
You must be signed in to change notification settings - Fork 180
/
AnalyzeResult.yml
152 lines (150 loc) · 4.83 KB
/
AnalyzeResult.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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
### YamlMime:TSType
name: AnalyzeResult
uid: '@azure/ai-form-recognizer.AnalyzeResult'
package: '@azure/ai-form-recognizer'
summary: >-
The result of an analysis operation. The type of the Document may be
determined by the model used to perform the
analysis.
fullName: AnalyzeResult<Document>
remarks: ''
isDeprecated: false
type: interface
properties:
- name: documents
uid: '@azure/ai-form-recognizer.AnalyzeResult.documents'
package: '@azure/ai-form-recognizer'
summary: >-
Extracted documents (instances of any of the model's document types and
corresponding field schemas).
fullName: documents
remarks: ''
isDeprecated: false
syntax:
content: 'documents?: Document[]'
return:
description: ''
type: Document[]
- name: keyValuePairs
uid: '@azure/ai-form-recognizer.AnalyzeResult.keyValuePairs'
package: '@azure/ai-form-recognizer'
summary: Extracted key-value pairs.
fullName: keyValuePairs
remarks: ''
isDeprecated: false
syntax:
content: 'keyValuePairs?: DocumentKeyValuePair[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentKeyValuePair" />[]
- name: languages
uid: '@azure/ai-form-recognizer.AnalyzeResult.languages'
package: '@azure/ai-form-recognizer'
summary: Extracted text languages.
fullName: languages
remarks: ''
isDeprecated: false
syntax:
content: 'languages?: DocumentLanguage[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentLanguage" />[]
- name: pages
uid: '@azure/ai-form-recognizer.AnalyzeResult.pages'
package: '@azure/ai-form-recognizer'
summary: Extracted pages.
fullName: pages
remarks: ''
isDeprecated: false
syntax:
content: 'pages?: DocumentPage[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentPage" />[]
- name: paragraphs
uid: '@azure/ai-form-recognizer.AnalyzeResult.paragraphs'
package: '@azure/ai-form-recognizer'
summary: Extracted document paragraphs.
fullName: paragraphs
remarks: ''
isDeprecated: false
syntax:
content: 'paragraphs?: DocumentParagraph[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentParagraph" />[]
- name: styles
uid: '@azure/ai-form-recognizer.AnalyzeResult.styles'
package: '@azure/ai-form-recognizer'
summary: Extracted font styles.
fullName: styles
remarks: ''
isDeprecated: false
syntax:
content: 'styles?: DocumentStyle[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentStyle" />[]
- name: tables
uid: '@azure/ai-form-recognizer.AnalyzeResult.tables'
package: '@azure/ai-form-recognizer'
summary: Extracted tables.
fullName: tables
remarks: ''
isDeprecated: false
syntax:
content: 'tables?: DocumentTable[]'
return:
description: ''
type: <xref uid="@azure/ai-form-recognizer.DocumentTable" />[]
inheritedProperties:
- name: apiVersion
uid: '@azure/ai-form-recognizer.AnalyzeResult.apiVersion'
package: '@azure/ai-form-recognizer'
summary: The service API version used to produce this result.
fullName: apiVersion
remarks: ''
isDeprecated: false
syntax:
content: 'apiVersion: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[AnalyzeResultCommon.apiVersion](xref:@azure/ai-form-recognizer.AnalyzeResultCommon.apiVersion)
- name: content
uid: '@azure/ai-form-recognizer.AnalyzeResult.content'
package: '@azure/ai-form-recognizer'
summary: >-
A string representation of all textual and visual elements in the input,
concatenated by reading order (the order
in which the service "reads" or extracts the textual and visual content
from the document).
fullName: content
remarks: ''
isDeprecated: false
syntax:
content: 'content: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[AnalyzeResultCommon.content](xref:@azure/ai-form-recognizer.AnalyzeResultCommon.content)
- name: modelId
uid: '@azure/ai-form-recognizer.AnalyzeResult.modelId'
package: '@azure/ai-form-recognizer'
summary: The unique ID of the model that was used to produce this result.
fullName: modelId
remarks: ''
isDeprecated: false
syntax:
content: 'modelId: string'
return:
description: ''
type: string
inheritanceDescription: >-
<b>Inherited From</b>
[AnalyzeResultCommon.modelId](xref:@azure/ai-form-recognizer.AnalyzeResultCommon.modelId)
extends: <xref uid="@azure/ai-form-recognizer.AnalyzeResultCommon" />