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
|
# coding=utf-8
# ------------------------------------
# Copyright (c) Microsoft Corporation.
# Licensed under the MIT License.
# ------------------------------------
import pytest
import functools
from datetime import date, time
from azure.core.exceptions import HttpResponseError, ServiceRequestError, ClientAuthenticationError
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 import FormRecognizerApiVersion
from azure.ai.formrecognizer.aio import FormRecognizerClient
from testcase import GlobalFormRecognizerAccountPreparer
from asynctestcase import AsyncFormRecognizerTest
from testcase import GlobalClientPreparer as _GlobalClientPreparer
GlobalClientPreparer = functools.partial(_GlobalClientPreparer, FormRecognizerClient)
class TestReceiptFromUrlAsync(AsyncFormRecognizerTest):
@GlobalFormRecognizerAccountPreparer()
async def test_polling_interval(self, resource_group, location, form_recognizer_account, form_recognizer_account_key):
client = FormRecognizerClient(form_recognizer_account, AzureKeyCredential(form_recognizer_account_key), polling_interval=7)
self.assertEqual(client._client._config.polling_interval, 7)
async with client:
poller = await client.begin_recognize_receipts_from_url(self.receipt_url_jpg, polling_interval=6)
await poller.wait()
self.assertEqual(poller._polling_method._timeout, 6)
poller2 = await client.begin_recognize_receipts_from_url(self.receipt_url_jpg)
await poller2.wait()
self.assertEqual(poller2._polling_method._timeout, 7) # goes back to client default
@pytest.mark.live_test_only
@GlobalFormRecognizerAccountPreparer()
async def test_active_directory_auth_async(self):
token = self.generate_oauth_token()
endpoint = self.get_oauth_endpoint()
client = FormRecognizerClient(endpoint, token)
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.receipt_url_jpg
)
result = await poller.result()
self.assertIsNotNone(result)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipts_encoded_url(self, client):
with pytest.raises(HttpResponseError) as e:
async with client:
poller = await client.begin_recognize_receipts_from_url("https://fakeuri.com/blank%20space")
self.assertIn("https://fakeuri.com/blank%20space", e.value.response.request.body)
@GlobalFormRecognizerAccountPreparer()
async def test_receipt_url_bad_endpoint(self, resource_group, location, form_recognizer_account, form_recognizer_account_key):
with self.assertRaises(ServiceRequestError):
client = FormRecognizerClient("http://notreal.azure.com", AzureKeyCredential(form_recognizer_account_key))
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.receipt_url_jpg
)
result = await poller.result()
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_url_auth_successful_key(self, client):
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.receipt_url_jpg
)
result = await poller.result()
@GlobalFormRecognizerAccountPreparer()
async def test_receipt_url_auth_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_receipts_from_url(
self.receipt_url_jpg
)
result = await poller.result()
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_bad_url(self, client):
with self.assertRaises(HttpResponseError):
async with client:
poller = await client.begin_recognize_receipts_from_url("https://badurl.jpg")
result = await poller.result()
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_url_pass_stream(self, client):
with open(self.receipt_png, "rb") as fd:
receipt = fd.read(4) # makes the recording smaller
with self.assertRaises(HttpResponseError):
async with client:
poller = await client.begin_recognize_receipts_from_url(receipt)
result = await poller.result()
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_url_transform_jpg(self, client):
responses = []
def callback(raw_response, _, headers):
analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
extracted_receipt = prepare_prebuilt_models(analyze_result)
responses.append(analyze_result)
responses.append(extracted_receipt)
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.receipt_url_jpg,
include_field_elements=True,
cls=callback
)
result = await poller.result()
raw_response = responses[0]
returned_model = responses[1]
receipt = 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
# check dict values
self.assertFormFieldsTransformCorrect(receipt.fields, actual, read_results)
# check page range
self.assertEqual(receipt.page_range.first_page_number, document_results[0].page_range[0])
self.assertEqual(receipt.page_range.last_page_number, document_results[0].page_range[1])
# Check page metadata
self.assertFormPagesTransformCorrect(receipt.pages, read_results)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_url_transform_png(self, client):
responses = []
def callback(raw_response, _, headers):
analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
extracted_receipt = prepare_prebuilt_models(analyze_result)
responses.append(analyze_result)
responses.append(extracted_receipt)
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.receipt_url_png,
include_field_elements=True,
cls=callback
)
result = await poller.result()
raw_response = responses[0]
returned_model = responses[1]
receipt = 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
# check dict values
self.assertFormFieldsTransformCorrect(receipt.fields, actual, read_results)
# check page range
self.assertEqual(receipt.page_range.first_page_number, document_results[0].page_range[0])
self.assertEqual(receipt.page_range.last_page_number, document_results[0].page_range[1])
# Check page metadata
self.assertFormPagesTransformCorrect(receipt.pages, read_results)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_url_include_field_elements(self, client):
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.receipt_url_jpg,
include_field_elements=True
)
result = await poller.result()
self.assertEqual(len(result), 1)
receipt = result[0]
self.assertFormPagesHasValues(receipt.pages)
for name, field in receipt.fields.items():
if field.value_type not in ["list", "dictionary"] and name != "ReceiptType": # receipt cases where value_data is None
self.assertFieldElementsHasValues(field.value_data.field_elements, receipt.page_range.first_page_number)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_url_jpg(self, client):
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.receipt_url_jpg
)
result = await poller.result()
self.assertEqual(len(result), 1)
receipt = result[0]
self.assertEqual(receipt.fields.get("MerchantAddress").value, '123 Main Street Redmond, WA 98052')
self.assertEqual(receipt.fields.get("MerchantName").value, 'Contoso Contoso')
self.assertEqual(receipt.fields.get("MerchantPhoneNumber").value, '+19876543210')
self.assertEqual(receipt.fields.get("Subtotal").value, 11.7)
self.assertEqual(receipt.fields.get("Tax").value, 1.17)
# self.assertEqual(receipt.fields.get("Tip").value, 1.63) # FIXME: Service sees this as 463.0
self.assertEqual(receipt.fields.get("Total").value, 14.5)
self.assertEqual(receipt.fields.get("TransactionDate").value, date(year=2019, month=6, day=10))
self.assertEqual(receipt.fields.get("TransactionTime").value, time(hour=13, minute=59, second=0))
self.assertEqual(receipt.page_range.first_page_number, 1)
self.assertEqual(receipt.page_range.last_page_number, 1)
self.assertFormPagesHasValues(receipt.pages)
receipt_type = receipt.fields.get("ReceiptType")
self.assertIsNotNone(receipt_type.confidence)
self.assertEqual(receipt_type.value, 'Itemized')
self.assertReceiptItemsHasValues(receipt.fields["Items"].value, receipt.page_range.first_page_number, False)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_url_png(self, client):
async with client:
poller = await client.begin_recognize_receipts_from_url(self.receipt_url_png)
result = await poller.result()
self.assertEqual(len(result), 1)
receipt = result[0]
self.assertEqual(receipt.fields.get("MerchantAddress").value, '123 Main Street Redmond, WA 98052')
self.assertEqual(receipt.fields.get("MerchantName").value, 'Contoso Contoso')
self.assertEqual(receipt.fields.get("Subtotal").value, 1098.99)
# self.assertEqual(receipt.fields.get("Tax").value, 104.4) # FIXME: Service not finding Tax
# self.assertEqual(receipt.fields.get("Total").value, 1203.39) # FIXME: Service sees Tax as Total
self.assertEqual(receipt.fields.get("TransactionDate").value, date(year=2019, month=6, day=10))
self.assertEqual(receipt.fields.get("TransactionTime").value, time(hour=13, minute=59, second=0))
self.assertEqual(receipt.page_range.first_page_number, 1)
self.assertEqual(receipt.page_range.last_page_number, 1)
self.assertFormPagesHasValues(receipt.pages)
receipt_type = receipt.fields.get("ReceiptType")
self.assertIsNotNone(receipt_type.confidence)
self.assertEqual(receipt_type.value, 'Itemized')
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_multipage_url(self, client):
async with client:
poller = await client.begin_recognize_receipts_from_url(self.multipage_url_pdf, include_field_elements=True)
result = await poller.result()
self.assertEqual(len(result), 3)
receipt = result[0]
self.assertEqual(receipt.fields.get("MerchantAddress").value, '123 Hobbit Lane 567 Main St. Redmond, WA Redmond, WA')
self.assertEqual(receipt.fields.get("MerchantName").value, 'Bilbo Baggins')
self.assertEqual(receipt.fields.get("MerchantPhoneNumber").value, '+15555555555')
self.assertEqual(receipt.fields.get("Subtotal").value, 300.0)
# self.assertEqual(receipt.fields.get("Total").value, 430.0) # FIXME: Service not seeing Total
self.assertEqual(receipt.page_range.first_page_number, 1)
self.assertEqual(receipt.page_range.last_page_number, 1)
self.assertFormPagesHasValues(receipt.pages)
receipt_type = receipt.fields.get("ReceiptType")
self.assertIsNotNone(receipt_type.confidence)
self.assertEqual(receipt_type.value, 'Itemized')
receipt = result[2]
self.assertEqual(receipt.fields.get("MerchantAddress").value, '123 Hobbit Lane 567 Main St. Redmond, WA Redmond, WA')
self.assertEqual(receipt.fields.get("MerchantName").value, 'Frodo Baggins')
self.assertEqual(receipt.fields.get("MerchantPhoneNumber").value, '+15555555555')
# self.assertEqual(receipt.fields.get("Subtotal").value, 3000.0) # FIXME: Service returning wrong value
# self.assertEqual(receipt.fields.get("Total").value, 1000.0) # FIXME: Service not seeing Total
self.assertEqual(receipt.page_range.first_page_number, 3)
self.assertEqual(receipt.page_range.last_page_number, 3)
self.assertFormPagesHasValues(receipt.pages)
receipt_type = receipt.fields.get("ReceiptType")
self.assertIsNotNone(receipt_type.confidence)
self.assertEqual(receipt_type.value, 'Itemized')
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_multipage_transform_url(self, client):
responses = []
def callback(raw_response, _, headers):
analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
extracted_receipt = prepare_prebuilt_models(analyze_result)
responses.append(analyze_result)
responses.append(extracted_receipt)
async with client:
poller = await client.begin_recognize_receipts_from_url(
self.multipage_url_pdf,
include_field_elements=True,
cls=callback
)
result = await poller.result()
raw_response = responses[0]
returned_model = responses[1]
actual = raw_response.analyze_result.document_results
read_results = raw_response.analyze_result.read_results
document_results = raw_response.analyze_result.document_results
page_results = raw_response.analyze_result.page_results
# check hardcoded values
for receipt, actual in zip(returned_model, actual):
if not actual.fields: # second page is blank
continue
# check dict values
self.assertFormFieldsTransformCorrect(receipt.fields, actual.fields, read_results)
# check page range
self.assertEqual(receipt.page_range.first_page_number, actual.page_range[0])
self.assertEqual(receipt.page_range.last_page_number, actual.page_range[1])
# Check form pages
self.assertFormPagesTransformCorrect(returned_model, read_results)
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
@pytest.mark.live_test_only
async def test_receipt_continuation_token(self, client):
async with client:
initial_poller = await client.begin_recognize_receipts_from_url(self.receipt_url_jpg)
cont_token = initial_poller.continuation_token()
poller = await client.begin_recognize_receipts_from_url(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()
async def test_receipt_locale_specified(self, client):
async with client:
poller = await client.begin_recognize_receipts_from_url(self.receipt_url_jpg, locale="en-IN")
assert 'en-IN' == poller._polling_method._initial_response.http_response.request.query['locale']
await poller.wait()
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer()
async def test_receipt_locale_error(self, client):
with pytest.raises(HttpResponseError) as e:
async with client:
await client.begin_recognize_receipts_from_url(self.receipt_url_jpg, locale="not a locale")
assert "UnsupportedLocale" == e.value.error.code
@GlobalFormRecognizerAccountPreparer()
@GlobalClientPreparer(client_kwargs={"api_version": FormRecognizerApiVersion.V2_0})
async def test_receipt_locale_v2(self, client):
with pytest.raises(ValueError) as e:
async with client:
await client.begin_recognize_receipts_from_url(self.receipt_url_jpg, locale="en-US")
assert "'locale' is only available for API version V2_1_PREVIEW and up" in str(e.value)
|
