[TA and Translatior] Update snippets (#20552)

Azure · Apr 21, 2021 · 402c776 · 402c776
1 parent 2aa289c
commit 402c776
Show file tree

Hide file tree

Showing 12 changed files with 63 additions and 92 deletions.
diff --git a/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/SampleSnippets.cs b/sdk/textanalytics/Azure.AI.TextAnalytics/tests/samples/SampleSnippets.cs
@@ -17,23 +17,27 @@ public partial class Snippets: SamplesBase<TextAnalyticsTestEnvironment>
         [Test]
         public void CreateTextAnalyticsClient()
         {
+            #region Snippet:CreateTextAnalyticsClient
+#if SNIPPET
+            string endpoint = "<endpoint>";
+            string apiKey = "<apiKey>";
+#else
             string endpoint = TestEnvironment.Endpoint;
             string apiKey = TestEnvironment.ApiKey;
-
-            #region Snippet:CreateTextAnalyticsClient
-            //@@ string endpoint = "<endpoint>";
-            //@@ string apiKey = "<apiKey>";
+#endif
             var client = new TextAnalyticsClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
             #endregion
         }
 
         [Test]
         public void CreateTextAnalyticsClientTokenCredential()
         {
-            string endpoint = TestEnvironment.Endpoint;
-
             #region Snippet:CreateTextAnalyticsClientTokenCredential
-            //@@ string endpoint = "<endpoint>";
+#if SNIPPET
+            string endpoint = "<endpoint>";
+#else
+            string endpoint = TestEnvironment.Endpoint;
+#endif
             var client = new TextAnalyticsClient(new Uri(endpoint), new DefaultAzureCredential());
             #endregion
         }

diff --git a/sdk/translation/Azure.AI.Translation.Document/README.md b/sdk/translation/Azure.AI.Translation.Document/README.md
@@ -94,19 +94,19 @@ To start a translation operation you need to create one instance or a list of `D
 A single source URL to documents can be translated to many different languages:
 
 ```C# Snippet:DocumentTranslationSingleInput
-Uri sourceSasUri = <source SAS URI>;
-Uri frenchTargetSasUri = <french target SAS URI>;
+Uri sourceSasUri = new Uri("<source SAS URI>");
+Uri frenchTargetSasUri = new Uri("<french target SAS URI>");
 
 var input = new DocumentTranslationInput(sourceSasUri, frenchTargetSasUri, "fr");
 ```
 
 Or multiple different sources can be provided each with their own targets.
 
 ```C# Snippet:DocumentTranslationMultipleInputs
-Uri source1SasUri = <source1 SAS URI>;
-Uri source2SasUri = <source2 SAS URI>;
-Uri frenchTargetSasUri = <french target SAS URI>;
-Uri spanishTargetSasUri = <spanish target SAS URI>;
+Uri arabicTargetSasUri = new Uri("<arabic target SAS URI>");
+Uri spanishTargetSasUri = new Uri("<spanish target SAS URI>");
+Uri source1SasUri = new Uri("<source1 SAS URI>");
+Uri source2SasUri = new Uri("<source2 SAS URI>");
 
 var inputs = new List<DocumentTranslationInput>
 {
@@ -116,7 +116,7 @@ var inputs = new List<DocumentTranslationInput>
         targets: new List<TranslationTarget>
         {
             new TranslationTarget(frenchTargetSasUri, "fr"),
-            new TranslationTarget(spanishTargetSasUri, "es")
+            new TranslationTarget(arabicTargetSasUri, "ar")
         }),
 };
 ```
@@ -160,8 +160,8 @@ Note: our `DocumentTranslationClient` provides both synchronous and asynchronous
 Start a translation operation to translate documents in the source container and write the translated files to the target container. `DocumentTranslationOperation` allows you to poll the status of the translation operation and get the status of the individual documents.
 
 ```C# Snippet:StartTranslationAsync
-Uri sourceUri = <source SAS URI>;
-Uri targetUri = <target SAS URI>;
+Uri sourceUri = new Uri("<source SAS URI>");
+Uri targetUri = new Uri("<target SAS URI>");
 
 var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
 
