rename receipt response handler and callback to prebuilt

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py

@@ -17,7 +17,7 @@
 from azure.core.polling.base_polling import LROBasePolling
 
 from ._response_handlers import (
-    prepare_receipt,
+    prepare_prebuilt_models,
     prepare_content_result,
     prepare_form_result
 )
@@ -64,9 +64,9 @@ class FormRecognizerClient(FormRecognizerClientBase):
             :caption: Creating the FormRecognizerClient with a token credential.
     """
 
-    def _receipt_callback(self, raw_response, _, headers):  # pylint: disable=unused-argument
+    def _prebuilt_callback(self, raw_response, _, headers):  # pylint: disable=unused-argument
         analyze_result = self._deserialize(self._generated_models.AnalyzeOperationResult, raw_response)
-        return prepare_receipt(analyze_result)
+        return prepare_prebuilt_models(analyze_result)
 
     @distributed_trace
     def begin_recognize_receipts(self, receipt, **kwargs):
@@ -113,7 +113,7 @@ def begin_recognize_receipts(self, receipt, **kwargs):
         include_field_elements = kwargs.pop("include_field_elements", False)
         if content_type == "application/json":
             raise TypeError("Call begin_recognize_receipts_from_url() to analyze a receipt from a URL.")
-        cls = kwargs.pop("cls", self._receipt_callback)
+        cls = kwargs.pop("cls", self._prebuilt_callback)
         if content_type is None:
             content_type = get_content_type(receipt)
 
@@ -166,7 +166,7 @@ def begin_recognize_receipts_from_url(self, receipt_url, **kwargs):
         """
         locale = kwargs.pop("locale", None)
         include_field_elements = kwargs.pop("include_field_elements", False)
