@@ -18,7 +18,8 @@ summary: 'FormRecognizerClient extracts information from forms and images into s
18
18
19
19
URL and inputs from a stream.'
20
20
constructor :
21
- syntax : FormRecognizerClient(endpoint, credential, **kwargs)
21
+ syntax : ' FormRecognizerClient(endpoint: str, credential: Union[AzureKeyCredential,
22
+ TokenCredential], **kwargs: Any)'
22
23
parameters :
23
24
- name : endpoint
24
25
description : ' Supported Cognitive Services endpoints (protocol and hostname,
@@ -83,7 +84,8 @@ methods:
83
84
84
85
85
86
New in version v2.1: The *begin_recognize_business_cards* client method'
86
- signature : begin_recognize_business_cards(business_card, **kwargs)
87
+ signature : ' begin_recognize_business_cards(business_card: Union[bytes, IO[bytes]],
88
+ **kwargs: Any) -> LROPoller[List[RecognizedForm]]'
87
89
parameters :
88
90
- name : business_card
89
91
description : JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -201,7 +203,8 @@ methods:
201
203
202
204
203
205
New in version v2.1: The *begin_recognize_business_cards_from_url* client method'
204
- signature : begin_recognize_business_cards_from_url(business_card_url, **kwargs)
206
+ signature : ' begin_recognize_business_cards_from_url(business_card_url: str, **kwargs:
207
+ Any) -> LROPoller[List[RecognizedForm]]'
205
208
parameters :
206
209
- name : business_card_url
207
210
description : ' The URL of the business card to analyze. The input must be a valid,
@@ -259,7 +262,8 @@ methods:
259
262
260
263
New in version v2.1: The *pages*, *language* and *reading_order* keyword arguments
261
264
and support for image/bmp content'
262
- signature : begin_recognize_content(form, **kwargs)
265
+ signature : ' begin_recognize_content(form: Union[bytes, IO[bytes]], **kwargs: Any)
266
+ -> LROPoller[List[FormPage]]'
263
267
parameters :
264
268
- name : form
265
269
description : JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -373,7 +377,7 @@ methods:
373
377
374
378
New in version v2.1: The *pages*, *language* and *reading_order* keyword arguments
375
379
and support for image/bmp content'
376
- signature : begin_recognize_content_from_url(form_url, **kwargs)
380
+ signature : ' begin_recognize_content_from_url(form_url: str , **kwargs: Any) -> LROPoller[List[FormPage]] '
377
381
parameters :
378
382
- name : form_url
379
383
description : ' The URL of the form to analyze. The input must be a valid, encoded
@@ -445,7 +449,8 @@ methods:
445
449
The input document must be of one of the supported content types - '' application/pdf'' ,
446
450
447
451
'' image/jpeg'' , '' image/png'' , '' image/tiff'' , or '' image/bmp'' .'
448
- signature : begin_recognize_custom_forms(model_id, form, **kwargs)
452
+ signature : ' begin_recognize_custom_forms(model_id: str, form: Union[bytes, IO[bytes]],
453
+ **kwargs: Any) -> LROPoller[List[RecognizedForm]]'
449
454
parameters :
450
455
- name : model_id
451
456
description : Custom model identifier.
@@ -553,7 +558,8 @@ methods:
553
558
model.
554
559
555
560
The input document must be the location (URL) of the document to be analyzed.'
556
- signature : begin_recognize_custom_forms_from_url(model_id, form_url, **kwargs)
561
+ signature : ' begin_recognize_custom_forms_from_url(model_id: str, form_url: str,
562
+ **kwargs: Any) -> LROPoller[List[RecognizedForm]]'
557
563
parameters :
558
564
- name : model_id
559
565
description : Custom model identifier.
@@ -613,7 +619,8 @@ methods:
613
619
614
620
615
621
New in version v2.1: The *begin_recognize_identity_documents* client method'
616
- signature : begin_recognize_identity_documents(identity_document, **kwargs)
622
+ signature : ' begin_recognize_identity_documents(identity_document: Union[bytes, IO[bytes]],
623
+ **kwargs: Any) -> LROPoller[List[RecognizedForm]]'
617
624
parameters :
618
625
- name : identity_document
619
626
description : JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -708,7 +715,8 @@ methods:
708
715
709
716
New in version v2.1: The *begin_recognize_identity_documents_from_url* client
710
717
method'
711
- signature : begin_recognize_identity_documents_from_url(identity_document_url, **kwargs)
718
+ signature : ' begin_recognize_identity_documents_from_url(identity_document_url: str,
719
+ **kwargs: Any) -> LROPoller[List[RecognizedForm]]'
712
720
parameters :
713
721
- name : identity_document_url
714
722
description : ' The URL of the identity document to analyze.
@@ -763,7 +771,8 @@ methods:
763
771
764
772
765
773
New in version v2.1: The *begin_recognize_invoices* client method'
766
- signature : begin_recognize_invoices(invoice, **kwargs)
774
+ signature : ' begin_recognize_invoices(invoice: Union[bytes, IO[bytes]], **kwargs:
775
+ Any) -> LROPoller[List[RecognizedForm]]'
767
776
parameters :
768
777
- name : invoice
769
778
description : JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -929,7 +938,8 @@ methods:
929
938
930
939
931
940
New in version v2.1: The *begin_recognize_invoices_from_url* client method'
932
- signature : begin_recognize_invoices_from_url(invoice_url, **kwargs)
941
+ signature : ' begin_recognize_invoices_from_url(invoice_url: str, **kwargs: Any) ->
942
+ LROPoller[List[RecognizedForm]]'
933
943
parameters :
934
944
- name : invoice_url
935
945
description : ' The URL of the invoice to analyze. The input must be a valid, encoded
@@ -989,7 +999,8 @@ methods:
989
999
990
1000
New in version v2.1: The *locale* and *pages* keyword arguments and support for
991
1001
image/bmp content'
992
- signature : begin_recognize_receipts(receipt, **kwargs)
1002
+ signature : ' begin_recognize_receipts(receipt: Union[bytes, IO[bytes]], **kwargs:
1003
+ Any) -> LROPoller[List[RecognizedForm]]'
993
1004
parameters :
994
1005
- name : receipt
995
1006
description : JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -1100,7 +1111,8 @@ methods:
1100
1111
1101
1112
New in version v2.1: The *locale* and *pages* keyword arguments and support for
1102
1113
image/bmp content'
1103
- signature : begin_recognize_receipts_from_url(receipt_url, **kwargs)
1114
+ signature : ' begin_recognize_receipts_from_url(receipt_url: str, **kwargs: Any) ->
1115
+ LROPoller[List[RecognizedForm]]'
1104
1116
parameters :
1105
1117
- name : receipt_url
1106
1118
description : ' The URL of the receipt to analyze. The input must be a valid, encoded
@@ -1194,4 +1206,4 @@ methods:
1194
1206
- uid : azure.ai.formrecognizer.FormRecognizerClient.close
1195
1207
name : close
1196
1208
summary : Close the <xref:azure.ai.formrecognizer.FormRecognizerClient> session.
1197
- signature : close()
1209
+ signature : close() -> None
0 commit comments