Skip to content

Commit 1d5719b

Browse files
committed
one more change
1 parent 1462090 commit 1d5719b

File tree

3 files changed

+9
-4
lines changed

3 files changed

+9
-4
lines changed

sdk/formrecognizer/azure-ai-formrecognizer/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,7 @@ If training files are within a subfolder in the container, use the [prefix][pref
263263
More details on setting up a container and required file structure can be found in the [service quickstart documentation][quickstart_training].
264264

265265
To train a model, you will need Azure Blob storage container's shared access signature (SAS) URL. See [here][train-a-model-using-labeled-data] for more detailed descriptions on how to get it.
266+
Alternatively, a container uri can be used instead if the container is public.
266267

267268
```python
268269
from azure.ai.formrecognizer import FormTrainingClient

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -93,11 +93,13 @@ def __init__(self, endpoint, credential, **kwargs):
9393
def begin_training(self, training_files_url, use_training_labels, **kwargs):
9494
# type: (str, bool, Any) -> LROPoller[CustomFormModel]
9595
"""Create and train a custom model. The request must include a `training_files_url` parameter that is an
96-
externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri).
96+
externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri). Note that
97+
a container uri is accepted only when the container is public.
9798
Models are trained using documents that are of the following content type - 'application/pdf',
9899
'image/jpeg', 'image/png', 'image/tiff'. Other type of content in the container is ignored.
99100
100-
:param str training_files_url: An Azure Storage blob container's SAS URI.
101+
:param str training_files_url: An Azure Storage blob container's SAS URI. A container uri can be used if the
102+
container is public.
101103
:param bool use_training_labels: Whether to train with labels or not. Corresponding labeled files must
102104
exist in the blob container.
103105
:keyword str prefix: A case-sensitive prefix string to filter documents in the source path for

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

+4-2
Original file line numberDiff line numberDiff line change
@@ -102,11 +102,13 @@ async def begin_training(
102102
**kwargs: Any
103103
) -> AsyncLROPoller[CustomFormModel]:
104104
"""Create and train a custom model. The request must include a `training_files_url` parameter that is an
105-
externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri).
105+
externally accessible Azure storage blob container Uri (preferably a Shared Access Signature Uri). Note that
106+
a container uri is accepted only when the container is public.
106107
Models are trained using documents that are of the following content type - 'application/pdf',
107108
'image/jpeg', 'image/png', 'image/tiff'. Other type of content in the container is ignored.
108109
109-
:param str training_files_url: An Azure Storage blob container's SAS URI.
110+
:param str training_files_url: An Azure Storage blob container's SAS URI. A container uri can be used if the
111+
container is public.
110112
:param bool use_training_labels: Whether to train with labels or not. Corresponding labeled files must
111113
exist in the blob container.
112114
:keyword str prefix: A case-sensitive prefix string to filter documents in the source path for

0 commit comments

Comments
 (0)