[Text Translation] Update the to parameter to to_language (#35735)

* [Text Translation] Change scopes to audiences

* Fixing PR comments

* Fix review feedback

* Fix PR comment

* Update sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_patch.py

Co-authored-by: Anna Tisch <[email protected]>

* Fixing PR comments

* Renaming to parameter

* Update release date

* Update changelog

* update paramtype for to_language

* regen code + post-processing

---------

Co-authored-by: Michal Materna <[email protected]>
Co-authored-by: Anna Tisch <[email protected]>
Co-authored-by: Krista Pratico <[email protected]>

Author: 4 people

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

@@ -1,6 +1,6 @@
 # Release History
 
-## 1.0.0 (2024-05-21)
+## 1.0.0 (2024-05-23)
 
 ### Features Added
   - Added support for Entra Id authentication.
@@ -10,6 +10,8 @@
   - All calls to the client using parameter `content` have been changed to use parameter `body`.
   - Users can call methods using just a string type instead of complex objects.
   - `get_languages` methods were changed to `get_supported_languages`.
+  - renamed `from_parameter` to `from_language`.
+  - renamed `to` parameter to `to_language`.
 
 ## 1.0.0b1 (2023-04-19)
 

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

@@ -140,10 +140,10 @@ Renders single source-language text to multiple target-language texts with a sin
 
 ```python
 try:
-    to = ["cs", "es", "de"]
+    to_language = ["cs", "es", "de"]
     input_text_elements = ["This is a test"]
 
-    response = text_translator.translate(body=input_text_elements, to=to)
+    response = text_translator.translate(body=input_text_elements, to_language=to_language)
     translation = response[0] if response else None
 
     if translation:
@@ -215,11 +215,11 @@ Identifies the positioning of sentence boundaries in a piece of text.
 ```python
 try:
     include_sentence_length = True
-    to = ["cs"]
+    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=to, include_sentence_length=include_sentence_length
+        body=input_text_elements, to_language=to_language, include_sentence_length=include_sentence_length
     )
     translation = response[0] if response else None
 
@@ -256,11 +256,11 @@ Returns equivalent words for the source term in the target language.
 ```python
 try:
     from_language = "en"
-    to = "es"
+    to_language = "es"
     input_text_elements = ["fly"]
 
     response = text_translator.lookup_dictionary_entries(
-        body=input_text_elements, from_language=from_language, to=to
+        body=input_text_elements, from_language=from_language, to_language=to_language
     )
     dictionary_entry = response[0] if response else None
 
@@ -292,11 +292,11 @@ Returns grammatical structure and context examples for the source term and targe
 ```python
 try:
     from_language = "en"
-    to = "es"
+    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=to
+        body=input_text_elements, from_language=from_language, to_language=to_language
     )
     dictionary_entry = response[0] if response else None
 

sdk/translation/azure-ai-translation-text/azure/ai/translation/text/_operations/_operations.py

