Addressing SDK archboard review comments (Azure#42706)

* Addressing SDK archboard review comments

* Fixing a few autogenerated files

* Re-generating SDK and adding all the updated files

* Some more autogeneration fixes

* Removing unsused imports

* Fixing readme documentation format

* A few more Readme format fixes

* Adding documentation for AAD auth for DT and SDT clients

* Addressing the remaining APIView comments on renaming models and using ResponseError from Azure.Core instead of TranslationError model

* Fixing a test failure issue

* Generating the SDK and fixing some issues with formatting and custom code

* Fixing samples and Readme

* Fixing Javadocs issue

* Fixing compilation error

* Going back to using DocumentFilter and removing the customization

* Fixing Readme file format issue

* Fixing another format issue in REadme file

* Re-generating sdk to fix some format issues

* Fixing checkstyle errors

* Making TranslationError models part of implementation package and adding custom code to return ResponseError

* Addressing review comments

Author: hamshavathimunibyraiah

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

@@ -4,6 +4,7 @@
 package com.azure.ai.translation.document;
 
 import com.azure.ai.translation.document.implementation.DocumentTranslationClientImpl;
+import com.azure.ai.translation.document.models.DocumentTranslationAudience;
 import com.azure.core.annotation.Generated;
 import com.azure.core.annotation.ServiceClientBuilder;
 import com.azure.core.client.traits.ConfigurationTrait;
@@ -59,13 +60,17 @@ public final class DocumentTranslationClientBuilder implements HttpTrait<Documen
     @Generated
     private static final String[] DEFAULT_SCOPES = new String[] { "https://cognitiveservices.azure.com/.default" };
 
+    private static final String DEFAULT_SCOPE = "/.default";
+
     @Generated
     private static final Map<String, String> PROPERTIES
         = CoreUtils.getProperties("azure-ai-translation-document.properties");
 
     @Generated
     private final List<HttpPipelinePolicy> pipelinePolicies;
 
+    private DocumentTranslationAudience audience;
+
     /**
      * Create an instance of the DocumentTranslationClientBuilder.
      */
@@ -268,6 +273,19 @@ public DocumentTranslationClientBuilder retryPolicy(RetryPolicy retryPolicy) {
         return this;
     }
 
+    /**
+     * Sets the Authentication audience used to authorize requests sent to the service.
+     *
+     * @param audience Token Audience.
+     * @return The updated {@link DocumentTranslationClientBuilder} object.
+     * @throws NullPointerException If {@code audience} is null.
+     */
+    public DocumentTranslationClientBuilder audience(DocumentTranslationAudience audience) {
+        Objects.requireNonNull(audience, "'audience' cannot be null.");
+        this.audience = audience;
+        return this;
+    }
+
     /**
      * Builds an instance of DocumentTranslationClientImpl with the provided parameters.
      *
@@ -285,6 +303,12 @@ private DocumentTranslationClientImpl buildInnerClient() {
     }
 
     @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+        Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
+    }
+
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration
             = (configuration == null) ? Configuration.getGlobalConfiguration() : configuration;
@@ -311,7 +335,11 @@ private HttpPipeline createHttpPipeline() {
             policies.add(new KeyCredentialPolicy("Ocp-Apim-Subscription-Key", keyCredential));
         }
         if (tokenCredential != null) {
-            policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
+            DocumentTranslationAudience authAudience = DocumentTranslationAudience.AZURE_PUBLIC_CLOUD;
+            if (this.audience != null) {
+                authAudience = this.audience;
+            }
+            policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, authAudience + DEFAULT_SCOPE));
         }
         this.pipelinePolicies.stream()
             .filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_RETRY)
@@ -346,11 +374,4 @@ public DocumentTranslationClient buildClient() {
     }
 
     private static final ClientLogger LOGGER = new ClientLogger(DocumentTranslationClientBuilder.class);
-
-    @Generated
-    private void validateClient() {
-        // This method is invoked from 'buildInnerClient'/'buildClient' method.
-        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
-        Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
-    }
 }

sdk/translation/azure-ai-translation-document/src/main/java/com/azure/ai/translation/document/DocumentTranslationAsyncClient.java

@@ -82,12 +82,11 @@ public final class SingleDocumentTranslationAsyncClient {
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    Mono<Response<BinaryData>> documentTranslateWithResponse(String targetLanguage, BinaryData documentTranslateContent,
+    Mono<Response<BinaryData>> translateWithResponse(String targetLanguage, BinaryData documentTranslateContent,
         RequestOptions requestOptions) {
-        // Protocol API requires serialization of parts with content-disposition and data, as operation
-        // 'documentTranslate' is 'multipart/form-data'
-        return this.serviceClient.documentTranslateWithResponseAsync(targetLanguage, documentTranslateContent,
-            requestOptions);
+        // Protocol API requires serialization of parts with content-disposition and data, as operation 'translate' is
+        // 'multipart/form-data'
+        return this.serviceClient.translateWithResponseAsync(targetLanguage, documentTranslateContent, requestOptions);
     }
 
     /**
@@ -119,9 +118,9 @@ Mono<Response<BinaryData>> documentTranslateWithResponse(String targetLanguage,
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<BinaryData> documentTranslate(String targetLanguage, DocumentTranslateContent documentTranslateContent,
+    public Mono<BinaryData> translate(String targetLanguage, DocumentTranslateContent documentTranslateContent,
         String sourceLanguage, String category, Boolean allowFallback) {
-        // Generated convenience method for documentTranslateWithResponse
+        // Generated convenience method for translateWithResponse
         RequestOptions requestOptions = new RequestOptions();
         if (sourceLanguage != null) {
             requestOptions.addQueryParam("sourceLanguage", sourceLanguage, false);
@@ -132,7 +131,7 @@ public Mono<BinaryData> documentTranslate(String targetLanguage, DocumentTransla
         if (allowFallback != null) {
             requestOptions.addQueryParam("allowFallback", String.valueOf(allowFallback), false);
         }
-        return documentTranslateWithResponse(targetLanguage,
+        return translateWithResponse(targetLanguage,
             new MultipartFormDataHelper(requestOptions)
                 .serializeFileField("document", documentTranslateContent.getDocument().getContent(),
                     documentTranslateContent.getDocument().getContentType(),
@@ -180,11 +179,10 @@ public Mono<BinaryData> documentTranslate(String targetLanguage, DocumentTransla
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public Mono<BinaryData> documentTranslate(String targetLanguage,
-        DocumentTranslateContent documentTranslateContent) {
-        // Generated convenience method for documentTranslateWithResponse
+    public Mono<BinaryData> translate(String targetLanguage, DocumentTranslateContent documentTranslateContent) {
+        // Generated convenience method for translateWithResponse
         RequestOptions requestOptions = new RequestOptions();
-        return documentTranslateWithResponse(targetLanguage,
+        return translateWithResponse(targetLanguage,
             new MultipartFormDataHelper(requestOptions)
                 .serializeFileField("document", documentTranslateContent.getDocument().getContent(),
                     documentTranslateContent.getDocument().getContentType(),

sdk/translation/azure-ai-translation-document/src/main/java/com/azure/ai/translation/document/DocumentTranslationClient.java

@@ -80,12 +80,11 @@ public final class SingleDocumentTranslationClient {
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    Response<BinaryData> documentTranslateWithResponse(String targetLanguage, BinaryData documentTranslateContent,
+    Response<BinaryData> translateWithResponse(String targetLanguage, BinaryData documentTranslateContent,
         RequestOptions requestOptions) {
-        // Protocol API requires serialization of parts with content-disposition and data, as operation
-        // 'documentTranslate' is 'multipart/form-data'
-        return this.serviceClient.documentTranslateWithResponse(targetLanguage, documentTranslateContent,
-            requestOptions);
+        // Protocol API requires serialization of parts with content-disposition and data, as operation 'translate' is
+        // 'multipart/form-data'
+        return this.serviceClient.translateWithResponse(targetLanguage, documentTranslateContent, requestOptions);
     }
 
     /**
@@ -117,9 +116,9 @@ Response<BinaryData> documentTranslateWithResponse(String targetLanguage, Binary
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public BinaryData documentTranslate(String targetLanguage, DocumentTranslateContent documentTranslateContent,
+    public BinaryData translate(String targetLanguage, DocumentTranslateContent documentTranslateContent,
         String sourceLanguage, String category, Boolean allowFallback) {
-        // Generated convenience method for documentTranslateWithResponse
+        // Generated convenience method for translateWithResponse
         RequestOptions requestOptions = new RequestOptions();
         if (sourceLanguage != null) {
             requestOptions.addQueryParam("sourceLanguage", sourceLanguage, false);
@@ -130,7 +129,7 @@ public BinaryData documentTranslate(String targetLanguage, DocumentTranslateCont
         if (allowFallback != null) {
             requestOptions.addQueryParam("allowFallback", String.valueOf(allowFallback), false);
         }
-        return documentTranslateWithResponse(targetLanguage,
+        return translateWithResponse(targetLanguage,
             new MultipartFormDataHelper(requestOptions)
                 .serializeFileField("document", documentTranslateContent.getDocument().getContent(),
                     documentTranslateContent.getDocument().getContentType(),
@@ -178,10 +177,10 @@ public BinaryData documentTranslate(String targetLanguage, DocumentTranslateCont
      */
     @Generated
     @ServiceMethod(returns = ReturnType.SINGLE)
-    public BinaryData documentTranslate(String targetLanguage, DocumentTranslateContent documentTranslateContent) {
-        // Generated convenience method for documentTranslateWithResponse
+    public BinaryData translate(String targetLanguage, DocumentTranslateContent documentTranslateContent) {
+        // Generated convenience method for translateWithResponse
         RequestOptions requestOptions = new RequestOptions();
-        return documentTranslateWithResponse(targetLanguage,
+        return translateWithResponse(targetLanguage,
             new MultipartFormDataHelper(requestOptions)
                 .serializeFileField("document", documentTranslateContent.getDocument().getContent(),
                     documentTranslateContent.getDocument().getContentType(),

sdk/translation/azure-ai-translation-document/src/main/java/com/azure/ai/translation/document/DocumentTranslationClientBuilder.java

@@ -4,6 +4,7 @@
 package com.azure.ai.translation.document;
 
 import com.azure.ai.translation.document.implementation.SingleDocumentTranslationClientImpl;
+import com.azure.ai.translation.document.models.DocumentTranslationAudience;
 import com.azure.core.annotation.Generated;
 import com.azure.core.annotation.ServiceClientBuilder;
 import com.azure.core.client.traits.ConfigurationTrait;
@@ -58,6 +59,8 @@ public final class SingleDocumentTranslationClientBuilder implements HttpTrait<S
     @Generated
     private static final String SDK_VERSION = "version";
 
+    private static final String DEFAULT_SCOPE = "/.default";
+
     @Generated
     private static final String[] DEFAULT_SCOPES = new String[] { "https://cognitiveservices.azure.com/.default" };
 
@@ -68,6 +71,8 @@ public final class SingleDocumentTranslationClientBuilder implements HttpTrait<S
     @Generated
     private final List<HttpPipelinePolicy> pipelinePolicies;
 
+    private DocumentTranslationAudience audience;
+
     /**
      * Create an instance of the SingleDocumentTranslationClientBuilder.
      */
@@ -159,6 +164,20 @@ public SingleDocumentTranslationClientBuilder retryOptions(RetryOptions retryOpt
         return this;
     }
 
+    /**
+     * Sets the Authentication audience used to authorize requests sent to the
+     * service.
+     *
+     * @param audience Token Audience.
+     * @return The updated {@link SingleDocumentTranslationClientBuilder} object.
+     * @throws NullPointerException If {@code audience} is null.
+     */
+    public SingleDocumentTranslationClientBuilder audience(DocumentTranslationAudience audience) {
+        Objects.requireNonNull(audience, "'audience' cannot be null.");
+        this.audience = audience;
+        return this;
+    }
+
     /**
      * {@inheritDoc}.
      */
@@ -287,6 +306,12 @@ private SingleDocumentTranslationClientImpl buildInnerClient() {
     }
 
     @Generated
+    private void validateClient() {
+        // This method is invoked from 'buildInnerClient'/'buildClient' method.
+        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
+        Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
+    }
+
     private HttpPipeline createHttpPipeline() {
         Configuration buildConfiguration
             = (configuration == null) ? Configuration.getGlobalConfiguration() : configuration;
@@ -313,7 +338,11 @@ private HttpPipeline createHttpPipeline() {
             policies.add(new KeyCredentialPolicy("Ocp-Apim-Subscription-Key", keyCredential));
         }
         if (tokenCredential != null) {
-            policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, DEFAULT_SCOPES));
+            DocumentTranslationAudience authAudience = DocumentTranslationAudience.AZURE_PUBLIC_CLOUD;
+            if (this.audience != null) {
+                authAudience = this.audience;
+            }
+            policies.add(new BearerTokenAuthenticationPolicy(tokenCredential, authAudience + DEFAULT_SCOPE));
         }
         this.pipelinePolicies.stream()
             .filter(p -> p.getPipelinePosition() == HttpPipelinePosition.PER_RETRY)
@@ -348,11 +377,4 @@ public SingleDocumentTranslationClient buildClient() {
     }
 
     private static final ClientLogger LOGGER = new ClientLogger(SingleDocumentTranslationClientBuilder.class);
-
-    @Generated
-    private void validateClient() {
-        // This method is invoked from 'buildInnerClient'/'buildClient' method.
-        // Developer can customize this method, to validate that the necessary conditions are met for the new client.
-        Objects.requireNonNull(endpoint, "'endpoint' cannot be null.");
-    }
 }