API versions in Azure AI Search
Azure AI Search rolls out feature updates regularly. Sometimes, but not always, these updates require a new version of the API to preserve backward compatibility. Publishing a new version allows you to control when and how you integrate search service updates in your code.
As a rule, the REST APIs and libraries are versioned only when necessary, since it can involve some effort to upgrade your code to use a new API version. A new version is needed only if some aspect of the API has changed in a way that breaks backward compatibility. Such changes can happen because of fixes to existing features, or because of new features that change existing API surface area.
See Azure SDK lifecycle and support policy for more information about the deprecation path.
Deprecated versions
2023-07-01-preview was deprecated on April 8, 2024 and won't be supported after July 8, 2024.
This was the first REST API that offered vector search support. Newer API versions have a different vector configuration. You should migrate to a newer version as soon as possible.
Discontinued versions
Some API versions are discontinued and are rejected by a search service:
- 2015-02-28
- 2015-02-28-Preview
- 2014-07-31-Preview
- 2014-10-20-Preview
All SDKs are based on REST API versions. If a REST version is discontinued, SDK packages based on that version are also discontinued. All Azure AI Search .NET SDKs older than 3.0.0-rc are now obsolete.
Support for the above-listed versions ended on October 15, 2020. If you have code that uses a discontinued version, you can migrate existing code to a newer REST API version or to a newer Azure SDK.
REST APIs
| REST API | Link |
|---|---|
| Search Service (data plane) | See API versions in REST API reference |
| Management (control plane) | See API versions in REST API reference |
Azure SDK for .NET
The following table provides links to more recent SDK versions.
| SDK version | Status | Description |
|---|---|---|
| Azure.Search.Documents 11 | Active | New client library from the Azure .NET SDK team, initially released July 2020. See the Change Log for information about minor releases. |
| Microsoft.Azure.Search 10 | Retired | Released May 2019. This is the last version of the Microsoft.Azure.Search package and it's now deprecated. It's succeeded by Azure.Search.Documents. |
| Microsoft.Azure.Management.Search 4.0.0 | Active | Targets the Management REST api-version=2020-08-01. |
| Microsoft.Azure.Management.Search 3.0.0 | Retired | Targets the Management REST api-version=2015-08-19. |
Azure SDK for Java
| SDK version | Status | Description |
|---|---|---|
| Java azure-search-documents 11 | Active | Use the azure-search-documents client library for data plane operations. |
| Java Management Client 1.35.0 | Active | Use the azure-mgmt-search client library for control plane operations. |
Azure SDK for JavaScript
| SDK version | Status | Description |
|---|---|---|
| JavaScript @azure/search-documents 11.0 | Active | Use the @azure/search-documents client library for data plane operations. |
| JavaScript @azure/arm-search | Active | Use the @azure/arm-search client library for control plane operations. |
Azure SDK for Python
| SDK version | Status | Description |
|---|---|---|
| Python azure-search-documents 11.0 | Active | Use the azure-search-documents client library for data plane operations. |
| Python azure-mgmt-search 8.0 | Active | Use the azure-mgmt-search client library for control plane operations. |
All Azure SDKs
If you're looking for beta client libraries and documentation, this page contains links to all of the Azure SDK library packages, code, and docs.