diff --git a/sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_model_base.py b/sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_model_base.py index e6a2730f9276..85a3feb5c5c3 100644 --- a/sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_model_base.py +++ b/sdk/translation/azure-ai-translation-document/azure/ai/translation/document/_model_base.py @@ -633,7 +633,7 @@ def _deserialize(cls, data, exist_discriminators): discriminator_value = data.find(xml_name).text # pyright: ignore else: discriminator_value = data.get(discriminator._rest_name) - mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member return mapped_cls._deserialize(data, exist_discriminators) def as_dict(self, *, exclude_readonly: bool = False) -> typing.Dict[str, typing.Any]: diff --git a/sdk/translation/azure-ai-translation-text/CHANGELOG.md b/sdk/translation/azure-ai-translation-text/CHANGELOG.md index 12cf67bd1fee..b53a644c60cc 100644 --- a/sdk/translation/azure-ai-translation-text/CHANGELOG.md +++ b/sdk/translation/azure-ai-translation-text/CHANGELOG.md @@ -1,11 +1,16 @@ # Release History -## 1.0.2 (Unreleased) +## 2.0.0b1 (Unreleased) ### Features Added +- Added support for the latest Azure AI Translator API, including translations using LLM models, adaptive custom translations, tone variant translations, and gender-specific language translations. + ### Breaking Changes +- Dictionary, sentence boundaries and text alignments features have been removed, and relevant models and properties have been removed. +- + ### Bugs Fixed ### Other Changes diff --git a/sdk/translation/azure-ai-translation-text/MANIFEST.in b/sdk/translation/azure-ai-translation-text/MANIFEST.in index af6732a09e1e..195bc20eac46 100644 --- a/sdk/translation/azure-ai-translation-text/MANIFEST.in +++ b/sdk/translation/azure-ai-translation-text/MANIFEST.in @@ -5,4 +5,4 @@ recursive-include tests *.py recursive-include samples *.py *.md include azure/__init__.py include azure/ai/__init__.py -include azure/ai/translation/__init__.py \ No newline at end of file +include azure/ai/translation/__init__.py diff --git a/sdk/translation/azure-ai-translation-text/README.md b/sdk/translation/azure-ai-translation-text/README.md index d70c4f913c2c..5aeea0dfe55a 100644 --- a/sdk/translation/azure-ai-translation-text/README.md +++ b/sdk/translation/azure-ai-translation-text/README.md @@ -101,7 +101,7 @@ try: f"Number of supported languages for transliterate operation: {len(response.transliteration) if response.transliteration is not None else 0}" ) print( - f"Number of supported languages for dictionary operations: {len(response.dictionary) if response.dictionary is not None else 0}" + f"Number of supported models for translation: {len(response.models) if response.models is not None else 0}" ) if response.translation is not None: @@ -114,10 +114,8 @@ try: for key, value in response.transliteration.items(): print(f"{key} -- name: {value.name}, supported script count: {len(value.scripts)}") - if response.dictionary is not None: - print("Dictionary Languages:") - for key, value in response.dictionary.items(): - print(f"{key} -- name: {value.name}, supported target languages count: {len(value.translations)}") + if response.models is not None: + print(f"Models: {', '.join(response.models)}") except HttpResponseError as exception: if exception.error is not None: @@ -153,7 +151,7 @@ try: f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -163,7 +161,6 @@ except HttpResponseError as exception: - For samples on using the `translate` endpoint refer to more samples [here][translate_sample]. Please refer to the service documentation for a conceptual discussion of [translate][translate_doc]. @@ -202,122 +199,11 @@ except HttpResponseError as exception: ``` + For samples on using the `transliterate` endpoint refer to more samples [here][transliterate_sample]. Please refer to the service documentation for a conceptual discussion of [transliterate][transliterate_doc]. -### Break Sentence - -Identifies the positioning of sentence boundaries in a piece of text. - - - -```python -try: - include_sentence_length = True - to_language = ["cs"] - input_text_elements = ["The answer lies in machine translation. This is a test."] - - response = text_translator.translate( - body=input_text_elements, to_language=to_language, include_sentence_length=include_sentence_length - ) - translation = response[0] if response else None - - if translation: - detected_language = translation.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." - ) - for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") - if translated_text.sent_len: - print(f"Source Sentence length: {translated_text.sent_len.src_sent_len}") - print(f"Translated Sentence length: {translated_text.sent_len.trans_sent_len}") - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") -``` - - - -For samples on using the `break sentence` endpoint refer to more samples [here][breaksentence_sample]. - -Please refer to the service documentation for a conceptual discussion of [break sentence][breaksentence_doc]. - -### Dictionary Lookup - -Returns equivalent words for the source term in the target language. - - - -```python -try: - from_language = "en" - to_language = "es" - input_text_elements = ["fly"] - - response = text_translator.lookup_dictionary_entries( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - dictionary_entry = response[0] if response else None - - if dictionary_entry: - print(f"For the given input {len(dictionary_entry.translations)} entries were found in the dictionary.") - print( - f"First entry: '{dictionary_entry.translations[0].display_target}', confidence: {dictionary_entry.translations[0].confidence}." - ) - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - raise -``` - - - -For samples on using the `dictionary lookup` endpoint refer to more samples [here][dictionarylookup_sample]. - -Please refer to the service documentation for a conceptual discussion of [dictionary lookup][dictionarylookup_doc]. - -### Dictionary Examples - -Returns grammatical structure and context examples for the source term and target term pair. - - - -```python -try: - from_language = "en" - to_language = "es" - input_text_elements = [DictionaryExampleTextItem(text="fly", translation="volar")] - - response = text_translator.lookup_dictionary_examples( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - dictionary_entry = response[0] if response else None - - if dictionary_entry: - print(f"For the given input {len(dictionary_entry.examples)} entries were found in the dictionary.") - print( - f"First example: '{dictionary_entry.examples[0].target_prefix}{dictionary_entry.examples[0].target_term}{dictionary_entry.examples[0].target_suffix}'." - ) - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") -raise -``` - - - -For samples on using the `dictionary examples` endpoint refer to more samples [here][dictionaryexamples_sample]. - -Please refer to the service documentation for a conceptual discussion of [dictionary examples][dictionaryexamples_doc]. ## Troubleshooting diff --git a/sdk/translation/azure-ai-translation-text/_metadata.json b/sdk/translation/azure-ai-translation-text/_metadata.json new file mode 100644 index 000000000000..c0891a0352d9 --- /dev/null +++ b/sdk/translation/azure-ai-translation-text/_metadata.json @@ -0,0 +1,3 @@ +{ + "apiVersion": "2025-10-01-preview" +} \ No newline at end of file diff --git a/sdk/translation/azure-ai-translation-text/apiview-properties.json b/sdk/translation/azure-ai-translation-text/apiview-properties.json new file mode 100644 index 000000000000..186452403543 --- /dev/null +++ b/sdk/translation/azure-ai-translation-text/apiview-properties.json @@ -0,0 +1,34 @@ +{ + "CrossLanguagePackageId": "TextTranslation", + "CrossLanguageDefinitionId": { + "azure.ai.translation.text.models.DetectedLanguage": "TextTranslation.DetectedLanguage", + "azure.ai.translation.text.models.ErrorDetails": "TextTranslation.ErrorDetails", + "azure.ai.translation.text.models.ErrorResponse": "TextTranslation.ErrorResponse", + "azure.ai.translation.text.models.GetSupportedLanguagesResult": "TextTranslation.GetSupportedLanguagesResult", + "azure.ai.translation.text.models.InputTextItem": "TextTranslation.InputTextItem", + "azure.ai.translation.text.models.LanguageScript": "TextTranslation.LanguageScript", + "azure.ai.translation.text.models.ReferenceTextPair": "TextTranslation.ReferenceTextPair", + "azure.ai.translation.text.models.TranslateBody": "TextTranslation.TranslateBody", + "azure.ai.translation.text.models.TranslatedTextItem": "TextTranslation.TranslatedTextItem", + "azure.ai.translation.text.models.TranslateInputItem": "TextTranslation.TranslateInputItem", + "azure.ai.translation.text.models.TranslationLanguage": "TextTranslation.TranslationLanguage", + "azure.ai.translation.text.models.TranslationResult": "TextTranslation.TranslationResult", + "azure.ai.translation.text.models.TranslationTarget": "TextTranslation.TranslationTarget", + "azure.ai.translation.text.models.TranslationText": "TextTranslation.TranslationText", + "azure.ai.translation.text.models.TransliterableScript": "TextTranslation.TransliterableScript", + "azure.ai.translation.text.models.TransliterateBody": "TextTranslation.TransliterateBody", + "azure.ai.translation.text.models.TransliteratedText": "TextTranslation.TransliteratedText", + "azure.ai.translation.text.models.TransliterateResult": "TextTranslation.TransliterateResult", + "azure.ai.translation.text.models.TransliterationLanguage": "TextTranslation.TransliterationLanguage", + "azure.ai.translation.text.models.LanguageDirectionality": "TextTranslation.LanguageDirectionality", + "azure.ai.translation.text.models.TextType": "TextTranslation.TextType", + "azure.ai.translation.text.models.ProfanityAction": "TextTranslation.ProfanityAction", + "azure.ai.translation.text.models.ProfanityMarker": "TextTranslation.ProfanityMarker", + "azure.ai.translation.text.TextTranslationClient.get_supported_languages": "TextTranslation.getSupportedLanguages", + "azure.ai.translation.text.aio.TextTranslationClient.get_supported_languages": "TextTranslation.getSupportedLanguages", + "azure.ai.translation.text.TextTranslationClient.translate": "TextTranslation.translate", + "azure.ai.translation.text.aio.TextTranslationClient.translate": "TextTranslation.translate", + "azure.ai.translation.text.TextTranslationClient.transliterate": "TextTranslation.transliterate", + "azure.ai.translation.text.aio.TextTranslationClient.transliterate": "TextTranslation.transliterate" + } +} \ No newline at end of file diff --git a/sdk/translation/azure-ai-translation-text/assets.json b/sdk/translation/azure-ai-translation-text/assets.json index 4f0bd1f71741..beab00514a27 100644 --- a/sdk/translation/azure-ai-translation-text/assets.json +++ b/sdk/translation/azure-ai-translation-text/assets.json @@ -2,5 +2,5 @@ "AssetsRepo": "Azure/azure-sdk-assets", "AssetsRepoPrefixPath": "python", "TagPrefix": "python/translation/azure-ai-translation-text", - "Tag": "python/translation/azure-ai-translation-text_35ab9367d7" + "Tag": "python/translation/azure-ai-translation-text_8d7a749482" } diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/__init__.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/__init__.py index 4b66a9e2dde2..9222cec2fdae 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/__init__.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/__init__.py @@ -5,18 +5,28 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._patch import TextTranslationClient +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + +from ._client import TextTranslationClient # type: ignore from ._version import VERSION __version__ = VERSION - +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "TextTranslationClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_client.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_client.py index c5ebee7ced4a..09e9e6c87ffd 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_client.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_client.py @@ -8,17 +8,18 @@ from copy import deepcopy from typing import Any +from typing_extensions import Self from azure.core import PipelineClient from azure.core.pipeline import policies from azure.core.rest import HttpRequest, HttpResponse from ._configuration import TextTranslationClientConfiguration -from ._operations import TextTranslationClientOperationsMixin -from ._serialization import Deserializer, Serializer +from ._operations import _TextTranslationClientOperationsMixin +from ._utils.serialization import Deserializer, Serializer -class TextTranslationClient(TextTranslationClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword +class TextTranslationClient(_TextTranslationClientOperationsMixin): """Text translation is a cloud-based REST API feature of the Translator service that uses neural machine translation technology to enable quick and accurate source-to-target text translation in real time across all supported languages. @@ -37,16 +38,12 @@ class TextTranslationClient(TextTranslationClientOperationsMixin): # pylint: di Detect. Returns the source code language code and a boolean variable denoting whether the detected language is supported for text translation and transliteration. - Dictionary lookup. Returns equivalent words for the source term in the target language. - - Dictionary example Returns grammatical structure and context examples for the source term and - target term pair. - :param endpoint: Supported Text Translation endpoints (protocol and hostname, for example: - https://api.cognitive.microsofttranslator.com). Required. + `https://api.cognitive.microsofttranslator.com + `_). Required. :type endpoint: str - :keyword api_version: Mandatory API version parameter. Default value is "3.0". Note that - overriding this default value may result in unsupported behavior. + :keyword api_version: Mandatory API version parameter. Default value is "2025-10-01-preview". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -55,6 +52,7 @@ def __init__( # pylint: disable=missing-client-constructor-parameter-credential ) -> None: _endpoint = "{Endpoint}" self._config = TextTranslationClientConfiguration(endpoint=endpoint, **kwargs) + _policies = kwargs.pop("policies", None) if _policies is None: _policies = [ @@ -107,7 +105,7 @@ def send_request(self, request: HttpRequest, *, stream: bool = False, **kwargs: def close(self) -> None: self._client.close() - def __enter__(self) -> "TextTranslationClient": + def __enter__(self) -> Self: self._client.__enter__() return self diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_configuration.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_configuration.py index 37b94a41e8a9..ee651e4fdd63 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_configuration.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_configuration.py @@ -13,22 +13,23 @@ from ._version import VERSION -class TextTranslationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class TextTranslationClientConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for TextTranslationClient. Note that all parameters used to create this instance are saved as instance attributes. :param endpoint: Supported Text Translation endpoints (protocol and hostname, for example: - https://api.cognitive.microsofttranslator.com). Required. + `https://api.cognitive.microsofttranslator.com + `_). Required. :type endpoint: str - :keyword api_version: Mandatory API version parameter. Default value is "3.0". Note that - overriding this default value may result in unsupported behavior. + :keyword api_version: Mandatory API version parameter. Default value is "2025-10-01-preview". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, **kwargs: Any) -> None: - api_version: str = kwargs.pop("api_version", "3.0") + api_version: str = kwargs.pop("api_version", "2025-10-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_model_base.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_model_base.py index 5cf70733404d..8c6780b64b19 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_model_base.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_model_base.py @@ -667,7 +667,7 @@ def _get_deserialize_callable_from_annotation( # pylint: disable=R0911, R0915, except AttributeError: model_name = annotation if module is not None: - annotation = _get_model(module, model_name) + annotation = _get_model(module, model_name) # type: ignore try: if module and _is_model(annotation): diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/__init__.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/__init__.py index 47ae0af6503a..57effd24ec31 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/__init__.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/__init__.py @@ -5,14 +5,19 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._patch import TextTranslationClientOperationsMixin +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import -from ._patch import patch_sdk as _patch_sdk +from ._operations import _TextTranslationClientOperationsMixin # type: ignore # pylint: disable=unused-import -__all__ = [ - "TextTranslationClientOperationsMixin", -] +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_operations.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_operations.py index 73eda75baff4..46bc17feb673 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_operations.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_operations.py @@ -1,4 +1,3 @@ -# pylint: disable=too-many-lines,too-many-statements # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,13 +5,12 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -# pylint: disable=R0914 +from collections.abc import MutableMapping from io import IOBase import json -import sys -from typing import Any, Callable, Dict, IO, List, Optional, Type, TypeVar, Union, overload +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload -from azure.core import MatchConditions +from azure.core import MatchConditions, PipelineClient from azure.core.exceptions import ( ClientAuthenticationError, HttpResponseError, @@ -20,6 +18,8 @@ ResourceModifiedError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.pipeline import PipelineResponse @@ -28,16 +28,15 @@ from azure.core.utils import case_insensitive_dict from .. import models as _models -from .._model_base import SdkJSONEncoder, _deserialize -from .._serialization import Serializer -from .._vendor import TextTranslationClientMixinABC, prep_if_match, prep_if_none_match - -if sys.version_info >= (3, 9): - from collections.abc import MutableMapping -else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +from .._configuration import TextTranslationClientConfiguration +from .._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from .._utils.serialization import Serializer +from .._utils.utils import ClientMixinABC, prep_if_match, prep_if_none_match +from .._validation import api_version_validation + +JSON = MutableMapping[str, Any] T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, HttpResponse], T, dict[str, Any]], Any]] _SERIALIZER = Serializer() _SERIALIZER.client_side_validation = False @@ -55,7 +54,7 @@ def build_text_translation_get_supported_languages_request( # pylint: disable=n _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "3.0")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-10-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -82,57 +81,18 @@ def build_text_translation_get_supported_languages_request( # pylint: disable=n return HttpRequest(method="GET", url=_url, params=_params, headers=_headers, **kwargs) -def build_text_translation_translate_request( - *, - to_language: List[str], - client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, - **kwargs: Any -) -> HttpRequest: +def build_text_translation_translate_request(*, client_trace_id: Optional[str] = None, **kwargs: Any) -> HttpRequest: _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "3.0")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-10-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL _url = "/translate" # Construct parameters - _params["to"] = [_SERIALIZER.query("to_language", q, "str") if q is not None else "" for q in to_language] - if from_language is not None: - _params["from"] = _SERIALIZER.query("from_language", from_language, "str") - if text_type is not None: - _params["textType"] = _SERIALIZER.query("text_type", text_type, "str") - if category is not None: - _params["category"] = _SERIALIZER.query("category", category, "str") - if profanity_action is not None: - _params["profanityAction"] = _SERIALIZER.query("profanity_action", profanity_action, "str") - if profanity_marker is not None: - _params["profanityMarker"] = _SERIALIZER.query("profanity_marker", profanity_marker, "str") - if include_alignment is not None: - _params["includeAlignment"] = _SERIALIZER.query("include_alignment", include_alignment, "bool") - if include_sentence_length is not None: - _params["includeSentenceLength"] = _SERIALIZER.query("include_sentence_length", include_sentence_length, "bool") - if suggested_from is not None: - _params["suggestedFrom"] = _SERIALIZER.query("suggested_from", suggested_from, "str") - if from_script is not None: - _params["fromScript"] = _SERIALIZER.query("from_script", from_script, "str") - if to_script is not None: - _params["toScript"] = _SERIALIZER.query("to_script", to_script, "str") - if allow_fallback is not None: - _params["allowFallback"] = _SERIALIZER.query("allow_fallback", allow_fallback, "bool") _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") # Construct headers @@ -152,7 +112,7 @@ def build_text_translation_transliterate_request( # pylint: disable=name-too-lo _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "3.0")) + api_version: str = kwargs.pop("api_version", _params.pop("api-version", "2025-10-01-preview")) accept = _headers.pop("Accept", "application/json") # Construct URL @@ -174,97 +134,9 @@ def build_text_translation_transliterate_request( # pylint: disable=name-too-lo return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) -def build_text_translation_find_sentence_boundaries_request( # pylint: disable=name-too-long - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - **kwargs: Any -) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "3.0")) - accept = _headers.pop("Accept", "application/json") - - # Construct URL - _url = "/breaksentence" - - # Construct parameters - if language is not None: - _params["language"] = _SERIALIZER.query("language", language, "str") - if script is not None: - _params["script"] = _SERIALIZER.query("script", script, "str") - _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - - # Construct headers - if client_trace_id is not None: - _headers["X-ClientTraceId"] = _SERIALIZER.header("client_trace_id", client_trace_id, "str") - if content_type is not None: - _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - - return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) - - -def build_text_translation_lookup_dictionary_entries_request( # pylint: disable=name-too-long - *, from_language: str, to_language: str, client_trace_id: Optional[str] = None, **kwargs: Any -) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "3.0")) - accept = _headers.pop("Accept", "application/json") - - # Construct URL - _url = "/dictionary/lookup" - - # Construct parameters - _params["from"] = _SERIALIZER.query("from_language", from_language, "str") - _params["to"] = _SERIALIZER.query("to_language", to_language, "str") - _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - - # Construct headers - if client_trace_id is not None: - _headers["X-ClientTraceId"] = _SERIALIZER.header("client_trace_id", client_trace_id, "str") - if content_type is not None: - _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - - return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) - - -def build_text_translation_lookup_dictionary_examples_request( # pylint: disable=name-too-long - *, from_language: str, to_language: str, client_trace_id: Optional[str] = None, **kwargs: Any -) -> HttpRequest: - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = case_insensitive_dict(kwargs.pop("params", {}) or {}) - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - api_version: str = kwargs.pop("api_version", _params.pop("api-version", "3.0")) - accept = _headers.pop("Accept", "application/json") - - # Construct URL - _url = "/dictionary/examples" - - # Construct parameters - _params["from"] = _SERIALIZER.query("from_language", from_language, "str") - _params["to"] = _SERIALIZER.query("to_language", to_language, "str") - _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str") - - # Construct headers - if client_trace_id is not None: - _headers["X-ClientTraceId"] = _SERIALIZER.header("client_trace_id", client_trace_id, "str") - if content_type is not None: - _headers["Content-Type"] = _SERIALIZER.header("content_type", content_type, "str") - _headers["Accept"] = _SERIALIZER.header("accept", accept, "str") - - return HttpRequest(method="POST", url=_url, params=_params, headers=_headers, **kwargs) - - -class TextTranslationClientOperationsMixin(TextTranslationClientMixinABC): +class _TextTranslationClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], TextTranslationClientConfiguration] +): @distributed_trace def get_supported_languages( @@ -277,7 +149,6 @@ def get_supported_languages( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.GetSupportedLanguagesResult: - # pylint: disable=line-too-long """Gets the set of languages currently supported by other operations of the Translator. Gets the set of languages currently supported by other operations of the Translator. @@ -286,7 +157,7 @@ def get_supported_languages( value is None. :paramtype client_trace_id: str :keyword scope: A comma-separated list of names defining the group of languages to return. - Allowed group names are: ``translation``\\ , ``transliteration`` and ``dictionary``. + Allowed group names are: ``translation``, ``transliteration`` and ``dictionary``. If no scope is given, then all groups are returned, which is equivalent to passing ``scope=translation,transliteration,dictionary``. To decide which set of supported languages is appropriate for your scenario, see the description of the `response object @@ -312,88 +183,8 @@ def get_supported_languages( MutableMapping :rtype: ~azure.ai.translation.text.models.GetSupportedLanguagesResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == { - "dictionary": { - "str": { - "dir": "str", # Directionality, which is rtl for - right-to-left languages or ltr for left-to-right languages. Required. - Known values are: "ltr" and "rtl". - "name": "str", # Display name of the language in the locale - requested via Accept-Language header. Required. - "nativeName": "str", # Display name of the language in the - locale native for this language. Required. - "translations": [ - { - "code": "str", # Language code identifying - the target language. Required. - "dir": "str", # Directionality, which is rtl - for right-to-left languages or ltr for left-to-right languages. - Required. Known values are: "ltr" and "rtl". - "name": "str", # Display name of the - language in the locale requested via Accept-Language header. - Required. - "nativeName": "str" # Display name of the - language in the locale native for this language. Required. - } - ] - } - }, - "translation": { - "str": { - "dir": "str", # Directionality, which is rtl for - right-to-left languages or ltr for left-to-right languages. Required. - Known values are: "ltr" and "rtl". - "name": "str", # Display name of the language in the locale - requested via Accept-Language header. Required. - "nativeName": "str" # Display name of the language in the - locale native for this language. Required. - } - }, - "transliteration": { - "str": { - "name": "str", # Display name of the language in the locale - requested via Accept-Language header. Required. - "nativeName": "str", # Display name of the language in the - locale native for this language. Required. - "scripts": [ - { - "code": "str", # Code identifying the - script. Required. - "dir": "str", # Directionality, which is rtl - for right-to-left languages or ltr for left-to-right languages. - Required. Known values are: "ltr" and "rtl". - "name": "str", # Display name of the script - in the locale requested via Accept-Language header. Required. - "nativeName": "str", # Display name of the - language in the locale native for the language. Required. - "toScripts": [ - { - "code": "str", # Code - identifying the script. Required. - "dir": "str", # - Directionality, which is rtl for right-to-left languages - or ltr for left-to-right languages. Required. Known - values are: "ltr" and "rtl". - "name": "str", # Display - name of the script in the locale requested via - Accept-Language header. Required. - "nativeName": "str" # - Display name of the language in the locale native for the - language. Required. - } - ] - } - ] - } - } - } """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -436,9 +227,15 @@ def get_supported_languages( if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) response_headers = {} @@ -458,177 +255,53 @@ def get_supported_languages( @overload def translate( self, - body: List[_models.InputTextItem], + body: _models.TranslateBody, *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long + ) -> _models.TranslationResult: """Translate Text. Translate Text. :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword to_language: Specifies the language of the output text. The target language must be - one of the supported languages included - in the translation scope. For example, use to=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to=de&to=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :type body: ~azure.ai.translation.text.models.TranslateBody :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: list of TranslatedTextItem - :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult :raises ~azure.core.exceptions.HttpResponseError: + """ - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] + @overload + def translate( + self, + body: JSON, + *, + client_trace_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.TranslationResult: + """Translate Text. + + Translate Text. + + :param body: Defines the content of the request. Required. + :type body: JSON + :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default + value is None. + :paramtype client_trace_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult + :raises ~azure.core.exceptions.HttpResponseError: """ @overload @@ -636,336 +309,55 @@ def translate( self, body: IO[bytes], *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long + ) -> _models.TranslationResult: """Translate Text. Translate Text. :param body: Defines the content of the request. Required. :type body: IO[bytes] - :keyword to_language: Specifies the language of the output text. The target language must be - one of the supported languages included - in the translation scope. For example, use to=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to=de&to=it to translate to German and Italian. Required. - :paramtype to_language: list[str] :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: list of TranslatedTextItem - :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ @distributed_trace + @api_version_validation( + method_added_on="2025-10-01-preview", + params_added_on={"2025-10-01-preview": ["client_trace_id", "api_version", "content_type", "accept"]}, + api_versions_list=["2025-10-01-preview"], + ) def translate( self, - body: Union[List[_models.InputTextItem], IO[bytes]], + body: Union[_models.TranslateBody, JSON, IO[bytes]], *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, **kwargs: Any - ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long + ) -> _models.TranslationResult: """Translate Text. Translate Text. - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] - :keyword to_language: Specifies the language of the output text. The target language must be - one of the supported languages included - in the translation scope. For example, use to=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to=de&to=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :param body: Defines the content of the request. Is one of the following types: TranslateBody, + JSON, IO[bytes] Required. + :type body: ~azure.ai.translation.text.models.TranslateBody or JSON or IO[bytes] :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool - :return: list of TranslatedTextItem - :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -977,7 +369,7 @@ def translate( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.TranslatedTextItem]] = kwargs.pop("cls", None) + cls: ClsType[_models.TranslationResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -987,19 +379,7 @@ def translate( _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore _request = build_text_translation_translate_request( - to_language=to_language, client_trace_id=client_trace_id, - from_language=from_language, - text_type=text_type, - category=category, - profanity_action=profanity_action, - profanity_marker=profanity_marker, - include_alignment=include_alignment, - include_sentence_length=include_sentence_length, - suggested_from=suggested_from, - from_script=from_script, - to_script=to_script, - allow_fallback=allow_fallback, content_type=content_type, api_version=self._config.api_version, content=_content, @@ -1020,9 +400,15 @@ def translate( if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) response_headers = {} @@ -1033,7 +419,7 @@ def translate( if _stream: deserialized = response.iter_bytes() else: - deserialized = _deserialize(List[_models.TranslatedTextItem], response.json()) + deserialized = _deserialize(_models.TranslationResult, response.json()) if cls: return cls(pipeline_response, deserialized, response_headers) # type: ignore @@ -1043,7 +429,7 @@ def translate( @overload def transliterate( self, - body: List[_models.InputTextItem], + body: _models.TransliterateBody, *, language: str, from_script: str, @@ -1051,13 +437,13 @@ def transliterate( client_trace_id: Optional[str] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TransliteratedText]: + ) -> _models.TransliterateResult: """Transliterate Text. Transliterate Text. :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] + :type body: ~azure.ai.translation.text.models.TransliterateBody :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -1076,35 +462,15 @@ def transliterate( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: list of TransliteratedText - :rtype: list[~azure.ai.translation.text.models.TransliteratedText] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ @overload def transliterate( self, - body: IO[bytes], + body: JSON, *, language: str, from_script: str, @@ -1112,13 +478,13 @@ def transliterate( client_trace_id: Optional[str] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TransliteratedText]: + ) -> _models.TransliterateResult: """Transliterate Text. Transliterate Text. :param body: Defines the content of the request. Required. - :type body: IO[bytes] + :type body: JSON :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -1134,45 +500,32 @@ def transliterate( :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: list of TransliteratedText - :rtype: list[~azure.ai.translation.text.models.TransliteratedText] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ - @distributed_trace + @overload def transliterate( self, - body: Union[List[_models.InputTextItem], IO[bytes]], + body: IO[bytes], *, language: str, from_script: str, to_script: str, client_trace_id: Optional[str] = None, + content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TransliteratedText]: + ) -> _models.TransliterateResult: """Transliterate Text. Transliterate Text. - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] + :param body: Defines the content of the request. Required. + :type body: IO[bytes] :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -1188,951 +541,67 @@ def transliterate( :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :return: list of TransliteratedText - :rtype: list[~azure.ai.translation.text.models.TransliteratedText] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] - """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = kwargs.pop("params", {}) or {} - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.TransliteratedText]] = kwargs.pop("cls", None) - - content_type = content_type or "application/json" - _content = None - if isinstance(body, (IOBase, bytes)): - _content = body - else: - _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - - _request = build_text_translation_transliterate_request( - language=language, - from_script=from_script, - to_script=to_script, - client_trace_id=client_trace_id, - content_type=content_type, - api_version=self._config.api_version, - content=_content, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), - } - _request.url = self._client.format_url(_request.url, **path_format_arguments) - - _stream = kwargs.pop("stream", False) - pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - _request, stream=_stream, **kwargs - ) - - response = pipeline_response.http_response - - if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) - raise HttpResponseError(response=response, model=error) - - response_headers = {} - response_headers["X-RequestId"] = self._deserialize("str", response.headers.get("X-RequestId")) - - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(List[_models.TransliteratedText], response.json()) - - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore - - @overload - def find_sentence_boundaries( - self, - body: List[_models.InputTextItem], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - @overload - def find_sentence_boundaries( - self, - body: IO[bytes], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] """ @distributed_trace - def find_sentence_boundaries( + @api_version_validation( + method_added_on="2025-10-01-preview", + params_added_on={ + "2025-10-01-preview": [ + "client_trace_id", + "language", + "from_script", + "to_script", + "api_version", + "content_type", + "accept", + ] + }, + api_versions_list=["2025-10-01-preview"], + ) + def transliterate( self, - body: Union[List[_models.InputTextItem], IO[bytes]], + body: Union[_models.TransliterateBody, JSON, IO[bytes]], *, + language: str, + from_script: str, + to_script: str, client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. + ) -> _models.TransliterateResult: + """Transliterate Text. - Find Sentence Boundaries. + Transliterate Text. - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. + :param body: Defines the content of the request. Is one of the following types: + TransliterateBody, JSON, IO[bytes] Required. + :type body: ~azure.ai.translation.text.models.TransliterateBody or JSON or IO[bytes] + :keyword language: Specifies the language of the text to convert from one script to another. + Possible languages are listed in the transliteration scope obtained by querying the service + for its supported languages. Required. :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = kwargs.pop("params", {}) or {} - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.BreakSentenceItem]] = kwargs.pop("cls", None) - - content_type = content_type or "application/json" - _content = None - if isinstance(body, (IOBase, bytes)): - _content = body - else: - _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - - _request = build_text_translation_find_sentence_boundaries_request( - client_trace_id=client_trace_id, - language=language, - script=script, - content_type=content_type, - api_version=self._config.api_version, - content=_content, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), - } - _request.url = self._client.format_url(_request.url, **path_format_arguments) - - _stream = kwargs.pop("stream", False) - pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - _request, stream=_stream, **kwargs - ) - - response = pipeline_response.http_response - - if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) - raise HttpResponseError(response=response, model=error) - - response_headers = {} - response_headers["X-RequestId"] = self._deserialize("str", response.headers.get("X-RequestId")) - - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(List[_models.BreakSentenceItem], response.json()) - - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore - - @overload - def lookup_dictionary_entries( - self, - body: List[_models.InputTextItem], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "confidence": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @overload - def lookup_dictionary_entries( - self, - body: IO[bytes], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "confidence": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @distributed_trace - def lookup_dictionary_entries( - self, - body: Union[List[_models.InputTextItem], IO[bytes]], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "confidence": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = kwargs.pop("params", {}) or {} - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.DictionaryLookupItem]] = kwargs.pop("cls", None) - - content_type = content_type or "application/json" - _content = None - if isinstance(body, (IOBase, bytes)): - _content = body - else: - _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - - _request = build_text_translation_lookup_dictionary_entries_request( - from_language=from_language, - to_language=to_language, - client_trace_id=client_trace_id, - content_type=content_type, - api_version=self._config.api_version, - content=_content, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), - } - _request.url = self._client.format_url(_request.url, **path_format_arguments) - - _stream = kwargs.pop("stream", False) - pipeline_response: PipelineResponse = self._client._pipeline.run( # pylint: disable=protected-access - _request, stream=_stream, **kwargs - ) - - response = pipeline_response.http_response - - if response.status_code not in [200]: - if _stream: - response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) - raise HttpResponseError(response=response, model=error) - - response_headers = {} - response_headers["X-RequestId"] = self._deserialize("str", response.headers.get("X-RequestId")) - - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(List[_models.DictionaryLookupItem], response.json()) - - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore - - @overload - def lookup_dictionary_examples( - self, - body: List[_models.DictionaryExampleTextItem], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryExampleItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Examples. - - Lookup Dictionary Examples. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.DictionaryExampleTextItem] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryExampleItem - :rtype: list[~azure.ai.translation.text.models.DictionaryExampleItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str", # Text to translate. Required. - "translation": "str" # A string specifying the translated text - previously returned by the Dictionary lookup operation. This should be the - value from the normalizedTarget field in the translations list of the - Dictionary lookup response. The service will return examples for the - specific source-target word-pair. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "examples": [ - { - "sourcePrefix": "str", # The string to concatenate - before the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceSuffix": "str", # The string to concatenate - after the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceTerm": "str", # A string equal to the actual - term looked up. The string is added with sourcePrefix and - sourceSuffix to form the complete example. Its value is separated so - it can be marked in a user interface, e.g., by bolding it. Required. - "targetPrefix": "str", # A string similar to - sourcePrefix but for the target. Required. - "targetSuffix": "str", # A string similar to - sourceSuffix but for the target. Required. - "targetTerm": "str" # A string similar to sourceTerm - but for the target. Required. - } - ], - "normalizedSource": "str", # A string giving the normalized form of - the source term. Generally, this should be identical to the value of the Text - field at the matching list index in the body of the request. Required. - "normalizedTarget": "str" # A string giving the normalized form of - the target term. Generally, this should be identical to the value of the - Translation field at the matching list index in the body of the request. - Required. - } - ] - """ - - @overload - def lookup_dictionary_examples( - self, - body: IO[bytes], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryExampleItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Examples. - - Lookup Dictionary Examples. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryExampleItem - :rtype: list[~azure.ai.translation.text.models.DictionaryExampleItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "examples": [ - { - "sourcePrefix": "str", # The string to concatenate - before the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceSuffix": "str", # The string to concatenate - after the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceTerm": "str", # A string equal to the actual - term looked up. The string is added with sourcePrefix and - sourceSuffix to form the complete example. Its value is separated so - it can be marked in a user interface, e.g., by bolding it. Required. - "targetPrefix": "str", # A string similar to - sourcePrefix but for the target. Required. - "targetSuffix": "str", # A string similar to - sourceSuffix but for the target. Required. - "targetTerm": "str" # A string similar to sourceTerm - but for the target. Required. - } - ], - "normalizedSource": "str", # A string giving the normalized form of - the source term. Generally, this should be identical to the value of the Text - field at the matching list index in the body of the request. Required. - "normalizedTarget": "str" # A string giving the normalized form of - the target term. Generally, this should be identical to the value of the - Translation field at the matching list index in the body of the request. - Required. - } - ] - """ - - @distributed_trace - def lookup_dictionary_examples( - self, - body: Union[List[_models.DictionaryExampleTextItem], IO[bytes]], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - **kwargs: Any - ) -> List[_models.DictionaryExampleItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Examples. - - Lookup Dictionary Examples. - - :param body: Defines the content of the request. Is either a [DictionaryExampleTextItem] type - or a IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.DictionaryExampleTextItem] or IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str + :keyword from_script: Specifies the script used by the input text. Look up supported languages + using the transliteration scope, + to find input scripts available for the selected language. Required. + :paramtype from_script: str + :keyword to_script: Specifies the output script. Look up supported languages using the + transliteration scope, to find output + scripts available for the selected combination of input language and input script. Required. + :paramtype to_script: str :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :return: list of DictionaryExampleItem - :rtype: list[~azure.ai.translation.text.models.DictionaryExampleItem] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "examples": [ - { - "sourcePrefix": "str", # The string to concatenate - before the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceSuffix": "str", # The string to concatenate - after the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceTerm": "str", # A string equal to the actual - term looked up. The string is added with sourcePrefix and - sourceSuffix to form the complete example. Its value is separated so - it can be marked in a user interface, e.g., by bolding it. Required. - "targetPrefix": "str", # A string similar to - sourcePrefix but for the target. Required. - "targetSuffix": "str", # A string similar to - sourceSuffix but for the target. Required. - "targetTerm": "str" # A string similar to sourceTerm - but for the target. Required. - } - ], - "normalizedSource": "str", # A string giving the normalized form of - the source term. Generally, this should be identical to the value of the Text - field at the matching list index in the body of the request. Required. - "normalizedTarget": "str" # A string giving the normalized form of - the target term. Generally, this should be identical to the value of the - Translation field at the matching list index in the body of the request. - Required. - } - ] """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -2144,7 +613,7 @@ def lookup_dictionary_examples( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.DictionaryExampleItem]] = kwargs.pop("cls", None) + cls: ClsType[_models.TransliterateResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -2153,9 +622,10 @@ def lookup_dictionary_examples( else: _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - _request = build_text_translation_lookup_dictionary_examples_request( - from_language=from_language, - to_language=to_language, + _request = build_text_translation_transliterate_request( + language=language, + from_script=from_script, + to_script=to_script, client_trace_id=client_trace_id, content_type=content_type, api_version=self._config.api_version, @@ -2177,9 +647,15 @@ def lookup_dictionary_examples( if response.status_code not in [200]: if _stream: - response.read() # Load the body in memory and close the socket + try: + response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) response_headers = {} @@ -2188,7 +664,7 @@ def lookup_dictionary_examples( if _stream: deserialized = response.iter_bytes() else: - deserialized = _deserialize(List[_models.DictionaryExampleItem], response.json()) + deserialized = _deserialize(_models.TransliterateResult, response.json()) if cls: return cls(pipeline_response, deserialized, response_headers) # type: ignore diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_patch.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_patch.py index 7506475e6478..57531a4598cd 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_patch.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_patch.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # ------------------------------------ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. @@ -8,578 +9,222 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from collections.abc import MutableMapping from typing import Any, cast, IO, List, Optional, overload, Union +from azure.core import MatchConditions, PipelineClient + +JSON = MutableMapping[str, Any] +from azure.core.rest import HttpRequest, HttpResponse from .. import models as _models -from ._operations import TextTranslationClientOperationsMixin as TextTranslationClientOperationsMixinGenerated +from .._configuration import TextTranslationClientConfiguration +from .._utils.utils import ClientMixinABC +from ._operations import _TextTranslationClientOperationsMixin as _TextTranslationClientOperationsMixinGenerated + + +class _TextTranslationClientOperationsMixin( + ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], TextTranslationClientConfiguration] +): + """Mixin class that delegates to the generated operations class while providing custom method signatures.""" + + def _get_generated_operations(self) -> _TextTranslationClientOperationsMixinGenerated: + """Get an instance of the generated operations mixin. + + This creates a wrapper object that shares the same _client, _config, _serialize, and _deserialize + attributes with self, allowing the generated operations to work correctly. + """ + if not hasattr(self, "_generated_ops_cache"): + # Create a lightweight wrapper that shares attributes with self + class GeneratedOpsWrapper(_TextTranslationClientOperationsMixinGenerated): + pass + + wrapper = GeneratedOpsWrapper.__new__(GeneratedOpsWrapper) + # Share the client infrastructure from self + wrapper._client = self._client # type: ignore + wrapper._config = self._config # type: ignore + wrapper._serialize = self._serialize # type: ignore + wrapper._deserialize = self._deserialize # type: ignore + self._generated_ops_cache = wrapper # type: ignore + return self._generated_ops_cache # type: ignore + + def get_supported_languages( + self, + *, + client_trace_id: Optional[str] = None, + scope: Optional[str] = None, + accept_language: Optional[str] = None, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.GetSupportedLanguagesResult: + """Gets the set of languages currently supported by other operations of the Translator. + + Gets the set of languages currently supported by other operations of the Translator. + :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default + value is None. + :paramtype client_trace_id: str + :keyword scope: A comma-separated list of names defining the group of languages to return. + Allowed group names are: ``translation``, ``transliteration`` and ``dictionary``. + If no scope is given, then all groups are returned, which is equivalent to passing + ``scope=translation,transliteration,dictionary``. To decide which set of supported languages + is appropriate for your scenario, see the description of the `response object + <#response-body>`_. Default value is None. + :paramtype scope: str + :keyword accept_language: The language to use for user interface strings. Some of the fields in + the response are names of languages or + names of regions. Use this parameter to define the language in which these names are returned. + The language is specified by providing a well-formed BCP 47 language tag. For instance, use + the value ``fr`` + to request names in French or use the value ``zh-Hant`` to request names in Chinese + Traditional. + Names are provided in the English language when a target language is not specified or when + localization + is not available. Default value is None. + :paramtype accept_language: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: GetSupportedLanguagesResult. The GetSupportedLanguagesResult is compatible with + MutableMapping + :rtype: ~azure.ai.translation.text.models.GetSupportedLanguagesResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + return self._get_generated_operations().get_supported_languages( + client_trace_id=client_trace_id, + scope=scope, + accept_language=accept_language, + etag=etag, + match_condition=match_condition, + **kwargs + ) -class TextTranslationClientOperationsMixin(TextTranslationClientOperationsMixinGenerated): - @overload + @overload # type: ignore[override] def translate( self, body: List[str], *, to_language: List[str], - client_trace_id: Optional[str] = None, from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, + client_trace_id: Optional[str] = None, content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long """Translate Text. - Translate Text. + Translates texts to the specified target languages. - :param body: Defines the content of the request. Required. + :param body: List of text strings to translate. Required. :type body: list[str] - :keyword to_language: Specifies the language of the output text. The target language must be one of the - supported languages included - in the translation scope. For example, use to_language=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to_language=de&to_language=it to translate to German and Italian. Required. + :keyword to_language: List of target languages of the translation outputs. The target language(s) + must be one of the supported languages included in the translation scope. Required. :paramtype to_language: list[str] + :keyword from_language: Language of the input text. If not specified, automatic language detection + is applied to determine the source language. Default value is None. + :paramtype from_language: str :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TranslatedTextItem :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - str" # Text to translate. Required. - ] - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ - @overload + @overload # type: ignore[override] def translate( self, - body: List[_models.InputTextItem], + body: List[_models.TranslateInputItem], *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long - """Translate Text. + """Translate text. - Translate Text. + Translates a list of input items with specified configurations. - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword to_language: Specifies the language of the output text. The target language must be one of the - supported languages included - in the translation scope. For example, use to_language=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to_language=de&to_language=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :param body: List of TranslateInputItem objects containing text and configurations for translation. Required. + :type body: list[~azure.ai.translation.text.models.TranslateInputItem] :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TranslatedTextItem :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ - @overload + @overload # type: ignore[override] def translate( self, - body: IO[bytes], + body: JSON, *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long - """Translate Text. + """Translate text. - Translate Text. + Translates text using a JSON body. - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword to_language: Specifies the language of the output text. The target language must be one of the - supported languages included - in the translation scope. For example, use to_language=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to_language=de&to_language=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :param body: JSON body containing translation request. Required. + :type body: JSON :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TranslatedTextItem :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ def translate( # pyright: ignore[reportIncompatibleMethodOverride] self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], + body: Union[List[str], List[_models.TranslateInputItem], JSON, IO[bytes]], *, - to_language: List[str], - client_trace_id: Optional[str] = None, + to_language: Optional[List[str]] = None, from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, + client_trace_id: Optional[str] = None, + content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items + request_body: Union[_models.TranslateBody, JSON, IO[bytes]] + + if isinstance(body, list): + if all(isinstance(item, _models.TranslateInputItem) for item in body): + # Handle List[TranslateInputItem] + request_body = _models.TranslateBody(inputs=cast(List[_models.TranslateInputItem], body)) + elif all(isinstance(item, str) for item in body): + # Handle List[str] - convert to TranslateInputItem with targets + targets = [_models.TranslationTarget(language=lang) for lang in (to_language or [])] + inputs = [ + _models.TranslateInputItem(text=cast(str, text), targets=targets, language=from_language) + for text in cast(List[str], body) + ] + request_body = _models.TranslateBody(inputs=inputs) + else: + raise ValueError( + "Invalid body type: list must contain either all strings or all TranslateInputItem objects" + ) else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) + # Handle JSON (dict/MutableMapping) or IO[bytes] + request_body = body # type: ignore - return super().translate( - body=request_body, - to_language=to_language, - client_trace_id=client_trace_id, - from_language=from_language, - text_type=text_type, - category=category, - profanity_action=profanity_action, - profanity_marker=profanity_marker, - include_alignment=include_alignment, - include_sentence_length=include_sentence_length, - suggested_from=suggested_from, - from_script=from_script, - to_script=to_script, - allow_fallback=allow_fallback, - **kwargs + result = self._get_generated_operations().translate( + body=request_body, content_type=content_type, client_trace_id=client_trace_id, **kwargs ) - @overload + return result.value + + @overload # type: ignore[override] def transliterate( self, body: List[str], @@ -618,29 +263,9 @@ def transliterate( :return: list of TransliteratedText :rtype: list[~azure.ai.translation.text.models.TransliteratedText] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ - @overload + @overload # type: ignore[override] def transliterate( self, body: List[_models.InputTextItem], @@ -679,32 +304,12 @@ def transliterate( :return: list of TransliteratedText :rtype: list[~azure.ai.translation.text.models.TransliteratedText] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ - @overload + @overload # type: ignore[override] def transliterate( self, - body: IO[bytes], + body: JSON, *, language: str, from_script: str, @@ -715,10 +320,10 @@ def transliterate( ) -> List[_models.TransliteratedText]: """Transliterate Text. - Transliterate Text. + Transliterates text using a JSON body. - :param body: Defines the content of the request. Required. - :type body: IO[bytes] + :param body: JSON body containing transliteration request. Required. + :type body: JSON :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -734,633 +339,51 @@ def transliterate( :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TransliteratedText :rtype: list[~azure.ai.translation.text.models.TransliteratedText] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ def transliterate( # pyright: ignore[reportIncompatibleMethodOverride] self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], + body: Union[List[str], List[_models.InputTextItem], JSON, IO[bytes]], *, language: str, from_script: str, to_script: str, client_trace_id: Optional[str] = None, + content_type: str = "application/json", **kwargs: Any ) -> List[_models.TransliteratedText]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items + request_body: Union[_models.TransliterateBody, JSON, IO[bytes]] + if isinstance(body, list): + inputs: List[_models.InputTextItem] = [] + if all(isinstance(item, _models.InputTextItem) for item in body): + inputs = cast(List[_models.InputTextItem], body) + elif all(isinstance(item, str) for item in body): + for text in body: + inputs.append(_models.InputTextItem(text=cast(str, text))) + request_body = _models.TransliterateBody(inputs=inputs) else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) + # Handle JSON (dict) or IO[bytes] + request_body = body # type: ignore - return super().transliterate( + result = self._get_generated_operations().transliterate( body=request_body, language=language, from_script=from_script, to_script=to_script, + content_type=content_type, client_trace_id=client_trace_id, - **kwargs - ) - - @overload - def find_sentence_boundaries( - self, - body: List[str], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: list[str] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - @overload - def find_sentence_boundaries( - self, - body: List[_models.InputTextItem], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - @overload - def find_sentence_boundaries( - self, - body: IO[bytes], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - def find_sentence_boundaries( # pyright: ignore[reportIncompatibleMethodOverride] - self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items - - else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) - - return super().find_sentence_boundaries( - body=request_body, language=language, script=script, client_trace_id=client_trace_id, **kwargs - ) - - @overload - def lookup_dictionary_entries( - self, - body: List[str], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: list[str] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "score": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @overload - def lookup_dictionary_entries( - self, - body: List[_models.InputTextItem], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "score": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @overload - def lookup_dictionary_entries( - self, - body: IO[bytes], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "score": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - def lookup_dictionary_entries( # pyright: ignore[reportIncompatibleMethodOverride] - self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items - else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) - - return super().lookup_dictionary_entries( - body=request_body, - from_language=from_language, - to_language=to_language, - client_trace_id=client_trace_id, - **kwargs ) + return result.value __all__: List[str] = [ - "TextTranslationClientOperationsMixin" + "_TextTranslationClientOperationsMixin" ] # Add all objects you want publicly available to users at this package level diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py index 104e2adda4ba..9c58006b2016 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py @@ -78,6 +78,7 @@ def get_translation_endpoint(endpoint, api_version): return translator_endpoint + def is_cognitive_services_scope(audience: str) -> bool: if "microsofttranslator" in audience: return True @@ -114,9 +115,7 @@ def set_authentication_policy(credential, kwargs): if not is_cognitive_services_scope(scope): scope = scope.rstrip("/").rstrip(DEFAULT_SCOPE) + DEFAULT_SCOPE - kwargs["authentication_policy"] = BearerTokenCredentialPolicy( - credential, scope - ) + kwargs["authentication_policy"] = BearerTokenCredentialPolicy(credential, scope) class TextTranslationClient(ServiceClientGenerated): @@ -159,7 +158,7 @@ class TextTranslationClient(ServiceClientGenerated): :keyword str region: Used for National Clouds. :keyword str resource_id: Used with both a TokenCredential combined with a region. :keyword str audience: Scopes of the credentials. - :keyword str api_version: Default value is "3.0". Note that overriding this default value may + :keyword str api_version: Default value is "2025-10-01-preview". Note that overriding this default value may result in unsupported behavior. """ @@ -172,7 +171,7 @@ def __init__( endpoint: Optional[str] = None, resource_id: Optional[str] = None, audience: Optional[str] = None, - api_version: str = "3.0", + api_version: str = "2025-10-01-preview", **kwargs ): ... @@ -183,15 +182,15 @@ def __init__( credential: AzureKeyCredential, region: Optional[str] = None, endpoint: Optional[str] = None, - api_version: str = "3.0", + api_version: str = "2025-10-01-preview", **kwargs ): ... @overload - def __init__(self, *, endpoint: str, api_version: str = "3.0", **kwargs): ... + def __init__(self, *, endpoint: str, api_version: str = "2025-10-01-preview", **kwargs): ... def __init__(self, **kwargs): - api_version = kwargs.get("api_version", "3.0") + api_version = kwargs.get("api_version", "2025-10-01-preview") set_authentication_policy(kwargs.get("credential"), kwargs) translation_endpoint = get_translation_endpoint( kwargs.pop("endpoint", "https://api.cognitive.microsofttranslator.com"), api_version diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_serialization.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_serialization.py index 2f781d740827..70e3b54bc97a 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_serialization.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_serialization.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines # -------------------------------------------------------------------------- # # Copyright (c) Microsoft Corporation. All rights reserved. @@ -1583,14 +1584,22 @@ def _instantiate_model(self, response, attrs, additional_properties=None): if callable(response): subtype = getattr(response, "_subtype_map", {}) try: - readonly = [k for k, v in response._validation.items() if v.get("readonly")] - const = [k for k, v in response._validation.items() if v.get("constant")] + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} response_obj = response(**kwargs) for attr in readonly: setattr(response_obj, attr, attrs.get(attr)) if additional_properties: - response_obj.additional_properties = additional_properties + response_obj.additional_properties = additional_properties # type: ignore return response_obj except TypeError as err: msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/__init__.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/__init__.py new file mode 100644 index 000000000000..8026245c2abc --- /dev/null +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/__init__.py @@ -0,0 +1,6 @@ +# -------------------------------------------------------------------------- +# 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. +# -------------------------------------------------------------------------- diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/model_base.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/model_base.py new file mode 100644 index 000000000000..12926fa98dcf --- /dev/null +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/model_base.py @@ -0,0 +1,1237 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# 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. +# -------------------------------------------------------------------------- +# pylint: disable=protected-access, broad-except + +import copy +import calendar +import decimal +import functools +import sys +import logging +import base64 +import re +import typing +import enum +import email.utils +from datetime import datetime, date, time, timedelta, timezone +from json import JSONEncoder +import xml.etree.ElementTree as ET +from collections.abc import MutableMapping +from typing_extensions import Self +import isodate +from azure.core.exceptions import DeserializationError +from azure.core import CaseInsensitiveEnumMeta +from azure.core.pipeline import PipelineResponse +from azure.core.serialization import _Null +from azure.core.rest import HttpResponse + +_LOGGER = logging.getLogger(__name__) + +__all__ = ["SdkJSONEncoder", "Model", "rest_field", "rest_discriminator"] + +TZ_UTC = timezone.utc +_T = typing.TypeVar("_T") + + +def _timedelta_as_isostr(td: timedelta) -> str: + """Converts a datetime.timedelta object into an ISO 8601 formatted string, e.g. 'P4DT12H30M05S' + + Function adapted from the Tin Can Python project: https://github.com/RusticiSoftware/TinCanPython + + :param timedelta td: The timedelta to convert + :rtype: str + :return: ISO8601 version of this timedelta + """ + + # Split seconds to larger units + seconds = td.total_seconds() + minutes, seconds = divmod(seconds, 60) + hours, minutes = divmod(minutes, 60) + days, hours = divmod(hours, 24) + + days, hours, minutes = list(map(int, (days, hours, minutes))) + seconds = round(seconds, 6) + + # Build date + date_str = "" + if days: + date_str = "%sD" % days + + if hours or minutes or seconds: + # Build time + time_str = "T" + + # Hours + bigger_exists = date_str or hours + if bigger_exists: + time_str += "{:02}H".format(hours) + + # Minutes + bigger_exists = bigger_exists or minutes + if bigger_exists: + time_str += "{:02}M".format(minutes) + + # Seconds + try: + if seconds.is_integer(): + seconds_string = "{:02}".format(int(seconds)) + else: + # 9 chars long w/ leading 0, 6 digits after decimal + seconds_string = "%09.6f" % seconds + # Remove trailing zeros + seconds_string = seconds_string.rstrip("0") + except AttributeError: # int.is_integer() raises + seconds_string = "{:02}".format(seconds) + + time_str += "{}S".format(seconds_string) + else: + time_str = "" + + return "P" + date_str + time_str + + +def _serialize_bytes(o, format: typing.Optional[str] = None) -> str: + encoded = base64.b64encode(o).decode() + if format == "base64url": + return encoded.strip("=").replace("+", "-").replace("/", "_") + return encoded + + +def _serialize_datetime(o, format: typing.Optional[str] = None): + if hasattr(o, "year") and hasattr(o, "hour"): + if format == "rfc7231": + return email.utils.format_datetime(o, usegmt=True) + if format == "unix-timestamp": + return int(calendar.timegm(o.utctimetuple())) + + # astimezone() fails for naive times in Python 2.7, so make make sure o is aware (tzinfo is set) + if not o.tzinfo: + iso_formatted = o.replace(tzinfo=TZ_UTC).isoformat() + else: + iso_formatted = o.astimezone(TZ_UTC).isoformat() + # Replace the trailing "+00:00" UTC offset with "Z" (RFC 3339: https://www.ietf.org/rfc/rfc3339.txt) + return iso_formatted.replace("+00:00", "Z") + # Next try datetime.date or datetime.time + return o.isoformat() + + +def _is_readonly(p): + try: + return p._visibility == ["read"] + except AttributeError: + return False + + +class SdkJSONEncoder(JSONEncoder): + """A JSON encoder that's capable of serializing datetime objects and bytes.""" + + def __init__(self, *args, exclude_readonly: bool = False, format: typing.Optional[str] = None, **kwargs): + super().__init__(*args, **kwargs) + self.exclude_readonly = exclude_readonly + self.format = format + + def default(self, o): # pylint: disable=too-many-return-statements + if _is_model(o): + if self.exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + return {k: v for k, v in o.items() if k not in readonly_props} + return dict(o.items()) + try: + return super(SdkJSONEncoder, self).default(o) + except TypeError: + if isinstance(o, _Null): + return None + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, self.format) + try: + # First try datetime.datetime + return _serialize_datetime(o, self.format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return super(SdkJSONEncoder, self).default(o) + + +_VALID_DATE = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}" + r"\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") +_VALID_RFC7231 = re.compile( + r"(Mon|Tue|Wed|Thu|Fri|Sat|Sun),\s\d{2}\s" + r"(Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec)\s\d{4}\s\d{2}:\d{2}:\d{2}\sGMT" +) + + +def _deserialize_datetime(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + attr = attr.upper() + match = _VALID_DATE.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + return date_obj + + +def _deserialize_datetime_rfc7231(attr: typing.Union[str, datetime]) -> datetime: + """Deserialize RFC7231 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + match = _VALID_RFC7231.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + return email.utils.parsedate_to_datetime(attr) + + +def _deserialize_datetime_unix_timestamp(attr: typing.Union[float, datetime]) -> datetime: + """Deserialize unix timestamp into Datetime object. + + :param str attr: response string to be deserialized. + :rtype: ~datetime.datetime + :returns: The datetime object from that input + """ + if isinstance(attr, datetime): + # i'm already deserialized + return attr + return datetime.fromtimestamp(attr, TZ_UTC) + + +def _deserialize_date(attr: typing.Union[str, date]) -> date: + """Deserialize ISO-8601 formatted string into Date object. + :param str attr: response string to be deserialized. + :rtype: date + :returns: The date object from that input + """ + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + if isinstance(attr, date): + return attr + return isodate.parse_date(attr, defaultmonth=None, defaultday=None) # type: ignore + + +def _deserialize_time(attr: typing.Union[str, time]) -> time: + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :rtype: datetime.time + :returns: The time object from that input + """ + if isinstance(attr, time): + return attr + return isodate.parse_time(attr) + + +def _deserialize_bytes(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + return bytes(base64.b64decode(attr)) + + +def _deserialize_bytes_base64(attr): + if isinstance(attr, (bytes, bytearray)): + return attr + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return bytes(base64.b64decode(encoded)) + + +def _deserialize_duration(attr): + if isinstance(attr, timedelta): + return attr + return isodate.parse_duration(attr) + + +def _deserialize_decimal(attr): + if isinstance(attr, decimal.Decimal): + return attr + return decimal.Decimal(str(attr)) + + +def _deserialize_int_as_str(attr): + if isinstance(attr, int): + return attr + return int(attr) + + +_DESERIALIZE_MAPPING = { + datetime: _deserialize_datetime, + date: _deserialize_date, + time: _deserialize_time, + bytes: _deserialize_bytes, + bytearray: _deserialize_bytes, + timedelta: _deserialize_duration, + typing.Any: lambda x: x, + decimal.Decimal: _deserialize_decimal, +} + +_DESERIALIZE_MAPPING_WITHFORMAT = { + "rfc3339": _deserialize_datetime, + "rfc7231": _deserialize_datetime_rfc7231, + "unix-timestamp": _deserialize_datetime_unix_timestamp, + "base64": _deserialize_bytes, + "base64url": _deserialize_bytes_base64, +} + + +def get_deserializer(annotation: typing.Any, rf: typing.Optional["_RestField"] = None): + if annotation is int and rf and rf._format == "str": + return _deserialize_int_as_str + if rf and rf._format: + return _DESERIALIZE_MAPPING_WITHFORMAT.get(rf._format) + return _DESERIALIZE_MAPPING.get(annotation) # pyright: ignore + + +def _get_type_alias_type(module_name: str, alias_name: str): + types = { + k: v + for k, v in sys.modules[module_name].__dict__.items() + if isinstance(v, typing._GenericAlias) # type: ignore + } + if alias_name not in types: + return alias_name + return types[alias_name] + + +def _get_model(module_name: str, model_name: str): + models = {k: v for k, v in sys.modules[module_name].__dict__.items() if isinstance(v, type)} + module_end = module_name.rsplit(".", 1)[0] + models.update({k: v for k, v in sys.modules[module_end].__dict__.items() if isinstance(v, type)}) + if isinstance(model_name, str): + model_name = model_name.split(".")[-1] + if model_name not in models: + return model_name + return models[model_name] + + +_UNSET = object() + + +class _MyMutableMapping(MutableMapping[str, typing.Any]): + def __init__(self, data: dict[str, typing.Any]) -> None: + self._data = data + + def __contains__(self, key: typing.Any) -> bool: + return key in self._data + + def __getitem__(self, key: str) -> typing.Any: + return self._data.__getitem__(key) + + def __setitem__(self, key: str, value: typing.Any) -> None: + self._data.__setitem__(key, value) + + def __delitem__(self, key: str) -> None: + self._data.__delitem__(key) + + def __iter__(self) -> typing.Iterator[typing.Any]: + return self._data.__iter__() + + def __len__(self) -> int: + return self._data.__len__() + + def __ne__(self, other: typing.Any) -> bool: + return not self.__eq__(other) + + def keys(self) -> typing.KeysView[str]: + """ + :returns: a set-like object providing a view on D's keys + :rtype: ~typing.KeysView + """ + return self._data.keys() + + def values(self) -> typing.ValuesView[typing.Any]: + """ + :returns: an object providing a view on D's values + :rtype: ~typing.ValuesView + """ + return self._data.values() + + def items(self) -> typing.ItemsView[str, typing.Any]: + """ + :returns: set-like object providing a view on D's items + :rtype: ~typing.ItemsView + """ + return self._data.items() + + def get(self, key: str, default: typing.Any = None) -> typing.Any: + """ + Get the value for key if key is in the dictionary, else default. + :param str key: The key to look up. + :param any default: The value to return if key is not in the dictionary. Defaults to None + :returns: D[k] if k in D, else d. + :rtype: any + """ + try: + return self[key] + except KeyError: + return default + + @typing.overload + def pop(self, key: str) -> typing.Any: ... # pylint: disable=arguments-differ + + @typing.overload + def pop(self, key: str, default: _T) -> _T: ... # pylint: disable=signature-differs + + @typing.overload + def pop(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def pop(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Removes specified key and return the corresponding value. + :param str key: The key to pop. + :param any default: The value to return if key is not in the dictionary + :returns: The value corresponding to the key. + :rtype: any + :raises KeyError: If key is not found and default is not given. + """ + if default is _UNSET: + return self._data.pop(key) + return self._data.pop(key, default) + + def popitem(self) -> tuple[str, typing.Any]: + """ + Removes and returns some (key, value) pair + :returns: The (key, value) pair. + :rtype: tuple + :raises KeyError: if D is empty. + """ + return self._data.popitem() + + def clear(self) -> None: + """ + Remove all items from D. + """ + self._data.clear() + + def update(self, *args: typing.Any, **kwargs: typing.Any) -> None: # pylint: disable=arguments-differ + """ + Updates D from mapping/iterable E and F. + :param any args: Either a mapping object or an iterable of key-value pairs. + """ + self._data.update(*args, **kwargs) + + @typing.overload + def setdefault(self, key: str, default: None = None) -> None: ... + + @typing.overload + def setdefault(self, key: str, default: typing.Any) -> typing.Any: ... # pylint: disable=signature-differs + + def setdefault(self, key: str, default: typing.Any = _UNSET) -> typing.Any: + """ + Same as calling D.get(k, d), and setting D[k]=d if k not found + :param str key: The key to look up. + :param any default: The value to set if key is not in the dictionary + :returns: D[k] if k in D, else d. + :rtype: any + """ + if default is _UNSET: + return self._data.setdefault(key) + return self._data.setdefault(key, default) + + def __eq__(self, other: typing.Any) -> bool: + try: + other_model = self.__class__(other) + except Exception: + return False + return self._data == other_model._data + + def __repr__(self) -> str: + return str(self._data) + + +def _is_model(obj: typing.Any) -> bool: + return getattr(obj, "_is_model", False) + + +def _serialize(o, format: typing.Optional[str] = None): # pylint: disable=too-many-return-statements + if isinstance(o, list): + return [_serialize(x, format) for x in o] + if isinstance(o, dict): + return {k: _serialize(v, format) for k, v in o.items()} + if isinstance(o, set): + return {_serialize(x, format) for x in o} + if isinstance(o, tuple): + return tuple(_serialize(x, format) for x in o) + if isinstance(o, (bytes, bytearray)): + return _serialize_bytes(o, format) + if isinstance(o, decimal.Decimal): + return float(o) + if isinstance(o, enum.Enum): + return o.value + if isinstance(o, int): + if format == "str": + return str(o) + return o + try: + # First try datetime.datetime + return _serialize_datetime(o, format) + except AttributeError: + pass + # Last, try datetime.timedelta + try: + return _timedelta_as_isostr(o) + except AttributeError: + # This will be raised when it hits value.total_seconds in the method above + pass + return o + + +def _get_rest_field(attr_to_rest_field: dict[str, "_RestField"], rest_name: str) -> typing.Optional["_RestField"]: + try: + return next(rf for rf in attr_to_rest_field.values() if rf._rest_name == rest_name) + except StopIteration: + return None + + +def _create_value(rf: typing.Optional["_RestField"], value: typing.Any) -> typing.Any: + if not rf: + return _serialize(value, None) + if rf._is_multipart_file_input: + return value + if rf._is_model: + return _deserialize(rf._type, value) + if isinstance(value, ET.Element): + value = _deserialize(rf._type, value) + return _serialize(value, rf._format) + + +class Model(_MyMutableMapping): + _is_model = True + # label whether current class's _attr_to_rest_field has been calculated + # could not see _attr_to_rest_field directly because subclass inherits it from parent class + _calculated: set[str] = set() + + def __init__(self, *args: typing.Any, **kwargs: typing.Any) -> None: + class_name = self.__class__.__name__ + if len(args) > 1: + raise TypeError(f"{class_name}.__init__() takes 2 positional arguments but {len(args) + 1} were given") + dict_to_pass = { + rest_field._rest_name: rest_field._default + for rest_field in self._attr_to_rest_field.values() + if rest_field._default is not _UNSET + } + if args: # pylint: disable=too-many-nested-blocks + if isinstance(args[0], ET.Element): + existed_attr_keys = [] + model_meta = getattr(self, "_xml", {}) + + for rf in self._attr_to_rest_field.values(): + prop_meta = getattr(rf, "_xml", {}) + xml_name = prop_meta.get("name", rf._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + # attribute + if prop_meta.get("attribute", False) and args[0].get(xml_name) is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].get(xml_name)) + continue + + # unwrapped element is array + if prop_meta.get("unwrapped", False): + # unwrapped array could either use prop items meta/prop meta + if prop_meta.get("itemsName"): + xml_name = prop_meta.get("itemsName") + xml_ns = prop_meta.get("itemNs") + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + items = args[0].findall(xml_name) # pyright: ignore + if len(items) > 0: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, items) + continue + + # text element is primitive type + if prop_meta.get("text", False): + if args[0].text is not None: + dict_to_pass[rf._rest_name] = _deserialize(rf._type, args[0].text) + continue + + # wrapped element could be normal property or array, it should only have one element + item = args[0].find(xml_name) + if item is not None: + existed_attr_keys.append(xml_name) + dict_to_pass[rf._rest_name] = _deserialize(rf._type, item) + + # rest thing is additional properties + for e in args[0]: + if e.tag not in existed_attr_keys: + dict_to_pass[e.tag] = _convert_element(e) + else: + dict_to_pass.update( + {k: _create_value(_get_rest_field(self._attr_to_rest_field, k), v) for k, v in args[0].items()} + ) + else: + non_attr_kwargs = [k for k in kwargs if k not in self._attr_to_rest_field] + if non_attr_kwargs: + # actual type errors only throw the first wrong keyword arg they see, so following that. + raise TypeError(f"{class_name}.__init__() got an unexpected keyword argument '{non_attr_kwargs[0]}'") + dict_to_pass.update( + { + self._attr_to_rest_field[k]._rest_name: _create_value(self._attr_to_rest_field[k], v) + for k, v in kwargs.items() + if v is not None + } + ) + super().__init__(dict_to_pass) + + def copy(self) -> "Model": + return Model(self.__dict__) + + def __new__(cls, *args: typing.Any, **kwargs: typing.Any) -> Self: + if f"{cls.__module__}.{cls.__qualname__}" not in cls._calculated: + # we know the last nine classes in mro are going to be 'Model', '_MyMutableMapping', 'MutableMapping', + # 'Mapping', 'Collection', 'Sized', 'Iterable', 'Container' and 'object' + mros = cls.__mro__[:-9][::-1] # ignore parents, and reverse the mro order + attr_to_rest_field: dict[str, _RestField] = { # map attribute name to rest_field property + k: v for mro_class in mros for k, v in mro_class.__dict__.items() if k[0] != "_" and hasattr(v, "_type") + } + annotations = { + k: v + for mro_class in mros + if hasattr(mro_class, "__annotations__") + for k, v in mro_class.__annotations__.items() + } + for attr, rf in attr_to_rest_field.items(): + rf._module = cls.__module__ + if not rf._type: + rf._type = rf._get_deserialize_callable_from_annotation(annotations.get(attr, None)) + if not rf._rest_name_input: + rf._rest_name_input = attr + cls._attr_to_rest_field: dict[str, _RestField] = dict(attr_to_rest_field.items()) + cls._calculated.add(f"{cls.__module__}.{cls.__qualname__}") + + return super().__new__(cls) + + def __init_subclass__(cls, discriminator: typing.Optional[str] = None) -> None: + for base in cls.__bases__: + if hasattr(base, "__mapping__"): + base.__mapping__[discriminator or cls.__name__] = cls # type: ignore + + @classmethod + def _get_discriminator(cls, exist_discriminators) -> typing.Optional["_RestField"]: + for v in cls.__dict__.values(): + if isinstance(v, _RestField) and v._is_discriminator and v._rest_name not in exist_discriminators: + return v + return None + + @classmethod + def _deserialize(cls, data, exist_discriminators): + if not hasattr(cls, "__mapping__"): + return cls(data) + discriminator = cls._get_discriminator(exist_discriminators) + if discriminator is None: + return cls(data) + exist_discriminators.append(discriminator._rest_name) + if isinstance(data, ET.Element): + model_meta = getattr(cls, "_xml", {}) + prop_meta = getattr(discriminator, "_xml", {}) + xml_name = prop_meta.get("name", discriminator._rest_name) + xml_ns = prop_meta.get("ns", model_meta.get("ns", None)) + if xml_ns: + xml_name = "{" + xml_ns + "}" + xml_name + + if data.get(xml_name) is not None: + discriminator_value = data.get(xml_name) + else: + discriminator_value = data.find(xml_name).text # pyright: ignore + else: + discriminator_value = data.get(discriminator._rest_name) + mapped_cls = cls.__mapping__.get(discriminator_value, cls) # pyright: ignore # pylint: disable=no-member + return mapped_cls._deserialize(data, exist_discriminators) + + def as_dict(self, *, exclude_readonly: bool = False) -> dict[str, typing.Any]: + """Return a dict that can be turned into json using json.dump. + + :keyword bool exclude_readonly: Whether to remove the readonly properties. + :returns: A dict JSON compatible object + :rtype: dict + """ + + result = {} + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in self._attr_to_rest_field.values() if _is_readonly(p)] + for k, v in self.items(): + if exclude_readonly and k in readonly_props: # pyright: ignore + continue + is_multipart_file_input = False + try: + is_multipart_file_input = next( + rf for rf in self._attr_to_rest_field.values() if rf._rest_name == k + )._is_multipart_file_input + except StopIteration: + pass + result[k] = v if is_multipart_file_input else Model._as_dict_value(v, exclude_readonly=exclude_readonly) + return result + + @staticmethod + def _as_dict_value(v: typing.Any, exclude_readonly: bool = False) -> typing.Any: + if v is None or isinstance(v, _Null): + return None + if isinstance(v, (list, tuple, set)): + return type(v)(Model._as_dict_value(x, exclude_readonly=exclude_readonly) for x in v) + if isinstance(v, dict): + return {dk: Model._as_dict_value(dv, exclude_readonly=exclude_readonly) for dk, dv in v.items()} + return v.as_dict(exclude_readonly=exclude_readonly) if hasattr(v, "as_dict") else v + + +def _deserialize_model(model_deserializer: typing.Optional[typing.Callable], obj): + if _is_model(obj): + return obj + return _deserialize(model_deserializer, obj) + + +def _deserialize_with_optional(if_obj_deserializer: typing.Optional[typing.Callable], obj): + if obj is None: + return obj + return _deserialize_with_callable(if_obj_deserializer, obj) + + +def _deserialize_with_union(deserializers, obj): + for deserializer in deserializers: + try: + return _deserialize(deserializer, obj) + except DeserializationError: + pass + raise DeserializationError() + + +def _deserialize_dict( + value_deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj: dict[typing.Any, typing.Any], +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = {child.tag: child for child in obj} + return {k: _deserialize(value_deserializer, v, module) for k, v in obj.items()} + + +def _deserialize_multiple_sequence( + entry_deserializers: list[typing.Optional[typing.Callable]], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + return type(obj)(_deserialize(deserializer, entry, module) for entry, deserializer in zip(obj, entry_deserializers)) + + +def _deserialize_sequence( + deserializer: typing.Optional[typing.Callable], + module: typing.Optional[str], + obj, +): + if obj is None: + return obj + if isinstance(obj, ET.Element): + obj = list(obj) + return type(obj)(_deserialize(deserializer, entry, module) for entry in obj) + + +def _sorted_annotations(types: list[typing.Any]) -> list[typing.Any]: + return sorted( + types, + key=lambda x: hasattr(x, "__name__") and x.__name__.lower() in ("str", "float", "int", "bool"), + ) + + +def _get_deserialize_callable_from_annotation( # pylint: disable=too-many-return-statements, too-many-statements, too-many-branches + annotation: typing.Any, + module: typing.Optional[str], + rf: typing.Optional["_RestField"] = None, +) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + if not annotation: + return None + + # is it a type alias? + if isinstance(annotation, str): + if module is not None: + annotation = _get_type_alias_type(module, annotation) + + # is it a forward ref / in quotes? + if isinstance(annotation, (str, typing.ForwardRef)): + try: + model_name = annotation.__forward_arg__ # type: ignore + except AttributeError: + model_name = annotation + if module is not None: + annotation = _get_model(module, model_name) # type: ignore + + try: + if module and _is_model(annotation): + if rf: + rf._is_model = True + + return functools.partial(_deserialize_model, annotation) # pyright: ignore + except Exception: + pass + + # is it a literal? + try: + if annotation.__origin__ is typing.Literal: # pyright: ignore + return None + except AttributeError: + pass + + # is it optional? + try: + if any(a for a in annotation.__args__ if a == type(None)): # pyright: ignore + if len(annotation.__args__) <= 2: # pyright: ignore + if_obj_deserializer = _get_deserialize_callable_from_annotation( + next(a for a in annotation.__args__ if a != type(None)), module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_with_optional, if_obj_deserializer) + # the type is Optional[Union[...]], we need to remove the None type from the Union + annotation_copy = copy.copy(annotation) + annotation_copy.__args__ = [a for a in annotation_copy.__args__ if a != type(None)] # pyright: ignore + return _get_deserialize_callable_from_annotation(annotation_copy, module, rf) + except AttributeError: + pass + + # is it union? + if getattr(annotation, "__origin__", None) is typing.Union: + # initial ordering is we make `string` the last deserialization option, because it is often them most generic + deserializers = [ + _get_deserialize_callable_from_annotation(arg, module, rf) + for arg in _sorted_annotations(annotation.__args__) # pyright: ignore + ] + + return functools.partial(_deserialize_with_union, deserializers) + + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() == "dict": + value_deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[1], module, rf # pyright: ignore + ) + + return functools.partial( + _deserialize_dict, + value_deserializer, + module, + ) + except (AttributeError, IndexError): + pass + try: + annotation_name = ( + annotation.__name__ if hasattr(annotation, "__name__") else annotation._name # pyright: ignore + ) + if annotation_name.lower() in ["list", "set", "tuple", "sequence"]: + if len(annotation.__args__) > 1: # pyright: ignore + entry_deserializers = [ + _get_deserialize_callable_from_annotation(dt, module, rf) + for dt in annotation.__args__ # pyright: ignore + ] + return functools.partial(_deserialize_multiple_sequence, entry_deserializers, module) + deserializer = _get_deserialize_callable_from_annotation( + annotation.__args__[0], module, rf # pyright: ignore + ) + + return functools.partial(_deserialize_sequence, deserializer, module) + except (TypeError, IndexError, AttributeError, SyntaxError): + pass + + def _deserialize_default( + deserializer, + obj, + ): + if obj is None: + return obj + try: + return _deserialize_with_callable(deserializer, obj) + except Exception: + pass + return obj + + if get_deserializer(annotation, rf): + return functools.partial(_deserialize_default, get_deserializer(annotation, rf)) + + return functools.partial(_deserialize_default, annotation) + + +def _deserialize_with_callable( + deserializer: typing.Optional[typing.Callable[[typing.Any], typing.Any]], + value: typing.Any, +): # pylint: disable=too-many-return-statements + try: + if value is None or isinstance(value, _Null): + return None + if isinstance(value, ET.Element): + if deserializer is str: + return value.text or "" + if deserializer is int: + return int(value.text) if value.text else None + if deserializer is float: + return float(value.text) if value.text else None + if deserializer is bool: + return value.text == "true" if value.text else None + if deserializer is None: + return value + if deserializer in [int, float, bool]: + return deserializer(value) + if isinstance(deserializer, CaseInsensitiveEnumMeta): + try: + return deserializer(value) + except ValueError: + # for unknown value, return raw value + return value + if isinstance(deserializer, type) and issubclass(deserializer, Model): + return deserializer._deserialize(value, []) + return typing.cast(typing.Callable[[typing.Any], typing.Any], deserializer)(value) + except Exception as e: + raise DeserializationError() from e + + +def _deserialize( + deserializer: typing.Any, + value: typing.Any, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + if isinstance(value, PipelineResponse): + value = value.http_response.json() + if rf is None and format: + rf = _RestField(format=format) + if not isinstance(deserializer, functools.partial): + deserializer = _get_deserialize_callable_from_annotation(deserializer, module, rf) + return _deserialize_with_callable(deserializer, value) + + +def _failsafe_deserialize( + deserializer: typing.Any, + response: HttpResponse, + module: typing.Optional[str] = None, + rf: typing.Optional["_RestField"] = None, + format: typing.Optional[str] = None, +) -> typing.Any: + try: + return _deserialize(deserializer, response.json(), module, rf, format) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +def _failsafe_deserialize_xml( + deserializer: typing.Any, + response: HttpResponse, +) -> typing.Any: + try: + return _deserialize_xml(deserializer, response.text()) + except DeserializationError: + _LOGGER.warning( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + +class _RestField: + def __init__( + self, + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + is_discriminator: bool = False, + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, + ): + self._type = type + self._rest_name_input = name + self._module: typing.Optional[str] = None + self._is_discriminator = is_discriminator + self._visibility = visibility + self._is_model = False + self._default = default + self._format = format + self._is_multipart_file_input = is_multipart_file_input + self._xml = xml if xml is not None else {} + + @property + def _class_type(self) -> typing.Any: + return getattr(self._type, "args", [None])[0] + + @property + def _rest_name(self) -> str: + if self._rest_name_input is None: + raise ValueError("Rest name was never set") + return self._rest_name_input + + def __get__(self, obj: Model, type=None): # pylint: disable=redefined-builtin + # by this point, type and rest_name will have a value bc we default + # them in __new__ of the Model class + item = obj.get(self._rest_name) + if item is None: + return item + if self._is_model: + return item + return _deserialize(self._type, _serialize(item, self._format), rf=self) + + def __set__(self, obj: Model, value) -> None: + if value is None: + # we want to wipe out entries if users set attr to None + try: + obj.__delitem__(self._rest_name) + except KeyError: + pass + return + if self._is_model: + if not _is_model(value): + value = _deserialize(self._type, value) + obj.__setitem__(self._rest_name, value) + return + obj.__setitem__(self._rest_name, _serialize(value, self._format)) + + def _get_deserialize_callable_from_annotation( + self, annotation: typing.Any + ) -> typing.Optional[typing.Callable[[typing.Any], typing.Any]]: + return _get_deserialize_callable_from_annotation(annotation, self._module, self) + + +def rest_field( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + default: typing.Any = _UNSET, + format: typing.Optional[str] = None, + is_multipart_file_input: bool = False, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField( + name=name, + type=type, + visibility=visibility, + default=default, + format=format, + is_multipart_file_input=is_multipart_file_input, + xml=xml, + ) + + +def rest_discriminator( + *, + name: typing.Optional[str] = None, + type: typing.Optional[typing.Callable] = None, # pylint: disable=redefined-builtin + visibility: typing.Optional[list[str]] = None, + xml: typing.Optional[dict[str, typing.Any]] = None, +) -> typing.Any: + return _RestField(name=name, type=type, is_discriminator=True, visibility=visibility, xml=xml) + + +def serialize_xml(model: Model, exclude_readonly: bool = False) -> str: + """Serialize a model to XML. + + :param Model model: The model to serialize. + :param bool exclude_readonly: Whether to exclude readonly properties. + :returns: The XML representation of the model. + :rtype: str + """ + return ET.tostring(_get_element(model, exclude_readonly), encoding="unicode") # type: ignore + + +def _get_element( + o: typing.Any, + exclude_readonly: bool = False, + parent_meta: typing.Optional[dict[str, typing.Any]] = None, + wrapped_element: typing.Optional[ET.Element] = None, +) -> typing.Union[ET.Element, list[ET.Element]]: + if _is_model(o): + model_meta = getattr(o, "_xml", {}) + + # if prop is a model, then use the prop element directly, else generate a wrapper of model + if wrapped_element is None: + wrapped_element = _create_xml_element( + model_meta.get("name", o.__class__.__name__), + model_meta.get("prefix"), + model_meta.get("ns"), + ) + + readonly_props = [] + if exclude_readonly: + readonly_props = [p._rest_name for p in o._attr_to_rest_field.values() if _is_readonly(p)] + + for k, v in o.items(): + # do not serialize readonly properties + if exclude_readonly and k in readonly_props: + continue + + prop_rest_field = _get_rest_field(o._attr_to_rest_field, k) + if prop_rest_field: + prop_meta = getattr(prop_rest_field, "_xml").copy() + # use the wire name as xml name if no specific name is set + if prop_meta.get("name") is None: + prop_meta["name"] = k + else: + # additional properties will not have rest field, use the wire name as xml name + prop_meta = {"name": k} + + # if no ns for prop, use model's + if prop_meta.get("ns") is None and model_meta.get("ns"): + prop_meta["ns"] = model_meta.get("ns") + prop_meta["prefix"] = model_meta.get("prefix") + + if prop_meta.get("unwrapped", False): + # unwrapped could only set on array + wrapped_element.extend(_get_element(v, exclude_readonly, prop_meta)) + elif prop_meta.get("text", False): + # text could only set on primitive type + wrapped_element.text = _get_primitive_type_value(v) + elif prop_meta.get("attribute", False): + xml_name = prop_meta.get("name", k) + if prop_meta.get("ns"): + ET.register_namespace(prop_meta.get("prefix"), prop_meta.get("ns")) # pyright: ignore + xml_name = "{" + prop_meta.get("ns") + "}" + xml_name # pyright: ignore + # attribute should be primitive type + wrapped_element.set(xml_name, _get_primitive_type_value(v)) + else: + # other wrapped prop element + wrapped_element.append(_get_wrapped_element(v, exclude_readonly, prop_meta)) + return wrapped_element + if isinstance(o, list): + return [_get_element(x, exclude_readonly, parent_meta) for x in o] # type: ignore + if isinstance(o, dict): + result = [] + for k, v in o.items(): + result.append( + _get_wrapped_element( + v, + exclude_readonly, + { + "name": k, + "ns": parent_meta.get("ns") if parent_meta else None, + "prefix": parent_meta.get("prefix") if parent_meta else None, + }, + ) + ) + return result + + # primitive case need to create element based on parent_meta + if parent_meta: + return _get_wrapped_element( + o, + exclude_readonly, + { + "name": parent_meta.get("itemsName", parent_meta.get("name")), + "prefix": parent_meta.get("itemsPrefix", parent_meta.get("prefix")), + "ns": parent_meta.get("itemsNs", parent_meta.get("ns")), + }, + ) + + raise ValueError("Could not serialize value into xml: " + o) + + +def _get_wrapped_element( + v: typing.Any, + exclude_readonly: bool, + meta: typing.Optional[dict[str, typing.Any]], +) -> ET.Element: + wrapped_element = _create_xml_element( + meta.get("name") if meta else None, meta.get("prefix") if meta else None, meta.get("ns") if meta else None + ) + if isinstance(v, (dict, list)): + wrapped_element.extend(_get_element(v, exclude_readonly, meta)) + elif _is_model(v): + _get_element(v, exclude_readonly, meta, wrapped_element) + else: + wrapped_element.text = _get_primitive_type_value(v) + return wrapped_element + + +def _get_primitive_type_value(v) -> str: + if v is True: + return "true" + if v is False: + return "false" + if isinstance(v, _Null): + return "" + return str(v) + + +def _create_xml_element(tag, prefix=None, ns=None): + if prefix and ns: + ET.register_namespace(prefix, ns) + if ns: + return ET.Element("{" + ns + "}" + tag) + return ET.Element(tag) + + +def _deserialize_xml( + deserializer: typing.Any, + value: str, +) -> typing.Any: + element = ET.fromstring(value) # nosec + return _deserialize(deserializer, element) + + +def _convert_element(e: ET.Element): + # dict case + if len(e.attrib) > 0 or len({child.tag for child in e}) > 1: + dict_result: dict[str, typing.Any] = {} + for child in e: + if dict_result.get(child.tag) is not None: + if isinstance(dict_result[child.tag], list): + dict_result[child.tag].append(_convert_element(child)) + else: + dict_result[child.tag] = [dict_result[child.tag], _convert_element(child)] + else: + dict_result[child.tag] = _convert_element(child) + dict_result.update(e.attrib) + return dict_result + # array case + if len(e) > 0: + array_result: list[typing.Any] = [] + for child in e: + array_result.append(_convert_element(child)) + return array_result + # primitive case + return e.text diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/serialization.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/serialization.py new file mode 100644 index 000000000000..45a3e44e45cb --- /dev/null +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/serialization.py @@ -0,0 +1,2030 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines +# 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. +# -------------------------------------------------------------------------- + +# pyright: reportUnnecessaryTypeIgnoreComment=false + +from base64 import b64decode, b64encode +import calendar +import datetime +import decimal +import email +from enum import Enum +import json +import logging +import re +import sys +import codecs +from typing import ( + Any, + cast, + Optional, + Union, + AnyStr, + IO, + Mapping, + Callable, + MutableMapping, +) + +try: + from urllib import quote # type: ignore +except ImportError: + from urllib.parse import quote +import xml.etree.ElementTree as ET + +import isodate # type: ignore +from typing_extensions import Self + +from azure.core.exceptions import DeserializationError, SerializationError +from azure.core.serialization import NULL as CoreNull + +_BOM = codecs.BOM_UTF8.decode(encoding="utf-8") + +JSON = MutableMapping[str, Any] + + +class RawDeserializer: + + # Accept "text" because we're open minded people... + JSON_REGEXP = re.compile(r"^(application|text)/([a-z+.]+\+)?json$") + + # Name used in context + CONTEXT_NAME = "deserialized_data" + + @classmethod + def deserialize_from_text(cls, data: Optional[Union[AnyStr, IO]], content_type: Optional[str] = None) -> Any: + """Decode data according to content-type. + + Accept a stream of data as well, but will be load at once in memory for now. + + If no content-type, will return the string version (not bytes, not stream) + + :param data: Input, could be bytes or stream (will be decoded with UTF8) or text + :type data: str or bytes or IO + :param str content_type: The content type. + :return: The deserialized data. + :rtype: object + """ + if hasattr(data, "read"): + # Assume a stream + data = cast(IO, data).read() + + if isinstance(data, bytes): + data_as_str = data.decode(encoding="utf-8-sig") + else: + # Explain to mypy the correct type. + data_as_str = cast(str, data) + + # Remove Byte Order Mark if present in string + data_as_str = data_as_str.lstrip(_BOM) + + if content_type is None: + return data + + if cls.JSON_REGEXP.match(content_type): + try: + return json.loads(data_as_str) + except ValueError as err: + raise DeserializationError("JSON is invalid: {}".format(err), err) from err + elif "xml" in (content_type or []): + try: + + try: + if isinstance(data, unicode): # type: ignore + # If I'm Python 2.7 and unicode XML will scream if I try a "fromstring" on unicode string + data_as_str = data_as_str.encode(encoding="utf-8") # type: ignore + except NameError: + pass + + return ET.fromstring(data_as_str) # nosec + except ET.ParseError as err: + # It might be because the server has an issue, and returned JSON with + # content-type XML.... + # So let's try a JSON load, and if it's still broken + # let's flow the initial exception + def _json_attemp(data): + try: + return True, json.loads(data) + except ValueError: + return False, None # Don't care about this one + + success, json_result = _json_attemp(data) + if success: + return json_result + # If i'm here, it's not JSON, it's not XML, let's scream + # and raise the last context in this block (the XML exception) + # The function hack is because Py2.7 messes up with exception + # context otherwise. + _LOGGER.critical("Wasn't XML not JSON, failing") + raise DeserializationError("XML is invalid") from err + elif content_type.startswith("text/"): + return data_as_str + raise DeserializationError("Cannot deserialize content-type: {}".format(content_type)) + + @classmethod + def deserialize_from_http_generics(cls, body_bytes: Optional[Union[AnyStr, IO]], headers: Mapping) -> Any: + """Deserialize from HTTP response. + + Use bytes and headers to NOT use any requests/aiohttp or whatever + specific implementation. + Headers will tested for "content-type" + + :param bytes body_bytes: The body of the response. + :param dict headers: The headers of the response. + :returns: The deserialized data. + :rtype: object + """ + # Try to use content-type from headers if available + content_type = None + if "content-type" in headers: + content_type = headers["content-type"].split(";")[0].strip().lower() + # Ouch, this server did not declare what it sent... + # Let's guess it's JSON... + # Also, since Autorest was considering that an empty body was a valid JSON, + # need that test as well.... + else: + content_type = "application/json" + + if body_bytes: + return cls.deserialize_from_text(body_bytes, content_type) + return None + + +_LOGGER = logging.getLogger(__name__) + +try: + _long_type = long # type: ignore +except NameError: + _long_type = int + +TZ_UTC = datetime.timezone.utc + +_FLATTEN = re.compile(r"(? None: + self.additional_properties: Optional[dict[str, Any]] = {} + for k in kwargs: # pylint: disable=consider-using-dict-items + if k not in self._attribute_map: + _LOGGER.warning("%s is not a known attribute of class %s and will be ignored", k, self.__class__) + elif k in self._validation and self._validation[k].get("readonly", False): + _LOGGER.warning("Readonly attribute %s will be ignored in class %s", k, self.__class__) + else: + setattr(self, k, kwargs[k]) + + def __eq__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are equal + :rtype: bool + """ + if isinstance(other, self.__class__): + return self.__dict__ == other.__dict__ + return False + + def __ne__(self, other: Any) -> bool: + """Compare objects by comparing all attributes. + + :param object other: The object to compare + :returns: True if objects are not equal + :rtype: bool + """ + return not self.__eq__(other) + + def __str__(self) -> str: + return str(self.__dict__) + + @classmethod + def enable_additional_properties_sending(cls) -> None: + cls._attribute_map["additional_properties"] = {"key": "", "type": "{object}"} + + @classmethod + def is_xml_model(cls) -> bool: + try: + cls._xml_map # type: ignore + except AttributeError: + return False + return True + + @classmethod + def _create_xml_node(cls): + """Create XML node. + + :returns: The XML node + :rtype: xml.etree.ElementTree.Element + """ + try: + xml_map = cls._xml_map # type: ignore + except AttributeError: + xml_map = {} + + return _create_xml_node(xml_map.get("name", cls.__name__), xml_map.get("prefix", None), xml_map.get("ns", None)) + + def serialize(self, keep_readonly: bool = False, **kwargs: Any) -> JSON: + """Return the JSON that would be sent to server from this model. + + This is an alias to `as_dict(full_restapi_key_transformer, keep_readonly=False)`. + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, keep_readonly=keep_readonly, **kwargs + ) + + def as_dict( + self, + keep_readonly: bool = True, + key_transformer: Callable[[str, dict[str, Any], Any], Any] = attribute_transformer, + **kwargs: Any + ) -> JSON: + """Return a dict that can be serialized using json.dump. + + Advanced usage might optionally use a callback as parameter: + + .. code::python + + def my_key_transformer(key, attr_desc, value): + return key + + Key is the attribute name used in Python. Attr_desc + is a dict of metadata. Currently contains 'type' with the + msrest type and 'key' with the RestAPI encoded key. + Value is the current value in this object. + + The string returned will be used to serialize the key. + If the return type is a list, this is considered hierarchical + result dict. + + See the three examples in this file: + + - attribute_transformer + - full_restapi_key_transformer + - last_restapi_key_transformer + + If you want XML serialization, you can pass the kwargs is_xml=True. + + :param bool keep_readonly: If you want to serialize the readonly attributes + :param function key_transformer: A key transformer function. + :returns: A dict JSON compatible object + :rtype: dict + """ + serializer = Serializer(self._infer_class_models()) + return serializer._serialize( # type: ignore # pylint: disable=protected-access + self, key_transformer=key_transformer, keep_readonly=keep_readonly, **kwargs + ) + + @classmethod + def _infer_class_models(cls): + try: + str_models = cls.__module__.rsplit(".", 1)[0] + models = sys.modules[str_models] + client_models = {k: v for k, v in models.__dict__.items() if isinstance(v, type)} + if cls.__name__ not in client_models: + raise ValueError("Not Autorest generated code") + except Exception: # pylint: disable=broad-exception-caught + # Assume it's not Autorest generated (tests?). Add ourselves as dependencies. + client_models = {cls.__name__: cls} + return client_models + + @classmethod + def deserialize(cls, data: Any, content_type: Optional[str] = None) -> Self: + """Parse a str using the RestAPI syntax and return a model. + + :param str data: A str using RestAPI structure. JSON by default. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def from_dict( + cls, + data: Any, + key_extractors: Optional[Callable[[str, dict[str, Any], Any], Any]] = None, + content_type: Optional[str] = None, + ) -> Self: + """Parse a dict using given key extractor return a model. + + By default consider key + extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor + and last_rest_key_case_insensitive_extractor) + + :param dict data: A dict using RestAPI structure + :param function key_extractors: A key extractor function. + :param str content_type: JSON by default, set application/xml if XML. + :returns: An instance of this model + :raises DeserializationError: if something went wrong + :rtype: Self + """ + deserializer = Deserializer(cls._infer_class_models()) + deserializer.key_extractors = ( # type: ignore + [ # type: ignore + attribute_key_case_insensitive_extractor, + rest_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + if key_extractors is None + else key_extractors + ) + return deserializer(cls.__name__, data, content_type=content_type) # type: ignore + + @classmethod + def _flatten_subtype(cls, key, objects): + if "_subtype_map" not in cls.__dict__: + return {} + result = dict(cls._subtype_map[key]) + for valuetype in cls._subtype_map[key].values(): + result |= objects[valuetype]._flatten_subtype(key, objects) # pylint: disable=protected-access + return result + + @classmethod + def _classify(cls, response, objects): + """Check the class _subtype_map for any child classes. + We want to ignore any inherited _subtype_maps. + + :param dict response: The initial data + :param dict objects: The class objects + :returns: The class to be used + :rtype: class + """ + for subtype_key in cls.__dict__.get("_subtype_map", {}).keys(): + subtype_value = None + + if not isinstance(response, ET.Element): + rest_api_response_key = cls._get_rest_key_parts(subtype_key)[-1] + subtype_value = response.get(rest_api_response_key, None) or response.get(subtype_key, None) + else: + subtype_value = xml_key_extractor(subtype_key, cls._attribute_map[subtype_key], response) + if subtype_value: + # Try to match base class. Can be class name only + # (bug to fix in Autorest to support x-ms-discriminator-name) + if cls.__name__ == subtype_value: + return cls + flatten_mapping_type = cls._flatten_subtype(subtype_key, objects) + try: + return objects[flatten_mapping_type[subtype_value]] # type: ignore + except KeyError: + _LOGGER.warning( + "Subtype value %s has no mapping, use base class %s.", + subtype_value, + cls.__name__, + ) + break + else: + _LOGGER.warning("Discriminator %s is absent or null, use base class %s.", subtype_key, cls.__name__) + break + return cls + + @classmethod + def _get_rest_key_parts(cls, attr_key): + """Get the RestAPI key of this attr, split it and decode part + :param str attr_key: Attribute key must be in attribute_map. + :returns: A list of RestAPI part + :rtype: list + """ + rest_split_key = _FLATTEN.split(cls._attribute_map[attr_key]["key"]) + return [_decode_attribute_map_key(key_part) for key_part in rest_split_key] + + +def _decode_attribute_map_key(key): + """This decode a key in an _attribute_map to the actual key we want to look at + inside the received data. + + :param str key: A key string from the generated code + :returns: The decoded key + :rtype: str + """ + return key.replace("\\.", ".") + + +class Serializer: # pylint: disable=too-many-public-methods + """Request object model serializer.""" + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + _xml_basic_types_serializers = {"bool": lambda x: str(x).lower()} + days = {0: "Mon", 1: "Tue", 2: "Wed", 3: "Thu", 4: "Fri", 5: "Sat", 6: "Sun"} + months = { + 1: "Jan", + 2: "Feb", + 3: "Mar", + 4: "Apr", + 5: "May", + 6: "Jun", + 7: "Jul", + 8: "Aug", + 9: "Sep", + 10: "Oct", + 11: "Nov", + 12: "Dec", + } + validation = { + "min_length": lambda x, y: len(x) < y, + "max_length": lambda x, y: len(x) > y, + "minimum": lambda x, y: x < y, + "maximum": lambda x, y: x > y, + "minimum_ex": lambda x, y: x <= y, + "maximum_ex": lambda x, y: x >= y, + "min_items": lambda x, y: len(x) < y, + "max_items": lambda x, y: len(x) > y, + "pattern": lambda x, y: not re.match(y, x, re.UNICODE), + "unique": lambda x, y: len(x) != len(set(x)), + "multiple": lambda x, y: x % y != 0, + } + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.serialize_type = { + "iso-8601": Serializer.serialize_iso, + "rfc-1123": Serializer.serialize_rfc, + "unix-time": Serializer.serialize_unix, + "duration": Serializer.serialize_duration, + "date": Serializer.serialize_date, + "time": Serializer.serialize_time, + "decimal": Serializer.serialize_decimal, + "long": Serializer.serialize_long, + "bytearray": Serializer.serialize_bytearray, + "base64": Serializer.serialize_base64, + "object": self.serialize_object, + "[]": self.serialize_iter, + "{}": self.serialize_dict, + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_transformer = full_restapi_key_transformer + self.client_side_validation = True + + def _serialize( # pylint: disable=too-many-nested-blocks, too-many-branches, too-many-statements, too-many-locals + self, target_obj, data_type=None, **kwargs + ): + """Serialize data into a string according to type. + + :param object target_obj: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, dict + :raises SerializationError: if serialization fails. + :returns: The serialized data. + """ + key_transformer = kwargs.get("key_transformer", self.key_transformer) + keep_readonly = kwargs.get("keep_readonly", False) + if target_obj is None: + return None + + attr_name = None + class_name = target_obj.__class__.__name__ + + if data_type: + return self.serialize_data(target_obj, data_type, **kwargs) + + if not hasattr(target_obj, "_attribute_map"): + data_type = type(target_obj).__name__ + if data_type in self.basic_types.values(): + return self.serialize_data(target_obj, data_type, **kwargs) + + # Force "is_xml" kwargs if we detect a XML model + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + is_xml_model_serialization = kwargs.setdefault("is_xml", target_obj.is_xml_model()) + + serialized = {} + if is_xml_model_serialization: + serialized = target_obj._create_xml_node() # pylint: disable=protected-access + try: + attributes = target_obj._attribute_map # pylint: disable=protected-access + for attr, attr_desc in attributes.items(): + attr_name = attr + if not keep_readonly and target_obj._validation.get( # pylint: disable=protected-access + attr_name, {} + ).get("readonly", False): + continue + + if attr_name == "additional_properties" and attr_desc["key"] == "": + if target_obj.additional_properties is not None: + serialized |= target_obj.additional_properties + continue + try: + + orig_attr = getattr(target_obj, attr) + if is_xml_model_serialization: + pass # Don't provide "transformer" for XML for now. Keep "orig_attr" + else: # JSON + keys, orig_attr = key_transformer(attr, attr_desc.copy(), orig_attr) + keys = keys if isinstance(keys, list) else [keys] + + kwargs["serialization_ctxt"] = attr_desc + new_attr = self.serialize_data(orig_attr, attr_desc["type"], **kwargs) + + if is_xml_model_serialization: + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + xml_prefix = xml_desc.get("prefix", None) + xml_ns = xml_desc.get("ns", None) + if xml_desc.get("attr", False): + if xml_ns: + ET.register_namespace(xml_prefix, xml_ns) + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + serialized.set(xml_name, new_attr) # type: ignore + continue + if xml_desc.get("text", False): + serialized.text = new_attr # type: ignore + continue + if isinstance(new_attr, list): + serialized.extend(new_attr) # type: ignore + elif isinstance(new_attr, ET.Element): + # If the down XML has no XML/Name, + # we MUST replace the tag with the local tag. But keeping the namespaces. + if "name" not in getattr(orig_attr, "_xml_map", {}): + splitted_tag = new_attr.tag.split("}") + if len(splitted_tag) == 2: # Namespace + new_attr.tag = "}".join([splitted_tag[0], xml_name]) + else: + new_attr.tag = xml_name + serialized.append(new_attr) # type: ignore + else: # That's a basic type + # Integrate namespace if necessary + local_node = _create_xml_node(xml_name, xml_prefix, xml_ns) + local_node.text = str(new_attr) + serialized.append(local_node) # type: ignore + else: # JSON + for k in reversed(keys): # type: ignore + new_attr = {k: new_attr} + + _new_attr = new_attr + _serialized = serialized + for k in keys: # type: ignore + if k not in _serialized: + _serialized.update(_new_attr) # type: ignore + _new_attr = _new_attr[k] # type: ignore + _serialized = _serialized[k] + except ValueError as err: + if isinstance(err, SerializationError): + raise + + except (AttributeError, KeyError, TypeError) as err: + msg = "Attribute {} in object {} cannot be serialized.\n{}".format(attr_name, class_name, str(target_obj)) + raise SerializationError(msg) from err + return serialized + + def body(self, data, data_type, **kwargs): + """Serialize data intended for a request body. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: dict + :raises SerializationError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized request body + """ + + # Just in case this is a dict + internal_data_type_str = data_type.strip("[]{}") + internal_data_type = self.dependencies.get(internal_data_type_str, None) + try: + is_xml_model_serialization = kwargs["is_xml"] + except KeyError: + if internal_data_type and issubclass(internal_data_type, Model): + is_xml_model_serialization = kwargs.setdefault("is_xml", internal_data_type.is_xml_model()) + else: + is_xml_model_serialization = False + if internal_data_type and not isinstance(internal_data_type, Enum): + try: + deserializer = Deserializer(self.dependencies) + # Since it's on serialization, it's almost sure that format is not JSON REST + # We're not able to deal with additional properties for now. + deserializer.additional_properties_detection = False + if is_xml_model_serialization: + deserializer.key_extractors = [ # type: ignore + attribute_key_case_insensitive_extractor, + ] + else: + deserializer.key_extractors = [ + rest_key_case_insensitive_extractor, + attribute_key_case_insensitive_extractor, + last_rest_key_case_insensitive_extractor, + ] + data = deserializer._deserialize(data_type, data) # pylint: disable=protected-access + except DeserializationError as err: + raise SerializationError("Unable to build a model: " + str(err)) from err + + return self._serialize(data, data_type, **kwargs) + + def url(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL path. + + :param str name: The name of the URL path parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :returns: The serialized URL path + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + """ + try: + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + + if kwargs.get("skip_quote") is True: + output = str(output) + output = output.replace("{", quote("{")).replace("}", quote("}")) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return output + + def query(self, name, data, data_type, **kwargs): + """Serialize data intended for a URL query. + + :param str name: The name of the query parameter. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str, list + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized query parameter + """ + try: + # Treat the list aside, since we don't want to encode the div separator + if data_type.startswith("["): + internal_data_type = data_type[1:-1] + do_quote = not kwargs.get("skip_quote", False) + return self.serialize_iter(data, internal_data_type, do_quote=do_quote, **kwargs) + + # Not a list, regular serialization + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + if kwargs.get("skip_quote") is True: + output = str(output) + else: + output = quote(str(output), safe="") + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def header(self, name, data, data_type, **kwargs): + """Serialize data intended for a request header. + + :param str name: The name of the header. + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :rtype: str + :raises TypeError: if serialization fails. + :raises ValueError: if data is None + :returns: The serialized header + """ + try: + if data_type in ["[str]"]: + data = ["" if d is None else d for d in data] + + output = self.serialize_data(data, data_type, **kwargs) + if data_type == "bool": + output = json.dumps(output) + except SerializationError as exc: + raise TypeError("{} must be type {}.".format(name, data_type)) from exc + return str(output) + + def serialize_data(self, data, data_type, **kwargs): + """Serialize generic data according to supplied data type. + + :param object data: The data to be serialized. + :param str data_type: The type to be serialized from. + :raises AttributeError: if required data is None. + :raises ValueError: if data is None + :raises SerializationError: if serialization fails. + :returns: The serialized data. + :rtype: str, int, float, bool, dict, list + """ + if data is None: + raise ValueError("No value for given attribute") + + try: + if data is CoreNull: + return None + if data_type in self.basic_types.values(): + return self.serialize_basic(data, data_type, **kwargs) + + if data_type in self.serialize_type: + return self.serialize_type[data_type](data, **kwargs) + + # If dependencies is empty, try with current data class + # It has to be a subclass of Enum anyway + enum_type = self.dependencies.get(data_type, cast(type, data.__class__)) + if issubclass(enum_type, Enum): + return Serializer.serialize_enum(data, enum_obj=enum_type) + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.serialize_type: + return self.serialize_type[iter_type](data, data_type[1:-1], **kwargs) + + except (ValueError, TypeError) as err: + msg = "Unable to serialize value: {!r} as type: {!r}." + raise SerializationError(msg.format(data, data_type)) from err + return self._serialize(data, **kwargs) + + @classmethod + def _get_custom_serializers(cls, data_type, **kwargs): # pylint: disable=inconsistent-return-statements + custom_serializer = kwargs.get("basic_types_serializers", {}).get(data_type) + if custom_serializer: + return custom_serializer + if kwargs.get("is_xml", False): + return cls._xml_basic_types_serializers.get(data_type) + + @classmethod + def serialize_basic(cls, data, data_type, **kwargs): + """Serialize basic builting data type. + Serializes objects to str, int, float or bool. + + Possible kwargs: + - basic_types_serializers dict[str, callable] : If set, use the callable as serializer + - is_xml bool : If set, use xml_basic_types_serializers + + :param obj data: Object to be serialized. + :param str data_type: Type of object in the iterable. + :rtype: str, int, float, bool + :return: serialized object + """ + custom_serializer = cls._get_custom_serializers(data_type, **kwargs) + if custom_serializer: + return custom_serializer(data) + if data_type == "str": + return cls.serialize_unicode(data) + return eval(data_type)(data) # nosec # pylint: disable=eval-used + + @classmethod + def serialize_unicode(cls, data): + """Special handling for serializing unicode strings in Py2. + Encode to UTF-8 if unicode, otherwise handle as a str. + + :param str data: Object to be serialized. + :rtype: str + :return: serialized object + """ + try: # If I received an enum, return its value + return data.value + except AttributeError: + pass + + try: + if isinstance(data, unicode): # type: ignore + # Don't change it, JSON and XML ElementTree are totally able + # to serialize correctly u'' strings + return data + except NameError: + return str(data) + return str(data) + + def serialize_iter(self, data, iter_type, div=None, **kwargs): + """Serialize iterable. + + Supported kwargs: + - serialization_ctxt dict : The current entry of _attribute_map, or same format. + serialization_ctxt['type'] should be same as data_type. + - is_xml bool : If set, serialize as XML + + :param list data: Object to be serialized. + :param str iter_type: Type of object in the iterable. + :param str div: If set, this str will be used to combine the elements + in the iterable into a combined string. Default is 'None'. + Defaults to False. + :rtype: list, str + :return: serialized iterable + """ + if isinstance(data, str): + raise SerializationError("Refuse str type as a valid iter type.") + + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + is_xml = kwargs.get("is_xml", False) + + serialized = [] + for d in data: + try: + serialized.append(self.serialize_data(d, iter_type, **kwargs)) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized.append(None) + + if kwargs.get("do_quote", False): + serialized = ["" if s is None else quote(str(s), safe="") for s in serialized] + + if div: + serialized = ["" if s is None else str(s) for s in serialized] + serialized = div.join(serialized) + + if "xml" in serialization_ctxt or is_xml: + # XML serialization is more complicated + xml_desc = serialization_ctxt.get("xml", {}) + xml_name = xml_desc.get("name") + if not xml_name: + xml_name = serialization_ctxt["key"] + + # Create a wrap node if necessary (use the fact that Element and list have "append") + is_wrapped = xml_desc.get("wrapped", False) + node_name = xml_desc.get("itemsName", xml_name) + if is_wrapped: + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + else: + final_result = [] + # All list elements to "local_node" + for el in serialized: + if isinstance(el, ET.Element): + el_node = el + else: + el_node = _create_xml_node(node_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + if el is not None: # Otherwise it writes "None" :-p + el_node.text = str(el) + final_result.append(el_node) + return final_result + return serialized + + def serialize_dict(self, attr, dict_type, **kwargs): + """Serialize a dictionary of objects. + + :param dict attr: Object to be serialized. + :param str dict_type: Type of object in the dictionary. + :rtype: dict + :return: serialized dictionary + """ + serialization_ctxt = kwargs.get("serialization_ctxt", {}) + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_data(value, dict_type, **kwargs) + except ValueError as err: + if isinstance(err, SerializationError): + raise + serialized[self.serialize_unicode(key)] = None + + if "xml" in serialization_ctxt: + # XML serialization is more complicated + xml_desc = serialization_ctxt["xml"] + xml_name = xml_desc["name"] + + final_result = _create_xml_node(xml_name, xml_desc.get("prefix", None), xml_desc.get("ns", None)) + for key, value in serialized.items(): + ET.SubElement(final_result, key).text = value + return final_result + + return serialized + + def serialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Serialize a generic object. + This will be handled as a dictionary. If object passed in is not + a basic type (str, int, float, dict, list) it will simply be + cast to str. + + :param dict attr: Object to be serialized. + :rtype: dict or str + :return: serialized object + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + return attr + obj_type = type(attr) + if obj_type in self.basic_types: + return self.serialize_basic(attr, self.basic_types[obj_type], **kwargs) + if obj_type is _long_type: + return self.serialize_long(attr) + if obj_type is str: + return self.serialize_unicode(attr) + if obj_type is datetime.datetime: + return self.serialize_iso(attr) + if obj_type is datetime.date: + return self.serialize_date(attr) + if obj_type is datetime.time: + return self.serialize_time(attr) + if obj_type is datetime.timedelta: + return self.serialize_duration(attr) + if obj_type is decimal.Decimal: + return self.serialize_decimal(attr) + + # If it's a model or I know this dependency, serialize as a Model + if obj_type in self.dependencies.values() or isinstance(attr, Model): + return self._serialize(attr) + + if obj_type == dict: + serialized = {} + for key, value in attr.items(): + try: + serialized[self.serialize_unicode(key)] = self.serialize_object(value, **kwargs) + except ValueError: + serialized[self.serialize_unicode(key)] = None + return serialized + + if obj_type == list: + serialized = [] + for obj in attr: + try: + serialized.append(self.serialize_object(obj, **kwargs)) + except ValueError: + pass + return serialized + return str(attr) + + @staticmethod + def serialize_enum(attr, enum_obj=None): + try: + result = attr.value + except AttributeError: + result = attr + try: + enum_obj(result) # type: ignore + return result + except ValueError as exc: + for enum_value in enum_obj: # type: ignore + if enum_value.value.lower() == str(attr).lower(): + return enum_value.value + error = "{!r} is not valid value for enum {!r}" + raise SerializationError(error.format(attr, enum_obj)) from exc + + @staticmethod + def serialize_bytearray(attr, **kwargs): # pylint: disable=unused-argument + """Serialize bytearray into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + return b64encode(attr).decode() + + @staticmethod + def serialize_base64(attr, **kwargs): # pylint: disable=unused-argument + """Serialize str into base-64 string. + + :param str attr: Object to be serialized. + :rtype: str + :return: serialized base64 + """ + encoded = b64encode(attr).decode("ascii") + return encoded.strip("=").replace("+", "-").replace("/", "_") + + @staticmethod + def serialize_decimal(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Decimal object to float. + + :param decimal attr: Object to be serialized. + :rtype: float + :return: serialized decimal + """ + return float(attr) + + @staticmethod + def serialize_long(attr, **kwargs): # pylint: disable=unused-argument + """Serialize long (Py2) or int (Py3). + + :param int attr: Object to be serialized. + :rtype: int/long + :return: serialized long + """ + return _long_type(attr) + + @staticmethod + def serialize_date(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Date object into ISO-8601 formatted string. + + :param Date attr: Object to be serialized. + :rtype: str + :return: serialized date + """ + if isinstance(attr, str): + attr = isodate.parse_date(attr) + t = "{:04}-{:02}-{:02}".format(attr.year, attr.month, attr.day) + return t + + @staticmethod + def serialize_time(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Time object into ISO-8601 formatted string. + + :param datetime.time attr: Object to be serialized. + :rtype: str + :return: serialized time + """ + if isinstance(attr, str): + attr = isodate.parse_time(attr) + t = "{:02}:{:02}:{:02}".format(attr.hour, attr.minute, attr.second) + if attr.microsecond: + t += ".{:02}".format(attr.microsecond) + return t + + @staticmethod + def serialize_duration(attr, **kwargs): # pylint: disable=unused-argument + """Serialize TimeDelta object into ISO-8601 formatted string. + + :param TimeDelta attr: Object to be serialized. + :rtype: str + :return: serialized duration + """ + if isinstance(attr, str): + attr = isodate.parse_duration(attr) + return isodate.duration_isoformat(attr) + + @staticmethod + def serialize_rfc(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into RFC-1123 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises TypeError: if format invalid. + :return: serialized rfc + """ + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + except AttributeError as exc: + raise TypeError("RFC1123 object must be valid Datetime object.") from exc + + return "{}, {:02} {} {:04} {:02}:{:02}:{:02} GMT".format( + Serializer.days[utc.tm_wday], + utc.tm_mday, + Serializer.months[utc.tm_mon], + utc.tm_year, + utc.tm_hour, + utc.tm_min, + utc.tm_sec, + ) + + @staticmethod + def serialize_iso(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into ISO-8601 formatted string. + + :param Datetime attr: Object to be serialized. + :rtype: str + :raises SerializationError: if format invalid. + :return: serialized iso + """ + if isinstance(attr, str): + attr = isodate.parse_datetime(attr) + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + utc = attr.utctimetuple() + if utc.tm_year > 9999 or utc.tm_year < 1: + raise OverflowError("Hit max or min date") + + microseconds = str(attr.microsecond).rjust(6, "0").rstrip("0").ljust(3, "0") + if microseconds: + microseconds = "." + microseconds + date = "{:04}-{:02}-{:02}T{:02}:{:02}:{:02}".format( + utc.tm_year, utc.tm_mon, utc.tm_mday, utc.tm_hour, utc.tm_min, utc.tm_sec + ) + return date + microseconds + "Z" + except (ValueError, OverflowError) as err: + msg = "Unable to serialize datetime object." + raise SerializationError(msg) from err + except AttributeError as err: + msg = "ISO-8601 object must be valid Datetime object." + raise TypeError(msg) from err + + @staticmethod + def serialize_unix(attr, **kwargs): # pylint: disable=unused-argument + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param Datetime attr: Object to be serialized. + :rtype: int + :raises SerializationError: if format invalid + :return: serialied unix + """ + if isinstance(attr, int): + return attr + try: + if not attr.tzinfo: + _LOGGER.warning("Datetime with no tzinfo will be considered UTC.") + return int(calendar.timegm(attr.utctimetuple())) + except AttributeError as exc: + raise TypeError("Unix time object must be valid Datetime object.") from exc + + +def rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + key = attr_desc["key"] + working_data = data + + while "." in key: + # Need the cast, as for some reasons "split" is typed as list[str | Any] + dict_keys = cast(list[str], _FLATTEN.split(key)) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = working_data.get(working_key, data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + return working_data.get(key) + + +def rest_key_case_insensitive_extractor( # pylint: disable=unused-argument, inconsistent-return-statements + attr, attr_desc, data +): + key = attr_desc["key"] + working_data = data + + while "." in key: + dict_keys = _FLATTEN.split(key) + if len(dict_keys) == 1: + key = _decode_attribute_map_key(dict_keys[0]) + break + working_key = _decode_attribute_map_key(dict_keys[0]) + working_data = attribute_key_case_insensitive_extractor(working_key, None, working_data) + if working_data is None: + # If at any point while following flatten JSON path see None, it means + # that all properties under are None as well + return None + key = ".".join(dict_keys[1:]) + + if working_data: + return attribute_key_case_insensitive_extractor(key, None, working_data) + + +def last_rest_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_extractor(dict_keys[-1], None, data) + + +def last_rest_key_case_insensitive_extractor(attr, attr_desc, data): # pylint: disable=unused-argument + """Extract the attribute in "data" based on the last part of the JSON path key. + + This is the case insensitive version of "last_rest_key_extractor" + :param str attr: The attribute to extract + :param dict attr_desc: The attribute description + :param dict data: The data to extract from + :rtype: object + :returns: The extracted attribute + """ + key = attr_desc["key"] + dict_keys = _FLATTEN.split(key) + return attribute_key_case_insensitive_extractor(dict_keys[-1], None, data) + + +def attribute_key_extractor(attr, _, data): + return data.get(attr) + + +def attribute_key_case_insensitive_extractor(attr, _, data): + found_key = None + lower_attr = attr.lower() + for key in data: + if lower_attr == key.lower(): + found_key = key + break + + return data.get(found_key) + + +def _extract_name_from_internal_type(internal_type): + """Given an internal type XML description, extract correct XML name with namespace. + + :param dict internal_type: An model type + :rtype: tuple + :returns: A tuple XML name + namespace dict + """ + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + xml_name = internal_type_xml_map.get("name", internal_type.__name__) + xml_ns = internal_type_xml_map.get("ns", None) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + return xml_name + + +def xml_key_extractor(attr, attr_desc, data): # pylint: disable=unused-argument,too-many-return-statements + if isinstance(data, dict): + return None + + # Test if this model is XML ready first + if not isinstance(data, ET.Element): + return None + + xml_desc = attr_desc.get("xml", {}) + xml_name = xml_desc.get("name", attr_desc["key"]) + + # Look for a children + is_iter_type = attr_desc["type"].startswith("[") + is_wrapped = xml_desc.get("wrapped", False) + internal_type = attr_desc.get("internalType", None) + internal_type_xml_map = getattr(internal_type, "_xml_map", {}) + + # Integrate namespace if necessary + xml_ns = xml_desc.get("ns", internal_type_xml_map.get("ns", None)) + if xml_ns: + xml_name = "{{{}}}{}".format(xml_ns, xml_name) + + # If it's an attribute, that's simple + if xml_desc.get("attr", False): + return data.get(xml_name) + + # If it's x-ms-text, that's simple too + if xml_desc.get("text", False): + return data.text + + # Scenario where I take the local name: + # - Wrapped node + # - Internal type is an enum (considered basic types) + # - Internal type has no XML/Name node + if is_wrapped or (internal_type and (issubclass(internal_type, Enum) or "name" not in internal_type_xml_map)): + children = data.findall(xml_name) + # If internal type has a local name and it's not a list, I use that name + elif not is_iter_type and internal_type and "name" in internal_type_xml_map: + xml_name = _extract_name_from_internal_type(internal_type) + children = data.findall(xml_name) + # That's an array + else: + if internal_type: # Complex type, ignore itemsName and use the complex type name + items_name = _extract_name_from_internal_type(internal_type) + else: + items_name = xml_desc.get("itemsName", xml_name) + children = data.findall(items_name) + + if len(children) == 0: + if is_iter_type: + if is_wrapped: + return None # is_wrapped no node, we want None + return [] # not wrapped, assume empty list + return None # Assume it's not there, maybe an optional node. + + # If is_iter_type and not wrapped, return all found children + if is_iter_type: + if not is_wrapped: + return children + # Iter and wrapped, should have found one node only (the wrap one) + if len(children) != 1: + raise DeserializationError( + "Tried to deserialize an array not wrapped, and found several nodes '{}'. Maybe you should declare this array as wrapped?".format( + xml_name + ) + ) + return list(children[0]) # Might be empty list and that's ok. + + # Here it's not a itertype, we should have found one element only or empty + if len(children) > 1: + raise DeserializationError("Find several XML '{}' where it was not expected".format(xml_name)) + return children[0] + + +class Deserializer: + """Response object model deserializer. + + :param dict classes: Class type dictionary for deserializing complex types. + :ivar list key_extractors: Ordered list of extractors to be used by this deserializer. + """ + + basic_types = {str: "str", int: "int", bool: "bool", float: "float"} + + valid_date = re.compile(r"\d{4}[-]\d{2}[-]\d{2}T\d{2}:\d{2}:\d{2}\.?\d*Z?[-+]?[\d{2}]?:?[\d{2}]?") + + def __init__(self, classes: Optional[Mapping[str, type]] = None) -> None: + self.deserialize_type = { + "iso-8601": Deserializer.deserialize_iso, + "rfc-1123": Deserializer.deserialize_rfc, + "unix-time": Deserializer.deserialize_unix, + "duration": Deserializer.deserialize_duration, + "date": Deserializer.deserialize_date, + "time": Deserializer.deserialize_time, + "decimal": Deserializer.deserialize_decimal, + "long": Deserializer.deserialize_long, + "bytearray": Deserializer.deserialize_bytearray, + "base64": Deserializer.deserialize_base64, + "object": self.deserialize_object, + "[]": self.deserialize_iter, + "{}": self.deserialize_dict, + } + self.deserialize_expected_types = { + "duration": (isodate.Duration, datetime.timedelta), + "iso-8601": (datetime.datetime), + } + self.dependencies: dict[str, type] = dict(classes) if classes else {} + self.key_extractors = [rest_key_extractor, xml_key_extractor] + # Additional properties only works if the "rest_key_extractor" is used to + # extract the keys. Making it to work whatever the key extractor is too much + # complicated, with no real scenario for now. + # So adding a flag to disable additional properties detection. This flag should be + # used if your expect the deserialization to NOT come from a JSON REST syntax. + # Otherwise, result are unexpected + self.additional_properties_detection = True + + def __call__(self, target_obj, response_data, content_type=None): + """Call the deserializer to process a REST response. + + :param str target_obj: Target data type to deserialize to. + :param requests.Response response_data: REST response object. + :param str content_type: Swagger "produces" if available. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + data = self._unpack_content(response_data, content_type) + return self._deserialize(target_obj, data) + + def _deserialize(self, target_obj, data): # pylint: disable=inconsistent-return-statements + """Call the deserializer on a model. + + Data needs to be already deserialized as JSON or XML ElementTree + + :param str target_obj: Target data type to deserialize to. + :param object data: Object to deserialize. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + # This is already a model, go recursive just in case + if hasattr(data, "_attribute_map"): + constants = [name for name, config in getattr(data, "_validation", {}).items() if config.get("constant")] + try: + for attr, mapconfig in data._attribute_map.items(): # pylint: disable=protected-access + if attr in constants: + continue + value = getattr(data, attr) + if value is None: + continue + local_type = mapconfig["type"] + internal_data_type = local_type.strip("[]{}") + if internal_data_type not in self.dependencies or isinstance(internal_data_type, Enum): + continue + setattr(data, attr, self._deserialize(local_type, value)) + return data + except AttributeError: + return + + response, class_name = self._classify_target(target_obj, data) + + if isinstance(response, str): + return self.deserialize_data(data, response) + if isinstance(response, type) and issubclass(response, Enum): + return self.deserialize_enum(data, response) + + if data is None or data is CoreNull: + return data + try: + attributes = response._attribute_map # type: ignore # pylint: disable=protected-access + d_attrs = {} + for attr, attr_desc in attributes.items(): + # Check empty string. If it's not empty, someone has a real "additionalProperties"... + if attr == "additional_properties" and attr_desc["key"] == "": + continue + raw_value = None + # Enhance attr_desc with some dynamic data + attr_desc = attr_desc.copy() # Do a copy, do not change the real one + internal_data_type = attr_desc["type"].strip("[]{}") + if internal_data_type in self.dependencies: + attr_desc["internalType"] = self.dependencies[internal_data_type] + + for key_extractor in self.key_extractors: + found_value = key_extractor(attr, attr_desc, data) + if found_value is not None: + if raw_value is not None and raw_value != found_value: + msg = ( + "Ignoring extracted value '%s' from %s for key '%s'" + " (duplicate extraction, follow extractors order)" + ) + _LOGGER.warning(msg, found_value, key_extractor, attr) + continue + raw_value = found_value + + value = self.deserialize_data(raw_value, attr_desc["type"]) + d_attrs[attr] = value + except (AttributeError, TypeError, KeyError) as err: + msg = "Unable to deserialize to object: " + class_name # type: ignore + raise DeserializationError(msg) from err + additional_properties = self._build_additional_properties(attributes, data) + return self._instantiate_model(response, d_attrs, additional_properties) + + def _build_additional_properties(self, attribute_map, data): + if not self.additional_properties_detection: + return None + if "additional_properties" in attribute_map and attribute_map.get("additional_properties", {}).get("key") != "": + # Check empty string. If it's not empty, someone has a real "additionalProperties" + return None + if isinstance(data, ET.Element): + data = {el.tag: el.text for el in data} + + known_keys = { + _decode_attribute_map_key(_FLATTEN.split(desc["key"])[0]) + for desc in attribute_map.values() + if desc["key"] != "" + } + present_keys = set(data.keys()) + missing_keys = present_keys - known_keys + return {key: data[key] for key in missing_keys} + + def _classify_target(self, target, data): + """Check to see whether the deserialization target object can + be classified into a subclass. + Once classification has been determined, initialize object. + + :param str target: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :return: The classified target object and its class name. + :rtype: tuple + """ + if target is None: + return None, None + + if isinstance(target, str): + try: + target = self.dependencies[target] + except KeyError: + return target, target + + try: + target = target._classify(data, self.dependencies) # type: ignore # pylint: disable=protected-access + except AttributeError: + pass # Target is not a Model, no classify + return target, target.__class__.__name__ # type: ignore + + def failsafe_deserialize(self, target_obj, data, content_type=None): + """Ignores any errors encountered in deserialization, + and falls back to not deserializing the object. Recommended + for use in error deserialization, as we want to return the + HttpResponseError to users, and not have them deal with + a deserialization error. + + :param str target_obj: The target object type to deserialize to. + :param str/dict data: The response data to deserialize. + :param str content_type: Swagger "produces" if available. + :return: Deserialized object. + :rtype: object + """ + try: + return self(target_obj, data, content_type=content_type) + except: # pylint: disable=bare-except + _LOGGER.debug( + "Ran into a deserialization error. Ignoring since this is failsafe deserialization", exc_info=True + ) + return None + + @staticmethod + def _unpack_content(raw_data, content_type=None): + """Extract the correct structure for deserialization. + + If raw_data is a PipelineResponse, try to extract the result of RawDeserializer. + if we can't, raise. Your Pipeline should have a RawDeserializer. + + If not a pipeline response and raw_data is bytes or string, use content-type + to decode it. If no content-type, try JSON. + + If raw_data is something else, bypass all logic and return it directly. + + :param obj raw_data: Data to be processed. + :param str content_type: How to parse if raw_data is a string/bytes. + :raises JSONDecodeError: If JSON is requested and parsing is impossible. + :raises UnicodeDecodeError: If bytes is not UTF8 + :rtype: object + :return: Unpacked content. + """ + # Assume this is enough to detect a Pipeline Response without importing it + context = getattr(raw_data, "context", {}) + if context: + if RawDeserializer.CONTEXT_NAME in context: + return context[RawDeserializer.CONTEXT_NAME] + raise ValueError("This pipeline didn't have the RawDeserializer policy; can't deserialize") + + # Assume this is enough to recognize universal_http.ClientResponse without importing it + if hasattr(raw_data, "body"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text(), raw_data.headers) + + # Assume this enough to recognize requests.Response without importing it. + if hasattr(raw_data, "_content_consumed"): + return RawDeserializer.deserialize_from_http_generics(raw_data.text, raw_data.headers) + + if isinstance(raw_data, (str, bytes)) or hasattr(raw_data, "read"): + return RawDeserializer.deserialize_from_text(raw_data, content_type) # type: ignore + return raw_data + + def _instantiate_model(self, response, attrs, additional_properties=None): + """Instantiate a response model passing in deserialized args. + + :param Response response: The response model class. + :param dict attrs: The deserialized response attributes. + :param dict additional_properties: Additional properties to be set. + :rtype: Response + :return: The instantiated response model. + """ + if callable(response): + subtype = getattr(response, "_subtype_map", {}) + try: + readonly = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("readonly") + ] + const = [ + k + for k, v in response._validation.items() # pylint: disable=protected-access # type: ignore + if v.get("constant") + ] + kwargs = {k: v for k, v in attrs.items() if k not in subtype and k not in readonly + const} + response_obj = response(**kwargs) + for attr in readonly: + setattr(response_obj, attr, attrs.get(attr)) + if additional_properties: + response_obj.additional_properties = additional_properties # type: ignore + return response_obj + except TypeError as err: + msg = "Unable to deserialize {} into model {}. ".format(kwargs, response) # type: ignore + raise DeserializationError(msg + str(err)) from err + else: + try: + for attr, value in attrs.items(): + setattr(response, attr, value) + return response + except Exception as exp: + msg = "Unable to populate response model. " + msg += "Type: {}, Error: {}".format(type(response), exp) + raise DeserializationError(msg) from exp + + def deserialize_data(self, data, data_type): # pylint: disable=too-many-return-statements + """Process data for deserialization according to data type. + + :param str data: The response string to be deserialized. + :param str data_type: The type to deserialize to. + :raises DeserializationError: if deserialization fails. + :return: Deserialized object. + :rtype: object + """ + if data is None: + return data + + try: + if not data_type: + return data + if data_type in self.basic_types.values(): + return self.deserialize_basic(data, data_type) + if data_type in self.deserialize_type: + if isinstance(data, self.deserialize_expected_types.get(data_type, tuple())): + return data + + is_a_text_parsing_type = lambda x: x not in [ # pylint: disable=unnecessary-lambda-assignment + "object", + "[]", + r"{}", + ] + if isinstance(data, ET.Element) and is_a_text_parsing_type(data_type) and not data.text: + return None + data_val = self.deserialize_type[data_type](data) + return data_val + + iter_type = data_type[0] + data_type[-1] + if iter_type in self.deserialize_type: + return self.deserialize_type[iter_type](data, data_type[1:-1]) + + obj_type = self.dependencies[data_type] + if issubclass(obj_type, Enum): + if isinstance(data, ET.Element): + data = data.text + return self.deserialize_enum(data, obj_type) + + except (ValueError, TypeError, AttributeError) as err: + msg = "Unable to deserialize response data." + msg += " Data: {}, {}".format(data, data_type) + raise DeserializationError(msg) from err + return self._deserialize(obj_type, data) + + def deserialize_iter(self, attr, iter_type): + """Deserialize an iterable. + + :param list attr: Iterable to be deserialized. + :param str iter_type: The type of object in the iterable. + :return: Deserialized iterable. + :rtype: list + """ + if attr is None: + return None + if isinstance(attr, ET.Element): # If I receive an element here, get the children + attr = list(attr) + if not isinstance(attr, (list, set)): + raise DeserializationError("Cannot deserialize as [{}] an object of type {}".format(iter_type, type(attr))) + return [self.deserialize_data(a, iter_type) for a in attr] + + def deserialize_dict(self, attr, dict_type): + """Deserialize a dictionary. + + :param dict/list attr: Dictionary to be deserialized. Also accepts + a list of key, value pairs. + :param str dict_type: The object type of the items in the dictionary. + :return: Deserialized dictionary. + :rtype: dict + """ + if isinstance(attr, list): + return {x["key"]: self.deserialize_data(x["value"], dict_type) for x in attr} + + if isinstance(attr, ET.Element): + # Transform value into {"Key": "value"} + attr = {el.tag: el.text for el in attr} + return {k: self.deserialize_data(v, dict_type) for k, v in attr.items()} + + def deserialize_object(self, attr, **kwargs): # pylint: disable=too-many-return-statements + """Deserialize a generic object. + This will be handled as a dictionary. + + :param dict attr: Dictionary to be deserialized. + :return: Deserialized object. + :rtype: dict + :raises TypeError: if non-builtin datatype encountered. + """ + if attr is None: + return None + if isinstance(attr, ET.Element): + # Do no recurse on XML, just return the tree as-is + return attr + if isinstance(attr, str): + return self.deserialize_basic(attr, "str") + obj_type = type(attr) + if obj_type in self.basic_types: + return self.deserialize_basic(attr, self.basic_types[obj_type]) + if obj_type is _long_type: + return self.deserialize_long(attr) + + if obj_type == dict: + deserialized = {} + for key, value in attr.items(): + try: + deserialized[key] = self.deserialize_object(value, **kwargs) + except ValueError: + deserialized[key] = None + return deserialized + + if obj_type == list: + deserialized = [] + for obj in attr: + try: + deserialized.append(self.deserialize_object(obj, **kwargs)) + except ValueError: + pass + return deserialized + + error = "Cannot deserialize generic object with type: " + raise TypeError(error + str(obj_type)) + + def deserialize_basic(self, attr, data_type): # pylint: disable=too-many-return-statements + """Deserialize basic builtin data type from string. + Will attempt to convert to str, int, float and bool. + This function will also accept '1', '0', 'true' and 'false' as + valid bool values. + + :param str attr: response string to be deserialized. + :param str data_type: deserialization data type. + :return: Deserialized basic type. + :rtype: str, int, float or bool + :raises TypeError: if string format is not valid. + """ + # If we're here, data is supposed to be a basic type. + # If it's still an XML node, take the text + if isinstance(attr, ET.Element): + attr = attr.text + if not attr: + if data_type == "str": + # None or '', node is empty string. + return "" + # None or '', node with a strong type is None. + # Don't try to model "empty bool" or "empty int" + return None + + if data_type == "bool": + if attr in [True, False, 1, 0]: + return bool(attr) + if isinstance(attr, str): + if attr.lower() in ["true", "1"]: + return True + if attr.lower() in ["false", "0"]: + return False + raise TypeError("Invalid boolean value: {}".format(attr)) + + if data_type == "str": + return self.deserialize_unicode(attr) + return eval(data_type)(attr) # nosec # pylint: disable=eval-used + + @staticmethod + def deserialize_unicode(data): + """Preserve unicode objects in Python 2, otherwise return data + as a string. + + :param str data: response string to be deserialized. + :return: Deserialized string. + :rtype: str or unicode + """ + # We might be here because we have an enum modeled as string, + # and we try to deserialize a partial dict with enum inside + if isinstance(data, Enum): + return data + + # Consider this is real string + try: + if isinstance(data, unicode): # type: ignore + return data + except NameError: + return str(data) + return str(data) + + @staticmethod + def deserialize_enum(data, enum_obj): + """Deserialize string into enum object. + + If the string is not a valid enum value it will be returned as-is + and a warning will be logged. + + :param str data: Response string to be deserialized. If this value is + None or invalid it will be returned as-is. + :param Enum enum_obj: Enum object to deserialize to. + :return: Deserialized enum object. + :rtype: Enum + """ + if isinstance(data, enum_obj) or data is None: + return data + if isinstance(data, Enum): + data = data.value + if isinstance(data, int): + # Workaround. We might consider remove it in the future. + try: + return list(enum_obj.__members__.values())[data] + except IndexError as exc: + error = "{!r} is not a valid index for enum {!r}" + raise DeserializationError(error.format(data, enum_obj)) from exc + try: + return enum_obj(str(data)) + except ValueError: + for enum_value in enum_obj: + if enum_value.value.lower() == str(data).lower(): + return enum_value + # We don't fail anymore for unknown value, we deserialize as a string + _LOGGER.warning("Deserializer is not able to find %s as valid enum in %s", data, enum_obj) + return Deserializer.deserialize_unicode(data) + + @staticmethod + def deserialize_bytearray(attr): + """Deserialize string into bytearray. + + :param str attr: response string to be deserialized. + :return: Deserialized bytearray + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return bytearray(b64decode(attr)) # type: ignore + + @staticmethod + def deserialize_base64(attr): + """Deserialize base64 encoded string into string. + + :param str attr: response string to be deserialized. + :return: Deserialized base64 string + :rtype: bytearray + :raises TypeError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + padding = "=" * (3 - (len(attr) + 3) % 4) # type: ignore + attr = attr + padding # type: ignore + encoded = attr.replace("-", "+").replace("_", "/") + return b64decode(encoded) + + @staticmethod + def deserialize_decimal(attr): + """Deserialize string into Decimal object. + + :param str attr: response string to be deserialized. + :return: Deserialized decimal + :raises DeserializationError: if string format invalid. + :rtype: decimal + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + return decimal.Decimal(str(attr)) # type: ignore + except decimal.DecimalException as err: + msg = "Invalid decimal {}".format(attr) + raise DeserializationError(msg) from err + + @staticmethod + def deserialize_long(attr): + """Deserialize string into long (Py2) or int (Py3). + + :param str attr: response string to be deserialized. + :return: Deserialized int + :rtype: long or int + :raises ValueError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + return _long_type(attr) # type: ignore + + @staticmethod + def deserialize_duration(attr): + """Deserialize ISO-8601 formatted string into TimeDelta object. + + :param str attr: response string to be deserialized. + :return: Deserialized duration + :rtype: TimeDelta + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + duration = isodate.parse_duration(attr) + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize duration object." + raise DeserializationError(msg) from err + return duration + + @staticmethod + def deserialize_date(attr): + """Deserialize ISO-8601 formatted string into Date object. + + :param str attr: response string to be deserialized. + :return: Deserialized date + :rtype: Date + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + # This must NOT use defaultmonth/defaultday. Using None ensure this raises an exception. + return isodate.parse_date(attr, defaultmonth=0, defaultday=0) + + @staticmethod + def deserialize_time(attr): + """Deserialize ISO-8601 formatted string into time object. + + :param str attr: response string to be deserialized. + :return: Deserialized time + :rtype: datetime.time + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + if re.search(r"[^\W\d_]", attr, re.I + re.U): # type: ignore + raise DeserializationError("Date must have only digits and -. Received: %s" % attr) + return isodate.parse_time(attr) + + @staticmethod + def deserialize_rfc(attr): + """Deserialize RFC-1123 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized RFC datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + parsed_date = email.utils.parsedate_tz(attr) # type: ignore + date_obj = datetime.datetime( + *parsed_date[:6], tzinfo=datetime.timezone(datetime.timedelta(minutes=(parsed_date[9] or 0) / 60)) + ) + if not date_obj.tzinfo: + date_obj = date_obj.astimezone(tz=TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to rfc datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_iso(attr): + """Deserialize ISO-8601 formatted string into Datetime object. + + :param str attr: response string to be deserialized. + :return: Deserialized ISO datetime + :rtype: Datetime + :raises DeserializationError: if string format invalid. + """ + if isinstance(attr, ET.Element): + attr = attr.text + try: + attr = attr.upper() # type: ignore + match = Deserializer.valid_date.match(attr) + if not match: + raise ValueError("Invalid datetime string: " + attr) + + check_decimal = attr.split(".") + if len(check_decimal) > 1: + decimal_str = "" + for digit in check_decimal[1]: + if digit.isdigit(): + decimal_str += digit + else: + break + if len(decimal_str) > 6: + attr = attr.replace(decimal_str, decimal_str[0:6]) + + date_obj = isodate.parse_datetime(attr) + test_utc = date_obj.utctimetuple() + if test_utc.tm_year > 9999 or test_utc.tm_year < 1: + raise OverflowError("Hit max or min date") + except (ValueError, OverflowError, AttributeError) as err: + msg = "Cannot deserialize datetime object." + raise DeserializationError(msg) from err + return date_obj + + @staticmethod + def deserialize_unix(attr): + """Serialize Datetime object into IntTime format. + This is represented as seconds. + + :param int attr: Object to be serialized. + :return: Deserialized datetime + :rtype: Datetime + :raises DeserializationError: if format invalid + """ + if isinstance(attr, ET.Element): + attr = int(attr.text) # type: ignore + try: + attr = int(attr) + date_obj = datetime.datetime.fromtimestamp(attr, TZ_UTC) + except ValueError as err: + msg = "Cannot deserialize to unix datetime object." + raise DeserializationError(msg) from err + return date_obj diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/utils.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/utils.py new file mode 100644 index 000000000000..927adb7c8ae2 --- /dev/null +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_utils/utils.py @@ -0,0 +1,57 @@ +# -------------------------------------------------------------------------- +# 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 abc import ABC +from typing import Generic, Optional, TYPE_CHECKING, TypeVar + +from azure.core import MatchConditions + +if TYPE_CHECKING: + from .serialization import Deserializer, Serializer + + +TClient = TypeVar("TClient") +TConfig = TypeVar("TConfig") + + +class ClientMixinABC(ABC, Generic[TClient, TConfig]): + """DO NOT use this class. It is for internal typing use only.""" + + _client: TClient + _config: TConfig + _serialize: "Serializer" + _deserialize: "Deserializer" + + +def quote_etag(etag: Optional[str]) -> Optional[str]: + if not etag or etag == "*": + return etag + if etag.startswith("W/"): + return etag + if etag.startswith('"') and etag.endswith('"'): + return etag + if etag.startswith("'") and etag.endswith("'"): + return etag + return '"' + etag + '"' + + +def prep_if_match(etag: Optional[str], match_condition: Optional[MatchConditions]) -> Optional[str]: + if match_condition == MatchConditions.IfNotModified: + if_match = quote_etag(etag) if etag else None + return if_match + if match_condition == MatchConditions.IfPresent: + return "*" + return None + + +def prep_if_none_match(etag: Optional[str], match_condition: Optional[MatchConditions]) -> Optional[str]: + if match_condition == MatchConditions.IfModified: + if_none_match = quote_etag(etag) if etag else None + return if_none_match + if match_condition == MatchConditions.IfMissing: + return "*" + return None diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_validation.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_validation.py new file mode 100644 index 000000000000..f5af3a4eb8a2 --- /dev/null +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_validation.py @@ -0,0 +1,66 @@ +# -------------------------------------------------------------------------- +# 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. +# -------------------------------------------------------------------------- +import functools + + +def api_version_validation(**kwargs): + params_added_on = kwargs.pop("params_added_on", {}) + method_added_on = kwargs.pop("method_added_on", "") + api_versions_list = kwargs.pop("api_versions_list", []) + + def _index_with_default(value: str, default: int = -1) -> int: + """Get the index of value in lst, or return default if not found. + + :param value: The value to search for in the api_versions_list. + :type value: str + :param default: The default value to return if the value is not found. + :type default: int + :return: The index of the value in the list, or the default value if not found. + :rtype: int + """ + try: + return api_versions_list.index(value) + except ValueError: + return default + + def decorator(func): + @functools.wraps(func) + def wrapper(*args, **kwargs): + try: + # this assumes the client has an _api_version attribute + client = args[0] + client_api_version = client._config.api_version # pylint: disable=protected-access + except AttributeError: + return func(*args, **kwargs) + + if _index_with_default(method_added_on) > _index_with_default(client_api_version): + raise ValueError( + f"'{func.__name__}' is not available in API version " + f"{client_api_version}. Pass service API version {method_added_on} or newer to your client." + ) + + unsupported = { + parameter: api_version + for api_version, parameters in params_added_on.items() + for parameter in parameters + if parameter in kwargs and _index_with_default(api_version) > _index_with_default(client_api_version) + } + if unsupported: + raise ValueError( + "".join( + [ + f"'{param}' is not available in API version {client_api_version}. " + f"Use service API version {version} or newer.\n" + for param, version in unsupported.items() + ] + ) + ) + return func(*args, **kwargs) + + return wrapper + + return decorator diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_version.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_version.py index 8e44259d1a18..0e00a6283246 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_version.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_version.py @@ -6,4 +6,4 @@ # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -VERSION = "1.0.2" +VERSION = "2.0.0b1" diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/__init__.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/__init__.py index 0d279090135b..2887e29b8c63 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/__init__.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/__init__.py @@ -5,15 +5,25 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._patch import TextTranslationClient +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import +from ._client import TextTranslationClient # type: ignore + +try: + from ._patch import __all__ as _patch_all + from ._patch import * +except ImportError: + _patch_all = [] from ._patch import patch_sdk as _patch_sdk __all__ = [ "TextTranslationClient", ] - +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_client.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_client.py index 9b7f5d746e2f..573b459a81ae 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_client.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_client.py @@ -8,17 +8,18 @@ from copy import deepcopy from typing import Any, Awaitable +from typing_extensions import Self from azure.core import AsyncPipelineClient from azure.core.pipeline import policies from azure.core.rest import AsyncHttpResponse, HttpRequest -from .._serialization import Deserializer, Serializer +from .._utils.serialization import Deserializer, Serializer from ._configuration import TextTranslationClientConfiguration -from ._operations import TextTranslationClientOperationsMixin +from ._operations import _TextTranslationClientOperationsMixin -class TextTranslationClient(TextTranslationClientOperationsMixin): # pylint: disable=client-accepts-api-version-keyword +class TextTranslationClient(_TextTranslationClientOperationsMixin): """Text translation is a cloud-based REST API feature of the Translator service that uses neural machine translation technology to enable quick and accurate source-to-target text translation in real time across all supported languages. @@ -37,16 +38,12 @@ class TextTranslationClient(TextTranslationClientOperationsMixin): # pylint: di Detect. Returns the source code language code and a boolean variable denoting whether the detected language is supported for text translation and transliteration. - Dictionary lookup. Returns equivalent words for the source term in the target language. - - Dictionary example Returns grammatical structure and context examples for the source term and - target term pair. - :param endpoint: Supported Text Translation endpoints (protocol and hostname, for example: - https://api.cognitive.microsofttranslator.com). Required. + `https://api.cognitive.microsofttranslator.com + `_). Required. :type endpoint: str - :keyword api_version: Mandatory API version parameter. Default value is "3.0". Note that - overriding this default value may result in unsupported behavior. + :keyword api_version: Mandatory API version parameter. Default value is "2025-10-01-preview". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ @@ -55,6 +52,7 @@ def __init__( # pylint: disable=missing-client-constructor-parameter-credential ) -> None: _endpoint = "{Endpoint}" self._config = TextTranslationClientConfiguration(endpoint=endpoint, **kwargs) + _policies = kwargs.pop("policies", None) if _policies is None: _policies = [ @@ -109,7 +107,7 @@ def send_request( async def close(self) -> None: await self._client.close() - async def __aenter__(self) -> "TextTranslationClient": + async def __aenter__(self) -> Self: await self._client.__aenter__() return self diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_configuration.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_configuration.py index 1f4d5c1f10f9..28cf60e9dd55 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_configuration.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_configuration.py @@ -13,22 +13,23 @@ from .._version import VERSION -class TextTranslationClientConfiguration: # pylint: disable=too-many-instance-attributes,name-too-long +class TextTranslationClientConfiguration: # pylint: disable=too-many-instance-attributes """Configuration for TextTranslationClient. Note that all parameters used to create this instance are saved as instance attributes. :param endpoint: Supported Text Translation endpoints (protocol and hostname, for example: - https://api.cognitive.microsofttranslator.com). Required. + `https://api.cognitive.microsofttranslator.com + `_). Required. :type endpoint: str - :keyword api_version: Mandatory API version parameter. Default value is "3.0". Note that - overriding this default value may result in unsupported behavior. + :keyword api_version: Mandatory API version parameter. Default value is "2025-10-01-preview". + Note that overriding this default value may result in unsupported behavior. :paramtype api_version: str """ def __init__(self, endpoint: str, **kwargs: Any) -> None: - api_version: str = kwargs.pop("api_version", "3.0") + api_version: str = kwargs.pop("api_version", "2025-10-01-preview") if endpoint is None: raise ValueError("Parameter 'endpoint' must not be None.") diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/__init__.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/__init__.py index 47ae0af6503a..57effd24ec31 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/__init__.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/__init__.py @@ -5,14 +5,19 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._patch import TextTranslationClientOperationsMixin +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import -from ._patch import patch_sdk as _patch_sdk +from ._operations import _TextTranslationClientOperationsMixin # type: ignore # pylint: disable=unused-import -__all__ = [ - "TextTranslationClientOperationsMixin", -] +from ._patch import __all__ as _patch_all +from ._patch import * +from ._patch import patch_sdk as _patch_sdk +__all__ = [] +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_operations.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_operations.py index 5b8d0cb5d9b5..b4a975acfbc7 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_operations.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_operations.py @@ -1,4 +1,4 @@ -# pylint: disable=too-many-lines,too-many-statements +# pylint: disable=line-too-long,useless-suppression # coding=utf-8 # -------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. @@ -6,13 +6,12 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- -# pylint: disable=R0914 +from collections.abc import MutableMapping from io import IOBase import json -import sys -from typing import Any, Callable, Dict, IO, List, Optional, Type, TypeVar, Union, overload +from typing import Any, Callable, IO, Optional, TypeVar, Union, overload -from azure.core import MatchConditions +from azure.core import AsyncPipelineClient, MatchConditions from azure.core.exceptions import ( ClientAuthenticationError, HttpResponseError, @@ -20,6 +19,8 @@ ResourceModifiedError, ResourceNotFoundError, ResourceNotModifiedError, + StreamClosedError, + StreamConsumedError, map_error, ) from azure.core.pipeline import PipelineResponse @@ -28,26 +29,24 @@ from azure.core.utils import case_insensitive_dict from ... import models as _models -from ..._model_base import SdkJSONEncoder, _deserialize from ..._operations._operations import ( - build_text_translation_find_sentence_boundaries_request, build_text_translation_get_supported_languages_request, - build_text_translation_lookup_dictionary_entries_request, - build_text_translation_lookup_dictionary_examples_request, build_text_translation_translate_request, build_text_translation_transliterate_request, ) -from .._vendor import TextTranslationClientMixinABC +from ..._utils.model_base import SdkJSONEncoder, _deserialize, _failsafe_deserialize +from ..._utils.utils import ClientMixinABC +from ..._validation import api_version_validation +from .._configuration import TextTranslationClientConfiguration -if sys.version_info >= (3, 9): - from collections.abc import MutableMapping -else: - from typing import MutableMapping # type: ignore # pylint: disable=ungrouped-imports +JSON = MutableMapping[str, Any] T = TypeVar("T") -ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, Dict[str, Any]], Any]] +ClsType = Optional[Callable[[PipelineResponse[HttpRequest, AsyncHttpResponse], T, dict[str, Any]], Any]] -class TextTranslationClientOperationsMixin(TextTranslationClientMixinABC): +class _TextTranslationClientOperationsMixin( + ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], TextTranslationClientConfiguration] +): @distributed_trace_async async def get_supported_languages( @@ -60,7 +59,6 @@ async def get_supported_languages( match_condition: Optional[MatchConditions] = None, **kwargs: Any ) -> _models.GetSupportedLanguagesResult: - # pylint: disable=line-too-long """Gets the set of languages currently supported by other operations of the Translator. Gets the set of languages currently supported by other operations of the Translator. @@ -69,7 +67,7 @@ async def get_supported_languages( value is None. :paramtype client_trace_id: str :keyword scope: A comma-separated list of names defining the group of languages to return. - Allowed group names are: ``translation``\\ , ``transliteration`` and ``dictionary``. + Allowed group names are: ``translation``, ``transliteration`` and ``dictionary``. If no scope is given, then all groups are returned, which is equivalent to passing ``scope=translation,transliteration,dictionary``. To decide which set of supported languages is appropriate for your scenario, see the description of the `response object @@ -95,88 +93,8 @@ async def get_supported_languages( MutableMapping :rtype: ~azure.ai.translation.text.models.GetSupportedLanguagesResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == { - "dictionary": { - "str": { - "dir": "str", # Directionality, which is rtl for - right-to-left languages or ltr for left-to-right languages. Required. - Known values are: "ltr" and "rtl". - "name": "str", # Display name of the language in the locale - requested via Accept-Language header. Required. - "nativeName": "str", # Display name of the language in the - locale native for this language. Required. - "translations": [ - { - "code": "str", # Language code identifying - the target language. Required. - "dir": "str", # Directionality, which is rtl - for right-to-left languages or ltr for left-to-right languages. - Required. Known values are: "ltr" and "rtl". - "name": "str", # Display name of the - language in the locale requested via Accept-Language header. - Required. - "nativeName": "str" # Display name of the - language in the locale native for this language. Required. - } - ] - } - }, - "translation": { - "str": { - "dir": "str", # Directionality, which is rtl for - right-to-left languages or ltr for left-to-right languages. Required. - Known values are: "ltr" and "rtl". - "name": "str", # Display name of the language in the locale - requested via Accept-Language header. Required. - "nativeName": "str" # Display name of the language in the - locale native for this language. Required. - } - }, - "transliteration": { - "str": { - "name": "str", # Display name of the language in the locale - requested via Accept-Language header. Required. - "nativeName": "str", # Display name of the language in the - locale native for this language. Required. - "scripts": [ - { - "code": "str", # Code identifying the - script. Required. - "dir": "str", # Directionality, which is rtl - for right-to-left languages or ltr for left-to-right languages. - Required. Known values are: "ltr" and "rtl". - "name": "str", # Display name of the script - in the locale requested via Accept-Language header. Required. - "nativeName": "str", # Display name of the - language in the locale native for the language. Required. - "toScripts": [ - { - "code": "str", # Code - identifying the script. Required. - "dir": "str", # - Directionality, which is rtl for right-to-left languages - or ltr for left-to-right languages. Required. Known - values are: "ltr" and "rtl". - "name": "str", # Display - name of the script in the locale requested via - Accept-Language header. Required. - "nativeName": "str" # - Display name of the language in the locale native for the - language. Required. - } - ] - } - ] - } - } - } """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -219,9 +137,15 @@ async def get_supported_languages( if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) response_headers = {} @@ -241,177 +165,53 @@ async def get_supported_languages( @overload async def translate( self, - body: List[_models.InputTextItem], + body: _models.TranslateBody, *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long + ) -> _models.TranslationResult: """Translate Text. Translate Text. :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword to_language: Specifies the language of the output text. The target language must be - one of the supported languages included - in the translation scope. For example, use to=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to=de&to=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :type body: ~azure.ai.translation.text.models.TranslateBody :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: list of TranslatedTextItem - :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult :raises ~azure.core.exceptions.HttpResponseError: + """ + + @overload + async def translate( + self, + body: JSON, + *, + client_trace_id: Optional[str] = None, + content_type: str = "application/json", + **kwargs: Any + ) -> _models.TranslationResult: + """Translate Text. + + Translate Text. - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] + :param body: Defines the content of the request. Required. + :type body: JSON + :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default + value is None. + :paramtype client_trace_id: str + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. + Default value is "application/json". + :paramtype content_type: str + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult + :raises ~azure.core.exceptions.HttpResponseError: """ @overload @@ -419,336 +219,55 @@ async def translate( self, body: IO[bytes], *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long + ) -> _models.TranslationResult: """Translate Text. Translate Text. :param body: Defines the content of the request. Required. :type body: IO[bytes] - :keyword to_language: Specifies the language of the output text. The target language must be - one of the supported languages included - in the translation scope. For example, use to=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to=de&to=it to translate to German and Italian. Required. - :paramtype to_language: list[str] :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: list of TranslatedTextItem - :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ @distributed_trace_async + @api_version_validation( + method_added_on="2025-10-01-preview", + params_added_on={"2025-10-01-preview": ["client_trace_id", "api_version", "content_type", "accept"]}, + api_versions_list=["2025-10-01-preview"], + ) async def translate( self, - body: Union[List[_models.InputTextItem], IO[bytes]], + body: Union[_models.TranslateBody, JSON, IO[bytes]], *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, **kwargs: Any - ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long + ) -> _models.TranslationResult: """Translate Text. Translate Text. - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] - :keyword to_language: Specifies the language of the output text. The target language must be - one of the supported languages included - in the translation scope. For example, use to=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to=de&to=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :param body: Defines the content of the request. Is one of the following types: TranslateBody, + JSON, IO[bytes] Required. + :type body: ~azure.ai.translation.text.models.TranslateBody or JSON or IO[bytes] :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool - :return: list of TranslatedTextItem - :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] + :return: TranslationResult. The TranslationResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TranslationResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -760,7 +279,7 @@ async def translate( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.TranslatedTextItem]] = kwargs.pop("cls", None) + cls: ClsType[_models.TranslationResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -770,19 +289,7 @@ async def translate( _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore _request = build_text_translation_translate_request( - to_language=to_language, client_trace_id=client_trace_id, - from_language=from_language, - text_type=text_type, - category=category, - profanity_action=profanity_action, - profanity_marker=profanity_marker, - include_alignment=include_alignment, - include_sentence_length=include_sentence_length, - suggested_from=suggested_from, - from_script=from_script, - to_script=to_script, - allow_fallback=allow_fallback, content_type=content_type, api_version=self._config.api_version, content=_content, @@ -803,9 +310,15 @@ async def translate( if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) response_headers = {} @@ -816,7 +329,7 @@ async def translate( if _stream: deserialized = response.iter_bytes() else: - deserialized = _deserialize(List[_models.TranslatedTextItem], response.json()) + deserialized = _deserialize(_models.TranslationResult, response.json()) if cls: return cls(pipeline_response, deserialized, response_headers) # type: ignore @@ -826,7 +339,7 @@ async def translate( @overload async def transliterate( self, - body: List[_models.InputTextItem], + body: _models.TransliterateBody, *, language: str, from_script: str, @@ -834,13 +347,13 @@ async def transliterate( client_trace_id: Optional[str] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TransliteratedText]: + ) -> _models.TransliterateResult: """Transliterate Text. Transliterate Text. :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] + :type body: ~azure.ai.translation.text.models.TransliterateBody :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -859,35 +372,15 @@ async def transliterate( :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: list of TransliteratedText - :rtype: list[~azure.ai.translation.text.models.TransliteratedText] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ @overload async def transliterate( self, - body: IO[bytes], + body: JSON, *, language: str, from_script: str, @@ -895,13 +388,13 @@ async def transliterate( client_trace_id: Optional[str] = None, content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TransliteratedText]: + ) -> _models.TransliterateResult: """Transliterate Text. Transliterate Text. :param body: Defines the content of the request. Required. - :type body: IO[bytes] + :type body: JSON :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -917,45 +410,32 @@ async def transliterate( :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str - :return: list of TransliteratedText - :rtype: list[~azure.ai.translation.text.models.TransliteratedText] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ - @distributed_trace_async + @overload async def transliterate( self, - body: Union[List[_models.InputTextItem], IO[bytes]], + body: IO[bytes], *, language: str, from_script: str, to_script: str, client_trace_id: Optional[str] = None, + content_type: str = "application/json", **kwargs: Any - ) -> List[_models.TransliteratedText]: + ) -> _models.TransliterateResult: """Transliterate Text. Transliterate Text. - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] + :param body: Defines the content of the request. Required. + :type body: IO[bytes] :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -971,951 +451,67 @@ async def transliterate( :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :return: list of TransliteratedText - :rtype: list[~azure.ai.translation.text.models.TransliteratedText] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] - """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = kwargs.pop("params", {}) or {} - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.TransliteratedText]] = kwargs.pop("cls", None) - - content_type = content_type or "application/json" - _content = None - if isinstance(body, (IOBase, bytes)): - _content = body - else: - _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - - _request = build_text_translation_transliterate_request( - language=language, - from_script=from_script, - to_script=to_script, - client_trace_id=client_trace_id, - content_type=content_type, - api_version=self._config.api_version, - content=_content, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), - } - _request.url = self._client.format_url(_request.url, **path_format_arguments) - - _stream = kwargs.pop("stream", False) - pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - _request, stream=_stream, **kwargs - ) - - response = pipeline_response.http_response - - if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) - raise HttpResponseError(response=response, model=error) - - response_headers = {} - response_headers["X-RequestId"] = self._deserialize("str", response.headers.get("X-RequestId")) - - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(List[_models.TransliteratedText], response.json()) - - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore - - @overload - async def find_sentence_boundaries( - self, - body: List[_models.InputTextItem], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - @overload - async def find_sentence_boundaries( - self, - body: IO[bytes], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str :keyword content_type: Body Parameter content-type. Content type parameter for binary body. Default value is "application/json". :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] """ @distributed_trace_async - async def find_sentence_boundaries( + @api_version_validation( + method_added_on="2025-10-01-preview", + params_added_on={ + "2025-10-01-preview": [ + "client_trace_id", + "language", + "from_script", + "to_script", + "api_version", + "content_type", + "accept", + ] + }, + api_versions_list=["2025-10-01-preview"], + ) + async def transliterate( self, - body: Union[List[_models.InputTextItem], IO[bytes]], + body: Union[_models.TransliterateBody, JSON, IO[bytes]], *, + language: str, + from_script: str, + to_script: str, client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. + ) -> _models.TransliterateResult: + """Transliterate Text. - Find Sentence Boundaries. + Transliterate Text. - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. + :param body: Defines the content of the request. Is one of the following types: + TransliterateBody, JSON, IO[bytes] Required. + :type body: ~azure.ai.translation.text.models.TransliterateBody or JSON or IO[bytes] + :keyword language: Specifies the language of the text to convert from one script to another. + Possible languages are listed in the transliteration scope obtained by querying the service + for its supported languages. Required. :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = kwargs.pop("params", {}) or {} - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.BreakSentenceItem]] = kwargs.pop("cls", None) - - content_type = content_type or "application/json" - _content = None - if isinstance(body, (IOBase, bytes)): - _content = body - else: - _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - - _request = build_text_translation_find_sentence_boundaries_request( - client_trace_id=client_trace_id, - language=language, - script=script, - content_type=content_type, - api_version=self._config.api_version, - content=_content, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), - } - _request.url = self._client.format_url(_request.url, **path_format_arguments) - - _stream = kwargs.pop("stream", False) - pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - _request, stream=_stream, **kwargs - ) - - response = pipeline_response.http_response - - if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) - raise HttpResponseError(response=response, model=error) - - response_headers = {} - response_headers["X-RequestId"] = self._deserialize("str", response.headers.get("X-RequestId")) - - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(List[_models.BreakSentenceItem], response.json()) - - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore - - @overload - async def lookup_dictionary_entries( - self, - body: List[_models.InputTextItem], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "confidence": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @overload - async def lookup_dictionary_entries( - self, - body: IO[bytes], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "confidence": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @distributed_trace_async - async def lookup_dictionary_entries( - self, - body: Union[List[_models.InputTextItem], IO[bytes]], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Is either a [InputTextItem] type or a - IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] or IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "confidence": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { - 401: ClientAuthenticationError, - 404: ResourceNotFoundError, - 409: ResourceExistsError, - 304: ResourceNotModifiedError, - } - error_map.update(kwargs.pop("error_map", {}) or {}) - - _headers = case_insensitive_dict(kwargs.pop("headers", {}) or {}) - _params = kwargs.pop("params", {}) or {} - - content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.DictionaryLookupItem]] = kwargs.pop("cls", None) - - content_type = content_type or "application/json" - _content = None - if isinstance(body, (IOBase, bytes)): - _content = body - else: - _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - - _request = build_text_translation_lookup_dictionary_entries_request( - from_language=from_language, - to_language=to_language, - client_trace_id=client_trace_id, - content_type=content_type, - api_version=self._config.api_version, - content=_content, - headers=_headers, - params=_params, - ) - path_format_arguments = { - "Endpoint": self._serialize.url("self._config.endpoint", self._config.endpoint, "str", skip_quote=True), - } - _request.url = self._client.format_url(_request.url, **path_format_arguments) - - _stream = kwargs.pop("stream", False) - pipeline_response: PipelineResponse = await self._client._pipeline.run( # type: ignore # pylint: disable=protected-access - _request, stream=_stream, **kwargs - ) - - response = pipeline_response.http_response - - if response.status_code not in [200]: - if _stream: - await response.read() # Load the body in memory and close the socket - map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) - raise HttpResponseError(response=response, model=error) - - response_headers = {} - response_headers["X-RequestId"] = self._deserialize("str", response.headers.get("X-RequestId")) - - if _stream: - deserialized = response.iter_bytes() - else: - deserialized = _deserialize(List[_models.DictionaryLookupItem], response.json()) - - if cls: - return cls(pipeline_response, deserialized, response_headers) # type: ignore - - return deserialized # type: ignore - - @overload - async def lookup_dictionary_examples( - self, - body: List[_models.DictionaryExampleTextItem], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryExampleItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Examples. - - Lookup Dictionary Examples. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.DictionaryExampleTextItem] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryExampleItem - :rtype: list[~azure.ai.translation.text.models.DictionaryExampleItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str", # Text to translate. Required. - "translation": "str" # A string specifying the translated text - previously returned by the Dictionary lookup operation. This should be the - value from the normalizedTarget field in the translations list of the - Dictionary lookup response. The service will return examples for the - specific source-target word-pair. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "examples": [ - { - "sourcePrefix": "str", # The string to concatenate - before the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceSuffix": "str", # The string to concatenate - after the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceTerm": "str", # A string equal to the actual - term looked up. The string is added with sourcePrefix and - sourceSuffix to form the complete example. Its value is separated so - it can be marked in a user interface, e.g., by bolding it. Required. - "targetPrefix": "str", # A string similar to - sourcePrefix but for the target. Required. - "targetSuffix": "str", # A string similar to - sourceSuffix but for the target. Required. - "targetTerm": "str" # A string similar to sourceTerm - but for the target. Required. - } - ], - "normalizedSource": "str", # A string giving the normalized form of - the source term. Generally, this should be identical to the value of the Text - field at the matching list index in the body of the request. Required. - "normalizedTarget": "str" # A string giving the normalized form of - the target term. Generally, this should be identical to the value of the - Translation field at the matching list index in the body of the request. - Required. - } - ] - """ - - @overload - async def lookup_dictionary_examples( - self, - body: IO[bytes], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryExampleItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Examples. - - Lookup Dictionary Examples. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryExampleItem - :rtype: list[~azure.ai.translation.text.models.DictionaryExampleItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "examples": [ - { - "sourcePrefix": "str", # The string to concatenate - before the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceSuffix": "str", # The string to concatenate - after the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceTerm": "str", # A string equal to the actual - term looked up. The string is added with sourcePrefix and - sourceSuffix to form the complete example. Its value is separated so - it can be marked in a user interface, e.g., by bolding it. Required. - "targetPrefix": "str", # A string similar to - sourcePrefix but for the target. Required. - "targetSuffix": "str", # A string similar to - sourceSuffix but for the target. Required. - "targetTerm": "str" # A string similar to sourceTerm - but for the target. Required. - } - ], - "normalizedSource": "str", # A string giving the normalized form of - the source term. Generally, this should be identical to the value of the Text - field at the matching list index in the body of the request. Required. - "normalizedTarget": "str" # A string giving the normalized form of - the target term. Generally, this should be identical to the value of the - Translation field at the matching list index in the body of the request. - Required. - } - ] - """ - - @distributed_trace_async - async def lookup_dictionary_examples( - self, - body: Union[List[_models.DictionaryExampleTextItem], IO[bytes]], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - **kwargs: Any - ) -> List[_models.DictionaryExampleItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Examples. - - Lookup Dictionary Examples. - - :param body: Defines the content of the request. Is either a [DictionaryExampleTextItem] type - or a IO[bytes] type. Required. - :type body: list[~azure.ai.translation.text.models.DictionaryExampleTextItem] or IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str + :keyword from_script: Specifies the script used by the input text. Look up supported languages + using the transliteration scope, + to find input scripts available for the selected language. Required. + :paramtype from_script: str + :keyword to_script: Specifies the output script. Look up supported languages using the + transliteration scope, to find output + scripts available for the selected combination of input language and input script. Required. + :paramtype to_script: str :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :return: list of DictionaryExampleItem - :rtype: list[~azure.ai.translation.text.models.DictionaryExampleItem] + :return: TransliterateResult. The TransliterateResult is compatible with MutableMapping + :rtype: ~azure.ai.translation.text.models.TransliterateResult :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "examples": [ - { - "sourcePrefix": "str", # The string to concatenate - before the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceSuffix": "str", # The string to concatenate - after the value of sourceTerm to form a complete example. Do not add - a space character, since it is already there when it should be. This - value may be an empty string. Required. - "sourceTerm": "str", # A string equal to the actual - term looked up. The string is added with sourcePrefix and - sourceSuffix to form the complete example. Its value is separated so - it can be marked in a user interface, e.g., by bolding it. Required. - "targetPrefix": "str", # A string similar to - sourcePrefix but for the target. Required. - "targetSuffix": "str", # A string similar to - sourceSuffix but for the target. Required. - "targetTerm": "str" # A string similar to sourceTerm - but for the target. Required. - } - ], - "normalizedSource": "str", # A string giving the normalized form of - the source term. Generally, this should be identical to the value of the Text - field at the matching list index in the body of the request. Required. - "normalizedTarget": "str" # A string giving the normalized form of - the target term. Generally, this should be identical to the value of the - Translation field at the matching list index in the body of the request. - Required. - } - ] """ - error_map: MutableMapping[int, Type[HttpResponseError]] = { + error_map: MutableMapping = { 401: ClientAuthenticationError, 404: ResourceNotFoundError, 409: ResourceExistsError, @@ -1927,7 +523,7 @@ async def lookup_dictionary_examples( _params = kwargs.pop("params", {}) or {} content_type: Optional[str] = kwargs.pop("content_type", _headers.pop("Content-Type", None)) - cls: ClsType[List[_models.DictionaryExampleItem]] = kwargs.pop("cls", None) + cls: ClsType[_models.TransliterateResult] = kwargs.pop("cls", None) content_type = content_type or "application/json" _content = None @@ -1936,9 +532,10 @@ async def lookup_dictionary_examples( else: _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True) # type: ignore - _request = build_text_translation_lookup_dictionary_examples_request( - from_language=from_language, - to_language=to_language, + _request = build_text_translation_transliterate_request( + language=language, + from_script=from_script, + to_script=to_script, client_trace_id=client_trace_id, content_type=content_type, api_version=self._config.api_version, @@ -1960,9 +557,15 @@ async def lookup_dictionary_examples( if response.status_code not in [200]: if _stream: - await response.read() # Load the body in memory and close the socket + try: + await response.read() # Load the body in memory and close the socket + except (StreamConsumedError, StreamClosedError): + pass map_error(status_code=response.status_code, response=response, error_map=error_map) - error = _deserialize(_models.ErrorResponse, response.json()) + error = _failsafe_deserialize( + _models.ErrorResponse, + response, + ) raise HttpResponseError(response=response, model=error) response_headers = {} @@ -1971,7 +574,7 @@ async def lookup_dictionary_examples( if _stream: deserialized = response.iter_bytes() else: - deserialized = _deserialize(List[_models.DictionaryExampleItem], response.json()) + deserialized = _deserialize(_models.TransliterateResult, response.json()) if cls: return cls(pipeline_response, deserialized, response_headers) # type: ignore diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_patch.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_patch.py index 3506e20e8701..8a76d9be546b 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_patch.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_operations/_patch.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression,too-many-lines # ------------------------------------ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. @@ -8,578 +9,224 @@ Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize """ +from collections.abc import MutableMapping from typing import Any, cast, IO, List, Optional, overload, Union +from azure.core import MatchConditions + +JSON = MutableMapping[str, Any] +from azure.core.pipeline.transport import AsyncHttpResponse +from azure.core.rest import HttpRequest +from aiohttp import ClientSession from ... import models as _models -from ._operations import TextTranslationClientOperationsMixin as TextTranslationClientOperationsMixinGenerated +from ..._configuration import TextTranslationClientConfiguration +from ..._utils.utils import ClientMixinABC +from ._operations import _TextTranslationClientOperationsMixin as _TextTranslationClientOperationsMixinGenerated + + +class _TextTranslationClientOperationsMixin( + ClientMixinABC[ClientSession, TextTranslationClientConfiguration] +): + """Mixin class that delegates to the generated operations class while providing custom method signatures.""" + + def _get_generated_operations(self) -> _TextTranslationClientOperationsMixinGenerated: + """Get an instance of the generated operations mixin. + + This creates a wrapper object that shares the same _client, _config, _serialize, and _deserialize + attributes with self, allowing the generated operations to work correctly. + """ + if not hasattr(self, "_generated_ops_cache"): + # Create a lightweight wrapper that shares attributes with self + class GeneratedOpsWrapper(_TextTranslationClientOperationsMixinGenerated): + pass + + wrapper = GeneratedOpsWrapper.__new__(GeneratedOpsWrapper) + # Share the client infrastructure from self + wrapper._client = self._client # type: ignore + wrapper._config = self._config # type: ignore + wrapper._serialize = self._serialize # type: ignore + wrapper._deserialize = self._deserialize # type: ignore + self._generated_ops_cache = wrapper # type: ignore + return self._generated_ops_cache # type: ignore + + async def get_supported_languages( + self, + *, + client_trace_id: Optional[str] = None, + scope: Optional[str] = None, + accept_language: Optional[str] = None, + etag: Optional[str] = None, + match_condition: Optional[MatchConditions] = None, + **kwargs: Any + ) -> _models.GetSupportedLanguagesResult: + """Gets the set of languages currently supported by other operations of the Translator. + + Gets the set of languages currently supported by other operations of the Translator. + :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default + value is None. + :paramtype client_trace_id: str + :keyword scope: A comma-separated list of names defining the group of languages to return. + Allowed group names are: ``translation``, ``transliteration`` and ``dictionary``. + If no scope is given, then all groups are returned, which is equivalent to passing + ``scope=translation,transliteration,dictionary``. To decide which set of supported languages + is appropriate for your scenario, see the description of the `response object + <#response-body>`_. Default value is None. + :paramtype scope: str + :keyword accept_language: The language to use for user interface strings. Some of the fields in + the response are names of languages or + names of regions. Use this parameter to define the language in which these names are returned. + The language is specified by providing a well-formed BCP 47 language tag. For instance, use + the value ``fr`` + to request names in French or use the value ``zh-Hant`` to request names in Chinese + Traditional. + Names are provided in the English language when a target language is not specified or when + localization + is not available. Default value is None. + :paramtype accept_language: str + :keyword etag: check if resource is changed. Set None to skip checking etag. Default value is + None. + :paramtype etag: str + :keyword match_condition: The match condition to use upon the etag. Default value is None. + :paramtype match_condition: ~azure.core.MatchConditions + :return: GetSupportedLanguagesResult. The GetSupportedLanguagesResult is compatible with + MutableMapping + :rtype: ~azure.ai.translation.text.models.GetSupportedLanguagesResult + :raises ~azure.core.exceptions.HttpResponseError: + """ + return await self._get_generated_operations().get_supported_languages( + client_trace_id=client_trace_id, + scope=scope, + accept_language=accept_language, + etag=etag, + match_condition=match_condition, + **kwargs + ) -class TextTranslationClientOperationsMixin(TextTranslationClientOperationsMixinGenerated): - @overload + @overload # type: ignore[override] async def translate( self, body: List[str], *, to_language: List[str], - client_trace_id: Optional[str] = None, from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, + client_trace_id: Optional[str] = None, content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long """Translate Text. - Translate Text. + Translates texts to the specified target languages. - :param body: Defines the content of the request. Required. + :param body: List of text strings to translate. Required. :type body: list[str] - :keyword to_language: Specifies the language of the output text. The target language must be one of the - supported languages included - in the translation scope. For example, use to_language=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to_language=de&to_language=it to translate to German and Italian. Required. + :keyword to_language: List of target languages of the translation outputs. The target language(s) + must be one of the supported languages included in the translation scope. Required. :paramtype to_language: list[str] + :keyword from_language: Language of the input text. If not specified, automatic language detection + is applied to determine the source language. Default value is None. + :paramtype from_language: str :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TranslatedTextItem :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - str" # Text to translate. Required. - ] - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ - @overload + @overload # type: ignore[override] async def translate( self, - body: List[_models.InputTextItem], + body: List[_models.TranslateInputItem], *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long - """Translate Text. + """Translate text. - Translate Text. + Translates a list of input items with specified configurations. - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword to_language: Specifies the language of the output text. The target language must be one of the - supported languages included - in the translation scope. For example, use to_language=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to_language=de&to_language=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :param body: List of TranslateInputItem objects containing text and configurations for translation. Required. + :type body: list[~azure.ai.translation.text.models.TranslateInputItem] :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TranslatedTextItem :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ - @overload + @overload # type: ignore[override] async def translate( self, - body: IO[bytes], + body: JSON, *, - to_language: List[str], client_trace_id: Optional[str] = None, - from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - # pylint: disable=line-too-long - """Translate Text. + """Translate text. - Translate Text. + Translates text using a JSON body. - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword to_language: Specifies the language of the output text. The target language must be one of the - supported languages included - in the translation scope. For example, use to_language=de to translate to German. - It's possible to translate to multiple languages simultaneously by repeating the parameter in - the query string. - For example, use to_language=de&to_language=it to translate to German and Italian. Required. - :paramtype to_language: list[str] + :param body: JSON body containing translation request. Required. + :type body: JSON :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword from_language: Specifies the language of the input text. Find which languages are - available to translate from by - looking up supported languages using the translation scope. If the from parameter isn't - specified, - automatic language detection is applied to determine the source language. - - You must use the from parameter rather than autodetection when using the dynamic dictionary - feature. - Note: the dynamic dictionary feature is case-sensitive. Default value is None. - :paramtype from_language: str - :keyword text_type: Defines whether the text being translated is plain text or HTML text. Any - HTML needs to be a well-formed, - complete element. Possible values are: plain (default) or html. Known values are: "Plain" and - "Html". Default value is None. - :paramtype text_type: str or ~azure.ai.translation.text.models.TextType - :keyword category: A string specifying the category (domain) of the translation. This parameter - is used to get translations - from a customized system built with Custom Translator. Add the Category ID from your Custom - Translator - project details to this parameter to use your deployed customized system. Default value is: - general. Default value is None. - :paramtype category: str - :keyword profanity_action: Specifies how profanities should be treated in translations. - Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", - "Marked", and "Deleted". Default value is None. - :paramtype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction - :keyword profanity_marker: Specifies how profanities should be marked in translations. - Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". - Default value is None. - :paramtype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker - :keyword include_alignment: Specifies whether to include alignment projection from source text - to translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_alignment: bool - :keyword include_sentence_length: Specifies whether to include sentence boundaries for the - input text and the translated text. - Possible values are: true or false (default). Default value is None. - :paramtype include_sentence_length: bool - :keyword suggested_from: Specifies a fallback language if the language of the input text can't - be identified. - Language autodetection is applied when the from parameter is omitted. If detection fails, - the suggestedFrom language will be assumed. Default value is None. - :paramtype suggested_from: str - :keyword from_script: Specifies the script of the input text. Default value is None. - :paramtype from_script: str - :keyword to_script: Specifies the script of the translated text. Default value is None. - :paramtype to_script: str - :keyword allow_fallback: Specifies that the service is allowed to fall back to a general system - when a custom system doesn't exist. - Possible values are: true (default) or false. - - allowFallback=false specifies that the translation should only use systems trained for the - category specified - by the request. If a translation for language X to language Y requires chaining through a - pivot language E, - then all the systems in the chain (X → E and E → Y) will need to be custom and have the same - category. - If no system is found with the specific category, the request will return a 400 status code. - allowFallback=true - specifies that the service is allowed to fall back to a general system when a custom system - doesn't exist. Default value is None. - :paramtype allow_fallback: bool - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TranslatedTextItem :rtype: list[~azure.ai.translation.text.models.TranslatedTextItem] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "translations": [ - { - "text": "str", # A string giving the translated - text. Required. - "to": "str", # A string representing the language - code of the target language. Required. - "alignment": { - "proj": "str" # Maps input text to - translated text. The alignment information is only provided when - the request parameter includeAlignment is true. Alignment is - returned as a string value of the following format: - [[SourceTextStartIndex]:[SourceTextEndIndex]"u2013[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the - languages, and space separates the words. One word may align - with zero, one, or multiple words in the other language, and the - aligned words may be non-contiguous. When no alignment - information is available, the alignment element will be empty. - Required. - }, - "sentLen": { - "srcSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the input text. The length - of the array is the number of sentences, and the values are - the length of each sentence. Required. - ], - "transSentLen": [ - 0 # An integer array representing - the lengths of the sentences in the translated text. The - length of the array is the number of sentences, and the - values are the length of each sentence. Required. - ] - }, - "transliteration": { - "script": "str", # A string specifying the - script used in the output. Required. - "text": "str" # A string which is the result - of converting the input string to the output script. Required. - } - } - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - }, - "sourceText": { - "text": "str" # Input text in the default script of the - source language. Required. - } - } - ] """ async def translate( # pyright: ignore[reportIncompatibleMethodOverride] self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], + body: Union[List[str], List[_models.TranslateInputItem], JSON, IO[bytes]], *, - to_language: List[str], - client_trace_id: Optional[str] = None, + to_language: Optional[List[str]] = None, from_language: Optional[str] = None, - text_type: Optional[Union[str, _models.TextType]] = None, - category: Optional[str] = None, - profanity_action: Optional[Union[str, _models.ProfanityAction]] = None, - profanity_marker: Optional[Union[str, _models.ProfanityMarker]] = None, - include_alignment: Optional[bool] = None, - include_sentence_length: Optional[bool] = None, - suggested_from: Optional[str] = None, - from_script: Optional[str] = None, - to_script: Optional[str] = None, - allow_fallback: Optional[bool] = None, + client_trace_id: Optional[str] = None, + content_type: str = "application/json", **kwargs: Any ) -> List[_models.TranslatedTextItem]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items + request_body: Union[_models.TranslateBody, JSON, IO[bytes]] + + if isinstance(body, list): + if all(isinstance(item, _models.TranslateInputItem) for item in body): + # Handle List[TranslateInputItem] + request_body = _models.TranslateBody(inputs=cast(List[_models.TranslateInputItem], body)) + elif all(isinstance(item, str) for item in body): + # Handle List[str] - convert to TranslateInputItem with targets + targets = [_models.TranslationTarget(language=lang) for lang in (to_language or [])] + inputs = [ + _models.TranslateInputItem(text=cast(str, text), targets=targets, language=from_language) + for text in cast(List[str], body) + ] + request_body = _models.TranslateBody(inputs=inputs) + else: + raise ValueError( + "Invalid body type: list must contain either all strings or all TranslateInputItem objects" + ) else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) + # Handle JSON (dict/MutableMapping) or IO[bytes] + request_body = body # type: ignore - return await super().translate( - body=request_body, - to_language=to_language, - client_trace_id=client_trace_id, - from_language=from_language, - text_type=text_type, - category=category, - profanity_action=profanity_action, - profanity_marker=profanity_marker, - include_alignment=include_alignment, - include_sentence_length=include_sentence_length, - suggested_from=suggested_from, - from_script=from_script, - to_script=to_script, - allow_fallback=allow_fallback, - **kwargs + result = await self._get_generated_operations().translate( + body=request_body, content_type=content_type, client_trace_id=client_trace_id, **kwargs ) - @overload + return result.value + + @overload # type: ignore[override] async def transliterate( self, body: List[str], @@ -618,29 +265,9 @@ async def transliterate( :return: list of TransliteratedText :rtype: list[~azure.ai.translation.text.models.TransliteratedText] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ - @overload + @overload # type: ignore[override] async def transliterate( self, body: List[_models.InputTextItem], @@ -679,32 +306,12 @@ async def transliterate( :return: list of TransliteratedText :rtype: list[~azure.ai.translation.text.models.TransliteratedText] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ - @overload + @overload # type: ignore[override] async def transliterate( self, - body: IO[bytes], + body: JSON, *, language: str, from_script: str, @@ -715,10 +322,10 @@ async def transliterate( ) -> List[_models.TransliteratedText]: """Transliterate Text. - Transliterate Text. + Transliterates text using a JSON body. - :param body: Defines the content of the request. Required. - :type body: IO[bytes] + :param body: JSON body containing transliteration request. Required. + :type body: JSON :keyword language: Specifies the language of the text to convert from one script to another. Possible languages are listed in the transliteration scope obtained by querying the service for its supported languages. Required. @@ -734,633 +341,51 @@ async def transliterate( :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default value is None. :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. + :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. Default value is "application/json". :paramtype content_type: str :return: list of TransliteratedText :rtype: list[~azure.ai.translation.text.models.TransliteratedText] :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "script": "str", # A string specifying the script used in the - output. Required. - "text": "str" # A string which is the result of converting the input - string to the output script. Required. - } - ] """ async def transliterate( # pyright: ignore[reportIncompatibleMethodOverride] self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], + body: Union[List[str], List[_models.InputTextItem], JSON, IO[bytes]], *, language: str, from_script: str, to_script: str, client_trace_id: Optional[str] = None, + content_type: str = "application/json", **kwargs: Any ) -> List[_models.TransliteratedText]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items + request_body: Union[_models.TransliterateBody, JSON, IO[bytes]] + if isinstance(body, list): + inputs: List[_models.InputTextItem] = [] + if all(isinstance(item, _models.InputTextItem) for item in body): + inputs = cast(List[_models.InputTextItem], body) + elif all(isinstance(item, str) for item in body): + for text in body: + inputs.append(_models.InputTextItem(text=cast(str, text))) + request_body = _models.TransliterateBody(inputs=inputs) else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) + # Handle JSON (dict) or IO[bytes] + request_body = body # type: ignore - return await super().transliterate( + result = await self._get_generated_operations().transliterate( body=request_body, language=language, from_script=from_script, to_script=to_script, + content_type=content_type, client_trace_id=client_trace_id, - **kwargs - ) - - @overload - async def find_sentence_boundaries( - self, - body: List[str], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: list[str] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - @overload - async def find_sentence_boundaries( - self, - body: List[_models.InputTextItem], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - @overload - async def find_sentence_boundaries( - self, - body: IO[bytes], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - # pylint: disable=line-too-long - """Find Sentence Boundaries. - - Find Sentence Boundaries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword language: Language tag identifying the language of the input text. - If a code isn't specified, automatic language detection will be applied. Default value is - None. - :paramtype language: str - :keyword script: Script tag identifying the script used by the input text. - If a script isn't specified, the default script of the language will be assumed. Default value - is None. - :paramtype script: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of BreakSentenceItem - :rtype: list[~azure.ai.translation.text.models.BreakSentenceItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "sentLen": [ - 0 # An integer array representing the lengths of the - sentences in the input text. The length of the array is the number of - sentences, and the values are the length of each sentence. Required. - ], - "detectedLanguage": { - "language": "str", # A string representing the code of the - detected language. Required. - "score": 0.0 # A float value indicating the confidence in - the result. The score is between zero and one and a low score indicates a - low confidence. Required. - } - } - ] - """ - - async def find_sentence_boundaries( # pyright: ignore[reportIncompatibleMethodOverride] - self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], - *, - client_trace_id: Optional[str] = None, - language: Optional[str] = None, - script: Optional[str] = None, - **kwargs: Any - ) -> List[_models.BreakSentenceItem]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items - - else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) - - return await super().find_sentence_boundaries( - body=request_body, language=language, script=script, client_trace_id=client_trace_id, **kwargs - ) - - @overload - async def lookup_dictionary_entries( - self, - body: List[str], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: list[str] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "score": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @overload - async def lookup_dictionary_entries( - self, - body: List[_models.InputTextItem], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: list[~azure.ai.translation.text.models.InputTextItem] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for JSON body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # JSON input template you can fill out and use as your body input. - body = [ - { - "text": "str" # Text to translate. Required. - } - ] - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "score": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - @overload - async def lookup_dictionary_entries( - self, - body: IO[bytes], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - content_type: str = "application/json", - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - # pylint: disable=line-too-long - """Lookup Dictionary Entries. - - Lookup Dictionary Entries. - - :param body: Defines the content of the request. Required. - :type body: IO[bytes] - :keyword from_language: Specifies the language of the input text. - The source language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype from_language: str - :keyword to_language: Specifies the language of the output text. - The target language must be one of the supported languages included in the dictionary scope. - Required. - :paramtype to_language: str - :keyword client_trace_id: A client-generated GUID to uniquely identify the request. Default - value is None. - :paramtype client_trace_id: str - :keyword content_type: Body Parameter content-type. Content type parameter for binary body. - Default value is "application/json". - :paramtype content_type: str - :return: list of DictionaryLookupItem - :rtype: list[~azure.ai.translation.text.models.DictionaryLookupItem] - :raises ~azure.core.exceptions.HttpResponseError: - - Example: - .. code-block:: python - - # response body for status code(s): 200 - response == [ - { - "displaySource": "str", # A string giving the source term in a form - best suited for end-user display. For example, if the input is "JOHN", the - display form will reflect the usual spelling of the name: "John". Required. - "normalizedSource": "str", # A string giving the normalized form of - the source term. For example, if the request is "JOHN", the normalized form - will be "john". The content of this field becomes the input to lookup - examples. Required. - "translations": [ - { - "backTranslations": [ - { - "displayText": "str", # A string - giving the source term that is a back-translation of the - target in a form best suited for end-user display. Required. - "frequencyCount": 0, # An integer - representing the frequency of this translation pair in the - data. The main purpose of this field is to provide a user - interface with a means to sort back-translations so the most - frequent terms are first. Required. - "normalizedText": "str", # A string - giving the normalized form of the source term that is a - back-translation of the target. This value should be used as - input to lookup examples. Required. - "numExamples": 0 # An integer - representing the number of examples that are available for - this translation pair. Actual examples must be retrieved with - a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user - interface may add a hyperlink to the back-translation if the - number of examples is greater than zero and show the - back-translation as plain text if there are no examples. Note - that the actual number of examples returned by a call to - lookup examples may be less than numExamples, because - additional filtering may be applied on the fly to remove - "bad" examples. Required. - } - ], - "score": 0.0, # A value between 0.0 and 1.0 - which represents the "confidence" (or perhaps more accurately, - "probability in the training data") of that translation pair. The - sum of confidence scores for one source word may or may not sum to - 1.0. Required. - "displayTarget": "str", # A string giving the term - in the target language and in a form best suited for end-user - display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" - will have normalizedTarget = "juan" and displayTarget = "Juan". - Required. - "normalizedTarget": "str", # A string giving the - normalized form of this term in the target language. This value - should be used as input to lookup examples. Required. - "posTag": "str", # A string associating this term - with a part-of-speech tag. Required. - "prefixWord": "str" # A string giving the word to - display as a prefix of the translation. Currently, this is the - gendered determiner of nouns, in languages that have gendered - determiners. For example, the prefix of the Spanish word "mosca" is - "la", since "mosca" is a feminine noun in Spanish. This is only - dependent on the translation, and not on the source. If there is no - prefix, it will be the empty string. Required. - } - ] - } - ] - """ - - async def lookup_dictionary_entries( # pyright: ignore[reportIncompatibleMethodOverride] - self, - body: Union[List[str], List[_models.InputTextItem], IO[bytes]], - *, - from_language: str, - to_language: str, - client_trace_id: Optional[str] = None, - **kwargs: Any - ) -> List[_models.DictionaryLookupItem]: - request_body: Union[List[_models.InputTextItem], IO[bytes]] - if isinstance(body, list) and all(isinstance(item, str) for item in body): - input_text_items: List[_models.InputTextItem] = [] - for text in body: - input_text_items.append(_models.InputTextItem(text=cast(str, text))) - request_body = input_text_items - else: - request_body = cast(Union[List[_models.InputTextItem], IO[bytes]], body) - - return await super().lookup_dictionary_entries( - body=request_body, - from_language=from_language, - to_language=to_language, - client_trace_id=client_trace_id, - **kwargs ) + return result.value __all__: List[str] = [ - "TextTranslationClientOperationsMixin" + "_TextTranslationClientOperationsMixin" ] # Add all objects you want publicly available to users at this package level diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_patch.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_patch.py index 235e7539dd94..153ee88e2ccb 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_patch.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/aio/_patch.py @@ -88,9 +88,7 @@ def set_authentication_policy(credential, kwargs): scope: str = kwargs.pop("audience", DEFAULT_ENTRA_ID_SCOPE) if not is_cognitive_services_scope(scope): scope = scope.rstrip("/").rstrip(DEFAULT_SCOPE) + DEFAULT_SCOPE - kwargs["authentication_policy"] = AsyncBearerTokenCredentialPolicy( - credential, scope - ) + kwargs["authentication_policy"] = AsyncBearerTokenCredentialPolicy(credential, scope) class TextTranslationClient(ServiceClientGenerated): @@ -133,7 +131,7 @@ class TextTranslationClient(ServiceClientGenerated): :keyword str region: Used for National Clouds. :keyword str resource_id: Used with both a TokenCredential combined with a region. :keyword str audience: Scopes of the credentials. - :keyword str api_version: Default value is "3.0". Note that overriding this default value may + :keyword str api_version: Default value is "2025-10-01-preview". Note that overriding this default value may result in unsupported behavior. """ @@ -146,7 +144,7 @@ def __init__( endpoint: Optional[str] = None, resource_id: Optional[str] = None, audience: Optional[str] = None, - api_version: str = "3.0", + api_version: str = "2025-10-01-preview", **kwargs ): ... @@ -157,15 +155,15 @@ def __init__( credential: AzureKeyCredential, region: Optional[str] = None, endpoint: Optional[str] = None, - api_version: str = "3.0", + api_version: str = "2025-10-01-preview", **kwargs ): ... @overload - def __init__(self, *, endpoint: str, api_version: str = "3.0", **kwargs): ... + def __init__(self, *, endpoint: str, api_version: str = "2025-10-01-preview", **kwargs): ... def __init__(self, **kwargs): - api_version = kwargs.get("api_version", "3.0") + api_version = kwargs.get("api_version", "2025-10-01-preview") set_authentication_policy(kwargs.get("credential"), kwargs) translation_endpoint = get_translation_endpoint( kwargs.pop("endpoint", "https://api.cognitive.microsofttranslator.com"), api_version diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/__init__.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/__init__.py index da99621bc1e2..101465544986 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/__init__.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/__init__.py @@ -5,63 +5,64 @@ # Code generated by Microsoft (R) Python Code Generator. # Changes may cause incorrect behavior and will be lost if the code is regenerated. # -------------------------------------------------------------------------- +# pylint: disable=wrong-import-position -from ._models import BackTranslation -from ._models import BreakSentenceItem -from ._models import DetectedLanguage -from ._models import DictionaryExample -from ._models import DictionaryExampleItem -from ._models import DictionaryExampleTextItem -from ._models import DictionaryLookupItem -from ._models import DictionaryTranslation -from ._models import ErrorDetails -from ._models import ErrorResponse -from ._models import GetSupportedLanguagesResult -from ._models import InputTextItem -from ._models import LanguageScript -from ._models import SentenceBoundaries -from ._models import SourceDictionaryLanguage -from ._models import SourceText -from ._models import TargetDictionaryLanguage -from ._models import TranslatedTextAlignment -from ._models import TranslatedTextItem -from ._models import TranslationLanguage -from ._models import TranslationText -from ._models import TransliterableScript -from ._models import TransliteratedText -from ._models import TransliterationLanguage +from typing import TYPE_CHECKING -from ._enums import LanguageDirectionality -from ._enums import ProfanityAction -from ._enums import ProfanityMarker -from ._enums import TextType +if TYPE_CHECKING: + from ._patch import * # pylint: disable=unused-wildcard-import + + +from ._models import ( # type: ignore + DetectedLanguage, + ErrorDetails, + ErrorResponse, + GetSupportedLanguagesResult, + InputTextItem, + LanguageScript, + ReferenceTextPair, + TranslateBody, + TranslateInputItem, + TranslatedTextItem, + TranslationLanguage, + TranslationResult, + TranslationTarget, + TranslationText, + TransliterableScript, + TransliterateBody, + TransliterateResult, + TransliteratedText, + TransliterationLanguage, +) + +from ._enums import ( # type: ignore + LanguageDirectionality, + ProfanityAction, + ProfanityMarker, + TextType, +) from ._patch import __all__ as _patch_all -from ._patch import * # pylint: disable=unused-wildcard-import +from ._patch import * from ._patch import patch_sdk as _patch_sdk __all__ = [ - "BackTranslation", - "BreakSentenceItem", "DetectedLanguage", - "DictionaryExample", - "DictionaryExampleItem", - "DictionaryExampleTextItem", - "DictionaryLookupItem", - "DictionaryTranslation", "ErrorDetails", "ErrorResponse", "GetSupportedLanguagesResult", "InputTextItem", "LanguageScript", - "SentenceBoundaries", - "SourceDictionaryLanguage", - "SourceText", - "TargetDictionaryLanguage", - "TranslatedTextAlignment", + "ReferenceTextPair", + "TranslateBody", + "TranslateInputItem", "TranslatedTextItem", "TranslationLanguage", + "TranslationResult", + "TranslationTarget", "TranslationText", "TransliterableScript", + "TransliterateBody", + "TransliterateResult", "TransliteratedText", "TransliterationLanguage", "LanguageDirectionality", @@ -69,5 +70,5 @@ "ProfanityMarker", "TextType", ] -__all__.extend([p for p in _patch_all if p not in __all__]) +__all__.extend([p for p in _patch_all if p not in __all__]) # pyright: ignore _patch_sdk() diff --git a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/_models.py b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/_models.py index e636f1f0a345..dd0dc156c8c8 100644 --- a/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/_models.py +++ b/sdk/translation/azure-ai-translation-text/azure/ai/translation/text/models/_models.py @@ -1,142 +1,23 @@ # coding=utf-8 -# pylint: disable=too-many-lines # -------------------------------------------------------------------------- # 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. # -------------------------------------------------------------------------- +# pylint: disable=useless-super-delegation -from typing import Any, Dict, List, Mapping, Optional, TYPE_CHECKING, Union, overload +from typing import Any, Mapping, Optional, TYPE_CHECKING, Union, overload -from .. import _model_base -from .._model_base import rest_field +from .._utils.model_base import Model as _Model, rest_field if TYPE_CHECKING: - # pylint: disable=unused-import,ungrouped-imports from .. import models as _models -class BackTranslation(_model_base.Model): - """Back Translation. - - All required parameters must be populated in order to send to server. - - :ivar normalized_text: A string giving the normalized form of the source term that is a - back-translation of the target. - This value should be used as input to lookup examples. Required. - :vartype normalized_text: str - :ivar display_text: A string giving the source term that is a back-translation of the target in - a form best - suited for end-user display. Required. - :vartype display_text: str - :ivar num_examples: An integer representing the number of examples that are available for this - translation pair. - Actual examples must be retrieved with a separate call to lookup examples. The number is - mostly - intended to facilitate display in a UX. For example, a user interface may add a hyperlink - to the back-translation if the number of examples is greater than zero and show the - back-translation - as plain text if there are no examples. Note that the actual number of examples returned - by a call to lookup examples may be less than numExamples, because additional filtering may be - applied on the fly to remove "bad" examples. Required. - :vartype num_examples: int - :ivar frequency_count: An integer representing the frequency of this translation pair in the - data. The main purpose of this - field is to provide a user interface with a means to sort back-translations so the most - frequent terms are first. Required. - :vartype frequency_count: int - """ - - normalized_text: str = rest_field(name="normalizedText") - """A string giving the normalized form of the source term that is a back-translation of the - target. - This value should be used as input to lookup examples. Required.""" - display_text: str = rest_field(name="displayText") - """A string giving the source term that is a back-translation of the target in a form best - suited for end-user display. Required.""" - num_examples: int = rest_field(name="numExamples") - """An integer representing the number of examples that are available for this translation pair. - Actual examples must be retrieved with a separate call to lookup examples. The number is mostly - intended to facilitate display in a UX. For example, a user interface may add a hyperlink - to the back-translation if the number of examples is greater than zero and show the - back-translation - as plain text if there are no examples. Note that the actual number of examples returned - by a call to lookup examples may be less than numExamples, because additional filtering may be - applied on the fly to remove \"bad\" examples. Required.""" - frequency_count: int = rest_field(name="frequencyCount") - """An integer representing the frequency of this translation pair in the data. The main purpose of - this - field is to provide a user interface with a means to sort back-translations so the most - frequent terms are first. Required.""" - - @overload - def __init__( - self, - *, - normalized_text: str, - display_text: str, - num_examples: int, - frequency_count: int, - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class BreakSentenceItem(_model_base.Model): - """Item containing break sentence result. - - All required parameters must be populated in order to send to server. - - :ivar detected_language: The detectedLanguage property is only present in the result object - when language auto-detection is requested. - :vartype detected_language: ~azure.ai.translation.text.models.DetectedLanguage - :ivar sent_len: An integer array representing the lengths of the sentences in the input text. - The length of the array is the number of sentences, and the values are the length of each - sentence. Required. - :vartype sent_len: list[int] - """ - - detected_language: Optional["_models.DetectedLanguage"] = rest_field(name="detectedLanguage") - """The detectedLanguage property is only present in the result object when language auto-detection - is requested.""" - sent_len: List[int] = rest_field(name="sentLen") - """An integer array representing the lengths of the sentences in the input text. - The length of the array is the number of sentences, and the values are the length of each - sentence. Required.""" - - @overload - def __init__( - self, - *, - sent_len: List[int], - detected_language: Optional["_models.DetectedLanguage"] = None, - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class DetectedLanguage(_model_base.Model): +class DetectedLanguage(_Model): """An object describing the detected language. - All required parameters must be populated in order to send to server. - :ivar language: A string representing the code of the detected language. Required. :vartype language: str :ivar score: A float value indicating the confidence in the result. @@ -144,9 +25,9 @@ class DetectedLanguage(_model_base.Model): :vartype score: float """ - language: str = rest_field() + language: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """A string representing the code of the detected language. Required.""" - score: float = rest_field() + score: float = rest_field(visibility=["read", "create", "update", "delete", "query"]) """A float value indicating the confidence in the result. The score is between zero and one and a low score indicates a low confidence. Required.""" @@ -156,393 +37,60 @@ def __init__( *, language: str, score: float, - ): ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class DictionaryExample(_model_base.Model): - """Dictionary Example. - - All required parameters must be populated in order to send to server. - - :ivar source_prefix: The string to concatenate before the value of sourceTerm to form a - complete example. - Do not add a space character, since it is already there when it should be. - This value may be an empty string. Required. - :vartype source_prefix: str - :ivar source_term: A string equal to the actual term looked up. The string is added with - sourcePrefix - and sourceSuffix to form the complete example. Its value is separated so it can be - marked in a user interface, e.g., by bolding it. Required. - :vartype source_term: str - :ivar source_suffix: The string to concatenate after the value of sourceTerm to form a complete - example. - Do not add a space character, since it is already there when it should be. - This value may be an empty string. Required. - :vartype source_suffix: str - :ivar target_prefix: A string similar to sourcePrefix but for the target. Required. - :vartype target_prefix: str - :ivar target_term: A string similar to sourceTerm but for the target. Required. - :vartype target_term: str - :ivar target_suffix: A string similar to sourceSuffix but for the target. Required. - :vartype target_suffix: str - """ - - source_prefix: str = rest_field(name="sourcePrefix") - """The string to concatenate before the value of sourceTerm to form a complete example. - Do not add a space character, since it is already there when it should be. - This value may be an empty string. Required.""" - source_term: str = rest_field(name="sourceTerm") - """A string equal to the actual term looked up. The string is added with sourcePrefix - and sourceSuffix to form the complete example. Its value is separated so it can be - marked in a user interface, e.g., by bolding it. Required.""" - source_suffix: str = rest_field(name="sourceSuffix") - """The string to concatenate after the value of sourceTerm to form a complete example. - Do not add a space character, since it is already there when it should be. - This value may be an empty string. Required.""" - target_prefix: str = rest_field(name="targetPrefix") - """A string similar to sourcePrefix but for the target. Required.""" - target_term: str = rest_field(name="targetTerm") - """A string similar to sourceTerm but for the target. Required.""" - target_suffix: str = rest_field(name="targetSuffix") - """A string similar to sourceSuffix but for the target. Required.""" - - @overload - def __init__( - self, - *, - source_prefix: str, - source_term: str, - source_suffix: str, - target_prefix: str, - target_term: str, - target_suffix: str, - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class DictionaryExampleItem(_model_base.Model): - """Dictionary Example element. - - All required parameters must be populated in order to send to server. - - :ivar normalized_source: A string giving the normalized form of the source term. Generally, - this should be identical - to the value of the Text field at the matching list index in the body of the request. - Required. - :vartype normalized_source: str - :ivar normalized_target: A string giving the normalized form of the target term. Generally, - this should be identical - to the value of the Translation field at the matching list index in the body of the request. - Required. - :vartype normalized_target: str - :ivar examples: A list of examples for the (source term, target term) pair. Required. - :vartype examples: list[~azure.ai.translation.text.models.DictionaryExample] - """ - - normalized_source: str = rest_field(name="normalizedSource") - """A string giving the normalized form of the source term. Generally, this should be identical - to the value of the Text field at the matching list index in the body of the request. Required.""" - normalized_target: str = rest_field(name="normalizedTarget") - """A string giving the normalized form of the target term. Generally, this should be identical - to the value of the Translation field at the matching list index in the body of the request. - Required.""" - examples: List["_models.DictionaryExample"] = rest_field() - """A list of examples for the (source term, target term) pair. Required.""" - - @overload - def __init__( - self, - *, - normalized_source: str, - normalized_target: str, - examples: List["_models.DictionaryExample"], - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class InputTextItem(_model_base.Model): - """Element containing the text for translation. - - All required parameters must be populated in order to send to server. - - :ivar text: Text to translate. Required. - :vartype text: str - """ - - text: str = rest_field() - """Text to translate. Required.""" - - @overload - def __init__( - self, - *, - text: str, - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class DictionaryExampleTextItem(InputTextItem): - """Element containing the text with translation. - - All required parameters must be populated in order to send to server. - - :ivar text: Text to translate. Required. - :vartype text: str - :ivar translation: A string specifying the translated text previously returned by the - Dictionary lookup operation. - This should be the value from the normalizedTarget field in the translations list of the - Dictionary - lookup response. The service will return examples for the specific source-target word-pair. - Required. - :vartype translation: str - """ - - translation: str = rest_field() - """A string specifying the translated text previously returned by the Dictionary lookup operation. - This should be the value from the normalizedTarget field in the translations list of the - Dictionary - lookup response. The service will return examples for the specific source-target word-pair. - Required.""" - - @overload - def __init__( - self, - *, - text: str, - translation: str, - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class DictionaryLookupItem(_model_base.Model): - """Dictionary Lookup Element. - - All required parameters must be populated in order to send to server. - - :ivar normalized_source: A string giving the normalized form of the source term. - For example, if the request is "JOHN", the normalized form will be "john". - The content of this field becomes the input to lookup examples. Required. - :vartype normalized_source: str - :ivar display_source: A string giving the source term in a form best suited for end-user - display. - For example, if the input is "JOHN", the display form will reflect the usual - spelling of the name: "John". Required. - :vartype display_source: str - :ivar translations: A list of translations for the source term. Required. - :vartype translations: list[~azure.ai.translation.text.models.DictionaryTranslation] - """ - - normalized_source: str = rest_field(name="normalizedSource") - """A string giving the normalized form of the source term. - For example, if the request is \"JOHN\", the normalized form will be \"john\". - The content of this field becomes the input to lookup examples. Required.""" - display_source: str = rest_field(name="displaySource") - """A string giving the source term in a form best suited for end-user display. - For example, if the input is \"JOHN\", the display form will reflect the usual - spelling of the name: \"John\". Required.""" - translations: List["_models.DictionaryTranslation"] = rest_field() - """A list of translations for the source term. Required.""" - - @overload - def __init__( - self, - *, - normalized_source: str, - display_source: str, - translations: List["_models.DictionaryTranslation"], - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class DictionaryTranslation(_model_base.Model): - """Translation source term. - - All required parameters must be populated in order to send to server. - - :ivar normalized_target: A string giving the normalized form of this term in the target - language. - This value should be used as input to lookup examples. Required. - :vartype normalized_target: str - :ivar display_target: A string giving the term in the target language and in a form best suited - for end-user display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like "Juan" will have - normalizedTarget = "juan" and displayTarget = "Juan". Required. - :vartype display_target: str - :ivar pos_tag: A string associating this term with a part-of-speech tag. Required. - :vartype pos_tag: str - :ivar confidence: A value between 0.0 and 1.0 which represents the "confidence" - (or perhaps more accurately, "probability in the training data") of that translation pair. - The sum of confidence scores for one source word may or may not sum to 1.0. Required. - :vartype confidence: float - :ivar prefix_word: A string giving the word to display as a prefix of the translation. - Currently, - this is the gendered determiner of nouns, in languages that have gendered determiners. - For example, the prefix of the Spanish word "mosca" is "la", since "mosca" is a feminine noun - in Spanish. - This is only dependent on the translation, and not on the source. - If there is no prefix, it will be the empty string. Required. - :vartype prefix_word: str - :ivar back_translations: A list of "back translations" of the target. For example, source words - that the target can translate to. - The list is guaranteed to contain the source word that was requested (e.g., if the source word - being - looked up is "fly", then it is guaranteed that "fly" will be in the backTranslations list). - However, it is not guaranteed to be in the first position, and often will not be. Required. - :vartype back_translations: list[~azure.ai.translation.text.models.BackTranslation] - """ - - normalized_target: str = rest_field(name="normalizedTarget") - """A string giving the normalized form of this term in the target language. - This value should be used as input to lookup examples. Required.""" - display_target: str = rest_field(name="displayTarget") - """A string giving the term in the target language and in a form best suited - for end-user display. Generally, this will only differ from the normalizedTarget - in terms of capitalization. For example, a proper noun like \"Juan\" will have - normalizedTarget = \"juan\" and displayTarget = \"Juan\". Required.""" - pos_tag: str = rest_field(name="posTag") - """A string associating this term with a part-of-speech tag. Required.""" - confidence: float = rest_field() - """A value between 0.0 and 1.0 which represents the \"confidence\" - (or perhaps more accurately, \"probability in the training data\") of that translation pair. - The sum of confidence scores for one source word may or may not sum to 1.0. Required.""" - prefix_word: str = rest_field(name="prefixWord") - """A string giving the word to display as a prefix of the translation. Currently, - this is the gendered determiner of nouns, in languages that have gendered determiners. - For example, the prefix of the Spanish word \"mosca\" is \"la\", since \"mosca\" is a feminine - noun in Spanish. - This is only dependent on the translation, and not on the source. - If there is no prefix, it will be the empty string. Required.""" - back_translations: List["_models.BackTranslation"] = rest_field(name="backTranslations") - """A list of \"back translations\" of the target. For example, source words that the target can - translate to. - The list is guaranteed to contain the source word that was requested (e.g., if the source word - being - looked up is \"fly\", then it is guaranteed that \"fly\" will be in the backTranslations list). - However, it is not guaranteed to be in the first position, and often will not be. Required.""" - - @overload - def __init__( - self, - *, - normalized_target: str, - display_target: str, - pos_tag: str, - confidence: float, - prefix_word: str, - back_translations: List["_models.BackTranslation"], - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class ErrorDetails(_model_base.Model): +class ErrorDetails(_Model): """Error details as returned by Translator Service. - All required parameters must be populated in order to send to server. - - :ivar code: Number identifier of the error. Required. - :vartype code: int + :ivar code: String identifier of the error. Required. + :vartype code: str :ivar message: Human readable error description. Required. :vartype message: str """ - code: int = rest_field() - """Number identifier of the error. Required.""" - message: str = rest_field() + code: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """String identifier of the error. Required.""" + message: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Human readable error description. Required.""" @overload def __init__( self, *, - code: int, + code: str, message: str, - ): ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class ErrorResponse(_model_base.Model): +class ErrorResponse(_Model): """Representation of the Error Response from Translator Service. - All required parameters must be populated in order to send to server. - :ivar error: Error details. Required. :vartype error: ~azure.ai.translation.text.models.ErrorDetails """ - error: "_models.ErrorDetails" = rest_field() + error: "_models.ErrorDetails" = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Error details. Required.""" @overload @@ -550,62 +98,69 @@ def __init__( self, *, error: "_models.ErrorDetails", - ): ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class GetSupportedLanguagesResult(_model_base.Model): +class GetSupportedLanguagesResult(_Model): """Response for the languages API. :ivar translation: Languages that support translate API. :vartype translation: dict[str, ~azure.ai.translation.text.models.TranslationLanguage] :ivar transliteration: Languages that support transliteration API. :vartype transliteration: dict[str, ~azure.ai.translation.text.models.TransliterationLanguage] - :ivar dictionary: Languages that support dictionary API. - :vartype dictionary: dict[str, ~azure.ai.translation.text.models.SourceDictionaryLanguage] + :ivar models: LLM models supported. + :vartype models: list[str] """ - translation: Optional[Dict[str, "_models.TranslationLanguage"]] = rest_field() + translation: Optional[dict[str, "_models.TranslationLanguage"]] = rest_field(visibility=["read"]) """Languages that support translate API.""" - transliteration: Optional[Dict[str, "_models.TransliterationLanguage"]] = rest_field() + transliteration: Optional[dict[str, "_models.TransliterationLanguage"]] = rest_field(visibility=["read"]) """Languages that support transliteration API.""" - dictionary: Optional[Dict[str, "_models.SourceDictionaryLanguage"]] = rest_field() - """Languages that support dictionary API.""" + models: Optional[list[str]] = rest_field(visibility=["read"]) + """LLM models supported.""" + + +class InputTextItem(_Model): + """Element containing the text for translation. + + :ivar text: Text to translate. Required. + :vartype text: str + """ + + text: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Text to translate. Required.""" @overload def __init__( self, *, - translation: Optional[Dict[str, "_models.TranslationLanguage"]] = None, - transliteration: Optional[Dict[str, "_models.TransliterationLanguage"]] = None, - dictionary: Optional[Dict[str, "_models.SourceDictionaryLanguage"]] = None, - ): ... + text: str, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class LanguageScript(_model_base.Model): +class LanguageScript(_Model): """Common properties of language script. - All required parameters must be populated in order to send to server. - :ivar code: Code identifying the script. Required. :vartype code: str :ivar name: Display name of the script in the locale requested via Accept-Language header. @@ -619,13 +174,15 @@ class LanguageScript(_model_base.Model): :vartype dir: str or ~azure.ai.translation.text.models.LanguageDirectionality """ - code: str = rest_field() + code: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Code identifying the script. Required.""" - name: str = rest_field() + name: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Display name of the script in the locale requested via Accept-Language header. Required.""" - native_name: str = rest_field(name="nativeName") + native_name: str = rest_field(name="nativeName", visibility=["read", "create", "update", "delete", "query"]) """Display name of the language in the locale native for the language. Required.""" - dir: Union[str, "_models.LanguageDirectionality"] = rest_field() + dir: Union[str, "_models.LanguageDirectionality"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) """Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages. Required. Known values are: \"ltr\" and \"rtl\".""" @@ -637,149 +194,192 @@ def __init__( name: str, native_name: str, dir: Union[str, "_models.LanguageDirectionality"], - ): ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class SentenceBoundaries(_model_base.Model): - """An object returning sentence boundaries in the input and output texts. - - All required parameters must be populated in order to send to server. +class ReferenceTextPair(_Model): + """Reference text pair to generate adaptive customized translation. - :ivar src_sent_len: An integer array representing the lengths of the sentences in the input - text. - The length of the array is the number of sentences, and the values are the length of each - sentence. Required. - :vartype src_sent_len: list[int] - :ivar trans_sent_len: An integer array representing the lengths of the sentences in the - translated text. - The length of the array is the number of sentences, and the values are the length of each - sentence. Required. - :vartype trans_sent_len: list[int] + :ivar source: Source reference sentence. Required. + :vartype source: str + :ivar target: Target reference sentence. Required. + :vartype target: str """ - src_sent_len: List[int] = rest_field(name="srcSentLen") - """An integer array representing the lengths of the sentences in the input text. - The length of the array is the number of sentences, and the values are the length of each - sentence. Required.""" - trans_sent_len: List[int] = rest_field(name="transSentLen") - """An integer array representing the lengths of the sentences in the translated text. - The length of the array is the number of sentences, and the values are the length of each - sentence. Required.""" + source: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Source reference sentence. Required.""" + target: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Target reference sentence. Required.""" @overload def __init__( self, *, - src_sent_len: List[int], - trans_sent_len: List[int], - ): ... + source: str, + target: str, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class SourceDictionaryLanguage(_model_base.Model): - """Properties ot the source dictionary language. - - All required parameters must be populated in order to send to server. +class TranslateBody(_Model): + """Request data for translate. - :ivar name: Display name of the language in the locale requested via Accept-Language header. - Required. - :vartype name: str - :ivar native_name: Display name of the language in the locale native for this language. - Required. - :vartype native_name: str - :ivar dir: Directionality, which is rtl for right-to-left languages or ltr for left-to-right - languages. Required. Known values are: "ltr" and "rtl". - :vartype dir: str or ~azure.ai.translation.text.models.LanguageDirectionality - :ivar translations: List of languages with alterative translations and examples for the query - expressed in the source language. Required. - :vartype translations: list[~azure.ai.translation.text.models.TargetDictionaryLanguage] + :ivar inputs: Array of the input text elements to translate. Required. + :vartype inputs: list[~azure.ai.translation.text.models.TranslateInputItem] """ - name: str = rest_field() - """Display name of the language in the locale requested via Accept-Language header. Required.""" - native_name: str = rest_field(name="nativeName") - """Display name of the language in the locale native for this language. Required.""" - dir: Union[str, "_models.LanguageDirectionality"] = rest_field() - """Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages. - Required. Known values are: \"ltr\" and \"rtl\".""" - translations: List["_models.TargetDictionaryLanguage"] = rest_field() - """List of languages with alterative translations and examples for the query expressed in the - source language. Required.""" + inputs: list["_models.TranslateInputItem"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Array of the input text elements to translate. Required.""" @overload def __init__( self, *, - name: str, - native_name: str, - dir: Union[str, "_models.LanguageDirectionality"], - translations: List["_models.TargetDictionaryLanguage"], - ): ... + inputs: list["_models.TranslateInputItem"], + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class SourceText(_model_base.Model): - """Input text in the default script of the source language. +class TranslatedTextItem(_Model): + """Element containing the translated text. - All required parameters must be populated in order to send to server. + :ivar detected_language: The detectedLanguage property is only present in the result object + when language auto-detection is requested. + :vartype detected_language: ~azure.ai.translation.text.models.DetectedLanguage + :ivar translations: An array of translation results. The size of the array matches the number + of target + languages specified through the to query parameter. Required. + :vartype translations: list[~azure.ai.translation.text.models.TranslationText] + """ + + detected_language: Optional["_models.DetectedLanguage"] = rest_field( + name="detectedLanguage", visibility=["read", "create", "update", "delete", "query"] + ) + """The detectedLanguage property is only present in the result object when language auto-detection + is requested.""" + translations: list["_models.TranslationText"] = rest_field(visibility=["read"]) + """An array of translation results. The size of the array matches the number of target + languages specified through the to query parameter. Required.""" - :ivar text: Input text in the default script of the source language. Required. + @overload + def __init__( + self, + *, + detected_language: Optional["_models.DetectedLanguage"] = None, + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class TranslateInputItem(_Model): + """Element containing the text for translation. + + :ivar text: Text to translate. Required. :vartype text: str + :ivar script: Specifies the script of the input text. + :vartype script: str + :ivar language: Specifies the language of the input text. Find which languages are available to + translate by + looking up supported languages using the translation scope. If the language parameter isn't + specified, automatic language detection is applied to determine the source language. + + You must use the language parameter rather than autodetection when using the dynamic dictionary + feature. + Note: the dynamic dictionary feature is case-sensitive. + :vartype language: str + :ivar text_type: Defines whether the text being translated is plain text or HTML text. Any HTML + needs to be a well-formed, + complete element. Possible values are: plain (default) or html. Known values are: "Plain" and + "Html". + :vartype text_type: str or ~azure.ai.translation.text.models.TextType + :ivar targets: Translation target parameters. Required. + :vartype targets: list[~azure.ai.translation.text.models.TranslationTarget] """ - text: str = rest_field() - """Input text in the default script of the source language. Required.""" + text: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Text to translate. Required.""" + script: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Specifies the script of the input text.""" + language: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Specifies the language of the input text. Find which languages are available to translate by + looking up supported languages using the translation scope. If the language parameter isn't + specified, automatic language detection is applied to determine the source language. + + You must use the language parameter rather than autodetection when using the dynamic dictionary + feature. + Note: the dynamic dictionary feature is case-sensitive.""" + text_type: Optional[Union[str, "_models.TextType"]] = rest_field( + name="textType", visibility=["read", "create", "update", "delete", "query"] + ) + """Defines whether the text being translated is plain text or HTML text. Any HTML needs to be a + well-formed, + complete element. Possible values are: plain (default) or html. Known values are: \"Plain\" and + \"Html\".""" + targets: list["_models.TranslationTarget"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Translation target parameters. Required.""" @overload def __init__( self, *, text: str, - ): ... + targets: list["_models.TranslationTarget"], + script: Optional[str] = None, + language: Optional[str] = None, + text_type: Optional[Union[str, "_models.TextType"]] = None, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TargetDictionaryLanguage(_model_base.Model): - """Properties of the target dictionary language. - - All required parameters must be populated in order to send to server. +class TranslationLanguage(_Model): + """The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP + 47 language tag. + A key identifies a language for which text can be translated to or translated from. :ivar name: Display name of the language in the locale requested via Accept-Language header. Required. @@ -790,19 +390,21 @@ class TargetDictionaryLanguage(_model_base.Model): :ivar dir: Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages. Required. Known values are: "ltr" and "rtl". :vartype dir: str or ~azure.ai.translation.text.models.LanguageDirectionality - :ivar code: Language code identifying the target language. Required. - :vartype code: str + :ivar models: LLM models supported for translation. Required. + :vartype models: list[str] """ - name: str = rest_field() + name: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Display name of the language in the locale requested via Accept-Language header. Required.""" - native_name: str = rest_field(name="nativeName") + native_name: str = rest_field(name="nativeName", visibility=["read", "create", "update", "delete", "query"]) """Display name of the language in the locale native for this language. Required.""" - dir: Union[str, "_models.LanguageDirectionality"] = rest_field() + dir: Union[str, "_models.LanguageDirectionality"] = rest_field( + visibility=["read", "create", "update", "delete", "query"] + ) """Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages. Required. Known values are: \"ltr\" and \"rtl\".""" - code: str = rest_field() - """Language code identifying the target language. Required.""" + models: list[str] = rest_field(visibility=["read"]) + """LLM models supported for translation. Required.""" @overload def __init__( @@ -811,224 +413,259 @@ def __init__( name: str, native_name: str, dir: Union[str, "_models.LanguageDirectionality"], - code: str, - ): ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TranslatedTextAlignment(_model_base.Model): - """Alignment information object. +class TranslationResult(_Model): + """Response for the translation API. - All required parameters must be populated in order to send to server. - - :ivar proj: Maps input text to translated text. The alignment information is only provided when - the request - parameter includeAlignment is true. Alignment is returned as a string value of the following - format: [[SourceTextStartIndex]:[SourceTextEndIndex]–[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the languages, and space separates - the words. - One word may align with zero, one, or multiple words in the other language, and the aligned - words may - be non-contiguous. When no alignment information is available, the alignment element will be - empty. Required. - :vartype proj: str + :ivar value: Array of the translated text elements. Required. + :vartype value: list[~azure.ai.translation.text.models.TranslatedTextItem] """ - proj: str = rest_field() - """Maps input text to translated text. The alignment information is only provided when the request - parameter includeAlignment is true. Alignment is returned as a string value of the following - format: [[SourceTextStartIndex]:[SourceTextEndIndex]–[TgtTextStartIndex]:[TgtTextEndIndex]]. - The colon separates start and end index, the dash separates the languages, and space separates - the words. - One word may align with zero, one, or multiple words in the other language, and the aligned - words may - be non-contiguous. When no alignment information is available, the alignment element will be - empty. Required.""" + value: list["_models.TranslatedTextItem"] = rest_field(visibility=["read"]) + """Array of the translated text elements. Required.""" - @overload - def __init__( - self, - *, - proj: str, - ): ... - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class TranslatedTextItem(_model_base.Model): - """Element containing the translated text. +class TranslationTarget(_Model): + """Target language and translation configuration parameters. - All required parameters must be populated in order to send to server. - - :ivar detected_language: The detectedLanguage property is only present in the result object - when language auto-detection is requested. - :vartype detected_language: ~azure.ai.translation.text.models.DetectedLanguage - :ivar translations: An array of translation results. The size of the array matches the number - of target - languages specified through the to query parameter. Required. - :vartype translations: list[~azure.ai.translation.text.models.TranslationText] - :ivar source_text: Input text in the default script of the source language. sourceText property - is present only when - the input is expressed in a script that's not the usual script for the language. For example, - if the input were Arabic written in Latin script, then sourceText.text would be the same - Arabic text - converted into Arab script. - :vartype source_text: ~azure.ai.translation.text.models.SourceText - """ - - detected_language: Optional["_models.DetectedLanguage"] = rest_field(name="detectedLanguage") - """The detectedLanguage property is only present in the result object when language auto-detection - is requested.""" - translations: List["_models.TranslationText"] = rest_field() - """An array of translation results. The size of the array matches the number of target - languages specified through the to query parameter. Required.""" - source_text: Optional["_models.SourceText"] = rest_field(name="sourceText") - """Input text in the default script of the source language. sourceText property is present only - when - the input is expressed in a script that's not the usual script for the language. For example, - if the input were Arabic written in Latin script, then sourceText.text would be the same Arabic - text - converted into Arab script.""" - - @overload - def __init__( - self, - *, - translations: List["_models.TranslationText"], - detected_language: Optional["_models.DetectedLanguage"] = None, - source_text: Optional["_models.SourceText"] = None, - ): ... - - @overload - def __init__(self, mapping: Mapping[str, Any]): - """ - :param mapping: raw JSON to initialize the model. - :type mapping: Mapping[str, Any] - """ - - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation - super().__init__(*args, **kwargs) - - -class TranslationLanguage(_model_base.Model): - """The value of the translation property is a dictionary of (key, value) pairs. Each key is a BCP - 47 language tag. - A key identifies a language for which text can be translated to or translated from. - - All required parameters must be populated in order to send to server. - - :ivar name: Display name of the language in the locale requested via Accept-Language header. - Required. - :vartype name: str - :ivar native_name: Display name of the language in the locale native for this language. - Required. - :vartype native_name: str - :ivar dir: Directionality, which is rtl for right-to-left languages or ltr for left-to-right - languages. Required. Known values are: "ltr" and "rtl". - :vartype dir: str or ~azure.ai.translation.text.models.LanguageDirectionality + :ivar language: Specifies the language of the output text. The target language must be one of + the supported languages included + in the translation scope. It's possible to translate to multiple languages simultaneously by + including + multiple string values in the targetsLanguage array. Required. + :vartype language: str + :ivar script: Specifies the script of the translated text. + :vartype script: str + :ivar profanity_action: Specifies how profanities should be treated in translations. + Possible values are: NoAction (default), Marked or Deleted. Known values are: "NoAction", + "Marked", and "Deleted". + :vartype profanity_action: str or ~azure.ai.translation.text.models.ProfanityAction + :ivar profanity_marker: Specifies how profanities should be marked in translations. + Possible values are: Asterisk (default) or Tag. Known values are: "Asterisk" and "Tag". + :vartype profanity_marker: str or ~azure.ai.translation.text.models.ProfanityMarker + :ivar deployment_name: Default is 'general', which uses NMT system. + 'abc-inc-gpt-4o', and 'abc-inc-gpt-4o-mini' are examples of deployment names which use GPT-4o + uses or + GPT-4o-mini model. 'gpt-4o' uses GPT-4o model. + + '' uses the custom NMT model tuned by customer. + 'best' system determines which is the best model to use for the request. This intelligence + could be introduced + in future. Customer should have deployed it in their resource. + :vartype deployment_name: str + :ivar allow_fallback: In the case where a custom system is being used, specifies that the + service is allowed to fall back to a + general system when a custom system doesn't exist. + In the case where a Large Language Model is being used, specifies that the service is allowed + to fall + back to a Small Language Model if an error occurs. + Possible values are: true (default) or false. + + allowFallback=false specifies that the translation should only use systems trained for the + category specified + by the request. If a translation for language X to language Y requires chaining through a pivot + language E, + then all the systems in the chain (X → E and E → Y) will need to be custom and have the same + category. + If no system is found with the specific category, the request will return a 400 status code. + allowFallback=true + specifies that the service is allowed to fall back to a general system when a custom system + doesn't exist. + :vartype allow_fallback: bool + :ivar grade: Defines complexity of LLM prompts to provide high accuracy translation. + :vartype grade: str + :ivar tone: Desired tone of target translation. + :vartype tone: str + :ivar gender: Desired gender of target translation. + :vartype gender: str + :ivar adaptive_dataset_id: Reference dataset ID having sentence pair to generate adaptive + customized translation. + :vartype adaptive_dataset_id: str + :ivar reference_text_pairs: Reference text pairs to generate adaptive customized translation. + :vartype reference_text_pairs: list[~azure.ai.translation.text.models.ReferenceTextPair] """ - name: str = rest_field() - """Display name of the language in the locale requested via Accept-Language header. Required.""" - native_name: str = rest_field(name="nativeName") - """Display name of the language in the locale native for this language. Required.""" - dir: Union[str, "_models.LanguageDirectionality"] = rest_field() - """Directionality, which is rtl for right-to-left languages or ltr for left-to-right languages. - Required. Known values are: \"ltr\" and \"rtl\".""" + language: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Specifies the language of the output text. The target language must be one of the supported + languages included + in the translation scope. It's possible to translate to multiple languages simultaneously by + including + multiple string values in the targetsLanguage array. Required.""" + script: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Specifies the script of the translated text.""" + profanity_action: Optional[Union[str, "_models.ProfanityAction"]] = rest_field( + name="profanityAction", visibility=["read", "create", "update", "delete", "query"] + ) + """Specifies how profanities should be treated in translations. + Possible values are: NoAction (default), Marked or Deleted. Known values are: \"NoAction\", + \"Marked\", and \"Deleted\".""" + profanity_marker: Optional[Union[str, "_models.ProfanityMarker"]] = rest_field( + name="profanityMarker", visibility=["read", "create", "update", "delete", "query"] + ) + """Specifies how profanities should be marked in translations. + Possible values are: Asterisk (default) or Tag. Known values are: \"Asterisk\" and \"Tag\".""" + deployment_name: Optional[str] = rest_field( + name="deploymentName", visibility=["read", "create", "update", "delete", "query"] + ) + """Default is 'general', which uses NMT system. + 'abc-inc-gpt-4o', and 'abc-inc-gpt-4o-mini' are examples of deployment names which use GPT-4o + uses or + GPT-4o-mini model. 'gpt-4o' uses GPT-4o model. + + '' uses the custom NMT model tuned by customer. + 'best' system determines which is the best model to use for the request. This intelligence + could be introduced + in future. Customer should have deployed it in their resource.""" + allow_fallback: Optional[bool] = rest_field( + name="allowFallback", visibility=["read", "create", "update", "delete", "query"] + ) + """In the case where a custom system is being used, specifies that the service is allowed to fall + back to a + general system when a custom system doesn't exist. + In the case where a Large Language Model is being used, specifies that the service is allowed + to fall + back to a Small Language Model if an error occurs. + Possible values are: true (default) or false. + + allowFallback=false specifies that the translation should only use systems trained for the + category specified + by the request. If a translation for language X to language Y requires chaining through a pivot + language E, + then all the systems in the chain (X → E and E → Y) will need to be custom and have the same + category. + If no system is found with the specific category, the request will return a 400 status code. + allowFallback=true + specifies that the service is allowed to fall back to a general system when a custom system + doesn't exist.""" + grade: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Defines complexity of LLM prompts to provide high accuracy translation.""" + tone: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Desired tone of target translation.""" + gender: Optional[str] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Desired gender of target translation.""" + adaptive_dataset_id: Optional[str] = rest_field( + name="adaptiveDatasetId", visibility=["read", "create", "update", "delete", "query"] + ) + """Reference dataset ID having sentence pair to generate adaptive customized translation.""" + reference_text_pairs: Optional[list["_models.ReferenceTextPair"]] = rest_field( + name="referenceTextPairs", visibility=["read", "create", "update", "delete", "query"] + ) + """Reference text pairs to generate adaptive customized translation.""" @overload def __init__( self, *, - name: str, - native_name: str, - dir: Union[str, "_models.LanguageDirectionality"], - ): ... + language: str, + script: Optional[str] = None, + profanity_action: Optional[Union[str, "_models.ProfanityAction"]] = None, + profanity_marker: Optional[Union[str, "_models.ProfanityMarker"]] = None, + deployment_name: Optional[str] = None, + allow_fallback: Optional[bool] = None, + grade: Optional[str] = None, + tone: Optional[str] = None, + gender: Optional[str] = None, + adaptive_dataset_id: Optional[str] = None, + reference_text_pairs: Optional[list["_models.ReferenceTextPair"]] = None, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TranslationText(_model_base.Model): +class TranslationText(_Model): """Translation result. - All required parameters must be populated in order to send to server. - - :ivar to: A string representing the language code of the target language. Required. - :vartype to: str + :ivar language: A string representing the language code of the target language. Required. + :vartype language: str + :ivar source_characters: An interger indicating the number of characters in the source text + string. + :vartype source_characters: int + :ivar instruction_tokens: An interger indicating the number of tokens used in generating the + translated text. + :vartype instruction_tokens: int + :ivar source_tokens: An interger indicating the number of tokens used in the source sentence. + :vartype source_tokens: int + :ivar response_tokens: An interger indicating the number of tokens used in the translation + response. + :vartype response_tokens: int + :ivar target_tokens: An interger indicating the number of tokens used in the target sentence. + :vartype target_tokens: int :ivar text: A string giving the translated text. Required. :vartype text: str - :ivar transliteration: An object giving the translated text in the script specified by the - toScript parameter. - :vartype transliteration: ~azure.ai.translation.text.models.TransliteratedText - :ivar alignment: Alignment information. - :vartype alignment: ~azure.ai.translation.text.models.TranslatedTextAlignment - :ivar sent_len: Sentence boundaries in the input and output texts. - :vartype sent_len: ~azure.ai.translation.text.models.SentenceBoundaries """ - to: str = rest_field() + language: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """A string representing the language code of the target language. Required.""" - text: str = rest_field() + source_characters: Optional[int] = rest_field( + name="sourceCharacters", visibility=["read", "create", "update", "delete", "query"] + ) + """An interger indicating the number of characters in the source text string.""" + instruction_tokens: Optional[int] = rest_field( + name="instructionTokens", visibility=["read", "create", "update", "delete", "query"] + ) + """An interger indicating the number of tokens used in generating the translated text.""" + source_tokens: Optional[int] = rest_field( + name="sourceTokens", visibility=["read", "create", "update", "delete", "query"] + ) + """An interger indicating the number of tokens used in the source sentence.""" + response_tokens: Optional[int] = rest_field( + name="responseTokens", visibility=["read", "create", "update", "delete", "query"] + ) + """An interger indicating the number of tokens used in the translation response.""" + target_tokens: Optional[int] = rest_field( + name="targetTokens", visibility=["read", "create", "update", "delete", "query"] + ) + """An interger indicating the number of tokens used in the target sentence.""" + text: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """A string giving the translated text. Required.""" - transliteration: Optional["_models.TransliteratedText"] = rest_field() - """An object giving the translated text in the script specified by the toScript parameter.""" - alignment: Optional["_models.TranslatedTextAlignment"] = rest_field() - """Alignment information.""" - sent_len: Optional["_models.SentenceBoundaries"] = rest_field(name="sentLen") - """Sentence boundaries in the input and output texts.""" @overload def __init__( self, *, - to: str, + language: str, text: str, - transliteration: Optional["_models.TransliteratedText"] = None, - alignment: Optional["_models.TranslatedTextAlignment"] = None, - sent_len: Optional["_models.SentenceBoundaries"] = None, - ): ... + source_characters: Optional[int] = None, + instruction_tokens: Optional[int] = None, + source_tokens: Optional[int] = None, + response_tokens: Optional[int] = None, + target_tokens: Optional[int] = None, + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) class TransliterableScript(LanguageScript): """Script definition with list of script into which given script can be translitered. - All required parameters must be populated in order to send to server. - :ivar code: Code identifying the script. Required. :vartype code: str :ivar name: Display name of the script in the locale requested via Accept-Language header. @@ -1044,7 +681,9 @@ class TransliterableScript(LanguageScript): :vartype to_scripts: list[~azure.ai.translation.text.models.LanguageScript] """ - to_scripts: List["_models.LanguageScript"] = rest_field(name="toScripts") + to_scripts: list["_models.LanguageScript"] = rest_field( + name="toScripts", visibility=["read", "create", "update", "delete", "query"] + ) """List of scripts available to convert text to. Required.""" @overload @@ -1055,24 +694,50 @@ def __init__( name: str, native_name: str, dir: Union[str, "_models.LanguageDirectionality"], - to_scripts: List["_models.LanguageScript"], - ): ... + to_scripts: list["_models.LanguageScript"], + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TransliteratedText(_model_base.Model): - """Transliterated text element. +class TransliterateBody(_Model): + """Request data for transliterate. + + :ivar inputs: Array of the input text elements to transliterate. Required. + :vartype inputs: list[~azure.ai.translation.text.models.InputTextItem] + """ + + inputs: list["_models.InputTextItem"] = rest_field(visibility=["read", "create", "update", "delete", "query"]) + """Array of the input text elements to transliterate. Required.""" - All required parameters must be populated in order to send to server. + @overload + def __init__( + self, + *, + inputs: list["_models.InputTextItem"], + ) -> None: ... + + @overload + def __init__(self, mapping: Mapping[str, Any]) -> None: + """ + :param mapping: raw JSON to initialize the model. + :type mapping: Mapping[str, Any] + """ + + def __init__(self, *args: Any, **kwargs: Any) -> None: + super().__init__(*args, **kwargs) + + +class TransliteratedText(_Model): + """Transliterated text element. :ivar text: A string which is the result of converting the input string to the output script. Required. @@ -1081,9 +746,9 @@ class TransliteratedText(_model_base.Model): :vartype script: str """ - text: str = rest_field() + text: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """A string which is the result of converting the input string to the output script. Required.""" - script: str = rest_field() + script: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """A string specifying the script used in the output. Required.""" @overload @@ -1092,27 +757,36 @@ def __init__( *, text: str, script: str, - ): ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) -class TransliterationLanguage(_model_base.Model): +class TransliterateResult(_Model): + """Response for the transliteration API. + + :ivar value: Array of transliterated texts. Required. + :vartype value: list[~azure.ai.translation.text.models.TransliteratedText] + """ + + value: list["_models.TransliteratedText"] = rest_field(visibility=["read"]) + """Array of transliterated texts. Required.""" + + +class TransliterationLanguage(_Model): """The value of the transliteration property is a dictionary of (key, value) pairs. Each key is a BCP 47 language tag. A key identifies a language for which text can be converted from one script to another script. - All required parameters must be populated in order to send to server. - :ivar name: Display name of the language in the locale requested via Accept-Language header. Required. :vartype name: str @@ -1123,11 +797,11 @@ class TransliterationLanguage(_model_base.Model): :vartype scripts: list[~azure.ai.translation.text.models.TransliterableScript] """ - name: str = rest_field() + name: str = rest_field(visibility=["read", "create", "update", "delete", "query"]) """Display name of the language in the locale requested via Accept-Language header. Required.""" - native_name: str = rest_field(name="nativeName") + native_name: str = rest_field(name="nativeName", visibility=["read", "create", "update", "delete", "query"]) """Display name of the language in the locale native for this language. Required.""" - scripts: List["_models.TransliterableScript"] = rest_field() + scripts: list["_models.TransliterableScript"] = rest_field(visibility=["read"]) """List of scripts to convert from. Required.""" @overload @@ -1136,15 +810,14 @@ def __init__( *, name: str, native_name: str, - scripts: List["_models.TransliterableScript"], - ): ... + ) -> None: ... @overload - def __init__(self, mapping: Mapping[str, Any]): + def __init__(self, mapping: Mapping[str, Any]) -> None: """ :param mapping: raw JSON to initialize the model. :type mapping: Mapping[str, Any] """ - def __init__(self, *args: Any, **kwargs: Any) -> None: # pylint: disable=useless-super-delegation + def __init__(self, *args: Any, **kwargs: Any) -> None: super().__init__(*args, **kwargs) diff --git a/sdk/translation/azure-ai-translation-text/pyproject.toml b/sdk/translation/azure-ai-translation-text/pyproject.toml index 893306989faf..400681a29b03 100644 --- a/sdk/translation/azure-ai-translation-text/pyproject.toml +++ b/sdk/translation/azure-ai-translation-text/pyproject.toml @@ -1,7 +1,68 @@ +# -------------------------------------------------------------------------- +# 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. +# -------------------------------------------------------------------------- + +[build-system] +requires = ["setuptools>=77.0.3", "wheel"] +build-backend = "setuptools.build_meta" + +[project] +name = "azure-ai-translation-text" +authors = [ + { name = "Microsoft Corporation", email = "azpysdkhelp@microsoft.com" }, +] +description = "Microsoft Corporation Azure Ai Translation Text Client Library for Python" +license = "MIT" +classifiers = [ + "Development Status :: 4 - Beta", + "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", +] +requires-python = ">=3.9" +keywords = ["azure", "azure sdk"] + +dependencies = [ + "isodate>=0.6.1", + "azure-core>=1.35.0", + "typing-extensions>=4.6.0", +] +dynamic = [ +"version", "readme" +] + +[project.urls] +repository = "https://github.com/Azure/azure-sdk-for-python" + +[tool.setuptools.dynamic] +version = {attr = "azure.ai.translation.text._version.VERSION"} +readme = {file = ["README.md", "CHANGELOG.md"], content-type = "text/markdown"} + +[tool.setuptools.packages.find] +exclude = [ + "tests*", + "generated_tests*", + "samples*", + "generated_samples*", + "doc*", + "azure", + "azure.ai", + "azure.ai.translation", +] + +[tool.setuptools.package-data] +pytyped = ["py.typed"] + [tool.azure-sdk-build] pylint = true type_check_samples = true verifytypes = true pyright = true - - diff --git a/sdk/translation/azure-ai-translation-text/samples/README.md b/sdk/translation/azure-ai-translation-text/samples/README.md index d1edb056fde5..c11984eb0270 100644 --- a/sdk/translation/azure-ai-translation-text/samples/README.md +++ b/sdk/translation/azure-ai-translation-text/samples/README.md @@ -18,15 +18,12 @@ Translator Service is a cloud-based neural machine translation service that is p * Get Supported Languages * Translate * Transliterate -* Break Sentence -* Dictionary Lookup -* Dictionary Examples See the [README][README] of the Text Translator client library for more information, including useful links and instructions. # Create Client -Text Translation service is using two types of endpoints - Global and Custom. You can find more information in the [v3 Translator reference][TranslatorReference]. +Text Translation service is using two types of endpoints - Global and Custom. You can find more information in the [Translator reference][TranslatorReference]. ## Global Endpoint @@ -143,7 +140,7 @@ try: f"Number of supported languages for transliterate operation: {len(response.transliteration) if response.transliteration is not None else 0}" ) print( - f"Number of supported languages for dictionary operations: {len(response.dictionary) if response.dictionary is not None else 0}" + f"Number of supported models for translation: {len(response.models) if response.models is not None else 0}" ) if response.translation is not None: @@ -156,10 +153,8 @@ try: for key, value in response.transliteration.items(): print(f"{key} -- name: {value.name}, supported script count: {len(value.scripts)}") - if response.dictionary is not None: - print("Dictionary Languages:") - for key, value in response.dictionary.items(): - print(f"{key} -- name: {value.name}, supported target languages count: {len(value.translations)}") + if response.models is not None: + print(f"Models: {', '.join(response.models)}") except HttpResponseError as exception: if exception.error is not None: @@ -188,7 +183,7 @@ try: f"Number of supported languages for transliterate operation: {len(response.transliteration) if response.transliteration is not None else 0}" ) print( - f"Number of supported languages for dictionary operations: {len(response.dictionary) if response.dictionary is not None else 0}" + f"Number of supported models for translation: {len(response.models) if response.models is not None else 0}" ) if response.translation is not None: @@ -201,10 +196,8 @@ try: for key, value in response.transliteration.items(): print(f"{key} -- name: {value.name}, supported script count: {len(value.scripts)}") - if response.dictionary is not None: - print("Dictionary Languages:") - for key, value in response.dictionary.items(): - print(f"{key} -- name: {value.name}, supported target languages count: {len(value.translations)}") + if response.models is not None: + print(f"Models: {', '.join(response.models)}") except HttpResponseError as exception: if exception.error is not None: @@ -234,7 +227,7 @@ try: f"Number of supported languages for transliterate operation: {len(response.transliteration) if response.transliteration is not None else 0}" ) print( - f"Number of supported languages for dictionary operations: {len(response.dictionary) if response.dictionary is not None else 0}" + f"Number of supported models for translation: {len(response.models) if response.models is not None else 0}" ) if response.translation is not None: @@ -247,10 +240,8 @@ try: for key, value in response.transliteration.items(): print(f"{key} -- name: {value.name}, supported script count: {len(value.scripts)}") - if response.dictionary is not None: - print("Dictionary Languages:") - for key, value in response.dictionary.items(): - print(f"{key} -- name: {value.name}, supported target languages count: {len(value.translations)}") + if response.models is not None: + print(f"Models: {', '.join(response.models)}") except HttpResponseError as exception: if exception.error is not None: @@ -263,6 +254,12 @@ except HttpResponseError as exception: # Translate +The following examples use the updated API that requires importing additional models: + +```python +from azure.ai.translation.text.models import TranslateInputItem, TranslationTarget, TextType, ProfanityAction, ProfanityMarker +``` + ### Translate text Translate text from known source language to target language. @@ -282,7 +279,7 @@ try: if translation: for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -318,7 +315,48 @@ try: f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") + +except HttpResponseError as exception: + if exception.error is not None: + print(f"Error Code: {exception.error.code}") + print(f"Message: {exception.error.message}") + raise +``` + + + +### Translate with LLM + +You can now translate using a large language model. You can also specify gender and tone using LLM translations. + +> Using an LLM model requires you to have an Azure AI Foundry resource. For more information, see [Azure AI Translation Resources][Azure AI Translation Resources]. + + + +```python +try: + llm_model_name = "gpt-4o-mini" + tone = "formal" + gender = "female" + to_language = "zh-Hans" + input_text = "This is a test" + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language, deployment_name=llm_model_name, tone=tone, gender=gender)], + ) + + response = text_translator.translate(body=[input_text_element]) + translation = response[0] if response else None + + if translation: + detected_language = translation.detected_language + if detected_language: + print( + f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." + ) + for translated_text in translation.translations: + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}' using LLM.") except HttpResponseError as exception: if exception.error is not None: @@ -340,27 +378,22 @@ try: from_script = "Latn" from_language = "ar" to_script = "Latn" - to_language = ["zh-Hans"] - input_text_elements = ["hudha akhtabar."] - - response = text_translator.translate( - body=input_text_elements, - to_language=to_language, - from_script=from_script, - from_language=from_language, - to_script=to_script, + to_language = "zh-Hans" + input_text = "hudha akhtabar." + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language, script=to_script)], + language=from_language, + script=from_script, ) + + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: - if translation.source_text: - print(f"Source Text: {translation.source_text.text}") first_translation = translation.translations[0] if first_translation: - print(f"Translation: '{first_translation.text}'.") - transliteration = first_translation.transliteration - if transliteration: - print(f"Transliterated text ({transliteration.script}): {transliteration.text}") + print(f"Translation in transliteration script: '{first_translation.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -393,7 +426,7 @@ try: f"Detected languages of the input text: {translation.detected_language.language if translation.detected_language else None} with score: {translation.detected_language.score if translation.detected_language else None}." ) print( - f"Text was translated to: '{translation.translations[0].to if translation.translations else None}' and the result is: '{translation.translations[0].text if translation.translations else None}'." + f"Text was translated to: '{translation.translations[0].language if translation.translations else None}' and the result is: '{translation.translations[0].text if translation.translations else None}'." ) except HttpResponseError as exception: @@ -425,7 +458,7 @@ try: f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -444,10 +477,15 @@ You can select whether the translated text is plain text or HTML text. Any HTML ```python try: text_type = TextType.HTML - to_language = ["cs"] - input_text_elements = ["This is a test."] + to_language = "cs" + input_text = "This is a test." + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language)], + text_type=text_type, + ) - response = text_translator.translate(body=input_text_elements, to_language=to_language, text_type=text_type) + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: @@ -457,7 +495,7 @@ try: f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -477,22 +515,21 @@ It's sometimes useful to exclude specific content from translation. You can use try: text_type = TextType.HTML from_language = "en" - to_language = ["cs"] - input_text_elements = [ - '
This will not be translated.
This will be translated.
' - ] - - response = text_translator.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, + to_language = "cs" + input_text = '
This will not be translated.
This will be translated.
' + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language)], + language=from_language, text_type=text_type, ) + + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -513,19 +550,20 @@ If you already know the translation you want to apply to a word or a phrase, you ```python try: from_language = "en" - to_language = ["cs"] - input_text_elements = [ - 'The word wordomatic is a dictionary entry.' - ] - - response = text_translator.translate( - body=input_text_elements, to_language=to_language, from_language=from_language + to_language = "cs" + input_text = 'The word wordomatic is a dictionary entry.' + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language)], + language=from_language, ) + + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -547,85 +585,14 @@ If you want to avoid getting profanity in the translation, regardless of the pre try: profanity_action = ProfanityAction.MARKED profanity_maker = ProfanityMarker.ASTERISK - to_language = ["cs"] - input_text_elements = ["This is ***."] - - response = text_translator.translate( - body=input_text_elements, - to_language=to_language, - profanity_action=profanity_action, - profanity_marker=profanity_maker, - ) - translation = response[0] if response else None - - if translation: - detected_language = translation.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." - ) - for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") -``` - - - -### Include alignments into translations - -You can ask translation service to include alignment projection from source text to translated text. - - - -```python -try: - include_alignment = True - to_language = ["cs"] - input_text_elements = ["The answer lies in machine translation."] - - response = text_translator.translate( - body=input_text_elements, to_language=to_language, include_alignment=include_alignment + to_language = "cs" + input_text = "This is ***." + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language, profanity_action=profanity_action, profanity_marker=profanity_maker)], ) - translation = response[0] if response else None - - if translation: - detected_language = translation.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." - ) - for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") - if translated_text.alignment: - print(f"Alignments: {translated_text.alignment.proj}") - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") -``` - - -### Include sentence length - -You can ask translator service to include sentence boundaries for the input text and the translated text. - - - -```python -try: - include_sentence_length = True - to_language = ["cs"] - input_text_elements = ["The answer lies in machine translation. This is a test."] - - response = text_translator.translate( - body=input_text_elements, to_language=to_language, include_sentence_length=include_sentence_length - ) + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: @@ -635,10 +602,7 @@ try: f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") - if translated_text.sent_len: - print(f"Source Sentence length: {translated_text.sent_len.src_sent_len}") - print(f"Translated Sentence length: {translated_text.sent_len.trans_sent_len}") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -661,10 +625,14 @@ It is possible to set `allow_fallback` parameter. It specifies that the service ```python try: category = "<>" - to_language = ["cs"] - input_text_elements = ["This is a test"] + to_language = "cs" + input_text = "This is a test" + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language, deployment_name=category)], + ) - response = text_translator.translate(body=input_text_elements, to_language=to_language, category=category) + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: @@ -674,7 +642,7 @@ try: f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print(f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -721,158 +689,18 @@ except HttpResponseError as exception: -# Break Sentence - -### Break Sentence with language and script parameters - -When the input language is known, you can provide those to the service call. - - - -```python -try: - from_language = "zh-Hans" - source_script = "Latn" - input_text_elements = ["zhè shì gè cè shì。"] - - response = text_translator.find_sentence_boundaries( - body=input_text_elements, language=from_language, script=source_script - ) - sentence_boundaries = response[0] if response else None - - if sentence_boundaries: - detected_language = sentence_boundaries.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." - ) - print(f"The detected sentence boundaries:") - for boundary in sentence_boundaries.sent_len: - print(boundary) - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - raise -``` - - - -### Break Sentence with auto-detection - -You can omit source language of the input text. In this case, API will try to auto-detect the language. - - - -```python -try: - input_text_elements = ["This is a test. This is the second sentence."] - - response = text_translator.find_sentence_boundaries(body=input_text_elements) - sentence_boundaries = response[0] if response else None - - if sentence_boundaries: - detected_language = sentence_boundaries.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." - ) - print(f"The detected sentence boundaries:") - for boundary in sentence_boundaries.sent_len: - print(boundary) - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") -``` - - - -# Dictionary - -### Dictionary Lookup - -Returns equivalent words for the source term in the target language. - - - -```python -try: - from_language = "en" - to_language = "es" - input_text_elements = ["fly"] - - response = text_translator.lookup_dictionary_entries( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - dictionary_entry = response[0] if response else None - - if dictionary_entry: - print(f"For the given input {len(dictionary_entry.translations)} entries were found in the dictionary.") - print( - f"First entry: '{dictionary_entry.translations[0].display_target}', confidence: {dictionary_entry.translations[0].confidence}." - ) - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - raise -``` - - - -### Dictionary Examples - -Returns grammatical structure and context examples for the source term and target term pair. - - - -```python -try: - from_language = "en" - to_language = "es" - input_text_elements = [DictionaryExampleTextItem(text="fly", translation="volar")] - - response = text_translator.lookup_dictionary_examples( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - dictionary_entry = response[0] if response else None - - if dictionary_entry: - print(f"For the given input {len(dictionary_entry.examples)} entries were found in the dictionary.") - print( - f"First example: '{dictionary_entry.examples[0].target_prefix}{dictionary_entry.examples[0].target_term}{dictionary_entry.examples[0].target_suffix}'." - ) - -except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") -raise -``` - - - * [Create Client][client_sample] * [Translate][translate_sample] * [Transliterate][transliterate_sample] -* [Break Sentence][breaksentence_sample] -* [Dictionary Lookup][dictionarylookup_sample] -* [Dictionary Examples][dictionaryexamples_sample] [README]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/README.md [client_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_client.py [languages_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_languages.py [translate_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_translate.py [transliterate_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_transliterate.py -[breaksentence_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_break_sentence.py -[dictionarylookup_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_lookup.py -[dictionaryexamples_sample]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_examples.py [static_access_token_credential]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/translation/azure-ai-translation-text/tests/static_access_token_credential.py [Container]: https://learn.microsoft.com/azure/ai-services/translator/containers/overview -[TranslatorReference]: https://learn.microsoft.com/azure/ai-services/translator/reference/v3-0-reference -[SovereignClouds]: https://learn.microsoft.com/azure/ai-services/translator/sovereign-clouds \ No newline at end of file +[TranslatorReference]: https://learn.microsoft.com/azure/ai-services/translator/text-translation/preview/overview +[SovereignClouds]: https://learn.microsoft.com/azure/ai-services/translator/sovereign-clouds +[Azure AI Translation Resources]: https://learn.microsoft.com/azure/ai-services/translator/how-to/create-translator-resource?tabs=foundry \ No newline at end of file diff --git a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_break_sentence.py b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_break_sentence.py deleted file mode 100644 index 86a0d4ca55b2..000000000000 --- a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_break_sentence.py +++ /dev/null @@ -1,89 +0,0 @@ -# ------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# -------------------------------------------------------------------------- - -""" -FILE: sample_text_translation_break_sentence.py - -DESCRIPTION: - This file contains sample snippets for the Text Translation service. - -USAGE: - python sample_text_translation_break_sentence.py - - Set the text translation endpoint environment variables with your own value before running the samples: - - 1) AZURE_TEXT_TRANSLATION_ENDPOINT - the endpoint to your Text Translation resource. - Note: the endpoint must be formatted to use the custom domain name for your resource: - https:\\.cognitiveservices.azure.com\ - - The create_text_translation_client_with_credential call requires additional variables: - 2) AZURE_TEXT_TRANSLATION_APIKEY - the API key to your Text Translation resource. - 3) AZURE_TEXT_TRANSLATION_REGION - the Azure Region of your Text Translation resource. -""" - -from azure.core.exceptions import HttpResponseError - -# ------------------------------------------------------------------------- -# Text translation client -# ------------------------------------------------------------------------- -import sample_text_translation_client - -text_translator = sample_text_translation_client.create_text_translation_client_with_credential() - - -def get_text_sentence_boundaries(): - # [START get_text_sentence_boundaries] - try: - from_language = "zh-Hans" - source_script = "Latn" - input_text_elements = ["zhè shì gè cè shì。"] - - response = text_translator.find_sentence_boundaries( - body=input_text_elements, language=from_language, script=source_script - ) - sentence_boundaries = response[0] if response else None - - if sentence_boundaries: - detected_language = sentence_boundaries.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." - ) - print(f"The detected sentence boundaries:") - for boundary in sentence_boundaries.sent_len: - print(boundary) - - except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - raise - # [END get_text_sentence_boundaries] - - -def get_text_sentence_boundaries_auto(): - # [START get_text_sentence_boundaries_auto] - try: - input_text_elements = ["This is a test. This is the second sentence."] - - response = text_translator.find_sentence_boundaries(body=input_text_elements) - sentence_boundaries = response[0] if response else None - - if sentence_boundaries: - detected_language = sentence_boundaries.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." - ) - print(f"The detected sentence boundaries:") - for boundary in sentence_boundaries.sent_len: - print(boundary) - - except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - # [END get_text_sentence_boundaries_auto] diff --git a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_client.py b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_client.py index 25e7004a4af7..b6e736155ff6 100644 --- a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_client.py +++ b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_client.py @@ -54,6 +54,7 @@ def create_text_translation_client_with_credential(): # [END create_text_translation_client_with_credential] return text_translator + def create_text_translation_client_custom_with_credential(): from azure.ai.translation.text import TextTranslationClient from azure.core.credentials import AzureKeyCredential @@ -66,6 +67,7 @@ def create_text_translation_client_custom_with_credential(): # [END create_text_translation_client_custom_with_credential] return text_translator + def create_text_translation_client_with_cognitive_services_token(): from azure.ai.translation.text import TextTranslationClient from azure.core.credentials import TokenCredential @@ -79,6 +81,7 @@ def create_text_translation_client_with_cognitive_services_token(): client = TextTranslationClient(credential=credential, audience="https://api.microsofttranslator.com/") # [END create_text_translation_client_with_cognitive_services_token] + def create_text_translation_client_with_entra_id_token(): from azure.ai.translation.text import TextTranslationClient from azure.identity import DefaultAzureCredential @@ -91,6 +94,7 @@ def create_text_translation_client_with_entra_id_token(): client = TextTranslationClient(credential=credential, region=region, resource_id=resource_id) # [END create_text_translation_client_with_entra_id_token] + def create_text_translation_client_custom_with_entra_id_token(): from azure.ai.translation.text import TextTranslationClient from azure.identity import DefaultAzureCredential diff --git a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_examples.py b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_examples.py deleted file mode 100644 index 5ffd4af66589..000000000000 --- a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_examples.py +++ /dev/null @@ -1,63 +0,0 @@ -# ------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# -------------------------------------------------------------------------- - -""" -FILE: sample_text_translation_dictionary_examples.py - -DESCRIPTION: - This file contains sample snippets for the Text Translation service. - -USAGE: - python sample_text_translation_dictionary_examples.py - - Set the text translation endpoint environment variables with your own value before running the samples: - - 1) AZURE_TEXT_TRANSLATION_ENDPOINT - the endpoint to your Text Translation resource. - Note: the endpoint must be formatted to use the custom domain name for your resource: - https:\\.cognitiveservices.azure.com\ - - The create_text_translation_client_with_credential call requires additional variables: - 2) AZURE_TEXT_TRANSLATION_APIKEY - the API key to your Text Translation resource. - 3) AZURE_TEXT_TRANSLATION_REGION - the Azure Region of your Text Translation resource. -""" -from azure.core.exceptions import HttpResponseError -from azure.ai.translation.text.models import DictionaryExampleTextItem - -# ------------------------------------------------------------------------- -# Text translation client -# ------------------------------------------------------------------------- -import sample_text_translation_client - -text_translator = sample_text_translation_client.create_text_translation_client_with_credential() - - -# ------------------------------------------------------------------------- -# Dictionary Lookup -# ------------------------------------------------------------------------- -def get_text_translation_dictionary_examples(): - # [START get_text_translation_dictionary_examples] - try: - from_language = "en" - to_language = "es" - input_text_elements = [DictionaryExampleTextItem(text="fly", translation="volar")] - - response = text_translator.lookup_dictionary_examples( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - dictionary_entry = response[0] if response else None - - if dictionary_entry: - print(f"For the given input {len(dictionary_entry.examples)} entries were found in the dictionary.") - print( - f"First example: '{dictionary_entry.examples[0].target_prefix}{dictionary_entry.examples[0].target_term}{dictionary_entry.examples[0].target_suffix}'." - ) - - except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - raise - # [END get_text_translation_dictionary_examples] diff --git a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_lookup.py b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_lookup.py deleted file mode 100644 index 2db0d329f1fa..000000000000 --- a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_dictionary_lookup.py +++ /dev/null @@ -1,63 +0,0 @@ -# ------------------------------------------------------------------------- -# Copyright (c) Microsoft Corporation. All rights reserved. -# Licensed under the MIT License. See License.txt in the project root for -# license information. -# -------------------------------------------------------------------------- - -""" -FILE: sample_text_translation_dictionary_lookup.py - -DESCRIPTION: - This file contains sample snippets for the Text Translation service. - -USAGE: - python sample_text_translation_dictionary_lookup.py - - Set the text translation endpoint environment variables with your own value before running the samples: - - 1) AZURE_TEXT_TRANSLATION_ENDPOINT - the endpoint to your Text Translation resource. - Note: the endpoint must be formatted to use the custom domain name for your resource: - https:\\.cognitiveservices.azure.com\ - - The create_text_translation_client_with_credential call requires additional variables: - 2) AZURE_TEXT_TRANSLATION_APIKEY - the API key to your Text Translation resource. - 3) AZURE_TEXT_TRANSLATION_REGION - the Azure Region of your Text Translation resource. -""" - -from azure.core.exceptions import HttpResponseError - -# ------------------------------------------------------------------------- -# Text translation client -# ------------------------------------------------------------------------- -import sample_text_translation_client - -text_translator = sample_text_translation_client.create_text_translation_client_with_credential() - - -# ------------------------------------------------------------------------- -# Dictionary Lookup -# ------------------------------------------------------------------------- -def get_text_translation_dictionary_lookup(): - # [START get_text_translation_dictionary_lookup] - try: - from_language = "en" - to_language = "es" - input_text_elements = ["fly"] - - response = text_translator.lookup_dictionary_entries( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - dictionary_entry = response[0] if response else None - - if dictionary_entry: - print(f"For the given input {len(dictionary_entry.translations)} entries were found in the dictionary.") - print( - f"First entry: '{dictionary_entry.translations[0].display_target}', confidence: {dictionary_entry.translations[0].confidence}." - ) - - except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - raise - # [END get_text_translation_dictionary_lookup] diff --git a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_languages.py b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_languages.py index 66f3cb8c0ee1..f9b3de1f6c38 100644 --- a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_languages.py +++ b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_languages.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # ------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for @@ -48,7 +49,7 @@ def get_text_translation_languages(): f"Number of supported languages for transliterate operation: {len(response.transliteration) if response.transliteration is not None else 0}" ) print( - f"Number of supported languages for dictionary operations: {len(response.dictionary) if response.dictionary is not None else 0}" + f"Number of supported models for translation: {len(response.models) if response.models is not None else 0}" ) if response.translation is not None: @@ -61,10 +62,8 @@ def get_text_translation_languages(): for key, value in response.transliteration.items(): print(f"{key} -- name: {value.name}, supported script count: {len(value.scripts)}") - if response.dictionary is not None: - print("Dictionary Languages:") - for key, value in response.dictionary.items(): - print(f"{key} -- name: {value.name}, supported target languages count: {len(value.translations)}") + if response.models is not None: + print(f"Models: {', '.join(response.models)}") except HttpResponseError as exception: if exception.error is not None: @@ -87,7 +86,7 @@ def get_text_translation_languages_scope(): f"Number of supported languages for transliterate operation: {len(response.transliteration) if response.transliteration is not None else 0}" ) print( - f"Number of supported languages for dictionary operations: {len(response.dictionary) if response.dictionary is not None else 0}" + f"Number of supported models for translation: {len(response.models) if response.models is not None else 0}" ) if response.translation is not None: @@ -100,10 +99,8 @@ def get_text_translation_languages_scope(): for key, value in response.transliteration.items(): print(f"{key} -- name: {value.name}, supported script count: {len(value.scripts)}") - if response.dictionary is not None: - print("Dictionary Languages:") - for key, value in response.dictionary.items(): - print(f"{key} -- name: {value.name}, supported target languages count: {len(value.translations)}") + if response.models is not None: + print(f"Models: {', '.join(response.models)}") except HttpResponseError as exception: if exception.error is not None: @@ -126,7 +123,7 @@ def get_text_translation_languages_culture(): f"Number of supported languages for transliterate operation: {len(response.transliteration) if response.transliteration is not None else 0}" ) print( - f"Number of supported languages for dictionary operations: {len(response.dictionary) if response.dictionary is not None else 0}" + f"Number of supported models for translation: {len(response.models) if response.models is not None else 0}" ) if response.translation is not None: @@ -139,10 +136,8 @@ def get_text_translation_languages_culture(): for key, value in response.transliteration.items(): print(f"{key} -- name: {value.name}, supported script count: {len(value.scripts)}") - if response.dictionary is not None: - print("Dictionary Languages:") - for key, value in response.dictionary.items(): - print(f"{key} -- name: {value.name}, supported target languages count: {len(value.translations)}") + if response.models is not None: + print(f"Models: {', '.join(response.models)}") except HttpResponseError as exception: if exception.error is not None: diff --git a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_translate.py b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_translate.py index 3f095a474f75..8d6a3f9d9cf9 100644 --- a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_translate.py +++ b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_translate.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # ------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for @@ -25,7 +26,13 @@ """ from azure.core.exceptions import HttpResponseError -from azure.ai.translation.text.models import TextType, ProfanityAction, ProfanityMarker +from azure.ai.translation.text.models import ( + TranslateInputItem, + TranslationTarget, + TextType, + ProfanityAction, + ProfanityMarker, +) # ------------------------------------------------------------------------- # Text translation client @@ -52,7 +59,9 @@ def get_text_translation(): if translation: for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." + ) except HttpResponseError as exception: if exception.error is not None: @@ -78,7 +87,9 @@ def get_text_translation_auto(): f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." + ) except HttpResponseError as exception: if exception.error is not None: @@ -88,33 +99,63 @@ def get_text_translation_auto(): # [END get_text_translation_auto] +def get_text_translation_with_llm(): + # [START get_text_translation_with_llm] + try: + llm_model_name = "gpt-4o-mini" + tone = "formal" + gender = "female" + to_language = "zh-Hans" + input_text = "This is a test" + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language, deployment_name=llm_model_name, tone=tone, gender=gender)], + ) + + response = text_translator.translate(body=[input_text_element]) + translation = response[0] if response else None + + if translation: + detected_language = translation.detected_language + if detected_language: + print( + f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." + ) + for translated_text in translation.translations: + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}' using LLM." + ) + + except HttpResponseError as exception: + if exception.error is not None: + print(f"Error Code: {exception.error.code}") + print(f"Message: {exception.error.message}") + raise + # [END get_text_translation_with_llm] + + def get_text_translation_with_transliteration(): # [START get_text_translation_with_transliteration] try: from_script = "Latn" from_language = "ar" to_script = "Latn" - to_language = ["zh-Hans"] - input_text_elements = ["hudha akhtabar."] - - response = text_translator.translate( - body=input_text_elements, - to_language=to_language, - from_script=from_script, - from_language=from_language, - to_script=to_script, + to_language = "zh-Hans" + input_text = "hudha akhtabar." + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language, script=to_script)], + language=from_language, + script=from_script, ) + + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: - if translation.source_text: - print(f"Source Text: {translation.source_text.text}") first_translation = translation.translations[0] if first_translation: - print(f"Translation: '{first_translation.text}'.") - transliteration = first_translation.transliteration - if transliteration: - print(f"Transliterated text ({transliteration.script}): {transliteration.text}") + print(f"Translation in transliteration script: '{first_translation.text}'.") except HttpResponseError as exception: if exception.error is not None: @@ -141,7 +182,7 @@ def get_text_translation_multiple_inputs(): f"Detected languages of the input text: {translation.detected_language.language if translation.detected_language else None} with score: {translation.detected_language.score if translation.detected_language else None}." ) print( - f"Text was translated to: '{translation.translations[0].to if translation.translations else None}' and the result is: '{translation.translations[0].text if translation.translations else None}'." + f"Text was translated to: '{translation.translations[0].language if translation.translations else None}' and the result is: '{translation.translations[0].text if translation.translations else None}'." ) except HttpResponseError as exception: @@ -167,7 +208,9 @@ def get_text_translation_multiple_languages(): f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." + ) except HttpResponseError as exception: if exception.error is not None: @@ -180,10 +223,15 @@ def get_text_translation_type(): # [START get_text_translation_type] try: text_type = TextType.HTML - to_language = ["cs"] - input_text_elements = ["This is a test."] + to_language = "cs" + input_text = "This is a test." + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language)], + text_type=text_type, + ) - response = text_translator.translate(body=input_text_elements, to_language=to_language, text_type=text_type) + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: @@ -193,7 +241,9 @@ def get_text_translation_type(): f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." + ) except HttpResponseError as exception: if exception.error is not None: @@ -207,22 +257,23 @@ def get_text_translation_exclude(): try: text_type = TextType.HTML from_language = "en" - to_language = ["cs"] - input_text_elements = [ - '
This will not be translated.
This will be translated.
' - ] - - response = text_translator.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, + to_language = "cs" + input_text = '
This will not be translated.
This will be translated.
' + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language)], + language=from_language, text_type=text_type, ) + + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." + ) except HttpResponseError as exception: if exception.error is not None: @@ -235,19 +286,22 @@ def get_text_translation_entity(): # [START get_text_translation_entity] try: from_language = "en" - to_language = ["cs"] - input_text_elements = [ - 'The word wordomatic is a dictionary entry.' - ] - - response = text_translator.translate( - body=input_text_elements, to_language=to_language, from_language=from_language + to_language = "cs" + input_text = 'The word wordomatic is a dictionary entry.' + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language)], + language=from_language, ) + + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." + ) except HttpResponseError as exception: if exception.error is not None: @@ -261,43 +315,18 @@ def get_text_translation_profanity(): try: profanity_action = ProfanityAction.MARKED profanity_maker = ProfanityMarker.ASTERISK - to_language = ["cs"] - input_text_elements = ["This is ***."] - - response = text_translator.translate( - body=input_text_elements, - to_language=to_language, - profanity_action=profanity_action, - profanity_marker=profanity_maker, - ) - translation = response[0] if response else None - - if translation: - detected_language = translation.detected_language - if detected_language: - print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." + to_language = "cs" + input_text = "This is ***." + input_text_element = TranslateInputItem( + text=input_text, + targets=[ + TranslationTarget( + language=to_language, profanity_action=profanity_action, profanity_marker=profanity_maker ) - for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") - - except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - # [END get_text_translation_profanity] - - -def get_text_translation_alignment(): - # [START get_text_translation_alignment] - try: - include_alignment = True - to_language = ["cs"] - input_text_elements = ["The answer lies in machine translation."] - - response = text_translator.translate( - body=input_text_elements, to_language=to_language, include_alignment=include_alignment + ], ) + + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: @@ -307,56 +336,29 @@ def get_text_translation_alignment(): f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") - if translated_text.alignment: - print(f"Alignments: {translated_text.alignment.proj}") - - except HttpResponseError as exception: - if exception.error is not None: - print(f"Error Code: {exception.error.code}") - print(f"Message: {exception.error.message}") - # [END get_text_translation_alignment] - - -def get_text_translation_sentence_length(): - # [START get_text_translation_sentence_length] - try: - include_sentence_length = True - to_language = ["cs"] - input_text_elements = ["The answer lies in machine translation. This is a test."] - - response = text_translator.translate( - body=input_text_elements, to_language=to_language, include_sentence_length=include_sentence_length - ) - translation = response[0] if response else None - - if translation: - detected_language = translation.detected_language - if detected_language: print( - f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." ) - for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") - if translated_text.sent_len: - print(f"Source Sentence length: {translated_text.sent_len.src_sent_len}") - print(f"Translated Sentence length: {translated_text.sent_len.trans_sent_len}") except HttpResponseError as exception: if exception.error is not None: print(f"Error Code: {exception.error.code}") print(f"Message: {exception.error.message}") - # [END get_text_translation_sentence_length] + # [END get_text_translation_profanity] def get_text_translation_custom(): # [START get_text_translation_custom] try: category = "<>" - to_language = ["cs"] - input_text_elements = ["This is a test"] + to_language = "cs" + input_text = "This is a test" + input_text_element = TranslateInputItem( + text=input_text, + targets=[TranslationTarget(language=to_language, deployment_name=category)], + ) - response = text_translator.translate(body=input_text_elements, to_language=to_language, category=category) + response = text_translator.translate(body=[input_text_element]) translation = response[0] if response else None if translation: @@ -366,7 +368,9 @@ def get_text_translation_custom(): f"Detected languages of the input text: {detected_language.language} with score: {detected_language.score}." ) for translated_text in translation.translations: - print(f"Text was translated to: '{translated_text.to}' and the result is: '{translated_text.text}'.") + print( + f"Text was translated to: '{translated_text.language}' and the result is: '{translated_text.text}'." + ) except HttpResponseError as exception: if exception.error is not None: diff --git a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_transliterate.py b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_transliterate.py index 14ea30724109..d0f15f9fd120 100644 --- a/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_transliterate.py +++ b/sdk/translation/azure-ai-translation-text/samples/sample_text_translation_transliterate.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # ------------------------------------------------------------------------- # Copyright (c) Microsoft Corporation. All rights reserved. # Licensed under the MIT License. See License.txt in the project root for diff --git a/sdk/translation/azure-ai-translation-text/setup.py b/sdk/translation/azure-ai-translation-text/setup.py deleted file mode 100644 index fd168a300310..000000000000 --- a/sdk/translation/azure-ai-translation-text/setup.py +++ /dev/null @@ -1,72 +0,0 @@ -# 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. -# -------------------------------------------------------------------------- -# coding: utf-8 - -import os -import re -from setuptools import setup, find_packages - - -PACKAGE_NAME = "azure-ai-translation-text" -PACKAGE_PPRINT_NAME = "Azure Ai Translation Text" - -# a-b-c => a/b/c -package_folder_path = PACKAGE_NAME.replace("-", "/") - -# Version extraction inspired from 'requests' -with open(os.path.join(package_folder_path, "_version.py"), "r") as fd: - version = re.search(r'^VERSION\s*=\s*[\'"]([^\'"]*)[\'"]', fd.read(), re.MULTILINE).group(1) - -if not version: - raise RuntimeError("Cannot find version information") - - -setup( - name=PACKAGE_NAME, - version=version, - description="Microsoft {} Client Library for Python".format(PACKAGE_PPRINT_NAME), - long_description=open("README.md", "r").read(), - long_description_content_type="text/markdown", - license="MIT License", - author="Microsoft Corporation", - author_email="azpysdkhelp@microsoft.com", - url="https://github.com/Azure/azure-sdk-for-python/tree/main/sdk", - keywords="azure, azure sdk", - classifiers=[ - "Development Status :: 5 - Production/Stable", - "Programming Language :: Python", - "Programming Language :: Python :: 3 :: Only", - "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.8", - "Programming Language :: Python :: 3.9", - "Programming Language :: Python :: 3.10", - "Programming Language :: Python :: 3.11", - "Programming Language :: Python :: 3.12", - "License :: OSI Approved :: MIT License", - ], - zip_safe=False, - packages=find_packages( - exclude=[ - "tests", - # Exclude packages that will be covered by PEP420 or nspkg - "azure", - "azure.ai", - "azure.ai.translation", - ] - ), - include_package_data=True, - package_data={ - "azure.ai.translation.text": ["py.typed"], - }, - install_requires=[ - "isodate>=0.6.1", - "azure-core>=1.30.0", - "typing-extensions>=4.6.0", - ], - python_requires=">=3.8", -) diff --git a/sdk/translation/azure-ai-translation-text/tests/test_break_sentence.py b/sdk/translation/azure-ai-translation-text/tests/test_break_sentence.py deleted file mode 100644 index 5ea0659a5f22..000000000000 --- a/sdk/translation/azure-ai-translation-text/tests/test_break_sentence.py +++ /dev/null @@ -1,77 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ - -from devtools_testutils import recorded_by_proxy -from preparer import TextTranslationPreparer -from testcase import TextTranslationTest - - -class TestBreakSentence(TextTranslationTest): - @TextTranslationPreparer() - @recorded_by_proxy - def test_autodetect(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - input_text_elements = ["Hello world"] - - response = client.find_sentence_boundaries(body=input_text_elements) - assert response is not None - assert response[0].detected_language.language == "en" - assert response[0].detected_language.score > 0.8 # Created bug: https://machinetranslation.visualstudio.com/MachineTranslation/_workitems/edit/164493 - assert response[0].sent_len[0] == 11 - - @TextTranslationPreparer() - @recorded_by_proxy - def test_with_language(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - input_text_elements = [ - "รวบรวมแผ่นคำตอบ ระยะเวลาของโครงการ วิธีเลือกชายในฝัน หมายเลขซีเรียลของระเบียน วันที่สิ้นสุดของโครงการเมื่อเสร็จสมบูรณ์ ปีที่มีการรวบรวม ทุกคนมีวัฒนธรรมและวิธีคิดเหมือนกัน ได้รับโทษจำคุกตลอดชีวิตใน ฉันลดได้ถึง 55 ปอนด์ได้อย่างไร ฉันคิดว่าใครๆ ก็ต้องการกำหนดเมนูอาหารส่วนบุคคล" - ] - - response = client.find_sentence_boundaries(body=input_text_elements, language="th") - assert response is not None - expected_lengths = [78, 41, 110, 46] - for i, expected_length in enumerate(expected_lengths): - assert expected_length == response[0].sent_len[i] - - @TextTranslationPreparer() - @recorded_by_proxy - def test_with_language_script(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - input_text_elements = ["zhè shì gè cè shì。"] - - response = client.find_sentence_boundaries(body=input_text_elements, language="zh-Hans", script="Latn") - assert response is not None - assert response[0].sent_len[0] == 18 - - @TextTranslationPreparer() - @recorded_by_proxy - def test_with_multiple_languages(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - input_text_elements = [ - "hello world", - "العالم هو مكان مثير جدا للاهتمام", - ] - - response = client.find_sentence_boundaries(body=input_text_elements) - assert response is not None - assert response[0].detected_language.language == "en" - assert response[1].detected_language.language == "ar" - assert response[0].sent_len[0] == 11 - assert response[1].sent_len[0] == 32 diff --git a/sdk/translation/azure-ai-translation-text/tests/test_break_sentence_async.py b/sdk/translation/azure-ai-translation-text/tests/test_break_sentence_async.py deleted file mode 100644 index cef2c50888d3..000000000000 --- a/sdk/translation/azure-ai-translation-text/tests/test_break_sentence_async.py +++ /dev/null @@ -1,83 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ - -from devtools_testutils.aio import recorded_by_proxy_async -from preparer import TextTranslationPreparer -from testcase import TextTranslationTest - - -class TestBreakSentenceAsync(TextTranslationTest): - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_autodetect(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - input_text_elements = ["Hello world"] - - async with client: - response = await client.find_sentence_boundaries(body=input_text_elements) - assert response is not None - assert response[0].detected_language.language == "en" - assert response[0].detected_language.score > 0.8 # Created bug: https://machinetranslation.visualstudio.com/MachineTranslation/_workitems/edit/164493 - assert response[0].sent_len[0] == 11 - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_with_language(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - input_text_elements = [ - "รวบรวมแผ่นคำตอบ ระยะเวลาของโครงการ วิธีเลือกชายในฝัน หมายเลขซีเรียลของระเบียน วันที่สิ้นสุดของโครงการเมื่อเสร็จสมบูรณ์ ปีที่มีการรวบรวม ทุกคนมีวัฒนธรรมและวิธีคิดเหมือนกัน ได้รับโทษจำคุกตลอดชีวิตใน ฉันลดได้ถึง 55 ปอนด์ได้อย่างไร ฉันคิดว่าใครๆ ก็ต้องการกำหนดเมนูอาหารส่วนบุคคล" - ] - - async with client: - response = await client.find_sentence_boundaries(body=input_text_elements, language="th") - assert response is not None - expected_lengths = [78, 41, 110, 46] - for i, expected_length in enumerate(expected_lengths): - assert expected_length == response[0].sent_len[i] - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_with_language_script(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - input_text_elements = ["zhè shì gè cè shì。"] - - async with client: - response = await client.find_sentence_boundaries( - body=input_text_elements, language="zh-Hans", script="Latn" - ) - assert response is not None - assert response[0].sent_len[0] == 18 - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_with_multiple_languages(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - input_text_elements = [ - "hello world", - "العالم هو مكان مثير جدا للاهتمام", - ] - - async with client: - response = await client.find_sentence_boundaries(body=input_text_elements) - assert response is not None - assert response[0].detected_language.language == "en" - assert response[1].detected_language.language == "ar" - assert response[0].sent_len[0] == 11 - assert response[1].sent_len[0] == 32 diff --git a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_examples.py b/sdk/translation/azure-ai-translation-text/tests/test_dictionary_examples.py deleted file mode 100644 index b0af55dba4f6..000000000000 --- a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_examples.py +++ /dev/null @@ -1,55 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ - -from devtools_testutils import recorded_by_proxy -from azure.ai.translation.text.models import DictionaryExampleTextItem -from preparer import TextTranslationPreparer -from testcase import TextTranslationTest - - -class TestDictionaryExamples(TextTranslationTest): - @TextTranslationPreparer() - @recorded_by_proxy - def test_single_input_element(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = [DictionaryExampleTextItem(text="fly", translation="volar")] - - response = client.lookup_dictionary_examples( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert response[0].normalized_source == "fly" - assert response[0].normalized_target == "volar" - - @TextTranslationPreparer() - @recorded_by_proxy - def test_multiple_input_elements(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = [ - DictionaryExampleTextItem(text="fly", translation="volar"), - DictionaryExampleTextItem(text="beef", translation="came"), - ] - - response = client.lookup_dictionary_examples( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert len(response) == 2 - assert response[0].normalized_source == "fly" - assert response[0].normalized_target == "volar" - assert response[1].normalized_source == "beef" - assert response[1].normalized_target == "came" diff --git a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_examples_async.py b/sdk/translation/azure-ai-translation-text/tests/test_dictionary_examples_async.py deleted file mode 100644 index b0150f7a300b..000000000000 --- a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_examples_async.py +++ /dev/null @@ -1,57 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ - -from devtools_testutils.aio import recorded_by_proxy_async -from azure.ai.translation.text.models import DictionaryExampleTextItem -from preparer import TextTranslationPreparer -from testcase import TextTranslationTest - - -class TestDictionaryExamplesAsync(TextTranslationTest): - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_single_input_element(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = [DictionaryExampleTextItem(text="fly", translation="volar")] - - async with client: - response = await client.lookup_dictionary_examples( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert response[0].normalized_source == "fly" - assert response[0].normalized_target == "volar" - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_multiple_input_elements(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = [ - DictionaryExampleTextItem(text="fly", translation="volar"), - DictionaryExampleTextItem(text="beef", translation="came"), - ] - - async with client: - response = await client.lookup_dictionary_examples( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert len(response) == 2 - assert response[0].normalized_source == "fly" - assert response[0].normalized_target == "volar" - assert response[1].normalized_source == "beef" - assert response[1].normalized_target == "came" diff --git a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_lookup.py b/sdk/translation/azure-ai-translation-text/tests/test_dictionary_lookup.py deleted file mode 100644 index 4f41246b69b9..000000000000 --- a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_lookup.py +++ /dev/null @@ -1,51 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ - -from devtools_testutils import recorded_by_proxy -from preparer import TextTranslationPreparer -from testcase import TextTranslationTest - - -class TestDictionaryLookup(TextTranslationTest): - @TextTranslationPreparer() - @recorded_by_proxy - def test_single_input_element(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = ["fly"] - - response = client.lookup_dictionary_entries( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert response[0].normalized_source == "fly" - assert response[0].display_source == "fly" - - @TextTranslationPreparer() - @recorded_by_proxy - def test_multiple_input_elements(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = ["fly", "fox"] - - response = client.lookup_dictionary_entries( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert len(response) == 2 - assert response[0].normalized_source == "fly" - assert response[0].display_source == "fly" - assert response[1].normalized_source == "fox" - assert response[1].display_source == "fox" diff --git a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_lookup_async.py b/sdk/translation/azure-ai-translation-text/tests/test_dictionary_lookup_async.py deleted file mode 100644 index c4e35c82c2df..000000000000 --- a/sdk/translation/azure-ai-translation-text/tests/test_dictionary_lookup_async.py +++ /dev/null @@ -1,53 +0,0 @@ -# ------------------------------------ -# Copyright (c) Microsoft Corporation. -# Licensed under the MIT License. -# ------------------------------------ - -from devtools_testutils.aio import recorded_by_proxy_async -from preparer import TextTranslationPreparer -from testcase import TextTranslationTest - - -class TestDictionaryLookupAsync(TextTranslationTest): - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_single_input_element(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = ["fly"] - - async with client: - response = await client.lookup_dictionary_entries( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert response[0].normalized_source == "fly" - assert response[0].display_source == "fly" - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_multiple_input_elements(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - from_language = "en" - to_language = "es" - input_text_elements = ["fly", "fox"] - - async with client: - response = await client.lookup_dictionary_entries( - body=input_text_elements, from_language=from_language, to_language=to_language - ) - assert response is not None - assert len(response) == 2 - assert response[0].normalized_source == "fly" - assert response[0].display_source == "fly" - assert response[1].normalized_source == "fox" - assert response[1].display_source == "fox" diff --git a/sdk/translation/azure-ai-translation-text/tests/test_get_languages.py b/sdk/translation/azure-ai-translation-text/tests/test_get_languages.py index 544a85c33006..5280acdd3575 100644 --- a/sdk/translation/azure-ai-translation-text/tests/test_get_languages.py +++ b/sdk/translation/azure-ai-translation-text/tests/test_get_languages.py @@ -16,9 +16,9 @@ def test_all_scopes(self, **kwargs): client = self.create_getlanguage_client(endpoint) response = client.get_supported_languages() - assert len(response.translation) > 0 - assert len(response.transliteration) > 0 - assert len(response.dictionary) > 0 + assert response.translation + assert response.transliteration + assert response.models @TextTranslationPreparer() @recorded_by_proxy @@ -27,7 +27,7 @@ def test_translation_scope(self, **kwargs): client = self.create_getlanguage_client(endpoint) response = client.get_supported_languages(scope="translation") - assert len(response.translation) > 0 + assert response.translation translations = response.translation["af"] assert translations.dir is not None assert translations.name is not None @@ -40,7 +40,7 @@ def test_transliteration_scope(self, **kwargs): client = self.create_getlanguage_client(endpoint) response = client.get_supported_languages(scope="transliteration") - assert len(response.transliteration) > 0 + assert response.transliteration transliterations = response.transliteration["be"] assert transliterations.name is not None assert transliterations.native_name is not None @@ -66,7 +66,7 @@ def test_transliteration_multiple_scripts(self, **kwargs): client = self.create_getlanguage_client(endpoint) response = client.get_supported_languages(scope="transliteration") - assert len(response.transliteration) > 0 + assert response.transliteration transliterations = response.transliteration["zh-Hant"] assert transliterations.name is not None assert transliterations.native_name is not None @@ -78,51 +78,10 @@ def test_transliteration_multiple_scripts(self, **kwargs): @TextTranslationPreparer() @recorded_by_proxy - def test_dictionary_scope(self, **kwargs): + def test_models_scope(self, **kwargs): endpoint = kwargs.get("text_translation_endpoint") client = self.create_getlanguage_client(endpoint) - response = client.get_supported_languages(scope="dictionary") + response = client.get_supported_languages(scope="models") - assert len(response.dictionary) > 0 - dictionaries = response.dictionary["de"] - assert dictionaries.name is not None - assert dictionaries.native_name is not None - - assert len(dictionaries.translations) > 0 - assert dictionaries.translations[0].code is not None - assert dictionaries.translations[0].dir is not None - assert dictionaries.translations[0].name is not None - assert dictionaries.translations[0].native_name is not None - - @TextTranslationPreparer() - @recorded_by_proxy - def test_dictionary_multiple_translations(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - client = self.create_getlanguage_client(endpoint) - response = client.get_supported_languages(scope="dictionary") - - assert len(response.dictionary) > 0 - dictionaries = response.dictionary["en"] - assert dictionaries.name is not None - assert dictionaries.native_name is not None - - assert len(dictionaries.translations) > 1 - assert dictionaries.translations[0].code is not None - assert dictionaries.translations[0].dir is not None - assert dictionaries.translations[0].name is not None - assert dictionaries.translations[0].native_name is not None - - @TextTranslationPreparer() - @recorded_by_proxy - def test_with_culture(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - client = self.create_getlanguage_client(endpoint) - response = client.get_supported_languages(accept_language="es") - - assert len(response.translation.items()) > 0 - assert len(response.transliteration.items()) > 0 - assert len(response.dictionary.items()) > 0 - translations = response.translation["en"] - assert translations.dir is not None - assert translations.name is not None - assert translations.native_name is not None + assert response.models + assert len(response.models) > 0 diff --git a/sdk/translation/azure-ai-translation-text/tests/test_get_languages_async.py b/sdk/translation/azure-ai-translation-text/tests/test_get_languages_async.py index e7818325453d..47561f7a9787 100644 --- a/sdk/translation/azure-ai-translation-text/tests/test_get_languages_async.py +++ b/sdk/translation/azure-ai-translation-text/tests/test_get_languages_async.py @@ -17,9 +17,9 @@ async def test_all_scopes(self, **kwargs): async with client: response = await client.get_supported_languages() - assert len(response.translation) > 0 - assert len(response.transliteration) > 0 - assert len(response.dictionary) > 0 + assert response.translation + assert response.transliteration + assert response.models @TextTranslationPreparer() @recorded_by_proxy_async @@ -29,7 +29,7 @@ async def test_translation_scope(self, **kwargs): async with client: response = await client.get_supported_languages(scope="translation") - assert len(response.translation) > 0 + assert response.translation translations = response.translation["af"] assert translations.dir is not None assert translations.name is not None @@ -43,7 +43,7 @@ async def test_transliteration_scope(self, **kwargs): async with client: response = await client.get_supported_languages(scope="transliteration") - assert len(response.transliteration) > 0 + assert response.transliteration transliterations = response.transliteration["be"] assert transliterations.name is not None assert transliterations.native_name is not None @@ -70,7 +70,7 @@ async def test_transliteration_multiple_scripts(self, **kwargs): async with client: response = await client.get_supported_languages(scope="transliteration") - assert len(response.transliteration) > 0 + assert response.transliteration transliterations = response.transliteration["zh-Hant"] assert transliterations.name is not None assert transliterations.native_name is not None @@ -82,54 +82,11 @@ async def test_transliteration_multiple_scripts(self, **kwargs): @TextTranslationPreparer() @recorded_by_proxy_async - async def test_dictionary_scope(self, **kwargs): + async def test_models_scope(self, **kwargs): endpoint = kwargs.get("text_translation_endpoint") client = self.create_async_getlanguage_client(endpoint) async with client: - response = await client.get_supported_languages(scope="dictionary") + response = await client.get_supported_languages(scope="models") - assert len(response.dictionary) > 0 - dictionaries = response.dictionary["de"] - assert dictionaries.name is not None - assert dictionaries.native_name is not None - - assert len(dictionaries.translations) > 0 - assert dictionaries.translations[0].code is not None - assert dictionaries.translations[0].dir is not None - assert dictionaries.translations[0].name is not None - assert dictionaries.translations[0].native_name is not None - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_dictionary_multiple_translations(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - client = self.create_async_getlanguage_client(endpoint) - async with client: - response = await client.get_supported_languages(scope="dictionary") - - assert len(response.dictionary) > 0 - dictionaries = response.dictionary["en"] - assert dictionaries.name is not None - assert dictionaries.native_name is not None - - assert len(dictionaries.translations) > 1 - assert dictionaries.translations[0].code is not None - assert dictionaries.translations[0].dir is not None - assert dictionaries.translations[0].name is not None - assert dictionaries.translations[0].native_name is not None - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_with_culture(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - client = self.create_async_getlanguage_client(endpoint) - async with client: - response = await client.get_supported_languages(accept_language="es") - - assert len(response.translation.items()) > 0 - assert len(response.transliteration.items()) > 0 - assert len(response.dictionary.items()) > 0 - translations = response.translation["en"] - assert translations.dir is not None - assert translations.name is not None - assert translations.native_name is not None + assert response.models + assert len(response.models) > 0 diff --git a/sdk/translation/azure-ai-translation-text/tests/test_translation.py b/sdk/translation/azure-ai-translation-text/tests/test_translation.py index ba4098075df8..7a7b2bd4ba09 100644 --- a/sdk/translation/azure-ai-translation-text/tests/test_translation.py +++ b/sdk/translation/azure-ai-translation-text/tests/test_translation.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # ------------------------------------ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. @@ -5,7 +6,13 @@ import pytest from devtools_testutils import recorded_by_proxy -from azure.ai.translation.text.models import TextType, ProfanityAction, ProfanityMarker +from azure.ai.translation.text.models import ( + TranslateInputItem, + TranslationTarget, + TextType, + ProfanityAction, + ProfanityMarker, +) from preparer import TextTranslationPreparer from testcase import TextTranslationTest @@ -26,7 +33,7 @@ def test_translate(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "cs" + assert response[0].translations[0].language == "cs" assert response[0].translations[0].text is not None @TextTranslationPreparer() @@ -43,101 +50,70 @@ def test_autodetect(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 - assert response[0].translations[0].to == "cs" + assert response[0].translations[0].language == "cs" assert response[0].translations[0].text is not None @TextTranslationPreparer() @recorded_by_proxy - def test_no_translate_tag(self, **kwargs): + def test_translate_using_llm(self, **kwargs): endpoint = kwargs.get("text_translation_endpoint") apikey = kwargs.get("text_translation_apikey") region = kwargs.get("text_translation_region") client = self.create_client(endpoint, apikey, region) - from_language = "zh-chs" - to_language = ["en"] - input_text_elements = ["今天是怎么回事是非常可怕的"] - response = client.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, - text_type=TextType.HTML, + input_text_element = TranslateInputItem( + text="Hola mundo", targets=[TranslationTarget(language="cs", deployment_name="gpt-4o-mini")], language="es" ) + response = client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 - assert "今天是怎么回事是" in response[0].translations[0].text - - @TextTranslationPreparer() - @recorded_by_proxy - def test_dictionary_tag(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - from_language = "en" - to_language = ["es"] - input_text_elements = [ - 'The word < mstrans:dictionary translation ="wordomatic">wordomatic is a dictionary entry.' - ] - response = client.translate(body=input_text_elements, to_language=to_language, from_language=from_language) - - assert len(response) == 1 - assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "es" - assert "wordomatic" in response[0].translations[0].text + assert response[0].translations[0].language == "cs" + assert response[0].translations[0].text is not None @TextTranslationPreparer() @recorded_by_proxy - def test_transliteration(self, **kwargs): + def test_no_translate_tag(self, **kwargs): endpoint = kwargs.get("text_translation_endpoint") apikey = kwargs.get("text_translation_apikey") region = kwargs.get("text_translation_region") client = self.create_client(endpoint, apikey, region) - from_language = "ar" - to_language = ["zh-Hans"] - input_text_elements = ["hudha akhtabar."] - response = client.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, - from_script="Latn", - to_script="Latn", + input_text_element = TranslateInputItem( + text="今天是怎么回事是非常可怕的", + targets=[TranslationTarget(language="en")], + language="zh-chs", + text_type=TextType.HTML, ) + response = client.translate(body=[input_text_element]) assert len(response) == 1 - assert response[0].source_text is not None assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "zh-Hans" - assert response[0].translations[0].text is not None + assert "今天是怎么回事是" in response[0].translations[0].text @TextTranslationPreparer() @recorded_by_proxy - def test_from_to_latin(self, **kwargs): + def test_transliteration(self, **kwargs): endpoint = kwargs.get("text_translation_endpoint") apikey = kwargs.get("text_translation_apikey") region = kwargs.get("text_translation_region") client = self.create_client(endpoint, apikey, region) - from_language = "hi" - to_language = ["ta"] - input_text_elements = ["ap kaise ho"] - response = client.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, - from_script="Latn", - to_script="Latn", + input_text_element = TranslateInputItem( + text="hudha akhtabar.", + targets=[TranslationTarget(language="zh-Hans", script="Latn")], + language="ar", + script="Latn", ) + response = client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].translations[0].language == "zh-Hans" assert response[0].translations[0].text is not None - assert "eppadi irukkiraai?" in response[0].translations[0].transliteration.text @TextTranslationPreparer() @recorded_by_proxy @@ -156,6 +132,9 @@ def test_multiple_input(self, **kwargs): response = client.translate(body=input_text_elements, to_language=to_language) assert len(response) == 3 + assert response[0].detected_language is not None + assert response[1].detected_language is not None + assert response[2].detected_language is not None assert response[0].detected_language.language == "en" assert response[1].detected_language.language == "es" assert response[2].detected_language.language == "de" @@ -176,11 +155,14 @@ def test_multiple_target_languages(self, **kwargs): client = self.create_client(endpoint, apikey, region) to_language = ["cs", "es", "de"] - input_text_elements = ["This is a test."] - response = client.translate(body=input_text_elements, to_language=to_language) + input_text_element = TranslateInputItem( + text="This is a test.", targets=[TranslationTarget(language=lang) for lang in to_language] + ) + response = client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 3 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 assert response[0].translations[0].text is not None @@ -196,11 +178,16 @@ def test_different_texttypes(self, **kwargs): client = self.create_client(endpoint, apikey, region) to_language = ["cs"] - input_text_elements = ["This is a test."] - response = client.translate(body=input_text_elements, to_language=to_language, text_type=TextType.HTML) + input_text_element = TranslateInputItem( + text="This is a test.", + targets=[TranslationTarget(language=lang) for lang in to_language], + text_type=TextType.HTML, + ) + response = client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 @@ -212,76 +199,24 @@ def test_profanity(self, **kwargs): region = kwargs.get("text_translation_region") client = self.create_client(endpoint, apikey, region) - to_language = ["zh-cn"] - input_text_elements = ["shit this is fucking crazy"] - response = client.translate( - body=input_text_elements, - to_language=to_language, - profanity_action=ProfanityAction.MARKED, - profanity_marker=ProfanityMarker.ASTERISK, + input_text_element = TranslateInputItem( + text="Shit this is fucking crazy", + targets=[ + TranslationTarget( + language="zh-cn", profanity_action=ProfanityAction.MARKED, profanity_marker=ProfanityMarker.ASTERISK + ) + ], ) + response = client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" - assert response[0].detected_language.score == 1 - #assert "***" in response[0].translations[0].text # Created bug: https://machinetranslation.visualstudio.com/MachineTranslation/_workitems/edit/164493 - - @TextTranslationPreparer() - @recorded_by_proxy - def test_alignment(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - to_language = ["cs"] - input_text_elements = ["It is a beautiful morning"] - response = client.translate(body=input_text_elements, to_language=to_language, include_alignment=True) - - assert len(response) == 1 - assert len(response[0].translations) == 1 - assert response[0].detected_language.language == "en" - assert response[0].detected_language.score == 1 - assert response[0].translations[0].alignment.proj is not None - - @TextTranslationPreparer() - @recorded_by_proxy - def test_sentence_length(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - to_language = ["fr"] - input_text_elements = [ - "La réponse se trouve dans la traduction automatique. La meilleure technologie de traduction automatique ne peut pas toujours fournir des traductions adaptées à un site ou des utilisateurs comme un être humain. Il suffit de copier et coller un extrait de code n'importe où." - ] - response = client.translate(body=input_text_elements, to_language=to_language, include_sentence_length=True) - - assert len(response) == 1 - assert len(response[0].translations) == 1 - assert response[0].detected_language.language == "fr" - assert response[0].detected_language.score == 1 - assert len(response[0].translations[0].sent_len.src_sent_len) == 3 - assert len(response[0].translations[0].sent_len.trans_sent_len) == 3 - - @TextTranslationPreparer() - @recorded_by_proxy - def test_custom_endpoint(self, **kwargs): - endpoint = kwargs.get("text_translation_custom_endpoint") - apikey = kwargs.get("text_translation_custom_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - to_language = ["fr"] - input_text_elements = ["It is a beautiful morning"] - response = client.translate(body=input_text_elements, to_language=to_language) - - assert len(response) == 1 - assert len(response[0].translations) == 1 - assert response[0].detected_language.language == "en" - assert response[0].detected_language.score == 1 + assert response[0].detected_language.score > 0.5 + assert ( + "***" in response[0].translations[0].text + ) # Created bug: https://machinetranslation.visualstudio.com/MachineTranslation/_workitems/edit/164493 @pytest.mark.live_test_only @TextTranslationPreparer() @@ -298,6 +233,7 @@ def test_token(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 @@ -317,7 +253,7 @@ def test_translate_aad(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "cs" + assert response[0].translations[0].language == "cs" assert response[0].translations[0].text is not None @pytest.mark.skip @@ -335,5 +271,5 @@ def test_translate_aad_custom(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "cs" + assert response[0].translations[0].language == "cs" assert response[0].translations[0].text is not None diff --git a/sdk/translation/azure-ai-translation-text/tests/test_translation_async.py b/sdk/translation/azure-ai-translation-text/tests/test_translation_async.py index d2bff209f6d2..4ef21aae8cce 100644 --- a/sdk/translation/azure-ai-translation-text/tests/test_translation_async.py +++ b/sdk/translation/azure-ai-translation-text/tests/test_translation_async.py @@ -1,3 +1,4 @@ +# pylint: disable=line-too-long,useless-suppression # ------------------------------------ # Copyright (c) Microsoft Corporation. # Licensed under the MIT License. @@ -6,7 +7,13 @@ import os import pytest from devtools_testutils.aio import recorded_by_proxy_async -from azure.ai.translation.text.models import TextType, ProfanityAction, ProfanityMarker +from azure.ai.translation.text.models import ( + TranslateInputItem, + TranslationTarget, + TextType, + ProfanityAction, + ProfanityMarker, +) from preparer import TextTranslationPreparer from testcase import TextTranslationTest @@ -30,7 +37,7 @@ async def test_translate(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "cs" + assert response[0].translations[0].language == "cs" assert response[0].translations[0].text is not None @TextTranslationPreparer() @@ -48,56 +55,51 @@ async def test_autodetect(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 - assert response[0].translations[0].to == "cs" + assert response[0].translations[0].language == "cs" assert response[0].translations[0].text is not None @TextTranslationPreparer() @recorded_by_proxy_async - async def test_no_translate_tag(self, **kwargs): + async def test_translate_using_llm(self, **kwargs): endpoint = kwargs.get("text_translation_endpoint") apikey = kwargs.get("text_translation_apikey") region = kwargs.get("text_translation_region") client = self.create_async_client(endpoint, apikey, region) - from_language = "zh-chs" - to_language = ["en"] - input_text_elements = ["今天是怎么回事是非常可怕的"] + input_text_element = TranslateInputItem( + text="Hola mundo", targets=[TranslationTarget(language="cs", deployment_name="gpt-4o-mini")], language="es" + ) async with client: - response = await client.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, - text_type=TextType.HTML, - ) + response = await client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 - assert "今天是怎么回事是" in response[0].translations[0].text + assert response[0].translations[0].language == "cs" + assert response[0].translations[0].text is not None @TextTranslationPreparer() @recorded_by_proxy_async - async def test_dictionary_tag(self, **kwargs): + async def test_no_translate_tag(self, **kwargs): endpoint = kwargs.get("text_translation_endpoint") apikey = kwargs.get("text_translation_apikey") region = kwargs.get("text_translation_region") client = self.create_async_client(endpoint, apikey, region) - from_language = "en" - to_language = ["es"] - input_text_elements = [ - 'The word < mstrans:dictionary translation ="wordomatic">wordomatic is a dictionary entry.' - ] + input_text_element = TranslateInputItem( + text="今天是怎么回事是非常可怕的", + targets=[TranslationTarget(language="en")], + language="zh-chs", + text_type=TextType.HTML, + ) async with client: - response = await client.translate( - body=input_text_elements, to_language=to_language, from_language=from_language - ) + response = await client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "es" - assert "wordomatic" in response[0].translations[0].text + assert "今天是怎么回事是" in response[0].translations[0].text @TextTranslationPreparer() @recorded_by_proxy_async @@ -107,48 +109,19 @@ async def test_transliteration(self, **kwargs): region = kwargs.get("text_translation_region") client = self.create_async_client(endpoint, apikey, region) - from_language = "ar" - to_language = ["zh-Hans"] - input_text_elements = ["hudha akhtabar."] - async with client: - response = await client.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, - from_script="Latn", - to_script="Latn", - ) - - assert len(response) == 1 - assert response[0].source_text is not None - assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "zh-Hans" - assert response[0].translations[0].text is not None - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_from_to_latin(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - from_language = "hi" - to_language = ["ta"] - input_text_elements = ["ap kaise ho"] + input_text_element = TranslateInputItem( + text="hudha akhtabar.", + targets=[TranslationTarget(language="zh-Hans", script="Latn")], + language="ar", + script="Latn", + ) async with client: - response = await client.translate( - body=input_text_elements, - to_language=to_language, - from_language=from_language, - from_script="Latn", - to_script="Latn", - ) + response = await client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].translations[0].language == "zh-Hans" assert response[0].translations[0].text is not None - assert "eppadi irukkiraai?" in response[0].translations[0].transliteration.text @TextTranslationPreparer() @recorded_by_proxy_async @@ -168,6 +141,9 @@ async def test_multiple_input(self, **kwargs): response = await client.translate(body=input_text_elements, to_language=to_language) assert len(response) == 3 + assert response[0].detected_language is not None + assert response[1].detected_language is not None + assert response[2].detected_language is not None assert response[0].detected_language.language == "en" assert response[1].detected_language.language == "es" assert response[2].detected_language.language == "de" @@ -194,6 +170,7 @@ async def test_multiple_target_languages(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 3 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 assert response[0].translations[0].text is not None @@ -209,14 +186,17 @@ async def test_different_texttypes(self, **kwargs): client = self.create_async_client(endpoint, apikey, region) to_language = ["cs"] - input_text_elements = ["This is a test."] + input_text_element = TranslateInputItem( + text="This is a test.", + targets=[TranslationTarget(language=lang) for lang in to_language], + text_type=TextType.HTML, + ) async with client: - response = await client.translate( - body=input_text_elements, to_language=to_language, text_type=TextType.HTML - ) + response = await client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 @@ -228,82 +208,25 @@ async def test_profanity(self, **kwargs): region = kwargs.get("text_translation_region") client = self.create_async_client(endpoint, apikey, region) - to_language = ["zh-cn"] - input_text_elements = ["shit this is fucking crazy"] - async with client: - response = await client.translate( - body=input_text_elements, - to_language=to_language, - profanity_action=ProfanityAction.MARKED, - profanity_marker=ProfanityMarker.ASTERISK, - ) - - assert len(response) == 1 - assert len(response[0].translations) == 1 - assert response[0].detected_language.language == "en" - assert response[0].detected_language.score == 1 - #assert "***" in response[0].translations[0].text # Created bug: https://machinetranslation.visualstudio.com/MachineTranslation/_workitems/edit/164493 - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_alignment(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - to_language = ["cs"] - input_text_elements = ["It is a beautiful morning"] - async with client: - response = await client.translate(body=input_text_elements, to_language=to_language, include_alignment=True) - - assert len(response) == 1 - assert len(response[0].translations) == 1 - assert response[0].detected_language.language == "en" - assert response[0].detected_language.score == 1 - assert response[0].translations[0].alignment.proj is not None - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_sentence_length(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - to_language = ["fr"] - input_text_elements = [ - "La réponse se trouve dans la traduction automatique. La meilleure technologie de traduction automatique ne peut pas toujours fournir des traductions adaptées à un site ou des utilisateurs comme un être humain. Il suffit de copier et coller un extrait de code n'importe où." - ] - async with client: - response = await client.translate( - body=input_text_elements, to_language=to_language, include_sentence_length=True - ) - - assert len(response) == 1 - assert len(response[0].translations) == 1 - assert response[0].detected_language.language == "fr" - assert response[0].detected_language.score == 1 - assert len(response[0].translations[0].sent_len.src_sent_len) == 3 - assert len(response[0].translations[0].sent_len.trans_sent_len) == 3 - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_custom_endpoint(self, **kwargs): - endpoint = kwargs.get("text_translation_custom_endpoint") - apikey = kwargs.get("text_translation_custom_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - to_language = ["fr"] - input_text_elements = ["It is a beautiful morning"] + input_text_element = TranslateInputItem( + text="Shit this is fucking crazy", + targets=[ + TranslationTarget( + language="zh-cn", profanity_action=ProfanityAction.MARKED, profanity_marker=ProfanityMarker.ASTERISK + ) + ], + ) async with client: - response = await client.translate(body=input_text_elements, to_language=to_language) + response = await client.translate(body=[input_text_element]) assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" - assert response[0].detected_language.score == 1 + assert response[0].detected_language.score > 0.5 + assert ( + "***" in response[0].translations[0].text + ) # Created bug: https://machinetranslation.visualstudio.com/MachineTranslation/_workitems/edit/164493 @pytest.mark.live_test_only @TextTranslationPreparer() @@ -321,6 +244,7 @@ async def test_token(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 + assert response[0].detected_language is not None assert response[0].detected_language.language == "en" assert response[0].detected_language.score == 1 @@ -342,5 +266,5 @@ async def test_translate_aad(self, **kwargs): assert len(response) == 1 assert len(response[0].translations) == 1 - assert response[0].translations[0].to == "cs" + assert response[0].translations[0].language == "cs" assert response[0].translations[0].text is not None diff --git a/sdk/translation/azure-ai-translation-text/tests/test_transliteration.py b/sdk/translation/azure-ai-translation-text/tests/test_transliteration.py index dca33ad14409..249b3fe91fdd 100644 --- a/sdk/translation/azure-ai-translation-text/tests/test_transliteration.py +++ b/sdk/translation/azure-ai-translation-text/tests/test_transliteration.py @@ -48,34 +48,3 @@ def test_multiple_inputs(self, **kwargs): assert response is not None assert response[0].text is not None assert response[1].text is not None - - @TextTranslationPreparer() - @recorded_by_proxy - def test_edit_distance(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_client(endpoint, apikey, region) - - input_text_elements = [ - "gujarat", - "hadman", - "hukkabar", - ] - response = client.transliterate( - body=input_text_elements, - language="gu", - from_script="Latn", - to_script="Gujr", - ) - - assert response is not None - assert response[0].text is not None - assert response[1].text is not None - assert response[2].text is not None - - expected_texts = ["ગુજરાત", "હદમાં", "હુક્કાબાર"] - edit_distance_value = 0 - for i, expected_text in enumerate(expected_texts): - edit_distance_value = edit_distance_value + self.edit_distance(expected_text, response[i].text) - assert edit_distance_value < 6 diff --git a/sdk/translation/azure-ai-translation-text/tests/test_transliteration_async.py b/sdk/translation/azure-ai-translation-text/tests/test_transliteration_async.py index b8fa9e72837c..c9bd96745fd5 100644 --- a/sdk/translation/azure-ai-translation-text/tests/test_transliteration_async.py +++ b/sdk/translation/azure-ai-translation-text/tests/test_transliteration_async.py @@ -50,35 +50,3 @@ async def test_multiple_inputs(self, **kwargs): assert response is not None assert response[0].text is not None assert response[1].text is not None - - @TextTranslationPreparer() - @recorded_by_proxy_async - async def test_edit_distance(self, **kwargs): - endpoint = kwargs.get("text_translation_endpoint") - apikey = kwargs.get("text_translation_apikey") - region = kwargs.get("text_translation_region") - client = self.create_async_client(endpoint, apikey, region) - - input_text_elements = [ - "gujarat", - "hadman", - "hukkabar", - ] - async with client: - response = await client.transliterate( - body=input_text_elements, - language="gu", - from_script="Latn", - to_script="Gujr", - ) - - assert response is not None - assert response[0].text is not None - assert response[1].text is not None - assert response[2].text is not None - - expected_texts = ["ગુજરાત", "હદમાં", "હુક્કાબાર"] - edit_distance_value = 0 - for i, expected_text in enumerate(expected_texts): - edit_distance_value = edit_distance_value + self.edit_distance(expected_text, response[i].text) - assert edit_distance_value < 6 diff --git a/sdk/translation/azure-ai-translation-text/tsp-location.yaml b/sdk/translation/azure-ai-translation-text/tsp-location.yaml index 913c42604909..36b6ee69a579 100644 --- a/sdk/translation/azure-ai-translation-text/tsp-location.yaml +++ b/sdk/translation/azure-ai-translation-text/tsp-location.yaml @@ -1,3 +1,3 @@ -directory: specification/translation/Azure.AI.TextTranslation -commit: 5656333510e6c6b8c4027c73933349f1f16a0fe6 +directory: specification/translation/data-plane/TextTranslation +commit: d57e27e86c8832f5ceef6acc057ad301086f5541 repo: Azure/azure-rest-api-specs diff --git a/sdk/translation/test-resources.json b/sdk/translation/test-resources.json index 05e9f16a84c8..629d3ccb05d7 100644 --- a/sdk/translation/test-resources.json +++ b/sdk/translation/test-resources.json @@ -44,7 +44,7 @@ } }, "variables": { - "txtUniqueSubDomainName": "[format('{0}', parameters('baseName'))]", + "txtUniqueSubDomainName": "[format('{0}-foundry', parameters('baseName'))]", "txtEndpointValue": "[format('https://api.cognitive.microsofttranslator.com')]", "txtCustomEndpointValue": "[format('https://{0}.cognitiveservices.azure.com', parameters('baseName'))]", "txtRegionValue": "[format('{0}', parameters('location'))]", @@ -131,16 +131,55 @@ }, { "type": "Microsoft.CognitiveServices/accounts", - "apiVersion": "2017-04-18", + "apiVersion": "2023-05-01", "name": "[variables('txtUniqueSubDomainName')]", "location": "[parameters('location')]", "sku": { - "name": "S1" + "name": "S0" + }, + "kind": "AIServices", + "identity": { + "type": "SystemAssigned" }, - "kind": "TextTranslation", "properties": { - "customSubDomainName": "[variables('txtUniqueSubDomainName')]" - } + "customSubDomainName": "[variables('txtUniqueSubDomainName')]", + "publicNetworkAccess": "Enabled" + }, + "resources": [ + { + "type": "deployments", + "apiVersion": "2023-05-01", + "name": "gpt-4o-mini", + "dependsOn": [ + "[resourceId('Microsoft.CognitiveServices/accounts', variables('txtUniqueSubDomainName'))]" + ], + "sku": { + "name": "Standard", + "capacity": 10 + }, + "properties": { + "model": { + "format": "OpenAI", + "name": "gpt-4o-mini", + "version": "2024-07-18" + }, + "versionUpgradeOption": "OnceNewDefaultVersionAvailable" + } + } + ] + }, + { + "type": "Microsoft.Authorization/roleAssignments", + "apiVersion": "2018-09-01-preview", + "name": "[guid(concat('foundryUserRoleId', resourceGroup().id))]", + "properties": { + "roleDefinitionId": "[variables('roleDefinitionId')]", + "principalId": "[reference(resourceId('Microsoft.CognitiveServices/accounts', variables('txtUniqueSubDomainName')), '2023-05-01', 'full').identity.principalId]", + "principalType": "ServicePrincipal" + }, + "dependsOn": [ + "[resourceId('Microsoft.CognitiveServices/accounts', variables('txtUniqueSubDomainName'))]" + ] } ], "outputs": { @@ -150,7 +189,7 @@ }, "TEXT_TRANSLATION_APIKEY": { "type": "string", - "value": "[listKeys(resourceId('Microsoft.CognitiveServices/accounts', variables('txtUniqueSubDomainName')), '2017-04-18').key1]" + "value": "[listKeys(resourceId('Microsoft.CognitiveServices/accounts', variables('txtUniqueSubDomainName')), '2023-05-01').key1]" }, "TEXT_TRANSLATION_CUSTOM_ENDPOINT": { "type": "string", @@ -158,7 +197,7 @@ }, "TEXT_TRANSLATION_CUSTOM_APIKEY": { "type": "string", - "value": "[listKeys(resourceId('Microsoft.CognitiveServices/accounts', variables('txtUniqueSubDomainName')), '2017-04-18').key1]" + "value": "[listKeys(resourceId('Microsoft.CognitiveServices/accounts', variables('txtUniqueSubDomainName')), '2023-05-01').key1]" }, "TEXT_TRANSLATION_REGION": { "type": "string",