[formrecognizer] Rename some beta components (Azure#23448)

* rename copy model and composed model APIs

* update AccountInfo property names

Author: catalinaperalta

sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md

@@ -5,10 +5,14 @@
 ### Features Added
 
 ### Breaking Changes
+- Renamed `begin_copy_model()` to `begin_copy_model_to()`.
+- In `begin_create_composed_model()`, renamed required parameter `model_ids` to `component_model_ids`.
+- Renamed `model_count` and `model_limit` on `AccountInfo` to `document_model_count` and `document_model_limit`.
 
 ### Bugs Fixed
 
 ### Other Changes
+- Renamed `sample_copy_model.py` and `sample_copy_model_async.py` to `sample_copy_model_to.py` and `sample_copy_model_to_async.py` under the `3.2-beta` samples folder. Updated the samples to use renamed copy model method.
 
 ## 3.2.0b3 (2022-02-10)
 

sdk/formrecognizer/azure-ai-formrecognizer/README.md

@@ -544,7 +544,7 @@ document_model_admin_client = DocumentModelAdministrationClient(endpoint, creden
 
 account_info = document_model_admin_client.get_account_info()
 print("Our account has {} custom models, and we can have at most {} custom models".format(
-    account_info.model_count, account_info.model_limit
+    account_info.document_model_count, account_info.document_model_limit
 ))
 
 # Here we get a paged list of all of our models

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

@@ -181,15 +181,15 @@ def callback(raw_response, _, headers):  # pylint: disable=unused-argument
         )
 
     @distributed_trace
-    def begin_create_composed_model(self, model_ids, **kwargs):
+    def begin_create_composed_model(self, component_model_ids, **kwargs):
         # type: (List[str], Any) -> DocumentModelAdministrationLROPoller[DocumentModel]
         """Creates a composed model from a collection of existing models.
 
         A composed model allows multiple models to be called with a single model ID. When a document is
         submitted to be analyzed with a composed model ID, a classification step is first performed to
         route it to the correct custom model.
 
-        :param list[str] model_ids: List of model IDs to use in the composed model.
+        :param list[str] component_model_ids: List of model IDs to use in the composed model.
         :keyword str model_id: A unique ID for your composed model.
             If not specified, a model ID will be created for you.
         :keyword str description: An optional description to add to the model.
@@ -243,9 +243,9 @@ def _compose_callback(
                 tags=tags,
                 component_models=[
                     self._generated_models.ComponentModelInfo(model_id=model_id)
-                    for model_id in model_ids
+                    for model_id in component_model_ids
                 ]
-                if model_ids
+                if component_model_ids
                 else [],
             ),
             cls=kwargs.pop("cls", _compose_callback),
@@ -264,7 +264,7 @@ def get_copy_authorization(self, **kwargs):
         """Generate authorization for copying a custom model into the target Form Recognizer resource.
 
         This should be called by the target resource (where the model will be copied to)
-        and the output can be passed as the `target` parameter into :func:`~begin_copy_model()`.
+        and the output can be passed as the `target` parameter into :func:`~begin_copy_model_to()`.
 
         :keyword str model_id: A unique ID for your copied model.
             If not specified, a model ID will be created for you.
@@ -296,7 +296,7 @@ def get_copy_authorization(self, **kwargs):
         return target
 
     @distributed_trace
-    def begin_copy_model(
+    def begin_copy_model_to(
         self,
         model_id,  # type: str
         target,  # type: Dict
@@ -323,8 +323,8 @@ def begin_copy_model(
         .. admonition:: Example:
 
             .. literalinclude:: ../samples/v3.2-beta/sample_copy_model.py
-                :start-after: [START begin_copy_model]
-                :end-before: [END begin_copy_model]
+                :start-after: [START begin_copy_model_to]
+                :end-before: [END begin_copy_model_to]
                 :language: python
                 :dedent: 4
                 :caption: Copy a model from the source resource to the target resource

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

@@ -4086,30 +4086,30 @@ def from_dict(cls, data):
 class AccountInfo(object):
     """Info regarding models under the Form Recognizer resource.
 
-    :ivar int model_count: Number of custom models in the current resource.
-    :ivar int model_limit: Maximum number of custom models supported in the current resource.
+    :ivar int document_model_count: Number of custom models in the current resource.
+    :ivar int document_model_limit: Maximum number of custom models supported in the current resource.
     """
 
     def __init__(
         self,
         **kwargs
     ):
-        self.model_count = kwargs.get('model_count', None)
-        self.model_limit = kwargs.get('model_limit', None)
+        self.document_model_count = kwargs.get('document_model_count', None)
+        self.document_model_limit = kwargs.get('document_model_limit', None)
 
     def __repr__(self):
         return (
-            "AccountInfo(model_count={}, model_limit={})".format(
-                self.model_count,
-                self.model_limit,
+            "AccountInfo(document_model_count={}, document_model_limit={})".format(
+                self.document_model_count,
+                self.document_model_limit,
             )
         )
 
     @classmethod
     def _from_generated(cls, info):
         return cls(
-            model_count=info.count,
-            model_limit=info.limit,
+            document_model_count=info.count,
+            document_model_limit=info.limit,
         )
 
 
@@ -4121,8 +4121,8 @@ def to_dict(self):
         :rtype: dict
         """
         return {
-            "model_count": self.model_count,
-            "model_limit": self.model_limit,
+            "document_model_count": self.document_model_count,
+            "document_model_limit": self.document_model_limit,
         }
 
     @classmethod
@@ -4135,8 +4135,8 @@ def from_dict(cls, data):
         :rtype: AccountInfo
         """
         return cls(
-            model_count=data.get("model_count", None),
-            model_limit=data.get("model_limit", None),
+            document_model_count=data.get("document_model_count", None),
+            document_model_limit=data.get("document_model_limit", None),
         )
 
 

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

@@ -186,15 +186,15 @@ def callback(raw_response, _, headers):  # pylint: disable=unused-argument
         )
 
     @distributed_trace_async
-    async def begin_create_composed_model(self, model_ids, **kwargs):
+    async def begin_create_composed_model(self, component_model_ids, **kwargs):
         # type: (List[str], Any) -> AsyncDocumentModelAdministrationLROPoller[DocumentModel]
         """Creates a composed model from a collection of existing models.
 
         A composed model allows multiple models to be called with a single model ID. When a document is
         submitted to be analyzed with a composed model ID, a classification step is first performed to
         route it to the correct custom model.
 
-        :param list[str] model_ids: List of model IDs to use in the composed model.
+        :param list[str] component_model_ids: List of model IDs to use in the composed model.
         :keyword str model_id: A unique ID for your composed model.
             If not specified, a model ID will be created for you.
         :keyword str description: An optional description to add to the model.
@@ -248,9 +248,9 @@ def _compose_callback(
                 tags=tags,
                 component_models=[
                     self._generated_models.ComponentModelInfo(model_id=model_id)
-                    for model_id in model_ids
+                    for model_id in component_model_ids
                 ]
-                if model_ids
+                if component_model_ids
                 else [],
             ),
             cls=kwargs.pop("cls", _compose_callback),
@@ -268,7 +268,7 @@ async def get_copy_authorization(self, **kwargs: Any) -> Dict[str, str]:
         """Generate authorization for copying a custom model into the target Form Recognizer resource.
 
         This should be called by the target resource (where the model will be copied to)
-        and the output can be passed as the `target` parameter into :func:`~begin_copy_model()`.
+        and the output can be passed as the `target` parameter into :func:`~begin_copy_model_to()`.
 
         :keyword str model_id: A unique ID for your copied model.
             If not specified, a model ID will be created for you.
@@ -300,7 +300,7 @@ async def get_copy_authorization(self, **kwargs: Any) -> Dict[str, str]:
         return target
 
     @distributed_trace_async
-    async def begin_copy_model(
+    async def begin_copy_model_to(
         self, model_id: str, target: dict, **kwargs: Any
     ) -> AsyncDocumentModelAdministrationLROPoller[DocumentModel]:
         """Copy a model stored in this resource (the source) to the user specified
@@ -322,9 +322,9 @@ async def begin_copy_model(
 
         .. admonition:: Example:
 
-            .. literalinclude:: ../samples/v3.2-beta/async_samples/sample_copy_model_async.py
-                :start-after: [START begin_copy_model_async]
-                :end-before: [END begin_copy_model_async]
+            .. literalinclude:: ../samples/v3.2-beta/async_samples/sample_copy_model_to_async.py
+                :start-after: [START begin_copy_model_to_async]
+                :end-before: [END begin_copy_model_to_async]
                 :language: python
                 :dedent: 4
                 :caption: Copy a model from the source resource to the target resource

sdk/formrecognizer/azure-ai-formrecognizer/samples/README.md

@@ -40,7 +40,7 @@ All of these samples need the endpoint to your Form Recognizer resource ([instru
 |[sample_create_composed_model.py][sample_composed_model] and [sample_create_composed_model_async.py][sample_composed_model_async]|Create a composed model from a collection of existing models to be called with a single model ID|
 |[sample_manage_models.py][sample_manage_models] and [sample_manage_models_async.py][sample_manage_models_async]|Manage the models in your account|
 |[sample_get_operations.py][sample_get_operations] and [sample_get_operations_async.py][sample_get_operations_async]|Get and list the document model operations created within the past 24 hours|
-|[sample_copy_model.py][sample_copy] and [sample_copy_model_async.py][sample_copy_async]|Copy a custom model from one Form Recognizer resource to another|
+|[sample_copy_model_to.py][sample_copy] and [sample_copy_model_to_async.py][sample_copy_async]|Copy a custom model from one Form Recognizer resource to another|
 |[sample_get_words_on_document_line.py][sample_get_words_on_document_line] and [sample_get_words_on_document_line_async.py][sample_get_words_on_document_line_async]|Get the words in a DocumentLine|
 |[sample_convert_to_and_from_dict.py][sample_convert_to_and_from_dict_v3_2] and [sample_convert_to_and_from_dict_async.py][sample_convert_to_and_from_dict_async_v3_2]|Convert model types to a dictionary that can be used to create JSON content, then convert the same dictionary back to the original model type|
 |[sample_get_elements_with_spans.py][sample_get_elements_with_spans] and [sample_get_elements_with_spans_async.py][sample_get_elements_with_spans_async]|Get elements, such as words, lines, and styles, in the result of an analyze operation by searching with spans|
@@ -139,8 +139,8 @@ what you can do with the Azure Form Recognizer client library.
 [sample_manage_models_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_manage_models_async.py
 [sample_get_operations]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_get_operations.py
 [sample_get_operations_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_get_operations_async.py
-[sample_copy]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_copy_model.py
-[sample_copy_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_copy_model_async.py
+[sample_copy]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_copy_model_to.py
+[sample_copy_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_copy_model_to_async.py
 [sample_get_words_on_document_line]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_get_words_on_document_line.py
 [sample_get_words_on_document_line_async]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_get_words_on_document_line_async.py
 [sample_get_elements_with_spans]: https://aka.ms/azsdk/python/formrecognizer/spansamplesync

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_copy_model_async.py renamed to sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_copy_model_to_async.py

@@ -7,7 +7,7 @@
 # --------------------------------------------------------------------------
 
 """
-FILE: sample_copy_model_async.py
+FILE: sample_copy_model_to_async.py
 
 DESCRIPTION:
     This sample demonstrates how to copy a custom model from a source Form Recognizer resource
@@ -17,7 +17,7 @@
     training files in https://aka.ms/azsdk/formrecognizer/sampletrainingfiles
 
 USAGE:
-    python sample_copy_model_async.py
+    python sample_copy_model_to_async.py
 
     Set the environment variables with your own values before running the sample:
     1) AZURE_FORM_RECOGNIZER_SOURCE_ENDPOINT - the endpoint to your source Form Recognizer resource.
@@ -34,8 +34,8 @@
 import asyncio
 
 
-async def sample_copy_model_async(custom_model_id):
-    # [START begin_copy_model_async]
+async def sample_copy_model_to_async(custom_model_id):
+    # [START begin_copy_model_to_async]
     from azure.core.credentials import AzureKeyCredential
     from azure.ai.formrecognizer.aio import DocumentModelAdministrationClient
 
@@ -53,7 +53,7 @@ async def sample_copy_model_async(custom_model_id):
 
     source_client = DocumentModelAdministrationClient(endpoint=source_endpoint, credential=AzureKeyCredential(source_key))
     async with source_client:
-        poller = await source_client.begin_copy_model(
+        poller = await source_client.begin_copy_model_to(
             model_id=source_model_id,
             target=target  # output from target client's call to get_copy_authorization()
         )
@@ -69,7 +69,7 @@ async def sample_copy_model_async(custom_model_id):
             print("Field: '{}' has type '{}' and confidence score {}".format(
                 field_name, field["type"], doc_type.field_confidence[field_name]
             ))
-    # [END begin_copy_model_async]
+    # [END begin_copy_model_to_async]
 
 
 async def main():
@@ -93,7 +93,7 @@ async def main():
             model = await (await document_model_admin_client.begin_build_model(os.getenv("CONTAINER_SAS_URL"), DocumentBuildMode.TEMPLATE)).result()
             model_id = model.model_id
 
-    await sample_copy_model_async(model_id)
+    await sample_copy_model_to_async(model_id)
 
 if __name__ == '__main__':
     asyncio.run(main())

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/async_samples/sample_manage_models_async.py

@@ -42,7 +42,7 @@ async def sample_manage_models_async():
     async with document_model_admin_client:
         account_info = await document_model_admin_client.get_account_info()
         print("Our account has {} custom models, and we can have at most {} custom models\n".format(
-            account_info.model_count, account_info.model_limit
+            account_info.document_model_count, account_info.document_model_limit
         ))
         # [END get_account_info_async]
 

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_copy_model.py renamed to sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_copy_model_to.py

@@ -7,7 +7,7 @@
 # --------------------------------------------------------------------------
 
 """
-FILE: sample_copy_model.py
+FILE: sample_copy_model_to.py
 
 DESCRIPTION:
     This sample demonstrates how to copy a custom model from a source Form Recognizer resource
@@ -17,7 +17,7 @@
     training files in https://aka.ms/azsdk/formrecognizer/sampletrainingfiles
 
 USAGE:
-    python sample_copy_model.py
+    python sample_copy_model_to.py
 
     Set the environment variables with your own values before running the sample:
     1) AZURE_FORM_RECOGNIZER_SOURCE_ENDPOINT - the endpoint to your source Form Recognizer resource.
@@ -32,8 +32,8 @@
 
 import os
 
-def sample_copy_model(custom_model_id):
-    # [START begin_copy_model]
+def sample_copy_model_to(custom_model_id):
+    # [START begin_copy_model_to]
     from azure.core.credentials import AzureKeyCredential
     from azure.ai.formrecognizer import DocumentModelAdministrationClient
 
@@ -50,7 +50,7 @@ def sample_copy_model(custom_model_id):
     )
 
     source_client = DocumentModelAdministrationClient(endpoint=source_endpoint, credential=AzureKeyCredential(source_key))
-    poller = source_client.begin_copy_model(
+    poller = source_client.begin_copy_model_to(
         model_id=source_model_id,
         target=target  # output from target client's call to get_copy_authorization()
     )
@@ -66,7 +66,7 @@ def sample_copy_model(custom_model_id):
             print("Field: '{}' has type '{}' and confidence score {}".format(
                 field_name, field["type"], doc_type.field_confidence[field_name]
             ))
-    # [END begin_copy_model]
+    # [END begin_copy_model_to]
 
 
 if __name__ == '__main__':
@@ -88,4 +88,4 @@ def sample_copy_model(custom_model_id):
         model = document_model_admin_client.begin_build_model(os.getenv("CONTAINER_SAS_URL"), DocumentBuildMode.TEMPLATE).result()
         model_id = model.model_id
 
-    sample_copy_model(model_id)
+    sample_copy_model_to(model_id)

sdk/formrecognizer/azure-ai-formrecognizer/samples/v3.2-beta/sample_manage_models.py

@@ -39,7 +39,7 @@ def sample_manage_models():
 
     account_info = document_model_admin_client.get_account_info()
     print("Our account has {} custom models, and we can have at most {} custom models\n".format(
-        account_info.model_count, account_info.model_limit
+        account_info.document_model_count, account_info.document_model_limit
     ))
     # [END get_account_info]