Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Note
Azure AI Search is available through the Azure portal, REST APIs, and Azure SDKs. It also underpins Foundry IQ, the managed knowledge layer that transforms enterprise content into reusable, permission-aware knowledge bases for agents in the Microsoft Foundry portal.
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 Azure SDK client 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.
For more information about the deprecation path, see the Azure SDK lifecycle and support policy.
Deprecated versions
2023-07-01-preview was deprecated on April 8, 2024 and is no longer supported as of July 8, 2024. This version was the first REST API that offered vector search support. Newer API versions have a different vector configuration. Migrate to a newer API version or to a newer SDK version as soon as possible.
Discontinued versions
As of October 15, 2020, the following API versions are discontinued and no longer documented or supported:
- 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 API version is discontinued, the SDK packages based on it are also discontinued. All Azure AI Search .NET SDKs older than 3.0.0-rc are now obsolete.
If you have code that uses a discontinued version, migrate to a newer API version or to a newer SDK version.
REST APIs
| REST API | Link |
|---|---|
| Search Service (data plane) | See API versions in the REST API reference. |
| Search Management (control plane) | See API versions in the REST API reference. |
Azure SDK for .NET
| SDK version | Status | Changelog | Description |
|---|---|---|---|
| Azure.Search.Documents 12 | Active | Changelog | APIs for data plane operations on a service, such as read-write operations on content and objects. |
| Azure.ResourceManager.Search | Active | Changelog | APIs for control plane operations on the search service. |
Azure SDK for Java
| SDK version | Status | Changelog | Description |
|---|---|---|---|
| azure-search-documents 12 | Active | Changelog | Use the azure-search-documents client library for data plane operations. |
| azure-resourcemanager-search 2 | Active | Changelog | Use the azure-resourcemanager-search client library for control plane operations. |
Azure SDK for JavaScript
| SDK version | Status | Changelog | Description |
|---|---|---|---|
| @azure/search-documents 13 | Active | Changelog | Use the @azure/search-documents client library for data plane operations. |
| @azure/arm-search 4 | Active | Changelog | Use the @azure/arm-search package for control plane operations. |
Azure SDK for Python
| SDK version | Status | Changelog | Description |
|---|---|---|---|
| azure-search-documents 12 | Active | Changelog | Use the azure-search-documents client library for data plane operations. |
| azure-mgmt-search 9 | Active | Changelog | 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.