Azure.Search (preview:2025-08-01)

2025/07/30 • 60 new methods

KnowledgeRetrieval_Retrieve (new)
Description :  KnowledgeAgent retrieves relevant data from backing stores.
Reference :  Link ¶

⚼ Request

POST:  /retrieve
{
retrievalRequest:
{
Description: The retrieval request to process. ,
Required: True ,
}
{
messages:
{
Required: True ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: False ,
}
string ,
content:
{
Required: True ,
}
[
{
type:
{
Description: The type of the message ,
Enum:
{
text: Text message content kind. ,
image: Image message content kind. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
knowledgeSourceParams:
{
Required: False ,
}
[
{
knowledgeSourceName:
{
Description: The name of the index the params apply to. ,
Required: True ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
response:
{
Required: False ,
}
[
{
role:
{
Description: The role of the tool response. ,
Required: False ,
}
string ,
content:
{
Required: True ,
}
[
{
type:
{
Description: The type of the message ,
Enum:
{
text: Text message content kind. ,
image: Image message content kind. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
]
,
activity:
{
Description: The activity records for tracking progress and billing implications. ,
Required: False ,
}
[
{
id:
{
Description: The ID of the activity record. ,
Format: int32 ,
Required: True ,
}
integer ,
type:
{
Description: The type of the activity record. ,
Required: True ,
}
string ,
elapsedMs:
{
Description: The elapsed time in milliseconds for the retrieval activity. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
references:
{
Description: The references for the retrieval data used in the response. ,
Required: False ,
}
[
{
type:
{
Description: The type of the reference. ,
Required: True ,
}
string ,
id:
{
Description: The ID of the reference. ,
Required: True ,
}
string ,
activitySource:
{
Description: The source activity ID for the reference. ,
Format: int32 ,
Required: True ,
}
integer ,
sourceData:
{
Required: False ,
}
object ,
rerankerScore:
{
Description: The reranker score for the document reference. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
}

⚐ 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_Count (new)
Description :  Queries the number of documents in the index.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
$schema:
{
Format: int64 ,
}
integer ,
}

⚐ Response (default)

{
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_SearchGet (new)
Description :  Searches for documents in the index.
Reference :  Link ¶

⚼ Request

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

⚐ 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 @odata.nextLink to formulate another POST Search request to get the next part of the search response. ,
Required: False ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. ,
Format: double ,
Required: False ,
}
number ,
orderby:
{
Description: The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
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 specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
kind:
{
Description: The kind of vector query being performed. ,
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 ,
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: The kind of threshold used to filter vector queries ,
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 ,
}
,
]
,
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 @search.score values for each vector query. ,
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 @odata.nextLink to formulate another POST Search request to get the next part of the search response. ,
Required: False ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. ,
Format: double ,
Required: False ,
}
number ,
orderby:
{
Description: The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
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 specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
kind:
{
Description: The kind of vector query being performed. ,
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 ,
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: The kind of threshold used to filter vector queries ,
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 ,
}
,
]
,
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 @search.score values for each vector query. ,
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 (new)
Description :  Searches for documents in the index.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.post.search
{
searchRequest:
{
Description: The definition of the Search request. ,
Required: True ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. ,
Format: double ,
Required: False ,
}
number ,
orderby:
{
Description: The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
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 specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
kind:
{
Description: The kind of vector query being performed. ,
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 ,
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: The kind of threshold used to filter vector queries ,
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 ,
}
,
]
,
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 ,
}
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
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 ,
}

⚐ 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 @odata.nextLink to formulate another POST Search request to get the next part of the search response. ,
Required: False ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. ,
Format: double ,
Required: False ,
}
number ,
orderby:
{
Description: The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
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 specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
kind:
{
Description: The kind of vector query being performed. ,
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 ,
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: The kind of threshold used to filter vector queries ,
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 ,
}
,
]
,
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 @search.score values for each vector query. ,
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 @odata.nextLink to formulate another POST Search request to get the next part of the search response. ,
Required: False ,
}
{
count:
{
Description: A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation. ,
Required: False ,
}
boolean ,
facets:
{
Description: The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs. ,
Required: False ,
}
[
string ,
]
,
filter:
{
Description: The OData $filter expression to apply to the search query. ,
Required: False ,
}
string ,
highlight:
{
Description: The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting. ,
Required: False ,
}
string ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100. ,
Format: double ,
Required: False ,
}
number ,
orderby:
{
Description: The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. ,
Required: False ,
}
string ,
queryType:
{
Description: A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax. ,
Enum:
{
simple: Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and "". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified. ,
full: Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features. ,
semantic: Best suited for queries expressed in natural language as opposed to keywords. Improves precision of search results by re-ranking the top search results using a ranking model trained on the Web corpus. ,
}
,
Required: False ,
}
enum ,
scoringStatistics:
{
Description: A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries. ,
Enum:
{
local: The scoring statistics will be calculated locally for lower latency. ,
global: The scoring statistics will be calculated globally for more consistent scoring. ,
}
,
Required: False ,
}
enum ,
sessionId:
{
Description: A value to be used to create a sticky session, which can help getting more consistent results. As long as the same sessionId is used, a best-effort attempt will be made to target the same replica set. Be wary that reusing the same sessionID values repeatedly can interfere with the load balancing of the requests across replicas and adversely affect the performance of the search service. The value used as sessionId cannot start with a '_' character. ,
Required: False ,
}
string ,
scoringParameters:
{
Description: The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be "mylocation--122.2,44.8" (without the quotes). ,
Required: False ,
}
[
string ,
]
,
scoringProfile:
{
Description: The name of a scoring profile to evaluate match scores for matching documents in order to sort the results. ,
Required: False ,
}
string ,
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 specified the type of the speller to use to spell-correct individual search query terms. ,
Enum:
{
none: Speller not enabled. ,
lexicon: Speller corrects individual query terms using a static lexicon for the language specified by the queryLanguage parameter. ,
}
,
Required: False ,
}
enum ,
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 ,
}
[
{
kind:
{
Description: The kind of vector query being performed. ,
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 ,
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: The kind of threshold used to filter vector queries ,
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 ,
}
,
]
,
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 @search.score values for each vector query. ,
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_Get (new)
Description :  Retrieves a document from the index.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ 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_SuggestGet (new)
Description :  Suggests documents in the index that match the given partial query text.
Reference :  Link ¶

⚼ Request

GET:  /docs/search.suggest
{
search:
{
Description: The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters. ,
Required: True ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: True ,
}
string ,
$filter:
{
Description: An OData expression that filters the documents considered for suggestions. ,
Required: False ,
}
string ,
fuzzy:
{
Description: A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80. ,
Format: double ,
Required: False ,
}
number ,
$orderby:
{
Description: The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. ,
Required: False ,
}
array ,
searchFields:
{
Description: The list of field names to search for the specified search text. Target fields must be included in the specified suggester. ,
Required: False ,
}
array ,
$select:
{
Description: The list of fields to retrieve. If unspecified, only the key field will be included in the results. ,
Required: False ,
}
array ,
$top:
{
Description: The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sequence of results returned by the query. ,
Required: True ,
}
[
{
@search.text:
{
Description: The text of the suggestion result. ,
Required: True ,
}
string ,
}
,
]
,
@search.coverage:
{
Description: A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request. ,
Format: double ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
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_SuggestPost (new)
Description :  Suggests documents in the index that match the given partial query text.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.post.suggest
{
suggestRequest:
{
Description: The Suggest request. ,
Required: True ,
}
{
filter:
{
Description: An OData expression that filters the documents considered for suggestions. ,
Required: False ,
}
string ,
fuzzy:
{
Description: A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80. ,
Format: double ,
Required: False ,
}
number ,
orderby:
{
Description: The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses. ,
Required: False ,
}
string ,
search:
{
Description: The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters. ,
Required: True ,
}
string ,
searchFields:
{
Description: The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester. ,
Required: False ,
}
string ,
select:
{
Description: The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results. ,
Required: False ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: True ,
}
string ,
top:
{
Description: The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sequence of results returned by the query. ,
Required: True ,
}
[
{
@search.text:
{
Description: The text of the suggestion result. ,
Required: True ,
}
string ,
}
,
]
,
@search.coverage:
{
Description: A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request. ,
Format: double ,
Required: False ,
}
number ,
}

⚐ Response (default)

{
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_Index (new)
Description :  Sends a batch of document write actions to the index.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.index
{
batch:
{
Description: The batch of index actions. ,
Required: True ,
}
{
value:
{
Description: The actions in the batch. ,
Required: True ,
}
[
{
@search.action:
{
Description: The operation to perform on a document in an indexing batch. ,
Enum:
{
upload: Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case. ,
merge: Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types. ,
mergeOrUpload: Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document. ,
delete: Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (207)

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

⚐ Response (default)

{
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_AutocompleteGet (new)
Description :  Autocompletes incomplete query terms based on input text and matching terms in the index.
Reference :  Link ¶

⚼ Request

GET:  /docs/search.autocomplete
{
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
search:
{
Description: The incomplete term which should be auto-completed. ,
Required: True ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: True ,
}
string ,
autocompleteMode:
{
Description: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms. ,
Required: False ,
}
string ,
$filter:
{
Description: An OData expression that filters the documents used to produce completed terms for the Autocomplete result. ,
Required: False ,
}
string ,
fuzzy:
{
Description: A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80. ,
Format: double ,
Required: False ,
}
number ,
searchFields:
{
Description: The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester. ,
Required: False ,
}
array ,
$top:
{
Description: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}

⚐ Response (200)

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

⚐ Response (default)

{
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_AutocompletePost (new)
Description :  Autocompletes incomplete query terms based on input text and matching terms in the index.
Reference :  Link ¶

⚼ Request

POST:  /docs/search.post.autocomplete
{
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
autocompleteRequest:
{
Description: The definition of the Autocomplete request. ,
Required: True ,
}
{
search:
{
Description: The search text on which to base autocomplete results. ,
Required: True ,
}
string ,
autocompleteMode:
{
Description: Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms. ,
Enum:
{
oneTerm: Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'. ,
twoTerms: Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'. ,
oneTermWithContext: Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'. ,
}
,
Required: False ,
}
enum ,
filter:
{
Description: An OData expression that filters the documents used to produce completed terms for the Autocomplete result. ,
Required: False ,
}
string ,
fuzzy:
{
Description: A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources. ,
Required: False ,
}
boolean ,
highlightPostTag:
{
Description: A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
highlightPreTag:
{
Description: A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled. ,
Required: False ,
}
string ,
minimumCoverage:
{
Description: A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80. ,
Format: double ,
Required: False ,
}
number ,
searchFields:
{
Description: The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester. ,
Required: False ,
}
string ,
suggesterName:
{
Description: The name of the suggester as specified in the suggesters collection that's part of the index definition. ,
Required: True ,
}
string ,
top:
{
Description: The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
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 ,
}
,
]
,
}
,
}
KnowledgeAgents_CreateOrUpdate (new)
Description :  Creates a new agent or updates an agent if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /agents('{agentName}')
{
agentName:
{
Description: The name of the agent to create or update. ,
Required: True ,
}
string ,
KnowledgeAgent:
{
Description: The definition of the agent to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the knowledge agent. ,
Required: True ,
}
string ,
models:
{
Description: Contains configuration options on how to connect to AI models. ,
Required: True ,
}
[
{
kind:
{
Description: The type of AI model. ,
Enum:
{
azureOpenAI: Use Azure Open AI models for query planning. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
knowledgeSources:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
maxSubQueries:
{
Description: The maximum number of queries that can be issued at a time when retrieving data from this source. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
outputConfiguration:
{
Required: False ,
}
{
modality:
{
Description: The output configuration for the agent ,
Enum:
{
answerSynthesis: Synthesize an answer for the response payload. ,
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
}
,
Required: False ,
}
enum ,
answerInstructions:
{
Description: Instructions considered by the knowledge agent when generating answers ,
Required: False ,
}
string ,
attemptFastPath:
{
Description: Indicates whether the agent should attempt to issue the most recent chat message as a direct query to the knowledge sources, bypassing the model calls. ,
Required: False ,
}
boolean ,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
}
,
requestLimits:
{
Description: Guardrails to limit how much resources are utilized for a single agent retrieval request. ,
Required: False ,
}
{
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
retrievalInstructions:
{
Description: Instructions considered by the knowledge agent when developing query plan. ,
Required: False ,
}
string ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
description:
{
Description: The description of the agent. ,
Required: False ,
}
string ,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the knowledge agent. ,
Required: True ,
}
string ,
models:
{
Description: Contains configuration options on how to connect to AI models. ,
Required: True ,
}
[
{
kind:
{
Description: The type of AI model. ,
Enum:
{
azureOpenAI: Use Azure Open AI models for query planning. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
knowledgeSources:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
maxSubQueries:
{
Description: The maximum number of queries that can be issued at a time when retrieving data from this source. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
outputConfiguration:
{
Required: False ,
}
{
modality:
{
Description: The output configuration for the agent ,
Enum:
{
answerSynthesis: Synthesize an answer for the response payload. ,
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
}
,
Required: False ,
}
enum ,
answerInstructions:
{
Description: Instructions considered by the knowledge agent when generating answers ,
Required: False ,
}
string ,
attemptFastPath:
{
Description: Indicates whether the agent should attempt to issue the most recent chat message as a direct query to the knowledge sources, bypassing the model calls. ,
Required: False ,
}
boolean ,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
}
,
requestLimits:
{
Description: Guardrails to limit how much resources are utilized for a single agent retrieval request. ,
Required: False ,
}
{
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
retrievalInstructions:
{
Description: Instructions considered by the knowledge agent when developing query plan. ,
Required: False ,
}
string ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
description:
{
Description: The description of the agent. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the knowledge agent. ,
Required: True ,
}
string ,
models:
{
Description: Contains configuration options on how to connect to AI models. ,
Required: True ,
}
[
{
kind:
{
Description: The type of AI model. ,
Enum:
{
azureOpenAI: Use Azure Open AI models for query planning. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
knowledgeSources:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
maxSubQueries:
{
Description: The maximum number of queries that can be issued at a time when retrieving data from this source. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
outputConfiguration:
{
Required: False ,
}
{
modality:
{
Description: The output configuration for the agent ,
Enum:
{
answerSynthesis: Synthesize an answer for the response payload. ,
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
}
,
Required: False ,
}
enum ,
answerInstructions:
{
Description: Instructions considered by the knowledge agent when generating answers ,
Required: False ,
}
string ,
attemptFastPath:
{
Description: Indicates whether the agent should attempt to issue the most recent chat message as a direct query to the knowledge sources, bypassing the model calls. ,
Required: False ,
}
boolean ,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
}
,
requestLimits:
{
Description: Guardrails to limit how much resources are utilized for a single agent retrieval request. ,
Required: False ,
}
{
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
retrievalInstructions:
{
Description: Instructions considered by the knowledge agent when developing query plan. ,
Required: False ,
}
string ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
description:
{
Description: The description of the agent. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeAgents_Delete (new)
Description :  Deletes an existing agent.
Reference :  Link ¶

⚼ Request

DELETE:  /agents('{agentName}')
{
agentName:
{
Description: The name of the agent to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeAgents_Get (new)
Description :  Retrieves an agent definition.
Reference :  Link ¶

⚼ Request

GET:  /agents('{agentName}')
{
agentName:
{
Description: The name of the agent to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the knowledge agent. ,
Required: True ,
}
string ,
models:
{
Description: Contains configuration options on how to connect to AI models. ,
Required: True ,
}
[
{
kind:
{
Description: The type of AI model. ,
Enum:
{
azureOpenAI: Use Azure Open AI models for query planning. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
knowledgeSources:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
maxSubQueries:
{
Description: The maximum number of queries that can be issued at a time when retrieving data from this source. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
outputConfiguration:
{
Required: False ,
}
{
modality:
{
Description: The output configuration for the agent ,
Enum:
{
answerSynthesis: Synthesize an answer for the response payload. ,
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
}
,
Required: False ,
}
enum ,
answerInstructions:
{
Description: Instructions considered by the knowledge agent when generating answers ,
Required: False ,
}
string ,
attemptFastPath:
{
Description: Indicates whether the agent should attempt to issue the most recent chat message as a direct query to the knowledge sources, bypassing the model calls. ,
Required: False ,
}
boolean ,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
}
,
requestLimits:
{
Description: Guardrails to limit how much resources are utilized for a single agent retrieval request. ,
Required: False ,
}
{
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
retrievalInstructions:
{
Description: Instructions considered by the knowledge agent when developing query plan. ,
Required: False ,
}
string ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
description:
{
Description: The description of the agent. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeAgents_List (new)
Description :  Lists all agents available for a search service.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge agent. ,
Required: True ,
}
string ,
models:
{
Description: Contains configuration options on how to connect to AI models. ,
Required: True ,
}
[
{
kind:
{
Description: The type of AI model. ,
Enum:
{
azureOpenAI: Use Azure Open AI models for query planning. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
knowledgeSources:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
maxSubQueries:
{
Description: The maximum number of queries that can be issued at a time when retrieving data from this source. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
outputConfiguration:
{
Required: False ,
}
{
modality:
{
Description: The output configuration for the agent ,
Enum:
{
answerSynthesis: Synthesize an answer for the response payload. ,
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
}
,
Required: False ,
}
enum ,
answerInstructions:
{
Description: Instructions considered by the knowledge agent when generating answers ,
Required: False ,
}
string ,
attemptFastPath:
{
Description: Indicates whether the agent should attempt to issue the most recent chat message as a direct query to the knowledge sources, bypassing the model calls. ,
Required: False ,
}
boolean ,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
}
,
requestLimits:
{
Description: Guardrails to limit how much resources are utilized for a single agent retrieval request. ,
Required: False ,
}
{
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
retrievalInstructions:
{
Description: Instructions considered by the knowledge agent when developing query plan. ,
Required: False ,
}
string ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
description:
{
Description: The description of the agent. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeAgents_Create (new)
Description :  Creates a new agent.
Reference :  Link ¶

⚼ Request

POST:  /agents
{
KnowledgeAgent:
{
Description: The definition of the agent to create. ,
Required: True ,
}
{
name:
{
Description: The name of the knowledge agent. ,
Required: True ,
}
string ,
models:
{
Description: Contains configuration options on how to connect to AI models. ,
Required: True ,
}
[
{
kind:
{
Description: The type of AI model. ,
Enum:
{
azureOpenAI: Use Azure Open AI models for query planning. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
knowledgeSources:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
maxSubQueries:
{
Description: The maximum number of queries that can be issued at a time when retrieving data from this source. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
outputConfiguration:
{
Required: False ,
}
{
modality:
{
Description: The output configuration for the agent ,
Enum:
{
answerSynthesis: Synthesize an answer for the response payload. ,
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
}
,
Required: False ,
}
enum ,
answerInstructions:
{
Description: Instructions considered by the knowledge agent when generating answers ,
Required: False ,
}
string ,
attemptFastPath:
{
Description: Indicates whether the agent should attempt to issue the most recent chat message as a direct query to the knowledge sources, bypassing the model calls. ,
Required: False ,
}
boolean ,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
}
,
requestLimits:
{
Description: Guardrails to limit how much resources are utilized for a single agent retrieval request. ,
Required: False ,
}
{
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
retrievalInstructions:
{
Description: Instructions considered by the knowledge agent when developing query plan. ,
Required: False ,
}
string ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
description:
{
Description: The description of the agent. ,
Required: False ,
}
string ,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the knowledge agent. ,
Required: True ,
}
string ,
models:
{
Description: Contains configuration options on how to connect to AI models. ,
Required: True ,
}
[
{
kind:
{
Description: The type of AI model. ,
Enum:
{
azureOpenAI: Use Azure Open AI models for query planning. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
knowledgeSources:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
includeReferences:
{
Description: Indicates whether references should be included for data retrieved from this source. ,
Required: False ,
}
boolean ,
includeReferenceSourceData:
{
Description: Indicates whether references should include the structured data obtained during retrieval in their payload. ,
Required: False ,
}
boolean ,
alwaysQuerySource:
{
Description: Indicates that this knowledge source should bypass source selection and always be queried at retrieval time. ,
Required: False ,
}
boolean ,
maxSubQueries:
{
Description: The maximum number of queries that can be issued at a time when retrieving data from this source. ,
Format: int32 ,
Required: False ,
}
integer ,
rerankerThreshold:
{
Description: The reranker threshold all retrieved documents must meet to be included in the response. ,
Format: float ,
Required: False ,
}
number ,
}
,
]
,
outputConfiguration:
{
Required: False ,
}
{
modality:
{
Description: The output configuration for the agent ,
Enum:
{
answerSynthesis: Synthesize an answer for the response payload. ,
extractiveData: Return data from the knowledge sources directly without generative alteration. ,
}
,
Required: False ,
}
enum ,
answerInstructions:
{
Description: Instructions considered by the knowledge agent when generating answers ,
Required: False ,
}
string ,
attemptFastPath:
{
Description: Indicates whether the agent should attempt to issue the most recent chat message as a direct query to the knowledge sources, bypassing the model calls. ,
Required: False ,
}
boolean ,
includeActivity:
{
Description: Indicates retrieval results should include activity information. ,
Required: False ,
}
boolean ,
}
,
requestLimits:
{
Description: Guardrails to limit how much resources are utilized for a single agent retrieval request. ,
Required: False ,
}
{
maxRuntimeInSeconds:
{
Description: The maximum runtime in seconds. ,
Format: int32 ,
Required: False ,
}
integer ,
maxOutputSize:
{
Description: Limits the maximum size of the content in the output. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
retrievalInstructions:
{
Description: Instructions considered by the knowledge agent when developing query plan. ,
Required: False ,
}
string ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
description:
{
Description: The description of the agent. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeSources_CreateOrUpdate (new)
Description :  Creates a new knowledge source or updates an knowledge source if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /knowledgesources('{sourceName}')
{
sourceName:
{
Description: The name of the knowledge source to create or update. ,
Required: True ,
}
string ,
KnowledgeSource:
{
Description: The definition of the knowledge source to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeSources_Delete (new)
Description :  Deletes an existing knowledge source.
Reference :  Link ¶

⚼ Request

DELETE:  /knowledgesources('{sourceName}')
{
sourceName:
{
Description: The name of the knowledge source to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeSources_Get (new)
Description :  Retrieves a knowledge source definition.
Reference :  Link ¶

⚼ Request

GET:  /knowledgesources('{sourceName}')
{
sourceName:
{
Description: The name of the knowledge source to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeSources_List (new)
Description :  Lists all knowledge sources available for a search service.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Required: True ,
}
[
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
KnowledgeSources_Create (new)
Description :  Creates a new knowledge source.
Reference :  Link ¶

⚼ Request

POST:  /knowledgesources
{
KnowledgeSource:
{
Description: The definition of the knowledge source to create. ,
Required: True ,
}
{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the knowledge source. ,
Required: True ,
}
string ,
description:
{
Description: Optional user-defined description. ,
Required: False ,
}
string ,
kind:
{
Description: The type of the knowledge source. ,
Enum:
{
searchIndex: A knowledge source that reads data from a Search Index. ,
azureBlob: A knowledge source that read and ingest data from Azure Blob Storage to a Search Index. ,
web: A knowledge source that reads data from the web. ,
}
,
Required: True ,
}
enum ,
@odata.etag:
{
Description: The ETag of the agent. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your agent definition when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your agent definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your agent definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataSources_CreateOrUpdate (new)
Description :  Creates a new datasource or updates a datasource if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /datasources('{dataSourceName}')
{
dataSourceName:
{
Description: The name of the datasource to create or update. ,
Required: True ,
}
string ,
dataSource:
{
Description: The definition of the datasource to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Enum:
{
azuresql: Indicates an Azure SQL datasource. ,
cosmosdb: Indicates a CosmosDB datasource. ,
azureblob: Indicates an Azure Blob datasource. ,
azuretable: Indicates an Azure Table datasource. ,
mysql: Indicates a MySql datasource. ,
adlsgen2: Indicates an ADLS Gen2 datasource. ,
onelake: Indicates a Microsoft Fabric OneLake datasource. ,
}
,
Required: True ,
}
enum ,
subType:
{
Description: A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource. ,
Required: False ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
indexerPermissionOptions:
{
Description: Ingestion options with various types of permission data. ,
Required: False ,
}
[
string ,
]
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data change detection policy. ,
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data deletion detection policy. ,
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
ignoreResetRequirements:
{
Description: Ignores cache reset requirements. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Enum:
{
azuresql: Indicates an Azure SQL datasource. ,
cosmosdb: Indicates a CosmosDB datasource. ,
azureblob: Indicates an Azure Blob datasource. ,
azuretable: Indicates an Azure Table datasource. ,
mysql: Indicates a MySql datasource. ,
adlsgen2: Indicates an ADLS Gen2 datasource. ,
onelake: Indicates a Microsoft Fabric OneLake datasource. ,
}
,
Required: True ,
}
enum ,
subType:
{
Description: A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource. ,
Required: False ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
indexerPermissionOptions:
{
Description: Ingestion options with various types of permission data. ,
Required: False ,
}
[
string ,
]
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data change detection policy. ,
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data deletion detection policy. ,
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Enum:
{
azuresql: Indicates an Azure SQL datasource. ,
cosmosdb: Indicates a CosmosDB datasource. ,
azureblob: Indicates an Azure Blob datasource. ,
azuretable: Indicates an Azure Table datasource. ,
mysql: Indicates a MySql datasource. ,
adlsgen2: Indicates an ADLS Gen2 datasource. ,
onelake: Indicates a Microsoft Fabric OneLake datasource. ,
}
,
Required: True ,
}
enum ,
subType:
{
Description: A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource. ,
Required: False ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
indexerPermissionOptions:
{
Description: Ingestion options with various types of permission data. ,
Required: False ,
}
[
string ,
]
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data change detection policy. ,
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data deletion detection policy. ,
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataSources_Delete (new)
Description :  Deletes a datasource.
Reference :  Link ¶

⚼ Request

DELETE:  /datasources('{dataSourceName}')
{
dataSourceName:
{
Description: The name of the datasource to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
DataSources_Get (new)
Description :  Retrieves a datasource definition.
Reference :  Link ¶

⚼ Request

GET:  /datasources('{dataSourceName}')
{
dataSourceName:
{
Description: The name of the datasource to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Enum:
{
azuresql: Indicates an Azure SQL datasource. ,
cosmosdb: Indicates a CosmosDB datasource. ,
azureblob: Indicates an Azure Blob datasource. ,
azuretable: Indicates an Azure Table datasource. ,
mysql: Indicates a MySql datasource. ,
adlsgen2: Indicates an ADLS Gen2 datasource. ,
onelake: Indicates a Microsoft Fabric OneLake datasource. ,
}
,
Required: True ,
}
enum ,
subType:
{
Description: A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource. ,
Required: False ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
indexerPermissionOptions:
{
Description: Ingestion options with various types of permission data. ,
Required: False ,
}
[
string ,
]
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data change detection policy. ,
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data deletion detection policy. ,
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataSources_List (new)
Description :  Lists all datasources available for a search service.
Reference :  Link ¶

⚼ Request

GET:  /datasources
{
$select:
{
Description: Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The datasources in the Search service. ,
Required: True ,
}
[
{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Enum:
{
azuresql: Indicates an Azure SQL datasource. ,
cosmosdb: Indicates a CosmosDB datasource. ,
azureblob: Indicates an Azure Blob datasource. ,
azuretable: Indicates an Azure Table datasource. ,
mysql: Indicates a MySql datasource. ,
adlsgen2: Indicates an ADLS Gen2 datasource. ,
onelake: Indicates a Microsoft Fabric OneLake datasource. ,
}
,
Required: True ,
}
enum ,
subType:
{
Description: A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource. ,
Required: False ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
indexerPermissionOptions:
{
Description: Ingestion options with various types of permission data. ,
Required: False ,
}
[
string ,
]
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data change detection policy. ,
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data deletion detection policy. ,
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
DataSources_Create (new)
Description :  Creates a new datasource.
Reference :  Link ¶

⚼ Request

POST:  /datasources
{
dataSource:
{
Description: The definition of the datasource to create. ,
Required: True ,
}
{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Enum:
{
azuresql: Indicates an Azure SQL datasource. ,
cosmosdb: Indicates a CosmosDB datasource. ,
azureblob: Indicates an Azure Blob datasource. ,
azuretable: Indicates an Azure Table datasource. ,
mysql: Indicates a MySql datasource. ,
adlsgen2: Indicates an ADLS Gen2 datasource. ,
onelake: Indicates a Microsoft Fabric OneLake datasource. ,
}
,
Required: True ,
}
enum ,
subType:
{
Description: A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource. ,
Required: False ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
indexerPermissionOptions:
{
Description: Ingestion options with various types of permission data. ,
Required: False ,
}
[
string ,
]
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data change detection policy. ,
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data deletion detection policy. ,
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the datasource. ,
Required: True ,
}
string ,
description:
{
Description: The description of the datasource. ,
Required: False ,
}
string ,
type:
{
Description: The type of the datasource. ,
Enum:
{
azuresql: Indicates an Azure SQL datasource. ,
cosmosdb: Indicates a CosmosDB datasource. ,
azureblob: Indicates an Azure Blob datasource. ,
azuretable: Indicates an Azure Table datasource. ,
mysql: Indicates a MySql datasource. ,
adlsgen2: Indicates an ADLS Gen2 datasource. ,
onelake: Indicates a Microsoft Fabric OneLake datasource. ,
}
,
Required: True ,
}
enum ,
subType:
{
Description: A specific type of the data source, in case the resource is capable of different modalities. For example, 'MongoDb' for certain 'cosmosDb' accounts. ,
Required: False ,
}
string ,
credentials:
{
Description: Credentials for the datasource. ,
Required: True ,
}
{
connectionString:
{
Description: The connection string for the datasource. Set to `` (with brackets) if you don't want the connection string updated. Set to `` if you want to remove the connection string value from the datasource. ,
Required: False ,
}
string ,
}
,
container:
{
Description: The data container for the datasource. ,
Required: True ,
}
{
name:
{
Description: The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed. ,
Required: True ,
}
string ,
query:
{
Description: A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this datasource. If not specified and the connection string is a managed identity, the system-assigned managed identity is used. If not specified, the value remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
indexerPermissionOptions:
{
Description: Ingestion options with various types of permission data. ,
Required: False ,
}
[
string ,
]
,
dataChangeDetectionPolicy:
{
Description: The data change detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data change detection policy. ,
Required: True ,
}
string ,
}
,
dataDeletionDetectionPolicy:
{
Description: The data deletion detection policy for the datasource. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of data deletion detection policy. ,
Required: True ,
}
string ,
}
,
@odata.etag:
{
Description: The ETag of the data source. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your datasource definition when you want full assurance that no one, not even Microsoft, can decrypt your data source definition. Once you have encrypted your data source definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your datasource definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_Reset (new)
Description :  Resets the change tracking state associated with an indexer.
Reference :  Link ¶

⚼ Request

POST:  /indexers('{indexerName}')/search.reset
{
indexerName:
{
Description: The name of the indexer to reset. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_ResetDocs (new)
Description :  Resets specific documents in the datasource to be selectively re-ingested by the indexer.
Reference :  Link ¶

⚼ Request

POST:  /indexers('{indexerName}')/search.resetdocs
{
indexerName:
{
Description: The name of the indexer to reset documents for. ,
Required: True ,
}
string ,
keysOrIds:
{
Required: False ,
}
{
documentKeys:
{
Description: document keys to be reset ,
Required: False ,
}
[
string ,
]
,
datasourceDocumentIds:
{
Description: datasource document identifiers to be reset ,
Required: False ,
}
[
string ,
]
,
}
,
overwrite:
{
Description: If false, keys or ids will be appended to existing ones. If true, only the keys or ids in this payload will be queued to be re-ingested. ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_Resync (new)
Description :  Resync selective options from the datasource to be re-ingested by the indexer.
Reference :  Link ¶

⚼ Request

POST:  /indexers('{indexerName}')/search.resync
{
indexerName:
{
Description: The name of the indexer to resync for. ,
Required: True ,
}
string ,
indexerResync:
{
Required: True ,
}
{
options:
{
Description: Re-sync options that have been pre-defined from data source. ,
Required: False ,
}
[
string ,
]
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_Run (new)
Description :  Runs an indexer on-demand.
Reference :  Link ¶

⚼ Request

POST:  /indexers('{indexerName}')/search.run
{
indexerName:
{
Description: The name of the indexer to run. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_CreateOrUpdate (new)
Description :  Creates a new indexer or updates an indexer if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /indexers('{indexerName}')
{
indexerName:
{
Description: The name of the indexer to create or update. ,
Required: True ,
}
string ,
indexer:
{
Description: The definition of the indexer to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
skillsetName:
{
Description: The name of the skillset executing with this indexer. ,
Required: False ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
parsingMode:
{
Description: Represents the parsing mode for indexing from an Azure blob data source. ,
Enum:
{
default: Set to default for normal file processing. ,
text: Set to text to improve indexing performance on plain text files in blob storage. ,
delimitedText: Set to delimitedText when blobs are plain CSV files. ,
json: Set to json to extract structured content from JSON files. ,
jsonArray: Set to jsonArray to extract individual elements of a JSON array as separate documents. ,
jsonLines: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. ,
markdown: Set to markdown to extract content from markdown files. ,
}
,
Required: False ,
}
enum ,
excludedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. ,
Required: False ,
}
string ,
indexedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. ,
Required: False ,
}
string ,
failOnUnsupportedContentType:
{
Description: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. ,
Required: False ,
}
boolean ,
failOnUnprocessableDocument:
{
Description: For Azure blobs, set to false if you want to continue indexing if a document fails indexing. ,
Required: False ,
}
boolean ,
indexStorageMetadataOnlyForOversizedDocuments:
{
Description: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. ,
Required: False ,
}
boolean ,
delimitedTextHeaders:
{
Description: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. ,
Required: False ,
}
string ,
delimitedTextDelimiter:
{
Description: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). ,
Required: False ,
}
string ,
firstLineContainsHeaders:
{
Description: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. ,
Required: False ,
}
boolean ,
markdownParsingSubmode:
{
Description: Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. ,
Enum:
{
oneToMany: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. ,
oneToOne: Indicates that each markdown file will be parsed into a single search document. ,
}
,
Required: False ,
}
enum ,
markdownHeaderDepth:
{
Description: Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. ,
Enum:
{
h1: Indicates that headers up to a level of h1 will be considered while grouping markdown content. ,
h2: Indicates that headers up to a level of h2 will be considered while grouping markdown content. ,
h3: Indicates that headers up to a level of h3 will be considered while grouping markdown content. ,
h4: Indicates that headers up to a level of h4 will be considered while grouping markdown content. ,
h5: Indicates that headers up to a level of h5 will be considered while grouping markdown content. ,
h6: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. ,
}
,
Required: False ,
}
enum ,
documentRoot:
{
Description: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. ,
Required: False ,
}
string ,
dataToExtract:
{
Description: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. ,
Enum:
{
storageMetadata: Indexes just the standard blob properties and user-specified metadata. ,
allMetadata: Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). ,
contentAndMetadata: Extracts all metadata and textual content from each blob. ,
}
,
Required: False ,
}
enum ,
imageAction:
{
Description: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. ,
Enum:
{
none: Ignores embedded images or image files in the data set. This is the default. ,
generateNormalizedImages: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. ,
generateNormalizedImagePerPage: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. ,
}
,
Required: False ,
}
enum ,
allowSkillsetToReadFileData:
{
Description: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. ,
Required: False ,
}
boolean ,
pdfTextRotationAlgorithm:
{
Description: Determines algorithm for text extraction from PDF files in Azure blob storage. ,
Enum:
{
none: Leverages normal text extraction. This is the default. ,
detectAngles: May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. ,
}
,
Required: False ,
}
enum ,
executionEnvironment:
{
Description: Specifies the environment in which the indexer should execute. ,
Enum:
{
standard: Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. ,
private: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. ,
}
,
Required: False ,
}
enum ,
queryTimeout:
{
Description: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". ,
Required: False ,
}
string ,
}
,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
outputFieldMappings:
{
Description: Output field mappings are applied after enrichment and immediately before indexing. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the indexer. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
cache:
{
Description: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. ,
Required: False ,
}
{
id:
{
Description: A guid for the SearchIndexerCache. ,
Required: False ,
}
string ,
storageConnectionString:
{
Description: The connection string to the storage account where the cache data will be persisted. ,
Required: False ,
}
string ,
enableReprocessing:
{
Description: Specifies whether incremental reprocessing is enabled. ,
Required: False ,
}
boolean ,
identity:
{
Description: The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
ignoreResetRequirements:
{
Description: Ignores cache reset requirements. ,
Required: False ,
}
boolean ,
disableCacheReprocessingChangeDetection:
{
Description: Disables cache reprocessing change detection. ,
Required: False ,
}
boolean ,
}

⚐ Response (201)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
skillsetName:
{
Description: The name of the skillset executing with this indexer. ,
Required: False ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
parsingMode:
{
Description: Represents the parsing mode for indexing from an Azure blob data source. ,
Enum:
{
default: Set to default for normal file processing. ,
text: Set to text to improve indexing performance on plain text files in blob storage. ,
delimitedText: Set to delimitedText when blobs are plain CSV files. ,
json: Set to json to extract structured content from JSON files. ,
jsonArray: Set to jsonArray to extract individual elements of a JSON array as separate documents. ,
jsonLines: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. ,
markdown: Set to markdown to extract content from markdown files. ,
}
,
Required: False ,
}
enum ,
excludedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. ,
Required: False ,
}
string ,
indexedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. ,
Required: False ,
}
string ,
failOnUnsupportedContentType:
{
Description: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. ,
Required: False ,
}
boolean ,
failOnUnprocessableDocument:
{
Description: For Azure blobs, set to false if you want to continue indexing if a document fails indexing. ,
Required: False ,
}
boolean ,
indexStorageMetadataOnlyForOversizedDocuments:
{
Description: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. ,
Required: False ,
}
boolean ,
delimitedTextHeaders:
{
Description: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. ,
Required: False ,
}
string ,
delimitedTextDelimiter:
{
Description: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). ,
Required: False ,
}
string ,
firstLineContainsHeaders:
{
Description: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. ,
Required: False ,
}
boolean ,
markdownParsingSubmode:
{
Description: Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. ,
Enum:
{
oneToMany: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. ,
oneToOne: Indicates that each markdown file will be parsed into a single search document. ,
}
,
Required: False ,
}
enum ,
markdownHeaderDepth:
{
Description: Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. ,
Enum:
{
h1: Indicates that headers up to a level of h1 will be considered while grouping markdown content. ,
h2: Indicates that headers up to a level of h2 will be considered while grouping markdown content. ,
h3: Indicates that headers up to a level of h3 will be considered while grouping markdown content. ,
h4: Indicates that headers up to a level of h4 will be considered while grouping markdown content. ,
h5: Indicates that headers up to a level of h5 will be considered while grouping markdown content. ,
h6: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. ,
}
,
Required: False ,
}
enum ,
documentRoot:
{
Description: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. ,
Required: False ,
}
string ,
dataToExtract:
{
Description: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. ,
Enum:
{
storageMetadata: Indexes just the standard blob properties and user-specified metadata. ,
allMetadata: Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). ,
contentAndMetadata: Extracts all metadata and textual content from each blob. ,
}
,
Required: False ,
}
enum ,
imageAction:
{
Description: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. ,
Enum:
{
none: Ignores embedded images or image files in the data set. This is the default. ,
generateNormalizedImages: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. ,
generateNormalizedImagePerPage: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. ,
}
,
Required: False ,
}
enum ,
allowSkillsetToReadFileData:
{
Description: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. ,
Required: False ,
}
boolean ,
pdfTextRotationAlgorithm:
{
Description: Determines algorithm for text extraction from PDF files in Azure blob storage. ,
Enum:
{
none: Leverages normal text extraction. This is the default. ,
detectAngles: May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. ,
}
,
Required: False ,
}
enum ,
executionEnvironment:
{
Description: Specifies the environment in which the indexer should execute. ,
Enum:
{
standard: Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. ,
private: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. ,
}
,
Required: False ,
}
enum ,
queryTimeout:
{
Description: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". ,
Required: False ,
}
string ,
}
,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
outputFieldMappings:
{
Description: Output field mappings are applied after enrichment and immediately before indexing. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the indexer. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
cache:
{
Description: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. ,
Required: False ,
}
{
id:
{
Description: A guid for the SearchIndexerCache. ,
Required: False ,
}
string ,
storageConnectionString:
{
Description: The connection string to the storage account where the cache data will be persisted. ,
Required: False ,
}
string ,
enableReprocessing:
{
Description: Specifies whether incremental reprocessing is enabled. ,
Required: False ,
}
boolean ,
identity:
{
Description: The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
skillsetName:
{
Description: The name of the skillset executing with this indexer. ,
Required: False ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
parsingMode:
{
Description: Represents the parsing mode for indexing from an Azure blob data source. ,
Enum:
{
default: Set to default for normal file processing. ,
text: Set to text to improve indexing performance on plain text files in blob storage. ,
delimitedText: Set to delimitedText when blobs are plain CSV files. ,
json: Set to json to extract structured content from JSON files. ,
jsonArray: Set to jsonArray to extract individual elements of a JSON array as separate documents. ,
jsonLines: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. ,
markdown: Set to markdown to extract content from markdown files. ,
}
,
Required: False ,
}
enum ,
excludedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. ,
Required: False ,
}
string ,
indexedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. ,
Required: False ,
}
string ,
failOnUnsupportedContentType:
{
Description: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. ,
Required: False ,
}
boolean ,
failOnUnprocessableDocument:
{
Description: For Azure blobs, set to false if you want to continue indexing if a document fails indexing. ,
Required: False ,
}
boolean ,
indexStorageMetadataOnlyForOversizedDocuments:
{
Description: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. ,
Required: False ,
}
boolean ,
delimitedTextHeaders:
{
Description: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. ,
Required: False ,
}
string ,
delimitedTextDelimiter:
{
Description: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). ,
Required: False ,
}
string ,
firstLineContainsHeaders:
{
Description: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. ,
Required: False ,
}
boolean ,
markdownParsingSubmode:
{
Description: Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. ,
Enum:
{
oneToMany: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. ,
oneToOne: Indicates that each markdown file will be parsed into a single search document. ,
}
,
Required: False ,
}
enum ,
markdownHeaderDepth:
{
Description: Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. ,
Enum:
{
h1: Indicates that headers up to a level of h1 will be considered while grouping markdown content. ,
h2: Indicates that headers up to a level of h2 will be considered while grouping markdown content. ,
h3: Indicates that headers up to a level of h3 will be considered while grouping markdown content. ,
h4: Indicates that headers up to a level of h4 will be considered while grouping markdown content. ,
h5: Indicates that headers up to a level of h5 will be considered while grouping markdown content. ,
h6: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. ,
}
,
Required: False ,
}
enum ,
documentRoot:
{
Description: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. ,
Required: False ,
}
string ,
dataToExtract:
{
Description: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. ,
Enum:
{
storageMetadata: Indexes just the standard blob properties and user-specified metadata. ,
allMetadata: Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). ,
contentAndMetadata: Extracts all metadata and textual content from each blob. ,
}
,
Required: False ,
}
enum ,
imageAction:
{
Description: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. ,
Enum:
{
none: Ignores embedded images or image files in the data set. This is the default. ,
generateNormalizedImages: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. ,
generateNormalizedImagePerPage: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. ,
}
,
Required: False ,
}
enum ,
allowSkillsetToReadFileData:
{
Description: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. ,
Required: False ,
}
boolean ,
pdfTextRotationAlgorithm:
{
Description: Determines algorithm for text extraction from PDF files in Azure blob storage. ,
Enum:
{
none: Leverages normal text extraction. This is the default. ,
detectAngles: May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. ,
}
,
Required: False ,
}
enum ,
executionEnvironment:
{
Description: Specifies the environment in which the indexer should execute. ,
Enum:
{
standard: Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. ,
private: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. ,
}
,
Required: False ,
}
enum ,
queryTimeout:
{
Description: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". ,
Required: False ,
}
string ,
}
,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
outputFieldMappings:
{
Description: Output field mappings are applied after enrichment and immediately before indexing. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the indexer. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
cache:
{
Description: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. ,
Required: False ,
}
{
id:
{
Description: A guid for the SearchIndexerCache. ,
Required: False ,
}
string ,
storageConnectionString:
{
Description: The connection string to the storage account where the cache data will be persisted. ,
Required: False ,
}
string ,
enableReprocessing:
{
Description: Specifies whether incremental reprocessing is enabled. ,
Required: False ,
}
boolean ,
identity:
{
Description: The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_Delete (new)
Description :  Deletes an indexer.
Reference :  Link ¶

⚼ Request

DELETE:  /indexers('{indexerName}')
{
indexerName:
{
Description: The name of the indexer to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (404)

{}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_Get (new)
Description :  Retrieves an indexer definition.
Reference :  Link ¶

⚼ Request

GET:  /indexers('{indexerName}')
{
indexerName:
{
Description: The name of the indexer to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
skillsetName:
{
Description: The name of the skillset executing with this indexer. ,
Required: False ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
parsingMode:
{
Description: Represents the parsing mode for indexing from an Azure blob data source. ,
Enum:
{
default: Set to default for normal file processing. ,
text: Set to text to improve indexing performance on plain text files in blob storage. ,
delimitedText: Set to delimitedText when blobs are plain CSV files. ,
json: Set to json to extract structured content from JSON files. ,
jsonArray: Set to jsonArray to extract individual elements of a JSON array as separate documents. ,
jsonLines: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. ,
markdown: Set to markdown to extract content from markdown files. ,
}
,
Required: False ,
}
enum ,
excludedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. ,
Required: False ,
}
string ,
indexedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. ,
Required: False ,
}
string ,
failOnUnsupportedContentType:
{
Description: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. ,
Required: False ,
}
boolean ,
failOnUnprocessableDocument:
{
Description: For Azure blobs, set to false if you want to continue indexing if a document fails indexing. ,
Required: False ,
}
boolean ,
indexStorageMetadataOnlyForOversizedDocuments:
{
Description: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. ,
Required: False ,
}
boolean ,
delimitedTextHeaders:
{
Description: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. ,
Required: False ,
}
string ,
delimitedTextDelimiter:
{
Description: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). ,
Required: False ,
}
string ,
firstLineContainsHeaders:
{
Description: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. ,
Required: False ,
}
boolean ,
markdownParsingSubmode:
{
Description: Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. ,
Enum:
{
oneToMany: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. ,
oneToOne: Indicates that each markdown file will be parsed into a single search document. ,
}
,
Required: False ,
}
enum ,
markdownHeaderDepth:
{
Description: Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. ,
Enum:
{
h1: Indicates that headers up to a level of h1 will be considered while grouping markdown content. ,
h2: Indicates that headers up to a level of h2 will be considered while grouping markdown content. ,
h3: Indicates that headers up to a level of h3 will be considered while grouping markdown content. ,
h4: Indicates that headers up to a level of h4 will be considered while grouping markdown content. ,
h5: Indicates that headers up to a level of h5 will be considered while grouping markdown content. ,
h6: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. ,
}
,
Required: False ,
}
enum ,
documentRoot:
{
Description: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. ,
Required: False ,
}
string ,
dataToExtract:
{
Description: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. ,
Enum:
{
storageMetadata: Indexes just the standard blob properties and user-specified metadata. ,
allMetadata: Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). ,
contentAndMetadata: Extracts all metadata and textual content from each blob. ,
}
,
Required: False ,
}
enum ,
imageAction:
{
Description: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. ,
Enum:
{
none: Ignores embedded images or image files in the data set. This is the default. ,
generateNormalizedImages: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. ,
generateNormalizedImagePerPage: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. ,
}
,
Required: False ,
}
enum ,
allowSkillsetToReadFileData:
{
Description: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. ,
Required: False ,
}
boolean ,
pdfTextRotationAlgorithm:
{
Description: Determines algorithm for text extraction from PDF files in Azure blob storage. ,
Enum:
{
none: Leverages normal text extraction. This is the default. ,
detectAngles: May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. ,
}
,
Required: False ,
}
enum ,
executionEnvironment:
{
Description: Specifies the environment in which the indexer should execute. ,
Enum:
{
standard: Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. ,
private: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. ,
}
,
Required: False ,
}
enum ,
queryTimeout:
{
Description: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". ,
Required: False ,
}
string ,
}
,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
outputFieldMappings:
{
Description: Output field mappings are applied after enrichment and immediately before indexing. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the indexer. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
cache:
{
Description: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. ,
Required: False ,
}
{
id:
{
Description: A guid for the SearchIndexerCache. ,
Required: False ,
}
string ,
storageConnectionString:
{
Description: The connection string to the storage account where the cache data will be persisted. ,
Required: False ,
}
string ,
enableReprocessing:
{
Description: Specifies whether incremental reprocessing is enabled. ,
Required: False ,
}
boolean ,
identity:
{
Description: The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_List (new)
Description :  Lists all indexers available for a search service.
Reference :  Link ¶

⚼ Request

GET:  /indexers
{
$select:
{
Description: Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The indexers in the Search service. ,
Required: True ,
}
[
{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
skillsetName:
{
Description: The name of the skillset executing with this indexer. ,
Required: False ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
parsingMode:
{
Description: Represents the parsing mode for indexing from an Azure blob data source. ,
Enum:
{
default: Set to default for normal file processing. ,
text: Set to text to improve indexing performance on plain text files in blob storage. ,
delimitedText: Set to delimitedText when blobs are plain CSV files. ,
json: Set to json to extract structured content from JSON files. ,
jsonArray: Set to jsonArray to extract individual elements of a JSON array as separate documents. ,
jsonLines: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. ,
markdown: Set to markdown to extract content from markdown files. ,
}
,
Required: False ,
}
enum ,
excludedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. ,
Required: False ,
}
string ,
indexedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. ,
Required: False ,
}
string ,
failOnUnsupportedContentType:
{
Description: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. ,
Required: False ,
}
boolean ,
failOnUnprocessableDocument:
{
Description: For Azure blobs, set to false if you want to continue indexing if a document fails indexing. ,
Required: False ,
}
boolean ,
indexStorageMetadataOnlyForOversizedDocuments:
{
Description: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. ,
Required: False ,
}
boolean ,
delimitedTextHeaders:
{
Description: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. ,
Required: False ,
}
string ,
delimitedTextDelimiter:
{
Description: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). ,
Required: False ,
}
string ,
firstLineContainsHeaders:
{
Description: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. ,
Required: False ,
}
boolean ,
markdownParsingSubmode:
{
Description: Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. ,
Enum:
{
oneToMany: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. ,
oneToOne: Indicates that each markdown file will be parsed into a single search document. ,
}
,
Required: False ,
}
enum ,
markdownHeaderDepth:
{
Description: Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. ,
Enum:
{
h1: Indicates that headers up to a level of h1 will be considered while grouping markdown content. ,
h2: Indicates that headers up to a level of h2 will be considered while grouping markdown content. ,
h3: Indicates that headers up to a level of h3 will be considered while grouping markdown content. ,
h4: Indicates that headers up to a level of h4 will be considered while grouping markdown content. ,
h5: Indicates that headers up to a level of h5 will be considered while grouping markdown content. ,
h6: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. ,
}
,
Required: False ,
}
enum ,
documentRoot:
{
Description: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. ,
Required: False ,
}
string ,
dataToExtract:
{
Description: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. ,
Enum:
{
storageMetadata: Indexes just the standard blob properties and user-specified metadata. ,
allMetadata: Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). ,
contentAndMetadata: Extracts all metadata and textual content from each blob. ,
}
,
Required: False ,
}
enum ,
imageAction:
{
Description: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. ,
Enum:
{
none: Ignores embedded images or image files in the data set. This is the default. ,
generateNormalizedImages: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. ,
generateNormalizedImagePerPage: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. ,
}
,
Required: False ,
}
enum ,
allowSkillsetToReadFileData:
{
Description: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. ,
Required: False ,
}
boolean ,
pdfTextRotationAlgorithm:
{
Description: Determines algorithm for text extraction from PDF files in Azure blob storage. ,
Enum:
{
none: Leverages normal text extraction. This is the default. ,
detectAngles: May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. ,
}
,
Required: False ,
}
enum ,
executionEnvironment:
{
Description: Specifies the environment in which the indexer should execute. ,
Enum:
{
standard: Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. ,
private: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. ,
}
,
Required: False ,
}
enum ,
queryTimeout:
{
Description: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". ,
Required: False ,
}
string ,
}
,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
outputFieldMappings:
{
Description: Output field mappings are applied after enrichment and immediately before indexing. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the indexer. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
cache:
{
Description: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. ,
Required: False ,
}
{
id:
{
Description: A guid for the SearchIndexerCache. ,
Required: False ,
}
string ,
storageConnectionString:
{
Description: The connection string to the storage account where the cache data will be persisted. ,
Required: False ,
}
string ,
enableReprocessing:
{
Description: Specifies whether incremental reprocessing is enabled. ,
Required: False ,
}
boolean ,
identity:
{
Description: The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_Create (new)
Description :  Creates a new indexer.
Reference :  Link ¶

⚼ Request

POST:  /indexers
{
indexer:
{
Description: The definition of the indexer to create. ,
Required: True ,
}
{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
skillsetName:
{
Description: The name of the skillset executing with this indexer. ,
Required: False ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
parsingMode:
{
Description: Represents the parsing mode for indexing from an Azure blob data source. ,
Enum:
{
default: Set to default for normal file processing. ,
text: Set to text to improve indexing performance on plain text files in blob storage. ,
delimitedText: Set to delimitedText when blobs are plain CSV files. ,
json: Set to json to extract structured content from JSON files. ,
jsonArray: Set to jsonArray to extract individual elements of a JSON array as separate documents. ,
jsonLines: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. ,
markdown: Set to markdown to extract content from markdown files. ,
}
,
Required: False ,
}
enum ,
excludedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. ,
Required: False ,
}
string ,
indexedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. ,
Required: False ,
}
string ,
failOnUnsupportedContentType:
{
Description: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. ,
Required: False ,
}
boolean ,
failOnUnprocessableDocument:
{
Description: For Azure blobs, set to false if you want to continue indexing if a document fails indexing. ,
Required: False ,
}
boolean ,
indexStorageMetadataOnlyForOversizedDocuments:
{
Description: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. ,
Required: False ,
}
boolean ,
delimitedTextHeaders:
{
Description: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. ,
Required: False ,
}
string ,
delimitedTextDelimiter:
{
Description: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). ,
Required: False ,
}
string ,
firstLineContainsHeaders:
{
Description: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. ,
Required: False ,
}
boolean ,
markdownParsingSubmode:
{
Description: Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. ,
Enum:
{
oneToMany: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. ,
oneToOne: Indicates that each markdown file will be parsed into a single search document. ,
}
,
Required: False ,
}
enum ,
markdownHeaderDepth:
{
Description: Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. ,
Enum:
{
h1: Indicates that headers up to a level of h1 will be considered while grouping markdown content. ,
h2: Indicates that headers up to a level of h2 will be considered while grouping markdown content. ,
h3: Indicates that headers up to a level of h3 will be considered while grouping markdown content. ,
h4: Indicates that headers up to a level of h4 will be considered while grouping markdown content. ,
h5: Indicates that headers up to a level of h5 will be considered while grouping markdown content. ,
h6: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. ,
}
,
Required: False ,
}
enum ,
documentRoot:
{
Description: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. ,
Required: False ,
}
string ,
dataToExtract:
{
Description: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. ,
Enum:
{
storageMetadata: Indexes just the standard blob properties and user-specified metadata. ,
allMetadata: Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). ,
contentAndMetadata: Extracts all metadata and textual content from each blob. ,
}
,
Required: False ,
}
enum ,
imageAction:
{
Description: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. ,
Enum:
{
none: Ignores embedded images or image files in the data set. This is the default. ,
generateNormalizedImages: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. ,
generateNormalizedImagePerPage: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. ,
}
,
Required: False ,
}
enum ,
allowSkillsetToReadFileData:
{
Description: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. ,
Required: False ,
}
boolean ,
pdfTextRotationAlgorithm:
{
Description: Determines algorithm for text extraction from PDF files in Azure blob storage. ,
Enum:
{
none: Leverages normal text extraction. This is the default. ,
detectAngles: May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. ,
}
,
Required: False ,
}
enum ,
executionEnvironment:
{
Description: Specifies the environment in which the indexer should execute. ,
Enum:
{
standard: Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. ,
private: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. ,
}
,
Required: False ,
}
enum ,
queryTimeout:
{
Description: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". ,
Required: False ,
}
string ,
}
,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
outputFieldMappings:
{
Description: Output field mappings are applied after enrichment and immediately before indexing. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the indexer. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
cache:
{
Description: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. ,
Required: False ,
}
{
id:
{
Description: A guid for the SearchIndexerCache. ,
Required: False ,
}
string ,
storageConnectionString:
{
Description: The connection string to the storage account where the cache data will be persisted. ,
Required: False ,
}
string ,
enableReprocessing:
{
Description: Specifies whether incremental reprocessing is enabled. ,
Required: False ,
}
boolean ,
identity:
{
Description: The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
description:
{
Description: The description of the indexer. ,
Required: False ,
}
string ,
dataSourceName:
{
Description: The name of the datasource from which this indexer reads data. ,
Required: True ,
}
string ,
skillsetName:
{
Description: The name of the skillset executing with this indexer. ,
Required: False ,
}
string ,
targetIndexName:
{
Description: The name of the index to which this indexer writes data. ,
Required: True ,
}
string ,
schedule:
{
Description: The schedule for this indexer. ,
Required: False ,
}
{
interval:
{
Description: The interval of time between indexer executions. ,
Format: duration ,
Required: True ,
}
string ,
startTime:
{
Description: The time when an indexer should start running. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
parameters:
{
Description: Parameters for indexer execution. ,
Required: False ,
}
{
batchSize:
{
Description: The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItems:
{
Description: The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFailedItemsPerBatch:
{
Description: The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0. ,
Format: int32 ,
Required: False ,
}
integer ,
configuration:
{
Description: A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
parsingMode:
{
Description: Represents the parsing mode for indexing from an Azure blob data source. ,
Enum:
{
default: Set to default for normal file processing. ,
text: Set to text to improve indexing performance on plain text files in blob storage. ,
delimitedText: Set to delimitedText when blobs are plain CSV files. ,
json: Set to json to extract structured content from JSON files. ,
jsonArray: Set to jsonArray to extract individual elements of a JSON array as separate documents. ,
jsonLines: Set to jsonLines to extract individual JSON entities, separated by a new line, as separate documents. ,
markdown: Set to markdown to extract content from markdown files. ,
}
,
Required: False ,
}
enum ,
excludedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to ignore when processing from Azure blob storage. For example, you could exclude ".png, .mp4" to skip over those files during indexing. ,
Required: False ,
}
string ,
indexedFileNameExtensions:
{
Description: Comma-delimited list of filename extensions to select when processing from Azure blob storage. For example, you could focus indexing on specific application files ".docx, .pptx, .msg" to specifically include those file types. ,
Required: False ,
}
string ,
failOnUnsupportedContentType:
{
Description: For Azure blobs, set to false if you want to continue indexing when an unsupported content type is encountered, and you don't know all the content types (file extensions) in advance. ,
Required: False ,
}
boolean ,
failOnUnprocessableDocument:
{
Description: For Azure blobs, set to false if you want to continue indexing if a document fails indexing. ,
Required: False ,
}
boolean ,
indexStorageMetadataOnlyForOversizedDocuments:
{
Description: For Azure blobs, set this property to true to still index storage metadata for blob content that is too large to process. Oversized blobs are treated as errors by default. For limits on blob size, see https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. ,
Required: False ,
}
boolean ,
delimitedTextHeaders:
{
Description: For CSV blobs, specifies a comma-delimited list of column headers, useful for mapping source fields to destination fields in an index. ,
Required: False ,
}
string ,
delimitedTextDelimiter:
{
Description: For CSV blobs, specifies the end-of-line single-character delimiter for CSV files where each line starts a new document (for example, "|"). ,
Required: False ,
}
string ,
firstLineContainsHeaders:
{
Description: For CSV blobs, indicates that the first (non-blank) line of each blob contains headers. ,
Required: False ,
}
boolean ,
markdownParsingSubmode:
{
Description: Specifies the submode that will determine whether a markdown file will be parsed into exactly one search document or multiple search documents. Default is `oneToMany`. ,
Enum:
{
oneToMany: Indicates that each section of the markdown file (up to a specified depth) will be parsed into individual search documents. This can result in a single markdown file producing multiple search documents. This is the default sub-mode. ,
oneToOne: Indicates that each markdown file will be parsed into a single search document. ,
}
,
Required: False ,
}
enum ,
markdownHeaderDepth:
{
Description: Specifies the max header depth that will be considered while grouping markdown content. Default is `h6`. ,
Enum:
{
h1: Indicates that headers up to a level of h1 will be considered while grouping markdown content. ,
h2: Indicates that headers up to a level of h2 will be considered while grouping markdown content. ,
h3: Indicates that headers up to a level of h3 will be considered while grouping markdown content. ,
h4: Indicates that headers up to a level of h4 will be considered while grouping markdown content. ,
h5: Indicates that headers up to a level of h5 will be considered while grouping markdown content. ,
h6: Indicates that headers up to a level of h6 will be considered while grouping markdown content. This is the default. ,
}
,
Required: False ,
}
enum ,
documentRoot:
{
Description: For JSON arrays, given a structured or semi-structured document, you can specify a path to the array using this property. ,
Required: False ,
}
string ,
dataToExtract:
{
Description: Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none". This applies to embedded image content in a .PDF or other application, or image files such as .jpg and .png, in Azure blobs. ,
Enum:
{
storageMetadata: Indexes just the standard blob properties and user-specified metadata. ,
allMetadata: Extracts metadata provided by the Azure blob storage subsystem and the content-type specific metadata (for example, metadata unique to just .png files are indexed). ,
contentAndMetadata: Extracts all metadata and textual content from each blob. ,
}
,
Required: False ,
}
enum ,
imageAction:
{
Description: Determines how to process embedded images and image files in Azure blob storage. Setting the "imageAction" configuration to any value other than "none" requires that a skillset also be attached to that indexer. ,
Enum:
{
none: Ignores embedded images or image files in the data set. This is the default. ,
generateNormalizedImages: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field. This action requires that "dataToExtract" is set to "contentAndMetadata". A normalized image refers to additional processing resulting in uniform image output, sized and rotated to promote consistent rendering when you include images in visual search results. This information is generated for each image when you use this option. ,
generateNormalizedImagePerPage: Extracts text from images (for example, the word "STOP" from a traffic stop sign), and embeds it into the content field, but treats PDF files differently in that each page will be rendered as an image and normalized accordingly, instead of extracting embedded images. Non-PDF file types will be treated the same as if "generateNormalizedImages" was set. ,
}
,
Required: False ,
}
enum ,
allowSkillsetToReadFileData:
{
Description: If true, will create a path //document//file_data that is an object representing the original file data downloaded from your blob data source. This allows you to pass the original file data to a custom skill for processing within the enrichment pipeline, or to the Document Extraction skill. ,
Required: False ,
}
boolean ,
pdfTextRotationAlgorithm:
{
Description: Determines algorithm for text extraction from PDF files in Azure blob storage. ,
Enum:
{
none: Leverages normal text extraction. This is the default. ,
detectAngles: May produce better and more readable text extraction from PDF files that have rotated text within them. Note that there may be a small performance speed impact when this parameter is used. This parameter only applies to PDF files, and only to PDFs with embedded text. If the rotated text appears within an embedded image in the PDF, this parameter does not apply. ,
}
,
Required: False ,
}
enum ,
executionEnvironment:
{
Description: Specifies the environment in which the indexer should execute. ,
Enum:
{
standard: Indicates that the search service can determine where the indexer should execute. This is the default environment when nothing is specified and is the recommended value. ,
private: Indicates that the indexer should run with the environment provisioned specifically for the search service. This should only be specified as the execution environment if the indexer needs to access resources securely over shared private link resources. ,
}
,
Required: False ,
}
enum ,
queryTimeout:
{
Description: Increases the timeout beyond the 5-minute default for Azure SQL database data sources, specified in the format "hh:mm:ss". ,
Required: False ,
}
string ,
}
,
}
,
fieldMappings:
{
Description: Defines mappings between fields in the data source and corresponding target fields in the index. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
outputFieldMappings:
{
Description: Output field mappings are applied after enrichment and immediately before indexing. ,
Required: False ,
}
[
{
sourceFieldName:
{
Description: The name of the field in the data source. ,
Required: True ,
}
string ,
targetFieldName:
{
Description: The name of the target field in the index. Same as the source field name by default. ,
Required: False ,
}
string ,
mappingFunction:
{
Description: A function to apply to each source field value before indexing. ,
Required: False ,
}
{
name:
{
Description: The name of the field mapping function. ,
Required: True ,
}
string ,
parameters:
{
Description: A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type. ,
Required: False ,
}
object ,
}
,
}
,
]
,
disabled:
{
Description: A value indicating whether the indexer is disabled. Default is false. ,
Required: False ,
}
boolean ,
@odata.etag:
{
Description: The ETag of the indexer. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your indexer definition (as well as indexer execution status) when you want full assurance that no one, not even Microsoft, can decrypt them. Once you have encrypted your indexer definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your indexer definition (and indexer execution status) will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
cache:
{
Description: Adds caching to an enrichment pipeline to allow for incremental modification steps without having to rebuild the index every time. ,
Required: False ,
}
{
id:
{
Description: A guid for the SearchIndexerCache. ,
Required: False ,
}
string ,
storageConnectionString:
{
Description: The connection string to the storage account where the cache data will be persisted. ,
Required: False ,
}
string ,
enableReprocessing:
{
Description: Specifies whether incremental reprocessing is enabled. ,
Required: False ,
}
boolean ,
identity:
{
Description: The user-assigned managed identity used for connections to the enrichment cache. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexers_GetStatus (new)
Description :  Returns the current status and execution history of an indexer.
Reference :  Link ¶

⚼ Request

GET:  /indexers('{indexerName}')/search.status
{
indexerName:
{
Description: The name of the indexer for which to retrieve status. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the indexer. ,
Required: True ,
}
string ,
status:
{
Description: Overall indexer status. ,
Enum:
{
unknown: Indicates that the indexer is in an unknown state. ,
error: Indicates that the indexer experienced an error that cannot be corrected without human intervention. ,
running: Indicates that the indexer is running normally. ,
}
,
Required: True ,
}
enum ,
lastResult:
{
Description: The result of the most recent or an in-progress indexer execution. ,
Required: False ,
}
{
status:
{
Description: The outcome of this indexer execution. ,
Enum:
{
transientFailure: An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule. ,
success: Indexer execution completed successfully. ,
inProgress: Indexer execution is in progress. ,
reset: Indexer has been reset. ,
}
,
Required: True ,
}
enum ,
statusDetail:
{
Description: The outcome of this indexer execution. ,
Enum:
{
resetDocs: Indicates that the reset that occurred was for a call to ResetDocs. ,
resync: Indicates to selectively resync based on option(s) from data source. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode the indexer is running in. ,
Enum:
{
indexingAllDocs: The indexer is indexing all documents in the datasource. ,
indexingResetDocs: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. ,
indexingResync: The indexer is resyncing and indexing selective option(s) from the datasource. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message indicating the top-level error, if any. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of this indexer execution. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of this indexer execution, if the execution has already completed. ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The item-level indexing errors. ,
Required: True ,
}
[
{
key:
{
Description: The key of the item for which indexing failed. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The message describing the error that occurred while processing the item. ,
Required: True ,
}
string ,
statusCode:
{
Description: The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. ,
Format: int32 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available. ,
Required: False ,
}
string ,
details:
{
Description: Additional, verbose details about the error to assist in debugging the indexer. This may not be always available. ,
Required: False ,
}
string ,
documentationLink:
{
Description: A link to a troubleshooting guide for these classes of errors. This may not be always available. ,
Required: False ,
}
string ,
}
,
]
,
warnings:
{
Description: The item-level indexing warnings. ,
Required: True ,
}
[
{
key:
{
Description: The key of the item which generated a warning. ,
Required: False ,
}
string ,
message:
{
Description: The message describing the warning that occurred while processing the item. ,
Required: True ,
}
string ,
name:
{
Description: The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available. ,
Required: False ,
}
string ,
details:
{
Description: Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available. ,
Required: False ,
}
string ,
documentationLink:
{
Description: A link to a troubleshooting guide for these classes of warnings. This may not be always available. ,
Required: False ,
}
string ,
}
,
]
,
itemsProcessed:
{
Description: The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. ,
Format: int32 ,
Required: True ,
}
integer ,
itemsFailed:
{
Description: The number of items that failed to be indexed during this indexer execution. ,
Format: int32 ,
Required: True ,
}
integer ,
initialTrackingState:
{
Description: Change tracking state with which an indexer execution started. ,
Required: False ,
}
string ,
finalTrackingState:
{
Description: Change tracking state with which an indexer execution finished. ,
Required: False ,
}
string ,
}
,
executionHistory:
{
Description: History of the recent indexer executions, sorted in reverse chronological order. ,
Required: True ,
}
[
{
status:
{
Description: The outcome of this indexer execution. ,
Enum:
{
transientFailure: An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule. ,
success: Indexer execution completed successfully. ,
inProgress: Indexer execution is in progress. ,
reset: Indexer has been reset. ,
}
,
Required: True ,
}
enum ,
statusDetail:
{
Description: The outcome of this indexer execution. ,
Enum:
{
resetDocs: Indicates that the reset that occurred was for a call to ResetDocs. ,
resync: Indicates to selectively resync based on option(s) from data source. ,
}
,
Required: False ,
}
enum ,
mode:
{
Description: The mode the indexer is running in. ,
Enum:
{
indexingAllDocs: The indexer is indexing all documents in the datasource. ,
indexingResetDocs: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. ,
indexingResync: The indexer is resyncing and indexing selective option(s) from the datasource. ,
}
,
Required: False ,
}
enum ,
errorMessage:
{
Description: The error message indicating the top-level error, if any. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time of this indexer execution. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time of this indexer execution, if the execution has already completed. ,
Format: date-time ,
Required: False ,
}
string ,
errors:
{
Description: The item-level indexing errors. ,
Required: True ,
}
[
{
key:
{
Description: The key of the item for which indexing failed. ,
Required: False ,
}
string ,
errorMessage:
{
Description: The message describing the error that occurred while processing the item. ,
Required: True ,
}
string ,
statusCode:
{
Description: The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy. ,
Format: int32 ,
Required: True ,
}
integer ,
name:
{
Description: The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available. ,
Required: False ,
}
string ,
details:
{
Description: Additional, verbose details about the error to assist in debugging the indexer. This may not be always available. ,
Required: False ,
}
string ,
documentationLink:
{
Description: A link to a troubleshooting guide for these classes of errors. This may not be always available. ,
Required: False ,
}
string ,
}
,
]
,
warnings:
{
Description: The item-level indexing warnings. ,
Required: True ,
}
[
{
key:
{
Description: The key of the item which generated a warning. ,
Required: False ,
}
string ,
message:
{
Description: The message describing the warning that occurred while processing the item. ,
Required: True ,
}
string ,
name:
{
Description: The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available. ,
Required: False ,
}
string ,
details:
{
Description: Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available. ,
Required: False ,
}
string ,
documentationLink:
{
Description: A link to a troubleshooting guide for these classes of warnings. This may not be always available. ,
Required: False ,
}
string ,
}
,
]
,
itemsProcessed:
{
Description: The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed. ,
Format: int32 ,
Required: True ,
}
integer ,
itemsFailed:
{
Description: The number of items that failed to be indexed during this indexer execution. ,
Format: int32 ,
Required: True ,
}
integer ,
initialTrackingState:
{
Description: Change tracking state with which an indexer execution started. ,
Required: False ,
}
string ,
finalTrackingState:
{
Description: Change tracking state with which an indexer execution finished. ,
Required: False ,
}
string ,
}
,
]
,
limits:
{
Description: The execution limits for the indexer. ,
Required: True ,
}
{
maxRunTime:
{
Description: The maximum duration that the indexer is permitted to run for one execution. ,
Format: duration ,
Required: False ,
}
string ,
maxDocumentExtractionSize:
{
Description: The maximum size of a document, in bytes, which will be considered valid for indexing. ,
Format: int64 ,
Required: False ,
}
number ,
maxDocumentContentCharactersToExtract:
{
Description: The maximum number of characters that will be extracted from a document picked up for indexing. ,
Format: int64 ,
Required: False ,
}
number ,
}
,
currentState:
{
Description: All of the state that defines and dictates the indexer's current execution. ,
Required: False ,
}
{
mode:
{
Description: The mode the indexer is running in. ,
Enum:
{
indexingAllDocs: The indexer is indexing all documents in the datasource. ,
indexingResetDocs: The indexer is indexing selective, reset documents in the datasource. The documents being indexed are defined on indexer status. ,
indexingResync: The indexer is resyncing and indexing selective option(s) from the datasource. ,
}
,
Required: False ,
}
enum ,
allDocsInitialTrackingState:
{
Description: Change tracking state used when indexing starts on all documents in the datasource. ,
Required: False ,
}
string ,
allDocsFinalTrackingState:
{
Description: Change tracking state value when indexing finishes on all documents in the datasource. ,
Required: False ,
}
string ,
resetDocsInitialTrackingState:
{
Description: Change tracking state used when indexing starts on select, reset documents in the datasource. ,
Required: False ,
}
string ,
resetDocsFinalTrackingState:
{
Description: Change tracking state value when indexing finishes on select, reset documents in the datasource. ,
Required: False ,
}
string ,
resetDocumentKeys:
{
Description: The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys. ,
Required: False ,
}
[
string ,
]
,
resetDatasourceDocumentIds:
{
Description: The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids. ,
Required: False ,
}
[
string ,
]
,
resyncInitialTrackingState:
{
Description: Change tracking state used when indexing starts on selective options from the datasource. ,
Required: False ,
}
string ,
resyncFinalTrackingState:
{
Description: Change tracking state value when indexing finishes on selective options from the datasource. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Skillsets_CreateOrUpdate (new)
Description :  Creates a new skillset in a search service or updates the skillset if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /skillsets('{skillsetName}')
{
skillsetName:
{
Description: The name of the skillset to create or update. ,
Required: True ,
}
string ,
skillset:
{
Description: The skillset containing one or more skills to create or update in a search service. ,
Required: True ,
}
{
name:
{
Description: The name of the skillset. ,
Required: True ,
}
string ,
description:
{
Description: The description of the skillset. ,
Required: False ,
}
string ,
skills:
{
Description: A list of skills in the skillset. ,
Required: True ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of skill. ,
Required: True ,
}
string ,
name:
{
Description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. ,
Required: False ,
}
string ,
description:
{
Description: The description of the skill which describes the inputs, outputs, and usage of the skill. ,
Required: False ,
}
string ,
context:
{
Description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. ,
Required: False ,
}
string ,
inputs:
{
Description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
outputs:
{
Description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the output defined by the skill. ,
Required: True ,
}
string ,
targetName:
{
Description: The target name of the output. It is optional and default to name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
cognitiveServices:
{
Description: Details about the Azure AI service to be used when running skills. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of Azure AI service resource attached to a skillset. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Azure AI service resource attached to a skillset. ,
Required: False ,
}
string ,
}
,
knowledgeStore:
{
Description: Definition of additional projections to Azure blob, table, or files, of enriched data. ,
Required: False ,
}
{
storageConnectionString:
{
Description: The connection string to the storage account projections will be stored in. ,
Required: True ,
}
string ,
projections:
{
Description: A list of additional projections to perform during indexing. ,
Required: True ,
}
[
{
tables:
{
Description: Projections to Azure Table storage. ,
Required: False ,
}
[
{
tableName:
{
Description: Name of the Azure table to store projected data in. ,
Required: True ,
}
string ,
}
,
]
,
objects:
{
Description: Projections to Azure Blob storage. ,
Required: False ,
}
[
object ,
]
,
files:
{
Description: Projections to Azure File storage. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
identity:
{
Description: The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
parameters:
{
Description: A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
synthesizeGeneratedKeyName:
{
Description: Whether or not projections should synthesize a generated key name if one isn't already present. ,
Required: False ,
}
boolean ,
}
,
}
,
indexProjections:
{
Description: Definition of additional projections to secondary search index(es). ,
Required: False ,
}
{
selectors:
{
Description: A list of projections to be performed to secondary search indexes. ,
Required: True ,
}
[
{
targetIndexName:
{
Description: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. ,
Required: True ,
}
string ,
parentKeyFieldName:
{
Description: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. ,
Required: True ,
}
string ,
sourceContext:
{
Description: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. ,
Required: True ,
}
string ,
mappings:
{
Description: Mappings for the projection, or which source should be mapped to which field in the target index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
projectionMode:
{
Description: Defines behavior of the index projections in relation to the rest of the indexer. ,
Enum:
{
skipIndexingParentDocuments: The source document will be skipped from writing into the indexer's target index. ,
includeIndexingParentDocuments: The source document will be written into the indexer's target index. This is the default pattern. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the skillset. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
ignoreResetRequirements:
{
Description: Ignores cache reset requirements. ,
Required: False ,
}
boolean ,
disableCacheReprocessingChangeDetection:
{
Description: Disables cache reprocessing change detection. ,
Required: False ,
}
boolean ,
}

⚐ Response (200)

{
name:
{
Description: The name of the skillset. ,
Required: True ,
}
string ,
description:
{
Description: The description of the skillset. ,
Required: False ,
}
string ,
skills:
{
Description: A list of skills in the skillset. ,
Required: True ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of skill. ,
Required: True ,
}
string ,
name:
{
Description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. ,
Required: False ,
}
string ,
description:
{
Description: The description of the skill which describes the inputs, outputs, and usage of the skill. ,
Required: False ,
}
string ,
context:
{
Description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. ,
Required: False ,
}
string ,
inputs:
{
Description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
outputs:
{
Description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the output defined by the skill. ,
Required: True ,
}
string ,
targetName:
{
Description: The target name of the output. It is optional and default to name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
cognitiveServices:
{
Description: Details about the Azure AI service to be used when running skills. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of Azure AI service resource attached to a skillset. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Azure AI service resource attached to a skillset. ,
Required: False ,
}
string ,
}
,
knowledgeStore:
{
Description: Definition of additional projections to Azure blob, table, or files, of enriched data. ,
Required: False ,
}
{
storageConnectionString:
{
Description: The connection string to the storage account projections will be stored in. ,
Required: True ,
}
string ,
projections:
{
Description: A list of additional projections to perform during indexing. ,
Required: True ,
}
[
{
tables:
{
Description: Projections to Azure Table storage. ,
Required: False ,
}
[
{
tableName:
{
Description: Name of the Azure table to store projected data in. ,
Required: True ,
}
string ,
}
,
]
,
objects:
{
Description: Projections to Azure Blob storage. ,
Required: False ,
}
[
object ,
]
,
files:
{
Description: Projections to Azure File storage. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
identity:
{
Description: The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
parameters:
{
Description: A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
synthesizeGeneratedKeyName:
{
Description: Whether or not projections should synthesize a generated key name if one isn't already present. ,
Required: False ,
}
boolean ,
}
,
}
,
indexProjections:
{
Description: Definition of additional projections to secondary search index(es). ,
Required: False ,
}
{
selectors:
{
Description: A list of projections to be performed to secondary search indexes. ,
Required: True ,
}
[
{
targetIndexName:
{
Description: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. ,
Required: True ,
}
string ,
parentKeyFieldName:
{
Description: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. ,
Required: True ,
}
string ,
sourceContext:
{
Description: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. ,
Required: True ,
}
string ,
mappings:
{
Description: Mappings for the projection, or which source should be mapped to which field in the target index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
projectionMode:
{
Description: Defines behavior of the index projections in relation to the rest of the indexer. ,
Enum:
{
skipIndexingParentDocuments: The source document will be skipped from writing into the indexer's target index. ,
includeIndexingParentDocuments: The source document will be written into the indexer's target index. This is the default pattern. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the skillset. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
name:
{
Description: The name of the skillset. ,
Required: True ,
}
string ,
description:
{
Description: The description of the skillset. ,
Required: False ,
}
string ,
skills:
{
Description: A list of skills in the skillset. ,
Required: True ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of skill. ,
Required: True ,
}
string ,
name:
{
Description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. ,
Required: False ,
}
string ,
description:
{
Description: The description of the skill which describes the inputs, outputs, and usage of the skill. ,
Required: False ,
}
string ,
context:
{
Description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. ,
Required: False ,
}
string ,
inputs:
{
Description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
outputs:
{
Description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the output defined by the skill. ,
Required: True ,
}
string ,
targetName:
{
Description: The target name of the output. It is optional and default to name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
cognitiveServices:
{
Description: Details about the Azure AI service to be used when running skills. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of Azure AI service resource attached to a skillset. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Azure AI service resource attached to a skillset. ,
Required: False ,
}
string ,
}
,
knowledgeStore:
{
Description: Definition of additional projections to Azure blob, table, or files, of enriched data. ,
Required: False ,
}
{
storageConnectionString:
{
Description: The connection string to the storage account projections will be stored in. ,
Required: True ,
}
string ,
projections:
{
Description: A list of additional projections to perform during indexing. ,
Required: True ,
}
[
{
tables:
{
Description: Projections to Azure Table storage. ,
Required: False ,
}
[
{
tableName:
{
Description: Name of the Azure table to store projected data in. ,
Required: True ,
}
string ,
}
,
]
,
objects:
{
Description: Projections to Azure Blob storage. ,
Required: False ,
}
[
object ,
]
,
files:
{
Description: Projections to Azure File storage. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
identity:
{
Description: The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
parameters:
{
Description: A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
synthesizeGeneratedKeyName:
{
Description: Whether or not projections should synthesize a generated key name if one isn't already present. ,
Required: False ,
}
boolean ,
}
,
}
,
indexProjections:
{
Description: Definition of additional projections to secondary search index(es). ,
Required: False ,
}
{
selectors:
{
Description: A list of projections to be performed to secondary search indexes. ,
Required: True ,
}
[
{
targetIndexName:
{
Description: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. ,
Required: True ,
}
string ,
parentKeyFieldName:
{
Description: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. ,
Required: True ,
}
string ,
sourceContext:
{
Description: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. ,
Required: True ,
}
string ,
mappings:
{
Description: Mappings for the projection, or which source should be mapped to which field in the target index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
projectionMode:
{
Description: Defines behavior of the index projections in relation to the rest of the indexer. ,
Enum:
{
skipIndexingParentDocuments: The source document will be skipped from writing into the indexer's target index. ,
includeIndexingParentDocuments: The source document will be written into the indexer's target index. This is the default pattern. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the skillset. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Skillsets_Delete (new)
Description :  Deletes a skillset in a search service.
Reference :  Link ¶

⚼ Request

DELETE:  /skillsets('{skillsetName}')
{
skillsetName:
{
Description: The name of the skillset to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Skillsets_Get (new)
Description :  Retrieves a skillset in a search service.
Reference :  Link ¶

⚼ Request

GET:  /skillsets('{skillsetName}')
{
skillsetName:
{
Description: The name of the skillset to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the skillset. ,
Required: True ,
}
string ,
description:
{
Description: The description of the skillset. ,
Required: False ,
}
string ,
skills:
{
Description: A list of skills in the skillset. ,
Required: True ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of skill. ,
Required: True ,
}
string ,
name:
{
Description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. ,
Required: False ,
}
string ,
description:
{
Description: The description of the skill which describes the inputs, outputs, and usage of the skill. ,
Required: False ,
}
string ,
context:
{
Description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. ,
Required: False ,
}
string ,
inputs:
{
Description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
outputs:
{
Description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the output defined by the skill. ,
Required: True ,
}
string ,
targetName:
{
Description: The target name of the output. It is optional and default to name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
cognitiveServices:
{
Description: Details about the Azure AI service to be used when running skills. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of Azure AI service resource attached to a skillset. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Azure AI service resource attached to a skillset. ,
Required: False ,
}
string ,
}
,
knowledgeStore:
{
Description: Definition of additional projections to Azure blob, table, or files, of enriched data. ,
Required: False ,
}
{
storageConnectionString:
{
Description: The connection string to the storage account projections will be stored in. ,
Required: True ,
}
string ,
projections:
{
Description: A list of additional projections to perform during indexing. ,
Required: True ,
}
[
{
tables:
{
Description: Projections to Azure Table storage. ,
Required: False ,
}
[
{
tableName:
{
Description: Name of the Azure table to store projected data in. ,
Required: True ,
}
string ,
}
,
]
,
objects:
{
Description: Projections to Azure Blob storage. ,
Required: False ,
}
[
object ,
]
,
files:
{
Description: Projections to Azure File storage. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
identity:
{
Description: The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
parameters:
{
Description: A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
synthesizeGeneratedKeyName:
{
Description: Whether or not projections should synthesize a generated key name if one isn't already present. ,
Required: False ,
}
boolean ,
}
,
}
,
indexProjections:
{
Description: Definition of additional projections to secondary search index(es). ,
Required: False ,
}
{
selectors:
{
Description: A list of projections to be performed to secondary search indexes. ,
Required: True ,
}
[
{
targetIndexName:
{
Description: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. ,
Required: True ,
}
string ,
parentKeyFieldName:
{
Description: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. ,
Required: True ,
}
string ,
sourceContext:
{
Description: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. ,
Required: True ,
}
string ,
mappings:
{
Description: Mappings for the projection, or which source should be mapped to which field in the target index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
projectionMode:
{
Description: Defines behavior of the index projections in relation to the rest of the indexer. ,
Enum:
{
skipIndexingParentDocuments: The source document will be skipped from writing into the indexer's target index. ,
includeIndexingParentDocuments: The source document will be written into the indexer's target index. This is the default pattern. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the skillset. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Skillsets_List (new)
Description :  List all skillsets in a search service.
Reference :  Link ¶

⚼ Request

GET:  /skillsets
{
$select:
{
Description: Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The skillsets defined in the Search service. ,
Required: True ,
}
[
{
name:
{
Description: The name of the skillset. ,
Required: True ,
}
string ,
description:
{
Description: The description of the skillset. ,
Required: False ,
}
string ,
skills:
{
Description: A list of skills in the skillset. ,
Required: True ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of skill. ,
Required: True ,
}
string ,
name:
{
Description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. ,
Required: False ,
}
string ,
description:
{
Description: The description of the skill which describes the inputs, outputs, and usage of the skill. ,
Required: False ,
}
string ,
context:
{
Description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. ,
Required: False ,
}
string ,
inputs:
{
Description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
outputs:
{
Description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the output defined by the skill. ,
Required: True ,
}
string ,
targetName:
{
Description: The target name of the output. It is optional and default to name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
cognitiveServices:
{
Description: Details about the Azure AI service to be used when running skills. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of Azure AI service resource attached to a skillset. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Azure AI service resource attached to a skillset. ,
Required: False ,
}
string ,
}
,
knowledgeStore:
{
Description: Definition of additional projections to Azure blob, table, or files, of enriched data. ,
Required: False ,
}
{
storageConnectionString:
{
Description: The connection string to the storage account projections will be stored in. ,
Required: True ,
}
string ,
projections:
{
Description: A list of additional projections to perform during indexing. ,
Required: True ,
}
[
{
tables:
{
Description: Projections to Azure Table storage. ,
Required: False ,
}
[
{
tableName:
{
Description: Name of the Azure table to store projected data in. ,
Required: True ,
}
string ,
}
,
]
,
objects:
{
Description: Projections to Azure Blob storage. ,
Required: False ,
}
[
object ,
]
,
files:
{
Description: Projections to Azure File storage. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
identity:
{
Description: The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
parameters:
{
Description: A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
synthesizeGeneratedKeyName:
{
Description: Whether or not projections should synthesize a generated key name if one isn't already present. ,
Required: False ,
}
boolean ,
}
,
}
,
indexProjections:
{
Description: Definition of additional projections to secondary search index(es). ,
Required: False ,
}
{
selectors:
{
Description: A list of projections to be performed to secondary search indexes. ,
Required: True ,
}
[
{
targetIndexName:
{
Description: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. ,
Required: True ,
}
string ,
parentKeyFieldName:
{
Description: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. ,
Required: True ,
}
string ,
sourceContext:
{
Description: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. ,
Required: True ,
}
string ,
mappings:
{
Description: Mappings for the projection, or which source should be mapped to which field in the target index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
projectionMode:
{
Description: Defines behavior of the index projections in relation to the rest of the indexer. ,
Enum:
{
skipIndexingParentDocuments: The source document will be skipped from writing into the indexer's target index. ,
includeIndexingParentDocuments: The source document will be written into the indexer's target index. This is the default pattern. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the skillset. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Skillsets_Create (new)
Description :  Creates a new skillset in a search service.
Reference :  Link ¶

⚼ Request

POST:  /skillsets
{
skillset:
{
Description: The skillset containing one or more skills to create in a search service. ,
Required: True ,
}
{
name:
{
Description: The name of the skillset. ,
Required: True ,
}
string ,
description:
{
Description: The description of the skillset. ,
Required: False ,
}
string ,
skills:
{
Description: A list of skills in the skillset. ,
Required: True ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of skill. ,
Required: True ,
}
string ,
name:
{
Description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. ,
Required: False ,
}
string ,
description:
{
Description: The description of the skill which describes the inputs, outputs, and usage of the skill. ,
Required: False ,
}
string ,
context:
{
Description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. ,
Required: False ,
}
string ,
inputs:
{
Description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
outputs:
{
Description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the output defined by the skill. ,
Required: True ,
}
string ,
targetName:
{
Description: The target name of the output. It is optional and default to name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
cognitiveServices:
{
Description: Details about the Azure AI service to be used when running skills. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of Azure AI service resource attached to a skillset. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Azure AI service resource attached to a skillset. ,
Required: False ,
}
string ,
}
,
knowledgeStore:
{
Description: Definition of additional projections to Azure blob, table, or files, of enriched data. ,
Required: False ,
}
{
storageConnectionString:
{
Description: The connection string to the storage account projections will be stored in. ,
Required: True ,
}
string ,
projections:
{
Description: A list of additional projections to perform during indexing. ,
Required: True ,
}
[
{
tables:
{
Description: Projections to Azure Table storage. ,
Required: False ,
}
[
{
tableName:
{
Description: Name of the Azure table to store projected data in. ,
Required: True ,
}
string ,
}
,
]
,
objects:
{
Description: Projections to Azure Blob storage. ,
Required: False ,
}
[
object ,
]
,
files:
{
Description: Projections to Azure File storage. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
identity:
{
Description: The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
parameters:
{
Description: A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
synthesizeGeneratedKeyName:
{
Description: Whether or not projections should synthesize a generated key name if one isn't already present. ,
Required: False ,
}
boolean ,
}
,
}
,
indexProjections:
{
Description: Definition of additional projections to secondary search index(es). ,
Required: False ,
}
{
selectors:
{
Description: A list of projections to be performed to secondary search indexes. ,
Required: True ,
}
[
{
targetIndexName:
{
Description: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. ,
Required: True ,
}
string ,
parentKeyFieldName:
{
Description: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. ,
Required: True ,
}
string ,
sourceContext:
{
Description: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. ,
Required: True ,
}
string ,
mappings:
{
Description: Mappings for the projection, or which source should be mapped to which field in the target index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
projectionMode:
{
Description: Defines behavior of the index projections in relation to the rest of the indexer. ,
Enum:
{
skipIndexingParentDocuments: The source document will be skipped from writing into the indexer's target index. ,
includeIndexingParentDocuments: The source document will be written into the indexer's target index. This is the default pattern. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the skillset. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the skillset. ,
Required: True ,
}
string ,
description:
{
Description: The description of the skillset. ,
Required: False ,
}
string ,
skills:
{
Description: A list of skills in the skillset. ,
Required: True ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of skill. ,
Required: True ,
}
string ,
name:
{
Description: The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'. ,
Required: False ,
}
string ,
description:
{
Description: The description of the skill which describes the inputs, outputs, and usage of the skill. ,
Required: False ,
}
string ,
context:
{
Description: Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document. ,
Required: False ,
}
string ,
inputs:
{
Description: Inputs of the skills could be a column in the source data set, or the output of an upstream skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
outputs:
{
Description: The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill. ,
Required: True ,
}
[
{
name:
{
Description: The name of the output defined by the skill. ,
Required: True ,
}
string ,
targetName:
{
Description: The target name of the output. It is optional and default to name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
cognitiveServices:
{
Description: Details about the Azure AI service to be used when running skills. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of Azure AI service resource attached to a skillset. ,
Required: True ,
}
string ,
description:
{
Description: Description of the Azure AI service resource attached to a skillset. ,
Required: False ,
}
string ,
}
,
knowledgeStore:
{
Description: Definition of additional projections to Azure blob, table, or files, of enriched data. ,
Required: False ,
}
{
storageConnectionString:
{
Description: The connection string to the storage account projections will be stored in. ,
Required: True ,
}
string ,
projections:
{
Description: A list of additional projections to perform during indexing. ,
Required: True ,
}
[
{
tables:
{
Description: Projections to Azure Table storage. ,
Required: False ,
}
[
{
tableName:
{
Description: Name of the Azure table to store projected data in. ,
Required: True ,
}
string ,
}
,
]
,
objects:
{
Description: Projections to Azure Blob storage. ,
Required: False ,
}
[
object ,
]
,
files:
{
Description: Projections to Azure File storage. ,
Required: False ,
}
[
object ,
]
,
}
,
]
,
identity:
{
Description: The user-assigned managed identity used for connections to Azure Storage when writing knowledge store projections. If the connection string indicates an identity (ResourceId) and it's not specified, the system-assigned managed identity is used. On updates to the indexer, if the identity is unspecified, the value remains unchanged. If set to "none", the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
parameters:
{
Description: A dictionary of knowledge store-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
synthesizeGeneratedKeyName:
{
Description: Whether or not projections should synthesize a generated key name if one isn't already present. ,
Required: False ,
}
boolean ,
}
,
}
,
indexProjections:
{
Description: Definition of additional projections to secondary search index(es). ,
Required: False ,
}
{
selectors:
{
Description: A list of projections to be performed to secondary search indexes. ,
Required: True ,
}
[
{
targetIndexName:
{
Description: Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. ,
Required: True ,
}
string ,
parentKeyFieldName:
{
Description: Name of the field in the search index to map the parent document's key value to. Must be a string field that is filterable and not the key field. ,
Required: True ,
}
string ,
sourceContext:
{
Description: Source context for the projections. Represents the cardinality at which the document will be split into multiple sub documents. ,
Required: True ,
}
string ,
mappings:
{
Description: Mappings for the projection, or which source should be mapped to which field in the target index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the input. ,
Required: True ,
}
string ,
source:
{
Description: The source of the input. ,
Required: False ,
}
string ,
sourceContext:
{
Description: The source context used for selecting recursive inputs. ,
Required: False ,
}
string ,
inputs:
{
Description: The recursive inputs used when creating a complex type. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
]
,
parameters:
{
Description: A dictionary of index projection-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type. ,
Required: False ,
}
{
projectionMode:
{
Description: Defines behavior of the index projections in relation to the rest of the indexer. ,
Enum:
{
skipIndexingParentDocuments: The source document will be skipped from writing into the indexer's target index. ,
includeIndexingParentDocuments: The source document will be written into the indexer's target index. This is the default pattern. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the skillset. ,
Required: False ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your skillset definition when you want full assurance that no one, not even Microsoft, can decrypt your skillset definition. Once you have encrypted your skillset definition, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your skillset definition will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Skillsets_ResetSkills (new)
Description :  Reset an existing skillset in a search service.
Reference :  Link ¶

⚼ Request

POST:  /skillsets('{skillsetName}')/search.resetskills
{
skillsetName:
{
Description: The name of the skillset to reset. ,
Required: True ,
}
string ,
skillNames:
{
Description: The names of skills to reset. ,
Required: True ,
}
{
skillNames:
{
Description: the names of skills to be reset. ,
Required: False ,
}
[
string ,
]
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ 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 ,
}
,
]
,
}
,
}
SynonymMaps_CreateOrUpdate (new)
Description :  Creates a new synonym map or updates a synonym map if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /synonymmaps('{synonymMapName}')
{
synonymMapName:
{
Description: The name of the synonym map to create or update. ,
Required: True ,
}
string ,
synonymMap:
{
Description: The definition of the synonym map to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the synonym map. ,
Required: True ,
}
string ,
format:
{
Description: The format of the synonym map. Only the 'solr' format is currently supported. ,
Enum:
{
solr: Selects the SOLR format for synonym maps. ,
}
,
Required: True ,
}
enum ,
synonyms:
{
Description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the synonym map. ,
Required: False ,
}
string ,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the synonym map. ,
Required: True ,
}
string ,
format:
{
Description: The format of the synonym map. Only the 'solr' format is currently supported. ,
Enum:
{
solr: Selects the SOLR format for synonym maps. ,
}
,
Required: True ,
}
enum ,
synonyms:
{
Description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the synonym map. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the synonym map. ,
Required: True ,
}
string ,
format:
{
Description: The format of the synonym map. Only the 'solr' format is currently supported. ,
Enum:
{
solr: Selects the SOLR format for synonym maps. ,
}
,
Required: True ,
}
enum ,
synonyms:
{
Description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the synonym map. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
SynonymMaps_Delete (new)
Description :  Deletes a synonym map.
Reference :  Link ¶

⚼ Request

DELETE:  /synonymmaps('{synonymMapName}')
{
synonymMapName:
{
Description: The name of the synonym map to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
SynonymMaps_Get (new)
Description :  Retrieves a synonym map definition.
Reference :  Link ¶

⚼ Request

GET:  /synonymmaps('{synonymMapName}')
{
synonymMapName:
{
Description: The name of the synonym map to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the synonym map. ,
Required: True ,
}
string ,
format:
{
Description: The format of the synonym map. Only the 'solr' format is currently supported. ,
Enum:
{
solr: Selects the SOLR format for synonym maps. ,
}
,
Required: True ,
}
enum ,
synonyms:
{
Description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the synonym map. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
SynonymMaps_List (new)
Description :  Lists all synonym maps available for a search service.
Reference :  Link ¶

⚼ Request

GET:  /synonymmaps
{
$select:
{
Description: Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The synonym maps in the Search service. ,
Required: True ,
}
[
{
name:
{
Description: The name of the synonym map. ,
Required: True ,
}
string ,
format:
{
Description: The format of the synonym map. Only the 'solr' format is currently supported. ,
Enum:
{
solr: Selects the SOLR format for synonym maps. ,
}
,
Required: True ,
}
enum ,
synonyms:
{
Description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the synonym map. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
SynonymMaps_Create (new)
Description :  Creates a new synonym map.
Reference :  Link ¶

⚼ Request

POST:  /synonymmaps
{
synonymMap:
{
Description: The definition of the synonym map to create. ,
Required: True ,
}
{
name:
{
Description: The name of the synonym map. ,
Required: True ,
}
string ,
format:
{
Description: The format of the synonym map. Only the 'solr' format is currently supported. ,
Enum:
{
solr: Selects the SOLR format for synonym maps. ,
}
,
Required: True ,
}
enum ,
synonyms:
{
Description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the synonym map. ,
Required: False ,
}
string ,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the synonym map. ,
Required: True ,
}
string ,
format:
{
Description: The format of the synonym map. Only the 'solr' format is currently supported. ,
Enum:
{
solr: Selects the SOLR format for synonym maps. ,
}
,
Required: True ,
}
enum ,
synonyms:
{
Description: A series of synonym rules in the specified synonym map format. The rules must be separated by newlines. ,
Required: True ,
}
string ,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
@odata.etag:
{
Description: The ETag of the synonym map. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexes_Create (new)
Description :  Creates a new search index.
Reference :  Link ¶

⚼ Request

POST:  /indexes
{
index:
{
Description: The definition of the index to create. ,
Required: True ,
}
{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
description:
{
Description: The description of the index. ,
Required: False ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field, which must be unique within the fields collection of the index or parent field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Enum:
{
Edm.String: Indicates that a field contains a string. ,
Edm.Int32: Indicates that a field contains a 32-bit signed integer. ,
Edm.Int64: Indicates that a field contains a 64-bit signed integer. ,
Edm.Double: Indicates that a field contains an IEEE double-precision floating point number. ,
Edm.Boolean: Indicates that a field contains a Boolean value (true or false). ,
Edm.DateTimeOffset: Indicates that a field contains a date/time value, including timezone information. ,
Edm.GeographyPoint: Indicates that a field contains a geo-location in terms of longitude and latitude. ,
Edm.ComplexType: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. ,
Edm.Single: Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). ,
Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half). ,
Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16). ,
Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). ,
Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). ,
}
,
Required: True ,
}
enum ,
key:
{
Description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields. ,
Required: False ,
}
boolean ,
stored:
{
Description: An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. ,
Required: False ,
}
boolean ,
permissionFilter:
{
Description: A value indicating whether the field should be used as a permission filter. ,
Enum:
{
userIds: Field represents user IDs that should be used to filter document access on queries. ,
groupIds: Field represents group IDs that should be used to filter document access on queries. ,
rbacScope: Field represents an RBAC scope that should be used to filter document access on queries. ,
}
,
Required: False ,
}
enum ,
analyzer:
{
Description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The dimensionality of the vector field. ,
Format: int32 ,
Required: False ,
}
integer ,
vectorSearchProfile:
{
Description: The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field. ,
Required: False ,
}
string ,
vectorEncoding:
{
Description: The encoding format to interpret the field contents. ,
Enum:
{
packedBit: Encoding format representing bits packed into a wider data type. ,
}
,
Required: False ,
}
enum ,
synonymMaps:
{
Description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields. ,
Required: False ,
}
[
string ,
]
,
fields:
{
Description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case. ,
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions. ,
constant: Boosts scores by a constant factor. ,
quadratic: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
logarithmic: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: Boost scores by the sum of all scoring function results. ,
average: Boost scores by the average of all scoring function results. ,
minimum: Boost scores by the minimum of all scoring function results. ,
maximum: Boost scores by the maximum of all scoring function results. ,
firstMatching: Boost scores using the first applicable scoring function in the scoring profile. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of analyzer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of tokenizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of token filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of char filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
normalizers:
{
Description: The normalizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of normalizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. ,
Required: True ,
}
string ,
}
,
]
,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
similarity:
{
Description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
semantic:
{
Description: Defines parameters for a search index that influence semantic capabilities. ,
Required: False ,
}
{
defaultConfiguration:
{
Description: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. ,
Required: False ,
}
string ,
configurations:
{
Description: The semantic configurations for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the semantic configuration. ,
Required: True ,
}
string ,
prioritizedFields:
{
Description: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. ,
Required: True ,
}
{
titleField:
{
Description: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. ,
Required: False ,
}
{
fieldName:
{
Required: True ,
}
string ,
}
,
prioritizedContentFields:
{
Description: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
prioritizedKeywordsFields:
{
Description: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
}
,
rankingOrder:
{
Description: Specifies the score type to be used for the sort order of the search results. ,
Enum:
{
BoostedRerankerScore: Sets sort order as BoostedRerankerScore ,
RerankerScore: Sets sort order as ReRankerScore ,
}
,
Required: False ,
}
enum ,
flightingOptIn:
{
Description: Determines which semantic or query rewrite models to use during model flighting/upgrades. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
vectorSearch:
{
Description: Contains configuration options related to vector search. ,
Required: False ,
}
{
profiles:
{
Description: Defines combinations of configurations to use with vector search. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vector search profile. ,
Required: True ,
}
string ,
algorithm:
{
Description: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. ,
Required: True ,
}
string ,
vectorizer:
{
Description: The name of the vectorization being configured for use with vector search. ,
Required: False ,
}
string ,
compression:
{
Description: The name of the compression method configuration that specifies the compression method and optional parameters. ,
Required: False ,
}
string ,
}
,
]
,
algorithms:
{
Description: Contains configuration options specific to the algorithm used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of algorithm being configured for use with vector search. ,
Enum:
{
hnsw: HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. ,
exhaustiveKnn: Exhaustive KNN algorithm which will perform brute-force search. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorizers:
{
Description: Contains configuration options on how to vectorize text vector queries. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vectorization method. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of vectorization method being configured for use with vector search. ,
Enum:
{
azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time. ,
customWebApi: Generate embeddings using a custom web endpoint at query time. ,
aiServicesVision: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. ,
aml: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
compressions:
{
Description: Contains configuration options specific to the compression method used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of compression method being configured for use with vector search. ,
Enum:
{
scalarQuantization: Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. ,
binaryQuantization: Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. ,
}
,
Required: True ,
}
enum ,
rerankWithOriginalVectors:
{
Description: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoringOptions:
{
Description: Contains the options for rescoring. ,
Required: False ,
}
{
enableRescoring:
{
Description: If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoreStorageMethod:
{
Description: Controls the storage method for original vectors. This setting is immutable. ,
Enum:
{
preserveOriginals: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. ,
discardOriginals: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. ,
}
,
Required: False ,
}
enum ,
}
,
truncationDimension:
{
Description: The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
permissionFilterOption:
{
Description: A value indicating whether permission filtering is enabled for the index. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
description:
{
Description: The description of the index. ,
Required: False ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field, which must be unique within the fields collection of the index or parent field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Enum:
{
Edm.String: Indicates that a field contains a string. ,
Edm.Int32: Indicates that a field contains a 32-bit signed integer. ,
Edm.Int64: Indicates that a field contains a 64-bit signed integer. ,
Edm.Double: Indicates that a field contains an IEEE double-precision floating point number. ,
Edm.Boolean: Indicates that a field contains a Boolean value (true or false). ,
Edm.DateTimeOffset: Indicates that a field contains a date/time value, including timezone information. ,
Edm.GeographyPoint: Indicates that a field contains a geo-location in terms of longitude and latitude. ,
Edm.ComplexType: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. ,
Edm.Single: Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). ,
Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half). ,
Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16). ,
Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). ,
Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). ,
}
,
Required: True ,
}
enum ,
key:
{
Description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields. ,
Required: False ,
}
boolean ,
stored:
{
Description: An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. ,
Required: False ,
}
boolean ,
permissionFilter:
{
Description: A value indicating whether the field should be used as a permission filter. ,
Enum:
{
userIds: Field represents user IDs that should be used to filter document access on queries. ,
groupIds: Field represents group IDs that should be used to filter document access on queries. ,
rbacScope: Field represents an RBAC scope that should be used to filter document access on queries. ,
}
,
Required: False ,
}
enum ,
analyzer:
{
Description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The dimensionality of the vector field. ,
Format: int32 ,
Required: False ,
}
integer ,
vectorSearchProfile:
{
Description: The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field. ,
Required: False ,
}
string ,
vectorEncoding:
{
Description: The encoding format to interpret the field contents. ,
Enum:
{
packedBit: Encoding format representing bits packed into a wider data type. ,
}
,
Required: False ,
}
enum ,
synonymMaps:
{
Description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields. ,
Required: False ,
}
[
string ,
]
,
fields:
{
Description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case. ,
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions. ,
constant: Boosts scores by a constant factor. ,
quadratic: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
logarithmic: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: Boost scores by the sum of all scoring function results. ,
average: Boost scores by the average of all scoring function results. ,
minimum: Boost scores by the minimum of all scoring function results. ,
maximum: Boost scores by the maximum of all scoring function results. ,
firstMatching: Boost scores using the first applicable scoring function in the scoring profile. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of analyzer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of tokenizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of token filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of char filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
normalizers:
{
Description: The normalizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of normalizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. ,
Required: True ,
}
string ,
}
,
]
,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
similarity:
{
Description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
semantic:
{
Description: Defines parameters for a search index that influence semantic capabilities. ,
Required: False ,
}
{
defaultConfiguration:
{
Description: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. ,
Required: False ,
}
string ,
configurations:
{
Description: The semantic configurations for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the semantic configuration. ,
Required: True ,
}
string ,
prioritizedFields:
{
Description: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. ,
Required: True ,
}
{
titleField:
{
Description: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. ,
Required: False ,
}
{
fieldName:
{
Required: True ,
}
string ,
}
,
prioritizedContentFields:
{
Description: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
prioritizedKeywordsFields:
{
Description: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
}
,
rankingOrder:
{
Description: Specifies the score type to be used for the sort order of the search results. ,
Enum:
{
BoostedRerankerScore: Sets sort order as BoostedRerankerScore ,
RerankerScore: Sets sort order as ReRankerScore ,
}
,
Required: False ,
}
enum ,
flightingOptIn:
{
Description: Determines which semantic or query rewrite models to use during model flighting/upgrades. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
vectorSearch:
{
Description: Contains configuration options related to vector search. ,
Required: False ,
}
{
profiles:
{
Description: Defines combinations of configurations to use with vector search. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vector search profile. ,
Required: True ,
}
string ,
algorithm:
{
Description: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. ,
Required: True ,
}
string ,
vectorizer:
{
Description: The name of the vectorization being configured for use with vector search. ,
Required: False ,
}
string ,
compression:
{
Description: The name of the compression method configuration that specifies the compression method and optional parameters. ,
Required: False ,
}
string ,
}
,
]
,
algorithms:
{
Description: Contains configuration options specific to the algorithm used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of algorithm being configured for use with vector search. ,
Enum:
{
hnsw: HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. ,
exhaustiveKnn: Exhaustive KNN algorithm which will perform brute-force search. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorizers:
{
Description: Contains configuration options on how to vectorize text vector queries. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vectorization method. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of vectorization method being configured for use with vector search. ,
Enum:
{
azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time. ,
customWebApi: Generate embeddings using a custom web endpoint at query time. ,
aiServicesVision: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. ,
aml: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
compressions:
{
Description: Contains configuration options specific to the compression method used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of compression method being configured for use with vector search. ,
Enum:
{
scalarQuantization: Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. ,
binaryQuantization: Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. ,
}
,
Required: True ,
}
enum ,
rerankWithOriginalVectors:
{
Description: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoringOptions:
{
Description: Contains the options for rescoring. ,
Required: False ,
}
{
enableRescoring:
{
Description: If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoreStorageMethod:
{
Description: Controls the storage method for original vectors. This setting is immutable. ,
Enum:
{
preserveOriginals: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. ,
discardOriginals: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. ,
}
,
Required: False ,
}
enum ,
}
,
truncationDimension:
{
Description: The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
permissionFilterOption:
{
Description: A value indicating whether permission filtering is enabled for the index. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexes_List (new)
Description :  Lists all indexes available for a search service.
Reference :  Link ¶

⚼ Request

GET:  /indexes
{
$select:
{
Description: Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties. ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The indexes in the Search service. ,
Required: True ,
}
[
{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
description:
{
Description: The description of the index. ,
Required: False ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field, which must be unique within the fields collection of the index or parent field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Enum:
{
Edm.String: Indicates that a field contains a string. ,
Edm.Int32: Indicates that a field contains a 32-bit signed integer. ,
Edm.Int64: Indicates that a field contains a 64-bit signed integer. ,
Edm.Double: Indicates that a field contains an IEEE double-precision floating point number. ,
Edm.Boolean: Indicates that a field contains a Boolean value (true or false). ,
Edm.DateTimeOffset: Indicates that a field contains a date/time value, including timezone information. ,
Edm.GeographyPoint: Indicates that a field contains a geo-location in terms of longitude and latitude. ,
Edm.ComplexType: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. ,
Edm.Single: Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). ,
Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half). ,
Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16). ,
Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). ,
Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). ,
}
,
Required: True ,
}
enum ,
key:
{
Description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields. ,
Required: False ,
}
boolean ,
stored:
{
Description: An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. ,
Required: False ,
}
boolean ,
permissionFilter:
{
Description: A value indicating whether the field should be used as a permission filter. ,
Enum:
{
userIds: Field represents user IDs that should be used to filter document access on queries. ,
groupIds: Field represents group IDs that should be used to filter document access on queries. ,
rbacScope: Field represents an RBAC scope that should be used to filter document access on queries. ,
}
,
Required: False ,
}
enum ,
analyzer:
{
Description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The dimensionality of the vector field. ,
Format: int32 ,
Required: False ,
}
integer ,
vectorSearchProfile:
{
Description: The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field. ,
Required: False ,
}
string ,
vectorEncoding:
{
Description: The encoding format to interpret the field contents. ,
Enum:
{
packedBit: Encoding format representing bits packed into a wider data type. ,
}
,
Required: False ,
}
enum ,
synonymMaps:
{
Description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields. ,
Required: False ,
}
[
string ,
]
,
fields:
{
Description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case. ,
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions. ,
constant: Boosts scores by a constant factor. ,
quadratic: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
logarithmic: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: Boost scores by the sum of all scoring function results. ,
average: Boost scores by the average of all scoring function results. ,
minimum: Boost scores by the minimum of all scoring function results. ,
maximum: Boost scores by the maximum of all scoring function results. ,
firstMatching: Boost scores using the first applicable scoring function in the scoring profile. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of analyzer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of tokenizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of token filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of char filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
normalizers:
{
Description: The normalizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of normalizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. ,
Required: True ,
}
string ,
}
,
]
,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
similarity:
{
Description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
semantic:
{
Description: Defines parameters for a search index that influence semantic capabilities. ,
Required: False ,
}
{
defaultConfiguration:
{
Description: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. ,
Required: False ,
}
string ,
configurations:
{
Description: The semantic configurations for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the semantic configuration. ,
Required: True ,
}
string ,
prioritizedFields:
{
Description: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. ,
Required: True ,
}
{
titleField:
{
Description: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. ,
Required: False ,
}
{
fieldName:
{
Required: True ,
}
string ,
}
,
prioritizedContentFields:
{
Description: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
prioritizedKeywordsFields:
{
Description: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
}
,
rankingOrder:
{
Description: Specifies the score type to be used for the sort order of the search results. ,
Enum:
{
BoostedRerankerScore: Sets sort order as BoostedRerankerScore ,
RerankerScore: Sets sort order as ReRankerScore ,
}
,
Required: False ,
}
enum ,
flightingOptIn:
{
Description: Determines which semantic or query rewrite models to use during model flighting/upgrades. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
vectorSearch:
{
Description: Contains configuration options related to vector search. ,
Required: False ,
}
{
profiles:
{
Description: Defines combinations of configurations to use with vector search. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vector search profile. ,
Required: True ,
}
string ,
algorithm:
{
Description: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. ,
Required: True ,
}
string ,
vectorizer:
{
Description: The name of the vectorization being configured for use with vector search. ,
Required: False ,
}
string ,
compression:
{
Description: The name of the compression method configuration that specifies the compression method and optional parameters. ,
Required: False ,
}
string ,
}
,
]
,
algorithms:
{
Description: Contains configuration options specific to the algorithm used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of algorithm being configured for use with vector search. ,
Enum:
{
hnsw: HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. ,
exhaustiveKnn: Exhaustive KNN algorithm which will perform brute-force search. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorizers:
{
Description: Contains configuration options on how to vectorize text vector queries. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vectorization method. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of vectorization method being configured for use with vector search. ,
Enum:
{
azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time. ,
customWebApi: Generate embeddings using a custom web endpoint at query time. ,
aiServicesVision: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. ,
aml: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
compressions:
{
Description: Contains configuration options specific to the compression method used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of compression method being configured for use with vector search. ,
Enum:
{
scalarQuantization: Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. ,
binaryQuantization: Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. ,
}
,
Required: True ,
}
enum ,
rerankWithOriginalVectors:
{
Description: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoringOptions:
{
Description: Contains the options for rescoring. ,
Required: False ,
}
{
enableRescoring:
{
Description: If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoreStorageMethod:
{
Description: Controls the storage method for original vectors. This setting is immutable. ,
Enum:
{
preserveOriginals: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. ,
discardOriginals: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. ,
}
,
Required: False ,
}
enum ,
}
,
truncationDimension:
{
Description: The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
permissionFilterOption:
{
Description: A value indicating whether permission filtering is enabled for the index. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexes_CreateOrUpdate (new)
Description :  Creates a new search index or updates an index if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /indexes('{indexName}')
{
indexName:
{
Description: The definition of the index to create or update. ,
Required: True ,
}
string ,
index:
{
Description: The definition of the index to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
description:
{
Description: The description of the index. ,
Required: False ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field, which must be unique within the fields collection of the index or parent field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Enum:
{
Edm.String: Indicates that a field contains a string. ,
Edm.Int32: Indicates that a field contains a 32-bit signed integer. ,
Edm.Int64: Indicates that a field contains a 64-bit signed integer. ,
Edm.Double: Indicates that a field contains an IEEE double-precision floating point number. ,
Edm.Boolean: Indicates that a field contains a Boolean value (true or false). ,
Edm.DateTimeOffset: Indicates that a field contains a date/time value, including timezone information. ,
Edm.GeographyPoint: Indicates that a field contains a geo-location in terms of longitude and latitude. ,
Edm.ComplexType: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. ,
Edm.Single: Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). ,
Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half). ,
Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16). ,
Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). ,
Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). ,
}
,
Required: True ,
}
enum ,
key:
{
Description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields. ,
Required: False ,
}
boolean ,
stored:
{
Description: An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. ,
Required: False ,
}
boolean ,
permissionFilter:
{
Description: A value indicating whether the field should be used as a permission filter. ,
Enum:
{
userIds: Field represents user IDs that should be used to filter document access on queries. ,
groupIds: Field represents group IDs that should be used to filter document access on queries. ,
rbacScope: Field represents an RBAC scope that should be used to filter document access on queries. ,
}
,
Required: False ,
}
enum ,
analyzer:
{
Description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The dimensionality of the vector field. ,
Format: int32 ,
Required: False ,
}
integer ,
vectorSearchProfile:
{
Description: The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field. ,
Required: False ,
}
string ,
vectorEncoding:
{
Description: The encoding format to interpret the field contents. ,
Enum:
{
packedBit: Encoding format representing bits packed into a wider data type. ,
}
,
Required: False ,
}
enum ,
synonymMaps:
{
Description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields. ,
Required: False ,
}
[
string ,
]
,
fields:
{
Description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case. ,
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions. ,
constant: Boosts scores by a constant factor. ,
quadratic: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
logarithmic: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: Boost scores by the sum of all scoring function results. ,
average: Boost scores by the average of all scoring function results. ,
minimum: Boost scores by the minimum of all scoring function results. ,
maximum: Boost scores by the maximum of all scoring function results. ,
firstMatching: Boost scores using the first applicable scoring function in the scoring profile. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of analyzer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of tokenizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of token filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of char filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
normalizers:
{
Description: The normalizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of normalizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. ,
Required: True ,
}
string ,
}
,
]
,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
similarity:
{
Description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
semantic:
{
Description: Defines parameters for a search index that influence semantic capabilities. ,
Required: False ,
}
{
defaultConfiguration:
{
Description: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. ,
Required: False ,
}
string ,
configurations:
{
Description: The semantic configurations for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the semantic configuration. ,
Required: True ,
}
string ,
prioritizedFields:
{
Description: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. ,
Required: True ,
}
{
titleField:
{
Description: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. ,
Required: False ,
}
{
fieldName:
{
Required: True ,
}
string ,
}
,
prioritizedContentFields:
{
Description: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
prioritizedKeywordsFields:
{
Description: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
}
,
rankingOrder:
{
Description: Specifies the score type to be used for the sort order of the search results. ,
Enum:
{
BoostedRerankerScore: Sets sort order as BoostedRerankerScore ,
RerankerScore: Sets sort order as ReRankerScore ,
}
,
Required: False ,
}
enum ,
flightingOptIn:
{
Description: Determines which semantic or query rewrite models to use during model flighting/upgrades. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
vectorSearch:
{
Description: Contains configuration options related to vector search. ,
Required: False ,
}
{
profiles:
{
Description: Defines combinations of configurations to use with vector search. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vector search profile. ,
Required: True ,
}
string ,
algorithm:
{
Description: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. ,
Required: True ,
}
string ,
vectorizer:
{
Description: The name of the vectorization being configured for use with vector search. ,
Required: False ,
}
string ,
compression:
{
Description: The name of the compression method configuration that specifies the compression method and optional parameters. ,
Required: False ,
}
string ,
}
,
]
,
algorithms:
{
Description: Contains configuration options specific to the algorithm used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of algorithm being configured for use with vector search. ,
Enum:
{
hnsw: HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. ,
exhaustiveKnn: Exhaustive KNN algorithm which will perform brute-force search. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorizers:
{
Description: Contains configuration options on how to vectorize text vector queries. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vectorization method. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of vectorization method being configured for use with vector search. ,
Enum:
{
azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time. ,
customWebApi: Generate embeddings using a custom web endpoint at query time. ,
aiServicesVision: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. ,
aml: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
compressions:
{
Description: Contains configuration options specific to the compression method used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of compression method being configured for use with vector search. ,
Enum:
{
scalarQuantization: Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. ,
binaryQuantization: Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. ,
}
,
Required: True ,
}
enum ,
rerankWithOriginalVectors:
{
Description: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoringOptions:
{
Description: Contains the options for rescoring. ,
Required: False ,
}
{
enableRescoring:
{
Description: If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoreStorageMethod:
{
Description: Controls the storage method for original vectors. This setting is immutable. ,
Enum:
{
preserveOriginals: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. ,
discardOriginals: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. ,
}
,
Required: False ,
}
enum ,
}
,
truncationDimension:
{
Description: The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
permissionFilterOption:
{
Description: A value indicating whether permission filtering is enabled for the index. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}
,
allowIndexDowntime:
{
Description: Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes. ,
Required: False ,
}
boolean ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
description:
{
Description: The description of the index. ,
Required: False ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field, which must be unique within the fields collection of the index or parent field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Enum:
{
Edm.String: Indicates that a field contains a string. ,
Edm.Int32: Indicates that a field contains a 32-bit signed integer. ,
Edm.Int64: Indicates that a field contains a 64-bit signed integer. ,
Edm.Double: Indicates that a field contains an IEEE double-precision floating point number. ,
Edm.Boolean: Indicates that a field contains a Boolean value (true or false). ,
Edm.DateTimeOffset: Indicates that a field contains a date/time value, including timezone information. ,
Edm.GeographyPoint: Indicates that a field contains a geo-location in terms of longitude and latitude. ,
Edm.ComplexType: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. ,
Edm.Single: Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). ,
Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half). ,
Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16). ,
Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). ,
Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). ,
}
,
Required: True ,
}
enum ,
key:
{
Description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields. ,
Required: False ,
}
boolean ,
stored:
{
Description: An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. ,
Required: False ,
}
boolean ,
permissionFilter:
{
Description: A value indicating whether the field should be used as a permission filter. ,
Enum:
{
userIds: Field represents user IDs that should be used to filter document access on queries. ,
groupIds: Field represents group IDs that should be used to filter document access on queries. ,
rbacScope: Field represents an RBAC scope that should be used to filter document access on queries. ,
}
,
Required: False ,
}
enum ,
analyzer:
{
Description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The dimensionality of the vector field. ,
Format: int32 ,
Required: False ,
}
integer ,
vectorSearchProfile:
{
Description: The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field. ,
Required: False ,
}
string ,
vectorEncoding:
{
Description: The encoding format to interpret the field contents. ,
Enum:
{
packedBit: Encoding format representing bits packed into a wider data type. ,
}
,
Required: False ,
}
enum ,
synonymMaps:
{
Description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields. ,
Required: False ,
}
[
string ,
]
,
fields:
{
Description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case. ,
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions. ,
constant: Boosts scores by a constant factor. ,
quadratic: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
logarithmic: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: Boost scores by the sum of all scoring function results. ,
average: Boost scores by the average of all scoring function results. ,
minimum: Boost scores by the minimum of all scoring function results. ,
maximum: Boost scores by the maximum of all scoring function results. ,
firstMatching: Boost scores using the first applicable scoring function in the scoring profile. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of analyzer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of tokenizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of token filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of char filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
normalizers:
{
Description: The normalizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of normalizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. ,
Required: True ,
}
string ,
}
,
]
,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
similarity:
{
Description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
semantic:
{
Description: Defines parameters for a search index that influence semantic capabilities. ,
Required: False ,
}
{
defaultConfiguration:
{
Description: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. ,
Required: False ,
}
string ,
configurations:
{
Description: The semantic configurations for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the semantic configuration. ,
Required: True ,
}
string ,
prioritizedFields:
{
Description: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. ,
Required: True ,
}
{
titleField:
{
Description: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. ,
Required: False ,
}
{
fieldName:
{
Required: True ,
}
string ,
}
,
prioritizedContentFields:
{
Description: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
prioritizedKeywordsFields:
{
Description: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
}
,
rankingOrder:
{
Description: Specifies the score type to be used for the sort order of the search results. ,
Enum:
{
BoostedRerankerScore: Sets sort order as BoostedRerankerScore ,
RerankerScore: Sets sort order as ReRankerScore ,
}
,
Required: False ,
}
enum ,
flightingOptIn:
{
Description: Determines which semantic or query rewrite models to use during model flighting/upgrades. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
vectorSearch:
{
Description: Contains configuration options related to vector search. ,
Required: False ,
}
{
profiles:
{
Description: Defines combinations of configurations to use with vector search. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vector search profile. ,
Required: True ,
}
string ,
algorithm:
{
Description: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. ,
Required: True ,
}
string ,
vectorizer:
{
Description: The name of the vectorization being configured for use with vector search. ,
Required: False ,
}
string ,
compression:
{
Description: The name of the compression method configuration that specifies the compression method and optional parameters. ,
Required: False ,
}
string ,
}
,
]
,
algorithms:
{
Description: Contains configuration options specific to the algorithm used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of algorithm being configured for use with vector search. ,
Enum:
{
hnsw: HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. ,
exhaustiveKnn: Exhaustive KNN algorithm which will perform brute-force search. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorizers:
{
Description: Contains configuration options on how to vectorize text vector queries. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vectorization method. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of vectorization method being configured for use with vector search. ,
Enum:
{
azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time. ,
customWebApi: Generate embeddings using a custom web endpoint at query time. ,
aiServicesVision: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. ,
aml: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
compressions:
{
Description: Contains configuration options specific to the compression method used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of compression method being configured for use with vector search. ,
Enum:
{
scalarQuantization: Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. ,
binaryQuantization: Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. ,
}
,
Required: True ,
}
enum ,
rerankWithOriginalVectors:
{
Description: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoringOptions:
{
Description: Contains the options for rescoring. ,
Required: False ,
}
{
enableRescoring:
{
Description: If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoreStorageMethod:
{
Description: Controls the storage method for original vectors. This setting is immutable. ,
Enum:
{
preserveOriginals: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. ,
discardOriginals: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. ,
}
,
Required: False ,
}
enum ,
}
,
truncationDimension:
{
Description: The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
permissionFilterOption:
{
Description: A value indicating whether permission filtering is enabled for the index. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
description:
{
Description: The description of the index. ,
Required: False ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field, which must be unique within the fields collection of the index or parent field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Enum:
{
Edm.String: Indicates that a field contains a string. ,
Edm.Int32: Indicates that a field contains a 32-bit signed integer. ,
Edm.Int64: Indicates that a field contains a 64-bit signed integer. ,
Edm.Double: Indicates that a field contains an IEEE double-precision floating point number. ,
Edm.Boolean: Indicates that a field contains a Boolean value (true or false). ,
Edm.DateTimeOffset: Indicates that a field contains a date/time value, including timezone information. ,
Edm.GeographyPoint: Indicates that a field contains a geo-location in terms of longitude and latitude. ,
Edm.ComplexType: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. ,
Edm.Single: Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). ,
Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half). ,
Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16). ,
Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). ,
Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). ,
}
,
Required: True ,
}
enum ,
key:
{
Description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields. ,
Required: False ,
}
boolean ,
stored:
{
Description: An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. ,
Required: False ,
}
boolean ,
permissionFilter:
{
Description: A value indicating whether the field should be used as a permission filter. ,
Enum:
{
userIds: Field represents user IDs that should be used to filter document access on queries. ,
groupIds: Field represents group IDs that should be used to filter document access on queries. ,
rbacScope: Field represents an RBAC scope that should be used to filter document access on queries. ,
}
,
Required: False ,
}
enum ,
analyzer:
{
Description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The dimensionality of the vector field. ,
Format: int32 ,
Required: False ,
}
integer ,
vectorSearchProfile:
{
Description: The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field. ,
Required: False ,
}
string ,
vectorEncoding:
{
Description: The encoding format to interpret the field contents. ,
Enum:
{
packedBit: Encoding format representing bits packed into a wider data type. ,
}
,
Required: False ,
}
enum ,
synonymMaps:
{
Description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields. ,
Required: False ,
}
[
string ,
]
,
fields:
{
Description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case. ,
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions. ,
constant: Boosts scores by a constant factor. ,
quadratic: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
logarithmic: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: Boost scores by the sum of all scoring function results. ,
average: Boost scores by the average of all scoring function results. ,
minimum: Boost scores by the minimum of all scoring function results. ,
maximum: Boost scores by the maximum of all scoring function results. ,
firstMatching: Boost scores using the first applicable scoring function in the scoring profile. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of analyzer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of tokenizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of token filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of char filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
normalizers:
{
Description: The normalizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of normalizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. ,
Required: True ,
}
string ,
}
,
]
,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
similarity:
{
Description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
semantic:
{
Description: Defines parameters for a search index that influence semantic capabilities. ,
Required: False ,
}
{
defaultConfiguration:
{
Description: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. ,
Required: False ,
}
string ,
configurations:
{
Description: The semantic configurations for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the semantic configuration. ,
Required: True ,
}
string ,
prioritizedFields:
{
Description: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. ,
Required: True ,
}
{
titleField:
{
Description: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. ,
Required: False ,
}
{
fieldName:
{
Required: True ,
}
string ,
}
,
prioritizedContentFields:
{
Description: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
prioritizedKeywordsFields:
{
Description: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
}
,
rankingOrder:
{
Description: Specifies the score type to be used for the sort order of the search results. ,
Enum:
{
BoostedRerankerScore: Sets sort order as BoostedRerankerScore ,
RerankerScore: Sets sort order as ReRankerScore ,
}
,
Required: False ,
}
enum ,
flightingOptIn:
{
Description: Determines which semantic or query rewrite models to use during model flighting/upgrades. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
vectorSearch:
{
Description: Contains configuration options related to vector search. ,
Required: False ,
}
{
profiles:
{
Description: Defines combinations of configurations to use with vector search. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vector search profile. ,
Required: True ,
}
string ,
algorithm:
{
Description: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. ,
Required: True ,
}
string ,
vectorizer:
{
Description: The name of the vectorization being configured for use with vector search. ,
Required: False ,
}
string ,
compression:
{
Description: The name of the compression method configuration that specifies the compression method and optional parameters. ,
Required: False ,
}
string ,
}
,
]
,
algorithms:
{
Description: Contains configuration options specific to the algorithm used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of algorithm being configured for use with vector search. ,
Enum:
{
hnsw: HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. ,
exhaustiveKnn: Exhaustive KNN algorithm which will perform brute-force search. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorizers:
{
Description: Contains configuration options on how to vectorize text vector queries. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vectorization method. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of vectorization method being configured for use with vector search. ,
Enum:
{
azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time. ,
customWebApi: Generate embeddings using a custom web endpoint at query time. ,
aiServicesVision: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. ,
aml: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
compressions:
{
Description: Contains configuration options specific to the compression method used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of compression method being configured for use with vector search. ,
Enum:
{
scalarQuantization: Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. ,
binaryQuantization: Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. ,
}
,
Required: True ,
}
enum ,
rerankWithOriginalVectors:
{
Description: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoringOptions:
{
Description: Contains the options for rescoring. ,
Required: False ,
}
{
enableRescoring:
{
Description: If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoreStorageMethod:
{
Description: Controls the storage method for original vectors. This setting is immutable. ,
Enum:
{
preserveOriginals: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. ,
discardOriginals: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. ,
}
,
Required: False ,
}
enum ,
}
,
truncationDimension:
{
Description: The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
permissionFilterOption:
{
Description: A value indicating whether permission filtering is enabled for the index. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexes_Delete (new)
Description :  Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.
Reference :  Link ¶

⚼ Request

DELETE:  /indexes('{indexName}')
{
indexName:
{
Description: The name of the index to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Indexes_Get (new)
Description :  Retrieves an index definition.
Reference :  Link ¶

⚼ Request

GET:  /indexes('{indexName}')
{
indexName:
{
Description: The name of the index to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
description:
{
Description: The description of the index. ,
Required: False ,
}
string ,
fields:
{
Description: The fields of the index. ,
Required: True ,
}
[
{
name:
{
Description: The name of the field, which must be unique within the fields collection of the index or parent field. ,
Required: True ,
}
string ,
type:
{
Description: The data type of the field. ,
Enum:
{
Edm.String: Indicates that a field contains a string. ,
Edm.Int32: Indicates that a field contains a 32-bit signed integer. ,
Edm.Int64: Indicates that a field contains a 64-bit signed integer. ,
Edm.Double: Indicates that a field contains an IEEE double-precision floating point number. ,
Edm.Boolean: Indicates that a field contains a Boolean value (true or false). ,
Edm.DateTimeOffset: Indicates that a field contains a date/time value, including timezone information. ,
Edm.GeographyPoint: Indicates that a field contains a geo-location in terms of longitude and latitude. ,
Edm.ComplexType: Indicates that a field contains one or more complex objects that in turn have sub-fields of other types. ,
Edm.Single: Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single). ,
Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half). ,
Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16). ,
Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte). ,
Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte). ,
}
,
Required: True ,
}
enum ,
key:
{
Description: A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
retrievable:
{
Description: A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields, false for vector fields, and null for complex fields. ,
Required: False ,
}
boolean ,
stored:
{
Description: An immutable value indicating whether the field will be persisted separately on disk to be returned in a search result. You can disable this option if you don't plan to return the field contents in a search response to save on storage overhead. This can only be set during index creation and only for vector fields. This property cannot be changed for existing fields or set as false for new fields. If this property is set as false, the property 'retrievable' must also be set to false. This property must be true or unset for key fields, for new fields, and for non-vector fields, and it must be null for complex fields. Disabling this property will reduce index storage requirements. The default is true for vector fields. ,
Required: False ,
}
boolean ,
searchable:
{
Description: A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like "sunny day", internally it will be split into the individual tokens "sunny" and "day". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index to accommodate additional tokenized versions of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false. ,
Required: False ,
}
boolean ,
filterable:
{
Description: A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to "sunny day", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields. ,
Required: False ,
}
boolean ,
sortable:
{
Description: A value indicating whether to enable the field to be referenced in $orderby expressions. By default, the search engine sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields. ,
Required: False ,
}
boolean ,
facetable:
{
Description: A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields. ,
Required: False ,
}
boolean ,
permissionFilter:
{
Description: A value indicating whether the field should be used as a permission filter. ,
Enum:
{
userIds: Field represents user IDs that should be used to filter document access on queries. ,
groupIds: Field represents group IDs that should be used to filter document access on queries. ,
rbacScope: Field represents an RBAC scope that should be used to filter document access on queries. ,
}
,
Required: False ,
}
enum ,
analyzer:
{
Description: The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
searchAnalyzer:
{
Description: The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
indexAnalyzer:
{
Description: The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use for the field. This option can be used only with fields with filterable, sortable, or facetable enabled. Once the normalizer is chosen, it cannot be changed for the field. Must be null for complex fields. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
dimensions:
{
Description: The dimensionality of the vector field. ,
Format: int32 ,
Required: False ,
}
integer ,
vectorSearchProfile:
{
Description: The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field. ,
Required: False ,
}
string ,
vectorEncoding:
{
Description: The encoding format to interpret the field contents. ,
Enum:
{
packedBit: Encoding format representing bits packed into a wider data type. ,
}
,
Required: False ,
}
enum ,
synonymMaps:
{
Description: A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields. ,
Required: False ,
}
[
string ,
]
,
fields:
{
Description: A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
scoringProfiles:
{
Description: The scoring profiles for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the scoring profile. ,
Required: True ,
}
string ,
text:
{
Description: Parameters that boost scoring based on text matches in certain index fields. ,
Required: False ,
}
{
weights:
{
Description: The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field. ,
Required: True ,
}
object ,
}
,
functions:
{
Description: The collection of functions that influence the scoring of documents. ,
Required: False ,
}
[
{
type:
{
Description: Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case. ,
Required: True ,
}
string ,
fieldName:
{
Description: The name of the field used as input to the scoring function. ,
Required: True ,
}
string ,
boost:
{
Description: A multiplier for the raw score. Must be a positive number not equal to 1.0. ,
Format: double ,
Required: True ,
}
number ,
interpolation:
{
Description: A value indicating how boosting will be interpolated across document scores; defaults to "Linear". ,
Enum:
{
linear: Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions. ,
constant: Boosts scores by a constant factor. ,
quadratic: Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
logarithmic: Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
functionAggregation:
{
Description: A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions. ,
Enum:
{
sum: Boost scores by the sum of all scoring function results. ,
average: Boost scores by the average of all scoring function results. ,
minimum: Boost scores by the minimum of all scoring function results. ,
maximum: Boost scores by the maximum of all scoring function results. ,
firstMatching: Boost scores using the first applicable scoring function in the scoring profile. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
defaultScoringProfile:
{
Description: The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used. ,
Required: False ,
}
string ,
corsOptions:
{
Description: Options to control Cross-Origin Resource Sharing (CORS) for the index. ,
Required: False ,
}
{
allowedOrigins:
{
Description: The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended). ,
Required: True ,
}
[
string ,
]
,
maxAgeInSeconds:
{
Description: The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
suggesters:
{
Description: The suggesters for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the suggester. ,
Required: True ,
}
string ,
searchMode:
{
Description: A value indicating the capabilities of the suggester. ,
Enum:
{
analyzingInfixMatching: Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match. ,
}
,
Required: True ,
}
enum ,
sourceFields:
{
Description: The list of field names to which the suggester applies. Each field must be searchable. ,
Required: True ,
}
[
string ,
]
,
}
,
]
,
analyzers:
{
Description: The analyzers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of analyzer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenizers:
{
Description: The tokenizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of tokenizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
tokenFilters:
{
Description: The token filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of token filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
charFilters:
{
Description: The character filters for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of char filter. ,
Required: True ,
}
string ,
name:
{
Description: The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. ,
Required: True ,
}
string ,
}
,
]
,
normalizers:
{
Description: The normalizers for the index. ,
Required: False ,
}
[
{
@odata.type:
{
Description: A URI fragment specifying the type of normalizer. ,
Required: True ,
}
string ,
name:
{
Description: The name of the normalizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters. It cannot end in '.microsoft' nor '.lucene', nor be named 'asciifolding', 'standard', 'lowercase', 'uppercase', or 'elision'. ,
Required: True ,
}
string ,
}
,
]
,
encryptionKey:
{
Description: A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data. Once you have encrypted your data, it will always remain encrypted. The search service will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019. ,
Required: False ,
}
{
keyVaultKeyName:
{
Description: The name of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: True ,
}
string ,
keyVaultKeyVersion:
{
Description: The version of your Azure Key Vault key to be used to encrypt your data at rest. ,
Required: False ,
}
string ,
keyVaultUri:
{
Description: The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be `https://my-keyvault-name.vault.azure.net`. ,
Required: True ,
}
string ,
accessCredentials:
{
Description: Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead. ,
Required: False ,
}
{
applicationId:
{
Description: An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application. ,
Required: True ,
}
string ,
applicationSecret:
{
Description: The authentication key of the specified AAD application. ,
Required: False ,
}
string ,
}
,
identity:
{
Description: An explicit managed identity to use for this encryption key. If not specified and the access credentials property is null, the system-assigned managed identity is used. On update to the resource, if the explicit identity is unspecified, it remains unchanged. If "none" is specified, the value of this property is cleared. ,
Required: False ,
}
{
@odata.type:
{
Description: A URI fragment specifying the type of identity. ,
Required: True ,
}
string ,
}
,
}
,
similarity:
{
Description: The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used. ,
Required: False ,
}
{
@odata.type:
{
Required: True ,
}
string ,
}
,
semantic:
{
Description: Defines parameters for a search index that influence semantic capabilities. ,
Required: False ,
}
{
defaultConfiguration:
{
Description: Allows you to set the name of a default semantic configuration in your index, making it optional to pass it on as a query parameter every time. ,
Required: False ,
}
string ,
configurations:
{
Description: The semantic configurations for the index. ,
Required: False ,
}
[
{
name:
{
Description: The name of the semantic configuration. ,
Required: True ,
}
string ,
prioritizedFields:
{
Description: Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. ,
Required: True ,
}
{
titleField:
{
Description: Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. ,
Required: False ,
}
{
fieldName:
{
Required: True ,
}
string ,
}
,
prioritizedContentFields:
{
Description: Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
prioritizedKeywordsFields:
{
Description: Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. ,
Required: False ,
}
[
{
fieldName:
{
Required: True ,
}
string ,
}
,
]
,
}
,
rankingOrder:
{
Description: Specifies the score type to be used for the sort order of the search results. ,
Enum:
{
BoostedRerankerScore: Sets sort order as BoostedRerankerScore ,
RerankerScore: Sets sort order as ReRankerScore ,
}
,
Required: False ,
}
enum ,
flightingOptIn:
{
Description: Determines which semantic or query rewrite models to use during model flighting/upgrades. ,
Required: False ,
}
boolean ,
}
,
]
,
}
,
vectorSearch:
{
Description: Contains configuration options related to vector search. ,
Required: False ,
}
{
profiles:
{
Description: Defines combinations of configurations to use with vector search. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vector search profile. ,
Required: True ,
}
string ,
algorithm:
{
Description: The name of the vector search algorithm configuration that specifies the algorithm and optional parameters. ,
Required: True ,
}
string ,
vectorizer:
{
Description: The name of the vectorization being configured for use with vector search. ,
Required: False ,
}
string ,
compression:
{
Description: The name of the compression method configuration that specifies the compression method and optional parameters. ,
Required: False ,
}
string ,
}
,
]
,
algorithms:
{
Description: Contains configuration options specific to the algorithm used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of algorithm being configured for use with vector search. ,
Enum:
{
hnsw: HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm. ,
exhaustiveKnn: Exhaustive KNN algorithm which will perform brute-force search. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
vectorizers:
{
Description: Contains configuration options on how to vectorize text vector queries. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular vectorization method. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of vectorization method being configured for use with vector search. ,
Enum:
{
azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time. ,
customWebApi: Generate embeddings using a custom web endpoint at query time. ,
aiServicesVision: Generate embeddings for an image or text input at query time using the Azure AI Services Vision Vectorize API. ,
aml: Generate embeddings using an Azure Machine Learning endpoint deployed via the Azure AI Foundry Model Catalog at query time. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
compressions:
{
Description: Contains configuration options specific to the compression method used during indexing or querying. ,
Required: False ,
}
[
{
name:
{
Description: The name to associate with this particular configuration. ,
Required: True ,
}
string ,
kind:
{
Description: The name of the kind of compression method being configured for use with vector search. ,
Enum:
{
scalarQuantization: Scalar Quantization, a type of compression method. In scalar quantization, the original vectors values are compressed to a narrower type by discretizing and representing each component of a vector using a reduced set of quantized values, thereby reducing the overall data size. ,
binaryQuantization: Binary Quantization, a type of compression method. In binary quantization, the original vectors values are compressed to the narrower binary type by discretizing and representing each component of a vector using binary values, thereby reducing the overall data size. ,
}
,
Required: True ,
}
enum ,
rerankWithOriginalVectors:
{
Description: If set to true, once the ordered set of results calculated using compressed vectors are obtained, they will be reranked again by recalculating the full-precision similarity scores. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling will internally request more documents (specified by this multiplier) in the initial search. This increases the set of results that will be reranked using recomputed similarity scores from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when rerankWithOriginalVectors is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoringOptions:
{
Description: Contains the options for rescoring. ,
Required: False ,
}
{
enableRescoring:
{
Description: If set to true, after the initial search on the compressed vectors, the similarity scores are recalculated using the full-precision vectors. This will improve recall at the expense of latency. ,
Required: False ,
}
boolean ,
defaultOversampling:
{
Description: Default oversampling factor. Oversampling retrieves a greater set of potential documents to offset the resolution loss due to quantization. This increases the set of results that will be rescored on full-precision vectors. Minimum value is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' is true. Higher values improve recall at the expense of latency. ,
Format: double ,
Required: False ,
}
number ,
rescoreStorageMethod:
{
Description: Controls the storage method for original vectors. This setting is immutable. ,
Enum:
{
preserveOriginals: This option preserves the original full-precision vectors. Choose this option for maximum flexibility and highest quality of compressed search results. This consumes more storage but allows for rescoring and oversampling. ,
discardOriginals: This option discards the original full-precision vectors. Choose this option for maximum storage savings. Since this option does not allow for rescoring and oversampling, it will often cause slight to moderate reductions in quality. ,
}
,
Required: False ,
}
enum ,
}
,
truncationDimension:
{
Description: The number of dimensions to truncate the vectors to. Truncating the vectors reduces the size of the vectors and the amount of data that needs to be transferred during search. This can save storage cost and improve search performance at the expense of recall. It should be only used for embeddings trained with Matryoshka Representation Learning (MRL) such as OpenAI text-embedding-3-large (small). The default value is null, which means no truncation. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
permissionFilterOption:
{
Description: A value indicating whether permission filtering is enabled for the index. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
@odata.etag:
{
Description: The ETag of the index. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexes_GetStatistics (new)
Description :  Returns statistics for the given index, including a document count and storage usage.
Reference :  Link ¶

⚼ Request

GET:  /indexes('{indexName}')/search.stats
{
indexName:
{
Description: The name of the index for which to retrieve statistics. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
documentCount:
{
Description: The number of documents in the index. ,
Format: int64 ,
Required: True ,
}
integer ,
storageSize:
{
Description: The amount of storage in bytes consumed by the index. ,
Format: int64 ,
Required: True ,
}
integer ,
vectorIndexSize:
{
Description: The amount of memory in bytes consumed by vectors in the index. ,
Format: int64 ,
Required: True ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Indexes_Analyze (new)
Description :  Shows how an analyzer breaks text into tokens.
Reference :  Link ¶

⚼ Request

POST:  /indexes('{indexName}')/search.analyze
{
indexName:
{
Description: The name of the index for which to test an analyzer. ,
Required: True ,
}
string ,
request:
{
Description: The text and analyzer or analysis components to test. ,
Required: True ,
}
{
text:
{
Description: The text to break into tokens. ,
Required: True ,
}
string ,
analyzer:
{
Description: The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive. ,
Enum:
{
ar.microsoft: Microsoft analyzer for Arabic. ,
ar.lucene: Lucene analyzer for Arabic. ,
hy.lucene: Lucene analyzer for Armenian. ,
bn.microsoft: Microsoft analyzer for Bangla. ,
eu.lucene: Lucene analyzer for Basque. ,
bg.microsoft: Microsoft analyzer for Bulgarian. ,
bg.lucene: Lucene analyzer for Bulgarian. ,
ca.microsoft: Microsoft analyzer for Catalan. ,
ca.lucene: Lucene analyzer for Catalan. ,
zh-Hans.microsoft: Microsoft analyzer for Chinese (Simplified). ,
zh-Hans.lucene: Lucene analyzer for Chinese (Simplified). ,
zh-Hant.microsoft: Microsoft analyzer for Chinese (Traditional). ,
zh-Hant.lucene: Lucene analyzer for Chinese (Traditional). ,
hr.microsoft: Microsoft analyzer for Croatian. ,
cs.microsoft: Microsoft analyzer for Czech. ,
cs.lucene: Lucene analyzer for Czech. ,
da.microsoft: Microsoft analyzer for Danish. ,
da.lucene: Lucene analyzer for Danish. ,
nl.microsoft: Microsoft analyzer for Dutch. ,
nl.lucene: Lucene analyzer for Dutch. ,
en.microsoft: Microsoft analyzer for English. ,
en.lucene: Lucene analyzer for English. ,
et.microsoft: Microsoft analyzer for Estonian. ,
fi.microsoft: Microsoft analyzer for Finnish. ,
fi.lucene: Lucene analyzer for Finnish. ,
fr.microsoft: Microsoft analyzer for French. ,
fr.lucene: Lucene analyzer for French. ,
gl.lucene: Lucene analyzer for Galician. ,
de.microsoft: Microsoft analyzer for German. ,
de.lucene: Lucene analyzer for German. ,
el.microsoft: Microsoft analyzer for Greek. ,
el.lucene: Lucene analyzer for Greek. ,
gu.microsoft: Microsoft analyzer for Gujarati. ,
he.microsoft: Microsoft analyzer for Hebrew. ,
hi.microsoft: Microsoft analyzer for Hindi. ,
hi.lucene: Lucene analyzer for Hindi. ,
hu.microsoft: Microsoft analyzer for Hungarian. ,
hu.lucene: Lucene analyzer for Hungarian. ,
is.microsoft: Microsoft analyzer for Icelandic. ,
id.microsoft: Microsoft analyzer for Indonesian (Bahasa). ,
id.lucene: Lucene analyzer for Indonesian. ,
ga.lucene: Lucene analyzer for Irish. ,
it.microsoft: Microsoft analyzer for Italian. ,
it.lucene: Lucene analyzer for Italian. ,
ja.microsoft: Microsoft analyzer for Japanese. ,
ja.lucene: Lucene analyzer for Japanese. ,
kn.microsoft: Microsoft analyzer for Kannada. ,
ko.microsoft: Microsoft analyzer for Korean. ,
ko.lucene: Lucene analyzer for Korean. ,
lv.microsoft: Microsoft analyzer for Latvian. ,
lv.lucene: Lucene analyzer for Latvian. ,
lt.microsoft: Microsoft analyzer for Lithuanian. ,
ml.microsoft: Microsoft analyzer for Malayalam. ,
ms.microsoft: Microsoft analyzer for Malay (Latin). ,
mr.microsoft: Microsoft analyzer for Marathi. ,
nb.microsoft: Microsoft analyzer for Norwegian (Bokmål). ,
no.lucene: Lucene analyzer for Norwegian. ,
fa.lucene: Lucene analyzer for Persian. ,
pl.microsoft: Microsoft analyzer for Polish. ,
pl.lucene: Lucene analyzer for Polish. ,
pt-BR.microsoft: Microsoft analyzer for Portuguese (Brazil). ,
pt-BR.lucene: Lucene analyzer for Portuguese (Brazil). ,
pt-PT.microsoft: Microsoft analyzer for Portuguese (Portugal). ,
pt-PT.lucene: Lucene analyzer for Portuguese (Portugal). ,
pa.microsoft: Microsoft analyzer for Punjabi. ,
ro.microsoft: Microsoft analyzer for Romanian. ,
ro.lucene: Lucene analyzer for Romanian. ,
ru.microsoft: Microsoft analyzer for Russian. ,
ru.lucene: Lucene analyzer for Russian. ,
sr-cyrillic.microsoft: Microsoft analyzer for Serbian (Cyrillic). ,
sr-latin.microsoft: Microsoft analyzer for Serbian (Latin). ,
sk.microsoft: Microsoft analyzer for Slovak. ,
sl.microsoft: Microsoft analyzer for Slovenian. ,
es.microsoft: Microsoft analyzer for Spanish. ,
es.lucene: Lucene analyzer for Spanish. ,
sv.microsoft: Microsoft analyzer for Swedish. ,
sv.lucene: Lucene analyzer for Swedish. ,
ta.microsoft: Microsoft analyzer for Tamil. ,
te.microsoft: Microsoft analyzer for Telugu. ,
th.microsoft: Microsoft analyzer for Thai. ,
th.lucene: Lucene analyzer for Thai. ,
tr.microsoft: Microsoft analyzer for Turkish. ,
tr.lucene: Lucene analyzer for Turkish. ,
uk.microsoft: Microsoft analyzer for Ukrainian. ,
ur.microsoft: Microsoft analyzer for Urdu. ,
vi.microsoft: Microsoft analyzer for Vietnamese. ,
standard.lucene: Standard Lucene analyzer. ,
standardasciifolding.lucene: Standard ASCII Folding Lucene analyzer. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers ,
keyword: Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html ,
pattern: Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html ,
simple: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html ,
stop: Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html ,
whitespace: An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html ,
}
,
Required: False ,
}
enum ,
tokenizer:
{
Description: The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive. ,
Enum:
{
classic: Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html ,
edgeNGram: Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html ,
keyword_v2: Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html ,
letter: Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html ,
lowercase: Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html ,
microsoft_language_tokenizer: Divides text using language-specific rules. ,
microsoft_language_stemming_tokenizer: Divides text using language-specific rules and reduces words to their base forms. ,
nGram: Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html ,
path_hierarchy_v2: Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html ,
pattern: Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html ,
standard_v2: Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html ,
uax_url_email: Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html ,
whitespace: Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html ,
}
,
Required: False ,
}
enum ,
normalizer:
{
Description: The name of the normalizer to use to normalize the given text. ,
Enum:
{
asciifolding: Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the "Basic Latin" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html ,
elision: Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html ,
lowercase: Normalizes token text to lowercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html ,
standard: Standard normalizer, which consists of lowercase and asciifolding. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html ,
uppercase: Normalizes token text to uppercase. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html ,
}
,
Required: False ,
}
enum ,
tokenFilters:
{
Description: An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter. ,
Required: False ,
}
[
string ,
]
,
charFilters:
{
Description: An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter. ,
Required: False ,
}
[
string ,
]
,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
tokens:
{
Description: The list of tokens returned by the analyzer specified in the request. ,
Required: True ,
}
[
{
token:
{
Description: The token returned by the analyzer. ,
Required: True ,
}
string ,
startOffset:
{
Description: The index of the first character of the token in the input text. ,
Format: int32 ,
Required: True ,
}
integer ,
endOffset:
{
Description: The index of the last character of the token in the input text. ,
Format: int32 ,
Required: True ,
}
integer ,
position:
{
Description: The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Aliases_Create (new)
Description :  Creates a new search alias.
Reference :  Link ¶

⚼ Request

POST:  /aliases
{
alias:
{
Description: The definition of the alias to create. ,
Required: True ,
}
{
name:
{
Description: The name of the alias. ,
Required: True ,
}
string ,
indexes:
{
Description: The name of the index this alias maps to. Only one index name may be specified. ,
Required: True ,
}
[
string ,
]
,
@odata.etag:
{
Description: The ETag of the alias. ,
Required: False ,
}
string ,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the alias. ,
Required: True ,
}
string ,
indexes:
{
Description: The name of the index this alias maps to. Only one index name may be specified. ,
Required: True ,
}
[
string ,
]
,
@odata.etag:
{
Description: The ETag of the alias. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Aliases_List (new)
Description :  Lists all aliases available for a search service.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The aliases in the Search service. ,
Required: True ,
}
[
{
name:
{
Description: The name of the alias. ,
Required: True ,
}
string ,
indexes:
{
Description: The name of the index this alias maps to. Only one index name may be specified. ,
Required: True ,
}
[
string ,
]
,
@odata.etag:
{
Description: The ETag of the alias. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Aliases_CreateOrUpdate (new)
Description :  Creates a new search alias or updates an alias if it already exists.
Reference :  Link ¶

⚼ Request

PUT:  /aliases('{aliasName}')
{
aliasName:
{
Description: The definition of the alias to create or update. ,
Required: True ,
}
string ,
alias:
{
Description: The definition of the alias to create or update. ,
Required: True ,
}
{
name:
{
Description: The name of the alias. ,
Required: True ,
}
string ,
indexes:
{
Description: The name of the index this alias maps to. Only one index name may be specified. ,
Required: True ,
}
[
string ,
]
,
@odata.etag:
{
Description: The ETag of the alias. ,
Required: False ,
}
string ,
}
,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
Prefer:
{
Description: For HTTP PUT requests, instructs the service to return the created/updated resource on success. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the alias. ,
Required: True ,
}
string ,
indexes:
{
Description: The name of the index this alias maps to. Only one index name may be specified. ,
Required: True ,
}
[
string ,
]
,
@odata.etag:
{
Description: The ETag of the alias. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
name:
{
Description: The name of the alias. ,
Required: True ,
}
string ,
indexes:
{
Description: The name of the index this alias maps to. Only one index name may be specified. ,
Required: True ,
}
[
string ,
]
,
@odata.etag:
{
Description: The ETag of the alias. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Aliases_Delete (new)
Description :  Deletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this operation.
Reference :  Link ¶

⚼ Request

DELETE:  /aliases('{aliasName}')
{
aliasName:
{
Description: The name of the alias to delete. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
If-Match:
{
Description: Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value. ,
Required: False ,
}
string ,
If-None-Match:
{
Description: Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value. ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (404)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Aliases_Get (new)
Description :  Retrieves an alias definition.
Reference :  Link ¶

⚼ Request

GET:  /aliases('{aliasName}')
{
aliasName:
{
Description: The name of the alias to retrieve. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: The tracking ID sent with the request to help with debugging. ,
Format: uuid ,
Required: False ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: The name of the alias. ,
Required: True ,
}
string ,
indexes:
{
Description: The name of the index this alias maps to. Only one index name may be specified. ,
Required: True ,
}
[
string ,
]
,
@odata.etag:
{
Description: The ETag of the alias. ,
Required: False ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
GetServiceStatistics (new)
Description :  Gets service level statistics for a search service.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
counters:
{
Description: Service level resource counters. ,
Required: True ,
}
{
aliasesCount:
{
Description: Total number of aliases. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
documentCount:
{
Description: Total number of documents across all indexes in the service. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
indexesCount:
{
Description: Total number of indexes. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
indexersCount:
{
Description: Total number of indexers. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
dataSourcesCount:
{
Description: Total number of data sources. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
storageSize:
{
Description: Total size of used storage in bytes. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
synonymMaps:
{
Description: Total number of synonym maps. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
skillsetCount:
{
Description: Total number of skillsets. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
vectorIndexSize:
{
Description: Total memory consumption of all vector indexes within the service, in bytes. ,
Required: True ,
}
{
usage:
{
Description: The resource usage amount. ,
Format: int64 ,
Required: True ,
}
integer ,
quota:
{
Description: The resource amount quota. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}
,
limits:
{
Description: Service level general limits. ,
Required: True ,
}
{
maxFieldsPerIndex:
{
Description: The maximum allowed fields per index. ,
Format: int32 ,
Required: False ,
}
integer ,
maxFieldNestingDepthPerIndex:
{
Description: The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3. ,
Format: int32 ,
Required: False ,
}
integer ,
maxComplexCollectionFieldsPerIndex:
{
Description: The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index. ,
Format: int32 ,
Required: False ,
}
integer ,
maxComplexObjectsInCollectionsPerDocument:
{
Description: The maximum number of objects in complex collections allowed per document. ,
Format: int32 ,
Required: False ,
}
integer ,
maxStoragePerIndex:
{
Description: The maximum amount of storage in bytes allowed per index. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
GetIndexStatsSummary (new)
Description :  Retrieves a summary of statistics for all indexes in the search service.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: The Statistics summary of all indexes in the Search service. ,
Required: True ,
}
[
{
name:
{
Description: The name of the index. ,
Required: True ,
}
string ,
documentCount:
{
Description: The number of documents in the index. ,
Format: int64 ,
Required: True ,
}
integer ,
storageSize:
{
Description: The amount of storage in bytes consumed by the index. ,
Format: int64 ,
Required: True ,
}
integer ,
vectorIndexSize:
{
Description: The amount of memory in bytes consumed by vectors in the index. ,
Format: int64 ,
Required: True ,
}
integer ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
,
}