Azure Search DataPlane 2024-07-01 (#29058)

* Copy over old spec * Update version to 07-01 * Add feature spec changes * Update docs.microsoft.com to learn.microsoft.com * Use common error response instead of our own model * Make skillsetCount required * Add additional feature changes * update readme tags * Fix error in readme * Update Examples * Running Prettier * Running Prettier * Addition feature change * Applying Feedback * Apply feedback to update Description Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> * Applying feedback on vectorizerName description change Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com> * Adding x-ms-client-name to RawVectorQuery --------- Co-authored-by: Jonathan Serbent <jserbent@microsoft.com> Co-authored-by: Alan Zimmer <48699787+alzimmermsft@users.noreply.github.com>
Azure · May 30, 2024 · dc27f9b · dc27f9b
1 parent 51031c3
commit dc27f9b
Show file tree

Hide file tree

Showing 45 changed files with 18,399 additions and 1 deletion.
diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md
@@ -26,7 +26,7 @@ These are the global settings for SearchServiceClient and SearchIndexClient.
 title: SearchClient
 opt-in-extensible-enums: true
 openapi-type: data-plane
-tag: package-2024-05-01-preview
+tag: package-2024-07-01
 
 directive:
   - where:
@@ -167,6 +167,34 @@ directive:
       - RequiredReadOnlyProperties
 ```
 
+### Tag: package-2024-07-01
+
+These settings apply only when `--tag=package-2024-07-01` is specified on the command line.
+
+``` yaml $(tag) == 'package-2024-07-01'
+input-file:
+- stable/2024-07-01/searchservice.json
+- stable/2024-07-01/searchindex.json
+```
+
+### Tag: package-2024-07-searchservice
+
+These settings apply only when `--tag=package-2024-07-searchservice` is specified on the command line.
+
+``` yaml $(tag) == 'package-2024-07-searchservice'
+input-file:
+- stable/2024-07-01/searchservice.json
+```
+
+### Tag: package-2024-07-searchindex
+
+These settings apply only when `--tag=package-2024-07-searchindex` is specified on the command line.
+
+``` yaml $(tag) == 'package-2024-07-searchindex'
+input-file:
+- stable/2024-07-01/searchindex.json
+```
+
 ### Tag: package-2024-05-01-preview
 
 These settings apply only when `--tag=package-2024-05-01-preview` is specified on the command line.

diff --git a/...ta-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsGet.json b/...ta-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsGet.json
@@ -0,0 +1,38 @@
+{
+  "parameters": {
+    "endpoint": "https://myservice.search.windows.net",
+    "indexName": "myindex",
+    "api-version": "2024-07-01",
+    "autocompleteMode": "oneTerm",
+    "search": "washington medic",
+    "suggesterName": "sg",
+    "filter": "search.in(docId,'101,102,105')",
+    "fuzzy": false,
+    "highlightPostTag": "</em>",
+    "highlightPreTag": "<em>",
+    "minimumCoverage": 80,
+    "searchFields": [
+      "title",
+      "description"
+    ],
+    "top": 10
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "text": "medicaid",
+          "queryPlusText": "washington medicaid"
+        },
+        {
+          "text": "medicare",
+          "queryPlusText": "washington medicare"
+        },
+        {
+          "text": "medicine",
+          "queryPlusText": "washington medicine"
+        }
+      ]
+    }
+  }
+}
diff --git a/...a-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsPost.json b/...a-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexAutocompleteDocumentsPost.json
@@ -0,0 +1,36 @@
+{
+  "parameters": {
+    "endpoint": "https://myservice.search.windows.net",
+    "indexName": "myindex",
+    "api-version": "2024-07-01",
+    "autocompleteRequest": {
+      "autocompleteMode": "oneTerm",
+      "search": "washington medic",
+      "suggesterName": "sg",
+      "filter": "search.in(docId,'101,102,105')",
+      "highlightPostTag": "</em>",
+      "highlightPreTag": "<em>",
+      "minimumCoverage": 80,
+      "searchFields": "title,description",
+      "top": 10
+    }
+  },
+  "responses": {
+    "200": {
+      "body": [
+        {
+          "text": "medicaid",
+          "queryPlusText": "washington medicaid"
+        },
+        {
+          "text": "medicare",
+          "queryPlusText": "washington medicare"
+        },
+        {
+          "text": "medicine",
+          "queryPlusText": "washington medicine"
+        }
+      ]
+    }
+  }
+}
diff --git a/.../search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexCountDocuments.json b/.../search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexCountDocuments.json
@@ -0,0 +1,12 @@
+{
+  "parameters": {
+    "endpoint": "https://myservice.search.windows.net",
+    "indexName": "myindex",
+    "api-version": "2024-07-01"
+  },
+  "responses": {
+    "200": {
+      "body": 427
+    }
+  }
+}
diff --git a/...ion/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexGetDocument.json b/...ion/search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexGetDocument.json
@@ -0,0 +1,25 @@
+{
+  "operationId": "Documents_Get",
+  "title": "SearchIndexGetDocument",
+  "parameters": {
+    "endpoint": "https://exampleservice.search.windows.net",
+    "indexName": "getdocumentexample",
+    "key": "1",
+    "$select": [
+      "docId",
+      "title",
+      "description"
+    ],
+    "api-version": "2024-07-01",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000"
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "docId": "1",
+        "title": "Nice Hotel",
+        "description": "Cheapest hotel in town"
+      }
+    }
+  }
+}
diff --git a/.../search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexIndexDocuments.json b/.../search/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexIndexDocuments.json
@@ -0,0 +1,96 @@
+{
+  "operationId": "Documents_Index",
+  "title": "SearchIndexIndexDocuments",
+  "parameters": {
+    "endpoint": "https://exampleservice.search.windows.net",
+    "indexName": "indexdocumentsexample",
+    "api-version": "2024-07-01",
+    "x-ms-client-request-id": "00000000-0000-0000-0000-000000000000",
+    "batch": {
+      "value": [
+        {
+          "@search.action": "upload",
+          "docId": "1",
+          "title": "Fancy Stay",
+          "description": "Best hotel in town"
+        },
+        {
+          "@search.action": "merge",
+          "docId": "2",
+          "title": "Roach Motel"
+        },
+        {
+          "@search.action": "mergeOrUpload",
+          "docId": "3",
+          "title": "Econo Motel"
+        },
+        {
+          "@search.action": "delete",
+          "docId": "4"
+        }
+      ]
+    }
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "value": [
+          {
+            "key": "1",
+            "status": true,
+            "errorMessage": null,
+            "statusCode": 200
+          },
+          {
+            "key": "2",
+            "status": true,
+            "errorMessage": null,
+            "statusCode": 200
+          },
+          {
+            "key": "3",
+            "status": true,
+            "errorMessage": null,
+            "statusCode": 200
+          },
+          {
+            "key": "4",
+            "status": true,
+            "errorMessage": null,
+            "statusCode": 200
+          }
+        ]
+      }
+    },
+    "207": {
+      "body": {
+        "value": [
+          {
+            "key": "1",
+            "status": true,
+            "errorMessage": null,
+            "statusCode": 201
+          },
+          {
+            "key": "2",
+            "status": false,
+            "errorMessage": "Document not found.",
+            "statusCode": 404
+          },
+          {
+            "key": "3",
+            "status": true,
+            "errorMessage": null,
+            "statusCode": 201
+          },
+          {
+            "key": "4",
+            "status": true,
+            "errorMessage": null,
+            "statusCode": 200
+          }
+        ]
+      }
+    }
+  }
+}
diff --git a/...rch/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsGet.json b/...rch/data-plane/Azure.Search/stable/2024-07-01/examples/SearchIndexSearchDocumentsGet.json
@@ -0,0 +1,86 @@
+{
+  "parameters": {
+    "endpoint": "https://myservice.search.windows.net",
+    "indexName": "myindex",
+    "api-version": "2024-07-01",
+    "$count": true,
+    "facet": [
+      "category,count:10,sort:count"
+    ],
+    "$filter": "rating gt 10",
+    "highlight": [
+      "title"
+    ],
+    "highlightPostTag": "</em>",
+    "highlightPreTag": "<em>",
+    "minimumCoverage": 80,
+    "$orderby": [
+      "search.score() desc",
+      "rating desc"
+    ],
+    "queryType": "simple",
+    "sessionId": "mysessionid",
+    "scoringStatistics": "global",
+    "scoringParameters": [
+      "currentLocation--122.123,44.77233"
+    ],
+    "scoringProfile": "sp",
+    "search": "nice hotels",
+    "searchFields": [
+      "title",
+      "description"
+    ],
+    "searchMode": "any",
+    "$select": [
+      "docId",
+      "title",
+      "description"
+    ],
+    "$skip": 100,
+    "$top": 10
+  },
+  "responses": {
+    "200": {
+      "body": {
+        "@odata.count": 25,
+        "@search.coverage": 80,
+        "@search.facets": {
+          "category": [
+            {
+              "count": 1,
+              "value": "Economy"
+            },
+            {
+              "count": 1,
+              "value": "Luxury"
+            }
+          ]
+        },
+        "value": [
+          {
+            "@search.score": 1.50,
+            "@search.highlights": {
+              "title": [
+                "<em>Nice</em> <em>Hotel</em>"
+              ]
+            },
+            "description": "Cheapest hotel in town",
+            "docId": "1",
+            "title": "Nice Hotel"
+          },
+          {
+            "@search.score": 0.70,
+            "@search.highlights": {
+              "title": [
+                "Fancy <em>Hotel</em>"
+              ]
+            },
+            "description": "Best hotel in town",
+            "docId": "2",
+            "title": "Fancy Hotel"
+          }
+        ]
+      }
+    }
+  }
+}