Skip to content

Conversation

@Amichelangelo
Copy link
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.

…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
Copy link

github-actions bot commented Sep 24, 2025

API Change Check

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

azure-ai-language-questionanswering-authoring

@Amichelangelo
Copy link
Member Author

/azp run python - cognitivelanguage

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Amichelangelo Amichelangelo marked this pull request as ready for review September 28, 2025 09:54
Copilot AI review requested due to automatic review settings September 28, 2025 09:54
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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

Copy link
Member

@sarkar-rajarshi sarkar-rajarshi left a comment

Choose a reason for hiding this comment

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

looking good. few small comments

@Amichelangelo
Copy link
Member Author

/azp run python - cognitivelanguage

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Amichelangelo
Copy link
Member Author

/azp run python - cognitivelanguage

@azure-pipelines
Copy link

Azure Pipelines will not run the associated pipelines, because the pull request was updated after the run command was issued. Review the pull request again and issue a new run command.

@Amichelangelo
Copy link
Member Author

/azp run python - cognitivelanguage

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@sarkar-rajarshi
Copy link
Member

/azp run python - cognitivelanguage

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@Amichelangelo Amichelangelo merged commit acbf01f into main Nov 14, 2025
23 checks passed
@Amichelangelo Amichelangelo deleted the qiyin/sdk-cqa-python-beta branch November 14, 2025 16:57
msyyc pushed a commit that referenced this pull request Nov 25, 2025
* generated code

* feat(authoring): initialize standalone azure-ai-language-questionanswering-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).

* update setup file

* update import path in test files

* update tests, samples, readme

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

* update cspell

* fix host mismatch

* update readme and remove generated code

* update sample readme

* 1. QuestionAnsweringProjectMetadate -> QuestionAnsweringProject
2. import -> begin_import_assets
3. format -> file_format

* rename begin_import_method in samples

* update

* fix comments, get-> list, add overload

* apiview changes

* fix circle import issue

* fix broken link

* add type ignore

* analyze iuuse

* update get_[operation]_status to private
add dependency on azure-ai-language-questionanswering

* update

* update

* update assest

* update the dependencies

* fix cspell

* add azure-ai-language-questionanswering to shared_requirements.txt

* move down the pylint tag

* move down the pylint tag

---------

Co-authored-by: Qi Yin <v-qiyin1@microsoft.com>
Co-authored-by: Rajarshi Sarkar <73562869+sarkar-rajarshi@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants