diff --git a/sdk/formrecognizer/azure-ai-formrecognizer/README.md b/sdk/formrecognizer/azure-ai-formrecognizer/README.md index a66d8ea808e3..7ca9509f14c5 100644 --- a/sdk/formrecognizer/azure-ai-formrecognizer/README.md +++ b/sdk/formrecognizer/azure-ai-formrecognizer/README.md @@ -160,6 +160,7 @@ Use the `model` parameter to select the type of model for analysis. |"{custom-model-id}"| Text extraction, selection marks, tables, labeled fields and values from your custom documents Sample code snippets are provided to illustrate using a DocumentAnalysisClient [here](#examples "Examples"). +More information about analyzing documents, including supported features and locales can be found in the [service documentation][fr-models]. ### DocumentModelAdministrationClient `DocumentModelAdministrationClient` provides operations for: @@ -532,6 +533,7 @@ except ResourceNotFoundError: ### General Form Recognizer client library will raise exceptions defined in [Azure Core][azure_core_exceptions]. +Error codes and messages raised by the Form Recognizer service can be found in the [service documentation][fr-errors]. ### Logging This library uses the standard @@ -584,6 +586,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con [fr-labeling-tool]: https://aka.ms/azsdk/formrecognizer/labelingtool [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 +[fr-errors]: https://aka.ms/azsdk/formrecognizer/errors [azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs [azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions 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 b71b519195e1..9e625e4693db 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 @@ -78,9 +78,8 @@ def begin_analyze_document(self, model, document, **kwargs): """Analyze field text and semantic values from a given document. :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 to use are: - "prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard", - "prebuilt-document", "prebuilt-layout". + 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 document: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes. :type document: bytes or IO[bytes] :keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers @@ -134,9 +133,8 @@ def begin_analyze_document_from_url(self, model, document_url, **kwargs): The input must be the location (URL) of the document to be analyzed. :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 to use are: - "prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard", - "prebuilt-document", "prebuilt-layout". + 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. :keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers 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 f5ebaa29eb3f..25b71f5cfc16 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 @@ -84,9 +84,8 @@ async def begin_analyze_document( """Analyze field text and semantic values from a given document. :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 to use are: - "prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard", - "prebuilt-document", "prebuilt-layout". + 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 document: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes. :type document: bytes or IO[bytes] :keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers @@ -141,9 +140,8 @@ async def begin_analyze_document_from_url( The input must be the location (URL) of the document to be analyzed. :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 to use are: - "prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard", - "prebuilt-document", "prebuilt-layout". + 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. :keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers