Generating document translation SDK from typespec for both single and batch translation. (#35298)

* Generated SDK from typespec latest commit ID.
Added single document translation tests - sync and async.
Fixed getsupportedformat tests- sync and async.

* restoring dt client + models behavior

* Restored async document translation operations under aio folder and validated that sync and async test cases work except for 1 failure

* Skipping a test scenario that is no longer valid

* Marking Single document test to run in Live mode only and uploaded test recordings to assets repo

* Updated typeSpec commitID with rest-api repo. Updated test cases w.r.t removal of $, orderby and FileFormatType changes.

* Fixed failing  test case. Added sample test for SDT. All tests are now passing in Live and Record/playback mode, hence pushed recordings to assets repo and uupdated assets.json

* Adding words to be ignored for spellcheck during builds

* Fixing pylint and mypy issues

* Addressing review comments on ChangeLog.md

* Fixing a build error in pyproject.toml

* Fixing some build failures

* Fixing build error w.r.t samples

* Addressing review  comments

* Moving the model definitions from models/_patch.py to azure/ai/translation/document/_patch.py and fixing references

* Another attempt to fix sphinx errors

* Fixing a test failure

* Regenerating the SDK after making the models internal and updating all references.

* Regenerating the SDK with DocumentTranslateContent not internal

* Updating version to 1.1.0b1

* run post-processing

* Fixing mypy issues

* some fixes, reenable checks

* verifytypes passing

* remove comments

* Addressing review comments

* Addressing review comments

* missed pushing this update to address review comments

---------

Co-authored-by: Krista Pratico <[email protected]>

Author: hamshavathimunibyraiah

.vscode/cspell.json

@@ -1772,6 +1772,15 @@
         "wday"
       ]
     },
