Updates to show exception handling and more protocol method examples (d…

…otnet#42723) Adding new exception handling documentation --------- Co-authored-by: Scott Addie <[email protected]>
BillWagner · Sep 30, 2024 · 0f2ea15 · 0f2ea15
1 parent 824bde0
commit 0f2ea15
Show file tree

Hide file tree

Showing 9 changed files with 99 additions and 8 deletions.
diff --git a/docs/azure/sdk/protocol-convenience-methods.md b/docs/azure/sdk/protocol-convenience-methods.md
@@ -95,7 +95,7 @@ The preceding code demonstrates the following `System.ClientModel` convenience m
 
 The following code uses a `ChatClient` to call the `CompleteChat` protocol method:
 
-:::code source="snippets/protocol-convenience-methods/SCM/Protocol/Program.cs" highlight="26-31":::
+:::code source="snippets/protocol-convenience-methods/SCM/Protocol/Program.cs" highlight="31-34":::
 
 The preceding code demonstrates the following `System.ClientModel` protocol method patterns:
 
@@ -129,6 +129,20 @@ PipelineResponse response = result.GetRawResponse();
 
 ---
 
+## Handle exceptions
+
+When a service call fails, the service client throws an exception that exposes the HTTP status code and the details of the service response, if available. A `System.ClientModel`-dependent library throws a <xref:System.ClientModel.ClientResultException>, while an `Azure.Core`-dependent library throws a <xref:Azure.RequestFailedException>.
+
+# [System.ClientModel exceptions](#tab/system-clientmodel)
+
+:::code source="snippets/protocol-convenience-methods/AzureCore/ExceptionHandling/Program.cs" highlight="21-24":::
+
+# [Azure.Core exceptions](#tab/azure-core)
+
+:::code source="snippets/protocol-convenience-methods/SCM/ExceptionHandling/Program.cs" highlight="17-20":::
+
+---
+
 ## Protocol and convenience method usage guidance
 
 Although the Azure SDK for .NET client libraries provide the option to use either protocol or convenience methods, prioritize using convenience methods in most scenarios. Convenience methods are designed to improve the development experience and provide flexibility for authoring requests and handling responses. However, both method types can be used in your app as needed. Consider the following criteria when deciding which type of method to use.

diff --git a/...k/snippets/protocol-convenience-methods/AzureCore/Convenience/AzureCoreConvenience.csproj b/...k/snippets/protocol-convenience-methods/AzureCore/Convenience/AzureCoreConvenience.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net9.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>

diff --git a/...pets/protocol-convenience-methods/AzureCore/ExceptionHandling/AzureCoreConvenience.csproj b/...pets/protocol-convenience-methods/AzureCore/ExceptionHandling/AzureCoreConvenience.csproj
@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Azure.AI.ContentSafety" />
+    <PackageReference Include="Azure.Identity" />
+  </ItemGroup>
+
+</Project>
diff --git a/docs/azure/sdk/snippets/protocol-convenience-methods/AzureCore/ExceptionHandling/Program.cs b/docs/azure/sdk/snippets/protocol-convenience-methods/AzureCore/ExceptionHandling/Program.cs
@@ -0,0 +1,24 @@
+using Azure.AI.ContentSafety;
+using Azure.Identity;
+using Azure;
+
+// Create the client
+ContentSafetyClient client = new(
+    new Uri("https://contentsafetyai.cognitiveservices.azure.com/"),
+    new DefaultAzureCredential());
+
+try
+{
+    // Call the convenience method
+    AnalyzeTextResult result = client.AnalyzeText("What is Microsoft Azure?");
+
+    // Display the results
+    foreach (TextCategoriesAnalysis item in result.CategoriesAnalysis)
+    {
+        Console.WriteLine($"{item.Category}: {item.Severity}");
+    }
+} 
+catch (RequestFailedException ex)
+{
+    Console.WriteLine($"Error: {ex.Message}");
+}
diff --git a/...ure/sdk/snippets/protocol-convenience-methods/AzureCore/Protocol/AzureCoreProtocol.csproj b/...ure/sdk/snippets/protocol-convenience-methods/AzureCore/Protocol/AzureCoreProtocol.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net9.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>

diff --git a/docs/azure/sdk/snippets/protocol-convenience-methods/SCM/ExceptionHandling/Program.cs b/docs/azure/sdk/snippets/protocol-convenience-methods/SCM/ExceptionHandling/Program.cs
@@ -0,0 +1,21 @@
+using OpenAI.Chat;
+using System.ClientModel;
+
+// Create the client
+ChatClient client = new(
+    model: "gpt-4o-mini",
+    credential: Environment.GetEnvironmentVariable("OPENAI_API_KEY")!);
+
+try
+{
+    // Call the convenience method
+    ChatCompletion completion = client.CompleteChat("What is Microsoft Azure?");
+
+    // Display the results
+    Console.WriteLine($"[{completion.Role}]: {completion}");
+}
+catch (ClientResultException ex)
+{
+    Console.WriteLine($"Error: {ex.Message}");
+}
+
diff --git a/...ure/sdk/snippets/protocol-convenience-methods/SCM/ExceptionHandling/SCMConvenience.csproj b/...ure/sdk/snippets/protocol-convenience-methods/SCM/ExceptionHandling/SCMConvenience.csproj
@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="OpenAI" />
+  </ItemGroup>
+
+</Project>
diff --git a/docs/azure/sdk/snippets/protocol-convenience-methods/SCM/Protocol/Program.cs b/docs/azure/sdk/snippets/protocol-convenience-methods/SCM/Protocol/Program.cs
@@ -22,13 +22,16 @@
     """u8.ToArray());
 using BinaryContent content = BinaryContent.Create(input);
 
+var requestOptions = new RequestOptions();
+
+requestOptions.AddHeader("CustomHeader", "CustomHeaderValue");
+requestOptions.ErrorOptions = ClientErrorBehaviors.NoThrow;
+
 // Call the protocol method
 ClientResult result = client.CompleteChat(
     content,
-    new RequestOptions
-    {
-        ErrorOptions = ClientErrorBehaviors.NoThrow,
-    });
+    requestOptions
+);
 
 PipelineResponse response = result.GetRawResponse();
 

diff --git a/docs/azure/sdk/snippets/protocol-convenience-methods/SCM/Protocol/SCMProtocol.csproj b/docs/azure/sdk/snippets/protocol-convenience-methods/SCM/Protocol/SCMProtocol.csproj
@@ -2,7 +2,7 @@
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
-    <TargetFramework>net9.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <ImplicitUsings>enable</ImplicitUsings>
     <Nullable>enable</Nullable>
   </PropertyGroup>