Search tsp

cspell.yaml

@@ -1,4 +1,4 @@
 version: '0.2'
 language: en
 flagWords:
   - teh
@@ -35,6 +35,7 @@
   - byos
   - cadl
   - contoso
+  - discretizing
   - eastus
   - entra
   - fqdns
@@ -48,6 +49,7 @@
   - onboarded
   - payg
   - regen
+  - rerank
   - rpaas
   - skus
   - vmss

specification/search/Azure.Search.Index/examples/2024-07-01/SearchIndexAutocompleteDocumentsGet.json

@@ -0,0 +1,40 @@
+{
+  "operationId": "Documents_AutocompleteGet",
+  "title": "SearchIndexAutocompleteDocumentsGet",
+  "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"
+        }
+      ]
+    }
+  }
+}

specification/search/Azure.Search.Index/examples/2024-07-01/SearchIndexAutocompleteDocumentsPost.json

@@ -0,0 +1,38 @@
+{
+  "operationId": "Documents_AutocompletePost",
+  "title": "SearchIndexAutocompleteDocumentsPost",
+  "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"
+        }
+      ]
+    }
+  }
+}

specification/search/Azure.Search.Index/examples/2024-07-01/SearchIndexCountDocuments.json

@@ -0,0 +1,14 @@
+{
+  "operationId": "Documents_Count",
+  "title": "SearchIndexCountDocuments",
+  "parameters": {
+    "endpoint": "https://myservice.search.windows.net",
+    "indexName": "myindex",
+    "api-version": "2024-07-01"
+  },
+  "responses": {
+    "200": {
+      "body": 427
+    }
+  }
+}

specification/search/Azure.Search.Index/examples/2024-07-01/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"
+      }
+    }
+  }
+}

specification/search/Azure.Search.Index/examples/2024-07-01/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
+          }
+        ]
+      }
+    }
+  }
+}

specification/search/Azure.Search.Index/examples/2024-07-01/SearchIndexSearchDocumentsGet.json

@@ -0,0 +1,88 @@
+{
+  "operationId": "Documents_SearchGet",
+  "title": "SearchIndexSearchDocumentsGet",
+  "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"
+          }
+        ]
+      }
+    }
+  }
+}