[DocumentIntelligence] Renaming and fixing the behavior of TrainingOperation (#46399)

kinelski · web-flow · commit 56e5a7f0efdb · 2024-10-03T10:12:57.000-07:00
diff --git a/sdk/documentintelligence/Azure.AI.DocumentIntelligence/CHANGELOG.md b/sdk/documentintelligence/Azure.AI.DocumentIntelligence/CHANGELOG.md
@@ -7,6 +7,7 @@
 ### Breaking Changes
 
 ### Bugs Fixed
+- Fixed a bug where calling `Operation.Id` would sometimes return an `InvalidOperationException` with message "The operation ID was not present in the service response.".
 
 ### Other Changes
 
diff --git a/sdk/documentintelligence/Azure.AI.DocumentIntelligence/assets.json b/sdk/documentintelligence/Azure.AI.DocumentIntelligence/assets.json
@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "net",
   "TagPrefix": "net/documentintelligence/Azure.AI.DocumentIntelligence",
-  "Tag": "net/documentintelligence/Azure.AI.DocumentIntelligence_900de40cad"
+  "Tag": "net/documentintelligence/Azure.AI.DocumentIntelligence_0e2741b29e"
 }
diff --git a/sdk/documentintelligence/Azure.AI.DocumentIntelligence/src/DocumentIntelligenceAdministrationClient.cs b/sdk/documentintelligence/Azure.AI.DocumentIntelligence/src/DocumentIntelligenceAdministrationClient.cs
@@ -11,7 +11,7 @@ namespace Azure.AI.DocumentIntelligence
     public partial class DocumentIntelligenceAdministrationClient
     {
         // CUSTOM CODE NOTE: we're overwriting the behavior of the BuildDocumentModel, ComposeModel,
-        // CopyModelTo, BuildClassifier, and CopyClassifierTo APIs to return an instance of TrainingOperation.
+        // CopyModelTo, BuildClassifier, and CopyClassifierTo APIs to return an instance of OperationWithId.
         // This is a workaround since Operation.Id is not supported by our generator yet (it throws a
         // NotSupportedException), but this ID is needed for the GetOperation API.
 
@@ -47,7 +47,7 @@ public virtual async Task<Operation<BinaryData>> BuildDocumentModelAsync(WaitUnt
             {
                 using HttpMessage message = CreateBuildDocumentModelRequest(content, context);
                 var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildDocumentModel", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -88,7 +88,7 @@ public virtual Operation<BinaryData> BuildDocumentModel(WaitUntil waitUntil, Req
             {
                 using HttpMessage message = CreateBuildDocumentModelRequest(content, context);
                 var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildDocumentModel", OperationFinalStateVia.OperationLocation, context, waitUntil);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -129,7 +129,7 @@ public virtual async Task<Operation<BinaryData>> ComposeModelAsync(WaitUntil wai
             {
                 using HttpMessage message = CreateComposeModelRequest(content, context);
                 var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.ComposeModel", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -170,7 +170,7 @@ public virtual Operation<BinaryData> ComposeModel(WaitUntil waitUntil, RequestCo
             {
                 using HttpMessage message = CreateComposeModelRequest(content, context);
                 var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.ComposeModel", OperationFinalStateVia.OperationLocation, context, waitUntil);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -214,7 +214,7 @@ public virtual async Task<Operation<BinaryData>> CopyModelToAsync(WaitUntil wait
             {
                 using HttpMessage message = CreateCopyModelToRequest(modelId, content, context);
                 var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyModelTo", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -258,7 +258,7 @@ public virtual Operation<BinaryData> CopyModelTo(WaitUntil waitUntil, string mod
             {
                 using HttpMessage message = CreateCopyModelToRequest(modelId, content, context);
                 var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyModelTo", OperationFinalStateVia.OperationLocation, context, waitUntil);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -299,7 +299,7 @@ public virtual async Task<Operation<BinaryData>> BuildClassifierAsync(WaitUntil
             {
                 using HttpMessage message = CreateBuildClassifierRequest(content, context);
                 var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildClassifier", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -340,7 +340,7 @@ public virtual Operation<BinaryData> BuildClassifier(WaitUntil waitUntil, Reques
             {
                 using HttpMessage message = CreateBuildClassifierRequest(content, context);
                 var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildClassifier", OperationFinalStateVia.OperationLocation, context, waitUntil);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -384,7 +384,7 @@ public virtual async Task<Operation<BinaryData>> CopyClassifierToAsync(WaitUntil
             {
                 using HttpMessage message = CreateCopyClassifierToRequest(classifierId, content, context);
                 var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyClassifierTo", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
@@ -428,7 +428,7 @@ public virtual Operation<BinaryData> CopyClassifierTo(WaitUntil waitUntil, strin
             {
                 using HttpMessage message = CreateCopyClassifierToRequest(classifierId, content, context);
                 var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyClassifierTo", OperationFinalStateVia.OperationLocation, context, waitUntil);
-                return new TrainingOperation(internalOperation);
+                return new OperationWithId(internalOperation);
             }
             catch (Exception e)
             {
diff --git a/sdk/documentintelligence/Azure.AI.DocumentIntelligence/src/DocumentIntelligenceClient.cs b/sdk/documentintelligence/Azure.AI.DocumentIntelligence/src/DocumentIntelligenceClient.cs
@@ -14,7 +14,7 @@ namespace Azure.AI.DocumentIntelligence
     public partial class DocumentIntelligenceClient
     {
         // CUSTOM CODE NOTE: we're overwriting the behavior of the AnalyzeDocument API to
-        // return an instance of TrainingOperation. This is a workaround since Operation.Id
+        // return an instance of OperationWithId. This is a workaround since Operation.Id
         // is not supported by our generator yet (it throws a NotSupportedException), but
         // this ID is needed for the GetAnalyzeResultPdf and the GetAnalyzeResultImage APIs.
 
@@ -62,18 +62,18 @@ public virtual async Task<Operation<BinaryData>> AnalyzeDocumentAsync(WaitUntil
             {
                 using HttpMessage message = CreateAnalyzeDocumentRequest(modelId, content, pages, locale, stringIndexType, features, queryFields, outputContentFormat, output, context);
                 var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceClient.AnalyzeDocument", OperationFinalStateVia.OperationLocation, context, WaitUntil.Started).ConfigureAwait(false);
-                var trainingOperation = new TrainingOperation(internalOperation);
+                var operationWithId = new OperationWithId(internalOperation);
 
                 // Workaround to obtain the operation ID. The operation-location header is only returned after
                 // the first request that starts the LRO. Because of this we're setting waitUntil to 'Started'
-                // above so we have time to extract the operation ID in the TrainingOperation constructor.
+                // above so we have time to extract the operation ID in the OperationWithId constructor.
 
                 if (waitUntil == WaitUntil.Completed)
                 {
-                    await trainingOperation.WaitForCompletionAsync(context?.CancellationToken ?? default).ConfigureAwait(false);
+                    await operationWithId.WaitForCompletionAsync(context?.CancellationToken ?? default).ConfigureAwait(false);
                 }
 
-                return trainingOperation;
+                return operationWithId;
             }
             catch (Exception e)
             {
@@ -126,18 +126,18 @@ public virtual Operation<BinaryData> AnalyzeDocument(WaitUntil waitUntil, string
             {
                 using HttpMessage message = CreateAnalyzeDocumentRequest(modelId, content, pages, locale, stringIndexType, features, queryFields, outputContentFormat, output, context);
                 var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceClient.AnalyzeDocument", OperationFinalStateVia.OperationLocation, context, WaitUntil.Started);
-                var trainingOperation = new TrainingOperation(internalOperation);
+                var operationWithId = new OperationWithId(internalOperation);
 
                 // Workaround to obtain the operation ID. The operation-location header is only returned after
                 // the first request that starts the LRO. Because of this we're setting waitUntil to 'Started'
-                // above so we have time to extract the operation ID in the TrainingOperation constructor.
+                // above so we have time to extract the operation ID in the OperationWithId constructor.
 
                 if (waitUntil == WaitUntil.Completed)
                 {
-                    trainingOperation.WaitForCompletion(context?.CancellationToken ?? default);
+                    operationWithId.WaitForCompletion(context?.CancellationToken ?? default);
                 }
 
-                return trainingOperation;
+                return operationWithId;
             }
             catch (Exception e)
             {
diff --git a/sdk/documentintelligence/Azure.AI.DocumentIntelligence/src/OperationWithId.cs b/sdk/documentintelligence/Azure.AI.DocumentIntelligence/src/OperationWithId.cs
@@ -2,13 +2,14 @@
 // Licensed under the MIT License.
 
 using System;
+using System.Text.Json;
 using System.Text.RegularExpressions;
 using System.Threading;
 using System.Threading.Tasks;
 
 namespace Azure.AI.DocumentIntelligence
 {
-    internal class TrainingOperation : Operation<BinaryData>
+    internal class OperationWithId : Operation<BinaryData>
     {
         private const string OperationIdNotFoundErrorMessage = "The operation ID was not present in the service response.";
 
@@ -20,7 +21,7 @@ internal class TrainingOperation : Operation<BinaryData>
 
         private readonly string _operationId;
 
-        internal TrainingOperation(Operation<BinaryData> internalOperation)
+        internal OperationWithId(Operation<BinaryData> internalOperation)
         {
             _internalOperation = internalOperation;
             _operationId = GetOperationId();
@@ -53,16 +54,37 @@ private string GetOperationId()
         {
             var response = GetRawResponse();
 
+            // The "operation-location" header may or may not be present depending on the type of
+            // request that was sent to the service. It depends on whether it was a GET or a POST
+            // request, as well as whether this is an analysis or a training operation. In case the
+            // header is missing, the operation ID must be extracted from the response body. We're
+            // contemplating both scenarios in the code below.
+
             if (response.Headers.TryGetValue("operation-location", out string operationLocation))
             {
                 var match = s_locationHeaderRegex.Match(operationLocation);
 
-                if (!match.Success || !match.Groups[1].Success)
+                if (match.Success && match.Groups[1].Success)
                 {
-                    return null;
+                    return match.Groups[1].Value;
                 }
+            }
+            else if (response.Content is not null)
+            {
+                try
+                {
+                    using var document = JsonDocument.Parse(response.Content);
 
-                return match.Groups[1].Value;
+                    if (document.RootElement.TryGetProperty("operationId", out JsonElement operationIdProperty))
+                    {
+                        return operationIdProperty.GetString();
+                    }
+                }
+                catch (JsonException)
+                {
+                    // Ignore the exception. Failing to extract the ID should not prevent users from
+                    // using most of this class' functionality.
+                }
             }
 
             return null;
diff --git a/sdk/documentintelligence/Azure.AI.DocumentIntelligence/tests/DocumentIntelligenceAdministrationClient/OperationWithIdLiveTests.cs b/sdk/documentintelligence/Azure.AI.DocumentIntelligence/tests/DocumentIntelligenceAdministrationClient/OperationWithIdLiveTests.cs
@@ -10,15 +10,15 @@
 
 namespace Azure.AI.DocumentIntelligence.Tests
 {
-    public class TrainingOperationLiveTests : DocumentIntelligenceLiveTestBase
+    public class OperationWithIdLiveTests : DocumentIntelligenceLiveTestBase
     {
         // Example: 3eb2e5b5-b9d3-4b5a-ac31-90d945f4b4e4
         private const string AnalysisOperationIdPattern = @"^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$";
 
         // Example: 31466498286_3eb2e5b5-b9d3-4b5a-ac31-90d945f4b4e4
         private const string TrainingOperationIdPattern = @"^[0-9]+_[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$";
 
-        public TrainingOperationLiveTests(bool isAsync)
+        public OperationWithIdLiveTests(bool isAsync)
             : base(isAsync)
         {
         }

Original file line number	Diff line number	Diff line change
`@@ -2,5 +2,5 @@`
`2`	`2`	`"AssetsRepo": "Azure/azure-sdk-assets",`
`3`	`3`	`"AssetsRepoPrefixPath": "net",`
`4`	`4`	`"TagPrefix": "net/documentintelligence/Azure.AI.DocumentIntelligence",`
`5`		`- "Tag": "net/documentintelligence/Azure.AI.DocumentIntelligence_900de40cad"`
	`5`	`+ "Tag": "net/documentintelligence/Azure.AI.DocumentIntelligence_0e2741b29e"`
`6`	`6`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ namespace Azure.AI.DocumentIntelligence`
`11`	`11`	`public partial class DocumentIntelligenceAdministrationClient`
`12`	`12`	`{`
`13`	`13`	`// CUSTOM CODE NOTE: we're overwriting the behavior of the BuildDocumentModel, ComposeModel,`
`14`		`- // CopyModelTo, BuildClassifier, and CopyClassifierTo APIs to return an instance of TrainingOperation.`
	`14`	`+ // CopyModelTo, BuildClassifier, and CopyClassifierTo APIs to return an instance of OperationWithId.`
`15`	`15`	`// This is a workaround since Operation.Id is not supported by our generator yet (it throws a`
`16`	`16`	`// NotSupportedException), but this ID is needed for the GetOperation API.`
`17`	`17`
`@@ -47,7 +47,7 @@ public virtual async Task<Operation<BinaryData>> BuildDocumentModelAsync(WaitUnt`
`47`	`47`	`{`
`48`	`48`	`using HttpMessage message = CreateBuildDocumentModelRequest(content, context);`
`49`	`49`	`var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildDocumentModel", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);`
`50`		`- return new TrainingOperation(internalOperation);`
	`50`	`+ return new OperationWithId(internalOperation);`
`51`	`51`	`}`
`52`	`52`	`catch (Exception e)`
`53`	`53`	`{`
`@@ -88,7 +88,7 @@ public virtual Operation<BinaryData> BuildDocumentModel(WaitUntil waitUntil, Req`
`88`	`88`	`{`
`89`	`89`	`using HttpMessage message = CreateBuildDocumentModelRequest(content, context);`
`90`	`90`	`var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildDocumentModel", OperationFinalStateVia.OperationLocation, context, waitUntil);`
`91`		`- return new TrainingOperation(internalOperation);`
	`91`	`+ return new OperationWithId(internalOperation);`
`92`	`92`	`}`
`93`	`93`	`catch (Exception e)`
`94`	`94`	`{`
`@@ -129,7 +129,7 @@ public virtual async Task<Operation<BinaryData>> ComposeModelAsync(WaitUntil wai`
`129`	`129`	`{`
`130`	`130`	`using HttpMessage message = CreateComposeModelRequest(content, context);`
`131`	`131`	`var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.ComposeModel", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);`
`132`		`- return new TrainingOperation(internalOperation);`
	`132`	`+ return new OperationWithId(internalOperation);`
`133`	`133`	`}`
`134`	`134`	`catch (Exception e)`
`135`	`135`	`{`
`@@ -170,7 +170,7 @@ public virtual Operation<BinaryData> ComposeModel(WaitUntil waitUntil, RequestCo`
`170`	`170`	`{`
`171`	`171`	`using HttpMessage message = CreateComposeModelRequest(content, context);`
`172`	`172`	`var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.ComposeModel", OperationFinalStateVia.OperationLocation, context, waitUntil);`
`173`		`- return new TrainingOperation(internalOperation);`
	`173`	`+ return new OperationWithId(internalOperation);`
`174`	`174`	`}`
`175`	`175`	`catch (Exception e)`
`176`	`176`	`{`
`@@ -214,7 +214,7 @@ public virtual async Task<Operation<BinaryData>> CopyModelToAsync(WaitUntil wait`
`214`	`214`	`{`
`215`	`215`	`using HttpMessage message = CreateCopyModelToRequest(modelId, content, context);`
`216`	`216`	`var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyModelTo", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);`
`217`		`- return new TrainingOperation(internalOperation);`
	`217`	`+ return new OperationWithId(internalOperation);`
`218`	`218`	`}`
`219`	`219`	`catch (Exception e)`
`220`	`220`	`{`
`@@ -258,7 +258,7 @@ public virtual Operation<BinaryData> CopyModelTo(WaitUntil waitUntil, string mod`
`258`	`258`	`{`
`259`	`259`	`using HttpMessage message = CreateCopyModelToRequest(modelId, content, context);`
`260`	`260`	`var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyModelTo", OperationFinalStateVia.OperationLocation, context, waitUntil);`
`261`		`- return new TrainingOperation(internalOperation);`
	`261`	`+ return new OperationWithId(internalOperation);`
`262`	`262`	`}`
`263`	`263`	`catch (Exception e)`
`264`	`264`	`{`
`@@ -299,7 +299,7 @@ public virtual async Task<Operation<BinaryData>> BuildClassifierAsync(WaitUntil`
`299`	`299`	`{`
`300`	`300`	`using HttpMessage message = CreateBuildClassifierRequest(content, context);`
`301`	`301`	`var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildClassifier", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);`
`302`		`- return new TrainingOperation(internalOperation);`
	`302`	`+ return new OperationWithId(internalOperation);`
`303`	`303`	`}`
`304`	`304`	`catch (Exception e)`
`305`	`305`	`{`
`@@ -340,7 +340,7 @@ public virtual Operation<BinaryData> BuildClassifier(WaitUntil waitUntil, Reques`
`340`	`340`	`{`
`341`	`341`	`using HttpMessage message = CreateBuildClassifierRequest(content, context);`
`342`	`342`	`var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.BuildClassifier", OperationFinalStateVia.OperationLocation, context, waitUntil);`
`343`		`- return new TrainingOperation(internalOperation);`
	`343`	`+ return new OperationWithId(internalOperation);`
`344`	`344`	`}`
`345`	`345`	`catch (Exception e)`
`346`	`346`	`{`
`@@ -384,7 +384,7 @@ public virtual async Task<Operation<BinaryData>> CopyClassifierToAsync(WaitUntil`
`384`	`384`	`{`
`385`	`385`	`using HttpMessage message = CreateCopyClassifierToRequest(classifierId, content, context);`
`386`	`386`	`var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyClassifierTo", OperationFinalStateVia.OperationLocation, context, waitUntil).ConfigureAwait(false);`
`387`		`- return new TrainingOperation(internalOperation);`
	`387`	`+ return new OperationWithId(internalOperation);`
`388`	`388`	`}`
`389`	`389`	`catch (Exception e)`
`390`	`390`	`{`
`@@ -428,7 +428,7 @@ public virtual Operation<BinaryData> CopyClassifierTo(WaitUntil waitUntil, strin`
`428`	`428`	`{`
`429`	`429`	`using HttpMessage message = CreateCopyClassifierToRequest(classifierId, content, context);`
`430`	`430`	`var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceAdministrationClient.CopyClassifierTo", OperationFinalStateVia.OperationLocation, context, waitUntil);`
`431`		`- return new TrainingOperation(internalOperation);`
	`431`	`+ return new OperationWithId(internalOperation);`
`432`	`432`	`}`
`433`	`433`	`catch (Exception e)`
`434`	`434`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ namespace Azure.AI.DocumentIntelligence`
`14`	`14`	`public partial class DocumentIntelligenceClient`
`15`	`15`	`{`
`16`	`16`	`// CUSTOM CODE NOTE: we're overwriting the behavior of the AnalyzeDocument API to`
`17`		`- // return an instance of TrainingOperation. This is a workaround since Operation.Id`
	`17`	`+ // return an instance of OperationWithId. This is a workaround since Operation.Id`
`18`	`18`	`// is not supported by our generator yet (it throws a NotSupportedException), but`
`19`	`19`	`// this ID is needed for the GetAnalyzeResultPdf and the GetAnalyzeResultImage APIs.`
`20`	`20`
`@@ -62,18 +62,18 @@ public virtual async Task<Operation<BinaryData>> AnalyzeDocumentAsync(WaitUntil`
`62`	`62`	`{`
`63`	`63`	`using HttpMessage message = CreateAnalyzeDocumentRequest(modelId, content, pages, locale, stringIndexType, features, queryFields, outputContentFormat, output, context);`
`64`	`64`	`var internalOperation = await ProtocolOperationHelpers.ProcessMessageAsync(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceClient.AnalyzeDocument", OperationFinalStateVia.OperationLocation, context, WaitUntil.Started).ConfigureAwait(false);`
`65`		`- var trainingOperation = new TrainingOperation(internalOperation);`
	`65`	`+ var operationWithId = new OperationWithId(internalOperation);`
`66`	`66`
`67`	`67`	`// Workaround to obtain the operation ID. The operation-location header is only returned after`
`68`	`68`	`// the first request that starts the LRO. Because of this we're setting waitUntil to 'Started'`
`69`		`- // above so we have time to extract the operation ID in the TrainingOperation constructor.`
	`69`	`+ // above so we have time to extract the operation ID in the OperationWithId constructor.`
`70`	`70`
`71`	`71`	`if (waitUntil == WaitUntil.Completed)`
`72`	`72`	`{`
`73`		`- await trainingOperation.WaitForCompletionAsync(context?.CancellationToken ?? default).ConfigureAwait(false);`
	`73`	`+ await operationWithId.WaitForCompletionAsync(context?.CancellationToken ?? default).ConfigureAwait(false);`
`74`	`74`	`}`
`75`	`75`
`76`		`- return trainingOperation;`
	`76`	`+ return operationWithId;`
`77`	`77`	`}`
`78`	`78`	`catch (Exception e)`
`79`	`79`	`{`
`@@ -126,18 +126,18 @@ public virtual Operation<BinaryData> AnalyzeDocument(WaitUntil waitUntil, string`
`126`	`126`	`{`
`127`	`127`	`using HttpMessage message = CreateAnalyzeDocumentRequest(modelId, content, pages, locale, stringIndexType, features, queryFields, outputContentFormat, output, context);`
`128`	`128`	`var internalOperation = ProtocolOperationHelpers.ProcessMessage(_pipeline, message, ClientDiagnostics, "DocumentIntelligenceClient.AnalyzeDocument", OperationFinalStateVia.OperationLocation, context, WaitUntil.Started);`
`129`		`- var trainingOperation = new TrainingOperation(internalOperation);`
	`129`	`+ var operationWithId = new OperationWithId(internalOperation);`
`130`	`130`
`131`	`131`	`// Workaround to obtain the operation ID. The operation-location header is only returned after`
`132`	`132`	`// the first request that starts the LRO. Because of this we're setting waitUntil to 'Started'`
`133`		`- // above so we have time to extract the operation ID in the TrainingOperation constructor.`
	`133`	`+ // above so we have time to extract the operation ID in the OperationWithId constructor.`
`134`	`134`
`135`	`135`	`if (waitUntil == WaitUntil.Completed)`
`136`	`136`	`{`
`137`		`- trainingOperation.WaitForCompletion(context?.CancellationToken ?? default);`
	`137`	`+ operationWithId.WaitForCompletion(context?.CancellationToken ?? default);`
`138`	`138`	`}`
`139`	`139`
`140`		`- return trainingOperation;`
	`140`	`+ return operationWithId;`
`141`	`141`	`}`
`142`	`142`	`catch (Exception e)`
`143`	`143`	`{`
Original file line number	Diff line number	Diff line change
`@@ -10,15 +10,15 @@`
`10`	`10`
`11`	`11`	`namespace Azure.AI.DocumentIntelligence.Tests`
`12`	`12`	`{`
`13`		`- public class TrainingOperationLiveTests : DocumentIntelligenceLiveTestBase`
	`13`	`+ public class OperationWithIdLiveTests : DocumentIntelligenceLiveTestBase`
`14`	`14`	`{`
`15`	`15`	`// Example: 3eb2e5b5-b9d3-4b5a-ac31-90d945f4b4e4`
`16`	`16`	`private const string AnalysisOperationIdPattern = @"^[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$";`
`17`	`17`
`18`	`18`	`// Example: 31466498286_3eb2e5b5-b9d3-4b5a-ac31-90d945f4b4e4`
`19`	`19`	`private const string TrainingOperationIdPattern = @"^[0-9]+_[a-z0-9]{8}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{4}-[a-z0-9]{12}$";`
`20`	`20`
`21`		`- public TrainingOperationLiveTests(bool isAsync)`
	`21`	`+ public OperationWithIdLiveTests(bool isAsync)`
`22`	`22`	`: base(isAsync)`
`23`	`23`	`{`
`24`	`24`	`}`