[SDK Release] (Python) CQA inference 2025-05-15-preview #42870

Amichelangelo · 2025-09-05T17:27:43Z

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.

sarkar-rajarshi · 2025-09-05T17:52:40Z

/azp run python - cognitivelanguage

azure-pipelines · 2025-09-05T17:53:07Z

Azure Pipelines successfully started running 1 pipeline(s).

sarkar-rajarshi · 2025-09-05T18:09:09Z

After the move to TypeSpec, Authoring and Inference API would be in separate artifacts. There shouldn't be any authoring folder in this package if this being generated from typespec correctly. When generating the code, could you please locally delete the existing folder of azure-ai-language-questionanswering and run the codegen after that

github-actions · 2025-09-09T16:32:08Z

API Change Check

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

azure-ai-language-questionanswering

Amichelangelo · 2025-09-11T10:23:17Z

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

sarkar-rajarshi · 2025-09-15T17:44:53Z

/azp run python - cognitivelanguage

azure-pipelines · 2025-09-15T17:45:26Z

Azure Pipelines successfully started running 1 pipeline(s).

Amichelangelo · 2025-09-18T15:06:08Z

/azp run python - cognitivelanguage

azure-pipelines · 2025-09-18T15:06:43Z

Azure Pipelines successfully started running 1 pipeline(s).

…ytypes score The verifytypes pipeline failed because type completeness for azure-ai-language-questionanswering dropped from 100% (main) to 87.9%. Pyright reported missing / ambiguous types for: QuestionAnsweringClient.question_answering (sync + async clients) QuestionAnsweringOperations.init (sync + async) Derived patch classes were then flagged as having partially unknown bases. Changes: Added explicit return/attribute annotation for question_answering in _client.py and _client.py. Added *args: Any, **kwargs: Any plus explicit internal attribute types in _operations.py and _operations.py. Result: Eliminates Pyright errors about missing annotations and partially unknown base classes. Restores type completeness score to parity with main (expected 100%). No runtime or public API behavior changes; typing-only improvement. Follow-up (optional): Consider templating these annotations in the code generator to avoid future regeneration loss

sarkar-rajarshi

Lets check how we are generating code. The generated client does not look correct

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

sdk/cognitivelanguage/azure-ai-language-questionanswering/assets.json.bak

...nguage/azure-ai-language-questionanswering/azure/ai/language/questionanswering/aio/_patch.py

sdk/cognitivelanguage/azure-ai-language-questionanswering/migration_guide.md

...ests/recordings/test_query_knowledgebase.pyTestQnAKnowledgeBasetest_query_knowledgebase.json

sdk/cognitivelanguage/azure-ai-language-questionanswering/tsp-location.yaml

...zure-ai-language-questionanswering/samples/async_samples/sample_query_knowledgebase_async.py

sdk/cognitivelanguage/azure-ai-language-questionanswering/tsp-location.yaml

Amichelangelo · 2025-10-27T07:55:12Z

/azp run python - cognitivelanguage

azure-pipelines · 2025-10-27T07:55:40Z

Azure Pipelines successfully started running 1 pipeline(s).

…location.yaml Co-authored-by: Rajarshi Sarkar <[email protected]>

annatisch · 2025-10-27T22:31:13Z

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

+* Authoring functionality (project creation, knowledge source management, deployment operations) has been removed from this package and moved to a separate dedicated authoring package / namespace. All references to `AuthoringClient`, and related authoring operations have been eliminated from the runtime client distribution.
+* Dropped support for Python versions earlier than 3.9 (aligns with Azure SDK Python support policy going forward).
+* Model base class change: all public model types now inherit from `MutableMapping[str, Any]` (dict-like) instead of the previous `Model` base class. As a result they now support standard mutable mapping behavior (key iteration, item assignment, etc.) and any code depending on methods/properties inherited from the old base class should be reviewed/updated.



Can we add that default_language has been removed, and give a link to how to customers can change the service default instead?

Is there an actual guide/documentation that we can link to about how to configure this at the project level? Or in the portal?

I just check the service side, the default_language is hardcoded as "en",can not be configured at the project level, remove related line in changelog

.vscode/cspell.json

annatisch · 2025-10-27T22:42:03Z

...age/azure-ai-language-questionanswering/azure/ai/language/questionanswering/models/_patch.py

-        super().__init__(
-            question=question, text_documents=cast(List[TextDocument], text_documents), language=language, **kwargs
-        )
-        self.string_index_type = "UnicodeCodePoint"


Is there a reason we're no longer providing this default?

