feedback + add test for copy authorization

Author: kristapratico

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

@@ -251,13 +251,13 @@ def get_custom_model(self, model_id, **kwargs):
     @distributed_trace
     def get_copy_authorization(self, resource_id, resource_region, **kwargs):
         # type: (str, str, Any) -> Dict[str, Union[str, int]]
-        """Generate authorization for copying a model into the target Form Recognizer resource.
+        """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()`.
 
         :param str resource_id: Azure Resource Id of the target Form Recognizer resource
             where the model will be copied to.
-        :param str resource_region: Location of the target Azure resource. A valid Azure
+        :param str resource_region: Location of the target Form Recognizer resource. A valid Azure
             region name supported by Cognitive Services.
         :return: A dictionary with values for the copy authorization -
             "modelId", "accessToken", "resourceId", "resourceRegion", and "expirationDateTimeTicks".

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

@@ -263,13 +263,13 @@ async def get_copy_authorization(
             resource_region: str,
             **kwargs: Any
     ) -> Dict[str, Union[str, int]]:
-        """Generate authorization for copying a model into the target Form Recognizer resource.
+        """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:`~copy_model()`.
 
         :param str resource_id: Azure Resource Id of the target Form Recognizer resource
             where the model will be copied to.
-        :param str resource_region: Location of the target Azure resource. A valid Azure
+        :param str resource_region: Location of the target Form Recognizer resource. A valid Azure
             region name supported by Cognitive Services.
         :return: A dictionary with values for the copy authorization -
             "modelId", "accessToken", "resourceId", "resourceRegion", and "expirationDateTimeTicks".

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

@@ -27,7 +27,7 @@ All of these samples need the endpoint to your Form Recognizer resource ([instru
 |[sample_train_model_without_labels.py][sample_train_model_without_labels] and [sample_train_model_without_labels_async.py][sample_train_model_without_labels_async]|Train a custom model with unlabeled data|
 |[sample_train_model_with_labels.py][sample_train_model_with_labels] and [sample_train_model_with_labels_async.py][sample_train_model_with_labels_async]|Train a custom model with labeled data|
 |[sample_manage_custom_models.py][sample_manage_custom_models] and [sample_manage_custom_models_async.py][sample_manage_custom_models_async]|Manage the custom models in your account|
-|[sample_copy_model.py][sample_copy_model] and [sample_copy_model_async.py][sample_copy_model_async]|Copy a model from one Form Recognizer resource to another|
+|[sample_copy_model.py][sample_copy_model] and [sample_copy_model_async.py][sample_copy_model_async]|Copy a custom model from one Form Recognizer resource to another|
 
 
 ## Prerequisites

sdk/formrecognizer/azure-ai-formrecognizer/tests/recordings/test_copy_model.test_copy_authorization.yaml

@@ -0,0 +1,42 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip, deflate
+      Connection:
+      - keep-alive
+      Content-Length:
+      - '0'
+      User-Agent:
+      - azsdk-python-ai-formrecognizer/1.0.0b3 Python/3.7.3 (Windows-10-10.0.18362-SP0)
+        Python/3.7.3 (Windows-10-10.0.18362-SP0)
+    method: POST
+    uri: https://westus.api.cognitive.microsoft.com/formrecognizer/v2.0-preview/custom/models/copyAuthorization
+  response:
+    body:
+      string: '{"modelId": "3a1af284-1187-402d-9869-39ad09181bf5", "accessToken":
+        "redacted", "expirationDateTimeTicks": 637255865516657423}'
+    headers:
+      apim-request-id:
+      - be03b750-1177-47fa-9473-028489a9ce67
+      content-type:
+      - application/json; charset=utf-8
+      date:
+      - Tue, 19 May 2020 15:49:11 GMT
+      location:
+      - https://westus.api.cognitive.microsoft.com/formrecognizer/v2.0-preview/custom/models/3a1af284-1187-402d-9869-39ad09181bf5
+      strict-transport-security:
+      - max-age=31536000; includeSubDomains; preload
+      transfer-encoding:
+      - chunked
+      x-content-type-options:
+      - nosniff
+      x-envoy-upstream-service-time:
+      - '231'
+    status:
+      code: 201
+      message: Created
+version: 1

sdk/formrecognizer/azure-ai-formrecognizer/tests/recordings/test_copy_model_async.test_copy_authorization.yaml

@@ -0,0 +1,29 @@
+interactions:
+- request:
+    body: null
+    headers:
+      Accept:
+      - application/json
+      User-Agent:
+      - azsdk-python-ai-formrecognizer/1.0.0b3 Python/3.7.3 (Windows-10-10.0.18362-SP0)
+        Python/3.7.3 (Windows-10-10.0.18362-SP0)
+    method: POST
+    uri: https://westus.api.cognitive.microsoft.com/formrecognizer/v2.0-preview/custom/models/copyAuthorization
+  response:
+    body:
+      string: '{"modelId": "adcd2786-9aa5-4098-9a55-7d68eaeaaf2f", "accessToken":
+        "redacted", "expirationDateTimeTicks": 637255866617034918}'
+    headers:
+      apim-request-id: 99a50a5e-a423-47ae-8e9e-9369a4ac8d90
+      content-type: application/json; charset=utf-8
+      date: Tue, 19 May 2020 15:51:01 GMT
+      location: https://westus.api.cognitive.microsoft.com/formrecognizer/v2.0-preview/custom/models/adcd2786-9aa5-4098-9a55-7d68eaeaaf2f
+      strict-transport-security: max-age=31536000; includeSubDomains; preload
+      transfer-encoding: chunked
+      x-content-type-options: nosniff
+      x-envoy-upstream-service-time: '226'
+    status:
+      code: 201
+      message: Created
+    url: https://westus.api.cognitive.microsoft.com//formrecognizer/v2.0-preview/custom/models/copyAuthorization
+version: 1

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

@@ -78,3 +78,15 @@ def callback(response, _, headers):
         self.assertEqual(copy.status, actual.status)
         self.assertEqual(copy.last_modified, actual.last_updated_date_time)
         self.assertEqual(copy.model_id, target["modelId"])
+
+    @GlobalFormRecognizerAccountPreparer()
+    @GlobalTrainingAccountPreparer(copy=True)
+    def test_copy_authorization(self, client, container_sas_url, location, resource_id):
+
+        target = client.get_copy_authorization(resource_region="eastus", resource_id=resource_id)
+
+        self.assertIsNotNone(target["modelId"])
+        self.assertIsNotNone(target["accessToken"])
+        self.assertIsNotNone(target["expirationDateTimeTicks"])
+        self.assertEqual(target["resourceRegion"], "eastus")
+        self.assertEqual(target["resourceId"], resource_id)

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

@@ -73,3 +73,15 @@ def callback(response, _, headers):
         self.assertEqual(copy.status, actual.status)
         self.assertEqual(copy.last_modified, actual.last_updated_date_time)
         self.assertEqual(copy.model_id, target["modelId"])
+
+    @GlobalFormRecognizerAccountPreparer()
+    @GlobalTrainingAccountPreparer(copy=True)
+    async def test_copy_authorization(self, client, container_sas_url, location, resource_id):
+
+        target = await client.get_copy_authorization(resource_region="eastus", resource_id=resource_id)
+
+        self.assertIsNotNone(target["modelId"])
+        self.assertIsNotNone(target["accessToken"])
+        self.assertIsNotNone(target["expirationDateTimeTicks"])
+        self.assertEqual(target["resourceRegion"], "eastus")
+        self.assertEqual(target["resourceId"], resource_id)