-        cls = kwargs.pop("cls", self._receipt_callback)
+        cls = kwargs.pop("cls", self._prebuilt_callback)
         if self.api_version == "2.1-preview.1" and locale:
             kwargs.update({"locale": locale})
         return self._client.begin_analyze_receipt_async(  # type: ignore
@@ -223,7 +223,7 @@ def begin_recognize_business_cards(
                 file_stream=business_card,
                 content_type=content_type,
                 include_text_details=include_field_elements,
-                cls=kwargs.pop("cls", self._receipt_callback),
+                cls=kwargs.pop("cls", self._prebuilt_callback),
                 polling=True,
                 **kwargs
             )
@@ -268,7 +268,7 @@ def begin_recognize_business_cards_from_url(
             return self._client.begin_analyze_business_card_async(  # type: ignore
                 file_stream={"source": business_card_url},
                 include_text_details=include_field_elements,
-                cls=kwargs.pop("cls", self._receipt_callback),
+                cls=kwargs.pop("cls", self._prebuilt_callback),
                 polling=True,
                 **kwargs
             )

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_models.py

@@ -356,14 +356,14 @@ def __init__(self, **kwargs):
         self.lines = kwargs.get("lines", None)
 
     @classmethod
-    def _from_generated_receipt(cls, read_result):
+    def _from_generated_prebuilt_model(cls, read_result):
         return [cls(
             page_number=page.page,
             text_angle=adjust_text_angle(page.angle),
             width=page.width,
             height=page.height,
             unit=page.unit,
-            tables=None,  # receipt model does not return tables
+            tables=None,  # prebuilt model does not return tables
             lines=[FormLine._from_generated(line, page=page.page) for line in page.lines]
             if page.lines else None
         ) for page in read_result]

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_response_handlers.py

@@ -18,14 +18,14 @@
 )
 
 
-def prepare_receipt(response):
-    receipts = []
+def prepare_prebuilt_models(response):
+    prebuilt_models = []
     read_result = response.analyze_result.read_results
     document_result = response.analyze_result.document_results
-    form_page = FormPage._from_generated_receipt(read_result)
+    form_page = FormPage._from_generated_prebuilt_model(read_result)
 
     for page in document_result:
-        receipt = RecognizedForm(
+        prebuilt_model = RecognizedForm(
             page_range=FormPageRange(
                 first_page_number=page.page_range[0], last_page_number=page.page_range[1]
             ),
@@ -37,8 +37,8 @@ def prepare_receipt(response):
             } if page.fields else None
         )
 
-        receipts.append(receipt)
-    return receipts
+        prebuilt_models.append(prebuilt_model)
+    return prebuilt_models
 
 
 def prepare_tables(page, read_result):

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py

@@ -16,7 +16,7 @@
 from azure.core.polling import AsyncLROPoller
 from azure.core.polling.async_base_polling import AsyncLROBasePolling
 from .._response_handlers import (
-    prepare_receipt,
+    prepare_prebuilt_models,
     prepare_content_result,
     prepare_form_result
 )
@@ -61,9 +61,9 @@ class FormRecognizerClient(FormRecognizerClientBaseAsync):
             :caption: Creating the FormRecognizerClient with a token credential.
     """
 
-    def _receipt_callback(self, raw_response, _, headers):  # pylint: disable=unused-argument
+    def _prebuilt_callback(self, raw_response, _, headers):  # pylint: disable=unused-argument
         analyze_result = self._deserialize(self._generated_models.AnalyzeOperationResult, raw_response)
-        return prepare_receipt(analyze_result)
+        return prepare_prebuilt_models(analyze_result)
 
     @distributed_trace_async
     async def begin_recognize_receipts(
@@ -124,7 +124,7 @@ async def begin_recognize_receipts(
             file_stream=receipt,
             content_type=content_type,
             include_text_details=include_field_elements,
-            cls=kwargs.pop("cls", self._receipt_callback),
+            cls=kwargs.pop("cls", self._prebuilt_callback),
             polling=True,
             **kwargs
         )
@@ -177,7 +177,7 @@ async def begin_recognize_receipts_from_url(
         return await self._client.begin_analyze_receipt_async(  # type: ignore
             file_stream={"source": receipt_url},
             include_text_details=include_field_elements,
-            cls=kwargs.pop("cls", self._receipt_callback),
+            cls=kwargs.pop("cls", self._prebuilt_callback),
             polling=True,
             **kwargs
         )
@@ -227,7 +227,7 @@ async def begin_recognize_business_cards(
                 file_stream=business_card,
                 content_type=content_type,
                 include_text_details=include_field_elements,
-                cls=kwargs.pop("cls", self._receipt_callback),
+                cls=kwargs.pop("cls", self._prebuilt_callback),
                 polling=True,
                 **kwargs
             )
@@ -270,7 +270,7 @@ async def begin_recognize_business_cards_from_url(
             return await self._client.begin_analyze_business_card_async(  # type: ignore
                 file_stream={"source": business_card_url},
                 include_text_details=include_field_elements,
-                cls=kwargs.pop("cls", self._receipt_callback),
+                cls=kwargs.pop("cls", self._prebuilt_callback),
                 polling=True,
                 **kwargs
             )

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_business_card.py

@@ -11,7 +11,7 @@
 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_receipt
+from azure.ai.formrecognizer._response_handlers import prepare_prebuilt_models
 from azure.ai.formrecognizer import FormRecognizerClient, FormContentType, FormRecognizerApiVersion
 from testcase import FormRecognizerTest, GlobalFormRecognizerAccountPreparer
 from testcase import GlobalClientPreparer as _GlobalClientPreparer
@@ -140,7 +140,7 @@ def test_business_card_stream_transform_png(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 
@@ -187,7 +187,7 @@ def test_business_card_stream_transform_jpg(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_business_card_async.py

@@ -11,7 +11,7 @@
 from azure.core.exceptions import ServiceRequestError, ClientAuthenticationError, HttpResponseError
 from azure.core.credentials import AzureKeyCredential
 from azure.ai.formrecognizer._generated.models import AnalyzeOperationResult
-from azure.ai.formrecognizer._response_handlers import prepare_receipt
+from azure.ai.formrecognizer._response_handlers import prepare_prebuilt_models
 from azure.ai.formrecognizer.aio import FormRecognizerClient
 from azure.ai.formrecognizer import FormContentType, FormField, FormRecognizerApiVersion
 from testcase import GlobalFormRecognizerAccountPreparer
@@ -154,7 +154,7 @@ async def test_business_card_stream_transform_png(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 
@@ -201,7 +201,7 @@ async def test_business_card_stream_transform_jpg(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_business_card_from_url.py

@@ -11,7 +11,7 @@
 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_receipt
+from azure.ai.formrecognizer._response_handlers import prepare_prebuilt_models
 from azure.ai.formrecognizer import FormRecognizerClient, FormContentType, FormRecognizerApiVersion
 from testcase import FormRecognizerTest, GlobalFormRecognizerAccountPreparer
 from testcase import GlobalClientPreparer as _GlobalClientPreparer
@@ -80,7 +80,7 @@ def test_business_card_url_transform_png(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 
@@ -124,7 +124,7 @@ def test_business_card_url_transform_jpg(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_business_card_from_url_async.py

@@ -10,7 +10,7 @@
 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_receipt
+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
@@ -89,7 +89,7 @@ async def test_business_card_url_transform_png(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 
@@ -134,7 +134,7 @@ async def test_business_card_url_transform_jpg(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_business_card = prepare_receipt(analyze_result)
+            extracted_business_card = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_business_card)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_receipt.py

@@ -11,7 +11,7 @@
 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_receipt
+from azure.ai.formrecognizer._response_handlers import prepare_prebuilt_models
 from azure.ai.formrecognizer import FormRecognizerClient, FormContentType
 from testcase import FormRecognizerTest, GlobalFormRecognizerAccountPreparer
 from testcase import GlobalClientPreparer as _GlobalClientPreparer
@@ -140,7 +140,7 @@ def test_receipt_stream_transform_png(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 
@@ -194,7 +194,7 @@ def test_receipt_stream_transform_jpg(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 
@@ -355,7 +355,7 @@ def test_receipt_multipage_transform(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_receipt_async.py

@@ -11,7 +11,7 @@
 from azure.core.exceptions import ServiceRequestError, ClientAuthenticationError, HttpResponseError
 from azure.core.credentials import AzureKeyCredential
 from azure.ai.formrecognizer._generated.models import AnalyzeOperationResult
-from azure.ai.formrecognizer._response_handlers import prepare_receipt
+from azure.ai.formrecognizer._response_handlers import prepare_prebuilt_models
 from azure.ai.formrecognizer.aio import FormRecognizerClient
 from azure.ai.formrecognizer import FormContentType
 from testcase import GlobalFormRecognizerAccountPreparer
@@ -163,7 +163,7 @@ async def test_receipt_stream_transform_png(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 
@@ -218,7 +218,7 @@ async def test_receipt_stream_transform_jpg(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 
@@ -382,7 +382,7 @@ async def test_receipt_multipage_transform(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 

sdk/formrecognizer/azure-ai-formrecognizer/tests/test_receipt_from_url.py

@@ -10,7 +10,7 @@
 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_receipt
+from azure.ai.formrecognizer._response_handlers import prepare_prebuilt_models
 from azure.ai.formrecognizer import FormRecognizerClient
 from testcase import FormRecognizerTest, GlobalFormRecognizerAccountPreparer
 from testcase import GlobalClientPreparer as _GlobalClientPreparer
@@ -88,7 +88,7 @@ def test_receipt_url_transform_jpg(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 
@@ -140,7 +140,7 @@ def test_receipt_url_transform_png(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)
 
@@ -293,7 +293,7 @@ def test_receipt_multipage_transform_url(self, client):
 
         def callback(raw_response, _, headers):
             analyze_result = client._deserialize(AnalyzeOperationResult, raw_response)
-            extracted_receipt = prepare_receipt(analyze_result)
+            extracted_receipt = prepare_prebuilt_models(analyze_result)
             responses.append(analyze_result)
             responses.append(extracted_receipt)