|
1 | 1 | # Release History |
2 | 2 |
|
3 | | -## 11.7.0b3 (Unreleased) |
| 3 | +## 12.0.0 (2026-04-01) |
4 | 4 |
|
5 | 5 | ### Features Added |
6 | 6 |
|
| 7 | +- Below clients and models are added for knowledge base support |
| 8 | + - `azure.search.documents.knowledgebases.KnowledgeBaseRetrievalClient` |
| 9 | + - `azure.search.documents.indexes.models.AzureBlobKnowledgeSource` |
| 10 | + - `azure.search.documents.indexes.models.IndexedOneLakeKnowledgeSource` |
| 11 | + - `azure.search.documents.indexes.models.KnowledgeBase` |
| 12 | + - `azure.search.documents.indexes.models.SearchIndexKnowledgeSource` |
| 13 | + - `azure.search.documents.indexes.models.WebKnowledgeSource` |
| 14 | + - `azure.search.documents.knowledgebases.models.KnowledgeRetrievalMinimalReasoningEffort` |
| 15 | + - `azure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffort` |
| 16 | + - `azure.search.documents.knowledgebases.models.KnowledgeSourceStatistics` |
| 17 | + - `azure.search.documents.knowledgebases.models.KnowledgeSourceStatus` |
| 18 | + - `azure.search.documents.knowledgebases.models.KnowledgeSourceSynchronizationError` |
| 19 | + |
| 20 | +- Below properties are added or changed for index and indexer enhancements |
| 21 | + - `azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.identity` for managed identity support on data source connections. |
| 22 | + - `azure.search.documents.indexes.models.SearchIndexerKnowledgeStore.identity` for managed identity support on knowledge store projections. |
| 23 | + - `azure.search.documents.indexes.models.SearchResourceEncryptionKey.key_version` changed from required to optional, aligning with service behavior. |
| 24 | + |
| 25 | +- Below enum members and properties are added for Markdown parsing |
| 26 | + - `azure.search.documents.indexes.models.BlobIndexerParsingMode.MARKDOWN` enum value for native Markdown file parsing in blob indexers. |
| 27 | + - `azure.search.documents.indexes.models.IndexingParametersConfiguration.markdown_header_depth` (`h1` through `h6`) to set header depth for sectioning. |
| 28 | + - `azure.search.documents.indexes.models.IndexingParametersConfiguration.markdown_parsing_submode` (`oneToOne` or `oneToMany`) to control document splitting. |
| 29 | + |
| 30 | +- Below models are added |
| 31 | + - `azure.search.documents.indexes.models.ChatCompletionCommonModelParameters` |
| 32 | + - `azure.search.documents.indexes.models.ChatCompletionResponseFormat` |
| 33 | + - `azure.search.documents.indexes.models.ChatCompletionSchema` |
| 34 | + - `azure.search.documents.indexes.models.ChatCompletionSkill` |
| 35 | + - `azure.search.documents.indexes.models.ContentUnderstandingSkill` |
| 36 | + - `azure.search.documents.indexes.models.ContentUnderstandingSkillChunkingProperties` |
| 37 | + - `azure.search.documents.indexes.models.ContentUnderstandingSkillChunkingUnit` |
| 38 | + - `azure.search.documents.indexes.models.ContentUnderstandingSkillExtractionOptions` |
| 39 | + - `azure.search.documents.knowledgebases.models.AIServices` |
| 40 | + - `azure.search.documents.knowledgebases.models.CompletedSynchronizationState` |
| 41 | + - `azure.search.documents.knowledgebases.models.SynchronizationState` |
| 42 | + |
7 | 43 | ### Breaking Changes |
8 | 44 |
|
9 | | -### Bugs Fixed |
| 45 | +- `serialize()` 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)`). |
| 46 | +- Below models do not exist in this release |
| 47 | + - `azure.search.documents.indexes.models.EntityRecognitionSkill` |
| 48 | + - `azure.search.documents.indexes.models.EntityRecognitionSkillVersion` |
| 49 | + - `azure.search.documents.indexes.models.PathHierarchyTokenizer` (renamed to `PathHierarchyTokenizerV2`) |
| 50 | + - `azure.search.documents.indexes.models.SentimentSkill` |
| 51 | + - `azure.search.documents.indexes.models.SentimentSkillVersion` |
| 52 | +- Below enum members do not exist in this release |
| 53 | + - `azure.search.documents.indexes.models.SearchIndexerDataSourceType.MY_SQL` (renamed to `MYSQL`) |
| 54 | + - `azure.search.documents.indexes.models.SearchIndexerDataSourceType.ONE_LAKE` (renamed to `ONELAKE`) |
| 55 | +- Below properties do not exist in this release |
| 56 | + - `azure.search.documents.indexes.models.BinaryQuantizationCompression.rerank_with_original_vectors` |
| 57 | + - `azure.search.documents.indexes.models.ScalarQuantizationCompression.rerank_with_original_vectors` |
| 58 | + - `azure.search.documents.indexes.models.VectorSearchCompression.rerank_with_original_vectors` |
| 59 | + |
| 60 | +> The following changes do not impact the API of stable versions such as 11.6.0. |
| 61 | +> Only code written against a beta version such as 11.7.0b2 may be affected. |
| 62 | +
|
| 63 | +- Below models do not exist in this release |
| 64 | + - `azure.search.documents.indexes.models.AIServicesVisionParameters` |
| 65 | + - `azure.search.documents.indexes.models.AIServicesVisionVectorizer` |
| 66 | + - `azure.search.documents.indexes.models.AzureMachineLearningSkill` |
| 67 | + - `azure.search.documents.indexes.models.AzureOpenAITokenizerParameters` |
| 68 | + - `azure.search.documents.indexes.models.IndexedSharePointContainerName` |
| 69 | + - `azure.search.documents.indexes.models.IndexerCurrentState` |
| 70 | + - `azure.search.documents.indexes.models.IndexerExecutionStatusDetail` |
| 71 | + - `azure.search.documents.indexes.models.IndexerPermissionOption` |
| 72 | + - `azure.search.documents.indexes.models.IndexerRuntime` |
| 73 | + - `azure.search.documents.indexes.models.IndexingMode` |
| 74 | + - `azure.search.documents.indexes.models.IndexStatisticsSummary` |
| 75 | + - `azure.search.documents.indexes.models.KnowledgeRetrievalLowReasoningEffort` |
| 76 | + - `azure.search.documents.indexes.models.KnowledgeRetrievalMediumReasoningEffort` |
| 77 | + - `azure.search.documents.indexes.models.KnowledgeRetrievalOutputMode` |
| 78 | + - `azure.search.documents.indexes.models.PermissionFilter` |
| 79 | + - `azure.search.documents.indexes.models.SearchIndexerCache` |
| 80 | + - `azure.search.documents.indexes.models.SearchIndexPermissionFilterOption` |
| 81 | + - `azure.search.documents.indexes.models.ServiceIndexersRuntime` |
| 82 | + - `azure.search.documents.indexes.models.SplitSkillEncoderModelName` |
| 83 | + - `azure.search.documents.indexes.models.SplitSkillUnit` |
| 84 | + - `azure.search.documents.indexes.models.VisionVectorizeSkill` |
| 85 | + - `azure.search.documents.knowledgebases.models.IndexedSharePointKnowledgeSourceParams` |
| 86 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseIndexedSharePointReference` |
| 87 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseModelAnswerSynthesisActivityRecord` |
| 88 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseModelQueryPlanningActivityRecord` |
| 89 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseRemoteSharePointReference` |
| 90 | + - `azure.search.documents.knowledgebases.models.RemoteSharePointKnowledgeSourceParams` |
| 91 | + - `azure.search.documents.models.DebugInfo` |
| 92 | + - `azure.search.documents.models.HybridCountAndFacetMode` |
| 93 | + - `azure.search.documents.models.HybridSearch` |
| 94 | + - `azure.search.documents.models.QueryLanguage` |
| 95 | + - `azure.search.documents.models.QueryResultDocumentInnerHit` |
| 96 | + - `azure.search.documents.models.QueryResultDocumentRerankerInput` |
| 97 | + - `azure.search.documents.models.QueryResultDocumentSemanticField` |
| 98 | + - `azure.search.documents.models.QueryRewritesDebugInfo` |
| 99 | + - `azure.search.documents.models.QueryRewritesType` |
| 100 | + - `azure.search.documents.models.QueryRewritesValuesDebugInfo` |
| 101 | + - `azure.search.documents.models.QuerySpellerType` |
| 102 | + - `azure.search.documents.models.SearchDocumentsResult` |
| 103 | + - `azure.search.documents.models.SearchScoreThreshold` |
| 104 | + - `azure.search.documents.models.SemanticDebugInfo` |
| 105 | + - `azure.search.documents.models.SemanticFieldState` |
| 106 | + - `azure.search.documents.models.SemanticQueryRewritesResultType` |
| 107 | + - `azure.search.documents.models.VectorSimilarityThreshold` |
| 108 | + - `azure.search.documents.models.VectorThreshold` |
| 109 | + - `azure.search.documents.models.VectorThresholdKind` |
| 110 | + - SharePoint knowledge source types (`IndexedSharePointKnowledgeSource`, `RemoteSharePointKnowledgeSource` and related models including `IndexedSharePointKnowledgeSourceParameters`, `RemoteSharePointKnowledgeSourceParameters`, `SharePointSensitivityLabelInfo`) |
| 111 | + |
| 112 | +- Below properties do not exist in this release |
| 113 | + - `azure.search.documents.indexes.models.ChatCompletionSkill.auth_resource_id` |
| 114 | + - `azure.search.documents.indexes.models.ChatCompletionSkill.batch_size` |
| 115 | + - `azure.search.documents.indexes.models.ChatCompletionSkill.degree_of_parallelism` |
| 116 | + - `azure.search.documents.indexes.models.ChatCompletionSkill.http_headers` |
| 117 | + - `azure.search.documents.indexes.models.ChatCompletionSkill.http_method` |
| 118 | + - `azure.search.documents.indexes.models.ChatCompletionSkill.timeout` |
| 119 | + - `azure.search.documents.indexes.models.IndexerExecutionResult.mode` |
| 120 | + - `azure.search.documents.indexes.models.IndexerExecutionResult.status_detail` |
| 121 | + - `azure.search.documents.indexes.models.KnowledgeBase.answer_instructions` |
| 122 | + - `azure.search.documents.indexes.models.KnowledgeBase.output_mode` |
| 123 | + - `azure.search.documents.indexes.models.KnowledgeBase.retrieval_instructions` |
| 124 | + - `azure.search.documents.indexes.models.KnowledgeBase.retrieval_reasoning_effort` |
| 125 | + - `azure.search.documents.indexes.models.SearchField.permission_filter` |
| 126 | + - `azure.search.documents.indexes.models.SearchField.sensitivity_label` |
| 127 | + - `azure.search.documents.indexes.models.SearchIndex.permission_filter_option` |
| 128 | + - `azure.search.documents.indexes.models.SearchIndex.purview_enabled` |
| 129 | + - `azure.search.documents.indexes.models.SearchIndexer.cache` |
| 130 | + - `azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.indexer_permission_options` |
| 131 | + - `azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.sub_type` |
| 132 | + - `azure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.federated_identity_client_id` |
| 133 | + - `azure.search.documents.indexes.models.SearchIndexerKnowledgeStore.parameters` |
| 134 | + - `azure.search.documents.indexes.models.SearchIndexerStatus.current_state` |
| 135 | + - `azure.search.documents.indexes.models.SearchIndexerStatus.runtime` |
| 136 | + - `azure.search.documents.indexes.models.SearchServiceStatistics.indexers_runtime` |
| 137 | + - `azure.search.documents.indexes.models.SemanticConfiguration.flighting_opt_in` |
| 138 | + - `azure.search.documents.indexes.models.SplitSkill.azure_open_ai_tokenizer_parameters` |
| 139 | + - `azure.search.documents.indexes.models.SplitSkill.unit` |
| 140 | + - `azure.search.documents.knowledgebases.models.AzureBlobKnowledgeSourceParams.always_query_source` |
| 141 | + - `azure.search.documents.knowledgebases.models.IndexedOneLakeKnowledgeSourceParams.always_query_source` |
| 142 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.max_output_size` |
| 143 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.messages` |
| 144 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.output_mode` |
| 145 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseRetrievalRequest.retrieval_reasoning_effort` |
| 146 | + - `azure.search.documents.knowledgebases.models.KnowledgeSourceParams.always_query_source` |
| 147 | + - `azure.search.documents.knowledgebases.models.WebKnowledgeSourceParams.always_query_source` |
| 148 | + - `azure.search.documents.models.DebugInfo.query_rewrites` |
| 149 | + - `azure.search.documents.models.DocumentDebugInfo.inner_hits` |
| 150 | + - `azure.search.documents.models.DocumentDebugInfo.semantic` |
| 151 | + - `azure.search.documents.models.FacetResult.avg` |
| 152 | + - `azure.search.documents.models.FacetResult.cardinality` |
| 153 | + - `azure.search.documents.models.FacetResult.facets` |
| 154 | + - `azure.search.documents.models.FacetResult.max` |
| 155 | + - `azure.search.documents.models.FacetResult.min` |
| 156 | + - `azure.search.documents.models.FacetResult.sum` |
| 157 | + - `azure.search.documents.models.SearchDocumentsResult.debug_info` |
| 158 | + - `azure.search.documents.models.SearchDocumentsResult.semantic_query_rewrites_result_type` |
| 159 | + - `azure.search.documents.models.VectorizableTextQuery.query_rewrites` |
| 160 | + - `azure.search.documents.models.VectorQuery.filter_override` |
| 161 | + - `azure.search.documents.models.VectorQuery.per_document_vector_limit` |
| 162 | + - `azure.search.documents.models.VectorQuery.threshold` |
| 163 | + |
| 164 | +- Below parameters do not exist in this release |
| 165 | + - `SearchClient.search.hybrid_search` |
| 166 | + - `SearchClient.search.query_language` |
| 167 | + - `SearchClient.search.query_rewrites` |
| 168 | + - `SearchClient.search.semantic_fields` |
| 169 | + - `SearchClient.search.speller` |
| 170 | + - `SearchIndexerClient.create_or_update_data_source_connection.skip_indexer_reset_requirement_for_cache` |
| 171 | + - `SearchIndexerClient.create_or_update_indexer.disable_cache_reprocessing_change_detection` |
| 172 | + - `SearchIndexerClient.create_or_update_indexer.skip_indexer_reset_requirement_for_cache` |
| 173 | + - `SearchIndexerClient.create_or_update_skillset.disable_cache_reprocessing_change_detection` |
| 174 | + - `SearchIndexerClient.create_or_update_skillset.skip_indexer_reset_requirement_for_cache` |
| 175 | + |
| 176 | +- Below operations do not exist in this release |
| 177 | + - `SearchIndexClient.list_index_stats_summary` |
| 178 | + - `SearchIndexerClient.reset_documents` |
| 179 | + - `SearchIndexerClient.reset_skills` |
| 180 | + - `SearchIndexerClient.resync` |
| 181 | + |
| 182 | +- Below enum values do not exist in this release |
| 183 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT4_O` |
| 184 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT4_O_MINI` |
| 185 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT41` |
| 186 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT41_MINI` |
| 187 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT41_NANO` |
| 188 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT5` |
| 189 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT5_MINI` (renamed to `GPT_5_MINI`) |
| 190 | + - `azure.search.documents.indexes.models.AzureOpenAIModelName.GPT5_NANO` (renamed to `GPT_5_NANO`) |
| 191 | + - `azure.search.documents.indexes.models.KnowledgeSourceKind.INDEXED_ONE_LAKE` (renamed to `INDEXED_ONELAKE`) |
| 192 | + - `azure.search.documents.indexes.models.SearchIndexerDataSourceType.SHARE_POINT` (renamed to `SHAREPOINT`) |
| 193 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseActivityRecordType.INDEXED_ONE_LAKE` (renamed to `INDEXED_ONELAKE`) |
| 194 | + - `azure.search.documents.knowledgebases.models.KnowledgeBaseReferenceType.INDEXED_ONE_LAKE` (renamed to `INDEXED_ONELAKE`) |
| 195 | + - `azure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffortKind.LOW` |
| 196 | + - `azure.search.documents.knowledgebases.models.KnowledgeRetrievalReasoningEffortKind.MEDIUM` |
| 197 | + |
| 198 | +### Deprecated |
| 199 | + |
| 200 | +The 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: |
| 201 | + |
| 202 | +- `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. |
| 203 | +- `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. |
10 | 204 |
|
11 | 205 | ### Other Changes |
12 | 206 |
|
| 207 | +- Updated default API version to `2026-04-01`. |
| 208 | +- Some boolean properties now default to `None` instead of `True` or `False`. There is no behavioral change — the server applies the same default when the property is omitted. Examples include: |
| 209 | + - `azure.search.documents.indexes.models.CommonGramTokenFilter.ignore_case` |
| 210 | + - `azure.search.documents.indexes.models.CommonGramTokenFilter.use_query_mode` |
| 211 | + - `azure.search.documents.indexes.models.DictionaryDecompounderTokenFilter.only_longest_match` |
| 212 | + - `azure.search.documents.indexes.models.KeywordMarkerTokenFilter.ignore_case` |
| 213 | + - `azure.search.documents.indexes.models.StopwordsTokenFilter.ignore_case` |
| 214 | + - `azure.search.documents.indexes.models.SynonymTokenFilter.ignore_case` |
| 215 | + |
13 | 216 | ## 11.7.0b2 (2025-11-13) |
14 | 217 |
|
15 | 218 | ### Features Added |
@@ -911,7 +1114,6 @@ This version will be the last version to officially support Python 3.5, future v |
911 | 1114 | - Create_or_updates methods does not support partial updates #11800 |
912 | 1115 | - Renamed AnalyzeRequest to AnalyzeTextOptions #11800 |
913 | 1116 | - Renamed Batch methods #11800 |
914 | | - |
915 | 1117 |
|
916 | 1118 | ## 1.0.0b3 (2020-05-04) |
917 | 1119 |
|
|
0 commit comments