[SDK Release] (Python) CQA authoring 2025-05-15-preview #43117

Amichelangelo · 2025-09-24T14:23:17Z

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.

…ering-authoring package (packaging, samples, tests, migration guide) Summary: Packaging & metadata: Added sdk_packaging.toml (python_min=3.9; deps: azure-core, isodate, conditional typing-extensions) Added setup.py aligned with sdk_packaging.toml Preserved/added pyproject.toml (generator structure) Added initial CHANGELOG.md (1.0.0b1 draft) Rewrote README.md to focus exclusively on authoring features Added migration_guide_authoring.md (split rationale & upgrade steps) Added dev_requirements.txt (devtools_testutils, pytest, pytest-asyncio, aiohttp) Samples: Added sync samples: sample_create_and_deploy_project.py, sample_export_import_project.py, sample_update_knowledge_sources.py Added async counterparts under samples/authoring/async_samples/ Added README.md (authoring-only guidance) Tests: Added trimmed conftest.py (reduced env vars + essential sanitizers) Added testcase.py (QuestionAnsweringAuthoringTestCase with playback polling_interval=0) Added helpers.py (AuthoringTestHelper + AuthoringAsyncTestHelper) Added sync tests: test_create_and_deploy_project.py, test_export_import_project.py, test_update_knowledge_sources.py Added async tests: test_create_and_deploy_project_async.py, test_export_import_project_async.py, test_update_knowledge_sources_async.py Consistency & cleanup: Client renamed to QuestionAnsweringAuthoringClient (+ aio variant) Unified project name spelling to IsaacNewton Removed runtime query samples/tests (authoring-only scope) Simplified helper logic and removed unused parameters Deferred assets.json (not required until live resource orchestration is needed) Future follow-ups (not included in this commit): TypeSpec recompile & regeneration validation Optional AAD TokenCredential test coverage Potential runtime package split / publication Live test infra (assets.json) if/when enabled BREAKING CHANGE: Users of authoring functionality must install the new package and replace AuthoringClient with QuestionAnsweringAuthoringClient (import namespace remains in the authoring subtree).

github-actions · 2025-09-24T16:02:19Z

API Change Check

APIView identified API level changes in this PR and created the following API reviews

azure-ai-language-questionanswering-authoring

Amichelangelo · 2025-09-25T15:37:14Z

/azp run python - cognitivelanguage

azure-pipelines · 2025-09-25T15:37:48Z

Azure Pipelines successfully started running 1 pipeline(s).

…azure-sdk-for-python into qiyin/sdk-cqa-python-beta

Copilot

Pull Request Overview

This PR introduces a new Python SDK for Azure AI Language Question Answering Authoring, implementing the 2025-05-15-preview API version. This is a new authoring-only package that splits from the previous combined package to provide focused functionality for project management operations.

Key Changes

New SDK package: azure-ai-language-questionanswering-authoring
Complete client implementation with sync/async support for authoring operations
Comprehensive test coverage for project creation, deployment, export/import, and knowledge source management

Reviewed Changes

Copilot reviewed 57 out of 59 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
tsp-location.yaml	API specification reference configuration
setup.py	Package setup and dependency configuration
_client.py & aio/_client.py	Main client implementations for sync/async operations
models/	Generated model classes and enums for API data structures
tests/	Comprehensive test suite covering all major operations
samples/	Example code demonstrating SDK usage patterns

Copilot · 2025-09-28T09:54:51Z

...e-questionanswering-authoring/azure/ai/language/questionanswering/authoring/models/_enums.py

+from azure.core import CaseInsensitiveEnumMeta
+
+
+class AssestKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):


The enum name 'AssestKind' should be 'AssetKind' (missing 's').

Suggested change

class AssestKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):

class AssetKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):

Typo in the model name. Looks like this needs to be fixed in the spec.

Copilot · 2025-09-28T09:54:51Z

...questionanswering-authoring/azure/ai/language/questionanswering/authoring/models/__init__.py