@@ -232,12 +232,13 @@ Console.WriteLine($"Cancelled Documents: {docsCancelled}");
 Start a translation operation to translate documents in multiple source containers to multiple target containers in different languages. `DocumentTranslationOperation` allows you to poll the status of the translation operation and get the status of the individual documents.
 
 ```C# Snippet:MultipleInputsAsync
-Uri source1SasUriUri = <source1 SAS URI>;
-Uri source2SasUri = <source2 SAS URI>;
-Uri frenchTargetSasUri = <french target SAS URI>;
-Uri arabicTargetSasUri = <arabic target SAS URI>;
-Uri spanishTargetSasUri = <spanish target SAS URI>;
-Uri frenchGlossarySasUri = <french glossary SAS URI>;
+Uri source1SasUriUri = new Uri("<source1 SAS URI>");
+Uri source2SasUri = new Uri("<source2 SAS URI>");
+Uri frenchTargetSasUri = new Uri("<french target SAS URI>");
+Uri arabicTargetSasUri = new Uri("<arabic target SAS URI>");
+Uri spanishTargetSasUri = new Uri("<spanish target SAS URI>");
+Uri frenchGlossarySasUri = new Uri("<french glossary SAS URI>");
+
 var glossaryFormat = "TSV";
 
 var input1 = new DocumentTranslationInput(source1SasUriUri, frenchTargetSasUri, "fr", new TranslationGlossary(frenchGlossarySasUri, glossaryFormat));
@@ -279,8 +280,8 @@ await foreach (DocumentStatusResult document in operation.GetValuesAsync())
 Start a translation operation to translate documents in the source container and write the translated files to the target container. `DocumentTranslationOperation` allows you to poll the status of the translation operation and get the status of the individual documents.
 
 ```C# Snippet:StartTranslation
-Uri sourceUri = <source SAS URI>;
-Uri targetUri = <target SAS URI>;
+Uri sourceUri = new Uri("<source SAS URI>");
+Uri targetUri = new Uri("<target SAS URI>");
 
 var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
 
