Azure AI Search (preview:2025-11-01)

2026/01/06 • 2 updated methods

Documents_SearchGet (updated)
Description :  Searches for documents in the index.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Documents_SearchGet",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "@search.nextPageParameters",
          "Description": {
            "new": "Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with",
            "old": "Continuation JSON payload returned when the query can't return all the requested results in a single 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."
          }
        },
        {
          "value": {
            "$properties": {
              "@search.documentDebugInfo": [
                {
                  "vectors": [
                    {
                      "subscores": [
                        {
                          "#name": "vectors",
                          "Description": {
                            "new": "The vector similarity and",
                            "old": "The vector similarity and @search.score values for each vector query."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    },
    "206": {
      "$properties": [
        {
          "#name": "@search.nextPageParameters",
          "Description": {
            "new": "Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with",
            "old": "Continuation JSON payload returned when the query can't return all the requested results in a single 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."
          }
        },
        {
          "value": {
            "$properties": {
              "@search.documentDebugInfo": [
                {
                  "vectors": [
                    {
                      "subscores": [
                        {
                          "#name": "vectors",
                          "Description": {
                            "new": "The vector similarity and",
                            "old": "The vector similarity and @search.score values for each vector query."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /indexes('{indexName}')/docs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
Accept:
{
Description: The Accept header. ,
Required: True ,
}
string ,
x-ms-query-source-authorization:
{
Description: Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. ,
Required: False ,
}
string ,
x-ms-enable-elevated-read:
{
Description: A value that enables elevated read that bypass document level permission checks for the query operation. ,
Required: False ,
}
boolean ,
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 ,
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 (default). ,
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 ,
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. The maximum character length of answers can be configured by appending the pipe character '|' followed by the 'count-', such as 'extractive|maxcharlength-600'. ,
Required: False ,
}
string ,
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`. The maximum character length of captions can be configured by appending the pipe character '|' followed by the 'count-', such as 'extractive|maxcharlength-600'. ,
Required: False ,
}
string ,
semanticQuery:
{
Description: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase. ,
Required: False ,
}
string ,
queryRewrites:
{
Description: When QueryRewrites is set to `generative`, the query terms are sent to a generate model which will produce 10 (default) rewrites to help increase the recall of the request. The requested count can be configured by appending the pipe character `|` followed by the `count-` option, such as `generative|count-3`. Defaults to `None`. This parameter is only valid if the query type is `semantic`. ,
Required: False ,
}
string ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your search results. ,
Required: False ,
}
string ,
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 ,
semanticFields:
{
Description: The list of field names used for semantic ranking. ,
Required: False ,
}
array ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
indexName:
{
Description: The name of the index. ,
Required: True ,
}
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 the query can't return all the requested documents in a single 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.debug:
{
Description: Debug information that applies to the search results as a whole. ,
Required: False ,
}
{
queryRewrites:
{
Description: Contains debugging information specific to query rewrites. ,
Required: False ,
}
{
text:
{
Description: List of query rewrites generated for the text query. ,
Required: False ,
}
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
vectors:
{
Description: List of query rewrites generated for the vectorizable text queries. ,
Required: False ,
}
[
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
@search.nextPageParameters:
{
Description: Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with ,
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 ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your reranked results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their reranked results. ,
vector: Allows the user to further explore their hybrid and vector query results. ,
queryRewrites: Allows the user to explore the list of query rewrites generated for their search request. ,
innerHits: Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. ,
all: Turn on all debug options. ,
}
,
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. ,
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. ,
gl-es: Query language value for Galician. ,
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 specifies 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 ,
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 ,
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 ,
semanticQuery:
{
Description: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase. ,
Required: False ,
}
string ,
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 ,
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 ,
queryRewrites:
{
Description: A value that specifies whether query rewrites should be generated to augment the search query. ,
Enum:
{
none: Do not generate additional query rewrites for this query. ,
generative: Generate alternative query terms to increase the recall of a search request. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic ranking. ,
Required: False ,
}
string ,
vectorQueries:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
[
{
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 ,
exhaustive:
{
Description: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values. ,
Required: False ,
}
boolean ,
oversampling:
{
Description: Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. ,
Format: float ,
Required: False ,
}
number ,
threshold:
{
Description: The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. ,
Required: False ,
}
{
kind:
{
Description: Type of threshold. ,
Enum:
{
vectorSimilarity: The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. ,
searchScore: The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score. ,
}
,
Required: True ,
}
enum ,
}
,
filterOverride:
{
Description: The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead. ,
Required: False ,
}
string ,
perDocumentVectorLimit:
{
Description: Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
kind:
{
Description: Type of query. ,
Enum:
{
vector: Vector query where a raw vector value is provided. ,
text: Vector query where a text value that needs to be vectorized is provided. ,
imageUrl: Vector query where an url that represents an image value that needs to be vectorized is provided. ,
imageBinary: Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorFilterMode:
{
Description: Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes. ,
Enum:
{
postFilter: The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'. ,
preFilter: The filter will be applied before the search query. ,
strictPostFilter: The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'. ,
}
,
Required: False ,
}
enum ,
hybridSearch:
{
Description: The query parameters to configure hybrid search behaviors. ,
Required: False ,
}
{
maxTextRecallSize:
{
Description: Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
countAndFacetMode:
{
Description: Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. ,
Enum:
{
countRetrievableResults: Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. ,
countAllResults: Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. ,
}
,
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.rerankerBoostedScore:
{
Description: The relevance score computed by boosting the Reranker Score. Search results are sorted by the RerankerScore/RerankerBoostedScore based on useScoringProfileBoostedRanking in the Semantic Config. RerankerBoostedScore 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 ranking requests. ,
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 ,
}
,
}
,
vectors:
{
Description: Contains debugging information specific to vector and hybrid search. ,
Required: False ,
}
{
subscores:
{
Description: The breakdown of subscores of the document prior to the chosen result set fusion/combination method such as RRF. ,
Required: False ,
}
{
text:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Required: False ,
}
{
searchScore:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
vectors:
{
Description: The vector similarity and ,
Required: False ,
}
[
object ,
]
,
documentBoost:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
innerHits:
{
Description: Contains debugging information specific to vectors matched within a collection of complex types. ,
Required: False ,
}
object ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: Continuation URL returned when the query can't return all the requested results in a single 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 ,
@search.semanticPartialResponseReason:
{
Description: Reason that a partial response was returned for a semantic ranking 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 ranking 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 ,
@search.semanticQueryRewritesResultType:
{
Description: Type of query rewrite that was used to retrieve documents. ,
Enum:
{
originalQueryOnly: Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (206)

{
@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 the query can't return all the requested documents in a single 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.debug:
{
Description: Debug information that applies to the search results as a whole. ,
Required: False ,
}
{
queryRewrites:
{
Description: Contains debugging information specific to query rewrites. ,
Required: False ,
}
{
text:
{
Description: List of query rewrites generated for the text query. ,
Required: False ,
}
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
vectors:
{
Description: List of query rewrites generated for the vectorizable text queries. ,
Required: False ,
}
[
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
@search.nextPageParameters:
{
Description: Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with ,
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 ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your reranked results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their reranked results. ,
vector: Allows the user to further explore their hybrid and vector query results. ,
queryRewrites: Allows the user to explore the list of query rewrites generated for their search request. ,
innerHits: Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. ,
all: Turn on all debug options. ,
}
,
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. ,
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. ,
gl-es: Query language value for Galician. ,
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 specifies 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 ,
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 ,
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 ,
semanticQuery:
{
Description: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase. ,
Required: False ,
}
string ,
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 ,
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 ,
queryRewrites:
{
Description: A value that specifies whether query rewrites should be generated to augment the search query. ,
Enum:
{
none: Do not generate additional query rewrites for this query. ,
generative: Generate alternative query terms to increase the recall of a search request. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic ranking. ,
Required: False ,
}
string ,
vectorQueries:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
[
{
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 ,
exhaustive:
{
Description: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values. ,
Required: False ,
}
boolean ,
oversampling:
{
Description: Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. ,
Format: float ,
Required: False ,
}
number ,
threshold:
{
Description: The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. ,
Required: False ,
}
{
kind:
{
Description: Type of threshold. ,
Enum:
{
vectorSimilarity: The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. ,
searchScore: The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score. ,
}
,
Required: True ,
}
enum ,
}
,
filterOverride:
{
Description: The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead. ,
Required: False ,
}
string ,
perDocumentVectorLimit:
{
Description: Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
kind:
{
Description: Type of query. ,
Enum:
{
vector: Vector query where a raw vector value is provided. ,
text: Vector query where a text value that needs to be vectorized is provided. ,
imageUrl: Vector query where an url that represents an image value that needs to be vectorized is provided. ,
imageBinary: Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorFilterMode:
{
Description: Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes. ,
Enum:
{
postFilter: The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'. ,
preFilter: The filter will be applied before the search query. ,
strictPostFilter: The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'. ,
}
,
Required: False ,
}
enum ,
hybridSearch:
{
Description: The query parameters to configure hybrid search behaviors. ,
Required: False ,
}
{
maxTextRecallSize:
{
Description: Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
countAndFacetMode:
{
Description: Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. ,
Enum:
{
countRetrievableResults: Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. ,
countAllResults: Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. ,
}
,
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.rerankerBoostedScore:
{
Description: The relevance score computed by boosting the Reranker Score. Search results are sorted by the RerankerScore/RerankerBoostedScore based on useScoringProfileBoostedRanking in the Semantic Config. RerankerBoostedScore 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 ranking requests. ,
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 ,
}
,
}
,
vectors:
{
Description: Contains debugging information specific to vector and hybrid search. ,
Required: False ,
}
{
subscores:
{
Description: The breakdown of subscores of the document prior to the chosen result set fusion/combination method such as RRF. ,
Required: False ,
}
{
text:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Required: False ,
}
{
searchScore:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
vectors:
{
Description: The vector similarity and ,
Required: False ,
}
[
object ,
]
,
documentBoost:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
innerHits:
{
Description: Contains debugging information specific to vectors matched within a collection of complex types. ,
Required: False ,
}
object ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: Continuation URL returned when the query can't return all the requested results in a single 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 ,
@search.semanticPartialResponseReason:
{
Description: Reason that a partial response was returned for a semantic ranking 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 ranking 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 ,
@search.semanticQueryRewritesResultType:
{
Description: Type of query rewrite that was used to retrieve documents. ,
Enum:
{
originalQueryOnly: Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Documents_SearchPost (updated)
Description :  Searches for documents in the index.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Documents_SearchPost",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "@search.nextPageParameters",
          "Description": {
            "new": "Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with",
            "old": "Continuation JSON payload returned when the query can't return all the requested results in a single 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."
          }
        },
        {
          "value": {
            "$properties": {
              "@search.documentDebugInfo": [
                {
                  "vectors": [
                    {
                      "subscores": [
                        {
                          "#name": "vectors",
                          "Description": {
                            "new": "The vector similarity and",
                            "old": "The vector similarity and @search.score values for each vector query."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    },
    "206": {
      "$properties": [
        {
          "#name": "@search.nextPageParameters",
          "Description": {
            "new": "Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with",
            "old": "Continuation JSON payload returned when the query can't return all the requested results in a single 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."
          }
        },
        {
          "value": {
            "$properties": {
              "@search.documentDebugInfo": [
                {
                  "vectors": [
                    {
                      "subscores": [
                        {
                          "#name": "vectors",
                          "Description": {
                            "new": "The vector similarity and",
                            "old": "The vector similarity and @search.score values for each vector query."
                          }
                        }
                      ]
                    }
                  ]
                }
              ]
            }
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /indexes('{indexName}')/docs/search.post.search
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
Accept:
{
Description: The Accept header. ,
Required: True ,
}
string ,
x-ms-query-source-authorization:
{
Description: Token identifying the user for which the query is being executed. This token is used to enforce security restrictions on documents. ,
Required: False ,
}
string ,
x-ms-enable-elevated-read:
{
Description: A value that enables elevated read that bypass document level permission checks for the query operation. ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
indexName:
{
Description: The name of the index. ,
Required: True ,
}
string ,
body:
{
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 ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your reranked results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their reranked results. ,
vector: Allows the user to further explore their hybrid and vector query results. ,
queryRewrites: Allows the user to explore the list of query rewrites generated for their search request. ,
innerHits: Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. ,
all: Turn on all debug options. ,
}
,
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. ,
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. ,
gl-es: Query language value for Galician. ,
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 specifies 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 ,
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 ,
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 ,
semanticQuery:
{
Description: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase. ,
Required: False ,
}
string ,
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 ,
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 ,
queryRewrites:
{
Description: A value that specifies whether query rewrites should be generated to augment the search query. ,
Enum:
{
none: Do not generate additional query rewrites for this query. ,
generative: Generate alternative query terms to increase the recall of a search request. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic ranking. ,
Required: False ,
}
string ,
vectorQueries:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
[
{
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 ,
exhaustive:
{
Description: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values. ,
Required: False ,
}
boolean ,
oversampling:
{
Description: Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. ,
Format: float ,
Required: False ,
}
number ,
threshold:
{
Description: The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. ,
Required: False ,
}
{
kind:
{
Description: Type of threshold. ,
Enum:
{
vectorSimilarity: The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. ,
searchScore: The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score. ,
}
,
Required: True ,
}
enum ,
}
,
filterOverride:
{
Description: The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead. ,
Required: False ,
}
string ,
perDocumentVectorLimit:
{
Description: Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
kind:
{
Description: Type of query. ,
Enum:
{
vector: Vector query where a raw vector value is provided. ,
text: Vector query where a text value that needs to be vectorized is provided. ,
imageUrl: Vector query where an url that represents an image value that needs to be vectorized is provided. ,
imageBinary: Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorFilterMode:
{
Description: Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes. ,
Enum:
{
postFilter: The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'. ,
preFilter: The filter will be applied before the search query. ,
strictPostFilter: The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'. ,
}
,
Required: False ,
}
enum ,
hybridSearch:
{
Description: The query parameters to configure hybrid search behaviors. ,
Required: False ,
}
{
maxTextRecallSize:
{
Description: Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
countAndFacetMode:
{
Description: Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. ,
Enum:
{
countRetrievableResults: Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. ,
countAllResults: Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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 the query can't return all the requested documents in a single 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.debug:
{
Description: Debug information that applies to the search results as a whole. ,
Required: False ,
}
{
queryRewrites:
{
Description: Contains debugging information specific to query rewrites. ,
Required: False ,
}
{
text:
{
Description: List of query rewrites generated for the text query. ,
Required: False ,
}
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
vectors:
{
Description: List of query rewrites generated for the vectorizable text queries. ,
Required: False ,
}
[
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
@search.nextPageParameters:
{
Description: Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with ,
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 ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your reranked results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their reranked results. ,
vector: Allows the user to further explore their hybrid and vector query results. ,
queryRewrites: Allows the user to explore the list of query rewrites generated for their search request. ,
innerHits: Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. ,
all: Turn on all debug options. ,
}
,
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. ,
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. ,
gl-es: Query language value for Galician. ,
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 specifies 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 ,
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 ,
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 ,
semanticQuery:
{
Description: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase. ,
Required: False ,
}
string ,
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 ,
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 ,
queryRewrites:
{
Description: A value that specifies whether query rewrites should be generated to augment the search query. ,
Enum:
{
none: Do not generate additional query rewrites for this query. ,
generative: Generate alternative query terms to increase the recall of a search request. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic ranking. ,
Required: False ,
}
string ,
vectorQueries:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
[
{
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 ,
exhaustive:
{
Description: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values. ,
Required: False ,
}
boolean ,
oversampling:
{
Description: Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. ,
Format: float ,
Required: False ,
}
number ,
threshold:
{
Description: The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. ,
Required: False ,
}
{
kind:
{
Description: Type of threshold. ,
Enum:
{
vectorSimilarity: The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. ,
searchScore: The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score. ,
}
,
Required: True ,
}
enum ,
}
,
filterOverride:
{
Description: The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead. ,
Required: False ,
}
string ,
perDocumentVectorLimit:
{
Description: Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
kind:
{
Description: Type of query. ,
Enum:
{
vector: Vector query where a raw vector value is provided. ,
text: Vector query where a text value that needs to be vectorized is provided. ,
imageUrl: Vector query where an url that represents an image value that needs to be vectorized is provided. ,
imageBinary: Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorFilterMode:
{
Description: Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes. ,
Enum:
{
postFilter: The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'. ,
preFilter: The filter will be applied before the search query. ,
strictPostFilter: The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'. ,
}
,
Required: False ,
}
enum ,
hybridSearch:
{
Description: The query parameters to configure hybrid search behaviors. ,
Required: False ,
}
{
maxTextRecallSize:
{
Description: Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
countAndFacetMode:
{
Description: Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. ,
Enum:
{
countRetrievableResults: Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. ,
countAllResults: Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. ,
}
,
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.rerankerBoostedScore:
{
Description: The relevance score computed by boosting the Reranker Score. Search results are sorted by the RerankerScore/RerankerBoostedScore based on useScoringProfileBoostedRanking in the Semantic Config. RerankerBoostedScore 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 ranking requests. ,
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 ,
}
,
}
,
vectors:
{
Description: Contains debugging information specific to vector and hybrid search. ,
Required: False ,
}
{
subscores:
{
Description: The breakdown of subscores of the document prior to the chosen result set fusion/combination method such as RRF. ,
Required: False ,
}
{
text:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Required: False ,
}
{
searchScore:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
vectors:
{
Description: The vector similarity and ,
Required: False ,
}
[
object ,
]
,
documentBoost:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
innerHits:
{
Description: Contains debugging information specific to vectors matched within a collection of complex types. ,
Required: False ,
}
object ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: Continuation URL returned when the query can't return all the requested results in a single 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 ,
@search.semanticPartialResponseReason:
{
Description: Reason that a partial response was returned for a semantic ranking 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 ranking 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 ,
@search.semanticQueryRewritesResultType:
{
Description: Type of query rewrite that was used to retrieve documents. ,
Enum:
{
originalQueryOnly: Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (206)

{
@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 the query can't return all the requested documents in a single 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.debug:
{
Description: Debug information that applies to the search results as a whole. ,
Required: False ,
}
{
queryRewrites:
{
Description: Contains debugging information specific to query rewrites. ,
Required: False ,
}
{
text:
{
Description: List of query rewrites generated for the text query. ,
Required: False ,
}
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
vectors:
{
Description: List of query rewrites generated for the vectorizable text queries. ,
Required: False ,
}
[
{
inputQuery:
{
Description: The input text to the generative query rewriting model. There may be cases where the user query and the input to the generative model are not identical. ,
Required: False ,
}
string ,
rewrites:
{
Description: List of query rewrites. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}
,
@search.nextPageParameters:
{
Description: Continuation JSON payload returned when the query can't return all the requested results in a single response. You can use this JSON along with ,
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 ,
debug:
{
Description: Enables a debugging tool that can be used to further explore your reranked results. ,
Enum:
{
disabled: No query debugging information will be returned. ,
semantic: Allows the user to further explore their reranked results. ,
vector: Allows the user to further explore their hybrid and vector query results. ,
queryRewrites: Allows the user to explore the list of query rewrites generated for their search request. ,
innerHits: Allows the user to retrieve scoring information regarding vectors matched within a collection of complex types. ,
all: Turn on all debug options. ,
}
,
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. ,
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. ,
gl-es: Query language value for Galician. ,
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 specifies 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 ,
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 ,
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 ,
semanticQuery:
{
Description: Allows setting a separate search query that will be solely used for semantic reranking, semantic captions and semantic answers. Is useful for scenarios where there is a need to use different queries between the base retrieval and ranking phase, and the L2 semantic phase. ,
Required: False ,
}
string ,
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 ,
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 ,
queryRewrites:
{
Description: A value that specifies whether query rewrites should be generated to augment the search query. ,
Enum:
{
none: Do not generate additional query rewrites for this query. ,
generative: Generate alternative query terms to increase the recall of a search request. ,
}
,
Required: False ,
}
enum ,
semanticFields:
{
Description: The comma-separated list of field names used for semantic ranking. ,
Required: False ,
}
string ,
vectorQueries:
{
Description: The query parameters for vector and hybrid search queries. ,
Required: False ,
}
[
{
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 ,
exhaustive:
{
Description: When true, triggers an exhaustive k-nearest neighbor search across all vectors within the vector index. Useful for scenarios where exact matches are critical, such as determining ground truth values. ,
Required: False ,
}
boolean ,
oversampling:
{
Description: Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' is true. This parameter is only permitted when a compression method is used on the underlying vector field. ,
Format: double ,
Required: False ,
}
number ,
weight:
{
Description: Relative weight of the vector query when compared to other vector query and/or the text query within the same search request. This value is used when combining the results of multiple ranking lists produced by the different vector queries and/or the results retrieved through the text query. The higher the weight, the higher the documents that matched that query will be in the final ranking. Default is 1.0 and the value needs to be a positive number larger than zero. ,
Format: float ,
Required: False ,
}
number ,
threshold:
{
Description: The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. ,
Required: False ,
}
{
kind:
{
Description: Type of threshold. ,
Enum:
{
vectorSimilarity: The results of the vector query will be filtered based on the vector similarity metric. Note this is the canonical definition of similarity metric, not the 'distance' version. The threshold direction (larger or smaller) will be chosen automatically according to the metric used by the field. ,
searchScore: The results of the vector query will filter based on the '@search.score' value. Note this is the @search.score returned as part of the search response. The threshold direction will be chosen for higher @search.score. ,
}
,
Required: True ,
}
enum ,
}
,
filterOverride:
{
Description: The OData filter expression to apply to this specific vector query. If no filter expression is defined at the vector level, the expression defined in the top level filter parameter is used instead. ,
Required: False ,
}
string ,
perDocumentVectorLimit:
{
Description: Controls how many vectors can be matched from each document in a vector search query. Setting it to 1 ensures at most one vector per document is matched, guaranteeing results come from distinct documents. Setting it to 0 (unlimited) allows multiple relevant vectors from the same document to be matched. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
kind:
{
Description: Type of query. ,
Enum:
{
vector: Vector query where a raw vector value is provided. ,
text: Vector query where a text value that needs to be vectorized is provided. ,
imageUrl: Vector query where an url that represents an image value that needs to be vectorized is provided. ,
imageBinary: Vector query where a base 64 encoded binary of an image that needs to be vectorized is provided. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorFilterMode:
{
Description: Determines whether or not filters are applied before or after the vector search is performed. Default is 'preFilter' for new indexes. ,
Enum:
{
postFilter: The filter will be applied after the candidate set of vector results is returned. Depending on the filter selectivity, this can result in fewer results than requested by the parameter 'k'. ,
preFilter: The filter will be applied before the search query. ,
strictPostFilter: The filter will be applied after the global top-k candidate set of vector results is returned. This will result in fewer results than requested by the parameter 'k'. ,
}
,
Required: False ,
}
enum ,
hybridSearch:
{
Description: The query parameters to configure hybrid search behaviors. ,
Required: False ,
}
{
maxTextRecallSize:
{
Description: Determines the maximum number of documents to be retrieved by the text query portion of a hybrid search request. Those documents will be combined with the documents matching the vector queries to produce a single final list of results. Choosing a larger maxTextRecallSize value will allow retrieving and paging through more documents (using the top and skip parameters), at the cost of higher resource utilization and higher latency. The value needs to be between 1 and 10,000. Default is 1000. ,
Format: int32 ,
Required: False ,
}
integer ,
countAndFacetMode:
{
Description: Determines whether the count and facets should includes all documents that matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. ,
Enum:
{
countRetrievableResults: Only include documents that were matched within the 'maxTextRecallSize' retrieval window when computing 'count' and 'facets'. ,
countAllResults: Include all documents that were matched by the search query when computing 'count' and 'facets', regardless of whether or not those documents are within the 'maxTextRecallSize' retrieval window. ,
}
,
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.rerankerBoostedScore:
{
Description: The relevance score computed by boosting the Reranker Score. Search results are sorted by the RerankerScore/RerankerBoostedScore based on useScoringProfileBoostedRanking in the Semantic Config. RerankerBoostedScore 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 ranking requests. ,
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 ,
}
,
}
,
vectors:
{
Description: Contains debugging information specific to vector and hybrid search. ,
Required: False ,
}
{
subscores:
{
Description: The breakdown of subscores of the document prior to the chosen result set fusion/combination method such as RRF. ,
Required: False ,
}
{
text:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Required: False ,
}
{
searchScore:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
vectors:
{
Description: The vector similarity and ,
Required: False ,
}
[
object ,
]
,
documentBoost:
{
Description: The BM25 or Classic score for the text portion of the query. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
innerHits:
{
Description: Contains debugging information specific to vectors matched within a collection of complex types. ,
Required: False ,
}
object ,
}
,
}
,
]
,
@odata.nextLink:
{
Description: Continuation URL returned when the query can't return all the requested results in a single 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 ,
@search.semanticPartialResponseReason:
{
Description: Reason that a partial response was returned for a semantic ranking 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 ranking 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 ,
@search.semanticQueryRewritesResultType:
{
Description: Type of query rewrite that was used to retrieve documents. ,
Enum:
{
originalQueryOnly: Query rewrites were not successfully generated for this request. Only the original query was used to retrieve the results. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}