I remember it is not needed, but I'm not sure now. Add this back

Let's make a note to confirm this before GA.

this is useful, add it back

annatisch · 2025-10-27T22:42:31Z

...age/azure-ai-language-questionanswering/azure/ai/language/questionanswering/models/_patch.py

+class MetadataFilter(_GeneratedMetadataFilter):
+    """Backward compatible MetadataFilter supporting legacy tuple/dict inputs."""
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:


We're missing the overloads for this model.
I'm also not sure if all the documentation will be inherited - so we should check how it renders.

add the overloads and update the documentation

I think we're still missing the base overload that just supports a raw mapping? (You can find an example of this on all the generated models) - something like:

@overload def __init__(self, mapping: Mapping[str, Any]) -> None: ...

delete this patch file, it's false added

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

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

...itivelanguage/azure-ai-language-questionanswering/samples/async_samples/sample_chat_async.py

Copilot · 2025-11-04T12:07:46Z

@Amichelangelo I've opened a new pull request, #43778, to work on those changes. Once the pull request is ready, I'll request review from you.

Copilot · 2025-11-04T12:07:55Z

@Amichelangelo I've opened a new pull request, #43779, to work on those changes. Once the pull request is ready, I'll request review from you.

…into qiyin/cqa-sdk-py

annatisch · 2025-11-04T19:04:48Z

...age/azure-ai-language-questionanswering/azure/ai/language/questionanswering/models/_patch.py

+from __future__ import annotations
+
+from collections.abc import Iterable, Mapping, MutableMapping
+from typing import Any, Optional, Sequence, Tuple, Union, Mapping as TypingMapping, List, overload


You don't need separate imports of Mapping from typing vs collections.abc - they are aliases for the same object:
https://docs.python.org/3/library/typing.html#typing.Mapping

So you only need to import once from collections.abc

annatisch · 2025-11-04T19:06:55Z

...age/azure-ai-language-questionanswering/azure/ai/language/questionanswering/models/_patch.py

-     example, use "en" for English; "es" for Spanish etc. If not set, use "en" for English as
-     default.
-    :vartype language: str
+        metadata: Sequence[Union[Tuple[str, str], MetadataRecord, TypingMapping[str, str]]],


I wouldn't support a union sequence like this - I don't think it's too much to ask that users provide a homogenous list. Keeps things a bit more simple.

you're right, fix it

annatisch · 2025-11-04T19:08:17Z

...age/azure-ai-language-questionanswering/azure/ai/language/questionanswering/models/_patch.py

+class MetadataFilter(_GeneratedMetadataFilter):
+    """Backward compatible MetadataFilter supporting legacy tuple/dict inputs."""
+
+    def __init__(self, *args: Any, **kwargs: Any) -> None:


I think we're still missing the base overload that just supports a raw mapping? (You can find an example of this on all the generated models) - something like:

@overload def __init__(self, mapping: Mapping[str, Any]) -> None: ...

annatisch · 2025-11-04T19:09:07Z

...age/azure-ai-language-questionanswering/azure/ai/language/questionanswering/models/_patch.py

-        super().__init__(
-            question=question, text_documents=cast(List[TextDocument], text_documents), language=language, **kwargs
-        )
-        self.string_index_type = "UnicodeCodePoint"


Let's make a note to confirm this before GA.

annatisch · 2025-11-04T19:14:33Z

...age/azure-ai-language-questionanswering/azure/ai/language/questionanswering/models/_patch.py

+        self.string_index_type = "UnicodeCodePoint"
+        # _attribute_map may not exist if underlying generator changed; guard accordingly.
+        try:  # pragma: no cover - defensive
+            self._attribute_map.update({"string_index_type": {"key": "stringIndexType", "type": "str"}})


Rather than do this, shouldn't we do something like:

def __init__( self, *, question: str, text_documents: Sequence[Union[str, TextDocument]], language: Optional[str] = None, **kwargs: Any, ) -> None: string_index_type = kwargs.pop("string_index_type", "UnicodeCodePoint") super().__init__(question=question, text_documents=normalized, language=language, string_index_type=string_index_type)

from the changelog, the string_index_type is hardcoded to Utf16CodeUnit

we don't need to use kwargs.pop("string_index_type", "UnicodeCodePoint"), it's designed to use hardcode UnicodeCodePoint

Amichelangelo · 2025-11-05T14:34:08Z

/azp run python - cognitivelanguage

azure-pipelines · 2025-11-05T14:34:37Z

Azure Pipelines successfully started running 1 pipeline(s).

Amichelangelo · 2025-11-06T03:49:14Z

