[DI] Add SDK versions and API versions relationship in README.md (#33351

)
Azure · Dec 5, 2023 · 2bcc83c · 2bcc83c
1 parent 59ca764
commit 2bcc83c
Show file tree

Hide file tree

Showing 45 changed files with 291 additions and 247 deletions.
diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/CHANGELOG.md b/sdk/documentintelligence/azure-ai-documentintelligence/CHANGELOG.md
@@ -23,4 +23,4 @@ This is the first preview of the `azure-ai-documentintelligence` package, target
 - Changed some currency-related fields in `prebuilt-receipt` model.
 - Retired model `prebuilt-businessCard` and `prebuilt-document`. `prebuilt-document` model is essentially `prebuilt-layout` with `features="keyValuePairs"` specified. _(This is only supported as an optional feature for "prebuilt-layout" and "prebuilt-invoice".)_
 
-If you were using the old `azure-ai-formrecognizer` package, please refer [MIGRATION.MD](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/documentintelligence/azure-ai-documentintelligence/MIGRATION_GUIDE.md) for more details.
+If you were using the old `azure-ai-formrecognizer` package, please refer [MIGRATION_GUIDE.MD](https://github.com/Azure/azure-sdk-for-python/blob/main/sdk/documentintelligence/azure-ai-documentintelligence/MIGRATION_GUIDE.md) for more details.
diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/MIGRATION_GUIDE.md b/sdk/documentintelligence/azure-ai-documentintelligence/MIGRATION_GUIDE.md
@@ -90,7 +90,7 @@ Each page is treated as a separate document. Each empty page is kept as its own
 
 ### Clients names updates
 
-|SDK version|Supported API version of service|
+|SDK version|Supported API service version|
 |-|-|
 |1.0.0b1|2023-10-31-preview|
 |3.3.X(azure-ai-formrecognizer latest GA release)|2.0, 2.1, 2022-08-31, 2023-07-31 (default)|

diff --git a/sdk/documentintelligence/azure-ai-documentintelligence/README.md b/sdk/documentintelligence/azure-ai-documentintelligence/README.md
diff --git a/...lligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_barcodes_async.py b/...lligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_barcodes_async.py
@@ -60,12 +60,12 @@ async def analyze_barcodes():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
 
-    async with document_analysis_client:
+    async with document_intelligence_client:
         # Specify which add-on capabilities to enable.
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-layout",
                 analyze_request=f,
                 features=[DocumentAnalysisFeature.BARCODES],

diff --git a/...ntelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_fonts_async.py b/...ntelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_fonts_async.py
@@ -68,11 +68,11 @@ async def analyze_fonts():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
         # Specify which add-on capabilities to enable.
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-layout",
                 analyze_request=f,
                 features=[DocumentAnalysisFeature.STYLE_FONT],

diff --git a/...lligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_formulas_async.py b/...lligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_formulas_async.py
@@ -60,12 +60,12 @@ async def analyze_formulas():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
 
-    async with document_analysis_client:
+    async with document_intelligence_client:
         # Specify which add-on capabilities to enable
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-layout",
                 analyze_request=f,
                 features=[DocumentAnalysisFeature.FORMULAS],

diff --git a/...elligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_highres_async.py b/...elligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_highres_async.py
@@ -75,12 +75,12 @@ async def analyze_with_highres():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
 
-    async with document_analysis_client:
+    async with document_intelligence_client:
         # Specify which add-on capabilities to enable.
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-layout",
                 analyze_request=f,
                 features=[DocumentAnalysisFeature.OCR_HIGH_RESOLUTION],

diff --git a/...ligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_languages_async.py b/...ligence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_languages_async.py
@@ -60,12 +60,12 @@ async def analyze_languages():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
 
-    async with document_analysis_client:
+    async with document_intelligence_client:
         # Specify which add-on capabilities to enable.
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-layout",
                 analyze_request=f,
                 features=[DocumentAnalysisFeature.LANGUAGES],

diff --git a/...ence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_query_fields_async.py b/...ence/azure-ai-documentintelligence/samples/aio/sample_analyze_addon_query_fields_async.py
@@ -53,11 +53,11 @@ async def analyze_query_fields():
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
     url = "https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/documentintelligence/azure-ai-documentintelligence/samples/sample_forms/forms/Invoice_1.pdf"
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
 
-    async with document_analysis_client:
+    async with document_intelligence_client:
         # Specify which add-on capabilities to enable.
-        poller = await document_analysis_client.begin_analyze_document(
+        poller = await document_intelligence_client.begin_analyze_document(
             "prebuilt-layout",
             AnalyzeDocumentRequest(url_source=url),
             features=[DocumentAnalysisFeature.QUERY_FIELDS],

diff --git a/...igence/azure-ai-documentintelligence/samples/aio/sample_analyze_custom_documents_async.py b/...igence/azure-ai-documentintelligence/samples/aio/sample_analyze_custom_documents_async.py
@@ -43,11 +43,11 @@ async def analyze_custom_documents(custom_model_id):
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
     model_id = os.getenv("CUSTOM_BUILT_MODEL_ID", custom_model_id)
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
 
     # Make sure your document's type is included in the list of document types the custom model can analyze
     with open(path_to_sample_documents, "rb") as f:
-        poller = await document_analysis_client.begin_analyze_document(
+        poller = await document_intelligence_client.begin_analyze_document(
             model_id=model_id, analyze_request=f, content_type="application/octet-stream"
         )
     result = await poller.result()
@@ -112,11 +112,11 @@ async def main():
                 build_mode=DocumentBuildMode.TEMPLATE,
                 azure_blob_source=AzureBlobContentSource(container_url=blob_container_sas_url),
             )
-            document_model_admin_client = DocumentIntelligenceAdministrationClient(
+            document_intelligence_admin_client = DocumentIntelligenceAdministrationClient(
                 endpoint=endpoint, credential=AzureKeyCredential(key)
             )
-            async with document_model_admin_client:
-                poll = await document_model_admin_client.begin_build_document_model(request)
+            async with document_intelligence_admin_client:
+                poll = await document_intelligence_admin_client.begin_build_document_model(request)
                 model = await poll.result()
             model_id = model.model_id
     await analyze_custom_documents(model_id)

diff --git a/...-ai-documentintelligence/samples/aio/sample_analyze_documents_output_in_markdown_async.py b/...-ai-documentintelligence/samples/aio/sample_analyze_documents_output_in_markdown_async.py
@@ -34,9 +34,9 @@ async def analyze_documents_output_in_markdown():
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
     url = "https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/documentintelligence/azure-ai-documentintelligence/samples/sample_forms/forms/Invoice_1.pdf"
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
-        poller = await document_analysis_client.begin_analyze_document(
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
+        poller = await document_intelligence_client.begin_analyze_document(
             "prebuilt-layout",
             AnalyzeDocumentRequest(url_source=url),
             output_content_format=ContentFormat.MARKDOWN,

diff --git a/...gence/azure-ai-documentintelligence/samples/aio/sample_analyze_general_documents_async.py b/...gence/azure-ai-documentintelligence/samples/aio/sample_analyze_general_documents_async.py
@@ -58,12 +58,12 @@ async def analyze_general_documents():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(
+    document_intelligence_client = DocumentIntelligenceClient(
         endpoint=endpoint, credential=AzureKeyCredential(key)
     )
-    async with document_analysis_client:
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-layout",
                 analyze_request=f,
                 features=[DocumentAnalysisFeature.KEY_VALUE_PAIRS],

diff --git a/...ence/azure-ai-documentintelligence/samples/aio/sample_analyze_identity_documents_async.py b/...ence/azure-ai-documentintelligence/samples/aio/sample_analyze_identity_documents_async.py
@@ -43,10 +43,10 @@ async def analyze_identity_documents():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-idDocument", analyze_request=f, content_type="application/octet-stream"
             )
         id_documents = await poller.result()

diff --git a/...ntintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_invoices_async.py b/...ntintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_invoices_async.py
@@ -44,10 +44,10 @@ async def analyze_invoice():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-invoice", analyze_request=f, locale="en-US", content_type="application/octet-stream"
             )
         invoices = await poller.result()

diff --git a/...mentintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_layout_async.py b/...mentintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_layout_async.py
@@ -61,10 +61,10 @@ async def analyze_layout():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-layout", analyze_request=f, content_type="application/octet-stream"
             )
         result = await poller.result()

diff --git a/...cumentintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_read_async.py b/...cumentintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_read_async.py
@@ -57,10 +57,10 @@ async def analyze_read():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-read",
                 analyze_request=f,
                 features=[DocumentAnalysisFeature.STYLE_FONT],

diff --git a/...ntintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_receipts_async.py b/...ntintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_receipts_async.py
@@ -49,10 +49,10 @@ async def analyze_receipts():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-receipt", analyze_request=f, locale="en-US", content_type="application/octet-stream"
             )
         receipts = await poller.result()

diff --git a/...gence/azure-ai-documentintelligence/samples/aio/sample_analyze_receipts_from_url_async.py b/...gence/azure-ai-documentintelligence/samples/aio/sample_analyze_receipts_from_url_async.py
@@ -41,13 +41,14 @@ async def analyze_receipts_from_url():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
     url = "https://raw.githubusercontent.com/Azure/azure-sdk-for-python/main/sdk/documentintelligence/azure-ai-documentintelligence/samples/sample_forms/receipt/contoso-receipt.png"
-    async with document_analysis_client:
-        poller = await document_analysis_client.begin_analyze_document(
+    async with document_intelligence_client:
+        poller = await document_intelligence_client.begin_analyze_document(
             "prebuilt-receipt", AnalyzeDocumentRequest(url_source=url)
         )
         receipts = await poller.result()
+    # [END analyze_receipts_from_url]
 
     for idx, receipt in enumerate(receipts.documents):
         print(f"--------Analysis of receipt #{idx + 1}--------")
@@ -96,7 +97,6 @@ async def analyze_receipts_from_url():
         if total:
             print(f"Total: {format_price(total.get('valueCurrency'))} has confidence: {total.confidence}")
         print("--------------------------------------")
-    # [END analyze_receipts_from_url]
 
 
 async def main():

diff --git a/...tintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_tax_us_w2_async.py b/...tintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_tax_us_w2_async.py
@@ -47,10 +47,10 @@ async def analyze_tax_us_w2():
     endpoint = os.environ["DOCUMENTINTELLIGENCE_ENDPOINT"]
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
 
-    document_analysis_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
-    async with document_analysis_client:
+    document_intelligence_client = DocumentIntelligenceClient(endpoint=endpoint, credential=AzureKeyCredential(key))
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_analyze_document(
+            poller = await document_intelligence_client.begin_analyze_document(
                 "prebuilt-tax.us.w2", analyze_request=f, locale="en-US", content_type="application/octet-stream"
             )
         w2s = await poller.result()

diff --git a/...tintelligence/azure-ai-documentintelligence/samples/aio/sample_classify_document_async.py b/...tintelligence/azure-ai-documentintelligence/samples/aio/sample_classify_document_async.py
@@ -50,12 +50,12 @@ async def classify_document(classifier_id):
     key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
     classifier_id = os.getenv("CLASSIFIER_ID", classifier_id)
 
-    document_analysis_client = DocumentIntelligenceClient(
+    document_intelligence_client = DocumentIntelligenceClient(
         endpoint=endpoint, credential=AzureKeyCredential(key)
     )
-    async with document_analysis_client:
+    async with document_intelligence_client:
         with open(path_to_sample_documents, "rb") as f:
-            poller = await document_analysis_client.begin_classify_document(
+            poller = await document_intelligence_client.begin_classify_document(
                 classifier_id, classify_request=f, content_type="application/octet-stream"
             )
         result = await poller.result()
@@ -85,11 +85,11 @@ async def main():
         key = os.environ["DOCUMENTINTELLIGENCE_API_KEY"]
         blob_container_sas_url = os.environ["DOCUMENTINTELLIGENCE_TRAINING_DATA_CLASSIFIER_SAS_URL"]
 
-        document_model_admin_client = DocumentIntelligenceAdministrationClient(
+        document_intelligence_admin_client = DocumentIntelligenceAdministrationClient(
             endpoint=endpoint, credential=AzureKeyCredential(key)
         )
-        async with document_model_admin_client:
-            poller = await document_model_admin_client.begin_build_classifier(
+        async with document_intelligence_admin_client:
+            poller = await document_intelligence_admin_client.begin_build_classifier(
                 BuildDocumentClassifierRequest(
                     classifier_id=str(uuid.uuid4()),
                     doc_types={