diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md b/sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md index 700a4d7fae6d..e4d9ac213c38 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md +++ b/sdk/formrecognizer/azure-ai-formrecognizer/MIGRATION_GUIDE.md @@ -595,7 +595,7 @@ print("-----------------------------------") ### Training a custom model Differences between the versions: -- Files for building a new model for version `3.2.x` can be created using the labeling tool found [here][fr_labeling_tool]. +- Files for building a new model for version `3.2.x` can be created using [Form Recognizer Studio][fr_labeling_tool]. - In version `3.1.x` the `use_training_labels` keyword argument was used to indicate whether to use labeled data when creating the custom model. - In version `3.2.x` the `use_training_labels` keyword argument is not supported since training must be carried out with labeled training documents. Additionally train without labels is now replaced with the prebuilt model `prebuilt-document` which extracts entities, key-value pairs, and layout from a document. @@ -666,4 +666,4 @@ For additional samples please take a look at the [Form Recognizer Samples][sampl [readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/README.md [samples_readme]: https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/formrecognizer/azure-ai-formrecognizer/samples/README.md -[fr_labeling_tool]: https://aka.ms/azsdk/formrecognizer/labelingtool \ No newline at end of file +[fr_labeling_tool]: https://aka.ms/azsdk/formrecognizer/formrecognizerstudio \ No newline at end of file diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/README.md b/sdk/formrecognizer/azure-ai-formrecognizer/README.md index 84a9a14f7285..67a2a26e3968 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/README.md +++ b/sdk/formrecognizer/azure-ai-formrecognizer/README.md @@ -181,7 +181,7 @@ More information about analyzing documents, including supported features, locale - Listing document model operations or getting a specific model operation created within the last 24 hours. - Copying a custom model from one Form Recognizer resource to another. -Please note that models can also be built using a graphical user interface such as the [Form Recognizer Labeling Tool][labeling-tool]. +Please note that models can also be built using a graphical user interface such as [Form Recognizer Studio][fr-studio]. Sample code snippets are provided to illustrate using a DocumentModelAdministrationClient [here](#examples "Examples"). @@ -360,6 +360,8 @@ for page in result.pages: ) ``` +- Read more about the features provided by the `prebuilt-document` model [here][service_prebuilt_document]. + ### Using Prebuilt Models Extract fields from select document types such as receipts, invoices, business cards, and identity documents using prebuilt models provided by the Form Recognizer service. @@ -597,6 +599,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [cognitive_resource_cli]: https://docs.microsoft.com/azure/cognitive-services/cognitive-services-apis-create-account-cli?tabs=windows [azure-key-credential]: https://aka.ms/azsdk/python/core/azurekeycredential [labeling-tool]: https://aka.ms/azsdk/formrecognizer/labelingtool +[fr-studio]: https://aka.ms/azsdk/formrecognizer/formrecognizerstudio [fr-build-model]: https://aka.ms/azsdk/formrecognizer/buildmodel [fr-build-training-set]: https://aka.ms/azsdk/formrecognizer/buildtrainingset [fr-models]: https://aka.ms/azsdk/formrecognizer/models @@ -617,6 +620,7 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [service_recognize_business_cards]: https://aka.ms/azsdk/formrecognizer/businesscardfieldschema [service_recognize_invoice]: https://aka.ms/azsdk/formrecognizer/invoicefieldschema [service_recognize_identity_documents]: https://aka.ms/azsdk/formrecognizer/iddocumentfieldschema +[service_prebuilt_document]: https://docs.microsoft.com/azure/applied-ai-services/form-recognizer/concept-general-document#general-document-features [sdk_logging_docs]: https://docs.microsoft.com/azure/developer/python/azure-sdk-logging [sample_readme]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/samples [changelog]: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/formrecognizer/azure-ai-formrecognizer/CHANGELOG.md diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_document_analysis_client.py b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_document_analysis_client.py index 655d1b447f7d..42ac9ad67d0c 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_document_analysis_client.py +++ b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/_document_analysis_client.py @@ -144,8 +144,9 @@ def begin_analyze_document_from_url(self, model, document_url, **kwargs): :param str model: A unique model identifier can be passed in as a string. Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs supported can be found here: https://aka.ms/azsdk/formrecognizer/models - :param str document_url: The URL of the document to analyze. The input must be a valid, encoded, and - publicly accessible URL of one of the supported formats: JPEG, PNG, PDF, TIFF, or BMP. + :param str document_url: The URL of the document to analyze. The input must be a valid, properly + encoded (i.e. encode special characters, such as empty spaces), and publicly accessible URL + of one of the supported formats: JPEG, PNG, PDF, TIFF, or BMP. :keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages="1-3, 5-6"`. Separate each page number or range with a comma. diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_document_analysis_client_async.py b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_document_analysis_client_async.py index 65e4d8641502..cc5a0c50c7d7 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_document_analysis_client_async.py +++ b/sdk/formrecognizer/azure-ai-formrecognizer/azure/ai/formrecognizer/aio/_document_analysis_client_async.py @@ -151,8 +151,9 @@ async def begin_analyze_document_from_url( :param str model: A unique model identifier can be passed in as a string. Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs supported can be found here: https://aka.ms/azsdk/formrecognizer/models - :param str document_url: The URL of the document to analyze. The input must be a valid, encoded, and - publicly accessible URL of one of the supported formats: JPEG, PNG, PDF, TIFF, or BMP. + :param str document_url: The URL of the document to analyze. The input must be a valid, properly + encoded (i.e. encode special characters, such as empty spaces), and publicly accessible URL + of one of the supported formats: JPEG, PNG, PDF, TIFF, or BMP. :keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers and/or ranges of pages you want to get in the result. For a range of pages, use a hyphen, like `pages="1-3, 5-6"`. Separate each page number or range with a comma.