API version updates

Author: HeidiSteen

articles/search/search-api-migration.md

@@ -26,7 +26,7 @@ Upgrade instructions focus on code changes that get you through breaking changes
 
 We recommend upgrading API versions in succession, working through each version until you get to the newest one.
 
-`2023-07-01-preview` was the first REST API for vector support. *Do not use this API version*. It's now deprecated and you should migrate to either stable or newer preview REST APIs immediately.
+`2023-07-01-preview` was the first REST API for vector support. **Do not use this API version**. It's now deprecated and you should migrate to either stable or newer preview REST APIs immediately.
 
 > [!NOTE]
 > REST API reference docs are now versioned. For version-specific content, open a reference page and then use the selector located to the right, above the table of contents, to pick your version.
@@ -35,7 +35,7 @@ We recommend upgrading API versions in succession, working through each version
 
 Azure AI Search breaks backward compatibility as a last resort. Upgrade is necessary when:
 
-+ Your code references a retired or deprecated API version and is subject to one or more breaking changes. You must address breaking changes if your code targets [`2023-07-10-preview`](#code-upgrade-for-vector-indexes-and-queries) for vectors, [`2020-06-01-preview`](#breaking-change-for-semantic-ranking) for semantic ranking, and [`2019-05-06`](#upgrade-to-2019-05-06) for obsolete skills and workarounds. 
++ Your code references a retired or unsupported API version and is subject to one or more breaking changes. You must address breaking changes if your code targets [`2023-07-10-preview`](#code-upgrade-for-vector-indexes-and-queries) for vectors, [`2020-06-01-preview`](#breaking-change-for-semantic-ranking) for semantic ranking, and [`2019-05-06`](#upgrade-to-2019-05-06) for obsolete skills and workarounds. 
 
 + Your code fails when unrecognized properties are returned in an API response. As a best practice, your application should ignore properties that it doesn't understand.
 

articles/search/search-api-preview.md

@@ -10,12 +10,12 @@ ms.service: cognitive-search
 ms.custom:
   - build-2024
 ms.topic: conceptual
-ms.date: 06/11/2024
+ms.date: 06/25/2024
 ---
 
 # Preview features in Azure AI Search
 
-This article identifies all features in public preview. This list is helpful for checking feature status.
+This article identifies all data plane and control plane features in public preview. This list is helpful for checking feature status. It also provides usage guidance and reminders to always upgrade to newer preview API versions as they roll out.
 
 Preview features are removed from this list if they're retired or transition to general availability. For announcements regarding general availability and retirement, see [Service Updates](https://azure.microsoft.com/updates/?product=search) or [What's New](whats-new.md).
 
@@ -52,7 +52,7 @@ Preview features are removed from this list if they're retired or transition to
 
 |Feature                          | Category | Description | Availability  |
 |---------|------------------|-------------|---------------|
-| [**User-assigned managed identity**](search-howto-managed-identities-data-sources.md) | Service | Configures a search service to use a previously created user-assigned managed identity. | [Services - Update](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity), 2021-04-01-preview or a later. |
+| [**Search service under a user-assigned managed identity**](search-howto-managed-identities-data-sources.md) | Service | Configures a search service to use a previously created user-assigned managed identity. | [Services - Update](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true#identity), 2021-04-01-preview or a later. |
 
 ## Preview features in Azure SDKs
 
@@ -73,29 +73,30 @@ The following statements apply to preview features:
 + Preview features might undergo breaking changes if a redesign is required. 
 + Sometimes preview features don't make it into a GA release.
 
+If you write code against a preview API, you should prepare to upgrade that code to newer API versions when they roll out. We maintain an [Upgrade REST APIs](search-api-migration.md) document to make that step easier.
+
 ## How to call a preview REST API
 
 Preview REST APIs are accessed through the api-version parameter on the URI. Older previews are still operational but become stale over time and aren't updated with new features or bug fixes.
 
-For content operations, [**`2023-10-01-Preview`**](/rest/api/searchservice/search-service-api-versions#2023-10-01-Preview) is the most recent preview version. The following example shows the syntax for [Search POST (preview)](/rest/api/searchservice/documents/search-post?view=rest-searchservice-2023-10-01-preview&preserve-view=true):
+For data plane operation on content, [**`2024-05-01-preview`**](/rest/api/searchservice/search-service-api-versions#2024-05-01-Preview) is the most recent preview version. The following example shows the syntax for [Indexes GET (preview)](/rest/api/searchservice/indexes/get?view=rest-searchservice-2024-05-01-preview&preserve-view=true):
 
 ```rest
-GET {endpoint}/indexes('{indexName}')?api-version=2023-10-01-Preview
+GET {endpoint}/indexes('{indexName}')?api-version=2024-05-01-Preview
 ```
 
-For management operations, [**`2021-04-01-Preview`**](/rest/api/searchmanagement/management-api-versions#2021-04-01-Preview) is the most recent preview version. The following example shows the syntax for Update Service 2021-04-01-preview version.
+For management operations on the search service, [**`2024-06-01-preview`**](/rest/api/searchmanagement/services/update?view=rest-searchmanagement-2024-06-01-preview&preserve-view=true) is the most recent preview version. The following example shows the syntax for Update Service 2024-06-01-preview version.
 
 ```rest
-PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Search/searchServices/{searchServiceName}?api-version=2021-04-01-preview
+PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Search/searchServices/mysearchservice?api-version=2024-06-01-preview
+
 {
-  "location": "{{region}}",
-  "sku": {
-    "name": "basic"
+  "tags": {
+    "app-name": "My e-commerce app",
+    "new-tag": "Adding a new tag"
   },
   "properties": {
-    "replicaCount": 3,
-    "partitionCount": 1,
-    "hostingMode": "default"
+    "replicaCount": 2
   }
 }
 ```

articles/search/search-api-versions.md

@@ -14,7 +14,7 @@ ms.custom:
   - devx-track-python
   - ignite-2023
 ms.topic: conceptual
-ms.date: 04/17/2024
+ms.date: 06/24/2024
 ---
 
 # API versions in Azure AI Search
@@ -27,13 +27,15 @@ See [Azure SDK lifecycle and support policy](https://azure.github.io/azure-sdk/p
 
 ## Deprecated versions
 
-**2023-07-01-preview** was deprecated on April 8, 2024 and will be retired on July 8, 2024. This was the first REST API that offered vector search support. Newer API versions have a different vector configuration. We recommend [migrating to a newer version](search-api-migration.md) as soon as possible.
+**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](search-api-migration.md) as soon as possible.
 
 <a name="unsupported-versions"></a>
 
-## Unsupported versions
+## Discontinued versions
 
-Some API versions are discontinued and will be rejected by a search service:
+Some API versions are discontinued and are rejected by a search service:
 
 + **2015-02-28**
 + **2015-02-28-Preview**
@@ -85,4 +87,4 @@ The following  table provides links to more recent SDK versions.
 
 ## All Azure SDKs
 
-If you are looking for beta client libraries and documentation, [this page](https://azure.github.io/azure-sdk/releases/latest/index.html) contains links to all of the Azure SDK library packages, code, and docs. 
+If you're looking for beta client libraries and documentation, [this page](https://azure.github.io/azure-sdk/releases/latest/index.html) contains links to all of the Azure SDK library packages, code, and docs. 

articles/search/search-monitor-queries.md

@@ -86,7 +86,7 @@ When you enable resource logging, the system captures query requests in the **Az
       AzureDiagnostics
    | project OperationName, Query_s, IndexName_s, Documents_d
    | where OperationName == "Query.Search"
-   | where Query_s != "?api-version=2023-07-01-preview&search=*"
+   | where Query_s != "?api-version=2023-11-01&search=*"
    | where IndexName_s != "realestate-us-sample-index"
    ```
 

articles/search/vector-search-filters.md

@@ -42,7 +42,7 @@ To understand the conditions under which one filter mode performs better than th
 
 For the small and medium workloads, we used a Standard 2 (S2) service with one partition and one replica. For the large workload, we used a Standard 3 (S3) service with 12 partitions and one replica.
 
-Indexes had an identical construction: one key field, one vector field, one text field, and one numeric filterable field. The following index is defined using the 2023-07-01-preview syntax.
+Indexes had an identical construction: one key field, one vector field, one text field, and one numeric filterable field. The following index is defined using the 2023-11-03 syntax.
 
 ```python
 def get_index_schema(self, index_name, dimensions):
@@ -52,18 +52,27 @@ def get_index_schema(self, index_name, dimensions):
             {"name": "id", "type": "Edm.String", "key": True, "searchable": True},
             {"name": "content_vector", "type": "Collection(Edm.Single)", "dimensions": dimensions,
               "searchable": True, "retrievable": True, "filterable": False, "facetable": False, "sortable": False,
-              "vectorSearchConfiguration": "defaulthnsw"},
+              "vectorSearchProfile": "defaulthnsw"},
             {"name": "text", "type": "Edm.String", "searchable": True, "filterable": False, "retrievable": True,
               "sortable": False, "facetable": False},
             {"name": "score", "type": "Edm.Double", "searchable": False, "filterable": True,
               "retrievable": True, "sortable": True, "facetable": True}
         ],
-        "vectorSearch":
-        {
-            "algorithmConfigurations": [
-                {"name": "defaulthnsw", "kind": "hnsw", "hnswParameters": {"metric": "euclidean"}}
-            ]
-        }
+      "vectorSearch": {
+        "algorithms": [
+            {
+              "name": "defaulthnsw",
+              "kind": "hnsw",
+              "hnswParameters": { "metric": "euclidean" }
+            }
+          ],
+          "profiles": [
+            {
+              "name": "defaulthnsw",
+              "algorithm": "defaulthnsw"
+            }
+        ]
+      }
     }
 ```
 

articles/search/whats-new.md

@@ -53,7 +53,7 @@ ms.custom:
 | [**Vector quantization, narrow vector data types, and a new `stored` property (preview)**](vector-search-how-to-configure-compression-storage.md) | Feature | Collectively, these three features add vector compression and smarter storage options. First, *scalar quantization* reduces vector index size in memory and on disk. Second, [narrow data types](/rest/api/searchservice/supported-data-types) reduce per-field storage by storing smaller values. Third, you can use `stored` to opt-out of storing the extra copy of a vector that's used only for search results. If you don't need vectors in a query response, you can set `stored` to false to save on space. |
 | [**2024-03-01-preview Search REST API**](/rest/api/searchservice/search-service-api-versions#2024-03-01-preview) | API | New preview version of the Search REST APIs for the new data types, vector compression properties, and vector storage options. |
 | [**2024-03-01-preview Management REST API**](/rest/api/searchmanagement/operation-groups?view=rest-searchmanagement-2024-03-01-preview&preserve-view=true) | API | New preview version of the Management REST APIs for control plane operations.  |
-| [**2023-07-01-preview deprecation announcement**](/rest/api/searchservice/search-service-api-versions#2023-07-01-preview) | API | Deprecation announced on April 8, 2024. Retirement on July 8, 2024. This was the first REST API that offered vector search support. Newer API versions have a different vector configuration. We recommend [migrating to a newer version](search-api-migration.md) as soon as possible. |
+| [**2023-07-01-preview deprecation announcement**](/rest/api/searchservice/search-service-api-versions#2023-07-01-preview) | API | Deprecation announced on April 8, 2024. It becomes unsupported on 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](search-api-migration.md) as soon as possible. |
 
 ## February 2024