12.1.0b1 (2026-05-28)
Features Added
-
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.KnowledgeBaseFileReference
-
Below 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.KnowledgeBaseIndexedSqlReference
-
Below 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.McpServerKnowledgeSourceParams
-
Below 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.KnowledgeBaseFabricDataAgentReference
-
Below 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.KnowledgeBaseFabricOntologyReference
-
Below 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.WorkIQKnowledgeSourceParams
-
Below 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_serving
-
Below 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_info
-
Below 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.FreshnessPolicy
-
Below 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_documents
-
Below 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_name
-
Below models are added for knowledge base activity dispatch
azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecordTypeazure.search.documents.knowledgebases.models.KnowledgeBaseReferenceType
-
Below 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.AssetStore
-
Below 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.TOKENS
-
Below properties are added for federated identity on indexer data sources
azure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.federated_identity_client_id
-
Below models are added for indexer execution diagnostics
azure.search.documents.indexes.models.IndexerExecutionStatusDetail
-
Below 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_NANO
-
Below models and properties are added for SharePoint connector configuration
azure.search.documents.indexes.models.SearchIndex.share_point_connector_app_registrationazure.search.documents.indexes.models.SharePointConnectorAppRegistration
-
Below models are added for Microsoft Entra application credentials
azure.search.documents.indexes.models.AzureActiveDirectoryApplicationCredentials
-
Below models are added for multi-resource creation responses
azure.search.documents.indexes.models.CreatedResources
-
Below 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_id
-
Below properties are added for indexer data source connection sub-typing
azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.sub_type
-
Below 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_key
-
Below 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_name
-
Below 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.PathHierarchyTokenizerV2
-
Below models are added for indexer knowledge store parameters and web API skill headers
azure.search.documents.indexes.models.SearchIndexerKnowledgeStoreParametersazure.search.documents.indexes.models.WebApiHttpHeaders
-
Below 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.SynchronizationState
-
Below models are added for richer model activity records on knowledge bases
azure.search.documents.knowledgebases.models.KnowledgeBaseModelWebSummarizationActivityRecord
-
Below 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.VectorsDebugInfo
-
Below operations are added for arbitrary REST requests
azure.search.documents.indexes.SearchIndexerClient.send_requestazure.search.documents.knowledgebases.KnowledgeBaseRetrievalClient.send_request
-
Below 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 fixedsolrconstant)
Breaking Changes
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 ofindex.serialize(), andSearchIndex(data)instead ofSearchIndex.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 includeinclude_typeless_entitiesorskill_version)azure.search.documents.indexes.models.SentimentSkill->azure.search.documents.indexes.models.SentimentSkillV3(V3 does not includeskill_version)azure.search.documents.knowledgebases.models.SharePointSensitivityLabelInfo->azure.search.documents.knowledgebases.models.PurviewSensitivityLabelInfo
-
Below 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_neighbors
-
Below 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.SHAREPOINT
-
Below models do not exist in this release
azure.search.documents.indexes.models.AIServices(moved toazure.search.documents.knowledgebases.models.AIServices)azure.search.documents.indexes.models.CompletedSynchronizationState(moved toazure.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 toazure.search.documents.knowledgebases.models.KnowledgeSourceAzureOpenAIVectorizer)azure.search.documents.indexes.models.KnowledgeSourceIngestionParameters(moved toazure.search.documents.knowledgebases.models.KnowledgeSourceIngestionParameters)azure.search.documents.indexes.models.KnowledgeSourceStatistics(moved toazure.search.documents.knowledgebases.models.KnowledgeSourceStatistics)azure.search.documents.indexes.models.KnowledgeSourceStatus(moved toazure.search.documents.knowledgebases.models.KnowledgeSourceStatus)azure.search.documents.indexes.models.KnowledgeSourceVectorizer(moved toazure.search.documents.knowledgebases.models.KnowledgeSourceVectorizer)azure.search.documents.indexes.models.PathHierarchyTokenizer(usePathHierarchyTokenizerV2instead, which is still available)azure.search.documents.indexes.models.SentimentSkillVersionazure.search.documents.indexes.models.SuggestOptionsazure.search.documents.indexes.models.SynchronizationState(moved toazure.search.documents.knowledgebases.models.SynchronizationState)azure.search.documents.knowledgebases.models.ErrorAdditionalInfo(moved toazure.search.documents.models.ErrorAdditionalInfo)azure.search.documents.knowledgebases.models.ErrorDetail(moved toazure.search.documents.models.ErrorDetail)azure.search.documents.knowledgebases.models.ErrorResponse(moved toazure.search.documents.models.ErrorResponse)azure.search.documents.knowledgebases.models.KnowledgeBaseMessageImageContentImageazure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalActivityRecordazure.search.documents.knowledgebases.models.KnowledgeSourceKind(still available asazure.search.documents.indexes.models.KnowledgeSourceKind)azure.search.documents.knowledgebases.models.RequestOptionsazure.search.documents.knowledgebases.models.SearchIndexFieldReference(still available asazure.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 bysensitivity_label_idandsensitivity_label_name)azure.search.documents.indexes.models.SearchResourceEncryptionKey.application_id(replaced byaccess_credentials)azure.search.documents.indexes.models.SearchResourceEncryptionKey.application_secret(replaced byaccess_credentials)
Other Changes
- Updated default API version to
2026-05-01-preview.