· 6 years ago · Oct 05, 2019, 12:16 AM
1{
2 "description": "Analyze API call result.",
3 "type": "object",
4 "properties": {
5 "status": {
6 "description": "Status of the analyze operation.",
7 "enum": [
8 "success",
9 "partialSuccess",
10 "failure"
11 ],
12 "type": "string"
13 },
14 "pages": {
15 "description": "Page level information extracted in the analyzed\r\ndocument.",
16 "uniqueItems": false,
17 "type": "array",
18 "items": {
19 "description": "Extraction information of a single page in a\r\nwith a document.",
20 "type": "object",
21 "properties": {
22 "number": {
23 "format": "int32",
24 "description": "Page number.",
25 "type": "integer"
26 },
27 "height": {
28 "format": "int32",
29 "description": "Height of the page (in pixels).",
30 "type": "integer"
31 },
32 "width": {
33 "format": "int32",
34 "description": "Width of the page (in pixels).",
35 "type": "integer"
36 },
37 "clusterId": {
38 "format": "int32",
39 "description": "Cluster identifier.",
40 "type": "integer"
41 },
42 "keyValuePairs": {
43 "description": "List of Key-Value pairs extracted from the page.",
44 "uniqueItems": false,
45 "type": "array",
46 "items": {
47 "description": "Representation of a key-value pair as a list\r\nof key and value tokens.",
48 "type": "object",
49 "properties": {
50 "key": {
51 "description": "List of tokens for the extracted key in a key-value pair.",
52 "uniqueItems": false,
53 "type": "array",
54 "items": {
55 "description": "Canonical representation of single extracted text.",
56 "type": "object",
57 "properties": {
58 "text": {
59 "description": "String value of the extracted text.",
60 "type": "string"
61 },
62 "boundingBox": {
63 "description": "Bounding box of the extracted text. Represents the\r\nlocation of the extracted text as a pair of\r\ncartesian co-ordinates. The co-ordinate pairs are arranged by\r\ntop-left, top-right, bottom-right and bottom-left endpoints box\r\nwith origin reference from the bottom-left of the page.",
64 "uniqueItems": false,
65 "type": "array",
66 "items": {
67 "format": "double",
68 "type": "number"
69 }
70 },
71 "confidence": {
72 "format": "double",
73 "description": "A measure of accuracy of the extracted text.",
74 "type": "number"
75 }
76 }
77 }
78 },
79 "value": {
80 "description": "List of tokens for the extracted value in a key-value pair.",
81 "uniqueItems": false,
82 "type": "array",
83 "items": {
84 "description": "Canonical representation of single extracted text.",
85 "type": "object",
86 "properties": {
87 "text": {
88 "description": "String value of the extracted text.",
89 "type": "string"
90 },
91 "boundingBox": {
92 "description": "Bounding box of the extracted text. Represents the\r\nlocation of the extracted text as a pair of\r\ncartesian co-ordinates. The co-ordinate pairs are arranged by\r\ntop-left, top-right, bottom-right and bottom-left endpoints box\r\nwith origin reference from the bottom-left of the page.",
93 "uniqueItems": false,
94 "type": "array",
95 "items": {
96 "format": "double",
97 "type": "number"
98 }
99 },
100 "confidence": {
101 "format": "double",
102 "description": "A measure of accuracy of the extracted text.",
103 "type": "number"
104 }
105 }
106 }
107 }
108 }
109 }
110 },
111 "tables": {
112 "description": "List of Tables and their information extracted from the page.",
113 "uniqueItems": false,
114 "type": "array",
115 "items": {
116 "description": "Extraction information about a table\r\ncontained in a page.",
117 "type": "object",
118 "properties": {
119 "id": {
120 "description": "Table identifier.",
121 "type": "string"
122 },
123 "columns": {
124 "description": "List of columns contained in the table.",
125 "uniqueItems": false,
126 "type": "array",
127 "items": {
128 "description": "Extraction information of a column in\r\na table.",
129 "type": "object",
130 "properties": {
131 "header": {
132 "description": "List of extracted tokens for the column header.",
133 "uniqueItems": false,
134 "type": "array",
135 "items": {
136 "description": "Canonical representation of single extracted text.",
137 "type": "object",
138 "properties": {
139 "text": {
140 "description": "String value of the extracted text.",
141 "type": "string"
142 },
143 "boundingBox": {
144 "description": "Bounding box of the extracted text. Represents the\r\nlocation of the extracted text as a pair of\r\ncartesian co-ordinates. The co-ordinate pairs are arranged by\r\ntop-left, top-right, bottom-right and bottom-left endpoints box\r\nwith origin reference from the bottom-left of the page.",
145 "uniqueItems": false,
146 "type": "array",
147 "items": {
148 "format": "double",
149 "type": "number"
150 }
151 },
152 "confidence": {
153 "format": "double",
154 "description": "A measure of accuracy of the extracted text.",
155 "type": "number"
156 }
157 }
158 }
159 },
160 "entries": {
161 "description": "Extracted text for each cell of a column. Each cell\r\nin the column can have a list of one or more tokens.",
162 "uniqueItems": false,
163 "type": "array",
164 "items": {
165 "uniqueItems": false,
166 "type": "array",
167 "items": {
168 "description": "Canonical representation of single extracted text.",
169 "type": "object",
170 "properties": {
171 "text": {
172 "description": "String value of the extracted text.",
173 "type": "string"
174 },
175 "boundingBox": {
176 "description": "Bounding box of the extracted text. Represents the\r\nlocation of the extracted text as a pair of\r\ncartesian co-ordinates. The co-ordinate pairs are arranged by\r\ntop-left, top-right, bottom-right and bottom-left endpoints box\r\nwith origin reference from the bottom-left of the page.",
177 "uniqueItems": false,
178 "type": "array",
179 "items": {
180 "format": "double",
181 "type": "number"
182 }
183 },
184 "confidence": {
185 "format": "double",
186 "description": "A measure of accuracy of the extracted text.",
187 "type": "number"
188 }
189 }
190 }
191 }
192 }
193 }
194 }
195 }
196 }
197 }
198 }
199 }
200 }
201 },
202 "errors": {
203 "description": "List of errors reported during the analyze\r\noperation.",
204 "uniqueItems": false,
205 "type": "array",
206 "items": {
207 "description": "Error reported during an operation.",
208 "type": "object",
209 "properties": {
210 "errorMessage": {
211 "description": "Message reported during the train operation.",
212 "type": "string"
213 }
214 }
215 }
216 }
217 }
218}