diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexIndexDocuments.json
new file mode 100644
index 000000000000..076914f9ebc2
--- /dev/null
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexIndexDocuments.json
@@ -0,0 +1,94 @@
+{
+ "parameters": {
+ "searchServiceName": "myservice",
+ "searchDnsSuffix": "search.windows.net",
+ "indexName": "myindex",
+ "api-version": "2017-11-11-Preview",
+ "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": 201
+ },
+ {
+ "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": 200
+ },
+ {
+ "key": "2",
+ "status": false,
+ "errorMessage": "Document not found.",
+ "statusCode": 404
+ },
+ {
+ "key": "3",
+ "status": true,
+ "errorMessage": null,
+ "statusCode": 200
+ },
+ {
+ "key": "4",
+ "status": true,
+ "errorMessage": null,
+ "statusCode": 200
+ }
+ ]
+ }
+ }
+ }
+}
diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexSuggestDocumentsGet.json
new file mode 100644
index 000000000000..22fd6cc70f26
--- /dev/null
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexSuggestDocumentsGet.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "searchServiceName": "myservice",
+ "searchDnsSuffix": "search.windows.net",
+ "indexName": "myindex",
+ "api-version": "2017-11-11-Preview",
+ "$filter": "rating gt 10",
+ "fuzzy": false,
+ "highlightPostTag": "",
+ "highlightPreTag": "",
+ "minimumCoverage": 80,
+ "$orderby": ["search.score() desc", "rating desc"],
+ "search": "hote",
+ "searchFields": ["title"],
+ "suggesterName": "sg",
+ "$select": ["docId", "title", "description"],
+ "$top": 10
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "@search.text": "Nice Hotel",
+ "description": "Cheapest hotel in town",
+ "docId": "1",
+ "title": "Nice Hotel"
+ },
+ {
+ "@search.text": "Fancy Hotel",
+ "description": "Best hotel in town",
+ "docId": "2",
+ "title": "Fancy Hotel"
+ }
+ ]
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexSuggestDocumentsPost.json
new file mode 100644
index 000000000000..4802b4f82f20
--- /dev/null
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/examples/SearchIndexSuggestDocumentsPost.json
@@ -0,0 +1,39 @@
+{
+ "parameters": {
+ "searchServiceName": "myservice",
+ "searchDnsSuffix": "search.windows.net",
+ "indexName": "myindex",
+ "api-version": "2017-11-11-Preview",
+ "suggestRequest": {
+ "filter": "rating gt 4.0",
+ "highlightPostTag": "",
+ "highlightPreTag": "",
+ "minimumCoverage": 80,
+ "orderby": "rating desc",
+ "search": "hote",
+ "searchFields": "title",
+ "select": "docId,title,description",
+ "top": 10
+ }
+ },
+ "responses": {
+ "200": {
+ "body": {
+ "value": [
+ {
+ "@search.text": "Nice Hotel",
+ "description": "Cheapest hotel in town",
+ "docId": "1",
+ "title": "Nice Hotel"
+ },
+ {
+ "@search.text": "Fancy Hotel",
+ "description": "Best hotel in town",
+ "docId": "2",
+ "title": "Fancy Hotel"
+ }
+ ]
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json
index f9b1ff57fcc8..8fd07f00ae32 100644
--- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2017-11-11-preview/searchindex.json
@@ -86,7 +86,7 @@
"type": "string"
},
{
- "name":"$select",
+ "name": "$select",
"in": "query",
"type": "array",
"items": {
@@ -104,7 +104,7 @@
],
"responses": {
"200": {
- "description": "",
+ "description": "Response containing the requested document.",
"schema": {
"type": "object"
}
@@ -112,7 +112,237 @@
}
}
},
- "/docs/autocomplete": {
+ "/docs/search.suggest": {
+ "get": {
+ "tags": [
+ "Documents"
+ ],
+ "operationId": "Documents_SuggestGet",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions"
+ },
+ "x-ms-examples": {
+ "SearchIndexSuggestDocumentsGet": { "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" }
+ },
+ "description": "Suggests documents in the Azure Search index that match the given partial query text.",
+ "parameters": [
+ {
+ "name": "search",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.",
+ "x-ms-client-name": "searchText"
+ },
+ {
+ "name": "suggesterName",
+ "in": "query",
+ "required": true,
+ "type": "string",
+ "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition."
+ },
+ {
+ "name": "$filter",
+ "in": "query",
+ "type": "string",
+ "description": "An OData expression that filters the documents considered for suggestions.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "fuzzy",
+ "in": "query",
+ "type": "boolean",
+ "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.",
+ "x-ms-client-name": "UseFuzzyMatching",
+ "x-nullable": false,
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "highlightPostTag",
+ "in": "query",
+ "type": "string",
+ "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "highlightPreTag",
+ "in": "query",
+ "type": "string",
+ "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "minimumCoverage",
+ "in": "query",
+ "type": "number",
+ "format": "double",
+ "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "$orderby",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "x-ms-client-name": "OrderBy",
+ "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "searchFields",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The list of comma-separated field names to search for the specified search text. Target fields must be included in the specified suggester.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "$select",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "name": "$top",
+ "in": "query",
+ "type": "integer",
+ "format": "int32",
+ "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.",
+ "x-ms-parameter-grouping": {
+ "name": "SuggestParameters"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestIdParameter"
+ }
+ ],
+ "x-ms-request-id": "request-id",
+ "responses": {
+ "200": {
+ "description": "Response containing suggested documents that match the partial input.",
+ "schema": {
+ "$ref": "#/definitions/DocumentSuggestResult"
+ }
+ }
+ }
+ }
+ },
+ "/docs/search.post.suggest": {
+ "post": {
+ "tags": [
+ "Documents"
+ ],
+ "operationId": "Documents_SuggestPost",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions"
+ },
+ "x-ms-examples": {
+ "SearchIndexSuggestDocumentsPost": { "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" }
+ },
+ "description": "Suggests documents in the Azure Search index that match the given partial query text.",
+ "parameters": [
+ {
+ "name": "suggestRequest",
+ "in": "body",
+ "required": true,
+ "description": "The Suggest request.",
+ "schema": {
+ "$ref": "#/definitions/SuggestRequest"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestIdParameter"
+ }
+ ],
+ "x-ms-request-id": "request-id",
+ "responses": {
+ "200": {
+ "description": "Response containing suggested documents that match the partial input.",
+ "schema": {
+ "$ref": "#/definitions/DocumentSuggestResult"
+ }
+ }
+ }
+ }
+ },
+ "/docs/search.index": {
+ "post": {
+ "tags": [
+ "Document"
+ ],
+ "operationId": "Documents_Index",
+ "externalDocs": {
+ "url": "https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents"
+ },
+ "x-ms-examples": {
+ "SearchIndexIndexDocuments": { "$ref": "./examples/SearchIndexIndexDocuments.json" }
+ },
+ "description": "Sends a batch of document write actions to the Azure Search index.",
+ "parameters": [
+ {
+ "name": "batch",
+ "in": "body",
+ "description": "The batch of index actions.",
+ "required": true,
+ "schema": {
+ "$ref": "#/definitions/IndexBatch"
+ }
+ },
+ {
+ "$ref": "#/parameters/ApiVersionParameter"
+ },
+ {
+ "$ref": "#/parameters/ClientRequestIdParameter"
+ }
+ ],
+ "x-ms-request-id": "request-id",
+ "responses": {
+ "200": {
+ "description": "Response containing the status of operations for all actions in the batch.",
+ "schema": {
+ "$ref": "#/definitions/DocumentIndexResult"
+ }
+ },
+ "207": {
+ "description": "Response containing the status of operations for all actions in the batch.",
+ "schema": {
+ "$ref": "#/definitions/DocumentIndexResult"
+ }
+ }
+ }
+ }
+ },
+ "/docs/search.autocomplete": {
"get": {
"tags": [
"Documents"
@@ -133,7 +363,7 @@
"$ref": "#/parameters/ApiVersionParameter"
},
{
- "name":"search",
+ "name": "search",
"in": "query",
"type": "string",
"required": true,
@@ -141,7 +371,7 @@
"x-ms-client-name": "searchText"
},
{
- "name":"suggesterName",
+ "name": "suggesterName",
"in": "query",
"type": "string",
"required": true,
@@ -166,35 +396,35 @@
}
},
{
- "name":"fuzzy",
+ "name": "fuzzy",
"in": "query",
"type": "boolean",
- "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.",
+ "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.",
"x-ms-client-name": "UseFuzzyMatching",
"x-ms-parameter-grouping": {
"name": "AutocompleteParameters"
}
},
{
- "name":"highlightPostTag",
+ "name": "highlightPostTag",
"in": "query",
"type": "string",
- "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting is disabled.",
+ "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.",
"x-ms-parameter-grouping": {
"name": "AutocompleteParameters"
}
},
{
- "name":"highlightPreTag",
+ "name": "highlightPreTag",
"in": "query",
"type": "string",
- "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting is disabled.",
+ "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.",
"x-ms-parameter-grouping": {
"name": "AutocompleteParameters"
}
},
{
- "name":"minimumCoverage",
+ "name": "minimumCoverage",
"in": "query",
"type": "number",
"format": "double",
@@ -204,23 +434,23 @@
}
},
{
- "name":"searchFields",
+ "name": "searchFields",
"in": "query",
"type": "array",
"items": {
"type": "string"
},
- "description": "The comma-separated list of field names to consider when querying for auto-completed terms.",
+ "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.",
"x-ms-parameter-grouping": {
"name": "AutocompleteParameters"
}
},
{
- "name":"$top",
+ "name": "$top",
"in": "query",
"type": "integer",
"format": "int32",
- "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is to 5.",
+ "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.",
"x-ms-parameter-grouping": {
"name": "AutocompleteParameters"
}
@@ -236,7 +466,9 @@
}
}
}
- },
+ }
+ },
+ "/docs/search.post.autocomplete": {
"post": {
"tags": [
"Documents"
@@ -261,8 +493,7 @@
"in": "body",
"required": true,
"schema": {
- "$ref": "#/definitions/AutocompleteRequest",
- "description": "The Autocomplete request."
+ "$ref": "#/definitions/AutocompleteRequest"
},
"description": "The definition of the Autocomplete request."
}
@@ -281,6 +512,71 @@
}
},
"definitions": {
+ "DocumentSuggestResult": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/SuggestResult"
+ },
+ "x-ms-client-name": "Results",
+ "description": "The sequence of results returned by the query."
+ },
+ "@search.coverage": {
+ "type": "number",
+ "format": "double",
+ "x-ms-client-name": "Coverage",
+ "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request."
+ }
+ },
+ "description": "Response containing suggestion query results from an Azure Search index."
+ },
+ "SuggestResult": {
+ "type": "object",
+ "properties": {
+ "@search.text": {
+ "type": "string",
+ "description": "The text of the suggestion result.",
+ "x-ms-client-name": "Text"
+ }
+ },
+ "additionalProperties": true,
+ "description": "A result containing a document found by a suggestion query, plus associated metadata."
+ },
+ "IndexBatch": {
+ "properties": {
+ "value": {
+ "type": "array",
+ "items": {
+ "$ref": "#/definitions/IndexAction"
+ },
+ "description": "The actions in the batch.",
+ "x-ms-client-name": "Actions"
+ }
+ },
+ "required": ["value"],
+ "description": "Contains a batch of document write actions to send to the Azure Search index."
+ },
+ "IndexAction": {
+ "properties": {
+ "@search.action": {
+ "type": "string",
+ "enum": [
+ "upload",
+ "merge",
+ "mergeOrUpload",
+ "delete"
+ ],
+ "x-ms-enum": { "name": "IndexActionType" },
+ "x-ms-client-name": "ActionType",
+ "x-nullable": false,
+ "description": "The operation to perform on a document in an indexing batch."
+ }
+ },
+ "additionalProperties": true,
+ "description": "Represents an index action that operates on a document."
+ },
"IndexingResult": {
"properties": {
"key": {
@@ -324,17 +620,6 @@
},
"description": "Response containing the status of operations for all documents in the indexing request."
},
- "IndexActionType": {
- "type": "string",
- "enum": [
- "upload",
- "merge",
- "mergeOrUpload",
- "delete"
- ],
- "x-ms-enum": { "name": "IndexActionType" },
- "description": "Specifies the operation to perform on a document in an indexing batch."
- },
"SearchMode": {
"type": "string",
"enum": [
@@ -364,7 +649,7 @@
"modelAsString" : false },
"description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms."
},
- "SearchParametersPayload": {
+ "SearchRequest": {
"properties": {
"count": {
"type": "boolean",
@@ -393,11 +678,11 @@
},
"highlightPostTag": {
"type": "string",
- "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. Default is </em>."
+ "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>."
},
"highlightPreTag": {
"type": "string",
- "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. Default is <em>."
+ "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>."
},
"minimumCoverage": {
"type": "number",
@@ -407,7 +692,7 @@
"orderby": {
"x-ms-client-name": "OrderBy",
"type": "string",
- "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses."
+ "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses."
},
"queryType": {
"$ref": "#/definitions/QueryType",
@@ -446,7 +731,7 @@
"skip": {
"type": "integer",
"format": "int32",
- "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use Skip due to this limitation, consider using OrderBy on a totally-ordered key and Filter with a range query instead."
+ "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use Skip due to this limitation, consider using $orderby on a totally-ordered key and Filter with a range query instead."
},
"top": {
"externalDocs": {
@@ -459,26 +744,26 @@
},
"description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors."
},
- "SuggestParametersPayload": {
+ "SuggestRequest": {
"properties": {
"filter": {
"externalDocs": {
"url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search"
},
"type": "string",
- "description": "The OData $filter expression to apply to the suggestions query."
+ "description": "An OData expression that filters the documents considered for suggestions."
},
"fuzzy": {
"type": "boolean",
- "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources."
+ "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources."
},
"highlightPostTag": {
"type": "string",
- "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting of suggestions is disabled."
+ "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled."
},
"highlightPreTag": {
"type": "string",
- "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting of suggestions is disabled."
+ "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled."
},
"minimumCoverage": {
"type": "number",
@@ -488,19 +773,19 @@
"orderby": {
"x-ms-client-name": "OrderBy",
"type": "string",
- "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 Orderby clauses."
+ "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses."
},
"search": {
"type": "string",
- "description": "The search text on which to base suggestions."
+ "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters."
},
"searchFields": {
"type": "string",
- "description": "The comma-separated list of field names to consider when querying for suggestions."
+ "description": "The list of comma-separated field names to search for the specified search text. Target fields must be included in the specified suggester."
},
"select": {
"type": "string",
- "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included."
+ "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results."
},
"suggesterName": {
"type": "string",
@@ -509,7 +794,7 @@
"top": {
"type": "integer",
"format": "int32",
- "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is to 5."
+ "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5."
}
},
"description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors."
@@ -527,16 +812,16 @@
},
"fuzzy": {
"type": "boolean",
- "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.",
+ "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.",
"x-ms-client-name": "UseFuzzyMatching"
},
"highlightPostTag": {
"type": "string",
- "description": "A string tag that is appended to hit highlights. Must be set with HighlightPreTag. If omitted, hit highlighting is disabled."
+ "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled."
},
"highlightPreTag": {
"type": "string",
- "description": "A string tag that is prepended to hit highlights. Must be set with HighlightPostTag. If omitted, hit highlighting is disabled."
+ "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled."
},
"minimumCoverage": {
"type": "number",
@@ -545,7 +830,7 @@
},
"searchFields": {
"type": "string",
- "description": "The comma-separated list of field names to consider when querying for auto-completed terms."
+ "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester."
},
"suggesterName": {
"type": "string",
@@ -554,7 +839,7 @@
"top": {
"type": "integer",
"format": "int32",
- "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is to 5."
+ "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5."
}
},
"description": "Parameters for fuzzy matching, and other autocomplete query behaviors."
diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md b/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md
index 9bc5169457cd..ab992fafda1f 100644
--- a/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md
+++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/readme.md
@@ -108,6 +108,8 @@ Use the below directives sparingly. Every modification we make in here, we poten
``` yaml $(csharp)
directive:
+ # TODO: Simplify all the below regexes once we gain the ability to target them at specific files.
+
# Rename the IDocumentsOperations interface and implementation, then make the interface internal so we can version it freely.
# This requires these changes:
# 1. Globally rename the interface and implementation class, along with comments and constructors
@@ -129,7 +131,7 @@ directive:
replace( /public (partial interface IDocumentsProxyOperations)/g, "internal $1" ).
replace( /public virtual (IDocumentsProxyOperations) Documents ({ get;)/g, "internal $1 DocumentsProxy $2" ).
replace( /Documents = new DocumentsProxyOperations\(this\);/g, "DocumentsProxy = new DocumentsProxyOperations\(this\);" ).
- replace( /(Gets the) IDocumentsProxyOperations(.\s*\n\s*\/\/\/ <\/summary>\s*\n\s*)IDocumentsProxyOperations (Documents { get; })/g, "$1 IDocumentsOperations$2IDocumentsOperations $3" )
+ replace( /(Gets the) IDocumentsProxyOperations(.\s*\/\/\/ <\/summary>\s*)IDocumentsProxyOperations (Documents { get; })/g, "$1 IDocumentsOperations$2IDocumentsOperations $3" )
####
# Adds extra JsonSerializerSettings parameters to all operation methods. This enables the SDK to delegate serialization/de-serialization to the custom serializer on a per-call basis.
- from: source-file-csharp
@@ -150,4 +152,60 @@ directive:
replace( /(Task(> GetWithHttpMessagesAsync)/g, "$1$2" ).
replace( /(DeserializeObject)