You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/search/search-api-migration.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,17 +12,19 @@ ms.custom:
12
12
- build-2024
13
13
- ignite-2024
14
14
ms.topic: conceptual
15
-
ms.date: 03/10/2025
15
+
ms.date: 05/15/2025
16
16
---
17
17
18
18
# Upgrade to the latest REST API in Azure AI Search
19
19
20
20
Use this article to migrate to newer versions of the [**Search Service REST APIs**](/rest/api/searchservice/) and the [**Search Management REST APIs**](/rest/api/searchmanagement/) for [data plane and control plane](/azure/azure-resource-manager/management/control-plane-and-data-plane) operations.
21
21
22
+
Here are the most recent versions of the REST APIs:
23
+
22
24
| Targeted operations | REST API | Status |
23
25
|---------------------|----------|--------|
24
26
| Data plane |[`2024-07-01`](/rest/api/searchservice/search-service-api-versions#2024-07-01)| Stable |
25
-
| Data plane |[`2024-11-01-preview`](/rest/api/searchservice/search-service-api-versions#2024-11-01-preview)| Preview |
27
+
| Data plane |[`2025-05-01-preview`](/rest/api/searchservice/search-service-api-versions#2025-05-01-preview&preserve-view=true)| Preview |
26
28
| Control plane |[`2023-11-01`](/rest/api/searchmanagement/operation-groups?view=rest-searchmanagement-2023-11-0&preserve-view=true1)| Stable |
27
29
| Control plane |[`2025-02-01-preview`](/rest/api/searchmanagement/operation-groups?view=rest-searchmanagement-2025-02-01-preview&preserve-view=true)| Preview |
28
30
@@ -83,11 +85,21 @@ See [Migrate from preview version](semantic-code-migration.md) to transition you
83
85
84
86
## Data plane upgrades
85
87
88
+
Upgrade guidance assumes upgrade from the most recent previous version. If your code is based on an old API version, we recommend upgrading through each successive version to get to the newest version.
89
+
90
+
### Upgrade to 2025-05-01-preview
91
+
92
+
[`2025-05-01-preview`](/rest/api/searchservice/search-service-api-versions#2025-05-01-preview) provides new features, but there are no behavior changes on existing APIs. You can swap in the new API version and your code runs the same as before.
93
+
94
+
### Upgrade to 2025-03-01-preview
95
+
96
+
[`2025-03-01-preview`](/rest/api/searchservice/search-service-api-versions#2025-03-01-preview) provides new features, but there are no behavior changes on existing APIs. You can swap in the new API version and your code runs the same as before.
97
+
86
98
### Upgrade to 2024-11-01-preview
87
99
88
100
[`2024-11-01-preview`](/rest/api/searchservice/search-service-api-versions#2024-11-01-preview) query rewrite, Document Layout skill, keyless billing for skills processing, Markdown parsing mode, and rescoring options for compressed vectors.
89
101
90
-
If you're upgrading from `2024-09-01-preview`, you can use the new preview APIs with no change to existing code.
102
+
If you're upgrading from `2024-09-01-preview`, you can swap in the new API version and your code runs the same as before.
91
103
92
104
However, the new version introduces syntax changes to `vectorSearch.compressions`:
93
105
@@ -100,7 +112,7 @@ Backwards compatibility is preserved due to an internal API mapping, but we reco
100
112
101
113
[`2024-09-01-preview`](/rest/api/searchservice/search-service-api-versions#2024-09-01-preview) adds Matryoshka Representation Learning (MRL) compression for text-embedding-3 models, targeted vector filtering for hybrid queries, vector subscore details for debugging, and token chunking for [Text Split skill](cognitive-search-skill-textsplit.md).
102
114
103
-
If you're upgrading from `2024-05-01-preview`, you can use the new preview APIs with no change to existing code.
115
+
If you're upgrading from `2024-05-01-preview`, you can swap in the new API version and your code runs the same as before.
| [**Agentic retrieval**](search-agentic-retrieval-concept.md) | Query | Create a conversational search experience powered by large language models (LLMs) and your proprietary data. Agentic retrieval breaks down complex user queries into subqueries, runs the subqueries in parallel, and extracts grounding data from documents indexed in Azure AI Search. The output is intended for agents and custom chat solutions. A new [knowledge agent](search-agentic-retrieval-how-to-create.md) object is introduced in this preview. Its [response payload](search-agentic-retrieval-how-to-retrieve.md) is designed for downstream agent and chat model consumption, with full transparency of the query plan and reference data. To get started, see [Quickstart: Agentic retrieval](search-get-started-agentic-retrieval.md). | [Knowledge Agents (preview)](/rest/api/searchservice/knowledge-agents?view=rest-searchservice-2025-05-01-preview&preserve-view=true) and [Knowledge Retrieval (preview)](/rest/api/searchservice/knowledge-retrieval?view=rest-searchservice-2025-05-01-preview&preserve-view=true)|
30
+
|[**Multivector support**](vector-search-multi-vector-fields.md)| Indexing | Index multiple child vectors within a single document field. You can now use vector types in nested fields of complex collections, effectively allowing multiple vectors to be associated with a single document.|[Create or Update Index (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true). |
31
+
|[**Scoring profiles with semantic ranking**](semantic-how-to-enable-scoring-profiles.md)| Relevance | Semantic ranker adds a new field, `@search.rerankerBoostedScore`, to help you maintain consistent relevance and greater control over final ranking outcomes in your search pipeline. |[Create or Update Index (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true). |
32
+
|[**Logic Apps integration in the portal wizard**](search-how-to-index-logic-apps-indexers.md)| Indexing | Create an automated indexing pipeline that retrieves content using a logic app workflow. Use the [Import and vectorize data wizard](search-get-started-portal-import-vectors.md) in the Azure portal to build an indexing pipeline based on Logic Apps. | Image and vectorize data wizard in the Azure portal. |
33
+
|[**Document-level access control**](search-document-level-access-overview.md)| Security | Flow document-level permissions from blobs in Azure Data Lake Storage (ADLS) Gen2 to searchable documents in an index. Queries can now filter results based on user identity for selected data sources. |[Create or Update Index (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true). |
34
+
|[**GenAI Prompt skill**](cognitive-search-skill-genai-prompt.md)| Skills | A new skill that connects to a large language model (LLM) for information, using a prompt you provide. With this skill, you can populate a searchable field using content from an LLM. A primary use case for this skill is *image verbalization*, using an LLM to describe images and send the description to a searchable field in your index. |[Create or Update Skillset (preview)](/rest/api/searchservice/skillsets/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true). |
35
+
|[**Document Layout skill**](cognitive-search-skill-document-intelligence-layout.md)| Skills | New parameters are available for this skill if you use the 2025-05-01-preview API version or later. The new parameters support image offset metadata that improves the image search experience. |[Create or Update Skillset (preview)](/rest/api/searchservice/skillsets/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true). |
36
+
|[**Index "description" support**](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true#request-body)| REST | The 2025-05-01-preview API version adds a description to an index. A description is useful in agentic solutions, where the agent reads the description to decide whether to run a query or move on to another index. |[Create or Update Index (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true). |
29
37
|[**flightingOptIn parameter in a semantic configuration**](semantic-how-to-configure.md#opt-in-for-prerelease-semantic-ranking-models)| Queries| You can opt in to use prerelease semantic ranking models if one is available in a search service region. |[Create or Update Index (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-03-01-preview&preserve-view=true). |
30
38
|[**Rescore vector queries over binary embeddings using full precision vectors**](vector-search-how-to-quantization.md#recommended-rescoring-techniques)| Relevance (scoring) | For vector indexes that contain quantized binary embeddings, you can rescore query results using a full precision query vector. The query engine uses the dot product for rescoring, which improves the quality of search results. Set `enableRescoring` and `discardOriginals` to use this feature.|[Create or Update Index (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-03-01-preview&preserve-view=true). |
31
39
|[**Facet hierarchies, aggregations, and facet filters**](search-faceted-navigation-examples.md)| Queries| New facet query parameters support nested facets. For numeric facetable fields, you can sum the values of each field. You can also specify filters on a facet to add inclusion or exclusion criteria. |[Search Documents (preview)](/rest/api/searchservice/documents/search-post?view=rest-searchservice-2025-03-01-preview&preserve-view=true). |
Copy file name to clipboardExpand all lines: articles/search/search-what-is-azure-search.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,16 +10,16 @@ ms.service: azure-ai-search
10
10
ms.custom:
11
11
- ignite-2024
12
12
ms.topic: overview
13
-
ms.date: 04/15/2025
13
+
ms.date: 05/15/2025
14
14
---
15
15
16
16
# What's Azure AI Search?
17
17
18
18
Azure AI Search ([formerly known as "Azure Cognitive Search"](whats-new.md#new-service-name)) is an enterprise-ready information retrieval system for your heterogeneous content that you ingest into a search index, and surface to users through queries and apps. It comes with a comprehensive set of advanced search technologies, built for high-performance applications at any scale.
19
19
20
-
Azure AI Search is the recommended retrieval system for building RAG-based applications on Azure, with native LLM integrations between Azure OpenAI Service and Azure Machine Learning, an integration mechanism for non-native models and processes, and multiple strategies for relevance tuning.
20
+
Azure AI Search is the recommended retrieval system for building agent-to-agent (A2A) and RAG-based applications on Azure, with native LLM integrations between Azure OpenAI Service and Azure Machine Learning, with mechanisms for integrating third-party and open-source models and processes.
21
21
22
-
Azure AI Search can be used in both traditional and GenAI search scenarios. Common use cases include catalog or document search, information discovery (data exploration), and retrieval-augmented generation (RAG) for conversational search.
22
+
Azure AI Search can be used in both traditional and generative search scenarios. Common use cases include catalog or document search, information discovery (data exploration), and retrieval-augmented generation (RAG) for conversational search.
23
23
24
24
When you create a search service, you work with the following capabilities:
Copy file name to clipboardExpand all lines: articles/search/whats-new.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,14 +28,14 @@ Learn about the latest updates to Azure AI Search functionality, docs, and sampl
28
28
|[Multivector support (preview)](vector-search-multi-vector-fields.md)| Indexing | Index multiple child vectors within a single document field. You can now use vector types in nested fields of complex collections, effectively allowing multiple vectors to be associated with a single document.|
29
29
|[Scoring profiles with semantic ranking (preview)](semantic-how-to-enable-scoring-profiles.md)| Relevance | Semantic ranker adds a new field, `@search.rerankerBoostedScore`, to help you maintain consistent relevance and greater control over final ranking outcomes in your search pipeline. |
30
30
|[Logic Apps integration (preview)](search-how-to-index-logic-apps-indexers.md)| Indexing | Create an automated indexing pipeline that retrieves content using a logic app workflow. Use the [Import and vectorize data wizard](search-get-started-portal-import-vectors.md) in the Azure portal to build an indexing pipeline based on Logic Apps. |
31
+
|[Document-level access control (preview)](search-document-level-access-overview.md)| Security | Flow document-level permissions from blobs in Azure Data Lake Storage (ADLS) Gen2 to searchable documents in an index. Queries can now filter results based on user identity for selected data sources. |
32
+
|[Multimodal search (preview)](multimodal-search-overview.md)| Indexing, Query | Ingest, understand, and retrieve documents that contain text and images, enabling you to perform searches that combine various modalities, such as querying with text to find information embedded in relevant complex images. |
31
33
|[GenAI prompt skill (preview)](cognitive-search-skill-genai-prompt.md)| Skills | A new skill that connects to a large language model (LLM) for information, using a prompt you provide. With this skill, you can populate a searchable field using content from an LLM. A primary use case for this skill is *image verbalization*, using an LLM to describe images and send the description to a searchable field in your index. |
32
-
| Import and vectorize data wizard enhancements | Portal | This wizard provides two paths for creating and populating vector indexes: Retrieval Augmented Generation (RAG) and multimodal support. Logic apps integration is through the RAG path. |
34
+
|[Document Layout skill (preview)](cognitive-search-skill-document-intelligence-layout.md)| Skills | New parameters are available for this skill if you use the 2025-05-01-preview API version. New parameters support image offset metadata that improves the image search experience. |
35
+
| Import and vectorize data wizard enhancements | Portal | This wizard provides two paths for creating and populating vector indexes: [Retrieval Augmented Generation (RAG)](search-get-started-portal-import-vectors.md) and [Multimodal](search-get-started-portal-image-search.md). Logic apps integration is through the RAG path. |
33
36
|[Index "description" support (preview)](/rest/api/searchservice/indexes/create-or-update?view=rest-searchservice-2025-05-01-preview&preserve-view=true#request-body)| REST | The latest preview API adds a description to an index. A description is useful in agentic solutions, where the agent reads the description to decide whether to run a query or move on to another index. |
34
37
|[2025-05-01-preview](/rest/api/searchservice/operation-groups?view=rest-searchservice-2025-05-01-preview&preserve-view=true)| REST | New data plane preview REST API version providing programmatic access to the preview features announced in this release. |
35
38
36
-
<!-- | [Document-level access control (preview)](search-document-level-access-overview.md) | Security | Flow document-level permissions from blobs in Azure Data Lake Storage (ADLS) Gen2 to searchable documents in an index. Queries can now filter results based on user identity for selected data sources. |
37
-
| [Multimodal search (preview)](multimodal-search-overview.md) | Indexing, Query | Ingest, understand, and retrieve documents that contain text and images, enabling you to perform searches that combine various modalities, such as querying with text to find information embedded in relevant complex images. | -->
38
-
39
39
## April 2025
40
40
41
41
| Item | Type | Description |
0 commit comments