Microsoft.Azure.Search.Data (preview:2019-05-06-Preview)

2025/12/05 • 9 deleted methods

Documents_Count (removed)
Description :  Queries the number of documents in the index.
Reference :  Link ¶

⚼ Request

GET:  /docs/$count
{
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Format: int64 ,
}
integer ,
}
Documents_SearchGet (removed)
Description :  Searches for documents in the index.
Reference :  Link ¶

⚼ Request

GET:  /docs
{
search:
{
Description: A full-text search query expression; Use "*" or omit this parameter to match all documents. ,
Required: False ,
}
string ,
$count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facet:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
array ,
$filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
array ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search 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 100. ,
Format: double ,
Required: False ,
}
number ,
$orderby:
{
Description: The 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. ,
Required: False ,
}
array ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Required: False ,
}
string ,
scoringParameter:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
array ,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
searchFields:
{
Description: The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter. ,
Required: False ,
}
array ,
searchMode:
{
Description: A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. ,
Required: False ,
}
string ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. ,
Required: False ,
}
string ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help to get more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
$select:
{
Description: The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. ,
Required: False ,
}
array ,
$skip:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
$top:
{
Description: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
@odata.count:
{
Description: The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response. ,
Format: int64 ,
Required: False ,
}
integer ,
@search.coverage:
{
Description: A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request. ,
Format: double ,
Required: False ,
}
number ,
@search.facets:
{
Description: The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions. ,
Required: False ,
}
object ,
@search.nextPageParameters:
{
Description: Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response. ,
Required: False ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search 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 100. ,
Format: double ,
Required: False ,
}
number ,
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. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: No description available. ,
full: No description available. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: No description available. ,
global: No description available. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
search:
{
Description: A full-text search query expression; Use "*" or omit this parameter to match all documents. ,
Required: False ,
}
string ,
searchFields:
{
Description: The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter. ,
Required: False ,
}
string ,
searchMode:
{
Description: A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. ,
Enum:
{
any: No description available. ,
all: No description available. ,
}
,
Required: False ,
}
enum ,
select:
{
Description: The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. ,
Required: False ,
}
string ,
skip:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
value:
{
Description: The sequence of results returned by the query. ,
Required: False ,
}
[
{
@search.score:
{
Description: The relevance score of the document compared to other documents returned by the query. ,
Format: double ,
Required: False ,
}
number ,
@search.highlights:
{
Description: Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query. ,
Required: False ,
}
object ,
}
,
]
,
@odata.nextLink:
{
Description: Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. ,
Required: False ,
}
string ,
}
Documents_SearchPost (removed)
Description :  Searches for documents in the index.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.post.search
{
searchRequest:
{
Description: The definition of the Search request. ,
Required: True ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search 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 100. ,
Format: double ,
Required: False ,
}
number ,
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. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: No description available. ,
full: No description available. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: No description available. ,
global: No description available. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
search:
{
Description: A full-text search query expression; Use "*" or omit this parameter to match all documents. ,
Required: False ,
}
string ,
searchFields:
{
Description: The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter. ,
Required: False ,
}
string ,
searchMode:
{
Description: A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. ,
Enum:
{
any: No description available. ,
all: No description available. ,
}
,
Required: False ,
}
enum ,
select:
{
Description: The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. ,
Required: False ,
}
string ,
skip:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
@odata.count:
{
Description: The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response. ,
Format: int64 ,
Required: False ,
}
integer ,
@search.coverage:
{
Description: A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request. ,
Format: double ,
Required: False ,
}
number ,
@search.facets:
{
Description: The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions. ,
Required: False ,
}
object ,
@search.nextPageParameters:
{
Description: Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response. ,
Required: False ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search 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 100. ,
Format: double ,
Required: False ,
}
number ,
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. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: No description available. ,
full: No description available. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: No description available. ,
global: No description available. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
search:
{
Description: A full-text search query expression; Use "*" or omit this parameter to match all documents. ,
Required: False ,
}
string ,
searchFields:
{
Description: The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter. ,
Required: False ,
}
string ,
searchMode:
{
Description: A value that specifies whether any or all of the search terms must be matched in order to count the document as a match. ,
Enum:
{
any: No description available. ,
all: No description available. ,
}
,
Required: False ,
}
enum ,
select:
{
Description: The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included. ,
Required: False ,
}
string ,
skip:
{
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. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
value:
{
Description: The sequence of results returned by the query. ,
Required: False ,
}
[
{
@search.score:
{
Description: The relevance score of the document compared to other documents returned by the query. ,
Format: double ,
Required: False ,
}
number ,
@search.highlights:
{
Description: Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query. ,
Required: False ,
}
object ,
}
,
]
,
@odata.nextLink:
{
Description: Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response. ,
Required: False ,
}
string ,
}
Documents_Get (removed)
Description :  Retrieves a document from the index.
Reference :  Link ¶

⚼ Request

GET:  /docs('{key}')
{
key:
{
Description: The key of the document to retrieve. ,
Required: True ,
}
string ,
$select:
{
Description: List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document. ,
Required: False ,
}
array ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema: object ,
}
Documents_SuggestGet (removed)
Description :  Suggests documents in the index that match the given partial query text.
Reference :  Link ¶

⚼ Request

GET:  /docs/search.suggest
{
search:
{
Description: The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters. ,
Required: True ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData expression that filters the documents considered for suggestions. ,
Required: False ,
}
string ,
fuzzy:
{
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. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
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. ,
Format: double ,
Required: False ,
}
number ,
$orderby:
{
Description: The 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. ,
Required: False ,
}
array ,
searchFields:
{
Description: The list of field names to search for the specified search text. Target fields must be included in the specified suggester. ,
Required: False ,
}
array ,
$select:
{
Description: The list of fields to retrieve. If unspecified, only the key field will be included in the results. ,
Required: False ,
}
array ,
$top:
{
Description: The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sequence of results returned by the query. ,
Required: False ,
}
[
{
@search.text:
{
Description: The text of the suggestion result. ,
Required: False ,
}
string ,
}
,
]
,
@search.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. ,
Format: double ,
Required: False ,
}
number ,
}
Documents_SuggestPost (removed)
Description :  Suggests documents in the index that match the given partial query text.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.post.suggest
{
suggestRequest:
{
Description: The Suggest request. ,
Required: True ,
}
{
filter:
{
Description: An OData expression that filters the documents considered for suggestions. ,
Required: False ,
}
string ,
fuzzy:
{
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. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion 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. ,
Format: double ,
Required: False ,
}
number ,
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. ,
Required: False ,
}
string ,
search:
{
Description: The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters. ,
Required: False ,
}
string ,
searchFields:
{
Description: The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester. ,
Required: False ,
}
string ,
select:
{
Description: The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results. ,
Required: False ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: False ,
}
string ,
top:
{
Description: The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sequence of results returned by the query. ,
Required: False ,
}
[
{
@search.text:
{
Description: The text of the suggestion result. ,
Required: False ,
}
string ,
}
,
]
,
@search.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. ,
Format: double ,
Required: False ,
}
number ,
}
Documents_Index (removed)
Description :  Sends a batch of document write actions to the index.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.index
{
batch:
{
Description: The batch of index actions. ,
Required: True ,
}
{
value:
{
Description: The actions in the batch. ,
Required: True ,
}
[
{
@search.action:
{
Description: The operation to perform on a document in an indexing batch. ,
Enum:
{
upload: No description available. ,
merge: No description available. ,
mergeOrUpload: No description available. ,
delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of status information for each document in the indexing request. ,
Required: False ,
}
[
{
key:
{
Description: The key of a document that was in the indexing request. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded. ,
Required: False ,
}
string ,
status:
{
Description: A value indicating whether the indexing operation succeeded for the document identified by the key. ,
Required: False ,
}
boolean ,
statusCode:
{
Description: The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}

⚐ Response (207)

{
value:
{
Description: The list of status information for each document in the indexing request. ,
Required: False ,
}
[
{
key:
{
Description: The key of a document that was in the indexing request. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded. ,
Required: False ,
}
string ,
status:
{
Description: A value indicating whether the indexing operation succeeded for the document identified by the key. ,
Required: False ,
}
boolean ,
statusCode:
{
Description: The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
Documents_AutocompleteGet (removed)
Description :  Autocompletes incomplete query terms based on input text and matching terms in the index.
Reference :  Link ¶

⚼ Request

GET:  /docs/search.autocomplete
{
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
search:
{
Description: The incomplete term which should be auto-completed. ,
Required: True ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: True ,
}
string ,
autocompleteMode:
{
Description: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms. ,
Required: False ,
}
string ,
$filter:
{
Description: An OData expression that filters the documents used to produce completed terms for the Autocomplete result. ,
Required: False ,
}
string ,
fuzzy:
{
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. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete 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. ,
Format: double ,
Required: False ,
}
number ,
searchFields:
{
Description: The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester. ,
Required: False ,
}
array ,
$top:
{
Description: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

{
value:
{
Description: The list of returned Autocompleted items. ,
Required: False ,
}
[
{
text:
{
Description: The completed term. ,
Required: False ,
}
string ,
queryPlusText:
{
Description: The query along with the completed term. ,
Required: False ,
}
string ,
}
,
]
,
}
Documents_AutocompletePost (removed)
Description :  Autocompletes incomplete query terms based on input text and matching terms in the index.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.post.autocomplete
{
client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
autocompleteRequest:
{
Description: The definition of the Autocomplete request. ,
Required: True ,
}
{
search:
{
Description: The search text on which to base autocomplete results. ,
Required: False ,
}
string ,
autocompleteMode:
{
Description: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms. ,
Enum:
{
oneTerm: No description available. ,
twoTerms: No description available. ,
oneTermWithContext: No description available. ,
}
,
Required: False ,
}
enum ,
filter:
{
Description: An OData expression that filters the documents used to produce completed terms for the Autocomplete result. ,
Required: False ,
}
string ,
fuzzy:
{
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. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete 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. ,
Format: double ,
Required: False ,
}
number ,
searchFields:
{
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. ,
Required: False ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: False ,
}
string ,
top:
{
Description: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

{
value:
{
Description: The list of returned Autocompleted items. ,
Required: False ,
}
[
{
text:
{
Description: The completed term. ,
Required: False ,
}
string ,
queryPlusText:
{
Description: The query along with the completed term. ,
Required: False ,
}
string ,
}
,
]
,
}