[DI] Patch default polling interval (#33463)

Author: Yalin Li

sdk/documentintelligence/azure-ai-documentintelligence/CHANGELOG.md

@@ -10,6 +10,8 @@
 
 ### Other Changes
 
+- Changed the default polling interval from 30s to 5s.
+
 ## 1.0.0b1 (2023-11-17)
 
 This is the first preview of the `azure-ai-documentintelligence` package, targeting API version `2023-10-31-preview` of the Document Intelligence service(formerly known as Form Recognizer).

sdk/documentintelligence/azure-ai-documentintelligence/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "python",
   "TagPrefix": "python/documentintelligence/azure-ai-documentintelligence",
-  "Tag": "python/documentintelligence/azure-ai-documentintelligence_f46d5cfe2d"
+  "Tag": "python/documentintelligence/azure-ai-documentintelligence_3a7d15d3b0"
 }

sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_operations/_patch.py

@@ -30,7 +30,6 @@
 
 
 class DocumentIntelligenceAdministrationClientOperationsMixin(GeneratedDIAdminClientOps):  # pylint: disable=name-too-long
-    __doc__ = GeneratedDIAdminClientOps.__doc__
 
     @distributed_trace
     def begin_build_classifier(

sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/_patch.py

@@ -6,9 +6,82 @@
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
-from typing import List
+from typing import Any, List, Union
 
-__all__: List[str] = []  # Add all objects you want publicly available to users at this package level
+from azure.core.credentials import AzureKeyCredential, TokenCredential
+
+from ._client import(
+    DocumentIntelligenceClient as DIClientGenerated,
+    DocumentIntelligenceAdministrationClient as DIAClientGenerated,
+)
+
+
+class DocumentIntelligenceClient(DIClientGenerated):  # pylint: disable=client-accepts-api-version-keyword
+    """DocumentIntelligenceClient.
+
+    :param endpoint: The Document Intelligence service endpoint. Required.
+    :type endpoint: str
+    :param credential: Credential needed for the client to connect to Azure. Is either a
+     AzureKeyCredential type or a TokenCredential type. Required.
+    :type credential: ~azure.core.credentials.AzureKeyCredential or
+     ~azure.core.credentials.TokenCredential
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2023-10-31-preview". Note that overriding this default value may result in unsupported
+     behavior.
+    :paramtype api_version: str
+    """
+
+    def __init__(
+        self,
+        endpoint: str,
+        credential: Union[AzureKeyCredential, TokenCredential],
+        **kwargs: Any,
+    ) -> None:
+        # The default polling interval should be 5 seconds.
+        polling_interval = kwargs.pop("polling_interval", 5)
+        super().__init__(
+            endpoint=endpoint,
+            credential=credential,
+            polling_interval=polling_interval,
+            **kwargs,
+        )
+
+
+class DocumentIntelligenceAdministrationClient(DIAClientGenerated):  # pylint: disable=client-accepts-api-version-keyword
+    """DocumentIntelligenceAdministrationClient.
+
+    :param endpoint: The Document Intelligence service endpoint. Required.
+    :type endpoint: str
+    :param credential: Credential needed for the client to connect to Azure. Is either a
+     AzureKeyCredential type or a TokenCredential type. Required.
+    :type credential: ~azure.core.credentials.AzureKeyCredential or
+     ~azure.core.credentials.TokenCredential
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2023-10-31-preview". Note that overriding this default value may result in unsupported
+     behavior.
+    :paramtype api_version: str
+    """
+
+    def __init__(
+        self,
+        endpoint: str,
+        credential: Union[AzureKeyCredential, TokenCredential],
+        **kwargs: Any,
+    ) -> None:
+        # The default polling interval should be 5 seconds.
+        polling_interval = kwargs.pop("polling_interval", 5)
+        super().__init__(
+            endpoint=endpoint,
+            credential=credential,
+            polling_interval=polling_interval,
+            **kwargs,
+        )
+
+
+__all__: List[str] = [
+    "DocumentIntelligenceClient",
+    "DocumentIntelligenceAdministrationClient",
+]  # Add all objects you want publicly available to users at this package level
 
 
 def patch_sdk():

sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/aio/_operations/_patch.py

@@ -30,7 +30,6 @@
 
 
 class DocumentIntelligenceAdministrationClientOperationsMixin(GeneratedDIAdminClientOps):  # pylint: disable=name-too-long
-    __doc__ = GeneratedDIAdminClientOps.__doc__
 
     @distributed_trace_async
     async def begin_build_classifier(

sdk/documentintelligence/azure-ai-documentintelligence/azure/ai/documentintelligence/aio/_patch.py

@@ -6,9 +6,83 @@
 
 Follow our quickstart for examples: https://aka.ms/azsdk/python/dpcodegen/python/customize
 """
-from typing import List
+from typing import Any, List, Union
 
-__all__: List[str] = []  # Add all objects you want publicly available to users at this package level
+from azure.core.credentials import AzureKeyCredential
+from azure.core.credentials_async import AsyncTokenCredential
+
+from ._client import(
+    DocumentIntelligenceClient as DIClientGenerated,
+    DocumentIntelligenceAdministrationClient as DIAClientGenerated,
+)
+
+
+class DocumentIntelligenceClient(DIClientGenerated):  # pylint: disable=client-accepts-api-version-keyword
+    """DocumentIntelligenceClient.
+
+    :param endpoint: The Document Intelligence service endpoint. Required.
+    :type endpoint: str
+    :param credential: Credential needed for the client to connect to Azure. Is either a
+     AzureKeyCredential type or a TokenCredential type. Required.
+    :type credential: ~azure.core.credentials.AzureKeyCredential or
+     ~azure.core.credentials_async.AsyncTokenCredential
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2023-10-31-preview". Note that overriding this default value may result in unsupported
+     behavior.
+    :paramtype api_version: str
+    """
+
+    def __init__(
+        self,
+        endpoint: str,
+        credential: Union[AzureKeyCredential, AsyncTokenCredential],
+        **kwargs: Any,
+    ) -> None:
+        # The default polling interval should be 5 seconds.
+        polling_interval = kwargs.pop("polling_interval", 5)
+        super().__init__(
+            endpoint=endpoint,
+            credential=credential,
+            polling_interval=polling_interval,
+            **kwargs,
+        )
+
+
+class DocumentIntelligenceAdministrationClient(DIAClientGenerated):  # pylint: disable=client-accepts-api-version-keyword
+    """DocumentIntelligenceAdministrationClient.
+
+    :param endpoint: The Document Intelligence service endpoint. Required.
+    :type endpoint: str
+    :param credential: Credential needed for the client to connect to Azure. Is either a
+     AzureKeyCredential type or a TokenCredential type. Required.
+    :type credential: ~azure.core.credentials.AzureKeyCredential or
+     ~azure.core.credentials_async.AsyncTokenCredential
+    :keyword api_version: The API version to use for this operation. Default value is
+     "2023-10-31-preview". Note that overriding this default value may result in unsupported
+     behavior.
+    :paramtype api_version: str
+    """
+
+    def __init__(
+        self,
+        endpoint: str,
+        credential: Union[AzureKeyCredential, AsyncTokenCredential],
+        **kwargs: Any,
+    ) -> None:
+        # The default polling interval should be 5 seconds.
+        polling_interval = kwargs.pop("polling_interval", 5)
+        super().__init__(
+            endpoint=endpoint,
+            credential=credential,
+            polling_interval=polling_interval,
+            **kwargs,
+        )
+
+
+__all__: List[str] = [
+    "DocumentIntelligenceClient",
+    "DocumentIntelligenceAdministrationClient",
+]  # Add all objects you want publicly available to users at this package level
 
 
 def patch_sdk():

sdk/documentintelligence/azure-ai-documentintelligence/samples/aio/sample_analyze_documents_output_in_markdown_async.py

@@ -43,7 +43,7 @@ async def analyze_documents_output_in_markdown():
         )
         result = await poller.result()
 
-    print(f"Here's the full content in format{result.content_format}:\n")
+    print(f"Here's the full content in format {result.content_format}:\n")
     print(result.content)
     # [END analyze_documents_output_in_markdown]
 

sdk/documentintelligence/azure-ai-documentintelligence/samples/sample_analyze_documents_output_in_markdown.py

@@ -41,7 +41,7 @@ def analyze_documents_output_in_markdown():
     )
     result = poller.result()
 
-    print(f"Here's the full content in format{result.content_format}:\n")
+    print(f"Here's the full content in format {result.content_format}:\n")
     print(result.content)
     # [END analyze_documents_output_in_markdown]
 

sdk/documentintelligence/azure-ai-documentintelligence/tests/test_dac_analyze_layout.py

@@ -7,6 +7,7 @@
 import pytest
 import functools
 from devtools_testutils import recorded_by_proxy
+from azure.core.credentials import AzureKeyCredential
 from azure.ai.documentintelligence import DocumentIntelligenceClient
 from azure.ai.documentintelligence.models import DocumentAnalysisFeature, AnalyzeDocumentRequest
 from testcase import DocumentIntelligenceTest
@@ -141,3 +142,31 @@ def test_layout_url_barcode(self, client):
         assert layout.pages[0].barcodes[0].kind == "Code39"
         assert layout.pages[0].barcodes[0].polygon
         assert layout.pages[0].barcodes[0].confidence > 0.8
+    
+    
+    @skip_flaky_test
+    @DocumentIntelligencePreparer()
+    @recorded_by_proxy
+    def test_polling_interval(self, documentintelligence_endpoint, documentintelligence_api_key, **kwargs):
+        client = DocumentIntelligenceClient(
+            documentintelligence_endpoint, AzureKeyCredential(documentintelligence_api_key)
+        )
+        assert client._config.polling_interval ==  5
+        
+        client = DocumentIntelligenceClient(
+            documentintelligence_endpoint, AzureKeyCredential(documentintelligence_api_key), polling_interval=7
+        )
+        assert client._config.polling_interval ==  7
+        poller = client.begin_analyze_document(
+            "prebuilt-receipt",
+            AnalyzeDocumentRequest(url_source=self.receipt_url_jpg),
+            polling_interval=6
+        )
+        poller.wait()
+        assert poller._polling_method._timeout ==  6
+        poller2 = client.begin_analyze_document(
+            "prebuilt-receipt",
+            AnalyzeDocumentRequest(url_source=self.receipt_url_jpg),
+        )
+        poller2.wait()
+        assert poller2._polling_method._timeout ==  7  # goes back to client default

sdk/documentintelligence/azure-ai-documentintelligence/tests/test_dac_analyze_layout_async.py

@@ -7,6 +7,7 @@
 import pytest
 import functools
 from devtools_testutils.aio import recorded_by_proxy_async
+from azure.core.credentials import AzureKeyCredential
 from azure.ai.documentintelligence.aio import DocumentIntelligenceClient
 from azure.ai.documentintelligence.models import DocumentAnalysisFeature, AnalyzeDocumentRequest
 from asynctestcase import AsyncDocumentIntelligenceTest
@@ -144,3 +145,31 @@ async def test_layout_url_barcodes(self, client):
         assert layout.pages[0].barcodes[0].kind == "Code39"
         assert layout.pages[0].barcodes[0].polygon
         assert layout.pages[0].barcodes[0].confidence > 0.8
+    
+    @skip_flaky_test
+    @DocumentIntelligencePreparer()
+    @recorded_by_proxy_async
+    async def test_polling_interval(self, documentintelligence_endpoint, documentintelligence_api_key, **kwargs):
+        client = DocumentIntelligenceClient(
+            documentintelligence_endpoint, AzureKeyCredential(documentintelligence_api_key)
+        )
+        assert client._config.polling_interval ==  5
+        
+        client = DocumentIntelligenceClient(
+            documentintelligence_endpoint, AzureKeyCredential(documentintelligence_api_key), polling_interval=7
+        )
+        assert client._config.polling_interval ==  7
+        async with client:
+            poller = await client.begin_analyze_document(
+                "prebuilt-receipt",
+                AnalyzeDocumentRequest(url_source=self.receipt_url_jpg),
+                polling_interval=6
+            )
+            await poller.wait()
+            assert poller._polling_method._timeout ==  6
+            poller2 = await client.begin_analyze_document(
+                "prebuilt-receipt",
+                AnalyzeDocumentRequest(url_source=self.receipt_url_jpg),
+            )
+            await poller2.wait()
+            assert poller2._polling_method._timeout ==  7  # goes back to client default