/
ComposeDocumentModelOperation.xml
331 lines (331 loc) · 21.5 KB
/
ComposeDocumentModelOperation.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
<Type Name="ComposeDocumentModelOperation" FullName="Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation">
<TypeSignature Language="C#" Value="public class ComposeDocumentModelOperation : Azure.Operation<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ComposeDocumentModelOperation extends Azure.Operation`1<class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>" />
<TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation" />
<TypeSignature Language="VB.NET" Value="Public Class ComposeDocumentModelOperation
Inherits Operation(Of DocumentModelDetails)" />
<TypeSignature Language="F#" Value="type ComposeDocumentModelOperation = class
 inherit Operation<DocumentModelDetails>" />
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Azure.Operation<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="!0">Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
Tracks the status of a long-running operation for composing a model.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected ComposeDocumentModelOperation ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation" /> class. This constructor
is intended to be used for mocking only.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public ComposeDocumentModelOperation (string operationId, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelAdministrationClient client);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string operationId, class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelAdministrationClient client) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.#ctor(System.String,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelAdministrationClient)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (operationId As String, client As DocumentModelAdministrationClient)" />
<MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation : string * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelAdministrationClient -> Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation" Usage="new Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation (operationId, client)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="operationId" Type="System.String" />
<Parameter Name="client" Type="Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelAdministrationClient" />
</Parameters>
<Docs>
<param name="operationId">The ID of this operation.</param>
<param name="client">The client used to check for completion.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation" /> class which
tracks the status of a long-running operation for composing a custom model.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetRawResponse">
<MemberSignature Language="C#" Value="public override Azure.Response GetRawResponse ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class Azure.Response GetRawResponse() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.GetRawResponse" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetRawResponse () As Response" />
<MemberSignature Language="F#" Value="override this.GetRawResponse : unit -> Azure.Response" Usage="composeDocumentModelOperation.GetRawResponse " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
The last HTTP response received from the server.
</summary>
<returns>To be added.</returns>
<remarks>
The last response returned from the server during the lifecycle of this instance.
An instance of <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation" /> sends requests to a server in UpdateStatusAsync, UpdateStatus, and other methods.
Responses from these requests can be accessed using GetRawResponse.
</remarks>
</Docs>
</Member>
<Member MemberName="HasCompleted">
<MemberSignature Language="C#" Value="public override bool HasCompleted { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasCompleted" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.HasCompleted" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property HasCompleted As Boolean" />
<MemberSignature Language="F#" Value="member this.HasCompleted : bool" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.HasCompleted" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns true if the long-running operation completed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HasValue">
<MemberSignature Language="C#" Value="public override bool HasValue { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasValue" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.HasValue" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property HasValue As Boolean" />
<MemberSignature Language="F#" Value="member this.HasValue : bool" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.HasValue" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns true if the long-running operation completed successfully and has produced final result (accessible by Value property).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public override string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.Id" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.Id" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets operation Id that can be used to poll for the status
of the long-running operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PercentCompleted">
<MemberSignature Language="C#" Value="public virtual int PercentCompleted { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PercentCompleted" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.PercentCompleted" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property PercentCompleted As Integer" />
<MemberSignature Language="F#" Value="member this.PercentCompleted : int" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.PercentCompleted" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the operation progress. Value is from [0-100].
</summary>
<value>To be added.</value>
<remarks>
This property can be accessed only after an update request. Make sure to call UpdateStatus first.
</remarks>
</Docs>
</Member>
<Member MemberName="UpdateStatus">
<MemberSignature Language="C#" Value="public override Azure.Response UpdateStatus (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class Azure.Response UpdateStatus(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.UpdateStatus(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function UpdateStatus (Optional cancellationToken As CancellationToken = Nothing) As Response" />
<MemberSignature Language="F#" Value="override this.UpdateStatus : System.Threading.CancellationToken -> Azure.Response" Usage="composeDocumentModelOperation.UpdateStatus cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.Response</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the service call.</param>
<summary>
Calls the server to get updated status of the long-running operation.
</summary>
<returns>The HTTP response received from the server.</returns>
<remarks>
This operation will update the value returned from GetRawResponse and might update HasCompleted, HasValue, and Value.
</remarks>
</Docs>
</Member>
<Member MemberName="UpdateStatusAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask<Azure.Response> UpdateStatusAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1<class Azure.Response> UpdateStatusAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.UpdateStatusAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function UpdateStatusAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Response)" />
<MemberSignature Language="F#" Value="override this.UpdateStatusAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Response>" Usage="composeDocumentModelOperation.UpdateStatusAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<Azure.Response></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the service call.</param>
<summary>
Calls the server to get updated status of the long-running operation.
</summary>
<returns>The HTTP response received from the server.</returns>
<remarks>
This operation will update the value returned from GetRawResponse and might update HasCompleted, HasValue, and Value.
</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public override Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails Value { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails Value" />
<MemberSignature Language="DocId" Value="P:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.Value" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Value As DocumentModelDetails" />
<MemberSignature Language="F#" Value="member this.Value : Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails" Usage="Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails</ReturnType>
</ReturnValue>
<Docs>
<summary>
Final result of the long-running operation.
</summary>
<value>To be added.</value>
<remarks>
This property can be accessed only after the operation completes successfully (HasValue is true).
</remarks>
</Docs>
</Member>
<Member MemberName="WaitForCompletionAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>> WaitForCompletionAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1<class Azure.Response`1<class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>> WaitForCompletionAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.WaitForCompletionAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function WaitForCompletionAsync (Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Response(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="override this.WaitForCompletionAsync : System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>>" Usage="composeDocumentModelOperation.WaitForCompletionAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the periodical service calls.</param>
<summary>
Periodically calls the server till the long-running operation completes.
</summary>
<returns>The last HTTP response received from the server.</returns>
<remarks>
This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
</remarks>
</Docs>
</Member>
<Member MemberName="WaitForCompletionAsync">
<MemberSignature Language="C#" Value="public override System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>> WaitForCompletionAsync (TimeSpan pollingInterval, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance valuetype System.Threading.Tasks.ValueTask`1<class Azure.Response`1<class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>> WaitForCompletionAsync(valuetype System.TimeSpan pollingInterval, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.ComposeDocumentModelOperation.WaitForCompletionAsync(System.TimeSpan,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function WaitForCompletionAsync (pollingInterval As TimeSpan, Optional cancellationToken As CancellationToken = Nothing) As ValueTask(Of Response(Of DocumentModelDetails))" />
<MemberSignature Language="F#" Value="override this.WaitForCompletionAsync : TimeSpan * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>>" Usage="composeDocumentModelOperation.WaitForCompletionAsync (pollingInterval, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.ValueTask<Azure.Response<Azure.AI.FormRecognizer.DocumentAnalysis.DocumentModelDetails>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pollingInterval" Type="System.TimeSpan" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="pollingInterval">
The interval between status requests to the server.
The interval can change based on information returned from the server.
For example, the server might communicate to the client that there is not reason to poll for status change sooner than some time.
</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> used for the periodical service calls.</param>
<summary>
Periodically calls the server till the long-running operation completes.
</summary>
<returns>The last HTTP response received from the server.</returns>
<remarks>
This method will periodically call UpdateStatusAsync till HasCompleted is true, then return the final result of the operation.
</remarks>
</Docs>
</Member>
</Members>
</Type>