From 05b757f4264907538e478b57fd1363512f49633b Mon Sep 17 00:00:00 2001 From: Salah Mostafa Date: Wed, 22 Sep 2021 18:25:50 +0200 Subject: [PATCH] Add markdowns for samples --- .../Sample1_AnalyzeConversationWithOptions.md | 32 ++++++++ ...Sample2_AnalyzeConversationWithLanguage.md | 38 ++++++++++ .../samples/Sample3_Deepstack.md | 76 +++++++++++++++++++ .../Sample1_AnalyzeConversationWithOptions.cs | 2 +- ...Sample2_AnalyzeConversationWithLanguage.cs | 2 +- .../tests/Samples/Sample3_Deepstack.cs | 2 +- 6 files changed, 149 insertions(+), 3 deletions(-) create mode 100644 sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample1_AnalyzeConversationWithOptions.md create mode 100644 sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample2_AnalyzeConversationWithLanguage.md create mode 100644 sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample3_Deepstack.md diff --git a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample1_AnalyzeConversationWithOptions.md b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample1_AnalyzeConversationWithOptions.md new file mode 100644 index 0000000000000..7a457e2c81f5b --- /dev/null +++ b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample1_AnalyzeConversationWithOptions.md @@ -0,0 +1,32 @@ +# Ask a question + +This sample demonstrates how to analyze an utterance. To get started, you'll need to create a Cognitive Language service endpoint and an API key. See the [README](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations/README.md) for links and instructions. + +To analyze an utterance, you need to first create a `ConversationAnalysisClient` using an endpoint and API key. These can be stored in an environment variable, configuration setting, or any way that works for your application. + +```C# Snippet:ConversationAnalysisClient_Create +Uri endpoint = new Uri("https://myaccount.api.cognitive.microsoft.com"); +AzureKeyCredential credential = new AzureKeyCredential("{api-key}"); + +ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential); +``` + +Once you have created a client, you can call synchronous or asynchronous methods. + +## Synchronous + +```C# Snippet:ConversationAnalysis_AnalyzeConversationWithOptions +AnalyzeConversationOptions options = new AnalyzeConversationOptions("Menu", "production", "We'll have 2 plates of seared salmon nigiri."); +Response response = client.AnalyzeConversation(options); + +Console.WriteLine($"Top intent: {response.Value.Prediction.TopIntent}"); +``` + +## Asynchronous + +```C# Snippet:ConversationAnalysis_AnalyzeConversationWithOptionsAsync + AnalyzeConversationOptions options = new AnalyzeConversationOptions("Menu", "production", "We'll have 2 plates of seared salmon nigiri."); +Response response = await client.AnalyzeConversationAsync(options); + +Console.WriteLine($"Top intent: {response.Value.Prediction.TopIntent}"); +``` diff --git a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample2_AnalyzeConversationWithLanguage.md b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample2_AnalyzeConversationWithLanguage.md new file mode 100644 index 0000000000000..f3f3f72489358 --- /dev/null +++ b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample2_AnalyzeConversationWithLanguage.md @@ -0,0 +1,38 @@ +# Ask a question + +This sample demonstrates how to analyze an utterance. To get started, you'll need to create a Cognitive Language service endpoint and an API key. See the [README](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations/README.md) for links and instructions. + +To analyze an utterance, you need to first create a `ConversationAnalysisClient` using an endpoint and API key. These can be stored in an environment variable, configuration setting, or any way that works for your application. + +```C# Snippet:ConversationAnalysisClient_Create +Uri endpoint = new Uri("https://myaccount.api.cognitive.microsoft.com"); +AzureKeyCredential credential = new AzureKeyCredential("{api-key}"); + +ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential); +``` + +Once you have created a client, you can call synchronous or asynchronous methods. + +## Synchronous + +```C# Snippet:ConversationAnalysis_AnalyzeConversationWithLanguage +AnalyzeConversationOptions options = new AnalyzeConversationOptions("Menu", "production", "Tendremos 2 platos de nigiri de salmón braseado.") +{ + anguage = "es" +}; +Response response = client.AnalyzeConversation(options); + +Console.WriteLine($"Top intent: {response.Value.Prediction.TopIntent}"); +``` + +## Asynchronous + +```C# Snippet:ConversationAnalysis_AnalyzeConversationAsync +AnalyzeConversationOptions options = new AnalyzeConversationOptions("Menu", "production", "Tendremos 2 platos de nigiri de salmón braseado.") +{ + anguage = "es" +}; + Response response = await client.AnalyzeConversationAsync(options); + +Console.WriteLine($"Top intent: {response.Value.Prediction.TopIntent}"); +``` diff --git a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample3_Deepstack.md b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample3_Deepstack.md new file mode 100644 index 0000000000000..862653224292a --- /dev/null +++ b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/samples/Sample3_Deepstack.md @@ -0,0 +1,76 @@ +# Ask a question + +This sample demonstrates how to analyze an utterance. To get started, you'll need to create a Cognitive Language service endpoint and an API key. See the [README](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/cognitivelanguage/Azure.AI.Language.Conversations/README.md) for links and instructions. + +To analyze an utterance, you need to first create a `ConversationAnalysisClient` using an endpoint and API key. These can be stored in an environment variable, configuration setting, or any way that works for your application. + +```C# Snippet:ConversationAnalysisClient_Create +Uri endpoint = new Uri("https://myaccount.api.cognitive.microsoft.com"); +AzureKeyCredential credential = new AzureKeyCredential("{api-key}"); + +ConversationAnalysisClient client = new ConversationAnalysisClient(endpoint, credential); +``` + +Once you have created a client, you can call synchronous or asynchronous methods. + +## Synchronous + +```C# Snippet:ConversationAnalysis_AnalyzeConversationDeepstack +Response response = client.AnalyzeConversation( + "Menu", + "production", + "We'll have 2 plates of seared salmon nigiri."); + +DeepstackPrediction deepstackPrediction = response.Value.Prediction as DeepstackPrediction; + +Console.WriteLine("Intents:"); +foreach (DeepstackIntent intent in deepstackPrediction.Intents) +{ + Console.WriteLine($"Category:{intent.Category}"); + Console.WriteLine($"Confidence Score:{intent.ConfidenceScore}"); + Console.WriteLine(); +} + +Console.WriteLine("Entities:"); +foreach (DeepstackEntity entity in deepstackPrediction.Entities) +{ + Console.WriteLine($"Category: {entity.Category}"); + Console.WriteLine($"Text: {entity.Text}"); + Console.WriteLine($"Offset: {entity.Offset}"); + Console.WriteLine($"Length: {entity.Length}"); + Console.WriteLine($"Confidence Score: {entity.ConfidenceScore}"); + Console.WriteLine(); +} +``` + +## Asynchronous + +```C# Snippet:ConversationAnalysis_AnalyzeConversationDeepstackAsync +AnalyzeConversationOptions options = new AnalyzeConversationOptions("We'll have 2 plates of seared salmon nigiri."); + +Response response = await client.AnalyzeConversationAsync( + "Menu", + "production", + "We'll have 2 plates of seared salmon nigiri."); + +DeepstackPrediction deepstackPrediction = response.Value.Prediction as DeepstackPrediction; + +Console.WriteLine("Intents:"); +foreach (DeepstackIntent intent in deepstackPrediction.Intents) +{ + Console.WriteLine($"Category:{intent.Category}"); + Console.WriteLine($"Confidence Score:{intent.ConfidenceScore}"); + Console.WriteLine(); +} + +Console.WriteLine("Entities:"); +foreach (DeepstackEntity entity in deepstackPrediction.Entities) +{ + Console.WriteLine($"Category: {entity.Category}"); + Console.WriteLine($"Text: {entity.Text}"); + Console.WriteLine($"Offset: {entity.Offset}"); + Console.WriteLine($"Length: {entity.Length}"); + Console.WriteLine($"Confidence Score: {entity.ConfidenceScore}"); + Console.WriteLine(); +} +``` diff --git a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample1_AnalyzeConversationWithOptions.cs b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample1_AnalyzeConversationWithOptions.cs index a9569a7f3e9e5..822762a0f2514 100644 --- a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample1_AnalyzeConversationWithOptions.cs +++ b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample1_AnalyzeConversationWithOptions.cs @@ -47,7 +47,7 @@ public async Task AnalyzeConversationWithOptionsAsync() #if SNIPPET AnalyzeConversationOptions options = new AnalyzeConversationOptions("Menu", "production", "We'll have 2 plates of seared salmon nigiri."); - Response response = client.AnalyzeConversation(options); + Response response = await client.AnalyzeConversationAsync(options); #else AnalyzeConversationOptions options = new AnalyzeConversationOptions(TestEnvironment.ProjectName, TestEnvironment.DeploymentName, "We'll have 2 plates of seared salmon nigiri."); diff --git a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample2_AnalyzeConversationWithLanguage.cs b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample2_AnalyzeConversationWithLanguage.cs index 789f56fca7e51..f46eda91bff5b 100644 --- a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample2_AnalyzeConversationWithLanguage.cs +++ b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample2_AnalyzeConversationWithLanguage.cs @@ -56,7 +56,7 @@ public async Task AnalyzeConversationWithLanguageAsync() { Language = "es" }; - Response response = client.AnalyzeConversation(options); + Response response = await client.AnalyzeConversationAsync(options); #else AnalyzeConversationOptions options = new AnalyzeConversationOptions(TestEnvironment.ProjectName, TestEnvironment.DeploymentName, "Tendremos 2 platos de nigiri de salmón braseado.") diff --git a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample3_Deepstack.cs b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample3_Deepstack.cs index c4797eb6658ee..4f24dc1252306 100644 --- a/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample3_Deepstack.cs +++ b/sdk/cognitivelanguage/Azure.AI.Language.Conversations/tests/Samples/Sample3_Deepstack.cs @@ -66,7 +66,7 @@ public async Task AnalyzeConversationDeepstackAsync() #region Snippet:ConversationAnalysis_AnalyzeConversationDeepstackAsync #if SNIPPET - Response response = client.AnalyzeConversation( + Response response = await client.AnalyzeConversationAsync( "Menu", "production", "We'll have 2 plates of seared salmon nigiri.");