Skip to content

Commit 40b8b03

Browse files
author
VSC-Service-Account
committed
1 parent 632f850 commit 40b8b03

File tree

15,430 files changed

+186071
-169724
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

15,430 files changed

+186071
-169724
lines changed

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.AccountProperties.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ methods:
2424
- uid: azure.ai.formrecognizer.AccountProperties.from_dict
2525
name: from_dict
2626
summary: Converts a dict in the shape of a AccountProperties to the model itself.
27-
signature: from_dict(data)
27+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.AccountProperties'
2828
parameters:
2929
- name: data
3030
description: A dictionary in the shape of AccountProperties.
@@ -40,7 +40,7 @@ methods:
4040
- uid: azure.ai.formrecognizer.AccountProperties.to_dict
4141
name: to_dict
4242
summary: Returns a dict representation of AccountProperties.
43-
signature: to_dict()
43+
signature: to_dict() -> dict
4444
return:
4545
description: dict
4646
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.CustomFormModel.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ methods:
5959
- uid: azure.ai.formrecognizer.CustomFormModel.from_dict
6060
name: from_dict
6161
summary: Converts a dict in the shape of a CustomFormModel to the model itself.
62-
signature: from_dict(data)
62+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.CustomFormModel'
6363
parameters:
6464
- name: data
6565
description: A dictionary in the shape of CustomFormModel.
@@ -75,7 +75,7 @@ methods:
7575
- uid: azure.ai.formrecognizer.CustomFormModel.to_dict
7676
name: to_dict
7777
summary: Returns a dict representation of CustomFormModel.
78-
signature: to_dict()
78+
signature: to_dict() -> dict
7979
return:
8080
description: dict
8181
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.CustomFormModelField.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ methods:
2828
- uid: azure.ai.formrecognizer.CustomFormModelField.from_dict
2929
name: from_dict
3030
summary: Converts a dict in the shape of a CustomFormModelField to the model itself.
31-
signature: from_dict(data)
31+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.CustomFormModelField'
3232
parameters:
3333
- name: data
3434
description: A dictionary in the shape of CustomFormModelField.
@@ -44,7 +44,7 @@ methods:
4444
- uid: azure.ai.formrecognizer.CustomFormModelField.to_dict
4545
name: to_dict
4646
summary: Returns a dict representation of CustomFormModelField.
47-
signature: to_dict()
47+
signature: to_dict() -> dict
4848
return:
4949
description: dict
5050
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.CustomFormModelInfo.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ methods:
4343
- uid: azure.ai.formrecognizer.CustomFormModelInfo.from_dict
4444
name: from_dict
4545
summary: Converts a dict in the shape of a CustomFormModelInfo to the model itself.
46-
signature: from_dict(data)
46+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.CustomFormModelInfo'
4747
parameters:
4848
- name: data
4949
description: A dictionary in the shape of CustomFormModelInfo.
@@ -59,7 +59,7 @@ methods:
5959
- uid: azure.ai.formrecognizer.CustomFormModelInfo.to_dict
6060
name: to_dict
6161
summary: Returns a dict representation of CustomFormModelInfo.
62-
signature: to_dict()
62+
signature: to_dict() -> dict
6363
return:
6464
description: dict
6565
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.CustomFormModelProperties.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ methods:
2121
name: from_dict
2222
summary: Converts a dict in the shape of a CustomFormModelProperties to the model
2323
itself.
24-
signature: from_dict(data)
24+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.CustomFormModelProperties'
2525
parameters:
2626
- name: data
2727
description: A dictionary in the shape of CustomFormModelProperties.
@@ -37,7 +37,7 @@ methods:
3737
- uid: azure.ai.formrecognizer.CustomFormModelProperties.to_dict
3838
name: to_dict
3939
summary: Returns a dict representation of CustomFormModelProperties.
40-
signature: to_dict()
40+
signature: to_dict() -> dict
4141
return:
4242
description: dict
4343
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.CustomFormSubmodel.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ methods:
4141
- uid: azure.ai.formrecognizer.CustomFormSubmodel.from_dict
4242
name: from_dict
4343
summary: Converts a dict in the shape of a CustomFormSubmodel to the model itself.
44-
signature: from_dict(data)
44+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.CustomFormSubmodel'
4545
parameters:
4646
- name: data
4747
description: A dictionary in the shape of CustomFormSubmodel.
@@ -57,7 +57,7 @@ methods:
5757
- uid: azure.ai.formrecognizer.CustomFormSubmodel.to_dict
5858
name: to_dict
5959
summary: Returns a dict representation of CustomFormSubmodel.
60-
signature: to_dict()
60+
signature: to_dict() -> dict
6161
return:
6262
description: dict
6363
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FieldData.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ methods:
5050
- uid: azure.ai.formrecognizer.FieldData.from_dict
5151
name: from_dict
5252
summary: Converts a dict in the shape of a FieldData to the model itself.
53-
signature: from_dict(data)
53+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FieldData'
5454
parameters:
5555
- name: data
5656
description: A dictionary in the shape of FieldData.
@@ -66,7 +66,7 @@ methods:
6666
- uid: azure.ai.formrecognizer.FieldData.to_dict
6767
name: to_dict
6868
summary: Returns a dict representation of FieldData.
69-
signature: to_dict()
69+
signature: to_dict() -> dict
7070
return:
7171
description: dict
7272
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormElement.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ methods:
4343
- uid: azure.ai.formrecognizer.FormElement.from_dict
4444
name: from_dict
4545
summary: Converts a dict in the shape of a FormElement to the model itself.
46-
signature: from_dict(data)
46+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FormElement'
4747
parameters:
4848
- name: data
4949
description: A dictionary in the shape of FormElement.
@@ -59,7 +59,7 @@ methods:
5959
- uid: azure.ai.formrecognizer.FormElement.to_dict
6060
name: to_dict
6161
summary: Returns a dict representation of FormElement.
62-
signature: to_dict()
62+
signature: to_dict() -> dict
6363
return:
6464
description: dict
6565
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormField.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ methods:
6161
- uid: azure.ai.formrecognizer.FormField.from_dict
6262
name: from_dict
6363
summary: Converts a dict in the shape of a FormField to the model itself.
64-
signature: from_dict(data)
64+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FormField'
6565
parameters:
6666
- name: data
6767
description: A dictionary in the shape of FormField.
@@ -77,7 +77,7 @@ methods:
7777
- uid: azure.ai.formrecognizer.FormField.to_dict
7878
name: to_dict
7979
summary: Returns a dict representation of FormField.
80-
signature: to_dict()
80+
signature: to_dict() -> dict
8181
return:
8282
description: dict
8383
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormLine.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ methods:
4747
- uid: azure.ai.formrecognizer.FormLine.from_dict
4848
name: from_dict
4949
summary: Converts a dict in the shape of a FormLine to the model itself.
50-
signature: from_dict(data)
50+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FormLine'
5151
parameters:
5252
- name: data
5353
description: A dictionary in the shape of FormLine.
@@ -63,7 +63,7 @@ methods:
6363
- uid: azure.ai.formrecognizer.FormLine.to_dict
6464
name: to_dict
6565
summary: Returns a dict representation of FormLine.
66-
signature: to_dict()
66+
signature: to_dict() -> dict
6767
return:
6868
description: dict
6969
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormPage.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ methods:
7878
- uid: azure.ai.formrecognizer.FormPage.from_dict
7979
name: from_dict
8080
summary: Converts a dict in the shape of a FormPage to the model itself.
81-
signature: from_dict(data)
81+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FormPage'
8282
parameters:
8383
- name: data
8484
description: A dictionary in the shape of FormPage.
@@ -94,7 +94,7 @@ methods:
9494
- uid: azure.ai.formrecognizer.FormPage.to_dict
9595
name: to_dict
9696
summary: Returns a dict representation of FormPage.
97-
signature: to_dict()
97+
signature: to_dict() -> dict
9898
return:
9999
description: dict
100100
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormPageRange.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ methods:
2424
- uid: azure.ai.formrecognizer.FormPageRange.from_dict
2525
name: from_dict
2626
summary: Converts a dict in the shape of a FormPageRange to the model itself.
27-
signature: from_dict(data)
27+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FormPageRange'
2828
parameters:
2929
- name: data
3030
description: A dictionary in the shape of FormPageRange.
@@ -40,7 +40,7 @@ methods:
4040
- uid: azure.ai.formrecognizer.FormPageRange.to_dict
4141
name: to_dict
4242
summary: Returns a dict representation of FormPageRange.
43-
signature: to_dict()
43+
signature: to_dict() -> dict
4444
return:
4545
description: dict
4646
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormRecognizerClient.yml

