|
1 | 1 | # Release History
|
2 | 2 |
|
3 |
| -## 11.6.0b13 (Unreleased) |
4 |
| - |
5 |
| -### Features Added |
6 |
| - |
7 |
| -- Added `azure.search.documents.models.DebugInfo`. |
8 |
| - |
9 |
| -### Breaking Changes |
10 |
| - |
11 |
| -### Bugs Fixed |
12 |
| - |
13 |
| -### Other Changes |
14 |
| - |
15 |
| -## 11.6.0b12 (2025-05-14) |
16 |
| - |
17 |
| -### Features Added |
18 |
| - |
19 |
| -- Added `azure.search.documents.agent.KnowledgeAgentRetrievalClient`. |
20 |
| -- Added knowledge agents operations in `SearchIndexClient`. |
21 |
| -- Added `resync` method in `SearchIndexerClient`. |
22 |
| -- Exposed `@search.reranker_boosted_score` in the search results. |
23 |
| -- Added `x_ms_query_source_authorization` as a keyword argument to `SearchClient.search`. |
24 |
| -- Added property `azure.search.documents.indexes.models.SearchField.permission_filter`. |
25 |
| -- Added property `azure.search.documents.indexes.models.SearchIndex.permission_filter_option`. |
26 |
| -- Added property `azure.search.documents.indexes.models.SearchIndexerDataSourceConnection.indexer_permission_options`. |
27 |
| - |
28 |
| -- Added new models: |
29 |
| - - `azure.search.documents.models.QueryResultDocumentInnerHit` |
30 |
| - - `azure.search.documents.indexes.models.ChatCompletionExtraParametersBehavior` |
31 |
| - - `azure.search.documents.indexes.models.ChatCompletionResponseFormat` |
32 |
| - - `azure.search.documents.indexes.models.ChatCompletionResponseFormatType` |
33 |
| - - `azure.search.documents.indexes.models.ChatCompletionResponseFormatJsonSchemaProperties` |
34 |
| - - `azure.search.documents.indexes.models.ChatCompletionSchema` |
35 |
| - - `azure.search.documents.indexes.models.ChatCompletionSkill` |
36 |
| - - `azure.search.documents.indexes.models.CommonModelParameters` |
37 |
| - - `azure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillChunkingProperties` |
38 |
| - - `azure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillChunkingUnit` |
39 |
| - - `azure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillExtractionOptions` |
40 |
| - - `azure.search.documents.indexes.models.DocumentIntelligenceLayoutSkillOutputFormat` |
41 |
| - - `azure.search.documents.indexes.models.IndexerPermissionOption` |
42 |
| - - `azure.search.documents.indexes.models.IndexerResyncOption` |
43 |
| - - `azure.search.documents.indexes.models.KnowledgeAgent` |
44 |
| - - `azure.search.documents.indexes.models.KnowledgeAgentAzureOpenAIModel` |
45 |
| - - `azure.search.documents.indexes.models.KnowledgeAgentModel` |
46 |
| - - `azure.search.documents.indexes.models.KnowledgeAgentModelKind` |
47 |
| - - `azure.search.documents.indexes.models.KnowledgeAgentRequestLimits` |
48 |
| - - `azure.search.documents.indexes.models.KnowledgeAgentTargetIndex` |
49 |
| - - `azure.search.documents.indexes.models.PermissionFilter` |
50 |
| - - `azure.search.documents.indexes.models.RankingOrder` |
51 |
| - - `azure.search.documents.indexes.models.SearchIndexPermissionFilterOption` |
52 |
| - |
53 |
| -### Bugs Fixed |
54 |
| - |
55 |
| -- Fixed the issue batching in upload_documents() did not work. #40157 |
56 |
| - |
57 |
| -### Other Changes |
58 |
| - |
59 |
| -- Updated the API version to "2025-05-01-preview" |
60 |
| - |
61 |
| -## 11.6.0b11 (2025-03-25) |
62 |
| - |
63 |
| -### Bugs Fixed |
64 |
| - |
65 |
| -- Fixed the issue that could not deserialize `document_debug_info`. #40138 |
66 |
| - |
67 |
| -## 11.6.0b10 (2025-03-11) |
68 |
| - |
69 |
| -### Features Added |
70 |
| - |
71 |
| -- Added `SearchIndexClient.list_index_stats_summary`. |
72 |
| -- Added `SearchIndexerCache.id`. |
73 |
| -- Added new model `azure.search.documents.indexes.models.IndexStatisticsSummary`. |
74 |
| - |
75 |
| -### Breaking Changes |
76 |
| - |
77 |
| -> These changes do not impact the API of stable versions such as 11.5.0. |
78 |
| -> Only code written against a beta version such as 11.6.0b9 may be affected. |
79 |
| -- Renamed `azure.search.documents.indexes.models.AIStudioModelCatalogName` to `azure.search.documents.indexes.models.AIFoundryModelCatalogName`. |
80 |
| - |
81 |
| -### Other Changes |
82 |
| - |
83 |
| -- Updated the API version to "2025-03-01-preview" |
84 |
| - |
85 |
| -## 11.6.0b9 (2025-01-14) |
| 3 | +## 11.5.3 (2025-06-25) |
86 | 4 |
|
87 | 5 | ### Bugs Fixed
|
88 | 6 |
|
89 |
| -- Exposed `@search.document_debug_info` in the search results. |
| 7 | +- Fixed the issue search operation did not handle 206 correctly. |
90 | 8 |
|
91 |
| -## 11.6.0b8 (2024-11-21) |
92 |
| - |
93 |
| -### Features Added |
94 |
| - |
95 |
| -- Added `get_debug_info` in Search results. |
96 |
| - |
97 |
| -## 11.6.0b7 (2024-11-18) |
98 |
| - |
99 |
| -### Features Added |
100 |
| - |
101 |
| -- Added `SearchResourceEncryptionKey`.`identity` support. |
102 |
| -- Added `query_rewrites` & `query_rewrites_count` in `SearchClient.Search`. |
103 |
| -- Added `query_rewrites` in `VectorizableTextQuery`. |
104 |
| -- Added new models: |
105 |
| - - `azure.search.documents.QueryRewritesType` |
106 |
| - - `azure.search.documents.indexes.AIServicesAccountIdentity` |
107 |
| - - `azure.search.documents.indexes.AIServicesAccountKey` |
108 |
| - - `azure.search.documents.indexes.AzureOpenAITokenizerParameters` |
109 |
| - - `azure.search.documents.indexes.DocumentIntelligenceLayoutSkillMarkdownHeaderDepth` |
110 |
| - - `azure.search.documents.indexes.DocumentIntelligenceLayoutSkillOutputMode` |
111 |
| - - `azure.search.documents.indexes.DataSourceCredentials` |
112 |
| - - `azure.search.documents.indexes.DocumentIntelligenceLayoutSkill` |
113 |
| - - `azure.search.documents.indexes.IndexerCurrentState` |
114 |
| - - `azure.search.documents.indexes.MarkdownHeaderDepth` |
115 |
| - - `azure.search.documents.indexes.MarkdownParsingSubmode` |
116 |
| - - `azure.search.documents.indexes.RescoringOptions` |
117 |
| - - `azure.search.documents.indexes.ResourceCounter` |
118 |
| - - `azure.search.documents.indexes.SkillNames` |
119 |
| - - `azure.search.documents.indexes.SplitSkillEncoderModelName` |
120 |
| - - `azure.search.documents.indexes.SplitSkillUnit` |
121 |
| - - `azure.search.documents.indexes.VectorSearchCompressionKind` |
122 |
| - - `azure.search.documents.indexes.VectorSearchCompressionRescoreStorageMethod` |
123 |
| - |
124 |
| -### Other Changes |
125 |
| - |
126 |
| -- Updated the API version to "2024-1-01-preview" |
127 |
| - |
128 |
| -11.5.2 (2024-10-31) |
129 |
| - |
130 |
| -### Bugs Fixed |
131 |
| - |
132 |
| -- Fixed the issue that encryptionKey was lost during serialization. #37521 |
133 |
| - |
134 |
| -## 11.6.0b6 (2024-10-08) |
135 |
| - |
136 |
| -### Bugs Fixed |
137 |
| - |
138 |
| -- Fixed the issue that `encryptionKey` in `SearchIndexer` was lost during serialization. #37521 |
139 |
| - |
140 |
| -## 11.6.0b5 (2024-09-19) |
141 |
| - |
142 |
| -### Features Added |
143 |
| - |
144 |
| -- `SearchIndexClient`.`get_search_client` inherits the API version. |
| 9 | +## 11.5.2 (2024-10-31) |
145 | 10 |
|
146 | 11 | ### Bugs Fixed
|
147 | 12 |
|
148 |
| -- Fixed the issue that we missed ODATA header when using Entra ID auth. |
149 |
| -- Fixed the issue that `encryptionKey` was lost during serialization. #37251 |
150 |
| - |
151 |
| -### Other Changes |
152 |
| - |
153 |
| -- Updated the API version to "2024-09-01-preview" |
154 |
| - |
155 |
| -### Breaking changes |
156 |
| - |
157 |
| -> These changes do not impact the API of stable versions such as 11.5.0. |
158 |
| -> Only code written against a beta version such as 11.6.0b4 may be affected. |
159 |
| -- Below models were renamed |
160 |
| - - `azure.search.documents.indexes.models.SearchIndexerIndexProjections` -> `azure.search.documents.indexes.models.SearchIndexerIndexProjection` |
161 |
| - - `azure.search.documents.indexes.models.LineEnding` -> `azure.search.documents.indexes.models.OrcLineEnding` |
162 |
| - - `azure.search.documents.indexes.models.ScalarQuantizationCompressionConfiguration` -> `azure.search.documents.indexes.models.ScalarQuantizationCompression` |
163 |
| - - `azure.search.documents.indexes.models.VectorSearchCompressionConfiguration` -> `azure.search.documents.indexes.models.VectorSearchCompression` |
164 |
| - - `azure.search.documents.indexes.models.VectorSearchCompressionTargetDataType` -> `azure.search.documents.indexes.models.VectorSearchCompressionTarget` |
165 |
| -- Below properties were renamed |
166 |
| - - `azure.search.documents.indexes.models.AzureMachineLearningVectorizer.name` -> `azure.search.documents.indexes.models.AzureMachineLearningVectorizer.vectorizer_name` |
167 |
| - - `azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.deployment_id` -> `azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.deployment_name` |
168 |
| - - `azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.resource_uri` -> `azure.search.documents.indexes.models.AzureOpenAIEmbeddingSkill.resource_url` |
169 |
| - - `azure.search.documents.indexes.models.AzureOpenAIVectorizer.azure_open_ai_parameters` -> `azure.search.documents.indexes.models.AzureOpenAIVectorizer.parameters` |
170 |
| - - `azure.search.documents.indexes.models.AzureOpenAIVectorizer.name` -> `azure.search.documents.indexes.models.AzureOpenAIVectorizer.vectorizer_name` |
171 |
| - - `azure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.user_assigned_identity` -> `azure.search.documents.indexes.models.SearchIndexerDataUserAssignedIdentity.resource_id` |
172 |
| - - `azure.search.documents.indexes.models.VectorSearchProfile.compression_configuration_name` -> `azure.search.documents.indexes.models.VectorSearchProfile.compression_name` |
173 |
| - - `azure.search.documents.indexes.models.VectorSearchProfile.vectorizer` -> `azure.search.documents.indexes.models.VectorSearchProfile.vectorizer_name` |
174 |
| - - `azure.search.documents.indexes.models.VectorSearchVectorizer.name` -> `azure.search.documents.indexes.models.VectorSearchVectorizer.vectorizer_name` |
| 13 | +- Fixed the issue that `encryptionKey` was lost during serialization. #37521 |
175 | 14 |
|
176 | 15 | ## 11.5.1 (2024-07-30)
|
177 | 16 |
|
|
185 | 24 |
|
186 | 25 | > These changes do not impact the API of stable versions such as 11.4.0.
|
187 | 26 | > Only code written against a beta version such as 11.6.0b4 may be affected.
|
| 27 | +
|
188 | 28 | - Below models are renamed
|
189 | 29 | - `azure.search.documents.indexes.models.SearchIndexerIndexProjections` -> `azure.search.documents.indexes.models.SearchIndexerIndexProjection`
|
190 | 30 | - `azure.search.documents.indexes.models.LineEnding` -> `azure.search.documents.indexes.models.OrcLineEnding`
|
|
500 | 340 |
|
501 | 341 | ### Features Added
|
502 | 342 |
|
503 |
| -- Support for [`AzureMachineLearningSkill`](https://learn.microsoft.com/azure/search/cognitive-search-aml-skill). The AML skill allows you to extend AI enrichment with a custom [Azure Machine Learning](https://learn.microsoft.com/azure/machine-learning/overview-what-is-azure-machine-learning) (AML) model. Once an AML model is [trained and deployed](https://learn.microsoft.com/azure/machine-learning/concept-azure-machine-learning-architecture#workspace), an AML skill integrates it into AI enrichment. |
| 343 | +- Support for [`AzureMachineLearningSkill`](https://docs.microsoft.com/azure/search/cognitive-search-aml-skill). The AML skill allows you to extend AI enrichment with a custom [Azure Machine Learning](https://docs.microsoft.com/azure/machine-learning/overview-what-is-azure-machine-learning) (AML) model. Once an AML model is [trained and deployed](https://docs.microsoft.com/azure/machine-learning/concept-azure-machine-learning-architecture#workspace), an AML skill integrates it into AI enrichment. |
504 | 344 |
|
505 | 345 | ### Other Changes
|
506 | 346 |
|
@@ -550,7 +390,7 @@ Minor updates.
|
550 | 390 |
|
551 | 391 | ### Features Added
|
552 | 392 |
|
553 |
| -- Added new models: |
| 393 | +- Added new models: |
554 | 394 | - `azure.search.documents.models.QueryCaptionType`
|
555 | 395 | - `azure.search.documents.models.CaptionResult`
|
556 | 396 | - `azure.search.documents.indexes.models.CustomEntityLookupSkillLanguage`
|
|
0 commit comments