Skip to content

azure-search-documents 12.1.0b1 no longer exports KnowledgeRetrievalOutputMode from azure.search.documents.indexes.models #47871

Description

@pamelafox

Package Name
azure-search-documents

Package Version
12.1.0b1

Operating System
macOS

Python Version
3.14

Describe the bug
KnowledgeRetrievalOutputMode is no longer publicly importable from azure.search.documents.indexes.models in 12.1.0b1.

Earlier preview builds exposed this symbol publicly, and KnowledgeBase.output_mode still exists in the preview SDK/docs. In 12.1.0b1, the import fails, so callers are forced to use raw wire strings such as "extractiveData".

To Reproduce

  1. Install azure-search-documents==12.1.0b1
  2. Run:
from azure.search.documents.indexes.models import KnowledgeRetrievalOutputMode
print(KnowledgeRetrievalOutputMode.EXTRACTIVE_DATA)

Expected behavior
KnowledgeRetrievalOutputMode should still be publicly exported from azure.search.documents.indexes.models.

Actual behavior
The import fails.

Screenshots
N/A

Additional context
KnowledgeBase is still available publicly, and output_mode is still part of the model contract. The current workaround is:

from azure.search.documents.indexes.models import KnowledgeBase

kb = KnowledgeBase(
    name="x",
    knowledge_sources=[],
    output_mode="extractiveData",
)

That works, but it loses discoverability and type safety compared to the earlier enum-based public API.

Metadata

Metadata

Assignees

Labels

SearchService AttentionWorkflow: This issue is responsible by Azure service team.

Type

No type

Fields

No fields configured for issues without a type.

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions