Skip to content

Commit bf0e40e

Browse files
[formrecognizer] updating docs with aka.ms links (#21012)
* add service links * update with the aka.ms links
1 parent 08b17d8 commit bf0e40e

File tree

3 files changed

+12
-12
lines changed

3 files changed

+12
-12
lines changed

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,7 @@ Use the `model` parameter to select the type of model for analysis.
160160
|"{custom-model-id}"| Text extraction, selection marks, tables, labeled fields and values from your custom documents
161161

162162
Sample code snippets are provided to illustrate using a DocumentAnalysisClient [here](#examples "Examples").
163+
More information about analyzing documents, including supported features and locales can be found in the [service documentation][fr-models].
163164

164165
### DocumentModelAdministrationClient
165166
`DocumentModelAdministrationClient` provides operations for:
@@ -532,6 +533,7 @@ except ResourceNotFoundError:
532533

533534
### General
534535
Form Recognizer client library will raise exceptions defined in [Azure Core][azure_core_exceptions].
536+
Error codes and messages raised by the Form Recognizer service can be found in the [service documentation][fr-errors].
535537

536538
### Logging
537539
This library uses the standard
@@ -584,6 +586,8 @@ This project has adopted the [Microsoft Open Source Code of Conduct][code_of_con
584586
[fr-labeling-tool]: https://aka.ms/azsdk/formrecognizer/labelingtool
585587
[fr-build-model]: https://aka.ms/azsdk/formrecognizer/buildmodel
586588
[fr-build-training-set]: https://aka.ms/azsdk/formrecognizer/buildtrainingset
589+
[fr-models]: https://aka.ms/azsdk/formrecognizer/models
590+
[fr-errors]: https://aka.ms/azsdk/formrecognizer/errors
587591

588592
[azure_core_ref_docs]: https://aka.ms/azsdk/python/core/docs
589593
[azure_core_exceptions]: https://aka.ms/azsdk/python/core/docs#module-azure.core.exceptions

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,9 +78,8 @@ def begin_analyze_document(self, model, document, **kwargs):
7878
"""Analyze field text and semantic values from a given document.
7979
8080
:param str model: A unique model identifier can be passed in as a string.
81-
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs to use are:
82-
"prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard",
83-
"prebuilt-document", "prebuilt-layout".
81+
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs supported
82+
can be found here: https://aka.ms/azsdk/formrecognizer/models
8483
:param document: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
8584
:type document: bytes or IO[bytes]
8685
: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):
134133
The input must be the location (URL) of the document to be analyzed.
135134
136135
:param str model: A unique model identifier can be passed in as a string.
137-
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs to use are:
138-
"prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard",
139-
"prebuilt-document", "prebuilt-layout".
136+
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs supported
137+
can be found here: https://aka.ms/azsdk/formrecognizer/models
140138
:param str document_url: The URL of the document to analyze. The input must be a valid, encoded, and
141139
publicly accessible URL of one of the supported formats: JPEG, PNG, PDF, TIFF, or BMP.
142140
:keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers

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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,8 @@ async def begin_analyze_document(
8484
"""Analyze field text and semantic values from a given document.
8585
8686
:param str model: A unique model identifier can be passed in as a string.
87-
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs to use are:
88-
"prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard",
89-
"prebuilt-document", "prebuilt-layout".
87+
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs supported
88+
can be found here: https://aka.ms/azsdk/formrecognizer/models
9089
:param document: JPEG, PNG, PDF, TIFF, or BMP type file stream or bytes.
9190
:type document: bytes or IO[bytes]
9291
: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(
141140
The input must be the location (URL) of the document to be analyzed.
142141
143142
:param str model: A unique model identifier can be passed in as a string.
144-
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs to use are:
145-
"prebuilt-receipt", "prebuilt-invoice", "prebuilt-idDocument", "prebuilt-businessCard",
146-
"prebuilt-document", "prebuilt-layout".
143+
Use this to specify the custom model ID or prebuilt model ID. Prebuilt model IDs supported
144+
can be found here: https://aka.ms/azsdk/formrecognizer/models
147145
:param str document_url: The URL of the document to analyze. The input must be a valid, encoded, and
148146
publicly accessible URL of one of the supported formats: JPEG, PNG, PDF, TIFF, or BMP.
149147
:keyword str pages: Custom page numbers for multi-page documents(PDF/TIFF). Input the page numbers

0 commit comments

Comments
 (0)