-
Notifications
You must be signed in to change notification settings - Fork 263
/
DocumentAnalysisClient.xml
510 lines (510 loc) · 45.3 KB
/
DocumentAnalysisClient.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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
<Type Name="DocumentAnalysisClient" FullName="Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient">
<TypeSignature Language="C#" Value="public class DocumentAnalysisClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DocumentAnalysisClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" />
<TypeSignature Language="VB.NET" Value="Public Class DocumentAnalysisClient" />
<TypeSignature Language="F#" Value="type DocumentAnalysisClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
The client to use to connect to the Form Recognizer Azure Cognitive Service to analyze information from documents
and images and extract it into structured data. It provides the ability to use prebuilt models to analyze receipts,
business cards, invoices, to extract document content, and more. It's also possible to extract fields from custom
documents with models built on custom document types.
</summary>
<remarks>
This client only supports <see cref="F:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions.ServiceVersion.V2022_08_31" /> and newer.
To use an older service version, see <see cref="T:Azure.AI.FormRecognizer.FormRecognizerClient" />.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DocumentAnalysisClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.#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.DocumentAnalysisClient" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentAnalysisClient (Uri endpoint, Azure.AzureKeyCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.#ctor(System.Uri,Azure.AzureKeyCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient : Uri * Azure.AzureKeyCredential -> Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" Usage="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
</Parameters>
<Docs>
<param name="endpoint">The endpoint to use for connecting to the Form Recognizer Azure Cognitive Service.</param>
<param name="credential">A credential used to authenticate to an Azure Service.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> class.
</summary>
<remarks>
Both the <paramref name="endpoint" /> URI string and the <paramref name="credential" /><c>string</c> key
can be found in the Azure Portal.
For more information see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/README.md#authenticate-the-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentAnalysisClient (Uri endpoint, Azure.Core.TokenCredential credential);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.#ctor(System.Uri,Azure.Core.TokenCredential)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential)" />
<MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient : Uri * Azure.Core.TokenCredential -> Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" Usage="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient (endpoint, credential)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
</Parameters>
<Docs>
<param name="endpoint">The endpoint to use for connecting to the Form Recognizer Azure Cognitive Service.</param>
<param name="credential">A credential used to authenticate to an Azure Service.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> class.
</summary>
<remarks>
The <paramref name="endpoint" /> URI string can be found in the Azure Portal.
For more information see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/README.md#authenticate-the-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentAnalysisClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.AzureKeyCredential credential, class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As DocumentAnalysisClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient : Uri * Azure.AzureKeyCredential * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions -> Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" Usage="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.AzureKeyCredential" />
<Parameter Name="options" Type="Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions" />
</Parameters>
<Docs>
<param name="endpoint">The endpoint to use for connecting to the Form Recognizer Azure Cognitive Service.</param>
<param name="credential">A credential used to authenticate to an Azure Service.</param>
<param name="options">A set of options to apply when configuring the client.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> class.
</summary>
<remarks>
Both the <paramref name="endpoint" /> URI string and the <paramref name="credential" /><c>string</c> key
can be found in the Azure Portal.
For more information see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/README.md#authenticate-the-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DocumentAnalysisClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions options);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Uri endpoint, class Azure.Core.TokenCredential credential, class Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As DocumentAnalysisClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient : Uri * Azure.Core.TokenCredential * Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions -> Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" Usage="new Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient (endpoint, credential, options)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="endpoint" Type="System.Uri" />
<Parameter Name="credential" Type="Azure.Core.TokenCredential" />
<Parameter Name="options" Type="Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClientOptions" />
</Parameters>
<Docs>
<param name="endpoint">The endpoint to use for connecting to the Form Recognizer Azure Cognitive Service.</param>
<param name="credential">A credential used to authenticate to an Azure Service.</param>
<param name="options">A set of options to apply when configuring the client.</param>
<summary>
Initializes a new instance of the <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" /> class.
</summary>
<remarks>
The <paramref name="endpoint" /> URI string can be found in the Azure Portal.
For more information see <see href="https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/formrecognizer/Azure.AI.FormRecognizer/README.md#authenticate-the-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName="AnalyzeDocument">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation AnalyzeDocument (Azure.WaitUntil waitUntil, string modelId, System.IO.Stream document, Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation AnalyzeDocument(valuetype Azure.WaitUntil waitUntil, string modelId, class System.IO.Stream document, class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.AnalyzeDocument(Azure.WaitUntil,System.String,System.IO.Stream,Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeDocument (waitUntil As WaitUntil, modelId As String, document As Stream, Optional options As AnalyzeDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeDocumentOperation" />
<MemberSignature Language="F#" Value="abstract member AnalyzeDocument : Azure.WaitUntil * string * System.IO.Stream * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation
override this.AnalyzeDocument : Azure.WaitUntil * string * System.IO.Stream * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation" Usage="documentAnalysisClient.AnalyzeDocument (waitUntil, modelId, document, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="document" Type="System.IO.Stream" />
<Parameter Name="options" Type="Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="modelId">
The ID of the model to use for analyzing the input documents. When using a custom built model
for analysis, this parameter must be the ID attributed to the model during its creation. When
using one of the service's prebuilt models, one of the supported prebuilt model IDs must be passed.
Prebuilt model IDs can be found at <see href="https://aka.ms/azsdk/formrecognizer/models" />.
</param>
<param name="document">The stream containing one or more documents to analyze.</param>
<param name="options">
A set of options available for configuring the analyze request. For example, specify the locale of the
document, or which pages to analyze.
</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt
models provided by the Form Recognizer service.
</summary>
<returns>
An <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation.Value" /> upon successful
completion will contain analyzed pages from the input document.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AnalyzeDocumentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation> AnalyzeDocumentAsync (Azure.WaitUntil waitUntil, string modelId, System.IO.Stream document, Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation> AnalyzeDocumentAsync(valuetype Azure.WaitUntil waitUntil, string modelId, class System.IO.Stream document, class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.AnalyzeDocumentAsync(Azure.WaitUntil,System.String,System.IO.Stream,Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeDocumentAsync (waitUntil As WaitUntil, modelId As String, document As Stream, Optional options As AnalyzeDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeDocumentOperation)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation>
override this.AnalyzeDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation>" Usage="documentAnalysisClient.AnalyzeDocumentAsync (waitUntil, modelId, document, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="document" Type="System.IO.Stream" />
<Parameter Name="options" Type="Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="modelId">
The ID of the model to use for analyzing the input documents. When using a custom built model
for analysis, this parameter must be the ID attributed to the model during its creation. When
using one of the service's prebuilt models, one of the supported prebuilt model IDs must be passed.
Prebuilt model IDs can be found at <see href="https://aka.ms/azsdk/formrecognizer/models" />.
</param>
<param name="document">The stream containing one or more documents to analyze.</param>
<param name="options">
A set of options available for configuring the analyze request. For example, specify the locale of the
document, or which pages to analyze.
</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt
models provided by the Form Recognizer service.
</summary>
<returns>
An <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation.Value" /> upon successful
completion will contain analyzed pages from the input document.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AnalyzeDocumentFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation AnalyzeDocumentFromUri (Azure.WaitUntil waitUntil, string modelId, Uri documentUri, Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation AnalyzeDocumentFromUri(valuetype Azure.WaitUntil waitUntil, string modelId, class System.Uri documentUri, class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.AnalyzeDocumentFromUri(Azure.WaitUntil,System.String,System.Uri,Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeDocumentFromUri (waitUntil As WaitUntil, modelId As String, documentUri As Uri, Optional options As AnalyzeDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As AnalyzeDocumentOperation" />
<MemberSignature Language="F#" Value="abstract member AnalyzeDocumentFromUri : Azure.WaitUntil * string * Uri * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation
override this.AnalyzeDocumentFromUri : Azure.WaitUntil * string * Uri * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation" Usage="documentAnalysisClient.AnalyzeDocumentFromUri (waitUntil, modelId, documentUri, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="documentUri" Type="System.Uri" />
<Parameter Name="options" Type="Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="modelId">
The ID of the model to use for analyzing the input documents. When using a custom built model
for analysis, this parameter must be the ID attributed to the model during its creation. When
using one of the service's prebuilt models, one of the supported prebuilt model IDs must be passed.
Prebuilt model IDs can be found at <see href="https://aka.ms/azsdk/formrecognizer/models" />.
</param>
<param name="documentUri">The absolute URI of the remote file to analyze documents from.</param>
<param name="options">
A set of options available for configuring the analyze request. For example, specify the locale of the
document, or which pages to analyze.
</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt
models provided by the Form Recognizer service.
</summary>
<returns>
An <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation.Value" /> upon successful
completion will contain analyzed pages from the input document.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AnalyzeDocumentFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation> AnalyzeDocumentFromUriAsync (Azure.WaitUntil waitUntil, string modelId, Uri documentUri, Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation> AnalyzeDocumentFromUriAsync(valuetype Azure.WaitUntil waitUntil, string modelId, class System.Uri documentUri, class Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions options, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.AnalyzeDocumentFromUriAsync(Azure.WaitUntil,System.String,System.Uri,Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function AnalyzeDocumentFromUriAsync (waitUntil As WaitUntil, modelId As String, documentUri As Uri, Optional options As AnalyzeDocumentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of AnalyzeDocumentOperation)" />
<MemberSignature Language="F#" Value="abstract member AnalyzeDocumentFromUriAsync : Azure.WaitUntil * string * Uri * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation>
override this.AnalyzeDocumentFromUriAsync : Azure.WaitUntil * string * Uri * Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation>" Usage="documentAnalysisClient.AnalyzeDocumentFromUriAsync (waitUntil, modelId, documentUri, options, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="documentUri" Type="System.Uri" />
<Parameter Name="options" Type="Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="modelId">
The ID of the model to use for analyzing the input documents. When using a custom built model
for analysis, this parameter must be the ID attributed to the model during its creation. When
using one of the service's prebuilt models, one of the supported prebuilt model IDs must be passed.
Prebuilt model IDs can be found at <see href="https://aka.ms/azsdk/formrecognizer/models" />.
</param>
<param name="documentUri">The absolute URI of the remote file to analyze documents from.</param>
<param name="options">
A set of options available for configuring the analyze request. For example, specify the locale of the
document, or which pages to analyze.
</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyzes pages from one or more documents, using a model built with custom documents or one of the prebuilt
models provided by the Form Recognizer service.
</summary>
<returns>
An <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.AnalyzeDocumentOperation.Value" /> upon successful
completion will contain analyzed pages from the input document.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClassifyDocument">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation ClassifyDocument (Azure.WaitUntil waitUntil, string classifierId, System.IO.Stream document, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation ClassifyDocument(valuetype Azure.WaitUntil waitUntil, string classifierId, class System.IO.Stream document, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.ClassifyDocument(Azure.WaitUntil,System.String,System.IO.Stream,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ClassifyDocument (waitUntil As WaitUntil, classifierId As String, document As Stream, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" />
<MemberSignature Language="F#" Value="abstract member ClassifyDocument : Azure.WaitUntil * string * System.IO.Stream * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation
override this.ClassifyDocument : Azure.WaitUntil * string * System.IO.Stream * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation" Usage="documentAnalysisClient.ClassifyDocument (waitUntil, classifierId, document, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="document" Type="System.IO.Stream" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="classifierId">The ID of the document classifier to use.</param>
<param name="document">The stream containing one or more documents to classify.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Classifies one or more documents using a document classifier built with custom documents.
</summary>
<returns>
A <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation.Value" /> upon successful
completion will contain documents classified from the input.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClassifyDocumentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation> ClassifyDocumentAsync (Azure.WaitUntil waitUntil, string classifierId, System.IO.Stream document, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation> ClassifyDocumentAsync(valuetype Azure.WaitUntil waitUntil, string classifierId, class System.IO.Stream document, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.ClassifyDocumentAsync(Azure.WaitUntil,System.String,System.IO.Stream,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ClassifyDocumentAsync (waitUntil As WaitUntil, classifierId As String, document As Stream, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" />
<MemberSignature Language="F#" Value="abstract member ClassifyDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation>
override this.ClassifyDocumentAsync : Azure.WaitUntil * string * System.IO.Stream * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation>" Usage="documentAnalysisClient.ClassifyDocumentAsync (waitUntil, classifierId, document, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="document" Type="System.IO.Stream" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="classifierId">The ID of the document classifier to use.</param>
<param name="document">The stream containing one or more documents to classify.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Classifies one or more documents using a document classifier built with custom documents.
</summary>
<returns>
A <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation.Value" /> upon successful
completion will contain documents classified from the input.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClassifyDocumentFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation ClassifyDocumentFromUri (Azure.WaitUntil waitUntil, string classifierId, Uri documentUri, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation ClassifyDocumentFromUri(valuetype Azure.WaitUntil waitUntil, string classifierId, class System.Uri documentUri, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.ClassifyDocumentFromUri(Azure.WaitUntil,System.String,System.Uri,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ClassifyDocumentFromUri (waitUntil As WaitUntil, classifierId As String, documentUri As Uri, Optional cancellationToken As CancellationToken = Nothing) As ClassifyDocumentOperation" />
<MemberSignature Language="F#" Value="abstract member ClassifyDocumentFromUri : Azure.WaitUntil * string * Uri * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation
override this.ClassifyDocumentFromUri : Azure.WaitUntil * string * Uri * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation" Usage="documentAnalysisClient.ClassifyDocumentFromUri (waitUntil, classifierId, documentUri, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="documentUri" Type="System.Uri" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="classifierId">The ID of the document classifier to use.</param>
<param name="documentUri">The absolute URI of the remote file to classify documents from.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Classifies one or more documents using a document classifier built with custom documents.
</summary>
<returns>
A <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation.Value" /> upon successful
completion will contain documents classified from the input.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClassifyDocumentFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation> ClassifyDocumentFromUriAsync (Azure.WaitUntil waitUntil, string classifierId, Uri documentUri, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation> ClassifyDocumentFromUriAsync(valuetype Azure.WaitUntil waitUntil, string classifierId, class System.Uri documentUri, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient.ClassifyDocumentFromUriAsync(Azure.WaitUntil,System.String,System.Uri,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ClassifyDocumentFromUriAsync (waitUntil As WaitUntil, classifierId As String, documentUri As Uri, Optional cancellationToken As CancellationToken = Nothing) As Task(Of ClassifyDocumentOperation)" />
<MemberSignature Language="F#" Value="abstract member ClassifyDocumentFromUriAsync : Azure.WaitUntil * string * Uri * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation>
override this.ClassifyDocumentFromUriAsync : Azure.WaitUntil * string * Uri * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation>" Usage="documentAnalysisClient.ClassifyDocumentFromUriAsync (waitUntil, classifierId, documentUri, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="waitUntil" Type="Azure.WaitUntil" />
<Parameter Name="classifierId" Type="System.String" />
<Parameter Name="documentUri" Type="System.Uri" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="waitUntil">
<see cref="F:Azure.WaitUntil.Completed" /> if the method should wait to return until the long-running operation has completed on the service;
<see cref="F:Azure.WaitUntil.Started" /> if it should return after starting the operation.
</param>
<param name="classifierId">The ID of the document classifier to use.</param>
<param name="documentUri">The absolute URI of the remote file to classify documents from.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Classifies one or more documents using a document classifier built with custom documents.
</summary>
<returns>
A <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.DocumentAnalysis.ClassifyDocumentOperation.Value" /> upon successful
completion will contain documents classified from the input.
</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>