+26-14
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ summary: 'FormRecognizerClient extracts information from forms and images into s
1818
1919
URL and inputs from a stream.'
2020
constructor:
21-
syntax: FormRecognizerClient(endpoint, credential, **kwargs)
21+
syntax: 'FormRecognizerClient(endpoint: str, credential: Union[AzureKeyCredential,
22+
TokenCredential], **kwargs: Any)'
2223
parameters:
2324
- name: endpoint
2425
description: 'Supported Cognitive Services endpoints (protocol and hostname,
@@ -83,7 +84,8 @@ methods:
8384
8485
8586
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]]'
8789
parameters:
8890
- name: business_card
8991
description: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -201,7 +203,8 @@ methods:
201203
202204
203205
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]]'
205208
parameters:
206209
- name: business_card_url
207210
description: 'The URL of the business card to analyze. The input must be a valid,
@@ -259,7 +262,8 @@ methods:
259262
260263
New in version v2.1: The *pages*, *language* and *reading_order* keyword arguments
261264
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]]'
263267
parameters:
264268
- name: form
265269
description: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -373,7 +377,7 @@ methods:
373377
374378
New in version v2.1: The *pages*, *language* and *reading_order* keyword arguments
375379
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]]'
377381
parameters:
378382
- name: form_url
379383
description: 'The URL of the form to analyze. The input must be a valid, encoded
@@ -445,7 +449,8 @@ methods:
445449
The input document must be of one of the supported content types - ''application/pdf'',
446450
447451
''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]]'
449454
parameters:
450455
- name: model_id
451456
description: Custom model identifier.
@@ -553,7 +558,8 @@ methods:
553558
model.
554559
555560
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]]'
557563
parameters:
558564
- name: model_id
559565
description: Custom model identifier.
@@ -613,7 +619,8 @@ methods:
613619
614620
615621
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]]'
617624
parameters:
618625
- name: identity_document
619626
description: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -708,7 +715,8 @@ methods:
708715
709716
New in version v2.1: The *begin_recognize_identity_documents_from_url* client
710717
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]]'
712720
parameters:
713721
- name: identity_document_url
714722
description: 'The URL of the identity document to analyze.
@@ -763,7 +771,8 @@ methods:
763771
764772
765773
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]]'
767776
parameters:
768777
- name: invoice
769778
description: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -929,7 +938,8 @@ methods:
929938
930939
931940
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]]'
933943
parameters:
934944
- name: invoice_url
935945
description: 'The URL of the invoice to analyze. The input must be a valid, encoded
@@ -989,7 +999,8 @@ methods:
989999
9901000
New in version v2.1: The *locale* and *pages* keyword arguments and support for
9911001
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]]'
9931004
parameters:
9941005
- name: receipt
9951006
description: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
@@ -1100,7 +1111,8 @@ methods:
11001111
11011112
New in version v2.1: The *locale* and *pages* keyword arguments and support for
11021113
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]]'
11041116
parameters:
11051117
- name: receipt_url
11061118
description: 'The URL of the receipt to analyze. The input must be a valid, encoded
@@ -1194,4 +1206,4 @@ methods:
11941206
- uid: azure.ai.formrecognizer.FormRecognizerClient.close
11951207
name: close
11961208
summary: Close the <xref:azure.ai.formrecognizer.FormRecognizerClient> session.
1197-
signature: close()
1209+
signature: close() -> None

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormRecognizerError.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ methods:
2424
- uid: azure.ai.formrecognizer.FormRecognizerError.from_dict
2525
name: from_dict
2626
summary: Converts a dict in the shape of a FormRecognizerError to the model itself.
27-
signature: from_dict(data)
27+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FormRecognizerError'
2828
parameters:
2929
- name: data
3030
description: A dictionary in the shape of FormRecognizerError.
@@ -40,7 +40,7 @@ methods:
4040
- uid: azure.ai.formrecognizer.FormRecognizerError.to_dict
4141
name: to_dict
4242
summary: Returns a dict representation of FormRecognizerError.
43-
signature: to_dict()
43+
signature: to_dict() -> dict
4444
return:
4545
description: dict
4646
types:

docs-ref-autogen/azure-ai-formrecognizer/azure.ai.formrecognizer.FormSelectionMark.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ methods:
4949
- uid: azure.ai.formrecognizer.FormSelectionMark.from_dict
5050
name: from_dict
5151
summary: Converts a dict in the shape of a FormSelectionMark to the model itself.
52-
signature: from_dict(data)
52+
signature: 'from_dict(data: dict) -> azure.ai.formrecognizer._models.FormSelectionMark'
5353
parameters:
5454
- name: data
5555
description: A dictionary in the shape of FormSelectionMark.
@@ -65,7 +65,7 @@ methods:
6565
- uid: azure.ai.formrecognizer.FormSelectionMark.to_dict
6666
name: to_dict
6767
summary: Returns a dict representation of FormSelectionMark.
68-
signature: to_dict()
68+
signature: to_dict() -> dict
6969
return:
7070
description: dict
7171
types:

0 commit comments

Comments
 (0)