-
Notifications
You must be signed in to change notification settings - Fork 256
/
FormRecognizerClient.xml
970 lines (970 loc) · 103 KB
/
FormRecognizerClient.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
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
<Type Name="FormRecognizerClient" FullName="Azure.AI.FormRecognizer.FormRecognizerClient">
<TypeSignature Language="C#" Value="public class FormRecognizerClient" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit FormRecognizerClient extends System.Object" />
<TypeSignature Language="DocId" Value="T:Azure.AI.FormRecognizer.FormRecognizerClient" />
<TypeSignature Language="VB.NET" Value="Public Class FormRecognizerClient" />
<TypeSignature Language="F#" Value="type FormRecognizerClient = class" />
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>3.0.1.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>3.1.1.0</AssemblyVersion>
<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 recognize
information from forms and images and extract it into structured data. It provides the ability to analyze receipts,
business cards, and invoices, to recognize form content, and to extract fields from custom forms with models trained on custom form types.
Note that this client can only be used with service version <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" /> or lower.
In order to use later versions and their new features, see <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" />.
</summary>
<remarks>
This client only supports <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" /> and older.
To use a newer service version, see <see cref="T:Azure.AI.FormRecognizer.DocumentAnalysis.DocumentAnalysisClient" />.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected FormRecognizerClient ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.#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.FormRecognizerClient" /> class.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormRecognizerClient (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.FormRecognizerClient.#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.FormRecognizerClient : Uri * Azure.AzureKeyCredential -> Azure.AI.FormRecognizer.FormRecognizerClient" Usage="new Azure.AI.FormRecognizer.FormRecognizerClient (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.FormRecognizerClient" /> 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-a-form-recognizer-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormRecognizerClient (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.FormRecognizerClient.#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.FormRecognizerClient : Uri * Azure.Core.TokenCredential -> Azure.AI.FormRecognizer.FormRecognizerClient" Usage="new Azure.AI.FormRecognizer.FormRecognizerClient (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.FormRecognizerClient" /> 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-a-form-recognizer-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormRecognizerClient (Uri endpoint, Azure.AzureKeyCredential credential, Azure.AI.FormRecognizer.FormRecognizerClientOptions 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.FormRecognizerClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.#ctor(System.Uri,Azure.AzureKeyCredential,Azure.AI.FormRecognizer.FormRecognizerClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As AzureKeyCredential, options As FormRecognizerClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.FormRecognizerClient : Uri * Azure.AzureKeyCredential * Azure.AI.FormRecognizer.FormRecognizerClientOptions -> Azure.AI.FormRecognizer.FormRecognizerClient" Usage="new Azure.AI.FormRecognizer.FormRecognizerClient (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.FormRecognizerClientOptions" />
</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.FormRecognizerClient" /> 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-a-form-recognizer-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public FormRecognizerClient (Uri endpoint, Azure.Core.TokenCredential credential, Azure.AI.FormRecognizer.FormRecognizerClientOptions 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.FormRecognizerClientOptions options) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.#ctor(System.Uri,Azure.Core.TokenCredential,Azure.AI.FormRecognizer.FormRecognizerClientOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (endpoint As Uri, credential As TokenCredential, options As FormRecognizerClientOptions)" />
<MemberSignature Language="F#" Value="new Azure.AI.FormRecognizer.FormRecognizerClient : Uri * Azure.Core.TokenCredential * Azure.AI.FormRecognizer.FormRecognizerClientOptions -> Azure.AI.FormRecognizer.FormRecognizerClient" Usage="new Azure.AI.FormRecognizer.FormRecognizerClient (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.FormRecognizerClientOptions" />
</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.FormRecognizerClient" /> 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-a-form-recognizer-client"> here</see>.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeBusinessCards">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation StartRecognizeBusinessCards (System.IO.Stream businessCard, Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation StartRecognizeBusinessCards(class System.IO.Stream businessCard, class Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeBusinessCards(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeBusinessCards (businessCard As Stream, Optional recognizeBusinessCardsOptions As RecognizeBusinessCardsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeBusinessCardsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeBusinessCards : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation
override this.StartRecognizeBusinessCards : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation" Usage="formRecognizerClient.StartRecognizeBusinessCards (businessCard, recognizeBusinessCardsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="businessCard" Type="System.IO.Stream" />
<Parameter Name="recognizeBusinessCardsOptions" Type="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="businessCard">The stream containing the one or more business cards to recognize values from.</param>
<param name="recognizeBusinessCardsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more business cards.
<para>See <see href="https://aka.ms/formrecognizer/businesscardfields">business card fields</see> for a list of available fields on a business card.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation.Value" /> upon successful
completion will contain the extracted business cards.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeBusinessCardsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation> StartRecognizeBusinessCardsAsync (System.IO.Stream businessCard, Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions = 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.Models.RecognizeBusinessCardsOperation> StartRecognizeBusinessCardsAsync(class System.IO.Stream businessCard, class Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeBusinessCardsAsync(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeBusinessCardsAsync (businessCard As Stream, Optional recognizeBusinessCardsOptions As RecognizeBusinessCardsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeBusinessCardsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeBusinessCardsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation>
override this.StartRecognizeBusinessCardsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation>" Usage="formRecognizerClient.StartRecognizeBusinessCardsAsync (businessCard, recognizeBusinessCardsOptions, 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.Models.RecognizeBusinessCardsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="businessCard" Type="System.IO.Stream" />
<Parameter Name="recognizeBusinessCardsOptions" Type="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="businessCard">The stream containing the one or more business cards to recognize values from.</param>
<param name="recognizeBusinessCardsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more business cards.
<para>See <see href="https://aka.ms/formrecognizer/businesscardfields">business card fields</see> for a list of available fields on a business card.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation.Value" /> upon successful
completion will contain the extracted business cards.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeBusinessCardsFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation StartRecognizeBusinessCardsFromUri (Uri businessCardUri, Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation StartRecognizeBusinessCardsFromUri(class System.Uri businessCardUri, class Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeBusinessCardsFromUri(System.Uri,Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeBusinessCardsFromUri (businessCardUri As Uri, Optional recognizeBusinessCardsOptions As RecognizeBusinessCardsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeBusinessCardsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeBusinessCardsFromUri : Uri * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation
override this.StartRecognizeBusinessCardsFromUri : Uri * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation" Usage="formRecognizerClient.StartRecognizeBusinessCardsFromUri (businessCardUri, recognizeBusinessCardsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="businessCardUri" Type="System.Uri" />
<Parameter Name="recognizeBusinessCardsOptions" Type="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="businessCardUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeBusinessCardsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more business cards.
<para>See <see href="https://aka.ms/formrecognizer/businesscardfields">business card fields</see> for a list of available fields on a business card.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation.Value" /> upon successful
completion will contain the extracted business cards.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeBusinessCardsFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation> StartRecognizeBusinessCardsFromUriAsync (Uri businessCardUri, Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions = 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.Models.RecognizeBusinessCardsOperation> StartRecognizeBusinessCardsFromUriAsync(class System.Uri businessCardUri, class Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions recognizeBusinessCardsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeBusinessCardsFromUriAsync(System.Uri,Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeBusinessCardsFromUriAsync (businessCardUri As Uri, Optional recognizeBusinessCardsOptions As RecognizeBusinessCardsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeBusinessCardsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeBusinessCardsFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation>
override this.StartRecognizeBusinessCardsFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation>" Usage="formRecognizerClient.StartRecognizeBusinessCardsFromUriAsync (businessCardUri, recognizeBusinessCardsOptions, 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.Models.RecognizeBusinessCardsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="businessCardUri" Type="System.Uri" />
<Parameter Name="recognizeBusinessCardsOptions" Type="Azure.AI.FormRecognizer.RecognizeBusinessCardsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="businessCardUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeBusinessCardsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more business cards.
<para>See <see href="https://aka.ms/formrecognizer/businesscardfields">business card fields</see> for a list of available fields on a business card.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeBusinessCardsOperation.Value" /> upon successful
completion will contain the extracted business cards.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeContent">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeContentOperation StartRecognizeContent (System.IO.Stream form, Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeContentOperation StartRecognizeContent(class System.IO.Stream form, class Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeContent(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeContentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeContent (form As Stream, Optional recognizeContentOptions As RecognizeContentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeContentOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeContent : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeContentOperation
override this.StartRecognizeContent : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeContentOperation" Usage="formRecognizerClient.StartRecognizeContent (form, recognizeContentOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeContentOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="form" Type="System.IO.Stream" />
<Parameter Name="recognizeContentOptions" Type="Azure.AI.FormRecognizer.RecognizeContentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="form">The stream containing one or more forms to recognize elements from.</param>
<param name="recognizeContentOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the language of the form, and which pages in a multi-page document to analyze.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes layout elements from one or more passed-in forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeContentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeContentOperation.Value" /> upon successful
completion will contain layout elements extracted from the form.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeContentAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeContentOperation> StartRecognizeContentAsync (System.IO.Stream form, Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions = 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.Models.RecognizeContentOperation> StartRecognizeContentAsync(class System.IO.Stream form, class Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeContentAsync(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeContentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeContentAsync (form As Stream, Optional recognizeContentOptions As RecognizeContentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeContentOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeContentAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeContentOperation>
override this.StartRecognizeContentAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeContentOperation>" Usage="formRecognizerClient.StartRecognizeContentAsync (form, recognizeContentOptions, 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.Models.RecognizeContentOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="form" Type="System.IO.Stream" />
<Parameter Name="recognizeContentOptions" Type="Azure.AI.FormRecognizer.RecognizeContentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="form">The stream containing one or more forms to recognize elements from.</param>
<param name="recognizeContentOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the language of the form, and which pages in a multi-page document to analyze.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes layout elements from one or more passed-in forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeContentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeContentOperation.Value" /> upon successful
completion will contain layout elements extracted from the form.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeContentFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeContentOperation StartRecognizeContentFromUri (Uri formUri, Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeContentOperation StartRecognizeContentFromUri(class System.Uri formUri, class Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeContentFromUri(System.Uri,Azure.AI.FormRecognizer.RecognizeContentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeContentFromUri (formUri As Uri, Optional recognizeContentOptions As RecognizeContentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeContentOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeContentFromUri : Uri * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeContentOperation
override this.StartRecognizeContentFromUri : Uri * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeContentOperation" Usage="formRecognizerClient.StartRecognizeContentFromUri (formUri, recognizeContentOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeContentOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="formUri" Type="System.Uri" />
<Parameter Name="recognizeContentOptions" Type="Azure.AI.FormRecognizer.RecognizeContentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="formUri">The absolute URI of the remote file to recognize elements from.</param>
<param name="recognizeContentOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the language of the form, and which pages in a multi-page document to analyze.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes layout elements from one or more passed-in forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeContentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeContentOperation.Value" /> upon successful
completion will contain layout elements extracted from the form.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeContentFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeContentOperation> StartRecognizeContentFromUriAsync (Uri formUri, Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions = 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.Models.RecognizeContentOperation> StartRecognizeContentFromUriAsync(class System.Uri formUri, class Azure.AI.FormRecognizer.RecognizeContentOptions recognizeContentOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeContentFromUriAsync(System.Uri,Azure.AI.FormRecognizer.RecognizeContentOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeContentFromUriAsync (formUri As Uri, Optional recognizeContentOptions As RecognizeContentOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeContentOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeContentFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeContentOperation>
override this.StartRecognizeContentFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeContentOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeContentOperation>" Usage="formRecognizerClient.StartRecognizeContentFromUriAsync (formUri, recognizeContentOptions, 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.Models.RecognizeContentOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="formUri" Type="System.Uri" />
<Parameter Name="recognizeContentOptions" Type="Azure.AI.FormRecognizer.RecognizeContentOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="formUri">The absolute URI of the remote file to recognize elements from.</param>
<param name="recognizeContentOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the language of the form, and which pages in a multi-page document to analyze.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes layout elements from one or more passed-in forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeContentOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeContentOperation.Value" /> upon successful
completion will contain layout elements extracted from the form.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeCustomForms">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation StartRecognizeCustomForms (string modelId, System.IO.Stream form, Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation StartRecognizeCustomForms(string modelId, class System.IO.Stream form, class Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeCustomForms(System.String,System.IO.Stream,Azure.AI.FormRecognizer.RecognizeCustomFormsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomForms (modelId As String, form As Stream, Optional recognizeCustomFormsOptions As RecognizeCustomFormsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeCustomFormsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeCustomForms : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation
override this.StartRecognizeCustomForms : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation" Usage="formRecognizerClient.StartRecognizeCustomForms (modelId, form, recognizeCustomFormsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="form" Type="System.IO.Stream" />
<Parameter Name="recognizeCustomFormsOptions" Type="Azure.AI.FormRecognizer.RecognizeCustomFormsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="modelId">The ID of the model to use for recognizing form values.</param>
<param name="form">The stream containing one or more forms to recognize elements from.</param>
<param name="recognizeCustomFormsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes pages from one or more forms, using a model trained with custom forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation.Value" /> upon successful
completion will contain recognized pages from the input document.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeCustomFormsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation> StartRecognizeCustomFormsAsync (string modelId, System.IO.Stream form, Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions = 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.Models.RecognizeCustomFormsOperation> StartRecognizeCustomFormsAsync(string modelId, class System.IO.Stream form, class Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeCustomFormsAsync(System.String,System.IO.Stream,Azure.AI.FormRecognizer.RecognizeCustomFormsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomFormsAsync (modelId As String, form As Stream, Optional recognizeCustomFormsOptions As RecognizeCustomFormsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeCustomFormsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeCustomFormsAsync : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>
override this.StartRecognizeCustomFormsAsync : string * System.IO.Stream * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>" Usage="formRecognizerClient.StartRecognizeCustomFormsAsync (modelId, form, recognizeCustomFormsOptions, 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.Models.RecognizeCustomFormsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="form" Type="System.IO.Stream" />
<Parameter Name="recognizeCustomFormsOptions" Type="Azure.AI.FormRecognizer.RecognizeCustomFormsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="modelId">The ID of the model to use for recognizing form values.</param>
<param name="form">The stream containing one or more forms to recognize elements from.</param>
<param name="recognizeCustomFormsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes pages from one or more forms, using a model trained with custom forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation.Value" /> upon successful
completion will contain recognized pages from the input document.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeCustomFormsFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation StartRecognizeCustomFormsFromUri (string modelId, Uri formUri, Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation StartRecognizeCustomFormsFromUri(string modelId, class System.Uri formUri, class Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeCustomFormsFromUri(System.String,System.Uri,Azure.AI.FormRecognizer.RecognizeCustomFormsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomFormsFromUri (modelId As String, formUri As Uri, Optional recognizeCustomFormsOptions As RecognizeCustomFormsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeCustomFormsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeCustomFormsFromUri : string * Uri * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation
override this.StartRecognizeCustomFormsFromUri : string * Uri * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation" Usage="formRecognizerClient.StartRecognizeCustomFormsFromUri (modelId, formUri, recognizeCustomFormsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="formUri" Type="System.Uri" />
<Parameter Name="recognizeCustomFormsOptions" Type="Azure.AI.FormRecognizer.RecognizeCustomFormsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="modelId">The ID of the model to use for recognizing form values.</param>
<param name="formUri">The absolute URI of the remote file to recognize elements from.</param>
<param name="recognizeCustomFormsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes pages from one or more forms, using a model trained with custom forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation.Value" /> upon successful
completion will contain recognized pages from the input document.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeCustomFormsFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation> StartRecognizeCustomFormsFromUriAsync (string modelId, Uri formUri, Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions = 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.Models.RecognizeCustomFormsOperation> StartRecognizeCustomFormsFromUriAsync(string modelId, class System.Uri formUri, class Azure.AI.FormRecognizer.RecognizeCustomFormsOptions recognizeCustomFormsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeCustomFormsFromUriAsync(System.String,System.Uri,Azure.AI.FormRecognizer.RecognizeCustomFormsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeCustomFormsFromUriAsync (modelId As String, formUri As Uri, Optional recognizeCustomFormsOptions As RecognizeCustomFormsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeCustomFormsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeCustomFormsFromUriAsync : string * Uri * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>
override this.StartRecognizeCustomFormsFromUriAsync : string * Uri * Azure.AI.FormRecognizer.RecognizeCustomFormsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation>" Usage="formRecognizerClient.StartRecognizeCustomFormsFromUriAsync (modelId, formUri, recognizeCustomFormsOptions, 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.Models.RecognizeCustomFormsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="modelId" Type="System.String" />
<Parameter Name="formUri" Type="System.Uri" />
<Parameter Name="recognizeCustomFormsOptions" Type="Azure.AI.FormRecognizer.RecognizeCustomFormsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="modelId">The ID of the model to use for recognizing form values.</param>
<param name="formUri">The absolute URI of the remote file to recognize elements from.</param>
<param name="recognizeCustomFormsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes pages from one or more forms, using a model trained with custom forms.
</summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeCustomFormsOperation.Value" /> upon successful
completion will contain recognized pages from the input document.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeIdentityDocuments">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation StartRecognizeIdentityDocuments (System.IO.Stream identityDocument, Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation StartRecognizeIdentityDocuments(class System.IO.Stream identityDocument, class Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeIdentityDocuments(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeIdentityDocuments (identityDocument As Stream, Optional recognizeIdentityDocumentsOptions As RecognizeIdentityDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeIdentityDocumentsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeIdentityDocuments : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation
override this.StartRecognizeIdentityDocuments : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation" Usage="formRecognizerClient.StartRecognizeIdentityDocuments (identityDocument, recognizeIdentityDocumentsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="identityDocument" Type="System.IO.Stream" />
<Parameter Name="recognizeIdentityDocumentsOptions" Type="Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="identityDocument">The stream containing the one or more identity documents to recognize values from.</param>
<param name="recognizeIdentityDocumentsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents
to extract key information from passports and US driver licenses.
<para>See <see href="https://aka.ms/formrecognizer/iddocumentfields">identity document fields</see> for a list of available fields on an identity document.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation.Value" /> upon successful
completion will contain the extracted identity document information.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeIdentityDocumentsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation> StartRecognizeIdentityDocumentsAsync (System.IO.Stream identityDocument, Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions = 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.Models.RecognizeIdentityDocumentsOperation> StartRecognizeIdentityDocumentsAsync(class System.IO.Stream identityDocument, class Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeIdentityDocumentsAsync(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeIdentityDocumentsAsync (identityDocument As Stream, Optional recognizeIdentityDocumentsOptions As RecognizeIdentityDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeIdentityDocumentsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeIdentityDocumentsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation>
override this.StartRecognizeIdentityDocumentsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation>" Usage="formRecognizerClient.StartRecognizeIdentityDocumentsAsync (identityDocument, recognizeIdentityDocumentsOptions, 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.Models.RecognizeIdentityDocumentsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="identityDocument" Type="System.IO.Stream" />
<Parameter Name="recognizeIdentityDocumentsOptions" Type="Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="identityDocument">The stream containing the one or more identity documents to recognize values from.</param>
<param name="recognizeIdentityDocumentsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents
to extract key information from passports and US driver licenses.
<para>See <see href="https://aka.ms/formrecognizer/iddocumentfields">identity document fields</see> for a list of available fields on an identity document.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation.Value" /> upon successful
completion will contain the extracted identity document information.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeIdentityDocumentsFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation StartRecognizeIdentityDocumentsFromUri (Uri identityDocumentUri, Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation StartRecognizeIdentityDocumentsFromUri(class System.Uri identityDocumentUri, class Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeIdentityDocumentsFromUri(System.Uri,Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeIdentityDocumentsFromUri (identityDocumentUri As Uri, Optional recognizeIdentityDocumentsOptions As RecognizeIdentityDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeIdentityDocumentsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeIdentityDocumentsFromUri : Uri * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation
override this.StartRecognizeIdentityDocumentsFromUri : Uri * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation" Usage="formRecognizerClient.StartRecognizeIdentityDocumentsFromUri (identityDocumentUri, recognizeIdentityDocumentsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="identityDocumentUri" Type="System.Uri" />
<Parameter Name="recognizeIdentityDocumentsOptions" Type="Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="identityDocumentUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeIdentityDocumentsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents
to extract key information from passports and US driver licenses.
<para>See <see href="https://aka.ms/formrecognizer/iddocumentfields">identity document fields</see> for a list of available fields on an identity document.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation.Value" /> upon successful
completion will contain the extracted identity document information.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeIdentityDocumentsFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation> StartRecognizeIdentityDocumentsFromUriAsync (Uri identityDocumentUri, Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions = 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.Models.RecognizeIdentityDocumentsOperation> StartRecognizeIdentityDocumentsFromUriAsync(class System.Uri identityDocumentUri, class Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions recognizeIdentityDocumentsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeIdentityDocumentsFromUriAsync(System.Uri,Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeIdentityDocumentsFromUriAsync (identityDocumentUri As Uri, Optional recognizeIdentityDocumentsOptions As RecognizeIdentityDocumentsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeIdentityDocumentsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeIdentityDocumentsFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation>
override this.StartRecognizeIdentityDocumentsFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation>" Usage="formRecognizerClient.StartRecognizeIdentityDocumentsFromUriAsync (identityDocumentUri, recognizeIdentityDocumentsOptions, 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.Models.RecognizeIdentityDocumentsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="identityDocumentUri" Type="System.Uri" />
<Parameter Name="recognizeIdentityDocumentsOptions" Type="Azure.AI.FormRecognizer.RecognizeIdentityDocumentsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="identityDocumentUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeIdentityDocumentsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Analyze identity documents using optical character recognition (OCR) and a prebuilt model trained on identity documents
to extract key information from passports and US driver licenses.
<para>See <see href="https://aka.ms/formrecognizer/iddocumentfields">identity document fields</see> for a list of available fields on an identity document.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeIdentityDocumentsOperation.Value" /> upon successful
completion will contain the extracted identity document information.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeInvoices">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation StartRecognizeInvoices (System.IO.Stream invoice, Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation StartRecognizeInvoices(class System.IO.Stream invoice, class Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeInvoices(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeInvoicesOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeInvoices (invoice As Stream, Optional recognizeInvoicesOptions As RecognizeInvoicesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeInvoicesOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeInvoices : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation
override this.StartRecognizeInvoices : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation" Usage="formRecognizerClient.StartRecognizeInvoices (invoice, recognizeInvoicesOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="invoice" Type="System.IO.Stream" />
<Parameter Name="recognizeInvoicesOptions" Type="Azure.AI.FormRecognizer.RecognizeInvoicesOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="invoice">The stream containing the one or more invoices to recognize values from.</param>
<param name="recognizeInvoicesOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more invoices.
<para>See <see href="https://aka.ms/formrecognizer/invoicefields">invoice fields</see> for a list of available fields on an invoice.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation.Value" /> upon successful
completion will contain the extracted invoices.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeInvoicesAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation> StartRecognizeInvoicesAsync (System.IO.Stream invoice, Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions = 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.Models.RecognizeInvoicesOperation> StartRecognizeInvoicesAsync(class System.IO.Stream invoice, class Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeInvoicesAsync(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeInvoicesOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeInvoicesAsync (invoice As Stream, Optional recognizeInvoicesOptions As RecognizeInvoicesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeInvoicesOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeInvoicesAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation>
override this.StartRecognizeInvoicesAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation>" Usage="formRecognizerClient.StartRecognizeInvoicesAsync (invoice, recognizeInvoicesOptions, 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.Models.RecognizeInvoicesOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="invoice" Type="System.IO.Stream" />
<Parameter Name="recognizeInvoicesOptions" Type="Azure.AI.FormRecognizer.RecognizeInvoicesOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="invoice">The stream containing the one or more invoices to recognize values from.</param>
<param name="recognizeInvoicesOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more invoices.
<para>See <see href="https://aka.ms/formrecognizer/invoicefields">invoice fields</see> for a list of available fields on an invoice.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation.Value" /> upon successful
completion will contain the extracted invoices.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeInvoicesFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation StartRecognizeInvoicesFromUri (Uri invoiceUri, Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation StartRecognizeInvoicesFromUri(class System.Uri invoiceUri, class Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeInvoicesFromUri(System.Uri,Azure.AI.FormRecognizer.RecognizeInvoicesOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeInvoicesFromUri (invoiceUri As Uri, Optional recognizeInvoicesOptions As RecognizeInvoicesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeInvoicesOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeInvoicesFromUri : Uri * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation
override this.StartRecognizeInvoicesFromUri : Uri * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation" Usage="formRecognizerClient.StartRecognizeInvoicesFromUri (invoiceUri, recognizeInvoicesOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="invoiceUri" Type="System.Uri" />
<Parameter Name="recognizeInvoicesOptions" Type="Azure.AI.FormRecognizer.RecognizeInvoicesOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="invoiceUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeInvoicesOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more invoices.
<para>See <see href="https://aka.ms/formrecognizer/invoicefields">invoice fields</see> for a list of available fields on an invoice.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation.Value" /> upon successful
completion will contain the extracted invoices.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeInvoicesFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation> StartRecognizeInvoicesFromUriAsync (Uri invoiceUri, Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions = 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.Models.RecognizeInvoicesOperation> StartRecognizeInvoicesFromUriAsync(class System.Uri invoiceUri, class Azure.AI.FormRecognizer.RecognizeInvoicesOptions recognizeInvoicesOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeInvoicesFromUriAsync(System.Uri,Azure.AI.FormRecognizer.RecognizeInvoicesOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeInvoicesFromUriAsync (invoiceUri As Uri, Optional recognizeInvoicesOptions As RecognizeInvoicesOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeInvoicesOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeInvoicesFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation>
override this.StartRecognizeInvoicesFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeInvoicesOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation>" Usage="formRecognizerClient.StartRecognizeInvoicesFromUriAsync (invoiceUri, recognizeInvoicesOptions, 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.Models.RecognizeInvoicesOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="invoiceUri" Type="System.Uri" />
<Parameter Name="recognizeInvoicesOptions" Type="Azure.AI.FormRecognizer.RecognizeInvoicesOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="invoiceUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeInvoicesOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more invoices.
<para>See <see href="https://aka.ms/formrecognizer/invoicefields">invoice fields</see> for a list of available fields on an invoice.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeInvoicesOperation.Value" /> upon successful
completion will contain the extracted invoices.</returns>
<remarks>
Method is only available for <see cref="F:Azure.AI.FormRecognizer.FormRecognizerClientOptions.ServiceVersion.V2_1" />.
</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeReceipts">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation StartRecognizeReceipts (System.IO.Stream receipt, Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation StartRecognizeReceipts(class System.IO.Stream receipt, class Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeReceipts(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeReceiptsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeReceipts (receipt As Stream, Optional recognizeReceiptsOptions As RecognizeReceiptsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeReceiptsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeReceipts : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation
override this.StartRecognizeReceipts : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation" Usage="formRecognizerClient.StartRecognizeReceipts (receipt, recognizeReceiptsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="receipt" Type="System.IO.Stream" />
<Parameter Name="recognizeReceiptsOptions" Type="Azure.AI.FormRecognizer.RecognizeReceiptsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="receipt">The stream containing the one or more receipts to recognize values from.</param>
<param name="recognizeReceiptsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more receipts.
<para>See <see href="https://aka.ms/formrecognizer/receiptfields">receipt fields</see> for a list of available fields on a receipt.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation.Value" /> upon successful
completion will contain the extracted receipt.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeReceiptsAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation> StartRecognizeReceiptsAsync (System.IO.Stream receipt, Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions = 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.Models.RecognizeReceiptsOperation> StartRecognizeReceiptsAsync(class System.IO.Stream receipt, class Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeReceiptsAsync(System.IO.Stream,Azure.AI.FormRecognizer.RecognizeReceiptsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeReceiptsAsync (receipt As Stream, Optional recognizeReceiptsOptions As RecognizeReceiptsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeReceiptsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeReceiptsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation>
override this.StartRecognizeReceiptsAsync : System.IO.Stream * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation>" Usage="formRecognizerClient.StartRecognizeReceiptsAsync (receipt, recognizeReceiptsOptions, 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.Models.RecognizeReceiptsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="receipt" Type="System.IO.Stream" />
<Parameter Name="recognizeReceiptsOptions" Type="Azure.AI.FormRecognizer.RecognizeReceiptsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="receipt">The stream containing the one or more receipts to recognize values from.</param>
<param name="recognizeReceiptsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more receipts.
<para>See <see href="https://aka.ms/formrecognizer/receiptfields">receipt fields</see> for a list of available fields on a receipt.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation.Value" /> upon successful
completion will contain the extracted receipt.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeReceiptsFromUri">
<MemberSignature Language="C#" Value="public virtual Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation StartRecognizeReceiptsFromUri (Uri receiptUri, Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions = default, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation StartRecognizeReceiptsFromUri(class System.Uri receiptUri, class Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeReceiptsFromUri(System.Uri,Azure.AI.FormRecognizer.RecognizeReceiptsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeReceiptsFromUri (receiptUri As Uri, Optional recognizeReceiptsOptions As RecognizeReceiptsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As RecognizeReceiptsOperation" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeReceiptsFromUri : Uri * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation
override this.StartRecognizeReceiptsFromUri : Uri * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation" Usage="formRecognizerClient.StartRecognizeReceiptsFromUri (receiptUri, recognizeReceiptsOptions, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Azure.AI.FormRecognizer</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="receiptUri" Type="System.Uri" />
<Parameter Name="recognizeReceiptsOptions" Type="Azure.AI.FormRecognizer.RecognizeReceiptsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="receiptUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeReceiptsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more receipts.
<para>See <see href="https://aka.ms/formrecognizer/receiptfields">receipt fields</see> for a list of available fields on a receipt.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation.Value" /> upon successful
completion will contain the extracted receipt.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StartRecognizeReceiptsFromUriAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation> StartRecognizeReceiptsFromUriAsync (Uri receiptUri, Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions = 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.Models.RecognizeReceiptsOperation> StartRecognizeReceiptsFromUriAsync(class System.Uri receiptUri, class Azure.AI.FormRecognizer.RecognizeReceiptsOptions recognizeReceiptsOptions, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Azure.AI.FormRecognizer.FormRecognizerClient.StartRecognizeReceiptsFromUriAsync(System.Uri,Azure.AI.FormRecognizer.RecognizeReceiptsOptions,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function StartRecognizeReceiptsFromUriAsync (receiptUri As Uri, Optional recognizeReceiptsOptions As RecognizeReceiptsOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of RecognizeReceiptsOperation)" />
<MemberSignature Language="F#" Value="abstract member StartRecognizeReceiptsFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation>
override this.StartRecognizeReceiptsFromUriAsync : Uri * Azure.AI.FormRecognizer.RecognizeReceiptsOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation>" Usage="formRecognizerClient.StartRecognizeReceiptsFromUriAsync (receiptUri, recognizeReceiptsOptions, 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.Models.RecognizeReceiptsOperation></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="receiptUri" Type="System.Uri" />
<Parameter Name="recognizeReceiptsOptions" Type="Azure.AI.FormRecognizer.RecognizeReceiptsOptions" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="receiptUri">The absolute URI of the remote file to recognize values from.</param>
<param name="recognizeReceiptsOptions">A set of options available for configuring the recognize request. For example, specify the content type of the
form, the locale of the form, or whether or not to include form elements.</param>
<param name="cancellationToken">A <see cref="T:System.Threading.CancellationToken" /> controlling the request lifetime.</param>
<summary>
Recognizes values from one or more receipts.
<para>See <see href="https://aka.ms/formrecognizer/receiptfields">receipt fields</see> for a list of available fields on a receipt.</para></summary>
<returns>A <see cref="T:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation" /> to wait on this long-running operation. Its <see cref="P:Azure.AI.FormRecognizer.Models.RecognizeReceiptsOperation.Value" /> upon successful
completion will contain the extracted receipt.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>