SearchIndexClient (preview:2023-07-01-Preview)

2025/12/05 • 9 new methods

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

⚼ Request

GET:  /docs/$count
{
x-ms-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 ,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_SearchGet (new)
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 ,
semanticConfiguration:
{
Description: The name of the semantic configuration that lists which fields should be used for semantic ranking, captions, highlights, and answers ,
Required: False ,
}
string ,
semanticErrorHandling:
{
Description: Allows the user to choose whether a semantic call should fail completely, or to return partial results. ,
Required: False ,
}
string ,
semanticMaxWaitInMilliseconds:
{
Description: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails. ,
Format: int32 ,
Required: False ,
}
integer ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your search 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 ,
queryLanguage:
{
Description: The language of the query. ,
Required: False ,
}
string ,
speller:
{
Description: Improve search recall by spell-correcting individual search query terms. ,
Required: False ,
}
string ,
answers:
{
Description: This parameter is only valid if the query type is 'semantic'. If set, the query returns answers extracted from key passages in the highest ranked documents. The number of answers returned can be configured by appending the pipe character '|' followed by the 'count-' option after the answers parameter value, such as 'extractive|count-3'. Default count is 1. The confidence threshold can be configured by appending the pipe character '|' followed by the 'threshold-' option after the answers parameter value, such as 'extractive|threshold-0.9'. Default threshold is 0.7. ,
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. ,
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 ,
captions:
{
Description: This parameter is only valid if the query type is 'semantic'. If set, the query returns captions extracted from key passages in the highest ranked documents. When Captions is set to 'extractive', highlighting is enabled by default, and can be configured by appending the pipe character '|' followed by the 'highlight-' option, such as 'extractive|highlight-true'. Defaults to 'None'. ,
Required: False ,
}
string ,
semanticFields:
{
Description: The list of field names used for semantic search. ,
Required: False ,
}
array ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-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.answers:
{
Description: The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'. ,
Required: False ,
}
[
{
score:
{
Description: The score value represents how relevant the answer is to the query relative to other answers returned for the query. ,
Format: double ,
Required: False ,
}
number ,
key:
{
Description: The key of the document the answer was extracted from. ,
Required: False ,
}
string ,
text:
{
Description: The text passage extracted from the document contents as the answer. ,
Required: False ,
}
string ,
highlights:
{
Description: Same text passage as in the Text property with highlighted text phrases most relevant to the query. ,
Required: False ,
}
string ,
}
,
]
,
@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: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
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: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
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 ,
semanticConfiguration:
{
Description: The name of a semantic configuration that will be used when processing documents for queries of type semantic. ,
Required: False ,
}
string ,
semanticErrorHandling:
{
Description: Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results. ,
Enum:
{
partial: If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure. ,
fail: If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error. ,
}
,
Required: False ,
}
enum ,
semanticMaxWaitInMilliseconds:
{
Description: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails. ,
Format: int32 ,
Required: False ,
}
integer ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your Semantic search results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their Semantic search results. ,
}
,
Required: False ,
}
enum ,
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: Any of the search terms must be matched in order to count the document as a match. ,
all: All of the search terms must be matched in order to count the document as a match. ,
}
,
Required: False ,
}
enum ,
queryLanguage:
{
Description: A value that specifies the language of the search query. ,
Enum:
{
none: Query language not specified. ,
en-us: Query language value for English (United States). ,
en-gb: Query language value for English (Great Britain). ,
en-in: Query language value for English (India). ,
en-ca: Query language value for English (Canada). ,
en-au: Query language value for English (Australia). ,
fr-fr: Query language value for French (France). ,
fr-ca: Query language value for French (Canada). ,
de-de: Query language value for German (Germany). ,
es-es: Query language value for Spanish (Spain). ,
es-mx: Query language value for Spanish (Mexico). ,
zh-cn: Query language value for Chinese (China). ,
zh-tw: Query language value for Chinese (Taiwan). ,
pt-br: Query language value for Portuguese (Brazil). ,
pt-pt: Query language value for Portuguese (Portugal). ,
it-it: Query language value for Italian (Italy). ,
ja-jp: Query language value for Japanese (Japan). ,
ko-kr: Query language value for Korean (Korea). ,
ru-ru: Query language value for Russian (Russia). ,
cs-cz: Query language value for Czech (Czech Republic). ,
nl-be: Query language value for Dutch (Belgium). ,
nl-nl: Query language value for Dutch (Netherlands). ,
hu-hu: Query language value for Hungarian (Hungary). ,
pl-pl: Query language value for Polish (Poland). ,
sv-se: Query language value for Swedish (Sweden). ,
tr-tr: Query language value for Turkish (Turkey). ,
hi-in: Query language value for Hindi (India). ,
ar-sa: Query language value for Arabic (Saudi Arabia). ,
ar-eg: Query language value for Arabic (Egypt). ,
ar-ma: Query language value for Arabic (Morocco). ,
ar-kw: Query language value for Arabic (Kuwait). ,
ar-jo: Query language value for Arabic (Jordan). ,
da-dk: Query language value for Danish (Denmark). ,
no-no: Query language value for Norwegian (Norway). ,
bg-bg: Query language value for Bulgarian (Bulgaria). ,
hr-hr: Query language value for Croatian (Croatia). ,
hr-ba: Query language value for Croatian (Bosnia and Herzegovina). ,
ms-my: Query language value for Malay (Malaysia). ,
ms-bn: Query language value for Malay (Brunei Darussalam). ,
sl-sl: Query language value for Slovenian (Slovenia). ,
ta-in: Query language value for Tamil (India). ,
vi-vn: Query language value for Vietnamese (Viet Nam). ,
el-gr: Query language value for Greek (Greece). ,
ro-ro: Query language value for Romanian (Romania). ,
is-is: Query language value for Icelandic (Iceland). ,
id-id: Query language value for Indonesian (Indonesia). ,
th-th: Query language value for Thai (Thailand). ,
lt-lt: Query language value for Lithuanian (Lithuania). ,
uk-ua: Query language value for Ukrainian (Ukraine). ,
lv-lv: Query language value for Latvian (Latvia). ,
et-ee: Query language value for Estonian (Estonia). ,
ca-es: Query language value for Catalan (Spain). ,
fi-fi: Query language value for Finnish (Finland). ,
sr-ba: Query language value for Serbian (Bosnia and Herzegovina). ,
sr-me: Query language value for Serbian (Montenegro). ,
sr-rs: Query language value for Serbian (Serbia). ,
sk-sk: Query language value for Slovak (Slovakia). ,
nb-no: Query language value for Norwegian (Norway). ,
hy-am: Query language value for Armenian (Armenia). ,
bn-in: Query language value for Bengali (India). ,
eu-es: Query language value for Basque (Spain). ,
gl-es: Query language value for Galician (Spain). ,
gu-in: Query language value for Gujarati (India). ,
he-il: Query language value for Hebrew (Israel). ,
ga-ie: Query language value for Irish (Ireland). ,
kn-in: Query language value for Kannada (India). ,
ml-in: Query language value for Malayalam (India). ,
mr-in: Query language value for Marathi (India). ,
fa-ae: Query language value for Persian (U.A.E.). ,
pa-in: Query language value for Punjabi (India). ,
te-in: Query language value for Telugu (India). ,
ur-pk: Query language value for Urdu (Pakistan). ,
}
,
Required: False ,
}
enum ,
speller:
{
Description: A value that specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
answers:
{
Description: A value that specifies whether answers should be returned as part of the search response. ,
Enum:
{
none: Do not return answers for the query. ,
extractive: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. ,
}
,
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 ,
captions:
{
Description: A value that specifies whether captions should be returned as part of the search response. ,
Enum:
{
none: Do not return captions for the query. ,
extractive: Extracts captions from the matching documents that contain passages relevant to the search query. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic search. ,
Required: False ,
}
string ,
vector:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
{
value:
{
Description: The vector representation of a search query. ,
Required: False ,
}
[
number ,
]
,
k:
{
Description: Number of nearest neighbors to return as top hits. ,
Format: int32 ,
Required: False ,
}
integer ,
fields:
{
Description: Vector Fields of type Collection(Edm.Single) to be included in the vector searched. ,
Required: False ,
}
string ,
}
,
vectors:
{
Description: The query parameters for multi-vector search queries. ,
Required: False ,
}
[
{
value:
{
Description: The vector representation of a search query. ,
Required: False ,
}
[
number ,
]
,
k:
{
Description: Number of nearest neighbors to return as top hits. ,
Format: int32 ,
Required: False ,
}
integer ,
fields:
{
Description: Vector Fields of type Collection(Edm.Single) to be included in the vector searched. ,
Required: False ,
}
string ,
}
,
]
,
}
,
@search.semanticPartialResponseReason:
{
Description: Reason that a partial response was returned for a semantic search request. ,
Enum:
{
maxWaitExceeded: If 'semanticMaxWaitInMilliseconds' was set and the semantic processing duration exceeded that value. Only the base results were returned. ,
capacityOverloaded: The request was throttled. Only the base results were returned. ,
transient: At least one step of the semantic process failed. ,
}
,
Required: False ,
}
enum ,
@search.semanticPartialResponseType:
{
Description: Type of partial response that was returned for a semantic search request. ,
Enum:
{
baseResults: Results without any semantic enrichment or reranking. ,
rerankedResults: Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The sequence of results returned by the query. ,
Required: True ,
}
[
{
@search.score:
{
Description: The relevance score of the document compared to other documents returned by the query. ,
Format: double ,
Required: True ,
}
number ,
@search.rerankerScore:
{
Description: The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'. ,
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 ,
@search.captions:
{
Description: Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'. ,
Required: False ,
}
[
{
text:
{
Description: A representative text passage extracted from the document most relevant to the search query. ,
Required: False ,
}
string ,
highlights:
{
Description: Same text passage as in the Text property with highlighted phrases most relevant to the query. ,
Required: False ,
}
string ,
}
,
]
,
@search.documentDebugInfo:
{
Description: Contains debugging information that can be used to further explore your search results. ,
Required: False ,
}
[
{
semantic:
{
Description: Contains debugging information specific to semantic search queries. ,
Required: False ,
}
{
titleField:
{
Description: The title field that was sent to the semantic enrichment process, as well as how it was used ,
Required: False ,
}
{
name:
{
Description: The name of the field that was sent to the semantic enrichment process ,
Required: False ,
}
string ,
state:
{
Description: The way the field was used for the semantic enrichment process (fully used, partially used, or unused) ,
Enum:
{
used: The field was fully used for semantic enrichment. ,
unused: The field was not used for semantic enrichment. ,
partial: The field was partially used for semantic enrichment. ,
}
,
Required: False ,
}
enum ,
}
,
contentFields:
{
Description: The content fields that were sent to the semantic enrichment process, as well as how they were used ,
Required: False ,
}
[
{
name:
{
Description: The name of the field that was sent to the semantic enrichment process ,
Required: False ,
}
string ,
state:
{
Description: The way the field was used for the semantic enrichment process (fully used, partially used, or unused) ,
Enum:
{
used: The field was fully used for semantic enrichment. ,
unused: The field was not used for semantic enrichment. ,
partial: The field was partially used for semantic enrichment. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
keywordFields:
{
Description: The keyword fields that were sent to the semantic enrichment process, as well as how they were used ,
Required: False ,
}
[
{
name:
{
Description: The name of the field that was sent to the semantic enrichment process ,
Required: False ,
}
string ,
state:
{
Description: The way the field was used for the semantic enrichment process (fully used, partially used, or unused) ,
Enum:
{
used: The field was fully used for semantic enrichment. ,
unused: The field was not used for semantic enrichment. ,
partial: The field was partially used for semantic enrichment. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
rerankerInput:
{
Description: The raw concatenated strings that were sent to the semantic enrichment process. ,
Required: False ,
}
{
title:
{
Description: The raw string for the title field that was used for semantic enrichment. ,
Required: False ,
}
string ,
content:
{
Description: The raw concatenated strings for the content fields that were used for semantic enrichment. ,
Required: False ,
}
string ,
keywords:
{
Description: The raw concatenated strings for the keyword fields that were used for semantic enrichment. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
]
,
@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 ,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_SearchPost (new)
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: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
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: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
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 ,
semanticConfiguration:
{
Description: The name of a semantic configuration that will be used when processing documents for queries of type semantic. ,
Required: False ,
}
string ,
semanticErrorHandling:
{
Description: Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results. ,
Enum:
{
partial: If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure. ,
fail: If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error. ,
}
,
Required: False ,
}
enum ,
semanticMaxWaitInMilliseconds:
{
Description: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails. ,
Format: int32 ,
Required: False ,
}
integer ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your Semantic search results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their Semantic search results. ,
}
,
Required: False ,
}
enum ,
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: Any of the search terms must be matched in order to count the document as a match. ,
all: All of the search terms must be matched in order to count the document as a match. ,
}
,
Required: False ,
}
enum ,
queryLanguage:
{
Description: A value that specifies the language of the search query. ,
Enum:
{
none: Query language not specified. ,
en-us: Query language value for English (United States). ,
en-gb: Query language value for English (Great Britain). ,
en-in: Query language value for English (India). ,
en-ca: Query language value for English (Canada). ,
en-au: Query language value for English (Australia). ,
fr-fr: Query language value for French (France). ,
fr-ca: Query language value for French (Canada). ,
de-de: Query language value for German (Germany). ,
es-es: Query language value for Spanish (Spain). ,
es-mx: Query language value for Spanish (Mexico). ,
zh-cn: Query language value for Chinese (China). ,
zh-tw: Query language value for Chinese (Taiwan). ,
pt-br: Query language value for Portuguese (Brazil). ,
pt-pt: Query language value for Portuguese (Portugal). ,
it-it: Query language value for Italian (Italy). ,
ja-jp: Query language value for Japanese (Japan). ,
ko-kr: Query language value for Korean (Korea). ,
ru-ru: Query language value for Russian (Russia). ,
cs-cz: Query language value for Czech (Czech Republic). ,
nl-be: Query language value for Dutch (Belgium). ,
nl-nl: Query language value for Dutch (Netherlands). ,
hu-hu: Query language value for Hungarian (Hungary). ,
pl-pl: Query language value for Polish (Poland). ,
sv-se: Query language value for Swedish (Sweden). ,
tr-tr: Query language value for Turkish (Turkey). ,
hi-in: Query language value for Hindi (India). ,
ar-sa: Query language value for Arabic (Saudi Arabia). ,
ar-eg: Query language value for Arabic (Egypt). ,
ar-ma: Query language value for Arabic (Morocco). ,
ar-kw: Query language value for Arabic (Kuwait). ,
ar-jo: Query language value for Arabic (Jordan). ,
da-dk: Query language value for Danish (Denmark). ,
no-no: Query language value for Norwegian (Norway). ,
bg-bg: Query language value for Bulgarian (Bulgaria). ,
hr-hr: Query language value for Croatian (Croatia). ,
hr-ba: Query language value for Croatian (Bosnia and Herzegovina). ,
ms-my: Query language value for Malay (Malaysia). ,
ms-bn: Query language value for Malay (Brunei Darussalam). ,
sl-sl: Query language value for Slovenian (Slovenia). ,
ta-in: Query language value for Tamil (India). ,
vi-vn: Query language value for Vietnamese (Viet Nam). ,
el-gr: Query language value for Greek (Greece). ,
ro-ro: Query language value for Romanian (Romania). ,
is-is: Query language value for Icelandic (Iceland). ,
id-id: Query language value for Indonesian (Indonesia). ,
th-th: Query language value for Thai (Thailand). ,
lt-lt: Query language value for Lithuanian (Lithuania). ,
uk-ua: Query language value for Ukrainian (Ukraine). ,
lv-lv: Query language value for Latvian (Latvia). ,
et-ee: Query language value for Estonian (Estonia). ,
ca-es: Query language value for Catalan (Spain). ,
fi-fi: Query language value for Finnish (Finland). ,
sr-ba: Query language value for Serbian (Bosnia and Herzegovina). ,
sr-me: Query language value for Serbian (Montenegro). ,
sr-rs: Query language value for Serbian (Serbia). ,
sk-sk: Query language value for Slovak (Slovakia). ,
nb-no: Query language value for Norwegian (Norway). ,
hy-am: Query language value for Armenian (Armenia). ,
bn-in: Query language value for Bengali (India). ,
eu-es: Query language value for Basque (Spain). ,
gl-es: Query language value for Galician (Spain). ,
gu-in: Query language value for Gujarati (India). ,
he-il: Query language value for Hebrew (Israel). ,
ga-ie: Query language value for Irish (Ireland). ,
kn-in: Query language value for Kannada (India). ,
ml-in: Query language value for Malayalam (India). ,
mr-in: Query language value for Marathi (India). ,
fa-ae: Query language value for Persian (U.A.E.). ,
pa-in: Query language value for Punjabi (India). ,
te-in: Query language value for Telugu (India). ,
ur-pk: Query language value for Urdu (Pakistan). ,
}
,
Required: False ,
}
enum ,
speller:
{
Description: A value that specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
answers:
{
Description: A value that specifies whether answers should be returned as part of the search response. ,
Enum:
{
none: Do not return answers for the query. ,
extractive: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. ,
}
,
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 ,
captions:
{
Description: A value that specifies whether captions should be returned as part of the search response. ,
Enum:
{
none: Do not return captions for the query. ,
extractive: Extracts captions from the matching documents that contain passages relevant to the search query. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic search. ,
Required: False ,
}
string ,
vector:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
{
value:
{
Description: The vector representation of a search query. ,
Required: False ,
}
[
number ,
]
,
k:
{
Description: Number of nearest neighbors to return as top hits. ,
Format: int32 ,
Required: False ,
}
integer ,
fields:
{
Description: Vector Fields of type Collection(Edm.Single) to be included in the vector searched. ,
Required: False ,
}
string ,
}
,
vectors:
{
Description: The query parameters for multi-vector search queries. ,
Required: False ,
}
[
{
value:
{
Description: The vector representation of a search query. ,
Required: False ,
}
[
number ,
]
,
k:
{
Description: Number of nearest neighbors to return as top hits. ,
Format: int32 ,
Required: False ,
}
integer ,
fields:
{
Description: Vector Fields of type Collection(Edm.Single) to be included in the vector searched. ,
Required: False ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-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.answers:
{
Description: The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'. ,
Required: False ,
}
[
{
score:
{
Description: The score value represents how relevant the answer is to the query relative to other answers returned for the query. ,
Format: double ,
Required: False ,
}
number ,
key:
{
Description: The key of the document the answer was extracted from. ,
Required: False ,
}
string ,
text:
{
Description: The text passage extracted from the document contents as the answer. ,
Required: False ,
}
string ,
highlights:
{
Description: Same text passage as in the Text property with highlighted text phrases most relevant to the query. ,
Required: False ,
}
string ,
}
,
]
,
@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: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
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: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
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 ,
semanticConfiguration:
{
Description: The name of a semantic configuration that will be used when processing documents for queries of type semantic. ,
Required: False ,
}
string ,
semanticErrorHandling:
{
Description: Allows the user to choose whether a semantic call should fail completely (default / current behavior), or to return partial results. ,
Enum:
{
partial: If the semantic processing fails, partial results still return. The definition of partial results depends on what semantic step failed and what was the reason for failure. ,
fail: If there is an exception during the semantic processing step, the query will fail and return the appropriate HTTP code depending on the error. ,
}
,
Required: False ,
}
enum ,
semanticMaxWaitInMilliseconds:
{
Description: Allows the user to set an upper bound on the amount of time it takes for semantic enrichment to finish processing before the request fails. ,
Format: int32 ,
Required: False ,
}
integer ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your Semantic search results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their Semantic search results. ,
}
,
Required: False ,
}
enum ,
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: Any of the search terms must be matched in order to count the document as a match. ,
all: All of the search terms must be matched in order to count the document as a match. ,
}
,
Required: False ,
}
enum ,
queryLanguage:
{
Description: A value that specifies the language of the search query. ,
Enum:
{
none: Query language not specified. ,
en-us: Query language value for English (United States). ,
en-gb: Query language value for English (Great Britain). ,
en-in: Query language value for English (India). ,
en-ca: Query language value for English (Canada). ,
en-au: Query language value for English (Australia). ,
fr-fr: Query language value for French (France). ,
fr-ca: Query language value for French (Canada). ,
de-de: Query language value for German (Germany). ,
es-es: Query language value for Spanish (Spain). ,
es-mx: Query language value for Spanish (Mexico). ,
zh-cn: Query language value for Chinese (China). ,
zh-tw: Query language value for Chinese (Taiwan). ,
pt-br: Query language value for Portuguese (Brazil). ,
pt-pt: Query language value for Portuguese (Portugal). ,
it-it: Query language value for Italian (Italy). ,
ja-jp: Query language value for Japanese (Japan). ,
ko-kr: Query language value for Korean (Korea). ,
ru-ru: Query language value for Russian (Russia). ,
cs-cz: Query language value for Czech (Czech Republic). ,
nl-be: Query language value for Dutch (Belgium). ,
nl-nl: Query language value for Dutch (Netherlands). ,
hu-hu: Query language value for Hungarian (Hungary). ,
pl-pl: Query language value for Polish (Poland). ,
sv-se: Query language value for Swedish (Sweden). ,
tr-tr: Query language value for Turkish (Turkey). ,
hi-in: Query language value for Hindi (India). ,
ar-sa: Query language value for Arabic (Saudi Arabia). ,
ar-eg: Query language value for Arabic (Egypt). ,
ar-ma: Query language value for Arabic (Morocco). ,
ar-kw: Query language value for Arabic (Kuwait). ,
ar-jo: Query language value for Arabic (Jordan). ,
da-dk: Query language value for Danish (Denmark). ,
no-no: Query language value for Norwegian (Norway). ,
bg-bg: Query language value for Bulgarian (Bulgaria). ,
hr-hr: Query language value for Croatian (Croatia). ,
hr-ba: Query language value for Croatian (Bosnia and Herzegovina). ,
ms-my: Query language value for Malay (Malaysia). ,
ms-bn: Query language value for Malay (Brunei Darussalam). ,
sl-sl: Query language value for Slovenian (Slovenia). ,
ta-in: Query language value for Tamil (India). ,
vi-vn: Query language value for Vietnamese (Viet Nam). ,
el-gr: Query language value for Greek (Greece). ,
ro-ro: Query language value for Romanian (Romania). ,
is-is: Query language value for Icelandic (Iceland). ,
id-id: Query language value for Indonesian (Indonesia). ,
th-th: Query language value for Thai (Thailand). ,
lt-lt: Query language value for Lithuanian (Lithuania). ,
uk-ua: Query language value for Ukrainian (Ukraine). ,
lv-lv: Query language value for Latvian (Latvia). ,
et-ee: Query language value for Estonian (Estonia). ,
ca-es: Query language value for Catalan (Spain). ,
fi-fi: Query language value for Finnish (Finland). ,
sr-ba: Query language value for Serbian (Bosnia and Herzegovina). ,
sr-me: Query language value for Serbian (Montenegro). ,
sr-rs: Query language value for Serbian (Serbia). ,
sk-sk: Query language value for Slovak (Slovakia). ,
nb-no: Query language value for Norwegian (Norway). ,
hy-am: Query language value for Armenian (Armenia). ,
bn-in: Query language value for Bengali (India). ,
eu-es: Query language value for Basque (Spain). ,
gl-es: Query language value for Galician (Spain). ,
gu-in: Query language value for Gujarati (India). ,
he-il: Query language value for Hebrew (Israel). ,
ga-ie: Query language value for Irish (Ireland). ,
kn-in: Query language value for Kannada (India). ,
ml-in: Query language value for Malayalam (India). ,
mr-in: Query language value for Marathi (India). ,
fa-ae: Query language value for Persian (U.A.E.). ,
pa-in: Query language value for Punjabi (India). ,
te-in: Query language value for Telugu (India). ,
ur-pk: Query language value for Urdu (Pakistan). ,
}
,
Required: False ,
}
enum ,
speller:
{
Description: A value that specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
answers:
{
Description: A value that specifies whether answers should be returned as part of the search response. ,
Enum:
{
none: Do not return answers for the query. ,
extractive: Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language. ,
}
,
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 ,
captions:
{
Description: A value that specifies whether captions should be returned as part of the search response. ,
Enum:
{
none: Do not return captions for the query. ,
extractive: Extracts captions from the matching documents that contain passages relevant to the search query. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic search. ,
Required: False ,
}
string ,
vector:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
{
value:
{
Description: The vector representation of a search query. ,
Required: False ,
}
[
number ,
]
,
k:
{
Description: Number of nearest neighbors to return as top hits. ,
Format: int32 ,
Required: False ,
}
integer ,
fields:
{
Description: Vector Fields of type Collection(Edm.Single) to be included in the vector searched. ,
Required: False ,
}
string ,
}
,
vectors:
{
Description: The query parameters for multi-vector search queries. ,
Required: False ,
}
[
{
value:
{
Description: The vector representation of a search query. ,
Required: False ,
}
[
number ,
]
,
k:
{
Description: Number of nearest neighbors to return as top hits. ,
Format: int32 ,
Required: False ,
}
integer ,
fields:
{
Description: Vector Fields of type Collection(Edm.Single) to be included in the vector searched. ,
Required: False ,
}
string ,
}
,
]
,
}
,
@search.semanticPartialResponseReason:
{
Description: Reason that a partial response was returned for a semantic search request. ,
Enum:
{
maxWaitExceeded: If 'semanticMaxWaitInMilliseconds' was set and the semantic processing duration exceeded that value. Only the base results were returned. ,
capacityOverloaded: The request was throttled. Only the base results were returned. ,
transient: At least one step of the semantic process failed. ,
}
,
Required: False ,
}
enum ,
@search.semanticPartialResponseType:
{
Description: Type of partial response that was returned for a semantic search request. ,
Enum:
{
baseResults: Results without any semantic enrichment or reranking. ,
rerankedResults: Results have been reranked with the reranker model and will include semantic captions. They will not include any answers, answers highlights or caption highlights. ,
}
,
Required: False ,
}
enum ,
value:
{
Description: The sequence of results returned by the query. ,
Required: True ,
}
[
{
@search.score:
{
Description: The relevance score of the document compared to other documents returned by the query. ,
Format: double ,
Required: True ,
}
number ,
@search.rerankerScore:
{
Description: The relevance score computed by the semantic ranker for the top search results. Search results are sorted by the RerankerScore first and then by the Score. RerankerScore is only returned for queries of type 'semantic'. ,
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 ,
@search.captions:
{
Description: Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'. ,
Required: False ,
}
[
{
text:
{
Description: A representative text passage extracted from the document most relevant to the search query. ,
Required: False ,
}
string ,
highlights:
{
Description: Same text passage as in the Text property with highlighted phrases most relevant to the query. ,
Required: False ,
}
string ,
}
,
]
,
@search.documentDebugInfo:
{
Description: Contains debugging information that can be used to further explore your search results. ,
Required: False ,
}
[
{
semantic:
{
Description: Contains debugging information specific to semantic search queries. ,
Required: False ,
}
{
titleField:
{
Description: The title field that was sent to the semantic enrichment process, as well as how it was used ,
Required: False ,
}
{
name:
{
Description: The name of the field that was sent to the semantic enrichment process ,
Required: False ,
}
string ,
state:
{
Description: The way the field was used for the semantic enrichment process (fully used, partially used, or unused) ,
Enum:
{
used: The field was fully used for semantic enrichment. ,
unused: The field was not used for semantic enrichment. ,
partial: The field was partially used for semantic enrichment. ,
}
,
Required: False ,
}
enum ,
}
,
contentFields:
{
Description: The content fields that were sent to the semantic enrichment process, as well as how they were used ,
Required: False ,
}
[
{
name:
{
Description: The name of the field that was sent to the semantic enrichment process ,
Required: False ,
}
string ,
state:
{
Description: The way the field was used for the semantic enrichment process (fully used, partially used, or unused) ,
Enum:
{
used: The field was fully used for semantic enrichment. ,
unused: The field was not used for semantic enrichment. ,
partial: The field was partially used for semantic enrichment. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
keywordFields:
{
Description: The keyword fields that were sent to the semantic enrichment process, as well as how they were used ,
Required: False ,
}
[
{
name:
{
Description: The name of the field that was sent to the semantic enrichment process ,
Required: False ,
}
string ,
state:
{
Description: The way the field was used for the semantic enrichment process (fully used, partially used, or unused) ,
Enum:
{
used: The field was fully used for semantic enrichment. ,
unused: The field was not used for semantic enrichment. ,
partial: The field was partially used for semantic enrichment. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
rerankerInput:
{
Description: The raw concatenated strings that were sent to the semantic enrichment process. ,
Required: False ,
}
{
title:
{
Description: The raw string for the title field that was used for semantic enrichment. ,
Required: False ,
}
string ,
content:
{
Description: The raw concatenated strings for the content fields that were used for semantic enrichment. ,
Required: False ,
}
string ,
keywords:
{
Description: The raw concatenated strings for the keyword fields that were used for semantic enrichment. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
}
,
]
,
@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 ,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_Get (new)
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 ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$schema:
{
Description: A document retrieved via a document lookup operation. ,
}
object ,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_SuggestGet (new)
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 ,
x-ms-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: True ,
}
[
{
@search.text:
{
Description: The text of the suggestion result. ,
Required: True ,
}
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 ,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_SuggestPost (new)
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: True ,
}
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: True ,
}
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 ,
x-ms-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: True ,
}
[
{
@search.text:
{
Description: The text of the suggestion result. ,
Required: True ,
}
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 ,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_Index (new)
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: Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case. ,
merge: Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types. ,
mergeOrUpload: Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document. ,
delete: Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-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: True ,
}
[
{
key:
{
Description: The key of a document that was in the indexing request. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
}
,
]
,
}

⚐ Response (207)

{
value:
{
Description: The list of status information for each document in the indexing request. ,
Required: True ,
}
[
{
key:
{
Description: The key of a document that was in the indexing request. ,
Required: True ,
}
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: True ,
}
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: True ,
}
integer ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_AutocompleteGet (new)
Description :  Autocompletes incomplete query terms based on input text and matching terms in the index.
Reference :  Link ¶

⚼ Request

GET:  /docs/search.autocomplete
{
x-ms-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)

{
@search.coverage:
{
Description: A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request. ,
Format: double ,
Required: False ,
}
number ,
value:
{
Description: The list of returned Autocompleted items. ,
Required: True ,
}
[
{
text:
{
Description: The completed term. ,
Required: True ,
}
string ,
queryPlusText:
{
Description: The query along with the completed term. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}
Documents_AutocompletePost (new)
Description :  Autocompletes incomplete query terms based on input text and matching terms in the index.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.post.autocomplete
{
x-ms-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: 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. ,
Enum:
{
oneTerm: Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'. ,
twoTerms: Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'. ,
oneTermWithContext: Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'. ,
}
,
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: True ,
}
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)

{
@search.coverage:
{
Description: A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request. ,
Format: double ,
Required: False ,
}
number ,
value:
{
Description: The list of returned Autocompleted items. ,
Required: True ,
}
[
{
text:
{
Description: The completed term. ,
Required: True ,
}
string ,
queryPlusText:
{
Description: The query along with the completed term. ,
Required: True ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
}