@@ -342,7 +343,7 @@ When you interact with the Cognitive Services Document Translation client librar
 For example, if you submit a request with an empty targets list, a `400` error is returned, indicating "Bad Request".
 
 ```C# Snippet:BadRequest
-var invalidInput = new DocumentTranslationInput(new TranslationSource(sourceSasUri, new List<TranslationTarget>());
+var invalidInput = new DocumentTranslationInput(new TranslationSource(new Uri(endpoint)), new List<TranslationTarget>());
 
 try
 {

diff --git a/sdk/translation/Azure.AI.Translation.Document/samples/Sample1_StartTranslation.md b/sdk/translation/Azure.AI.Translation.Document/samples/Sample1_StartTranslation.md
@@ -25,8 +25,8 @@ To call `StartTranslationAsync` you need to initialize an object of type `Docume
 More on generating SAS Tokens [here](https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/get-started-with-document-translation?tabs=csharp#create-sas-access-tokens-for-document-translation)
 
 ```C# Snippet:StartTranslationAsync
-Uri sourceUri = <source SAS URI>;
-Uri targetUri = <target SAS URI>;
+Uri sourceUri = new Uri("<source SAS URI>");
+Uri targetUri = new Uri("<target SAS URI>");
 
 var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
 

diff --git a/...lation/Azure.AI.Translation.Document/samples/Sample2_PollIndividualDocuments.md b/...lation/Azure.AI.Translation.Document/samples/Sample2_PollIndividualDocuments.md
@@ -18,8 +18,8 @@ var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCreden
 To poll the status of documents in an operation you use the `DocumentTranslationOperation` class which contains two functions `GetAllDocumentsStatusAsync` which returns the status of all documents in the operation and `GetDocumentStatusAsync` which returns the status of a specific document given its ID.
 
 ```C# Snippet:PollIndividualDocumentsAsync
-Uri sourceUri = <source SAS URI>;
-Uri targetUri = <target SAS URI>;
+Uri sourceUri = new Uri("<source SAS URI>");
+Uri targetUri = new Uri("<target SAS URI>");
 
 var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
 

diff --git a/sdk/translation/Azure.AI.Translation.Document/samples/Sample4_MultipleInputs.md b/sdk/translation/Azure.AI.Translation.Document/samples/Sample4_MultipleInputs.md
@@ -25,12 +25,13 @@ To call `StartTranslationAsync` you need to initialize a list of `DocumentTransl
 More on generating SAS Tokens [here](https://docs.microsoft.com/azure/cognitive-services/translator/document-translation/get-started-with-document-translation?tabs=csharp#create-sas-access-tokens-for-document-translation)
 
 ```C# Snippet:MultipleInputsAsync
-Uri source1SasUriUri = <source1 SAS URI>;
-Uri source2SasUri = <source2 SAS URI>;
-Uri frenchTargetSasUri = <french target SAS URI>;
-Uri arabicTargetSasUri = <arabic target SAS URI>;
-Uri spanishTargetSasUri = <spanish target SAS URI>;
-Uri frenchGlossarySasUri = <french glossary SAS URI>;
+Uri source1SasUriUri = new Uri("<source1 SAS URI>");
+Uri source2SasUri = new Uri("<source2 SAS URI>");
+Uri frenchTargetSasUri = new Uri("<french target SAS URI>");
+Uri arabicTargetSasUri = new Uri("<arabic target SAS URI>");
+Uri spanishTargetSasUri = new Uri("<spanish target SAS URI>");
+Uri frenchGlossarySasUri = new Uri("<french glossary SAS URI>");
+
 var glossaryFormat = "TSV";
 
 var input1 = new DocumentTranslationInput(source1SasUriUri, frenchTargetSasUri, "fr", new TranslationGlossary(frenchGlossarySasUri, glossaryFormat));

diff --git a/sdk/translation/Azure.AI.Translation.Document/tests/samples/SampleSnippets.cs b/sdk/translation/Azure.AI.Translation.Document/tests/samples/SampleSnippets.cs
@@ -18,12 +18,14 @@ public partial class SampleSnippets : SamplesBase<DocumentTranslationTestEnviron
         [Ignore("Samples not working yet")]
         public void CreateDocumentTranslationClient()
         {
+            #region Snippet:CreateDocumentTranslationClient
+#if SNIPPET
+            string endpoint = "<endpoint>";
+            string apiKey = "<apiKey>";
+#else
             string endpoint = TestEnvironment.Endpoint;
             string apiKey = TestEnvironment.ApiKey;
-
-            #region Snippet:CreateDocumentTranslationClient
-            //@@ string endpoint = "<endpoint>";
-            //@@ string apiKey = "<apiKey>";
+#endif
             var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
             #endregion
         }
@@ -32,17 +34,18 @@ public void CreateDocumentTranslationClient()
         [Ignore("Samples not working yet")]
         public void BadRequestSnippet()
         {
+#if SNIPPET
+            string endpoint = "<endpoint>";
+#else
             string endpoint = TestEnvironment.Endpoint;
+#endif
             string apiKey = TestEnvironment.ApiKey;
 
             var credentials = new AzureKeyCredential(apiKey);
             var client = new DocumentTranslationClient(new Uri(endpoint), credentials);
 
-            var invalidInput = new DocumentTranslationInput(new TranslationSource(new Uri(endpoint)), new List<TranslationTarget>());
-
             #region Snippet:BadRequest
-
-            //@@ var invalidInput = new DocumentTranslationInput(new TranslationSource(sourceSasUri, new List<TranslationTarget>());
+            var invalidInput = new DocumentTranslationInput(new TranslationSource(new Uri(endpoint)), new List<TranslationTarget>());
 
             try
             {
@@ -59,27 +62,19 @@ public void BadRequestSnippet()
         [Ignore("Samples not working yet")]
         public void DocumentTranslationInput()
         {
+            #region Snippet:DocumentTranslationSingleInput
             Uri sourceSasUri = new Uri("<source SAS URI>");
             Uri frenchTargetSasUri = new Uri("<french target SAS URI>");
-            Uri arabicTargetSasUri = new Uri("<arabic target SAS URI>");
-            Uri spanishTargetSasUri = new Uri("<spanish target SAS URI>");
-
-            #region Snippet:DocumentTranslationSingleInput
-            //@@ Uri sourceSasUri = <source SAS URI>;
-            //@@ Uri frenchTargetSasUri = <french target SAS URI>;
 
             var input = new DocumentTranslationInput(sourceSasUri, frenchTargetSasUri, "fr");
             #endregion
 
+            #region Snippet:DocumentTranslationMultipleInputs
+            Uri arabicTargetSasUri = new Uri("<arabic target SAS URI>");
+            Uri spanishTargetSasUri = new Uri("<spanish target SAS URI>");
             Uri source1SasUri = new Uri("<source1 SAS URI>");
             Uri source2SasUri = new Uri("<source2 SAS URI>");
 
-            #region Snippet:DocumentTranslationMultipleInputs
-            //@@ Uri source1SasUri = <source1 SAS URI>;
-            //@@ Uri source2SasUri = <source2 SAS URI>;
-            //@@ Uri frenchTargetSasUri = <french target SAS URI>;
-            //@@ Uri spanishTargetSasUri = <spanish target SAS URI>;
-
             var inputs = new List<DocumentTranslationInput>
             {
                 new DocumentTranslationInput(source1SasUri, spanishTargetSasUri, "es"),
@@ -88,7 +83,7 @@ public void DocumentTranslationInput()
                     targets: new List<TranslationTarget>
                     {
                         new TranslationTarget(frenchTargetSasUri, "fr"),
-                        new TranslationTarget(spanishTargetSasUri, "es")
+                        new TranslationTarget(arabicTargetSasUri, "ar")
                     }),
             };
             #endregion

diff --git a/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_MultipleInputs.cs b/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_MultipleInputs.cs
@@ -22,21 +22,14 @@ public void MultipleInputs()
 
             var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
 
+            #region Snippet:MultipleInputs
             Uri source1SasUriUri = new Uri("<source1 SAS URI>");
             Uri source2SasUri = new Uri("<source2 SAS URI>");
             Uri frenchTargetSasUri = new Uri("<french target SAS URI>");
             Uri arabicTargetSasUri = new Uri("<arabic target SAS URI>");
             Uri spanishTargetSasUri = new Uri("<spanish target SAS URI>");
             Uri frenchGlossarySasUri = new Uri("<french glossary SAS URI>");
 
-            #region Snippet:MultipleInputs
-
-            //@@ Uri source1SasUriUri = <source1 SAS URI>;
-            //@@ Uri source2SasUri = <source2 SAS URI>;
-            //@@ Uri frenchTargetSasUri = <french target SAS URI>;
-            //@@ Uri arabicTargetSasUri = <arabic target SAS URI>;
-            //@@ Uri spanishTargetSasUri = <spanish target SAS URI>;
-            //@@ Uri frenchGlossarySasUri = <french glossary SAS URI>;
             var glossaryFormat = "TSV";
 
             var input1 = new DocumentTranslationInput(source1SasUriUri, frenchTargetSasUri, "fr", new TranslationGlossary(frenchGlossarySasUri, glossaryFormat));

diff --git a/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_MultipleInputsAsync.cs b/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_MultipleInputsAsync.cs
@@ -22,21 +22,14 @@ public async Task MultipleInputsAsync()
 
             var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
 
+            #region Snippet:MultipleInputsAsync
             Uri source1SasUriUri = new Uri("<source1 SAS URI>");
             Uri source2SasUri = new Uri("<source2 SAS URI>");
             Uri frenchTargetSasUri = new Uri("<french target SAS URI>");
             Uri arabicTargetSasUri = new Uri("<arabic target SAS URI>");
             Uri spanishTargetSasUri = new Uri("<spanish target SAS URI>");
             Uri frenchGlossarySasUri = new Uri("<french glossary SAS URI>");
 
-            #region Snippet:MultipleInputsAsync
-
-            //@@ Uri source1SasUriUri = <source1 SAS URI>;
-            //@@ Uri source2SasUri = <source2 SAS URI>;
-            //@@ Uri frenchTargetSasUri = <french target SAS URI>;
-            //@@ Uri arabicTargetSasUri = <arabic target SAS URI>;
-            //@@ Uri spanishTargetSasUri = <spanish target SAS URI>;
-            //@@ Uri frenchGlossarySasUri = <french glossary SAS URI>;
             var glossaryFormat = "TSV";
 
             var input1 = new DocumentTranslationInput(source1SasUriUri, frenchTargetSasUri, "fr", new TranslationGlossary(frenchGlossarySasUri, glossaryFormat));

diff --git a/...translation/Azure.AI.Translation.Document/tests/samples/Sample_PollIndividualDocuments.cs b/...translation/Azure.AI.Translation.Document/tests/samples/Sample_PollIndividualDocuments.cs
@@ -21,14 +21,10 @@ public void PollIndividualDocuments()
 
             var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
 
+            #region Snippet:PollIndividualDocuments
             Uri sourceUri = new Uri("<source SAS URI>");
             Uri targetUri = new Uri("<target SAS URI>");
 
-            #region Snippet:PollIndividualDocuments
-
-            //@@ Uri sourceUri = <source SAS URI>;
-            //@@ Uri targetUri = <target SAS URI>;
-
             var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
             DocumentTranslationOperation operation = client.StartTranslation(input);
 

diff --git a/...lation/Azure.AI.Translation.Document/tests/samples/Sample_PollIndividualDocumentsAsync.cs b/...lation/Azure.AI.Translation.Document/tests/samples/Sample_PollIndividualDocumentsAsync.cs
@@ -21,14 +21,10 @@ public async Task PollIndividualDocumentsAsync()
 
             var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
 
+            #region Snippet:PollIndividualDocumentsAsync
             Uri sourceUri = new Uri("<source SAS URI>");
             Uri targetUri = new Uri("<target SAS URI>");
 
-            #region Snippet:PollIndividualDocumentsAsync
-
-            //@@ Uri sourceUri = <source SAS URI>;
-            //@@ Uri targetUri = <target SAS URI>;
-
             var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
 
             DocumentTranslationOperation operation = await client.StartTranslationAsync(input);

diff --git a/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_StartTranslation.cs b/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_StartTranslation.cs
@@ -21,14 +21,10 @@ public void StartTranslation()
 
             var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
 
+            #region Snippet:StartTranslation
             Uri sourceUri = new Uri("<source SAS URI>");
             Uri targetUri = new Uri("<target SAS URI>");
 
-            #region Snippet:StartTranslation
-
-            //@@ Uri sourceUri = <source SAS URI>;
-            //@@ Uri targetUri = <target SAS URI>;
-
             var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
 
             DocumentTranslationOperation operation = client.StartTranslation(input);

diff --git a/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_StartTranslationAsync.cs b/sdk/translation/Azure.AI.Translation.Document/tests/samples/Sample_StartTranslationAsync.cs
@@ -21,14 +21,10 @@ public async Task StartTranslationAsync()
 
             var client = new DocumentTranslationClient(new Uri(endpoint), new AzureKeyCredential(apiKey));
 
+            #region Snippet:StartTranslationAsync
             Uri sourceUri = new Uri("<source SAS URI>");
             Uri targetUri = new Uri("<target SAS URI>");
 
-            #region Snippet:StartTranslationAsync
-
-            //@@ Uri sourceUri = <source SAS URI>;
-            //@@ Uri targetUri = <target SAS URI>;
-
             var input = new DocumentTranslationInput(sourceUri, targetUri, "es");
 
             DocumentTranslationOperation operation = await client.StartTranslationAsync(input);