/azp run python - cognitivelanguage

azure-pipelines · 2025-11-06T03:49:40Z

Azure Pipelines successfully started running 1 pipeline(s).

…-for-python into qiyin/cqa-sdk-py

Qi-2077 added 2 commits September 5, 2025 10:07

init and update by tsp generate tool

4b174eb

update patch files to support old version, and fix tests and samples

09000ab

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

Qi-2077 added 4 commits September 8, 2025 23:32

delete old question anwsering folder

bd85eca

init

bbeaed5

update patch files to support old version, and fix tests and samples

0943c27

update tests

4ed473b

Amichelangelo changed the title ~~(Python) CQA inference 2025-05-15-preview~~ [SDK Release] (Python) CQA inference 2025-05-15-preview Sep 10, 2025

update tests&recordings

06e9927

Qi-2077 added 9 commits September 11, 2025 22:39

fix spell issue

635d569

fix the Azure Pipelines / python - pullrequest

6a282b1

fix Unexpected indentation issue for sphinx-build

81105a7

fix the cspell issue

667b537

fix verify whl stage

f8762d2

fix Incompatible types in assignment

fd396d1

fix pylint

649ddb8

fix Inline strong start-string without end-string.

f8b5985

fix overload issue

dd4c736

update operation patch and re record

264fcef

sarkar-rajarshi reviewed Sep 18, 2025

View reviewed changes

sarkar-rajarshi reviewed Oct 9, 2025

View reviewed changes

sdk/cognitivelanguage/azure-ai-language-questionanswering/tsp-location.yaml Outdated Show resolved Hide resolved

Qi-2077 added 2 commits October 14, 2025 18:16

update change log

c1b1457

update

a4b2415

Amichelangelo and others added 2 commits October 27, 2025 16:58

Update sdk/cognitivelanguage/azure-ai-language-questionanswering/tsp-…

8b0f735

…location.yaml Co-authored-by: Rajarshi Sarkar <[email protected]>

fix analyze issue

62bdfd4

annatisch reviewed Oct 28, 2025

View reviewed changes

Qi-2077 added 2 commits November 3, 2025 21:15

update

5633487

about default_language

d9470b9

This was referenced Nov 4, 2025

Fix docstring typo: 'quering' → 'querying' in PrebuiltQueryMatchingPolicy #43778

Draft

Fix typo in QueryPreferences docstrings: 'controling' → 'controlling' #43779

Draft

Qi-2077 added 2 commits November 4, 2025 21:30

regenerate

4e62b2b

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-python …

2821346

…into qiyin/cqa-sdk-py

annatisch reviewed Nov 4, 2025

View reviewed changes

Qi-2077 added 2 commits November 5, 2025 16:26

update

80031e2

update

00d9ce8

Amichelangelo enabled auto-merge (squash) November 5, 2025 12:40

Qi-2077 added 2 commits November 5, 2025 23:53

update the test file

66f01a0

update

ac2dfda

Qi-2077 added 4 commits November 6, 2025 13:39

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

8060acd

…-for-python into qiyin/cqa-sdk-py

fix broken link

623b410

trim Trailing whitespace

5218755

add back string_index_type and add overload for MetadataFilter

17b21be

[SDK Release] (Python) CQA inference 2025-05-15-preview #42870

Are you sure you want to change the base?

[SDK Release] (Python) CQA inference 2025-05-15-preview #42870

Uh oh!

Conversation

Amichelangelo commented Sep 5, 2025

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Uh oh!

sarkar-rajarshi commented Sep 5, 2025

Uh oh!

azure-pipelines bot commented Sep 5, 2025

Uh oh!

sarkar-rajarshi commented Sep 5, 2025

Uh oh!

github-actions bot commented Sep 9, 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 11, 2025

Uh oh!

sarkar-rajarshi commented Sep 15, 2025

Uh oh!

azure-pipelines bot commented Sep 15, 2025

Uh oh!

Amichelangelo commented Sep 18, 2025

Uh oh!

azure-pipelines bot commented Sep 18, 2025

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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Amichelangelo commented Oct 27, 2025

Uh oh!

azure-pipelines bot commented Oct 27, 2025

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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

annatisch Nov 4, 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!

Amichelangelo Nov 5, 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!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Sep 9, 2025 •

edited

Loading

annatisch Nov 4, 2025 •

edited

Loading

Amichelangelo Nov 5, 2025 •

edited

Loading

annatisch Nov 4, 2025 •

edited

Loading

Amichelangelo Nov 5, 2025 •

edited

Loading