+    {
+      "filename": "sdk/translation/azure-ai-translation-document/azure/ai/translation/document/*.py",
+      "words": [
+        "mros",
+        "Nify",
+        "ctxt",
+        "wday"
+      ]
+    },
     {
       "filename": "sdk/healthinsights/azure-healthinsights-radiologyinsights/**",
       "words": [

sdk/translation/azure-ai-translation-document/CHANGELOG.md

@@ -1,12 +1,14 @@
 # Release History
 
-## 1.0.1 (Unreleased)
+## 1.1.0b1 (Unreleased)
 
 ### Features Added
+- Added SingleDocumentTranslationClient that is used to invoke `document_translate` API.
+- `document_translate` is the method added to submit a single/synchronous document translation request to the Document Translation service.
+- `DocumentTranslateContent` has been added to specify the `document_translate` request content.
 
 ### Breaking Changes
-
-### Bugs Fixed
+- Version `v1.0` is not supported
 
 ### Other Changes
 

sdk/translation/azure-ai-translation-document/MANIFEST.in

@@ -1,8 +1,8 @@
-recursive-include tests *.py
-recursive-include samples *.py *.md
 include *.md
 include LICENSE
+include azure/ai/translation/document/py.typed
+recursive-include tests *.py
+recursive-include samples *.py *.md
 include azure/__init__.py
 include azure/ai/__init__.py
-include azure/ai/translation/__init__.py
-include azure/ai/translation/document/py.typed
+include azure/ai/translation/__init__.py

sdk/translation/azure-ai-translation-document/README.md

@@ -21,7 +21,7 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For
 ## Getting started
 
 ### Prerequisites
-* Python 3.7 or later is required to use this package.
+* Python 3.8 or later is required to use this package.
 * You must have an [Azure subscription][azure_subscription] and a
 [Translator resource][DT_resource] to use this package.
 
@@ -30,10 +30,10 @@ _Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For
 Install the Azure Document Translation client library for Python with [pip][pip]:
 
 ```bash
-pip install azure-ai-translation-document
+pip install --pre azure-ai-translation-document
 ```
 
-> Note: This version of the client library defaults to the v1.0 version of the service
+> Note: This version of the client library defaults to the v2024-05-01 version of the service
 
 #### Create a Translator resource
 
@@ -179,11 +179,7 @@ poller = document_translation_client.begin_translation("<sas_url_to_source>", "<
 ```python
 import os
 from azure.core.credentials import AzureKeyCredential
-from azure.ai.translation.document import (
-    DocumentTranslationClient,
-    DocumentTranslationInput,
-    TranslationTarget
-)
+from azure.ai.translation.document import DocumentTranslationClient, DocumentTranslationInput, TranslationTarget
 
 endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
 key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]
@@ -195,29 +191,19 @@ target_container_url_es = os.environ["AZURE_TARGET_CONTAINER_URL_ES"]
 
 client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))
 
-poller = client.begin_translation(inputs=[
+poller = client.begin_translation(
+    inputs=[
         DocumentTranslationInput(
             source_url=source_container_url_1,
             targets=[
-                TranslationTarget(
-                    target_url=target_container_url_fr,
-                    language="fr"
-                ),
-                TranslationTarget(
-                    target_url=target_container_url_ar,
-                    language="ar"
-                )
-            ]
+                TranslationTarget(target_url=target_container_url_fr, language="fr"),
+                TranslationTarget(target_url=target_container_url_ar, language="ar"),
+            ],
         ),
         DocumentTranslationInput(
             source_url=source_container_url_2,
-            targets=[
-                TranslationTarget(
-                    target_url=target_container_url_es,
-                    language="es"
-                )
-            ]
-        )
+            targets=[TranslationTarget(target_url=target_container_url_es, language="es")],
+        ),
     ]
 )
 result = poller.result()
@@ -316,11 +302,7 @@ Begin translating with documents in multiple source containers to multiple targe
 ```python
 import os
 from azure.core.credentials import AzureKeyCredential
-from azure.ai.translation.document import (
-    DocumentTranslationClient,
-    DocumentTranslationInput,
-    TranslationTarget
-)
+from azure.ai.translation.document import DocumentTranslationClient, DocumentTranslationInput, TranslationTarget
 
 endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
 key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]
@@ -332,29 +314,19 @@ target_container_url_es = os.environ["AZURE_TARGET_CONTAINER_URL_ES"]
 
 client = DocumentTranslationClient(endpoint, AzureKeyCredential(key))
 
-poller = client.begin_translation(inputs=[
+poller = client.begin_translation(
+    inputs=[
         DocumentTranslationInput(
             source_url=source_container_url_1,
             targets=[
-                TranslationTarget(
-                    target_url=target_container_url_fr,
-                    language="fr"
-                ),
-                TranslationTarget(
-                    target_url=target_container_url_ar,
-                    language="ar"
-                )
-            ]
+                TranslationTarget(target_url=target_container_url_fr, language="fr"),
+                TranslationTarget(target_url=target_container_url_ar, language="ar"),
+            ],
         ),
         DocumentTranslationInput(
             source_url=source_container_url_2,
-            targets=[
-                TranslationTarget(
-                    target_url=target_container_url_es,
-                    language="es"
-                )
-            ]
-        )
+            targets=[TranslationTarget(target_url=target_container_url_es, language="es")],
+        ),
     ]
 )
 result = poller.result()
@@ -391,7 +363,6 @@ Enumerate over the translation operations submitted for the resource.
 from azure.core.credentials import AzureKeyCredential
 from azure.ai.translation.document import DocumentTranslationClient
 
-
 endpoint = os.environ["AZURE_DOCUMENT_TRANSLATION_ENDPOINT"]
 key = os.environ["AZURE_DOCUMENT_TRANSLATION_KEY"]
 

sdk/translation/azure-ai-translation-document/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/translation/azure-ai-translation-document",
-  "Tag": "python/translation/azure-ai-translation-document_a26c6e3759"
+  "Tag": "python/translation/azure-ai-translation-document_cf5e8aa525"
 }

sdk/translation/azure-ai-translation-document/azure/__init__.py

@@ -1 +1 @@
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/translation/azure-ai-translation-document/azure/ai/__init__.py

@@ -1 +1 @@
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/translation/azure-ai-translation-document/azure/ai/translation/__init__.py

@@ -1 +1 @@
-__path__ = __import__('pkgutil').extend_path(__path__, __name__)
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/translation/azure-ai-translation-document/azure/ai/translation/document/__init__.py

@@ -1,38 +1,44 @@
-# ------------------------------------
-# Copyright (c) Microsoft Corporation.
-# Licensed under the MIT License.
-# ------------------------------------
+# coding=utf-8
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See License.txt in the project root for license information.
+# Code generated by Microsoft (R) Python Code Generator.
+# Changes may cause incorrect behavior and will be lost if the code is regenerated.
+# --------------------------------------------------------------------------
 
+from ._patch import DocumentTranslationClient
+from ._client import SingleDocumentTranslationClient
 from ._version import VERSION
-from ._client import DocumentTranslationClient
-from ._generated.models import (
-    StorageInputType,
-)
-from ._api_version import DocumentTranslationApiVersion
-from ._polling import DocumentTranslationLROPoller
-from ._models import (
-    TranslationTarget,
-    TranslationStatus,
-    DocumentStatus,
-    DocumentTranslationError,
-    TranslationGlossary,
-    DocumentTranslationInput,
-    DocumentTranslationFileFormat,
-)
 
-__VERSION__ = VERSION
+__version__ = VERSION
 
 
+from ._patch import DocumentTranslationApiVersion
+from ._patch import DocumentTranslationLROPoller
+from ._patch import TranslationGlossary
+from ._patch import TranslationTarget
+from ._patch import DocumentTranslationInput
+from ._patch import TranslationStatus
+from ._patch import DocumentStatus
+from ._patch import DocumentTranslationError
+from ._patch import DocumentTranslationFileFormat
+from ._patch import StorageInputType
+from ._patch import patch_sdk as _patch_sdk
+
 __all__ = [
-    "DocumentTranslationClient",
     "DocumentTranslationApiVersion",
-    "DocumentTranslationInput",
+    "DocumentTranslationLROPoller",
     "TranslationGlossary",
-    "StorageInputType",
-    "DocumentTranslationFileFormat",
     "TranslationTarget",
+    "DocumentTranslationInput",
     "TranslationStatus",
     "DocumentStatus",
     "DocumentTranslationError",
-    "DocumentTranslationLROPoller",
+    "DocumentTranslationFileFormat",
+    "StorageInputType",
+    "DocumentTranslationClient",
+    "SingleDocumentTranslationClient",
 ]
+
+
+_patch_sdk()