Skip to content

[Document] Py sdk 2026-05-15-preview#47984

Open
amberchen-86 wants to merge 39 commits into
Azure:mainfrom
amberchen-86:v-amber/document-pysdk-2026-05-15-preview-continued
Open

[Document] Py sdk 2026-05-15-preview#47984
amberchen-86 wants to merge 39 commits into
Azure:mainfrom
amberchen-86:v-amber/document-pysdk-2026-05-15-preview-continued

Conversation

@amberchen-86

Copy link
Copy Markdown
Member

Description

Please add an informative description that covers that changes made by the pull request and link all relevant issues.

If an SDK is being regenerated based on a new API spec, a link to the pull request containing these API spec changes should be included above.

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes]
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

Copilot AI review requested due to automatic review settings July 9, 2026 21:30
@github-actions github-actions Bot added Cognitive - Language Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization. labels Jul 9, 2026
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

Thank you for your contribution @amberchen-86! We will review the pull request and get back to you soon.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Introduces the initial preview Azure AI Language Documents SDK for API version 2026-05-15-preview.

Changes:

  • Adds synchronous and asynchronous clients, models, and custom LRO polling.
  • Adds samples, recorded tests, documentation, and packaging metadata.
  • Registers the package in Cognitive Language CI.

Reviewed changes

Copilot reviewed 51 out of 52 changed files in this pull request and generated 7 comments.

Show a summary per file
File Description
sdk/cognitivelanguage/ci.yml Registers the package in CI.
azure-ai-language-documents/tsp-location.yaml Defines TypeSpec provenance.
azure-ai-language-documents/README.md Adds package documentation.
azure-ai-language-documents/CHANGELOG.md Records the initial preview.
azure-ai-language-documents/pyproject.toml Configures package metadata and dependencies.
azure-ai-language-documents/MANIFEST.in Configures source distribution contents.
azure-ai-language-documents/LICENSE Adds the MIT license.
azure-ai-language-documents/dev_requirements.txt Adds development dependencies.
azure-ai-language-documents/cspell.yaml Configures spell checking.
azure-ai-language-documents/assets.json Configures test assets.
azure-ai-language-documents/apiview-properties.json Maps cross-language API definitions.
azure-ai-language-documents/_metadata.json Records the service API version.
azure-ai-language-documents/tests/conftest.py Configures recording sanitizers.
azure-ai-language-documents/tests/testpreparer.py Adds synchronous test preparation.
azure-ai-language-documents/tests/testpreparer_async.py Adds asynchronous client preparation.
azure-ai-language-documents/tests/test_analyze_documents.py Tests synchronous operations.
azure-ai-language-documents/tests/test_analyze_documents_async.py Tests asynchronous operations.
azure-ai-language-documents/samples/sample_submit_job.py Demonstrates job submission.
azure-ai-language-documents/samples/sample_get_job_state.py Demonstrates status retrieval.
azure-ai-language-documents/samples/sample_cancel_job.py Demonstrates cancellation.
azure-ai-language-documents/samples/async_samples/sample_submit_job_async.py Adds asynchronous submission sample.
azure-ai-language-documents/samples/async_samples/sample_get_job_state_async.py Adds asynchronous status sample.
azure-ai-language-documents/samples/async_samples/sample_cancel_job_async.py Adds asynchronous cancellation sample.
azure-ai-language-documents/azure/__init__.py Configures the Azure namespace.
azure-ai-language-documents/azure/ai/__init__.py Configures the AI namespace.
azure-ai-language-documents/azure/ai/language/__init__.py Configures the Language namespace.
documents/__init__.py Exposes the synchronous client.
documents/_client.py Implements the synchronous client.
documents/_configuration.py Configures synchronous policies.
documents/_version.py Defines package version 1.0.0b1.
documents/_patch.py Provides package customization hooks.
documents/_lro.py Customizes synchronous LRO completion.
documents/py.typed Marks the package as typed.
documents/_operations/__init__.py Exposes synchronous operations.
documents/_operations/_operations.py Implements generated synchronous operations.
documents/_operations/_patch.py Customizes synchronous operations.
documents/aio/__init__.py Exposes the asynchronous client.
documents/aio/_client.py Implements the asynchronous client.
documents/aio/_configuration.py Configures asynchronous policies.
documents/aio/_patch.py Provides async customization hooks.
documents/aio/_lro.py Customizes asynchronous LRO completion.
documents/aio/_operations/__init__.py Exposes asynchronous operations.
documents/aio/_operations/_operations.py Implements generated asynchronous operations.
documents/aio/_operations/_patch.py Customizes asynchronous operations.
documents/models/__init__.py Exposes public models and enums.
documents/models/_models.py Defines generated service models.
documents/models/_enums.py Defines generated service enums.
documents/models/_patch.py Provides model customization hooks.
documents/_utils/__init__.py Initializes internal utilities.
documents/_utils/utils.py Defines internal client typing utilities.
documents/_utils/model_base.py Implements generated model behavior.
documents/_utils/serialization.py Implements generated serialization.

Comment thread sdk/cognitivelanguage/azure-ai-language-documents/tsp-location.yaml Outdated
Comment thread sdk/cognitivelanguage/azure-ai-language-documents/tests/test_analyze_documents.py Outdated
Comment thread sdk/cognitivelanguage/azure-ai-language-documents/README.md Outdated
Comment thread sdk/cognitivelanguage/azure-ai-language-documents/README.md
Comment thread sdk/cognitivelanguage/azure-ai-language-documents/README.md
@amberchen-86 amberchen-86 marked this pull request as draft July 10, 2026 17:18
@amberchen-86

Copy link
Copy Markdown
Member Author

@microsoft-github-policy-service agree company="Microsoft"

@amberchen-86

Copy link
Copy Markdown
Member Author

As seen in the error logs, all errors related to Generate Docs, MyPy, VerifyTypes, Pylint, Update Snippets, and test failures are caused by other packages under cognitivelanguage and are unrelated to the azure-ai-language-documents package. Therefore, these failures are not related to the changes introduced in this PR.

@amberchen-86 amberchen-86 marked this pull request as ready for review July 11, 2026 18:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Cognitive - Language Community Contribution Community members are working on the issue customer-reported Issues that are reported by GitHub users external to the Azure organization.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants