Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[formrecognizer] DMAC docstring feedback from service team #20955

Merged
merged 1 commit into from
Sep 30, 2021
Merged

[formrecognizer] DMAC docstring feedback from service team #20955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions .../azure-ai-formrecognizer/azure/ai/formrecognizer/_document_model_administration_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,8 +92,7 @@ def begin_build_model(self, source, **kwargs):
"""Build a custom model.

The request must include a `source` parameter that is an
externally accessible Azure storage blob container URI (preferably a Shared Access Signature URI). Note that
a container URI (without SAS) is accepted only when the container is public.
externally accessible Azure storage blob container URI (preferably a Shared Access Signature URI).
Models are built using documents that are of the following content type - 'application/pdf',
'image/jpeg', 'image/png', 'image/tiff', or 'image/bmp'. Other types of content in the container is ignored.

Expand All @@ -104,6 +103,7 @@ def begin_build_model(self, source, **kwargs):
:keyword str description: An optional description to add to the model.
:keyword str prefix: A case-sensitive prefix string to filter documents in the source path.
For example, when using an Azure storage blob URI, use the prefix to restrict sub folders.
`prefix` should end in '/' to avoid cases where filenames share the same prefix.
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:return: An instance of an DocumentModelAdministrationLROPoller. Call `result()` on the poller
object to return a :class:`~azure.ai.formrecognizer.DocumentModel`.
Expand Down Expand Up @@ -206,7 +206,7 @@ def _compose_callback(
component_models=[
self._generated_models.ComponentModelInfo(model_id=model_id)
for model_id in model_ids
] if model_ids else None
] if model_ids else []
),
cls=kwargs.pop("cls", _compose_callback),
polling=LROBasePolling(
Expand Down
6 changes: 3 additions & 3 deletions ...formrecognizer/azure/ai/formrecognizer/aio/_document_model_administration_client_async.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,8 +100,7 @@ async def begin_build_model(
"""Build a custom model.

The request must include a `source` parameter that is an
externally accessible Azure storage blob container URI (preferably a Shared Access Signature URI). Note that
a container URI (without SAS) is accepted only when the container is public.
externally accessible Azure storage blob container URI (preferably a Shared Access Signature URI).
Models are built using documents that are of the following content type - 'application/pdf',
'image/jpeg', 'image/png', 'image/tiff', or 'image/bmp'. Other types of content in the container is ignored.

Expand All @@ -112,6 +111,7 @@ async def begin_build_model(
:keyword str description: An optional description to add to the model.
:keyword str prefix: A case-sensitive prefix string to filter documents in the source path.
For example, when using an Azure storage blob URI, use the prefix to restrict sub folders.
`prefix` should end in '/' to avoid cases where filenames share the same prefix.
:keyword str continuation_token: A continuation token to restart a poller from a saved state.
:return: An instance of an AsyncDocumentModelAdministrationLROPoller. Call `result()` on the poller
object to return a :class:`~azure.ai.formrecognizer.DocumentModel`.
Expand Down Expand Up @@ -214,7 +214,7 @@ def _compose_callback(
component_models=[
self._generated_models.ComponentModelInfo(model_id=model_id)
for model_id in model_ids
] if model_ids else None
] if model_ids else []
),
cls=kwargs.pop("cls", _compose_callback),
polling=AsyncLROBasePolling(
Expand Down