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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
|
# coding=utf-8
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import pytest
import functools
from io import BytesIO
from datetime import date, time
from azure.core.exceptions import ClientAuthenticationError, ServiceRequestError, HttpResponseError
from azure.core.credentials import AzureKeyCredential
from azure.ai.formrecognizer._generated.models import AnalyzeOperationResult
from azure.ai.formrecognizer._response_handlers import prepare_prebuilt_models
from azure.ai.formrecognizer.aio import FormRecognizerClient
from azure.ai.formrecognizer import FormContentType, FormRecognizerApiVersion
from asynctestcase import AsyncFormRecognizerTest
from testcase import GlobalFormRecognizerAccountPreparer
from testcase import GlobalClientPreparer as _GlobalClientPreparer
GlobalClientPreparer = functools.partial(_GlobalClientPreparer, FormRecognizerClient)
class TestInvoiceAsync(AsyncFormRecognizerTest):
@GlobalFormRecognizerAccountPreparer()
async def test_invoice_bad_endpoint(self, resource_group, location, form_recognizer_account, form_recognizer_account_key):
with open(self.invoice_pdf, "rb") as fd:
myfile = fd.read()
with self.assertRaises(ServiceRequestError):
client = FormRecognizerClient("http://notreal.azure.com", AzureKeyCredential(form_recognizer_account_key))
async with client:
poller = await client.begin_recognize_invoices(myfile)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_authentication_successful_key(self, client):
with open(self.invoice_pdf, "rb") as fd:
myfile = fd.read()
async with client:
poller = await client.begin_recognize_invoices(myfile)
result = await poller.result()
@GlobalFormRecognizerAccountPreparer()
async def test_authentication_bad_key(self, resource_group, location, form_recognizer_account, form_recognizer_account_key):
client = FormRecognizerClient(form_recognizer_account, AzureKeyCredential("xxxx"))
with self.assertRaises(ClientAuthenticationError):
async with client:
poller = await client.begin_recognize_invoices(b"xx", content_type="image/jpeg")
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_passing_enum_content_type(self, client):
with open(self.invoice_pdf, "rb") as fd:
myfile = fd.read()
async with client:
poller = await client.begin_recognize_invoices(
myfile,
content_type=FormContentType.APPLICATION_PDF
)
result = await poller.result()
self.assertIsNotNone(result)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_damaged_file_passed_as_bytes(self, client):
damaged_pdf = b"\x25\x50\x44\x46\x55\x55\x55" # still has correct bytes to be recognized as PDF
with self.assertRaises(HttpResponseError):
async with client:
poller = await client.begin_recognize_invoices(
damaged_pdf
)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_damaged_file_bytes_fails_autodetect_content_type(self, client):
damaged_pdf = b"\x50\x44\x46\x55\x55\x55" # doesn't match any magic file numbers
with self.assertRaises(ValueError):
async with client:
poller = await client.begin_recognize_invoices(
damaged_pdf
)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_damaged_file_passed_as_bytes_io(self, client):
damaged_pdf = BytesIO(b"\x25\x50\x44\x46\x55\x55\x55") # still has correct bytes to be recognized as PDF
with self.assertRaises(HttpResponseError):
async with client:
poller = await client.begin_recognize_invoices(
damaged_pdf
)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_damaged_file_bytes_io_fails_autodetect(self, client):
damaged_pdf = BytesIO(b"\x50\x44\x46\x55\x55\x55") # doesn't match any magic file numbers
with self.assertRaises(ValueError):
async with client:
poller = await client.begin_recognize_invoices(
damaged_pdf
)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_blank_page(self, client):
with open(self.blank_pdf, "rb") as fd:
blank = fd.read()
async with client:
poller = await client.begin_recognize_invoices(
blank
)
result = await poller.result()
self.assertIsNotNone(result)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_passing_bad_content_type_param_passed(self, client):
with open(self.invoice_pdf, "rb") as fd:
myfile = fd.read()
with self.assertRaises(ValueError):
async with client:
poller = await client.begin_recognize_invoices(
myfile,
content_type="application/jpeg"
)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_passing_unsupported_url_content_type(self, client):
with self.assertRaises(TypeError):
async with client:
poller = await client.begin_recognize_invoices("https://badurl.jpg", content_type="application/json")
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_auto_detect_unsupported_stream_content(self, client):
with open(self.unsupported_content_py, "rb") as fd:
myfile = fd.read()
with self.assertRaises(ValueError):
async with client:
poller = await client.begin_recognize_invoices(
myfile
)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_stream_transform_pdf(self, client):
responses = []
def callback(raw_response, _, headers):
analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
extracted_invoice = prepare_prebuilt_models(analyze_result)
responses.append(analyze_result)
responses.append(extracted_invoice)
with open(self.invoice_pdf, "rb") as fd:
myfile = fd.read()
async with client:
poller = await client.begin_recognize_invoices(
invoice=myfile,
include_field_elements=True,
cls=callback
)
result = await poller.result()
raw_response = responses[0]
returned_model = responses[1]
invoice = returned_model[0]
actual = raw_response.analyze_result.document_results[0].fields
read_results = raw_response.analyze_result.read_results
document_results = raw_response.analyze_result.document_results
page_results = raw_response.analyze_result.page_results
self.assertFormFieldsTransformCorrect(invoice.fields, actual, read_results)
# check page range
self.assertEqual(invoice.page_range.first_page_number, document_results[0].page_range[0])
self.assertEqual(invoice.page_range.last_page_number, document_results[0].page_range[1])
# Check page metadata
self.assertFormPagesTransformCorrect(invoice.pages, read_results, page_results)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_stream_transform_tiff(self, client):
responses = []
def callback(raw_response, _, headers):
analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
extracted_invoice = prepare_prebuilt_models(analyze_result)
responses.append(analyze_result)
responses.append(extracted_invoice)
with open(self.invoice_tiff, "rb") as fd:
myfile = fd.read()
async with client:
poller = await client.begin_recognize_invoices(
invoice=myfile,
include_field_elements=True,
cls=callback
)
result = await poller.result()
raw_response = responses[0]
returned_model = responses[1]
invoice = returned_model[0]
actual = raw_response.analyze_result.document_results[0].fields
read_results = raw_response.analyze_result.read_results
document_results = raw_response.analyze_result.document_results
page_results = raw_response.analyze_result.page_results
self.assertFormFieldsTransformCorrect(invoice.fields, actual, read_results)
# check page range
self.assertEqual(invoice.page_range.first_page_number, document_results[0].page_range[0])
self.assertEqual(invoice.page_range.last_page_number, document_results[0].page_range[1])
# Check page metadata
self.assertFormPagesTransformCorrect(invoice.pages, read_results, page_results)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_stream_multipage_transform_pdf(self, client):
responses = []
def callback(raw_response, _, headers):
analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
extracted_invoice = prepare_prebuilt_models(analyze_result)
responses.append(analyze_result)
responses.append(extracted_invoice)
with open(self.multipage_vendor_pdf, "rb") as fd:
myfile = fd.read()
async with client:
poller = await client.begin_recognize_invoices(
invoice=myfile,
include_field_elements=True,
cls=callback
)
result = await poller.result()
raw_response = responses[0]
returned_models = responses[1]
read_results = raw_response.analyze_result.read_results
document_results = raw_response.analyze_result.document_results
page_results = raw_response.analyze_result.page_results
self.assertEqual(1, len(returned_models))
returned_model = returned_models[0]
self.assertEqual(2, len(returned_model.pages))
self.assertEqual(1, returned_model.page_range.first_page_number)
self.assertEqual(2, returned_model.page_range.last_page_number)
self.assertEqual(1, len(document_results))
document_result = document_results[0]
self.assertEqual(1, document_result.page_range[0]) # checking first page number
self.assertEqual(2, document_result.page_range[1]) # checking last page number
for invoice, document_result in zip(returned_models, document_results):
self.assertFormFieldsTransformCorrect(invoice.fields, document_result.fields, read_results)
self.assertFormPagesTransformCorrect(returned_model.pages, read_results, page_results)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_pdf(self, client):
with open(self.invoice_pdf, "rb") as fd:
invoice = fd.read()
async with client:
poller = await client.begin_recognize_invoices(invoice)
result = await poller.result()
self.assertEqual(len(result), 1)
invoice = result[0]
# check dict values
self.assertEqual(invoice.fields.get("VendorName").value, "Contoso")
self.assertEqual(invoice.fields.get("VendorAddress").value, '1 Redmond way Suite 6000 Redmond, WA 99243')
self.assertEqual(invoice.fields.get("CustomerAddressRecipient").value, "Microsoft")
self.assertEqual(invoice.fields.get("CustomerAddress").value, '1020 Enterprise Way Sunnayvale, CA 87659')
self.assertEqual(invoice.fields.get("CustomerName").value, "Microsoft")
self.assertEqual(invoice.fields.get("InvoiceId").value, '34278587')
self.assertEqual(invoice.fields.get("InvoiceDate").value, date(2017, 6, 18))
self.assertEqual(invoice.fields.get("InvoiceTotal").value, 56651.49)
self.assertEqual(invoice.fields.get("DueDate").value, date(2017, 6, 24))
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_tiff(self, client):
with open(self.invoice_tiff, "rb") as fd:
stream = fd.read()
async with client:
poller = await client.begin_recognize_invoices(stream)
result = await poller.result()
self.assertEqual(len(result), 1)
invoice = result[0]
# check dict values
self.assertEqual(invoice.fields.get("VendorName").value, "Contoso")
self.assertEqual(invoice.fields.get("VendorAddress").value, '1 Redmond way Suite 6000 Redmond, WA 99243')
self.assertEqual(invoice.fields.get("CustomerAddressRecipient").value, "Microsoft")
self.assertEqual(invoice.fields.get("CustomerAddress").value, '1020 Enterprise Way Sunnayvale, CA 87659')
self.assertEqual(invoice.fields.get("CustomerName").value, "Microsoft")
self.assertEqual(invoice.fields.get("InvoiceId").value, '34278587')
self.assertEqual(invoice.fields.get("InvoiceDate").value, date(2017, 6, 18))
self.assertEqual(invoice.fields.get("InvoiceTotal").value, 56651.49)
self.assertEqual(invoice.fields.get("DueDate").value, date(2017, 6, 24))
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_multipage_pdf(self, client):
with open(self.multipage_vendor_pdf, "rb") as fd:
invoice = fd.read()
async with client:
poller = await client.begin_recognize_invoices(invoice)
result = await poller.result()
self.assertEqual(len(result), 1)
invoice = result[0]
self.assertEqual("prebuilt:invoice", invoice.form_type)
self.assertEqual(1, invoice.page_range.first_page_number)
self.assertEqual(2, invoice.page_range.last_page_number)
vendor_name = invoice.fields["VendorName"]
self.assertEqual(vendor_name.value, 'Southridge Video')
self.assertEqual(vendor_name.value_data.page_number, 2)
remittance_address_recipient = invoice.fields["RemittanceAddressRecipient"]
self.assertEqual(remittance_address_recipient.value, "Contoso Ltd.")
self.assertEqual(remittance_address_recipient.value_data.page_number, 1)
remittance_address = invoice.fields["RemittanceAddress"]
self.assertEqual(remittance_address.value, '2345 Dogwood Lane Birch, Kansas 98123')
self.assertEqual(remittance_address.value_data.page_number, 1)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_pdf_include_field_elements(self, client):
with open(self.invoice_pdf, "rb") as fd:
invoice = fd.read()
async with client:
poller = await client.begin_recognize_invoices(invoice, include_field_elements=True)
result = await poller.result()
self.assertEqual(len(result), 1)
invoice = result[0]
self.assertFormPagesHasValues(invoice.pages)
for field in invoice.fields.values():
self.assertFieldElementsHasValues(field.value_data.field_elements, invoice.page_range.first_page_number)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
@pytest.mark.live_test_only
async def test_invoice_continuation_token(self, client):
with open(self.invoice_tiff, "rb") as fd:
invoice = fd.read()
async with client:
initial_poller = await client.begin_recognize_invoices(invoice)
cont_token = initial_poller.continuation_token()
poller = await client.begin_recognize_invoices(None, continuation_token=cont_token)
result = await poller.result()
self.assertIsNotNone(result)
await initial_poller.wait() # necessary so azure-devtools doesn't throw assertion error
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer(client_kwargs={"api_version": FormRecognizerApiVersion.V2_0})
async def test_invoice_v2(self, client):
with open(self.invoice_pdf, "rb") as fd:
invoice = fd.read()
with pytest.raises(ValueError) as e:
async with client:
await client.begin_recognize_invoices(invoice)
assert "Method 'begin_recognize_invoices' is only available for API version V2_1_PREVIEW and up" in str(e.value)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_locale_specified(self, client):
with open(self.invoice_tiff, "rb") as fd:
invoice = fd.read()
async with client:
poller = await client.begin_recognize_invoices(invoice, locale="en-US")
assert 'en-US' == poller._polling_method._initial_response.http_response.request.query['locale']
await poller.wait()
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_invoice_locale_error(self, client):
with open(self.invoice_pdf, "rb") as fd:
invoice = fd.read()
with pytest.raises(HttpResponseError) as e:
async with client:
await client.begin_recognize_invoices(invoice, locale="not a locale")
assert "locale" in e.value.error.message
|