@@ -84,7 +84,7 @@ def build_text_translation_get_supported_languages_request(  # pylint: disable=n
 
 def build_text_translation_translate_request(
     *,
-    to: 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,
@@ -110,7 +110,7 @@ def build_text_translation_translate_request(
     _url = "/translate"
 
     # Construct parameters
-    _params["to"] = [_SERIALIZER.query("to", q, "str") if q is not None else "" for q in to]
+    _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:
@@ -209,7 +209,7 @@ def build_text_translation_find_sentence_boundaries_request(  # pylint: disable=
 
 
 def build_text_translation_lookup_dictionary_entries_request(  # pylint: disable=name-too-long
-    *, from_language: str, to: str, client_trace_id: Optional[str] = None, **kwargs: Any
+    *, 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 {})
@@ -223,7 +223,7 @@ def build_text_translation_lookup_dictionary_entries_request(  # pylint: disable
 
     # Construct parameters
     _params["from"] = _SERIALIZER.query("from_language", from_language, "str")
-    _params["to"] = _SERIALIZER.query("to", to, "str")
+    _params["to"] = _SERIALIZER.query("to_language", to_language, "str")
     _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
 
     # Construct headers
@@ -237,7 +237,7 @@ def build_text_translation_lookup_dictionary_entries_request(  # pylint: disable
 
 
 def build_text_translation_lookup_dictionary_examples_request(  # pylint: disable=name-too-long
-    *, from_language: str, to: str, client_trace_id: Optional[str] = None, **kwargs: Any
+    *, 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 {})
@@ -251,7 +251,7 @@ def build_text_translation_lookup_dictionary_examples_request(  # pylint: disabl
 
     # Construct parameters
     _params["from"] = _SERIALIZER.query("from_language", from_language, "str")
-    _params["to"] = _SERIALIZER.query("to", to, "str")
+    _params["to"] = _SERIALIZER.query("to_language", to_language, "str")
     _params["api-version"] = _SERIALIZER.query("api_version", api_version, "str")
 
     # Construct headers
@@ -460,7 +460,7 @@ def translate(
         self,
         body: List[_models.InputTextItem],
         *,
-        to: 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,
@@ -483,13 +483,13 @@ def translate(
 
         :param body: Defines the content of the request. Required.
         :type body: list[~azure.ai.translation.text.models.InputTextItem]
-        :keyword to: Specifies the language of the output text. The target language must be one of the
-         supported languages included
+        :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: list[str]
+        :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
@@ -636,7 +636,7 @@ def translate(
         self,
         body: IO[bytes],
         *,
-        to: 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,
@@ -659,13 +659,13 @@ def translate(
 
         :param body: Defines the content of the request. Required.
         :type body: IO[bytes]
-        :keyword to: Specifies the language of the output text. The target language must be one of the
-         supported languages included
+        :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: list[str]
+        :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
@@ -805,7 +805,7 @@ def translate(
         self,
         body: Union[List[_models.InputTextItem], IO[bytes]],
         *,
-        to: 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,
@@ -828,13 +828,13 @@ def translate(
         :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: Specifies the language of the output text. The target language must be one of the
-         supported languages included
+        :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: list[str]
+        :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
@@ -987,7 +987,7 @@ def translate(
             _content = json.dumps(body, cls=SdkJSONEncoder, exclude_readonly=True)  # type: ignore
 
         _request = build_text_translation_translate_request(
-            to=to,
+            to_language=to_language,
             client_trace_id=client_trace_id,
             from_language=from_language,
             text_type=text_type,
@@ -1515,7 +1515,7 @@ def lookup_dictionary_entries(
         body: List[_models.InputTextItem],
         *,
         from_language: str,
-        to: str,
+        to_language: str,
         client_trace_id: Optional[str] = None,
         content_type: str = "application/json",
         **kwargs: Any
@@ -1531,10 +1531,10 @@ def lookup_dictionary_entries(
          The source language must be one of the supported languages included in the dictionary scope.
          Required.
         :paramtype from_language: str
-        :keyword to: Specifies the language of the output text.
+        :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: str
+        :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
@@ -1630,7 +1630,7 @@ def lookup_dictionary_entries(
         body: IO[bytes],
         *,
         from_language: str,
-        to: str,
+        to_language: str,
         client_trace_id: Optional[str] = None,
         content_type: str = "application/json",
         **kwargs: Any
@@ -1646,10 +1646,10 @@ def lookup_dictionary_entries(
          The source language must be one of the supported languages included in the dictionary scope.
          Required.
         :paramtype from_language: str
-        :keyword to: Specifies the language of the output text.
+        :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: str
+        :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
@@ -1738,7 +1738,7 @@ def lookup_dictionary_entries(
         body: Union[List[_models.InputTextItem], IO[bytes]],
         *,
         from_language: str,
-        to: str,
+        to_language: str,
         client_trace_id: Optional[str] = None,
         **kwargs: Any
     ) -> List[_models.DictionaryLookupItem]:
@@ -1754,10 +1754,10 @@ def lookup_dictionary_entries(
          The source language must be one of the supported languages included in the dictionary scope.
          Required.
         :paramtype from_language: str
-        :keyword to: Specifies the language of the output text.
+        :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: str
+        :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
@@ -1859,7 +1859,7 @@ def lookup_dictionary_entries(
 
         _request = build_text_translation_lookup_dictionary_entries_request(
             from_language=from_language,
-            to=to,
+            to_language=to_language,
             client_trace_id=client_trace_id,
             content_type=content_type,
             api_version=self._config.api_version,
@@ -1905,7 +1905,7 @@ def lookup_dictionary_examples(
         body: List[_models.DictionaryExampleTextItem],
         *,
         from_language: str,
-        to: str,
+        to_language: str,
         client_trace_id: Optional[str] = None,
         content_type: str = "application/json",
         **kwargs: Any
@@ -1921,10 +1921,10 @@ def lookup_dictionary_examples(
          The source language must be one of the supported languages included in the dictionary scope.
          Required.
         :paramtype from_language: str
-        :keyword to: Specifies the language of the output text.
+        :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: str
+        :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
@@ -1992,7 +1992,7 @@ def lookup_dictionary_examples(
         body: IO[bytes],
         *,
         from_language: str,
-        to: str,
+        to_language: str,
         client_trace_id: Optional[str] = None,
         content_type: str = "application/json",
         **kwargs: Any
@@ -2008,10 +2008,10 @@ def lookup_dictionary_examples(
          The source language must be one of the supported languages included in the dictionary scope.
          Required.
         :paramtype from_language: str
-        :keyword to: Specifies the language of the output text.
+        :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: str
+        :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
@@ -2067,7 +2067,7 @@ def lookup_dictionary_examples(
         body: Union[List[_models.DictionaryExampleTextItem], IO[bytes]],
         *,
         from_language: str,
-        to: str,
+        to_language: str,
         client_trace_id: Optional[str] = None,
         **kwargs: Any
     ) -> List[_models.DictionaryExampleItem]:
@@ -2083,10 +2083,10 @@ def lookup_dictionary_examples(
          The source language must be one of the supported languages included in the dictionary scope.
          Required.
         :paramtype from_language: str
-        :keyword to: Specifies the language of the output text.
+        :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: str
+        :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
@@ -2155,7 +2155,7 @@ def lookup_dictionary_examples(
 
         _request = build_text_translation_lookup_dictionary_examples_request(
             from_language=from_language,
-            to=to,
+            to_language=to_language,
             client_trace_id=client_trace_id,
             content_type=content_type,
             api_version=self._config.api_version,