| 79 |
azure.search.documents.SearchClient.autocomplete |
def autocomplete( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 97 |
azure.search.documents.SearchClient.delete_documents |
def delete_documents( |
Remove the numerical value assigned to the dedent entry in your docstring and leave it empty to comply with the [do-not-hardcode-dedent] guideline. |
| 122 |
azure.search.documents.SearchClient.merge_documents |
def merge_documents( |
Leave the dedent entry in the docstring empty to avoid hardcoding numerical values. |
| 128 |
azure.search.documents.SearchClient.merge_or_upload_documents |
def merge_or_upload_documents( |
Leave the dedent entry in the docstring empty; do not assign a numerical value to it. |
| 135 |
azure.search.documents.SearchClient.search |
def search( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 181 |
azure.search.documents.SearchClient.suggest |
def suggest( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 198 |
azure.search.documents.SearchClient.upload_documents |
def upload_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 233 |
azure.search.documents.SearchIndexingBufferedSender.delete_documents |
def delete_documents( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it to avoid hardcoding. |
| 254 |
azure.search.documents.SearchIndexingBufferedSender.merge_documents |
def merge_documents( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 261 |
azure.search.documents.SearchIndexingBufferedSender.merge_or_upload_documents |
def merge_or_upload_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it. |
| 268 |
azure.search.documents.SearchIndexingBufferedSender.upload_documents |
def upload_documents( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it to avoid hardcoding. |
| 329 |
azure.search.documents.aio.SearchClient.autocomplete:async |
async def autocomplete( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 347 |
azure.search.documents.aio.SearchClient.delete_documents:async |
async def delete_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 372 |
azure.search.documents.aio.SearchClient.merge_documents:async |
async def merge_documents( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it to avoid hardcoding. |
| 378 |
azure.search.documents.aio.SearchClient.merge_or_upload_documents:async |
async def merge_or_upload_documents( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it since hardcoding is discouraged. |
| 385 |
azure.search.documents.aio.SearchClient.search:async |
async def search( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 431 |
azure.search.documents.aio.SearchClient.suggest:async |
async def suggest( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 448 |
azure.search.documents.aio.SearchClient.upload_documents:async |
async def upload_documents( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it to avoid hardcoding. |
| 483 |
azure.search.documents.aio.SearchIndexingBufferedSender.delete_documents:async |
async def delete_documents( |
Leave the dedent entry in your docstring empty; do not assign a numerical value to it to avoid hardcoding. |
| 504 |
azure.search.documents.aio.SearchIndexingBufferedSender.merge_documents:async |
async def merge_documents( |
Do not assign a numerical value to the dedent entry in your docstring; leave it empty to avoid hardcoding. |
| 511 |
azure.search.documents.aio.SearchIndexingBufferedSender.merge_or_upload_documents:async |
async def merge_or_upload_documents( |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it, to comply with guidelines. |
| 518 |
azure.search.documents.aio.SearchIndexingBufferedSender.upload_documents:async |
async def upload_documents( |
Leave the dedent entry in your docstring empty to avoid hardcoding a numerical value. |
| 1051 |
azure.search.documents.indexes.SearchIndexerClient.get_indexer_names |
def get_indexer_names(self, **kwargs: Any) -> Sequence[str]: ... |
Leave the dedent entry in the docstring empty; do not assign a numerical value to it since hardcoding is discouraged. |
| 1635 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexer_names:async |
async def get_indexer_names(self, **kwargs) -> Sequence[str]: ... |
Leave the dedent entry in your docstring empty and do not assign a numerical value to it to avoid hardcoding. |
| 65 |
azure.search.documents.SearchClient |
class azure.search.documents.SearchClient(ClientMixinABC[PipelineClient[HttpRequest, HttpResponse], SearchClientConfiguration]): implements ContextManager |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 104 |
azure.search.documents.SearchClient.get_document |
def get_document( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 315 |
azure.search.documents.aio.SearchClient |
class azure.search.documents.aio.SearchClient(ClientMixinABC[AsyncPipelineClient[HttpRequest, AsyncHttpResponse], SearchClientConfiguration]): implements AsyncContextManager |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 354 |
azure.search.documents.aio.SearchClient.get_document:async |
async def get_document( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 540 |
azure.search.documents.indexes.SearchIndexClient.analyze_text |
def analyze_text( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 658 |
azure.search.documents.indexes.SearchIndexClient.create_or_update_alias |
def create_or_update_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 667 |
azure.search.documents.indexes.SearchIndexClient.create_or_update_index |
def create_or_update_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 731 |
azure.search.documents.indexes.SearchIndexClient.delete_alias |
def delete_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 740 |
azure.search.documents.indexes.SearchIndexClient.delete_index |
def delete_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 767 |
azure.search.documents.indexes.SearchIndexClient.delete_synonym_map |
def delete_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 783 |
azure.search.documents.indexes.SearchIndexClient.get_index |
def get_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 827 |
azure.search.documents.indexes.SearchIndexClient.get_synonym_map |
def get_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 837 |
azure.search.documents.indexes.SearchIndexClient.get_synonym_maps |
def get_synonym_maps( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 999 |
azure.search.documents.indexes.SearchIndexerClient.delete_data_source_connection |
def delete_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1008 |
azure.search.documents.indexes.SearchIndexerClient.delete_indexer |
def delete_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1026 |
azure.search.documents.indexes.SearchIndexerClient.get_data_source_connection |
def get_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1036 |
azure.search.documents.indexes.SearchIndexerClient.get_data_source_connections |
def get_data_source_connections( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1044 |
azure.search.documents.indexes.SearchIndexerClient.get_indexer |
def get_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1054 |
azure.search.documents.indexes.SearchIndexerClient.get_indexer_status |
def get_indexer_status( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1061 |
azure.search.documents.indexes.SearchIndexerClient.get_indexers |
def get_indexers( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1087 |
azure.search.documents.indexes.SearchIndexerClient.reset_indexer |
def reset_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1094 |
azure.search.documents.indexes.SearchIndexerClient.run_indexer |
def run_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1124 |
azure.search.documents.indexes.aio.SearchIndexClient.analyze_text:async |
async def analyze_text( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1242 |
azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_alias:async |
async def create_or_update_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1251 |
azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_index:async |
async def create_or_update_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1315 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_alias:async |
async def delete_alias( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1324 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_index:async |
async def delete_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1351 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_synonym_map:async |
async def delete_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1367 |
azure.search.documents.indexes.aio.SearchIndexClient.get_index:async |
async def get_index( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1411 |
azure.search.documents.indexes.aio.SearchIndexClient.get_synonym_map:async |
async def get_synonym_map( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1421 |
azure.search.documents.indexes.aio.SearchIndexClient.get_synonym_maps:async |
async def get_synonym_maps( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1583 |
azure.search.documents.indexes.aio.SearchIndexerClient.delete_data_source_connection:async |
async def delete_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1592 |
azure.search.documents.indexes.aio.SearchIndexerClient.delete_indexer:async |
async def delete_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1610 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_data_source_connection:async |
async def get_data_source_connection( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1620 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_data_source_connections:async |
async def get_data_source_connections( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1628 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexer:async |
async def get_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1638 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexer_status:async |
async def get_indexer_status( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1645 |
azure.search.documents.indexes.aio.SearchIndexerClient.get_indexers:async |
async def get_indexers( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1671 |
azure.search.documents.indexes.aio.SearchIndexerClient.reset_indexer:async |
async def reset_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 1678 |
azure.search.documents.indexes.aio.SearchIndexerClient.run_indexer:async |
async def run_indexer( |
Do not hardcode dedent value in docstring. Leave the dedent entry in your docstring empty, do not assign a numerical value to it. [do-not-hardcode-dedent] |
| 662 |
azure.search.documents.indexes.SearchIndexClient.create_or_update_alias.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should also expose an etag keyword-only parameter. Suggestion : match_condition: MatchConditions = MatchConditions.Unconditionally, etag: Optional[str] = None, Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 681 |
azure.search.documents.indexes.SearchIndexClient.create_or_update_knowledge_base.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should also expose an etag keyword-only parameter. Suggestion : match_condition: MatchConditions = MatchConditions.Unconditionally, etag: Optional[str] = None, Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 690 |
azure.search.documents.indexes.SearchIndexClient.create_or_update_knowledge_source.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should also expose an etag keyword-only parameter. Suggestion : match_condition: MatchConditions = MatchConditions.Unconditionally, etag: Optional[str] = None, Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 735 |
azure.search.documents.indexes.SearchIndexClient.delete_alias.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 753 |
azure.search.documents.indexes.SearchIndexClient.delete_knowledge_base.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 762 |
azure.search.documents.indexes.SearchIndexClient.delete_knowledge_source.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 1246 |
azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_alias:async.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 1265 |
azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_knowledge_base:async.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 1274 |
azure.search.documents.indexes.aio.SearchIndexClient.create_or_update_knowledge_source:async.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 1319 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_alias:async.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 1337 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_knowledge_base:async.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 1346 |
azure.search.documents.indexes.aio.SearchIndexClient.delete_knowledge_source:async.param(match_condition) |
match_condition: MatchConditions = MatchConditions.Unconditionally, |
Methods that support conditional requests should expose an explicit etag keyword-only parameter. Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etag |
| 1730 |
azure.search.documents.indexes.models.SimpleField.param(type) |
type: Union[str, SearchFieldDataType], |
Change the type annotation to 'type: Union[str, SearchFieldDataType]' to prevent exposing underscored internal types and maintain implementation details within the API. |
| 2057 |
azure.search.documents.indexes.models.AzureOpenAIModelName.GPT54_MINI |
GPT54_MINI = "gpt-5.4-mini" |
Compressing the dotted version into 54 is harder to read and can be misread as a different model version. Suggestion : GPT_5_4_MINI = "gpt-5.4-mini" |
| 2058 |
azure.search.documents.indexes.models.AzureOpenAIModelName.GPT54_NANO |
GPT54_NANO = "gpt-5.4-nano" |
Compressing the dotted version into 54 is harder to read and can be misread as a different model version. Suggestion : GPT_5_4_NANO = "gpt-5.4-nano" |
| 2511 |
azure.search.documents.indexes.models.CommonGramTokenFilter.__init___1.param(use_query_mode) |
use_query_mode: Optional[bool] = ... |
Change use_query_mode to bool = False for clarity and mention in the changelog. |
| 2920 |
azure.search.documents.indexes.models.DictionaryDecompounderTokenFilter.__init___1.param(only_longest_match) |
only_longest_match: Optional[bool] = ..., |
Use a concrete boolean default for 'only_longest_match' as False for clarity and ease of discovery. |
| 4157 |
azure.search.documents.indexes.models.KnowledgeBaseModelKind.AZURE_OPEN_AI |
AZURE_OPEN_AI = "azureOpenAI" |
Match the product name in the enum member. Splitting OpenAI into two words makes the constant harder to predict. Suggestion : AZURE_OPENAI = "azureOpenAI" |
| 4272 |
azure.search.documents.indexes.models.LengthTokenFilter.__init___1.param(max_length) |
max_length: Optional[int] = ..., |
A maximum token length is not meaningfully optional. Keeping a concrete default removes an unnecessary None state and makes the common case simpler. Suggestion : max_length: int = 300, |
| 6417 |
azure.search.documents.indexes.models.SearchResourceEncryptionKey.getattr |
def getattr(self, name: str) -> Any: ... |
Implement def __getattr__(self, name: str) -> object: ... to avoid hiding misspellings and strengthen static analysis. |
| 7185 |
azure.search.documents.indexes.models.SynonymTokenFilter.__init___1.param(ignore_case) |
ignore_case: Optional[bool] = ..., |
This should stay a regular boolean with an explicit default rather than introducing an extra null state. Suggestion : ignore_case: bool = False, |
| 8035 |
azure.search.documents.knowledgebases.models.AzureBlobKnowledgeSourceParams |
class azure.search.documents.knowledgebases.models.AzureBlobKnowledgeSourceParams(MutableMapping[str, Any]): |
Using a shortened suffix here is inconsistent with nearby model names and makes the surface harder to scan. Suggestion : class azure.search.documents.knowledgebases.models.AzureBlobKnowledgeSourceParameters(MutableMapping[str, Any]): |
| 8092 |
azure.search.documents.knowledgebases.models.IndexedOneLakeKnowledgeSourceParams |
class azure.search.documents.knowledgebases.models.IndexedOneLakeKnowledgeSourceParams(MutableMapping[str, Any]): |
Using a shortened suffix here is inconsistent with nearby model names and makes the surface harder to scan. Suggestion : class azure.search.documents.knowledgebases.models.IndexedOneLakeKnowledgeSourceParameters(MutableMapping[str, Any]): |
| 8764 |
azure.search.documents.knowledgebases.models.SearchIndexKnowledgeSourceParams.reranker_threshold(float) |
reranker_threshold: float |
The property type should match the constructor overload, which allows this value to be omitted. Suggestion : reranker_threshold: Optional[float] |
| 8946 |
azure.search.documents.models.IndexDocumentsBatch.add_delete_actions.param(documents) |
*documents: Union[List[Dict], List[List[Dict]]], |
Accept mapping-based document inputs instead of concrete dicts, and avoid nested list shapes here since the varargs already express multiple documents and the current contract is harder to understand and type-check. Suggestion : *documents: Mapping[str, Any], Guidelines https://azure.github.io/azure-sdk/python_design.html#python-client-splat-args |
| 75 |
azure.search.documents.SearchClient.init.param(kwargs) |
**kwargs: Any |
Restore 'audience' in _patch.py since it's not currently supported by the TypeSpec Python emitter. |
| 93 |
azure.search.documents.SearchClient.autocomplete.returntype |
) -> List[AutocompleteItem]: ... |
Keep the returned models as is since TypeSpec models inherit MutableMapping, enabling dict-style access without breaking behavior. |
| 1741 |
azure.search.documents.indexes.models.AIFoundryModelCatalogName.OPEN_AI_CLIP_IMAGE_TEXT_EMBEDDINGS_VIT_BASE_PATCH32 |
OPEN_AI_CLIP_IMAGE_TEXT_EMBEDDINGS_VIT_BASE_PATCH32 = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" |
Keep 'vit' as is, since it aligns with the AI Foundry model catalog registration. |
| 1897 |
azure.search.documents.indexes.models.AzureBlobKnowledgeSource.e_tag(str) |
e_tag: str |
Keep 'e_tag' as is since it is already used throughout the GA API for consistency. |
| 2146 |
azure.search.documents.indexes.models.BinaryQuantizationCompression.rescoring_options(~azure.search.documents.indexes.models.RescoringOptions) |
rescoring_options: RescoringOptions |
Keep 'RescoringOptions' as is since it retains all properties with no change from version 11.6.0. |
| 2278 |
azure.search.documents.indexes.models.ChatCompletionSchema.properties(str) |
properties: Optional[str] |
Keep 'properties' as type string because it is a JSON-formatted string defining the output schema, aligning with the OpenAI structured outputs pattern. |
| 3709 |
azure.search.documents.indexes.models.IndexedOneLakeKnowledgeSource |
class azure.search.documents.indexes.models.IndexedOneLakeKnowledgeSource(MutableMapping[str, Any]): |
Remove EntityRecognitionSkillVersion enum and the V1 EntityRecognitionSkill from the spec as they are no longer needed; only V3 remains. |
| 5278 |
azure.search.documents.indexes.models.PathHierarchyTokenizerV2 |
class azure.search.documents.indexes.models.PathHierarchyTokenizerV2(MutableMapping[str, Any]): |
Make this a breaking change as discussed. |
| 5568 |
azure.search.documents.indexes.models.ScalarQuantizationCompression.rescoring_options(~azure.search.documents.indexes.models.RescoringOptions) |
rescoring_options: RescoringOptions |
Keep 'RescoringOptions' as is since it retains all properties without change from version 11.6.0. |
| 6611 |
azure.search.documents.indexes.models.SentimentSkillV3 |
class azure.search.documents.indexes.models.SentimentSkillV3(MutableMapping[str, Any]): |
Remove 'SearchIndexerKnowledgeStoreParameters' model as it was intentionally deprecated in version 2026_04_01. |
| 7258 |
azure.search.documents.indexes.models.TextTranslationSkill |
class azure.search.documents.indexes.models.TextTranslationSkill(MutableMapping[str, Any]): |
No changes needed - the 'SuggestOptions' model is removed as users never constructed it. |
| 7592 |
azure.search.documents.indexes.models.VectorSearchCompression.truncation_dimension(int) |
truncation_dimension: Optional[int] |
Remove truncation_dimension since the property has been removed. |
| 7930 |
azure.search.documents.knowledgebases.KnowledgeBaseRetrievalClient.retrieve_1 |
def retrieve( |
Keep the verb 'retrieve' as is to differentiate it from simple CRUD 'get' operations due to its server-side retrieval and content assembly functionality. |
| 8656 |
azure.search.documents.knowledgebases.models.KnowledgeSourceParams |
class azure.search.documents.knowledgebases.models.KnowledgeSourceParams(MutableMapping[str, Any]): |
No changes needed - standardize 'Parameters' at the spec level across all languages. |
| 8929 |
azure.search.documents.models.IndexDocumentsBatch |
class azure.search.documents.models.IndexDocumentsBatch(MutableMapping[str, Any]): |
Check azure.search.documents.IndexDocumentsBatch for the required changes or verification. |
Current Task
Apply TypeSpec client customizations to address APIView feedback comments.
Package Name: azure-search-documents
Language: Python
APIView URL: https://spa.apiview.dev/review/e8d301b10edf4b29b346a87fa4905ea6?activeApiRevisionId=7234ecb987b64bc689d16969085cc7d1
Commit SHA: 70c6d1a7c8f9607e09a1d1c9f17f079bbb73f054
TypeSpec Project Path: specification/search/data-plane/Search
Feedback to Address
APIView Comments (104 unresolved)
match_condition: MatchConditions = MatchConditions.Unconditionally, etag: Optional[str] = None,Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etagmatch_condition: MatchConditions = MatchConditions.Unconditionally, etag: Optional[str] = None,Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etagmatch_condition: MatchConditions = MatchConditions.Unconditionally, etag: Optional[str] = None,Guidelines https://azure.github.io/azure-sdk/python_design.html#python-method-conditional-request-etagGPT_5_4_MINI = "gpt-5.4-mini"GPT_5_4_NANO = "gpt-5.4-nano"use_query_modetobool = Falsefor clarity and mention in the changelog.AZURE_OPENAI = "azureOpenAI"max_length: int = 300,def __getattr__(self, name: str) -> object: ...to avoid hiding misspellings and strengthen static analysis.ignore_case: bool = False,class azure.search.documents.knowledgebases.models.AzureBlobKnowledgeSourceParameters(MutableMapping[str, Any]):class azure.search.documents.knowledgebases.models.IndexedOneLakeKnowledgeSourceParameters(MutableMapping[str, Any]):reranker_threshold: Optional[float]*documents: Mapping[str, Any],Guidelines https://azure.github.io/azure-sdk/python_design.html#python-client-splat-argsstringbecause it is a JSON-formatted string defining the output schema, aligning with the OpenAI structured outputs pattern.EntityRecognitionSkillVersionenum and the V1EntityRecognitionSkillfrom the spec as they are no longer needed; only V3 remains.truncation_dimensionsince the property has been removed.Constraints
Apply TypeSpec client customizations to resolve as many comments as possible
MUST consult: https://github.com/Azure/azure-rest-api-specs/blob/main/eng/common/knowledge/customizing-client-tsp.md
ONLY commit the client.tsp file(s). TypeSpec compilation regenerates output files (e.g. Swagger/OpenAPI JSON files in data-plane/) as a side effect - do NOT commit these generated files. Revert them before creating the pull request.
Update ONLY the client.tsp file(s) for the spec directory referenced by this APIView. Do not modify other spec directories, even if feedback mentions related namespaces.
Example of feedback that should only update
specification/ai/Azure.AI.Projects/client.tspand NOTspecification/ai/Azure.AI.Agents/client.tspeven though they mention Agents-related elements:azure.ai.projects.aio.operations.AgentsOperations.delete:async.returntype| Return 'None' on delete.azure.ai.projects.telemetry.trace_function| Does this need to be a public function?Output Requirements
If a Commit SHA is provided, use it as the base for your changes
Include the APIView URL in PR description
CRITICAL: You MUST update the PR description with a summary table. The PR description MUST include a markdown table in EXACTLY this format (do not change column names):
Include one row for EVERY LineNo from the feedback table above. This table is required even if the PR is long.
Note: If a review comment CANNOT be addressed, explanation comments MUST NOT be added to the
client.tspfile.ONLY explain in the "Summary" column why it could not be addressed.
Include SDK code customization guidance: https://github.com/Azure/autorest.python/blob/main/docs/customizations.md
Auto-generated by DelegateAPIViewFeedbackTool