NewYour coding agent can read the release notes before it upgrades.Set up the MCP server →
PyPI · #1871 most downloaded on PyPI
Microsoft Corporation Azure Search Documents Client Library for Python
Last release 1 months ago
28 Aug 2026
Ships fairly regularly
a new release about every 2 months
Nearly every release is documented
notes for 13 of 13 stable releases
Nothing withdrawn
no release was ever pulled
6 years old
58 releases · first in 2020
One column per quarter.
Added ApiVersion.V2026_08_01_PREVIEW so the 2026-08-01-preview Search API version can be selected via the api_version keyword on the clients.
ApiVersion.V2026_08_01_PREVIEW so the 2026-08-01-preview Search API version can beapi_version keyword on the clients.search, page_size, and search_type parameters.prefix.azure.search.documents.indexes.SearchIndexClient.update_knowledge_source_fileazure.search.documents.indexes.SearchIndexClient.upload_knowledge_source_file_multipartazure.search.documents.indexes.models.FileUploadMetadataazure.search.documents.indexes.models.UpdateKnowledgeSourceFileRequestazure.search.documents.indexes.models.UploadKnowledgeSourceFileMultipartRequestazure.search.documents.indexes.models.KnowledgeSourceResultsProcessingazure.search.documents.indexes.models.SearchIndexKnowledgeSourceBoostazure.search.documents.indexes.models.SearchIndexKnowledgeSourceBoostKindazure.search.documents.indexes.models.SearchIndexKnowledgeSourceFieldValueBoostazure.search.documents.indexes.models.SearchIndexKnowledgeSourceFilterHintazure.search.documents.indexes.models.SearchIndexKnowledgeSourceMultiWordExpressionBoostazure.search.documents.indexes.models.SearchIndexKnowledgeSourceQueryHintsazure.search.documents.knowledgebases.models.KnowledgeBaseQueryHintProcessingazure.search.documents.knowledgebases.KnowledgeBaseRetrievalClient.retrieve_stream and itsKnowledgeBaseRetrievalEvent instances. New stream payload models include:
azure.search.documents.knowledgebases.models.KnowledgeBaseActivityStartedEventazure.search.documents.knowledgebases.models.KnowledgeBaseAnswerCompletedEventazure.search.documents.knowledgebases.models.KnowledgeBaseResponseCompletedEventazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalStartedEventazure.search.documents.knowledgebases.models.KnowledgeBaseStreamErrorEventtags and persisted retrieve_defaults.never_query_source, results_processing, and query_hint_overrides.KnowledgeRetrievalAutoReasoningEffort for automatic reasoning-effort selection.KnowledgeSourceNetworkAccessMode.EntraAppAuthentication andWorkIQKnowledgeSourceParameters, plus the query_work_iq_source_authorization retrievalSearchServiceLimits.max_vector_index_size_per_index_in_bytes.These changes do not impact the API of stable versions such as 11.6.0.
Only code written against a beta version such as 12.1.0b1 may be affected.
ApiVersion.V2026_05_01_PREVIEW with ApiVersion.V2026_08_01_PREVIEW and made the newtop, skip, and count with search, page_size, and search_type onSearchIndexClient.list_indexes, SearchIndexClient.list_index_names, and their asynchronouslist_index_stats_summary uses the same new parameters.McpServerTool.inclusion_mode and McpServerToolInclusionMode withMcpServerTool.results_processing and KnowledgeSourceResultsProcessing.model_name with model on model query-planning, answer-synthesis, and web-summarizationKnowledgeBaseActivityRecordModel.KnowledgeBaseWorkIQReference.attributions and WorkIQAttribution withsearch_sensitivity_label_info.GPT_5_MINI, GPT_5_NANO, GPT_5_4_MINI, and GPT_5_4_NANOGPT5_MINI, GPT5_NANO, GPT5_4_MINI, and GPT5_4_NANO, respectively. Wire values areSearchFieldDataType.Collection visible to static type checkers. #47929SearchIndexClient.update_knowledge_source_file and its asynchronous equivalent to(name, file_id, body), consistent with the other File knowledgetsp-location.yaml to target spec commitc195a3fe73b28cd90bf8a302944b2c0ec3d80def (2026-08-01-preview).Below models, operations, and enum members are added for File knowledge source support
Below models, operations, and enum members are added for File knowledge source support
azure.search.documents.indexes.SearchIndexClient.delete_knowledge_source_fileazure.search.documents.indexes.SearchIndexClient.list_knowledge_source_filesazure.search.documents.indexes.SearchIndexClient.upload_knowledge_source_fileazure.search.documents.indexes.models.FileKnowledgeSourceazure.search.documents.indexes.models.FileKnowledgeSourceParametersazure.search.documents.indexes.models.KnowledgeSourceFileazure.search.documents.indexes.models.KnowledgeSourceKind.FILEazure.search.documents.knowledgebases.models.FileKnowledgeSourceParamsazure.search.documents.knowledgebases.models.KnowledgeBaseFileActivityArgumentsazure.search.documents.knowledgebases.models.KnowledgeBaseFileActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseFileReferenceBelow models and enum members are added for indexed SQL knowledge source support
azure.search.documents.indexes.models.ContentColumnMappingazure.search.documents.indexes.models.EmbeddingColumnMappingazure.search.documents.indexes.models.IndexedSqlKnowledgeSourceazure.search.documents.indexes.models.IndexedSqlKnowledgeSourceParametersazure.search.documents.indexes.models.KnowledgeSourceKind.INDEXED_SQLazure.search.documents.knowledgebases.models.IndexedSqlKnowledgeSourceParamsazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedSqlActivityArgumentsazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedSqlActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedSqlReferenceBelow models and enum members are added for MCP server knowledge source support
azure.search.documents.indexes.models.KnowledgeSourceKind.MCP_SERVERazure.search.documents.indexes.models.McpServerAuthenticationazure.search.documents.indexes.models.McpServerAuthenticationKindazure.search.documents.indexes.models.McpServerAutoOutputParsingazure.search.documents.indexes.models.McpServerFoundryConnectionAuthenticationazure.search.documents.indexes.models.McpServerFoundryConnectionParametersazure.search.documents.indexes.models.McpServerHeadersazure.search.documents.indexes.models.McpServerJsonOutputParsingazure.search.documents.indexes.models.McpServerKnowledgeSourceazure.search.documents.indexes.models.McpServerKnowledgeSourceParametersazure.search.documents.indexes.models.McpServerNoneOutputParsingazure.search.documents.indexes.models.McpServerOutputParsingazure.search.documents.indexes.models.McpServerOutputParsingJsonParametersazure.search.documents.indexes.models.McpServerOutputParsingKindazure.search.documents.indexes.models.McpServerOutputParsingSplitParametersazure.search.documents.indexes.models.McpServerSplitOutputParsingazure.search.documents.indexes.models.McpServerStoredHeadersAuthenticationazure.search.documents.indexes.models.McpServerStoredHeadersParametersazure.search.documents.indexes.models.McpServerToolazure.search.documents.indexes.models.McpServerToolInclusionModeazure.search.documents.knowledgebases.models.KnowledgeBaseMcpServerActivityArgumentsazure.search.documents.knowledgebases.models.KnowledgeBaseMcpServerActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseMcpServerReferenceazure.search.documents.knowledgebases.models.McpServerKnowledgeSourceParamsBelow models and enum members are added for Fabric Data Agent knowledge source support
azure.search.documents.indexes.models.FabricDataAgentKnowledgeSourceazure.search.documents.indexes.models.FabricDataAgentKnowledgeSourceParametersazure.search.documents.indexes.models.KnowledgeSourceKind.FABRIC_DATA_AGENTazure.search.documents.knowledgebases.models.FabricDataAgentKnowledgeSourceParamsazure.search.documents.knowledgebases.models.KnowledgeBaseFabricDataAgentActivityArgumentsazure.search.documents.knowledgebases.models.KnowledgeBaseFabricDataAgentActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseFabricDataAgentReferenceBelow models and enum members are added for Fabric Ontology knowledge source support
azure.search.documents.indexes.models.FabricOntologyKnowledgeSourceazure.search.documents.indexes.models.FabricOntologyKnowledgeSourceParametersazure.search.documents.indexes.models.KnowledgeSourceKind.FABRIC_ONTOLOGYazure.search.documents.knowledgebases.models.FabricOntologyKnowledgeSourceParamsazure.search.documents.knowledgebases.models.KnowledgeBaseFabricOntologyActivityArgumentsazure.search.documents.knowledgebases.models.KnowledgeBaseFabricOntologyActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseFabricOntologyReferenceBelow models and enum members are added for WorkIQ knowledge source support
azure.search.documents.indexes.models.KnowledgeSourceKind.WORK_IQazure.search.documents.indexes.models.WorkIQKnowledgeSourceazure.search.documents.knowledgebases.models.KnowledgeBaseWorkIQActivityArgumentsazure.search.documents.knowledgebases.models.KnowledgeBaseWorkIQActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseWorkIQReferenceazure.search.documents.knowledgebases.models.WorkIQAttributionazure.search.documents.knowledgebases.models.WorkIQKnowledgeSourceParamsBelow models and properties are added for image serving in knowledge sources
azure.search.documents.indexes.models.KnowledgeSourceReference.enable_image_servingazure.search.documents.knowledgebases.models.ImageServingStatisticsazure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobActivityRecord.image_servingazure.search.documents.knowledgebases.models.KnowledgeBaseImageContentazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeActivityRecord.image_servingazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedSharePointActivityRecord.image_servingazure.search.documents.knowledgebases.models.KnowledgeBaseRemoteSharePointActivityRecord.image_servingazure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexActivityRecord.image_servingazure.search.documents.knowledgebases.models.KnowledgeBaseWebActivityRecord.image_servingazure.search.documents.knowledgebases.models.KnowledgeSourceParams.enable_image_servingBelow properties and enum members are added for Purview sensitivity label support
azure.search.documents.indexes.models.KnowledgeSourceIngestionPermissionOption.SENSITIVITY_LABELSazure.search.documents.knowledgebases.models.KnowledgeBaseAzureBlobReference.search_sensitivity_label_infoazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedOneLakeReference.search_sensitivity_label_infoazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedSharePointReference.search_sensitivity_label_infoazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalResponse.response_sensitivity_label_infoazure.search.documents.knowledgebases.models.KnowledgeBaseSearchIndexReference.search_sensitivity_label_infoBelow models and properties are added for content freshness
azure.search.documents.indexes.models.KnowledgeSourceReference.enable_freshnessazure.search.documents.indexes.models.WebKnowledgeSourceParameters.countazure.search.documents.indexes.models.WebKnowledgeSourceParameters.freshnessazure.search.documents.indexes.models.WebKnowledgeSourceParameters.languageazure.search.documents.indexes.models.WebKnowledgeSourceParameters.marketazure.search.documents.knowledgebases.models.FreshnessPolicyBelow properties are added for knowledge source resilience and output limits
azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.max_output_documentsazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.max_output_size_in_tokensazure.search.documents.knowledgebases.models.KnowledgeSourceParams.fail_on_errorazure.search.documents.knowledgebases.models.KnowledgeSourceParams.max_output_documentsBelow properties are added for knowledge base activity records
azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord.warningazure.search.documents.knowledgebases.models.KnowledgeBaseModelAnswerSynthesisActivityRecord.model_nameazure.search.documents.knowledgebases.models.KnowledgeBaseModelQueryPlanningActivityRecord.model_nameBelow models are added for knowledge base activity dispatch
azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecordTypeazure.search.documents.knowledgebases.models.KnowledgeBaseReferenceTypeBelow models and properties are added for knowledge base service capabilities
azure.search.documents.indexes.models.KnowledgeBase.cors_optionsazure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters.base_filterazure.search.documents.indexes.models.SearchServiceCounters.knowledge_base_counterazure.search.documents.indexes.models.SearchServiceCounters.knowledge_source_counterazure.search.documents.knowledgebases.models.AssetStoreBelow models, enum members, and properties are added for content understanding skill chunking
azure.search.documents.indexes.models.ContentUnderstandingSkillChunkingMethodazure.search.documents.indexes.models.ContentUnderstandingSkillChunkingProperties.methodazure.search.documents.indexes.models.ContentUnderstandingSkillChunkingUnit.TOKENSBelow properties are added for federated identity on indexer data sources
azure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.federated_identity_client_idBelow models are added for indexer execution diagnostics
azure.search.documents.indexes.models.IndexerExecutionStatusDetailBelow enum members are added for the GPT-5 Azure OpenAI model family
azure.search.documents.indexes.models.AzureOpenAIModelName.GPT51azure.search.documents.indexes.models.AzureOpenAIModelName.GPT52azure.search.documents.indexes.models.AzureOpenAIModelName.GPT54azure.search.documents.indexes.models.AzureOpenAIModelName.GPT_5_4_MINIazure.search.documents.indexes.models.AzureOpenAIModelName.GPT_5_4_NANOBelow models and properties are added for SharePoint connector configuration
azure.search.documents.indexes.models.SearchIndex.share_point_connector_app_registrationazure.search.documents.indexes.models.SharePointConnectorAppRegistrationBelow models are added for Microsoft Entra application credentials
azure.search.documents.indexes.models.AzureActiveDirectoryApplicationCredentialsBelow models are added for multi-resource creation responses
azure.search.documents.indexes.models.CreatedResourcesBelow properties are added for search field permissioning and source attribution
azure.search.documents.indexes.models.SearchField.retrievableazure.search.documents.indexes.models.SearchField.sensitivity_label_idazure.search.documents.indexes.models.SearchField.sensitivity_label_nameazure.search.documents.indexes.models.SearchField.sharepoint_site_urlazure.search.documents.indexes.models.SearchField.source_document_idBelow properties are added for indexer data source connection sub-typing
azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.sub_typeBelow properties are added for resource encryption key access credentials
azure.search.documents.indexes.models.SearchResourceEncryptionKey.access_credentialsazure.search.documents.indexes.models.SearchResourceEncryptionKey.is_service_level_keyBelow properties are added for custom analyzer configuration
azure.search.documents.indexes.models.CustomAnalyzer.char_filtersazure.search.documents.indexes.models.CustomAnalyzer.token_filtersazure.search.documents.indexes.models.CustomAnalyzer.tokenizer_nameBelow models are added as new V2 tokenizers and token filters
azure.search.documents.indexes.models.EdgeNGramTokenFilterV2azure.search.documents.indexes.models.KeywordTokenizerV2azure.search.documents.indexes.models.LuceneStandardTokenizerV2azure.search.documents.indexes.models.NGramTokenFilterV2azure.search.documents.indexes.models.PathHierarchyTokenizerV2Below models are added for indexer knowledge store parameters and web API skill headers
azure.search.documents.indexes.models.SearchIndexerKnowledgeStoreParametersazure.search.documents.indexes.models.WebApiHttpHeadersBelow models are added for knowledge source vectorization and synchronization
azure.search.documents.knowledgebases.models.AIServicesazure.search.documents.knowledgebases.models.CompletedSynchronizationStateazure.search.documents.knowledgebases.models.KnowledgeSourceAzureOpenAIVectorizerazure.search.documents.knowledgebases.models.KnowledgeSourceIngestionParametersazure.search.documents.knowledgebases.models.KnowledgeSourceStatisticsazure.search.documents.knowledgebases.models.KnowledgeSourceStatusazure.search.documents.knowledgebases.models.KnowledgeSourceSynchronizationErrorazure.search.documents.knowledgebases.models.KnowledgeSourceVectorizerazure.search.documents.knowledgebases.models.SynchronizationStateBelow models are added for richer model activity records on knowledge bases
azure.search.documents.knowledgebases.models.KnowledgeBaseModelWebSummarizationActivityRecordBelow models are added for document plane debug, autocomplete, suggest, and search result types
azure.search.documents.models.AutocompleteItemazure.search.documents.models.DocumentDebugInfoazure.search.documents.models.ErrorAdditionalInfoazure.search.documents.models.ErrorDetailazure.search.documents.models.ErrorResponseazure.search.documents.models.FacetResultazure.search.documents.models.IndexActionTypeazure.search.documents.models.IndexDocumentsBatchazure.search.documents.models.LookupDocumentazure.search.documents.models.QueryResultDocumentRerankerInputazure.search.documents.models.QueryResultDocumentSemanticFieldazure.search.documents.models.QueryResultDocumentSubscoresazure.search.documents.models.QueryRewritesDebugInfoazure.search.documents.models.QueryRewritesValuesDebugInfoazure.search.documents.models.SearchResultazure.search.documents.models.SemanticDebugInfoazure.search.documents.models.SemanticFieldStateazure.search.documents.models.SingleVectorFieldResultazure.search.documents.models.SuggestResultazure.search.documents.models.TextResultazure.search.documents.models.VectorQueryKindazure.search.documents.models.VectorsDebugInfoBelow operations are added for arbitrary REST requests
azure.search.documents.indexes.SearchIndexerClient.send_requestazure.search.documents.knowledgebases.KnowledgeBaseRetrievalClient.send_requestBelow models are added or changed for typed search field data
azure.search.documents.indexes.models.SearchFieldDataType (now an enum class; was a sub-module of string constants)Below properties are added or changed for synonym maps
azure.search.documents.indexes.models.SynonymMap.format (now a writable property; was a fixed solr constant)These changes do not impact the API of stable versions such as
12.0.0. Only code written against a beta version such as11.7.0b2may be affected.
Below methods do not exist on models in this release. Use as_dict() to serialize and the model constructor to deserialize (for example, index.as_dict() instead of index.serialize(), and SearchIndex(data) instead of SearchIndex.deserialize(data)).
deserialize()serialize()Below models are renamed
azure.search.documents.indexes.models.ChatCompletionResponseFormatJsonSchemaProperties -> azure.search.documents.indexes.models.ChatCompletionSchemaPropertiesazure.search.documents.indexes.models.CommonModelParameters -> azure.search.documents.indexes.models.ChatCompletionCommonModelParametersazure.search.documents.indexes.models.EntityRecognitionSkill -> azure.search.documents.indexes.models.EntityRecognitionSkillV3 (V3 does not include include_typeless_entities or skill_version)azure.search.documents.indexes.models.SentimentSkill -> azure.search.documents.indexes.models.SentimentSkillV3 (V3 does not include skill_version)azure.search.documents.knowledgebases.models.SharePointSensitivityLabelInfo -> azure.search.documents.knowledgebases.models.PurviewSensitivityLabelInfoBelow properties are renamed
azure.search.documents.indexes.models.ChatCompletionResponseFormat.chat_completion_schema_properties -> azure.search.documents.indexes.models.ChatCompletionResponseFormat.json_schema_propertiesazure.search.documents.indexes.models.CommonModelParameters.model -> azure.search.documents.indexes.models.ChatCompletionCommonModelParameters.model_nameazure.search.documents.indexes.models.KeywordTokenizer.max_token_length -> azure.search.documents.indexes.models.KeywordTokenizer.buffer_sizeazure.search.documents.indexes.models.SearchIndexerDataSourceConnection.connection_string -> azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.credentialsazure.search.documents.indexes.models.SplitSkill.parameters -> azure.search.documents.indexes.models.SplitSkill.azure_open_ai_tokenizer_parametersazure.search.documents.knowledgebases.models.SharePointSensitivityLabelInfo.tooltip -> azure.search.documents.knowledgebases.models.PurviewSensitivityLabelInfo.tool_tipazure.search.documents.models.VectorQuery.k -> azure.search.documents.models.VectorQuery.k_nearest_neighborsazure.search.documents.models.VectorizableImageBinaryQuery.k -> azure.search.documents.models.VectorizableImageBinaryQuery.k_nearest_neighborsazure.search.documents.models.VectorizableImageUrlQuery.k -> azure.search.documents.models.VectorizableImageUrlQuery.k_nearest_neighborsazure.search.documents.models.VectorizableTextQuery.k -> azure.search.documents.models.VectorizableTextQuery.k_nearest_neighborsazure.search.documents.models.VectorizedQuery.k -> azure.search.documents.models.VectorizedQuery.k_nearest_neighborsBelow enum members are renamed
azure.search.documents.indexes.models.AIFoundryModelCatalogName.FACEBOOK_DINO_V2_IMAGE_EMBEDDINGS_VI_T_BASE -> azure.search.documents.indexes.models.AIFoundryModelCatalogName.FACEBOOK_DINO_V2_IMAGE_EMBEDDINGS_VIT_BASEazure.search.documents.indexes.models.AIFoundryModelCatalogName.FACEBOOK_DINO_V2_IMAGE_EMBEDDINGS_VI_T_GIANT -> azure.search.documents.indexes.models.AIFoundryModelCatalogName.FACEBOOK_DINO_V2_IMAGE_EMBEDDINGS_VIT_GIANTazure.search.documents.indexes.models.AIFoundryModelCatalogName.OPEN_AI_CLIP_IMAGE_TEXT_EMBEDDINGS_VI_T_LARGE_PATCH14_336 -> azure.search.documents.indexes.models.AIFoundryModelCatalogName.OPEN_AI_CLIP_IMAGE_TEXT_EMBEDDINGS_VIT_LARGE_PATCH14_336azure.search.documents.indexes.models.AzureOpenAIModelName.GPT5_MINI -> azure.search.documents.indexes.models.AzureOpenAIModelName.GPT_5_MINIazure.search.documents.indexes.models.AzureOpenAIModelName.GPT5_NANO -> azure.search.documents.indexes.models.AzureOpenAIModelName.GPT_5_NANOazure.search.documents.indexes.models.KnowledgeSourceKind.INDEXED_ONE_LAKE -> azure.search.documents.indexes.models.KnowledgeSourceKind.INDEXED_ONELAKEazure.search.documents.indexes.models.RankingOrder.RE_RANKER_SCORE -> azure.search.documents.indexes.models.RankingOrder.RERANKER_SCOREazure.search.documents.indexes.models.SearchIndexerDataSourceType.MY_SQL -> azure.search.documents.indexes.models.SearchIndexerDataSourceType.MYSQLazure.search.documents.indexes.models.SearchIndexerDataSourceType.ONE_LAKE -> azure.search.documents.indexes.models.SearchIndexerDataSourceType.ONELAKEazure.search.documents.indexes.models.SearchIndexerDataSourceType.SHARE_POINT -> azure.search.documents.indexes.models.SearchIndexerDataSourceType.SHAREPOINTBelow models do not exist in this release
azure.search.documents.indexes.models.AIServices (moved to azure.search.documents.knowledgebases.models.AIServices)azure.search.documents.indexes.models.CompletedSynchronizationState (moved to azure.search.documents.knowledgebases.models.CompletedSynchronizationState)azure.search.documents.indexes.models.EntityRecognitionSkillVersionazure.search.documents.indexes.models.KnowledgeRetrievalLowReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalMediumReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalMinimalReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalOutputModeazure.search.documents.indexes.models.KnowledgeRetrievalReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalReasoningEffortKindazure.search.documents.indexes.models.KnowledgeSourceAzureOpenAIVectorizer (moved to azure.search.documents.knowledgebases.models.KnowledgeSourceAzureOpenAIVectorizer)azure.search.documents.indexes.models.KnowledgeSourceIngestionParameters (moved to azure.search.documents.knowledgebases.models.KnowledgeSourceIngestionParameters)azure.search.documents.indexes.models.KnowledgeSourceStatistics (moved to azure.search.documents.knowledgebases.models.KnowledgeSourceStatistics)azure.search.documents.indexes.models.KnowledgeSourceStatus (moved to azure.search.documents.knowledgebases.models.KnowledgeSourceStatus)azure.search.documents.indexes.models.KnowledgeSourceVectorizer (moved to azure.search.documents.knowledgebases.models.KnowledgeSourceVectorizer)azure.search.documents.indexes.models.PathHierarchyTokenizer (use PathHierarchyTokenizerV2 instead, which is still available)azure.search.documents.indexes.models.SentimentSkillVersionazure.search.documents.indexes.models.SuggestOptionsazure.search.documents.indexes.models.SynchronizationState (moved to azure.search.documents.knowledgebases.models.SynchronizationState)azure.search.documents.knowledgebases.models.ErrorAdditionalInfo (moved to azure.search.documents.models.ErrorAdditionalInfo)azure.search.documents.knowledgebases.models.ErrorDetail (moved to azure.search.documents.models.ErrorDetail)azure.search.documents.knowledgebases.models.ErrorResponse (moved to azure.search.documents.models.ErrorResponse)azure.search.documents.knowledgebases.models.KnowledgeBaseMessageImageContentImageazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalActivityRecordazure.search.documents.knowledgebases.models.KnowledgeSourceKind (still available as azure.search.documents.indexes.models.KnowledgeSourceKind)azure.search.documents.knowledgebases.models.RequestOptionsazure.search.documents.knowledgebases.models.SearchIndexFieldReference (still available as azure.search.documents.indexes.models.SearchIndexFieldReference)Below properties do not exist in this release
azure.search.documents.indexes.models.ChatCompletionSkill.auth_resource_idazure.search.documents.indexes.models.ChatCompletionSkill.batch_sizeazure.search.documents.indexes.models.ChatCompletionSkill.degree_of_parallelismazure.search.documents.indexes.models.ChatCompletionSkill.http_headersazure.search.documents.indexes.models.ChatCompletionSkill.http_methodazure.search.documents.indexes.models.ChatCompletionSkill.timeoutazure.search.documents.indexes.models.SearchField.sensitivity_label (replaced by sensitivity_label_id and sensitivity_label_name)azure.search.documents.indexes.models.SearchResourceEncryptionKey.application_id (replaced by access_credentials)azure.search.documents.indexes.models.SearchResourceEncryptionKey.application_secret (replaced by access_credentials)2026-05-01-preview.Code | Docs Support: Active
Code | Docs
Support: Active
Below clients, models, and enum members are added for knowledge base support
azure.search.documents.knowledgebases.KnowledgeBaseRetrievalClientazure.search.documents.indexes.models.AzureBlobKnowledgeSourceazure.search.documents.indexes.models.IndexedOneLakeKnowledgeSourceazure.search.documents.indexes.models.KnowledgeBaseazure.search.documents.indexes.models.SearchIndexKnowledgeSourceazure.search.documents.indexes.models.WebKnowledgeSourceazure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecordType.MODEL_WEB_SUMMARIZATIONazure.search.documents.knowledgebases.models.KnowledgeBaseModelWebSummarizationActivityRecordazure.search.documents.knowledgebases.models.KnowledgeRetrievalMinimalReasoningEffortazure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffortazure.search.documents.knowledgebases.models.KnowledgeSourceStatisticsazure.search.documents.knowledgebases.models.KnowledgeSourceStatusazure.search.documents.knowledgebases.models.KnowledgeSourceSynchronizationErrorBelow properties are added or changed for index and indexer enhancements
azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.identity for managed identity support on data source connections.azure.search.documents.indexes.models.SearchIndexerKnowledgeStore.identity for managed identity support on knowledge store projections.azure.search.documents.indexes.models.SearchResourceEncryptionKey.key_version changed from required to optional, aligning with service behavior.Below enum members and properties are added for Markdown parsing
azure.search.documents.indexes.models.BlobIndexerParsingMode.MARKDOWN enum value for native Markdown file parsing in blob indexers.azure.search.documents.indexes.models.IndexingParametersConfiguration.markdown_header_depth (h1 through h6) to set header depth for sectioning.azure.search.documents.indexes.models.IndexingParametersConfiguration.markdown_parsing_submode (oneToOne or oneToMany) to control document splitting.Below models are added
azure.search.documents.indexes.models.ChatCompletionCommonModelParametersazure.search.documents.indexes.models.ChatCompletionResponseFormatazure.search.documents.indexes.models.ChatCompletionSchemaazure.search.documents.indexes.models.ChatCompletionSkillazure.search.documents.indexes.models.ContentUnderstandingSkillazure.search.documents.indexes.models.ContentUnderstandingSkillChunkingPropertiesazure.search.documents.indexes.models.ContentUnderstandingSkillChunkingUnitazure.search.documents.indexes.models.ContentUnderstandingSkillExtractionOptionsazure.search.documents.knowledgebases.models.AIServicesazure.search.documents.knowledgebases.models.CompletedSynchronizationStateazure.search.documents.knowledgebases.models.SynchronizationStateserialize() and deserialize() methods on models are removed. Use as_dict() to serialize and the model constructor to deserialize (e.g., index.as_dict() instead of index.serialize(), SearchIndex(data) instead of SearchIndex.deserialize(data)).azure.search.documents.indexes.models.EntityRecognitionSkillazure.search.documents.indexes.models.EntityRecognitionSkillVersionazure.search.documents.indexes.models.PathHierarchyTokenizer (renamed to PathHierarchyTokenizerV2)azure.search.documents.indexes.models.SentimentSkillazure.search.documents.indexes.models.SentimentSkillVersionazure.search.documents.indexes.models.SearchIndexerDataSourceType.MY_SQL (renamed to MYSQL)azure.search.documents.indexes.models.SearchIndexerDataSourceType.ONE_LAKE (renamed to ONELAKE)azure.search.documents.indexes.models.BinaryQuantizationCompression.rerank_with_original_vectorsazure.search.documents.indexes.models.ScalarQuantizationCompression.rerank_with_original_vectorsazure.search.documents.indexes.models.VectorSearchCompression.rerank_with_original_vectorsThe following changes do not impact the API of stable versions such as 11.6.0. Only code written against a beta version such as 11.7.0b2 may be affected.
Below models do not exist in this release
azure.search.documents.indexes.models.AIServicesVisionParametersazure.search.documents.indexes.models.AIServicesVisionVectorizerazure.search.documents.indexes.models.AzureMachineLearningSkillazure.search.documents.indexes.models.AzureOpenAITokenizerParametersazure.search.documents.indexes.models.IndexedSharePointContainerNameazure.search.documents.indexes.models.IndexerCurrentStateazure.search.documents.indexes.models.IndexerExecutionStatusDetailazure.search.documents.indexes.models.IndexerPermissionOptionazure.search.documents.indexes.models.IndexerRuntimeazure.search.documents.indexes.models.IndexingModeazure.search.documents.indexes.models.IndexStatisticsSummaryazure.search.documents.indexes.models.KnowledgeRetrievalLowReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalMediumReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalOutputModeazure.search.documents.indexes.models.KnowledgeSourceIngestionPermissionOptionazure.search.documents.indexes.models.PermissionFilterazure.search.documents.indexes.models.SearchIndexerCacheazure.search.documents.indexes.models.SearchIndexPermissionFilterOptionazure.search.documents.indexes.models.ServiceIndexersRuntimeazure.search.documents.indexes.models.SplitSkillEncoderModelNameazure.search.documents.indexes.models.SplitSkillUnitazure.search.documents.indexes.models.VisionVectorizeSkillazure.search.documents.knowledgebases.models.IndexedSharePointKnowledgeSourceParamsazure.search.documents.knowledgebases.models.KnowledgeBaseIndexedSharePointReferenceazure.search.documents.knowledgebases.models.KnowledgeBaseModelAnswerSynthesisActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseModelQueryPlanningActivityRecordazure.search.documents.knowledgebases.models.KnowledgeBaseRemoteSharePointReferenceazure.search.documents.knowledgebases.models.RemoteSharePointKnowledgeSourceParamsazure.search.documents.models.DebugInfoazure.search.documents.models.HybridCountAndFacetModeazure.search.documents.models.HybridSearchazure.search.documents.models.QueryLanguageazure.search.documents.models.QueryResultDocumentInnerHitazure.search.documents.models.QueryResultDocumentRerankerInputazure.search.documents.models.QueryResultDocumentSemanticFieldazure.search.documents.models.QueryRewritesDebugInfoazure.search.documents.models.QueryRewritesTypeazure.search.documents.models.QueryRewritesValuesDebugInfoazure.search.documents.models.QuerySpellerTypeazure.search.documents.models.SearchDocumentsResultazure.search.documents.models.SearchScoreThresholdazure.search.documents.models.SemanticDebugInfoazure.search.documents.models.SemanticFieldStateazure.search.documents.models.SemanticQueryRewritesResultTypeazure.search.documents.models.VectorSimilarityThresholdazure.search.documents.models.VectorThresholdazure.search.documents.models.VectorThresholdKindIndexedSharePointKnowledgeSource, RemoteSharePointKnowledgeSource and related models including IndexedSharePointKnowledgeSourceParameters, RemoteSharePointKnowledgeSourceParameters, SharePointSensitivityLabelInfo)Below properties do not exist in this release
azure.search.documents.indexes.models.ChatCompletionSkill.auth_resource_idazure.search.documents.indexes.models.ChatCompletionSkill.batch_sizeazure.search.documents.indexes.models.ChatCompletionSkill.degree_of_parallelismazure.search.documents.indexes.models.ChatCompletionSkill.http_headersazure.search.documents.indexes.models.ChatCompletionSkill.http_methodazure.search.documents.indexes.models.ChatCompletionSkill.timeoutazure.search.documents.indexes.models.IndexerExecutionResult.modeazure.search.documents.indexes.models.IndexerExecutionResult.status_detailazure.search.documents.indexes.models.KnowledgeBase.answer_instructionsazure.search.documents.indexes.models.KnowledgeBase.output_modeazure.search.documents.indexes.models.KnowledgeBase.retrieval_instructionsazure.search.documents.indexes.models.KnowledgeBase.retrieval_reasoning_effortazure.search.documents.indexes.models.KnowledgeSourceIngestionParameters.ingestion_permission_optionsazure.search.documents.indexes.models.SearchField.permission_filterazure.search.documents.indexes.models.SearchField.sensitivity_labelazure.search.documents.indexes.models.SearchIndex.permission_filter_optionazure.search.documents.indexes.models.SearchIndex.purview_enabledazure.search.documents.indexes.models.SearchIndexer.cacheazure.search.documents.indexes.models.SearchIndexerDataSourceConnection.indexer_permission_optionsazure.search.documents.indexes.models.SearchIndexerDataSourceConnection.sub_typeazure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.federated_identity_client_idazure.search.documents.indexes.models.SearchIndexerKnowledgeStore.parametersazure.search.documents.indexes.models.SearchIndexerStatus.current_stateazure.search.documents.indexes.models.SearchIndexerStatus.runtimeazure.search.documents.indexes.models.SearchServiceStatistics.indexers_runtimeazure.search.documents.indexes.models.SemanticConfiguration.flighting_opt_inazure.search.documents.indexes.models.SplitSkill.azure_open_ai_tokenizer_parametersazure.search.documents.indexes.models.SplitSkill.unitazure.search.documents.knowledgebases.models.AzureBlobKnowledgeSourceParams.always_query_sourceazure.search.documents.knowledgebases.models.IndexedOneLakeKnowledgeSourceParams.always_query_sourceazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.max_output_sizeazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.messagesazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.output_modeazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.retrieval_reasoning_effortazure.search.documents.knowledgebases.models.KnowledgeSourceParams.always_query_sourceazure.search.documents.knowledgebases.models.WebKnowledgeSourceParams.always_query_sourceazure.search.documents.models.DebugInfo.query_rewritesazure.search.documents.models.DocumentDebugInfo.inner_hitsazure.search.documents.models.DocumentDebugInfo.semanticazure.search.documents.models.FacetResult.avgazure.search.documents.models.FacetResult.cardinalityazure.search.documents.models.FacetResult.facetsazure.search.documents.models.FacetResult.maxazure.search.documents.models.FacetResult.minazure.search.documents.models.FacetResult.sumazure.search.documents.models.SearchDocumentsResult.debug_infoazure.search.documents.models.SearchDocumentsResult.semantic_query_rewrites_result_typeazure.search.documents.models.VectorizableTextQuery.query_rewritesazure.search.documents.models.VectorQuery.filter_overrideazure.search.documents.models.VectorQuery.per_document_vector_limitazure.search.documents.models.VectorQuery.thresholdBelow parameters do not exist in this release
SearchClient.search.hybrid_searchSearchClient.search.query_languageSearchClient.search.query_rewritesSearchClient.search.semantic_fieldsSearchClient.search.spellerSearchIndexerClient.create_or_update_data_source_connection.skip_indexer_reset_requirement_for_cacheSearchIndexerClient.create_or_update_indexer.disable_cache_reprocessing_change_detectionSearchIndexerClient.create_or_update_indexer.skip_indexer_reset_requirement_for_cacheSearchIndexerClient.create_or_update_skillset.disable_cache_reprocessing_change_detectionSearchIndexerClient.create_or_update_skillset.skip_indexer_reset_requirement_for_cacheBelow operations do not exist in this release
SearchIndexClient.list_index_stats_summarySearchIndexerClient.reset_documentsSearchIndexerClient.reset_skillsSearchIndexerClient.resyncBelow enum values do not exist in this release
azure.search.documents.indexes.models.AzureOpenAIModelName.GPT4_Oazure.search.documents.indexes.models.AzureOpenAIModelName.GPT4_O_MINIazure.search.documents.indexes.models.AzureOpenAIModelName.GPT41azure.search.documents.indexes.models.AzureOpenAIModelName.GPT41_MINIazure.search.documents.indexes.models.AzureOpenAIModelName.GPT41_NANOazure.search.documents.indexes.models.AzureOpenAIModelName.GPT5azure.search.documents.indexes.models.AzureOpenAIModelName.GPT5_MINI (renamed to GPT_5_MINI)azure.search.documents.indexes.models.AzureOpenAIModelName.GPT5_NANO (renamed to GPT_5_NANO)azure.search.documents.indexes.models.KnowledgeSourceKind.INDEXED_ONE_LAKE (renamed to INDEXED_ONELAKE)azure.search.documents.indexes.models.SearchIndexerDataSourceType.SHARE_POINT (renamed to SHAREPOINT)azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecordType.INDEXED_ONE_LAKE (renamed to INDEXED_ONELAKE)azure.search.documents.knowledgebases.models.KnowledgeBaseReferenceType.INDEXED_ONE_LAKE (renamed to INDEXED_ONELAKE)azure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffortKind.LOWazure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffortKind.MEDIUMThe following changes are due to the migration from AutoRest to TypeSpec code generation. The old API continues to work at runtime via backward-compatible aliases:
azure.search.documents.indexes.models.SearchFieldDataType enum values are now UPPER_CASE (e.g., STRING instead of String). PascalCase aliases (e.g., SearchFieldDataType.String) are preserved and continue to work at runtime.azure.search.documents.indexes.models.SearchField now uses retrievable (from the API) as its native property instead of hidden. A hidden property (the inverse of retrievable) is preserved for backward compatibility via getter/setter.2026-04-01.None instead of True or False. There is no behavioral change — the server applies the same default when the property is omitted. Examples include:
azure.search.documents.indexes.models.CommonGramTokenFilter.ignore_caseazure.search.documents.indexes.models.CommonGramTokenFilter.use_query_modeazure.search.documents.indexes.models.DictionaryDecompounderTokenFilter.only_longest_matchazure.search.documents.indexes.models.KeywordMarkerTokenFilter.ignore_caseazure.search.documents.indexes.models.StopwordsTokenFilter.ignore_caseazure.search.documents.indexes.models.SynonymTokenFilter.ignore_caseazure.search.documents.indexes.models.AIServices
Added new models:
azure.search.documents.indexes.models.AIServicesazure.search.documents.indexes.models.CompletedSynchronizationStateazure.search.documents.indexes.models.ContentUnderstandingSkillazure.search.documents.indexes.models.ContentUnderstandingSkillChunkingPropertiesazure.search.documents.indexes.models.ContentUnderstandingSkillChunkingUnitazure.search.documents.indexes.models.ContentUnderstandingSkillExtractionOptionsazure.search.documents.indexes.models.IndexedOneLakeKnowledgeSourceazure.search.documents.indexes.models.IndexedOneLakeKnowledgeSourceParametersazure.search.documents.indexes.models.IndexedSharePointContainerNameazure.search.documents.indexes.models.IndexedSharePointKnowledgeSourceazure.search.documents.indexes.models.IndexedSharePointKnowledgeSourceParametersazure.search.documents.indexes.models.IndexerRuntimeazure.search.documents.indexes.models.KnowledgeRetrievalLowReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalMediumReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalMinimalReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalOutputModeazure.search.documents.indexes.models.KnowledgeRetrievalReasoningEffortazure.search.documents.indexes.models.KnowledgeRetrievalReasoningEffortKindazure.search.documents.indexes.models.KnowledgeSourceAzureOpenAIVectorizerazure.search.documents.indexes.models.KnowledgeSourceContentExtractionModeazure.search.documents.indexes.models.KnowledgeSourceIngestionParametersazure.search.documents.indexes.models.KnowledgeSourceIngestionPermissionOptionazure.search.documents.indexes.models.KnowledgeSourceStatisticsazure.search.documents.indexes.models.KnowledgeSourceStatusazure.search.documents.indexes.models.KnowledgeSourceSynchronizationStatusazure.search.documents.indexes.models.KnowledgeSourceVectorizerazure.search.documents.indexes.models.RemoteSharePointKnowledgeSourceazure.search.documents.indexes.models.RemoteSharePointKnowledgeSourceParametersazure.search.documents.indexes.models.SearchIndexFieldReferenceazure.search.documents.indexes.models.ServiceIndexersRuntimeazure.search.documents.indexes.models.SynchronizationStateazure.search.documents.indexes.models.WebKnowledgeSourceazure.search.documents.indexes.models.WebKnowledgeSourceDomainazure.search.documents.indexes.models.WebKnowledgeSourceDomainsazure.search.documents.indexes.models.WebKnowledgeSourceParametersExpanded existing models and enums:
avg, min, max, and cardinality metrics on azure.search.documents.models.FacetResult.is_adls_gen2 and ingestion_parameters options on azure.search.documents.indexes.models.AzureBlobKnowledgeSourceParameters.gpt-5, gpt-5-mini, and gpt-5-nano values on azure.search.documents.indexes.models.AzureOpenAIModelName.web, remoteSharePoint, indexedSharePoint, and indexedOneLake values on azure.search.documents.indexes.models.KnowledgeSourceKind.onelake and sharepoint values on azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.type.azure.search.documents.indexes.models.SearchField.sensitivity_label.azure.search.documents.indexes.models.SearchIndexerStatus.runtime.azure.search.documents.indexes.models.SearchIndex.purview_enabled.azure.search.documents.indexes.models.SearchServiceLimits.max_cumulative_indexer_runtime_seconds.azure.search.documents.indexes.models.SearchServiceStatistics.indexers_runtime.product aggregation support to azure.search.documents.indexes.models.ScoringFunctionAggregation.share_point to azure.search.documents.indexes.models.SearchIndexerDataSourceType.include_references, include_reference_source_data, always_query_source, and reranker_threshold options on azure.search.documents.knowledgebases.models.SearchIndexKnowledgeSourceParams.error tracking details on azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecord derivatives.Client and service enhancements:
azure.search.documents.knowledgebases.KnowledgeBaseRetrievalClient.knowledge_retrieval.retrieve.x_ms_enable_elevated_read keyword to azure.search.documents.SearchClient.search and azure.search.documents.aio.SearchClient.search for elevated document reads.These changes do not impact the API of stable versions such as 11.6.0. Only code written against a beta version such as 11.6.0b12 may be affected.
azure.search.documents.indexes.models.KnowledgeAgent -> azure.search.documents.indexes.models.KnowledgeBaseazure.search.documents.indexes.models.KnowledgeAgentAzureOpenAIModel -> azure.search.documents.indexes.models.KnowledgeBaseAzureOpenAIModelazure.search.documents.indexes.models.KnowledgeAgentModel -> azure.search.documents.indexes.models.KnowledgeBaseModelazure.search.documents.indexes.models.KnowledgeAgentModelKind -> azure.search.documents.indexes.models.KnowledgeBaseModelKind/knowledgebases REST routes and accept knowledge_base_name instead of the agent name parameter.azure.search.documents.indexes.models.KnowledgeAgentOutputConfiguration with azure.search.documents.indexes.models.KnowledgeBase.output_mode.azure.search.documents.indexes.models.KnowledgeAgentOutputConfigurationModality with azure.search.documents.indexes.models.KnowledgeRetrievalOutputMode.azure.search.documents.indexes.models.KnowledgeAgentRequestLimits; callers should apply request guardrails at the service level.azure.search.documents.indexes.models.AzureBlobKnowledgeSourceParameters to use azure.search.documents.indexes.models.KnowledgeSourceIngestionParameters, replacing the previous identity, embedding_model, chat_completion_model, ingestion_schedule, and disable_image_verbalization properties with the new is_adls_gen2 and ingestion_parameters shape.azure.search.documents.indexes.models.KnowledgeSourceReference to carry only the source name, moving the include_references, include_reference_source_data, always_query_source, max_sub_queries, and reranker_threshold options onto the concrete parameter types.default_oversampling property from azure.search.documents.indexes.models.BinaryQuantizationCompression, azure.search.documents.indexes.models.ScalarQuantizationCompression, and azure.search.documents.indexes.models.VectorSearchCompression.rerank_with_original_vectors property from azure.search.documents.indexes.models.BinaryQuantizationCompression, azure.search.documents.indexes.models.ScalarQuantizationCompression, and azure.search.documents.indexes.models.VectorSearchCompression.azure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters.source_data_select with azure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters.source_data_fields.azure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters.search_fields for field mapping.azure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters.semantic_configuration_name.Added azure.search.documents.models.DebugInfo.
azure.search.documents.models.DebugInfo.azure.search.documents.indexes.models.AzureBlobKnowledgeSource.azure.search.documents.indexes.models.AzureBlobKnowledgeSourceParameters.azure.search.documents.indexes.models.IndexerResyncBody.azure.search.documents.indexes.models.KnowledgeAgentOutputConfiguration.azure.search.documents.indexes.models.KnowledgeAgentOutputConfigurationModality.azure.search.documents.indexes.models.KnowledgeSource.azure.search.documents.indexes.models.KnowledgeSourceKind.azure.search.documents.indexes.models.KnowledgeSourceReference.azure.search.documents.indexes.models.SearchIndexKnowledgeSource.azure.search.documents.indexes.models.SearchIndexKnowledgeSourceParameters.azure.search.documents.indexes.models.KnowledgeAgentTargetIndex.azure.search.documents.indexes.models.SearchIndex.description.azure.search.documents.agent.models.KnowledgeAgentAzureBlobActivityArguments.azure.search.documents.agent.models.KnowledgeAgentAzureBlobActivityRecord.azure.search.documents.agent.models.KnowledgeAgentAzureBlobReference.azure.search.documents.agent.models.KnowledgeAgentModelAnswerSynthesisActivityRecord.azure.search.documents.agent.models.KnowledgeAgentRetrievalActivityRecord.azure.search.documents.agent.models.KnowledgeAgentSearchIndexActivityArguments.azure.search.documents.agent.models.KnowledgeAgentSearchIndexActivityRecord.azure.search.documents.agent.models.KnowledgeAgentSearchIndexReference.azure.search.documents.agent.models.KnowledgeAgentSemanticRerankerActivityRecord.azure.search.documents.agent.models.KnowledgeSourceParams.azure.search.documents.agent.models.SearchIndexKnowledgeSourceParams.azure.search.documents.agent.models.KnowledgeAgentAzureSearchDocReference.azure.search.documents.agent.models.KnowledgeAgentIndexParams.azure.search.documents.agent.models.KnowledgeAgentSearchActivityRecord.azure.search.documents.agent.models.KnowledgeAgentSearchActivityRecordQuery.azure.search.documents.agent.models.KnowledgeAgentSemanticRankerActivityRecord.SearchIndexClient.2025-08-01-preview.Added azure.search.documents.DocumentDebugInfo.
azure.search.documents.DocumentDebugInfo.azure.search.documents.QueryDebugMode.azure.search.documents.QueryResultDocumentSubscores.azure.search.documents.SingleVectorFieldResult.azure.search.documents.TextResult.azure.search.documents.VectorsDebugInfo.debug in azure.search.documents.SearchClient.search.azure.search.documents.indexes.LexicalNormalizer.azure.search.documents.indexes.LexicalNormalizerName.azure.search.documents.indexes.AnalyzeTextOptions.normalizer_name.azure.search.documents.indexes.CustomNormalizer.azure.search.documents.indexes.DocumentIntelligenceLayoutSkill.azure.search.documents.indexes.DocumentIntelligenceLayoutSkillExtractionOptions.azure.search.documents.indexes.DocumentIntelligenceLayoutSkillChunkingProperties.azure.search.documents.indexes.DocumentIntelligenceLayoutSkillChunkingUnit.azure.search.documents.indexes.DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.azure.search.documents.indexes.DocumentIntelligenceLayoutSkillOutputFormat.azure.search.documents.indexes.DocumentIntelligenceLayoutSkillOutputMode.azure.search.documents.indexes.RankingOrder.azure.search.documents.indexes.RescoringOptions.azure.search.documents.indexes.SearchField.normalizer_name.azure.search.documents.indexes.SearchIndex.normalizer.azure.search.documents.indexes.SearchIndexerKnowledgeStoreParameters.azure.search.documents.indexes.VectorSearchCompressionRescoreStorageMethod.VectorQuerys against sub-fields of complex fields.2025-09-01 service version.
SemanticConfiguration.rankingOrder.VectorSearchCompression.RescoringOptions to configure how vector compression handles the original
vector when indexing and how vectors are used during rescoring.SearchIndex.description to provide a textual description of the index.LexicalNormalizer when defining SearchIndex, SimpleField, and SearchableField and the ability to
use it when analyzing text with SearchIndexClient.analyzeText and SearchIndexAsyncClient.analyzeText.DocumentIntelligenceLayoutSkill skillset skill and OneLake SearchIndexerDataSourceConnection data source.QueryDebugMode in searching to retrieve detailed information about search processing. Only vector is
supported for QueryDebugMode.VectorSearchCompression.rerankWithOriginalVectors and VectorSearchCompression.defaultOversampling don't work with
2025-09-01 and were replaced by VectorSearchCompression.RescoringOptions.enabledRescoring and
VectorSearchCompression.RescoringOptions.defaultOversampling. If using 2024-07-01 continue using the old properties,
otherwise if using 2025-09-01 use the new properties in RescoringOptions.2025-09-01.Added azure.search.documents.agent.KnowledgeAgentRetrievalClient.
Added azure.search.documents.agent.KnowledgeAgentRetrievalClient.
Added knowledge agents operations in SearchIndexClient.
Added resync method in SearchIndexerClient.
Exposed @search.reranker_boosted_score in the search results.
Added x_ms_query_source_authorization as a keyword argument to SearchClient.search.
Added property azure.search.documents.indexes.models.SearchField.permission_filter.
Added property azure.search.documents.indexes.models.SearchIndex.permission_filter_option.
Added property azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.indexer_permission_options.
Added new models:
azure.search.documents.models.QueryResultDocumentInnerHitazure.search.documents.indexes.models.ChatCompletionExtraParametersBehaviorazure.search.documents.indexes.models.ChatCompletionResponseFormatazure.search.documents.indexes.models.ChatCompletionResponseFormatTypeazure.search.documents.indexes.models.ChatCompletionResponseFormatJsonSchemaPropertiesazure.search.documents.indexes.models.ChatCompletionSchemaazure.search.documents.indexes.models.ChatCompletionSkillazure.search.documents.indexes.models.CommonModelParametersazure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillChunkingPropertiesazure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillChunkingUnitazure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillExtractionOptionsazure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillOutputFormatazure.search.documents.indexes.models.IndexerPermissionOptionazure.search.documents.indexes.models.IndexerResyncOptionazure.search.documents.indexes.models.KnowledgeAgentazure.search.documents.indexes.models.KnowledgeAgentAzureOpenAIModelazure.search.documents.indexes.models.KnowledgeAgentModelazure.search.documents.indexes.models.KnowledgeAgentModelKindazure.search.documents.indexes.models.KnowledgeAgentRequestLimitsazure.search.documents.indexes.models.KnowledgeAgentTargetIndexazure.search.documents.indexes.models.PermissionFilterazure.search.documents.indexes.models.RankingOrderazure.search.documents.indexes.models.SearchIndexPermissionFilterOptionFixed the issue that could not deserialize document_debug_info. #40138
document_debug_info. #40138Added SearchIndexClient.list_index_stats_summary.
SearchIndexClient.list_index_stats_summary.SearchIndexerCache.id.azure.search.documents.indexes.models.IndexStatisticsSummary.These changes do not impact the API of stable versions such as 11.5.0. Only code written against a beta version such as 11.6.0b9 may be affected.
azure.search.documents.indexes.models.AIStudioModelCatalogName to azure.search.documents.indexes.models.AIFoundryModelCatalogName.Exposed @search.document_debug_info in the search results.
@search.document_debug_info in the search results.Added get_debug_info in Search results.
get_debug_info in Search results.Added SearchResourceEncryptionKey.identity support.
SearchResourceEncryptionKey.identity support.query_rewrites & query_rewrites_count in SearchClient.Search.query_rewrites in VectorizableTextQuery.azure.search.documents.QueryRewritesTypeazure.search.documents.indexes.AIServicesAccountIdentityazure.search.documents.indexes.AIServicesAccountKeyazure.search.documents.indexes.AzureOpenAITokenizerParametersazure.search.documents.indexes.DocumentIntelligenceLayoutSkillMarkdownHeaderDepthazure.search.documents.indexes.DocumentIntelligenceLayoutSkillOutputModeazure.search.documents.indexes.DataSourceCredentialsazure.search.documents.indexes.DocumentIntelligenceLayoutSkillazure.search.documents.indexes.IndexerCurrentStateazure.search.documents.indexes.MarkdownHeaderDepthazure.search.documents.indexes.MarkdownParsingSubmodeazure.search.documents.indexes.RescoringOptionsazure.search.documents.indexes.ResourceCounterazure.search.documents.indexes.SkillNamesazure.search.documents.indexes.SplitSkillEncoderModelNameazure.search.documents.indexes.SplitSkillUnitazure.search.documents.indexes.VectorSearchCompressionKindazure.search.documents.indexes.VectorSearchCompressionRescoreStorageMethodFixed the issue that encryptionKey in SearchIndexer was lost during serialization. #37521
encryptionKey in SearchIndexer was lost during serialization. #37521SearchIndexClient.get_search_client inherits the API version.
SearchIndexClient.get_search_client inherits the API version.encryptionKey was lost during serialization. #37251These changes do not impact the API of stable versions such as 11.5.0. Only code written against a beta version such as 11.6.0b4 may be affected.
azure.search.documents.indexes.models.SearchIndexerIndexProjections -> azure.search.documents.indexes.models.SearchIndexerIndexProjectionazure.search.documents.indexes.models.LineEnding -> azure.search.documents.indexes.models.OrcLineEndingazure.search.documents.indexes.models.ScalarQuantizationCompressionConfiguration -> azure.search.documents.indexes.models.ScalarQuantizationCompressionazure.search.documents.indexes.models.VectorSearchCompressionConfiguration -> azure.search.documents.indexes.models.VectorSearchCompressionazure.search.documents.indexes.models.VectorSearchCompressionTargetDataType -> azure.search.documents.indexes.models.VectorSearchCompressionTargetazure.search.documents.indexes.models.AzureMachineLearningVectorizer.name -> azure.search.documents.indexes.models.AzureMachineLearningVectorizer.vectorizer_nameazure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.deployment_id -> azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.deployment_nameazure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.resource_uri -> azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.resource_urlazure.search.documents.indexes.models.AzureOpenAIVectorizer.azure_open_ai_parameters -> azure.search.documents.indexes.models.AzureOpenAIVectorizer.parametersazure.search.documents.indexes.models.AzureOpenAIVectorizer.name -> azure.search.documents.indexes.models.AzureOpenAIVectorizer.vectorizer_nameazure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.user_assigned_identity -> azure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.resource_idazure.search.documents.indexes.models.VectorSearchProfile.compression_configuration_name -> azure.search.documents.indexes.models.VectorSearchProfile.compression_nameazure.search.documents.indexes.models.VectorSearchProfile.vectorizer -> azure.search.documents.indexes.models.VectorSearchProfile.vectorizer_nameazure.search.documents.indexes.models.VectorSearchVectorizer.name -> azure.search.documents.indexes.models.VectorSearchVectorizer.vectorizer_nameazure.search.documents.models.HybridCountAndFacetMode
azure.search.documents.models.HybridCountAndFacetModeazure.search.documents.models.HybridSearchazure.search.documents.models.SearchScoreThresholdazure.search.documents.models.VectorSimilarityThresholdazure.search.documents.models.VectorThresholdazure.search.documents.models.VectorThresholdKindazure.search.documents.models.VectorizableImageBinaryQueryazure.search.documents.models.VectorizableImageUrlQueryazure.search.documents.indexes.models.AIServicesVisionParametersazure.search.documents.indexes.models.AIServicesVisionVectorizerazure.search.documents.indexes.models.AIStudioModelCatalogNameazure.search.documents.indexes.models.AzureMachineLearningParametersazure.search.documents.indexes.models.AzureMachineLearningVectorizerazure.search.documents.indexes.models.AzureOpenAIModelNameazure.search.documents.indexes.models.VectorEncodingFormatazure.search.documents.indexes.models.VisionVectorizeSkillhybrid_search support for SearchClient.search method.2024-05-01-preview.Added IndexerExecutionEnvironment, IndexingMode, LineEnding, NativeBlobSoftDeleteDeletionDetectionPolicy, ScalarQuantizationCompressionConfiguration,
IndexerExecutionEnvironment, IndexingMode, LineEnding, NativeBlobSoftDeleteDeletionDetectionPolicy, ScalarQuantizationCompressionConfiguration, ScalarQuantizationParameters, SearchServiceCounters, SearchServiceLimits, SearchServiceStatistics, VectorSearchCompressionConfiguration & VectorSearchCompressionTargetDataType.stored in SearchField.SearchIndexerSkillset, SearchField, SearchIndex, AnalyzeTextOptions, SearchResourceEncryptionKey, SynonymMap, SearchIndexerDataSourceConnection are no
SearchIndexerSkillset, SearchField, SearchIndex, AnalyzeTextOptions, SearchResourceEncryptionKey, SynonymMap, SearchIndexerDataSourceConnection are no longer subclasses of _serialization.Model.SearchIndexerSkillset, SearchField, SearchIndex, AnalyzeTextOptions, SearchResourceEncryptionKey, SynonymMap, SearchIndexerDataSourceConnection could not be serialized and as_dict did not work.context was missing for EntityRecognitionSkill and SentimentSkill. #34623V2024_03_01_PREVIEWAdded back semantic_query for Search method.
semantic_query for Search method.SearchIndexClient.AzureOpenAIEmbeddingSkill, AzureOpenAIParameters and AzureOpenAIVectorizer.query_language, query_speller, semantic_fields and debug for Search method.send_request method for SearchClient & SearchIndexClient to run a network request using the client's existing pipeline.retrievable property for SearchField.Fixed the issue search operation did not handle 206 correctly.
Fixed the issue that encryptionKey was lost during serialization. #37521
encryptionKey was lost during serialization. #37521### Other Changes - Improved type checks.
> These changes do not impact the API of stable versions such as 11.4.0.
These changes do not impact the API of stable versions such as 11.4.0. Only code written against a beta version such as 11.6.0b4 may be affected.
Below models are renamed
azure.search.documents.indexes.models.SearchIndexerIndexProjections -> azure.search.documents.indexes.models.SearchIndexerIndexProjectionazure.search.documents.indexes.models.LineEnding -> azure.search.documents.indexes.models.OrcLineEndingazure.search.documents.indexes.models.ScalarQuantizationCompressionConfiguration -> azure.search.documents.indexes.models.ScalarQuantizationCompressionazure.search.documents.indexes.models.VectorSearchCompressionConfiguration -> azure.search.documents.indexes.models.VectorSearchCompressionazure.search.documents.indexes.models.VectorSearchCompressionTargetDataType -> azure.search.documents.indexes.models.VectorSearchCompressionTargetBelow models do not exist in this release
azure.search.documents.models.QueryLanguageazure.search.documents.models.QuerySpellerTypeazure.search.documents.models.QueryDebugModeazure.search.documents.models.HybridCountAndFacetModeazure.search.documents.models.HybridSearchazure.search.documents.models.SearchScoreThresholdazure.search.documents.models.VectorSimilarityThresholdazure.search.documents.models.VectorThresholdazure.search.documents.models.VectorThresholdKindazure.search.documents.models.VectorizableImageBinaryQueryazure.search.documents.models.VectorizableImageUrlQueryazure.search.documents.indexes.models.SearchAliasazure.search.documents.indexes.models.AIServicesVisionParametersazure.search.documents.indexes.models.AIServicesVisionVectorizerazure.search.documents.indexes.models.AIStudioModelCatalogNameazure.search.documents.indexes.models.AzureMachineLearningParametersazure.search.documents.indexes.models.AzureMachineLearningSkillazure.search.documents.indexes.models.AzureMachineLearningVectorizerazure.search.documents.indexes.models.CustomVectorizerazure.search.documents.indexes.models.CustomNormalizerazure.search.documents.indexes.models.DocumentKeysOrIdsazure.search.documents.indexes.models.IndexingModeazure.search.documents.indexes.models.LexicalNormalizerazure.search.documents.indexes.models.LexicalNormalizerNameazure.search.documents.indexes.models.NativeBlobSoftDeleteDeletionDetectionPolicyazure.search.documents.indexes.models.SearchIndexerCacheazure.search.documents.indexes.models.SkillNamesazure.search.documents.indexes.models.VisionVectorizeSkillSearchAlias operations do not exist in this release
SearchIndexerClient.reset_documents does not exist in this release
SearchIndexerClient.reset_skills does not exist in this release
Below properties do not exist
azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.identityazure.search.documents.indexes.models.SearchIndex.normalizersazure.search.documents.indexes.models.SearchField.normalizer_nameBelow parameters do not exist
SearchClient.search.debugSearchClient.search.hybrid_searchSearchClient.search.query_languageSearchClient.search.query_spellerSearchClient.search.semantic_fieldsSearchIndexerClient.create_or_update_indexer.skip_indexer_reset_requirement_for_cacheSearchIndexerClient.create_or_update_data_source_connection.skip_indexer_reset_requirement_for_cacheSearchIndexerClient.create_or_update_skillset.skip_indexer_reset_requirement_for_cacheSearchIndexerClient.create_or_update_indexer.disable_cache_reprocessing_change_detectionSearchIndexerClient.create_or_update_skillset.disable_cache_reprocessing_change_detection2024-07-01.SearchIndexerIndexProjectionSelector
VectorSearchAlgorithmMetricIndexProjectionModeSearchIndexerIndexProjectionsSearchIndexerIndexProjectionSelectorSearchIndexerIndexProjectionsParametersBlobIndexerDataToExtractBlobIndexerImageActionBlobIndexerParsingModeCharFilterNameCustomEntityCustomEntityAliasDataChangeDetectionPolicyDataDeletionDetectionPolicyDefaultCognitiveServicesAccountHighWaterMarkChangeDetectionPolicyHnswAlgorithmConfigurationIndexerExecutionResultIndexingParametersIndexingParametersConfigurationIndexingScheduleLexicalAnalyzerNameLexicalTokenizerNamePIIDetectionSkillPIIDetectionSkillMaskingModeScoringProfileSemanticSearchindex_projections support for SearchIndexerSkillsetThese changes do not impact the API of stable versions such as 11.3.0. Only code written against a beta version such as 11.4.0b11 may be affected.
AnswerResult to QueryAnswerResult and CaptionResult to QueryCaptionResult.SemanticErrorHandling to SemanticErrorMode.RawVectorQuery to VectorizedQuery.ExhaustiveKnnVectorSearchAlgorithmConfiguration to ExhaustiveKnnAlgorithmConfiguration.PrioritizedFields to SemanticPrioritizedFields.query_caption_highlight to query_caption_highlight_enabled.query_language and query_speller are not available for Search method in this stable release.alias operations are not available in this stable release.AzureOpenAIEmbeddingSkill, AzureOpenAIParameters and AzureOpenAIVectorizer are not available in 11.4.0.vector_search_profile to vector_search_profile_name in SearchField.SemanticSettings to SemanticSearch.Added vector_filter_mode support for Search method.
vector_filter_mode support for Search method.VectorizableTextQuery in azure.search.document.models.> These changes do not impact the API of stable versions such as 11.3.0.
These changes do not impact the API of stable versions such as 11.3.0. Only code written against a beta version such as 11.4.0b6 may be affected.
vector_search_configuration to vector_search_profile in SearchField.vectors to vector_queries in Search method.azure.search.documents.models.Vector to azure.search.documents.models.VectorQuery.V2023_07_01_PREVIEW anymore.V2023_10_01_PREVIEWFixed the bug that list type of order_by was not correctly handled. #31837
order_by was not correctly handled. #31837Exposed HnswVectorSearchAlgorithmConfiguration
HnswVectorSearchAlgorithmConfigurationThese changes do not impact the API of stable versions such as 11.3.0. Only code written against a beta version such as 11.4.0b6 may be affected.
VectorSearchAlgorithmConfiguration, now you need to use concrete types like HnswVectorSearchAlgorithmConfiguration.Added multi-vector search support. Now instead of passing in vector, top_k and vector_fields, search method accepts vectors which is a list of Vector
vector, top_k and vector_fields, search method accepts vectors which is a list of Vector object.These changes do not impact the API of stable versions such as 11.3.0. Only code written against a beta version such as 11.4.0b6 may be affected.
vector, top_k and vector_fields in SearchClient.search method.Added top_k support for VectorSearch.
top_k support for VectorSearch.Exposed azure.search.documents.models.Vector.
azure.search.documents.models.Vector.Deprecated SentimentSkillV1 and EntityRecognitionSkillV1.
VectorSearch support.SentimentSkillV1 and EntityRecognitionSkillV1.Added the semantic reranker score and captions on SearchResult.(thanks to @LucasVascovici for the contribution)
SearchResult.(thanks to @LucasVascovici for the contribution)Enabled OcrSkill and ImageAnalysisSkill
OcrSkill and ImageAnalysisSkillAdded support to create, update and delete aliases via the SearchIndexClient.
SearchIndexClient.Some of the features that were available in the 11.3.0b8 version are not available in this GA. They would be available in the upcoming beta release.
11.3.0b8 version are not available in this GA. They would be available in the upcoming beta release.search call would fail with a 403 error when retrieving large number of documents.Added support to create, update and delete aliases via the SearchIndexClient.
SearchIndexClient.Support for `AzureMachineLearningSkill`. The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AM
AzureMachineLearningSkill. The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model. Once an AML model is trained and deployed, an AML skill integrates it into AI enrichment.Added properties to SearchClient.search: semantic_configuration_name
SearchClient.search: semantic_configuration_nameSearchIndex: semantic_settingsPrioritizedFields, SemanticConfiguration, SemanticField, SemanticSettingsQueryLanguageAdded properties to SearchClient.search: session_id, scoring_statistics.
SearchClient.search: session_id, scoring_statistics.SearchIndexerDataSourceConnection: identity, encryption_key.select property to the following SearchIndexClient operations: get_synonym_maps, list_indexes.select property to the following SearchIndexersClient operations: get_data_source_connections, get_indexers, get_skillsets.SearchIndexerClient: reset_skills, reset_documents.DocumentKeysOrIdsAdded properties to SearchClient: query_answer, query_answer_count, query_caption, query_caption_highlight and semantic_fields.
SearchClient: query_answer, query_answer_count,
query_caption, query_caption_highlight and semantic_fields.SearchClient.speller to SearchClient.query_speller.Speller to QuerySpellerType.Answers to QueryAnswerType.SearchClient: answers and captions.SentimentSkill, EntityRecognitionSkill: added client-side validation to prevent sending unsupported parameters.ignore_reset_requirements to skip_indexer_reset_requirement_for_cache.azure.search.documents.models.QueryCaptionType
azure.search.documents.models.QueryCaptionTypeazure.search.documents.models.CaptionResultazure.search.documents.indexes.models.CustomEntityLookupSkillLanguageazure.search.documents.indexes.models.EntityRecognitionSkillVersionazure.search.documents.indexes.models.LexicalNormalizerNameazure.search.documents.indexes.models.PIIDetectionSkillazure.search.documents.indexes.models.PIIDetectionSkillMaskingModeazure.search.documents.indexes.models.SearchIndexerCacheazure.search.documents.indexes.models.SearchIndexerDataIdentityazure.search.documents.indexes.models.SearchIndexerDataNoneIdentityazure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentityazure.search.documents.indexes.models.SentimentSkillVersionnormalizer_name property to AnalyzeTextOptions model.azure.search.documents.indexes.models.SentimentSkillV3azure.search.documents.indexes.models.EntityRecognitionSkillV3SearchField.normalizer renamed to SearchField.normalizer_name.SentimentSkill and EntityRecognitionSkill can now be created by specifying
the skill_version keyword argument with a SentimentSkillVersion or
EntityRecognitionSkillVersion, respectively. The default behavior if skill_version
is not specified is to create a version 1 skill.Added new skills: SentimentSkillV3, EntityLinkingSkill, EntityRecognitionSkillV3
SentimentSkillV3, EntityLinkingSkill, EntityRecognitionSkillV3Added support for semantic search
Fixes a bug allowing users to set keys for cognitive service skills using the API. Exposes DefaultCognitiveServicesAccount and CognitiveServicesAccoun
DefaultCognitiveServicesAccount and CognitiveServicesAccountKeyMinor updates.
Minor updates.
This version will be the last version to officially support Python 3.5, future versions will require Python 2.7 or Python 3.6+.
This version will be the last version to officially support Python 3.5, future versions will require Python 2.7 or Python 3.6+.
New features
Added support for knowledge store #18461
Added support for semantic search #17638
Added new data source type ADLS gen2 #16852
IndexDocumentsBatch does not support enqueue_action any longer. enqueue_actions takes a single action too.
Breaking Changes
IndexDocumentsBatch does not support enqueue_action any longer. enqueue_actions takes a single action too.max_retries of SearchIndexingBufferedSender is renamed to max_retries_per_actionSearchClient does not support get_search_indexing_buffered_senderAdded get_search_indexing_buffered_sender support for SearchClient
Features
get_search_indexing_buffered_sender support for SearchClientinitial_batch_action_count support for SearchIndexingBufferedSendermax_retries support for SearchIndexingBufferedSenderRenamed SearchIndexDocumentBatchingClient to SearchIndexingBufferedSender
Breaking Changes
SearchIndexDocumentBatchingClient to SearchIndexingBufferedSenderSearchIndexDocumentBatchingClient.add_upload_actions to SearchIndexingBufferedSender.upload_documentsSearchIndexDocumentBatchingClient.add_delete_actions to SearchIndexingBufferedSender.delete_documentsSearchIndexDocumentBatchingClient.add_merge_actions to SearchIndexingBufferedSender.merge_documentsSearchIndexDocumentBatchingClient.add_merge_or_upload_actions to SearchIndexingBufferedSender.merge_or_upload_documentswindow kwargs for SearchIndexingBufferedSenderhook into on_new, on_progress, on_error, on_remove for SearchIndexingBufferedSenderFeatures
auto_flush_interval support for SearchIndexingBufferedSenderAdded azure.search.documents.RequestEntityTooLargeError
Features
azure.search.documents.RequestEntityTooLargeErrorFlush method in BatchClient now will not return until all actions are doneBreaking Changes
succeeded_actions & failed_actions from BatchClientget_index_document_batching_client from SearchClientnew SearchIndexDocumentBatchingClient
Features
SearchIndexDocumentBatchingClientSearchIndexDocumentBatchingClient supports handling document indexing actions in an automatic way. It can trigger the flush method automatically based on pending tasks and idle time.
KeyPhraseExtractionSkillLanguage
Features
Exposed more models:
Code | Docs Core - Client - Core azure-core
Code | Docs
Core - Client - Core
azure-core
Breaking Changes
Reorganized SearchServiceClient into SearchIndexClient & SearchIndexerClient #11507
Split searchindex.json and searchservice.json models and operations into separate namespaces #11508
Renamed edm to SearchFieldDataType #11511
Now Search Synonym Map creation/update returns a model #11514
Renaming #11565
Renamed DataSource methods to DataSourceConnection #11693
Autocomplete & suggest methods now takes arguments search_text & suggester_name rather than query objects #11747
Create_or_updates methods does not support partial updates #11800
Renamed AnalyzeRequest to AnalyzeTextOptions #11800
Renamed Batch methods #11800
Code | Docs Load Testing azure-developer-loadtesting
Code | Docs
Load Testing
azure-developer-loadtesting
Features
Breaking Changes
SearchIndexClient renamed to SearchClientCode | Docs FarmBeats azure-agrifood-farming
Code | Docs
FarmBeats
azure-agrifood-farming
Features
Breaking Changes
SearchApiKeyCredential and now using AzureKeyCredential from azure.core.credentials as key credentialYour coding agent can read these notes before it upgrades. Set up the MCP server →