Skip to content

Commit 6b97541

Browse files
update doc for content_type (#12220)
1 parent 61af105 commit 6b97541

File tree

2 files changed

+12
-6
lines changed

2 files changed

+12
-6
lines changed

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_form_recognizer_client.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,10 @@ def begin_recognize_receipts(self, receipt, **kwargs):
9595
:type receipt: bytes or IO[bytes]
9696
:keyword bool include_text_content:
9797
Whether or not to include text elements such as lines and words in addition to form fields.
98-
:keyword str content_type: Media type of the body sent to the API. Content-type is
98+
:keyword content_type: Media type of the body sent to the API. Content-type is
9999
auto-detected, but can be overridden by passing this keyword argument. For options,
100100
see :class:`~azure.ai.formrecognizer.FormContentType`.
101+
:paramtype: str or ~azure.ai.formrecognizer.FormContentType
101102
:keyword int polling_interval: Waiting time between two polls for LRO operations
102103
if no Retry-After header is present. Defaults to 5 seconds.
103104
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -197,9 +198,10 @@ def begin_recognize_content(self, form, **kwargs):
197198
198199
:param form: JPEG, PNG, PDF and TIFF type file stream or bytes.
199200
:type form: bytes or IO[bytes]
200-
:keyword str content_type: Media type of the body sent to the API. Content-type is
201+
:keyword content_type: Media type of the body sent to the API. Content-type is
201202
auto-detected, but can be overridden by passing this keyword argument. For options,
202203
see :class:`~azure.ai.formrecognizer.FormContentType`.
204+
:paramtype: str or ~azure.ai.formrecognizer.FormContentType
203205
:keyword int polling_interval: Waiting time between two polls for LRO operations
204206
if no Retry-After header is present. Defaults to 5 seconds.
205207
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -279,9 +281,10 @@ def begin_recognize_custom_forms(self, model_id, form, **kwargs):
279281
:type form: bytes or IO[bytes]
280282
:keyword bool include_text_content:
281283
Whether or not to include text elements such as lines and words in addition to form fields.
282-
:keyword str content_type: Media type of the body sent to the API. Content-type is
284+
:keyword content_type: Media type of the body sent to the API. Content-type is
283285
auto-detected, but can be overridden by passing this keyword argument. For options,
284286
see :class:`~azure.ai.formrecognizer.FormContentType`.
287+
:paramtype: str or ~azure.ai.formrecognizer.FormContentType
285288
:keyword int polling_interval: Waiting time between two polls for LRO operations
286289
if no Retry-After header is present. Defaults to 5 seconds.
287290
:keyword str continuation_token: A continuation token to restart a poller from a saved state.

sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_form_recognizer_client_async.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,10 @@ async def begin_recognize_receipts(
103103
:type receipt: bytes or IO[bytes]
104104
:keyword bool include_text_content:
105105
Whether or not to include text elements such as lines and words in addition to form fields.
106-
:keyword str content_type: Media type of the body sent to the API. Content-type is
106+
:keyword content_type: Media type of the body sent to the API. Content-type is
107107
auto-detected, but can be overridden by passing this keyword argument. For options,
108108
see :class:`~azure.ai.formrecognizer.FormContentType`.
109+
:paramtype: str or ~azure.ai.formrecognizer.FormContentType
109110
:keyword int polling_interval: Waiting time between two polls for LRO operations
110111
if no Retry-After header is present. Defaults to 5 seconds.
111112
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -217,9 +218,10 @@ async def begin_recognize_content(
217218
218219
:param form: JPEG, PNG, PDF and TIFF type file stream or bytes.
219220
:type form: bytes or IO[bytes]
220-
:keyword str content_type: Media type of the body sent to the API. Content-type is
221+
:keyword content_type: Media type of the body sent to the API. Content-type is
221222
auto-detected, but can be overridden by passing this keyword argument. For options,
222223
see :class:`~azure.ai.formrecognizer.FormContentType`.
224+
:paramtype: str or ~azure.ai.formrecognizer.FormContentType
223225
:keyword int polling_interval: Waiting time between two polls for LRO operations
224226
if no Retry-After header is present. Defaults to 5 seconds.
225227
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
@@ -307,9 +309,10 @@ async def begin_recognize_custom_forms(
307309
:type form: bytes or IO[bytes]
308310
:keyword bool include_text_content:
309311
Whether or not to include text elements such as lines and words in addition to form fields.
310-
:keyword str content_type: Media type of the body sent to the API. Content-type is
312+
:keyword content_type: Media type of the body sent to the API. Content-type is
311313
auto-detected, but can be overridden by passing this keyword argument. For options,
312314
see :class:`~azure.ai.formrecognizer.FormContentType`.
315+
:paramtype: str or ~azure.ai.formrecognizer.FormContentType
313316
:keyword int polling_interval: Waiting time between two polls for LRO operations
314317
if no Retry-After header is present. Defaults to 5 seconds.
315318
:keyword str continuation_token: A continuation token to restart a poller from a saved state.

0 commit comments

Comments
 (0)