[Search] Include Issue Cleanup starting 2026-08-01-preview release

[efrainretana]

Description

Address multiple issues -

• SearchFieldDataType.Collection not visible to static type checkers (requires # type: ignore at every call site) #47929
• Significant slowdown in SearchClient.upload_documents(...) for large payloads #46860

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.

[azure-pipelines]

Azure Pipelines:
Successfully started running 1 pipeline(s).
9 pipeline(s) were filtered out due to trigger conditions.
There may be pipelines that require an authorized user to comment /azp run to run.

[Copilot]

Pull request overview

Fixes upload performance and static typing issues in azure-search-documents.

Changes:

• Defers document serialization during batch construction.
• Exposes SearchFieldDataType.Collection to type checkers.
• Adds regression tests, performance benchmarks, samples, and release notes.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
CHANGELOG.md	Documents both fixes.
models/_patch.py	Defers action-value serialization.
indexes/models/_patch.py	Adds the typed Collection API.
tests/test_index_documents_batch.py	Tests deferred vector serialization.
tests/perfstress_tests/upload_documents.py	Adds upload serialization benchmark.
tests/perfstress_tests/compare_upload_documents.py	Compares package performance.
tests/perfstress_tests/README.md	Documents benchmarks.
samples/sample_query_vector.py	Removes obsolete type suppression.
samples/sample_query_vector_async.py	Removes obsolete type suppression.
samples/sample_knowledge_source_crud.py	Reformats analyzer collection.
samples/sample_knowledge_source_crud_async.py	Reformats analyzer collection.
samples/sample_knowledge_base_crud.py	Adjusts formatting.
samples/sample_knowledge_base_crud_async.py	Adjusts formatting.

---

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

[github-actions]

[Pilot] PR Pipeline Failure Analysis

What failed

Build: 6748942 — azure-sdk/public

Two checks failed for the azure-search-documents package, both caused by changes to azure/search/documents/indexes/models/_patch.py:

1. Pylint — FAIL (exit code 16)

• Line 177 — C4747(enum-must-inherit-case-insensitive-enum-meta): SearchFieldDataType must inherit from CaseInsensitiveEnumMeta
• Lines 191–199 — C4746(enum-must-be-uppercase) (9 violations): SearchFieldDataType enum values must use uppercase naming

2. MyPy — FAIL

• Lines 210–218 — Cannot assign to final attribute [misc] for each of: String, Int32, Int64, Single, Double, Boolean, DateTimeOffset, GeographyPoint, ComplexType
• The existing # type: ignore comments do not cover the misc error code (need # type: ignore[misc])

Relevant pipeline output

[azure-search-documents :: pylint] azure/search/documents/indexes/models/_patch.py:177: [C4747(enum-must-inherit-case-insensitive-enum-meta), SearchFieldDataType] The enum must inherit from CaseInsensitiveEnumMeta. See details: (azure.github.io/redacted)
[azure-search-documents :: pylint] azure/search/documents/indexes/models/_patch.py:191: [C4746(enum-must-be-uppercase), SearchFieldDataType] The enum must use uppercase naming.
...
[azure-search-documents :: pylint] azure/search/documents/indexes/models/_patch.py:199: [C4746(enum-must-be-uppercase), SearchFieldDataType] The enum must use uppercase naming.
[azure-search-documents :: pylint] Your code has been rated at 10.00/10
[ERROR] azure-search-documents main package exited with linting error 16.
PACKAGE                                               CHECK   STATUS    DURATION(s)
azure-search-documents                                pylint  FAIL(16)  68.68

[azure-search-documents :: mypy] azure/search/documents/indexes/models/_patch.py:210: error: Cannot assign to final attribute "String"  [misc]
[azure-search-documents :: mypy] azure/search/documents/indexes/models/_patch.py:210: note: Error code "misc" not covered by "type: ignore" comment
[azure-search-documents :: mypy] azure/search/documents/indexes/models/_patch.py:211: error: Cannot assign to final attribute "Int32"  [misc]
...
[azure-search-documents :: mypy] azure/search/documents/indexes/models/_patch.py:218: error: Cannot assign to final attribute "ComplexType"  [misc]

Recommended next steps

• In sdk/search/azure-search-documents/azure/search/documents/indexes/models/_patch.py:
  • Make SearchFieldDataType inherit from CaseInsensitiveEnumMeta (fixes C4747)
  • Rename enum member values to uppercase (fixes C4746 on lines 191–199)
  • Change # type: ignore comments on lines 210–218 to # type: ignore[misc] (fixes mypy)
• See https://aka.ms/ci-fix

Automated fix: Fix found, view and apply fix

Generated by Pipeline Analysis Next Steps · 62.4 AIC · ⌖ 9.16 AIC · ⊞ 6K · ◷

[Copilot]

Pull request overview

Copilot reviewed 17 out of 22 changed files in this pull request and generated no new comments.