+)
+
+from ._enums import (  # type: ignore
+    AssestKind,


The import and export of 'AssestKind' should be 'AssetKind' to match the corrected enum name.

Copilot · 2025-09-28T09:54:51Z

...questionanswering-authoring/azure/ai/language/questionanswering/authoring/models/__init__.py

+    "UpdateSourceFromFileOperationRecord",
+    "UpdateSourceRecord",
+    "WordAlterations",
+    "AssestKind",


The import and export of 'AssestKind' should be 'AssetKind' to match the corrected enum name.

sarkar-rajarshi

looking good. few small comments

...stionanswering-authoring/azure/ai/language/questionanswering/authoring/_operations/_patch.py

...cognitivelanguage/azure-ai-language-questionanswering-authoring/migration_guide_authoring.md

...answering-authoring/azure/ai/language/questionanswering/authoring/_operations/_operations.py

sdk/cognitivelanguage/azure-ai-language-questionanswering-authoring/README.md

sarkar-rajarshi · 2025-09-29T20:54:19Z

...nguage-questionanswering-authoring/azure/ai/language/questionanswering/authoring/__init__.py

+from ._patch import patch_sdk as _patch_sdk
+
+__all__ = [
+    "QuestionAnsweringAuthoringClient",


Could we mention to the review board that previously this was called as AuthoringClient

And we want to release this as QuestionAnsweringAuthoringClient. Is that okay?

sarkar-rajarshi · 2025-09-29T20:58:15Z

...cognitivelanguage/azure-ai-language-questionanswering-authoring/migration_guide_authoring.md

+| Previous (Combined) | New Authoring Package |
+|---------------------|-----------------------|
+| Install: `azure-ai-language-questionanswering` | Install: `azure-ai-language-questionanswering-authoring` |
+| Client: `AuthoringClient` | Client: `QuestionAnsweringAuthoringClient` |


Let's make it a point to ask this to the review board

sarkar-rajarshi · 2025-09-29T20:59:01Z

...cognitivelanguage/azure-ai-language-questionanswering-authoring/migration_guide_authoring.md

+
+```bash
+pip uninstall azure-ai-language-questionanswering -y  # if previously installed
+pip install --pre azure-ai-language-questionanswering-authoring


why do we need this --pre?

it's a beta version

...cognitivelanguage/azure-ai-language-questionanswering-authoring/migration_guide_authoring.md

2. import -> begin_import_assets 3. format -> file_format

sdk/cognitivelanguage/azure-ai-language-questionanswering-authoring/CHANGELOG.md

annatisch · 2025-10-29T19:36:28Z

...stionanswering-authoring/azure/ai/language/questionanswering/authoring/_operations/_patch.py

+    """Mixin class for patching methods with backward compatible parameter names."""
+
+    # create_project overloads with 'options' parameter
+    @overload # type: ignore


An overload should not need a #type: ignore - what was the error here?

The ignore was suppressing a mypy [override] error caused by renaming the parameter from 'body' to 'options'

annatisch · 2025-10-29T19:44:32Z

...stionanswering-authoring/azure/ai/language/questionanswering/authoring/_operations/_patch.py

+JSON = MutableMapping[str, Any]
+
+class _QuestionAnsweringAuthoringClientOperationsMixin(_QuestionAnsweringAuthoringClientOperationsMixinGenerated):
+    """Mixin class for patching methods with backward compatible parameter names."""


Please use code gen to generate the correct names - we do not need to use patching for this.

@annatisch about "code gen to generate the correct names", do you mean update the parameters' name in typespecs instead of write overload?
I see the .net project can use tag like [CodeGenMember] to rename, but haven't find the same thing in python.

annatisch · 2025-10-29T19:50:12Z

...e-questionanswering-authoring/azure/ai/language/questionanswering/authoring/models/_enums.py

+from azure.core import CaseInsensitiveEnumMeta
+
+
+class AssestKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):


Typo in the model name. Looks like this needs to be fixed in the spec.

...cognitivelanguage/azure-ai-language-questionanswering-authoring/migration_guide_authoring.md

sdk/cognitivelanguage/azure-ai-language-questionanswering-authoring/pyproject.toml

sdk/cognitivelanguage/azure-ai-language-questionanswering-authoring/setup.py

annatisch · 2025-10-29T20:20:46Z

...answering-authoring/azure/ai/language/questionanswering/authoring/_operations/_operations.py

+        return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)  # type: ignore
+
+    @distributed_trace
+    def get_delete_status(


This API (and the response model) don't need to be public. We use the LROPoller object to be the way people check the operation status.

Hide in patch file, will remove hide this in typespecs in next version

annatisch · 2025-10-29T20:26:01Z

...answering-authoring/azure/ai/language/questionanswering/authoring/_operations/_operations.py

+        return LROPoller[None](self._client, raw_result, get_long_running_output, polling_method)  # type: ignore
+
+    @distributed_trace
+    def get_export_status(


Same comment as above - we should be able to hide the get_[operation]_status APIs

Hide in patch file, will remove hide this in typespecs in next version

add dependency on azure-ai-language-questionanswering

Qi-2077 added 2 commits September 24, 2025 18:22

generated code

ed0994b

github-actions bot added the Cognitive - Language label Sep 24, 2025

Qi-2077 added 2 commits September 24, 2025 23:27

update setup file

eafd591

update import path in test files

e360f73

Qi-2077 added 2 commits September 25, 2025 23:20

update tests, samples, readme

d02b409

migrating test recordings out of the azure-sdk-for-python repository

fcb634e

Qi-2077 added 4 commits September 26, 2025 18:12

update cspell

e4c2f0f

fix host mismatch

862631d

Merge branch 'qiyin/sdk-cqa-python-beta' of https://github.com/Azure/…

3949428

…azure-sdk-for-python into qiyin/sdk-cqa-python-beta

update readme and remove generated code

f482e37

Amichelangelo marked this pull request as ready for review September 28, 2025 09:54

Amichelangelo requested review from benbp, mccoyp, quentinRobinson, scbedd and weshaggard as code owners September 28, 2025 09:54

Copilot AI review requested due to automatic review settings September 28, 2025 09:54

Copilot AI reviewed Sep 28, 2025

View reviewed changes

update sample readme

2661b06

sarkar-rajarshi reviewed Sep 29, 2025

View reviewed changes

Qi-2077 and others added 6 commits October 13, 2025 12:30

1. QuestionAnsweringProjectMetadate -> QuestionAnsweringProject

34b9cab

2. import -> begin_import_assets 3. format -> file_format

rename begin_import_method in samples

ba9bdf6

update

4d7592f

fix comments, get-> list, add overload

afb0270

apiview changes

27f46d1

fix circle import issue

89f1e33

Qi-2077 and others added 3 commits October 29, 2025 10:36

fix broken link

b151b76

add type ignore

b0e9a49

analyze iuuse

2b4f1fc

annatisch reviewed Oct 29, 2025

View reviewed changes

Qi-2077 added 2 commits November 3, 2025 10:38

update get_[operation]_status to private

f691eec

add dependency on azure-ai-language-questionanswering

update

bf0e0ea

		from azure.core import CaseInsensitiveEnumMeta


		class AssestKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):

	class AssestKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):
	class AssetKind(str, Enum, metaclass=CaseInsensitiveEnumMeta):

[SDK Release] (Python) CQA authoring 2025-05-15-preview #43117

Are you sure you want to change the base?

[SDK Release] (Python) CQA authoring 2025-05-15-preview #43117

Conversation

Amichelangelo commented Sep 24, 2025

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Uh oh!

github-actions bot commented Sep 24, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

API Change Check

Uh oh!

Amichelangelo commented Sep 25, 2025

Uh oh!

azure-pipelines bot commented Sep 25, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Key Changes

Reviewed Changes

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 28, 2025

Choose a reason for hiding this comment

Uh oh!

sarkar-rajarshi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Amichelangelo Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

github-actions bot commented Sep 24, 2025 •

edited

Loading

Amichelangelo Oct 31, 2025 •

edited

Loading