Indexes - Get

SearchIndex

ErrorResponse

Error response.

#Microsoft.Azure.Search.AsciiFoldingTokenFilter

A URI fragment specifying the type of token filter.

string

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.

boolean

A value indicating whether the original token will be kept. Default is false.

string

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.

string

The authentication key of the specified AAD application.

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

A URI fragment specifying the type of skill.

string

API key of the designated Azure OpenAI resource.

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

The user-assigned managed identity used for outbound connections.

string

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.

string

ID of the Azure OpenAI model deployment on the designated resource.

string

The description of the skill which describes the inputs, outputs, and usage of the skill.

integer

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

InputFieldMappingEntry[]

Inputs of the skills could be a column in the source data set, or the output of an upstream skill.

AzureOpenAIModelName

The name of the embedding model that is deployed at the provided deploymentId path.

string

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 '#'.

OutputFieldMappingEntry[]

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.

string

The resource URI of the Azure OpenAI resource.

string

string

string

string

API key of the designated Azure OpenAI resource.

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

The user-assigned managed identity used for outbound connections.

string

ID of the Azure OpenAI model deployment on the designated resource.

AzureOpenAIModelName

The name of the embedding model that is deployed at the provided deploymentId path.

string

The resource URI of the Azure OpenAI resource.

AzureOpenAIEmbeddingSkill

Contains the parameters specific to Azure OpenAI embedding vectorization.

azureOpenAI

The name of the kind of vectorization method being configured for use with vector search.

string

The name to associate with this particular vectorization method.

number

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.

binaryQuantization

The name of the kind of compression method being configured for use with vector search.

string

The name to associate with this particular configuration.

boolean

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.

#Microsoft.Azure.Search.BM25Similarity

number

This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document.

number

This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency.

string

A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html

#Microsoft.Azure.Search.CjkBigramTokenFilter

A URI fragment specifying the type of token filter.

CjkBigramTokenFilterScripts[]

The scripts to ignore.

string

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.

boolean

A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false.

string

Ignore Han script when forming bigrams of CJK terms.

string

Ignore Hangul script when forming bigrams of CJK terms.

string

Ignore Hiragana script when forming bigrams of CJK terms.

string

Ignore Katakana script when forming bigrams of CJK terms.

#Microsoft.Azure.Search.ClassicSimilarity

#Microsoft.Azure.Search.ClassicTokenizer

A URI fragment specifying the type of tokenizer.

integer

The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters.

string

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.

#Microsoft.Azure.Search.CommonGramTokenFilter

A URI fragment specifying the type of token filter.

string[]

The set of common words.

boolean

A value indicating whether common words matching will be case insensitive. Default is false.

string

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.

boolean

A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false.

string[]

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).

integer

The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes.

#Microsoft.Azure.Search.CustomAnalyzer

A URI fragment specifying the type of analyzer.

CharFilterName[]

A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed.

string

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.

TokenFilterName[]

A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed.

LexicalTokenizerName

The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words.

#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter

A URI fragment specifying the type of token filter.

integer

The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300.

integer

The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300.

integer

The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300.

string

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.

boolean

A value indicating whether to add only the longest matching subword to the output. Default is false.

string[]

The list of words to match against.

number

A multiplier for the raw score. Must be a positive number not equal to 1.0.

DistanceScoringParameters

Parameter values for the distance scoring function.

string

The name of the field used as input to the scoring function.

ScoringFunctionInterpolation

A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

distance

Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.

number

The distance in kilometers from the reference location where the boosting range ends.

string

The name of the parameter passed in search queries to specify the reference location.

#Microsoft.Azure.Search.EdgeNGramTokenFilter

A URI fragment specifying the type of token filter.

integer

The maximum n-gram length. Default is 2.

integer

The minimum n-gram length. Default is 1. Must be less than the value of maxGram.

string

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.

EdgeNGramTokenFilterSide

Specifies which side of the input the n-gram should be generated from. Default is "front".

string

Specifies that the n-gram should be generated from the back of the input.

string

Specifies that the n-gram should be generated from the front of the input.

#Microsoft.Azure.Search.EdgeNGramTokenFilterV2

A URI fragment specifying the type of token filter.

integer

The maximum n-gram length. Default is 2. Maximum is 300.

integer

The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.

string

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.

EdgeNGramTokenFilterSide

Specifies which side of the input the n-gram should be generated from. Default is "front".

#Microsoft.Azure.Search.EdgeNGramTokenizer

A URI fragment specifying the type of tokenizer.

integer

The maximum n-gram length. Default is 2. Maximum is 300.

integer

The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.

string

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.

TokenCharacterKind[]

Character classes to keep in the tokens.

#Microsoft.Azure.Search.ElisionTokenFilter

A URI fragment specifying the type of token filter.

string[]

The set of articles to remove.

string

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.

object

The additional info.

string

The additional info type.

ErrorAdditionalInfo[]

The error additional info.

string

The error code.

ErrorDetail[]

The error details.

string

The error message.

string

The error target.

ErrorDetail

The error object.

VectorSearchAlgorithmMetric

The similarity metric to use for vector comparisons.

ExhaustiveKnnParameters

Contains the parameters specific to exhaustive KNN algorithm.

exhaustiveKnn

The name of the kind of algorithm being configured for use with vector search.

string

The name to associate with this particular configuration.

number

A multiplier for the raw score. Must be a positive number not equal to 1.0.

string

The name of the field used as input to the scoring function.

FreshnessScoringParameters

Parameter values for the freshness scoring function.

ScoringFunctionInterpolation

A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

freshness

Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.

string

The expiration period after which boosting will stop for a particular document.

integer

The size of the dynamic list containing the nearest neighbors, which is used during index time. Increasing this parameter may improve index quality, at the expense of increased indexing time. At a certain point, increasing this parameter leads to diminishing returns.

integer

The size of the dynamic list containing the nearest neighbors, which is used during search time. Increasing this parameter may improve search results, at the expense of slower search. At a certain point, increasing this parameter leads to diminishing returns.

integer

The number of bi-directional links created for every new element during construction. Increasing this parameter value may improve recall and reduce retrieval times for datasets with high intrinsic dimensionality at the expense of increased memory consumption and longer indexing time.

VectorSearchAlgorithmMetric

The similarity metric to use for vector comparisons.

HnswParameters

Contains the parameters specific to HNSW algorithm.

hnsw

The name of the kind of algorithm being configured for use with vector search.

string

The name to associate with this particular configuration.

InputFieldMappingEntry[]

The recursive inputs used when creating a complex type.

string

The name of the input.

string

The source of the input.

string

The source context used for selecting recursive inputs.

#Microsoft.Azure.Search.KeepTokenFilter

A URI fragment specifying the type of token filter.

string[]

The list of words to keep.

boolean

A value indicating whether to lower case all words first. Default is false.

string

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.

#Microsoft.Azure.Search.KeywordMarkerTokenFilter

A URI fragment specifying the type of token filter.

boolean

A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false.

string[]

A list of words to mark as keywords.

string

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.

#Microsoft.Azure.Search.KeywordTokenizer

A URI fragment specifying the type of tokenizer.

integer

The read buffer size in bytes. Default is 256.

string

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.

#Microsoft.Azure.Search.KeywordTokenizerV2

A URI fragment specifying the type of tokenizer.

integer

The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters.

string

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.

#Microsoft.Azure.Search.LengthTokenFilter

A URI fragment specifying the type of token filter.

integer

The maximum length in characters. Default and maximum is 300.

integer

The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max.

string

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.

string

Lucene analyzer for Arabic.

string

Microsoft analyzer for Arabic.

string

Lucene analyzer for Bulgarian.

string

Microsoft analyzer for Bulgarian.

string

Microsoft analyzer for Bangla.

string

Lucene analyzer for Catalan.

string

Microsoft analyzer for Catalan.

string

Lucene analyzer for Czech.

string

Microsoft analyzer for Czech.

string

Lucene analyzer for Danish.

string

Microsoft analyzer for Danish.

string

Lucene analyzer for German.

string

Microsoft analyzer for German.

string

Lucene analyzer for Greek.

string

Microsoft analyzer for Greek.

string

Lucene analyzer for English.

string

Microsoft analyzer for English.

string

Lucene analyzer for Spanish.

string

Microsoft analyzer for Spanish.

string

Microsoft analyzer for Estonian.

string

Lucene analyzer for Basque.

string

Lucene analyzer for Persian.

string

Lucene analyzer for Finnish.

string

Microsoft analyzer for Finnish.

string

Lucene analyzer for French.

string

Microsoft analyzer for French.

string

Lucene analyzer for Irish.

string

Lucene analyzer for Galician.

string

Microsoft analyzer for Gujarati.

string

Microsoft analyzer for Hebrew.

string

Lucene analyzer for Hindi.

string

Microsoft analyzer for Hindi.

string

Microsoft analyzer for Croatian.

string

Lucene analyzer for Hungarian.

string

Microsoft analyzer for Hungarian.

string

Lucene analyzer for Armenian.

string

Lucene analyzer for Indonesian.

string

Microsoft analyzer for Indonesian (Bahasa).

string

Microsoft analyzer for Icelandic.

string

Lucene analyzer for Italian.

string

Microsoft analyzer for Italian.

string

Lucene analyzer for Japanese.

string

Microsoft analyzer for Japanese.

string

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

string

Microsoft analyzer for Kannada.

string

Lucene analyzer for Korean.

string

Microsoft analyzer for Korean.

string

Microsoft analyzer for Lithuanian.

string

Lucene analyzer for Latvian.

string

Microsoft analyzer for Latvian.

string

Microsoft analyzer for Malayalam.

string

Microsoft analyzer for Marathi.

string

Microsoft analyzer for Malay (Latin).

string

Microsoft analyzer for Norwegian (Bokmål).

string

Lucene analyzer for Dutch.

string

Microsoft analyzer for Dutch.

string

Lucene analyzer for Norwegian.

string

Microsoft analyzer for Punjabi.

string

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

string

Lucene analyzer for Polish.

string

Microsoft analyzer for Polish.

string

Lucene analyzer for Portuguese (Brazil).

string

Microsoft analyzer for Portuguese (Brazil).

string

Lucene analyzer for Portuguese (Portugal).

string

Microsoft analyzer for Portuguese (Portugal).

string

Lucene analyzer for Romanian.

string

Microsoft analyzer for Romanian.

string

Lucene analyzer for Russian.

string

Microsoft analyzer for Russian.

string

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

string

Microsoft analyzer for Slovak.

string

Microsoft analyzer for Slovenian.

string

Microsoft analyzer for Serbian (Cyrillic).

string

Microsoft analyzer for Serbian (Latin).

string

Standard Lucene analyzer.

string

Standard ASCII Folding Lucene analyzer. See https://zcusa.951200.xyz/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers

string

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

string

Lucene analyzer for Swedish.

string

Microsoft analyzer for Swedish.

string

Microsoft analyzer for Tamil.

string

Microsoft analyzer for Telugu.

string

Lucene analyzer for Thai.

string

Microsoft analyzer for Thai.

string

Lucene analyzer for Turkish.

string

Microsoft analyzer for Turkish.

string

Microsoft analyzer for Ukrainian.

string

Microsoft analyzer for Urdu.

string

Microsoft analyzer for Vietnamese.

string

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

string

Lucene analyzer for Chinese (Simplified).

string

Microsoft analyzer for Chinese (Simplified).

string

Lucene analyzer for Chinese (Traditional).

string

Microsoft analyzer for Chinese (Traditional).

string

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

string

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

string

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

string

Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html

string

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

string

Divides text using language-specific rules and reduces words to their base forms.

string

Divides text using language-specific rules.

string

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

string

Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html

string

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

string

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

string

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

string

Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html

#Microsoft.Azure.Search.LimitTokenFilter

A URI fragment specifying the type of token filter.

boolean

A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false.

integer

The maximum number of tokens to produce. Default is 1.

string

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.

#Microsoft.Azure.Search.StandardAnalyzer

A URI fragment specifying the type of analyzer.

integer

The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters.

string

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.

string[]

A list of stopwords.

#Microsoft.Azure.Search.StandardTokenizer

A URI fragment specifying the type of tokenizer.

integer

The maximum token length. Default is 255. Tokens longer than the maximum length are split.

string

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.

#Microsoft.Azure.Search.StandardTokenizerV2

A URI fragment specifying the type of tokenizer.

integer

The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters.

string

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.

number

A multiplier for the raw score. Must be a positive number not equal to 1.0.

string

The name of the field used as input to the scoring function.

ScoringFunctionInterpolation

A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

MagnitudeScoringParameters

Parameter values for the magnitude scoring function.

magnitude

Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.

number

The field value at which boosting ends.

number

The field value at which boosting starts.

boolean

A value indicating whether to apply a constant boost for field values beyond the range end value; default is false.

#Microsoft.Azure.Search.MappingCharFilter

A URI fragment specifying the type of char filter.

string[]

A list of mappings of the following format: "a=>b" (all occurrences of the character "a" will be replaced with character "b").

string

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.

#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer

A URI fragment specifying the type of tokenizer.

boolean

A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false.

MicrosoftStemmingTokenizerLanguage

The language to use. The default is English.

integer

The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255.

string

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.

#Microsoft.Azure.Search.MicrosoftLanguageTokenizer

A URI fragment specifying the type of tokenizer.

boolean

A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false.

MicrosoftTokenizerLanguage

The language to use. The default is English.

integer

The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255.

string

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.

string

Selects the Microsoft stemming tokenizer for Arabic.

string

Selects the Microsoft stemming tokenizer for Bangla.

string

Selects the Microsoft stemming tokenizer for Bulgarian.

string

Selects the Microsoft stemming tokenizer for Catalan.

string

Selects the Microsoft stemming tokenizer for Croatian.

string

Selects the Microsoft stemming tokenizer for Czech.

string

Selects the Microsoft stemming tokenizer for Danish.

string

Selects the Microsoft stemming tokenizer for Dutch.

string

Selects the Microsoft stemming tokenizer for English.

string

Selects the Microsoft stemming tokenizer for Estonian.

string

Selects the Microsoft stemming tokenizer for Finnish.

string

Selects the Microsoft stemming tokenizer for French.

string

Selects the Microsoft stemming tokenizer for German.

string

Selects the Microsoft stemming tokenizer for Greek.

string

Selects the Microsoft stemming tokenizer for Gujarati.

string

Selects the Microsoft stemming tokenizer for Hebrew.

string

Selects the Microsoft stemming tokenizer for Hindi.

string

Selects the Microsoft stemming tokenizer for Hungarian.

string

Selects the Microsoft stemming tokenizer for Icelandic.

string

Selects the Microsoft stemming tokenizer for Indonesian.

string

Selects the Microsoft stemming tokenizer for Italian.

string

Selects the Microsoft stemming tokenizer for Kannada.

string

Selects the Microsoft stemming tokenizer for Latvian.

string

Selects the Microsoft stemming tokenizer for Lithuanian.

string

Selects the Microsoft stemming tokenizer for Malay.

string

Selects the Microsoft stemming tokenizer for Malayalam.

string

Selects the Microsoft stemming tokenizer for Marathi.

string

Selects the Microsoft stemming tokenizer for Norwegian (Bokmål).

string

Selects the Microsoft stemming tokenizer for Polish.

string

Selects the Microsoft stemming tokenizer for Portuguese.

string

Selects the Microsoft stemming tokenizer for Portuguese (Brazil).

string

Selects the Microsoft stemming tokenizer for Punjabi.

string

Selects the Microsoft stemming tokenizer for Romanian.

string

Selects the Microsoft stemming tokenizer for Russian.

string

Selects the Microsoft stemming tokenizer for Serbian (Cyrillic).

string

Selects the Microsoft stemming tokenizer for Serbian (Latin).

string

Selects the Microsoft stemming tokenizer for Slovak.

string

Selects the Microsoft stemming tokenizer for Slovenian.

string

Selects the Microsoft stemming tokenizer for Spanish.

string

Selects the Microsoft stemming tokenizer for Swedish.

string

Selects the Microsoft stemming tokenizer for Tamil.

string

Selects the Microsoft stemming tokenizer for Telugu.

string

Selects the Microsoft stemming tokenizer for Turkish.

string

Selects the Microsoft stemming tokenizer for Ukrainian.

string

Selects the Microsoft stemming tokenizer for Urdu.

string

Selects the Microsoft tokenizer for Bangla.

string

Selects the Microsoft tokenizer for Bulgarian.

string

Selects the Microsoft tokenizer for Catalan.

string

Selects the Microsoft tokenizer for Chinese (Simplified).

string

Selects the Microsoft tokenizer for Chinese (Traditional).

string

Selects the Microsoft tokenizer for Croatian.

string

Selects the Microsoft tokenizer for Czech.

string

Selects the Microsoft tokenizer for Danish.

string

Selects the Microsoft tokenizer for Dutch.

string

Selects the Microsoft tokenizer for English.

string

Selects the Microsoft tokenizer for French.

string

Selects the Microsoft tokenizer for German.

string

Selects the Microsoft tokenizer for Greek.

string

Selects the Microsoft tokenizer for Gujarati.

string

Selects the Microsoft tokenizer for Hindi.

string

Selects the Microsoft tokenizer for Icelandic.

string

Selects the Microsoft tokenizer for Indonesian.

string

Selects the Microsoft tokenizer for Italian.

string

Selects the Microsoft tokenizer for Japanese.

string

Selects the Microsoft tokenizer for Kannada.

string

Selects the Microsoft tokenizer for Korean.

string

Selects the Microsoft tokenizer for Malay.

string

Selects the Microsoft tokenizer for Malayalam.

string

Selects the Microsoft tokenizer for Marathi.

string

Selects the Microsoft tokenizer for Norwegian (Bokmål).

string

Selects the Microsoft tokenizer for Polish.

string

Selects the Microsoft tokenizer for Portuguese.

string

Selects the Microsoft tokenizer for Portuguese (Brazil).

string

Selects the Microsoft tokenizer for Punjabi.

string

Selects the Microsoft tokenizer for Romanian.

string

Selects the Microsoft tokenizer for Russian.

string

Selects the Microsoft tokenizer for Serbian (Cyrillic).

string

Selects the Microsoft tokenizer for Serbian (Latin).

string

Selects the Microsoft tokenizer for Slovenian.

string

Selects the Microsoft tokenizer for Spanish.

string

Selects the Microsoft tokenizer for Swedish.

string

Selects the Microsoft tokenizer for Tamil.

string

Selects the Microsoft tokenizer for Telugu.

string

Selects the Microsoft tokenizer for Thai.

string

Selects the Microsoft tokenizer for Ukrainian.

string

Selects the Microsoft tokenizer for Urdu.

string

Selects the Microsoft tokenizer for Vietnamese.

#Microsoft.Azure.Search.NGramTokenFilter

A URI fragment specifying the type of token filter.

integer

The maximum n-gram length. Default is 2.

integer

The minimum n-gram length. Default is 1. Must be less than the value of maxGram.

string

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.

#Microsoft.Azure.Search.NGramTokenFilterV2

A URI fragment specifying the type of token filter.

integer

The maximum n-gram length. Default is 2. Maximum is 300.

integer

The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.

string

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.

#Microsoft.Azure.Search.NGramTokenizer

A URI fragment specifying the type of tokenizer.

integer

The maximum n-gram length. Default is 2. Maximum is 300.

integer

The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram.

string

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.

TokenCharacterKind[]

Character classes to keep in the tokens.

string

The name of the output defined by the skill.

string

The target name of the output. It is optional and default to name.

#Microsoft.Azure.Search.PathHierarchyTokenizerV2

A URI fragment specifying the type of tokenizer.

string

The delimiter character to use. Default is "/".

integer

The maximum token length. Default and maximum is 300.

string

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.

string

A value that, if set, replaces the delimiter character. Default is "/".

boolean

A value indicating whether to generate tokens in reverse order. Default is false.

integer

The number of initial tokens to skip. Default is 0.

#Microsoft.Azure.Search.PatternAnalyzer

A URI fragment specifying the type of analyzer.

RegexFlags

Regular expression flags.

boolean

A value indicating whether terms should be lower-cased. Default is true.

string

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.

string

A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.

string[]

A list of stopwords.

#Microsoft.Azure.Search.PatternCaptureTokenFilter

A URI fragment specifying the type of token filter.

string

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.

string[]

A list of patterns to match against each token.

boolean

A value indicating whether to return the original token even if one of the patterns matches. Default is true.

#Microsoft.Azure.Search.PatternReplaceCharFilter

A URI fragment specifying the type of char filter.

string

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.

string

A regular expression pattern.

string

The replacement text.

#Microsoft.Azure.Search.PatternReplaceTokenFilter

A URI fragment specifying the type of token filter.

string

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.

string

A regular expression pattern.

string

The replacement text.

#Microsoft.Azure.Search.PatternTokenizer

A URI fragment specifying the type of tokenizer.

RegexFlags

Regular expression flags.

integer

The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1.

string

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.

string

A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters.

string

Encodes a token into a Beider-Morse value.

string

Encodes a token into a Caverphone 1.0 value.

string

Encodes a token into a Caverphone 2.0 value.

string

Encodes a token into a Cologne Phonetic value.

string

Encodes a token into a double metaphone value.

string

Encodes a token using the Haase refinement of the Kölner Phonetik algorithm.

string

Encodes a token using the Kölner Phonetik algorithm.

string

Encodes a token into a Metaphone value.

string

Encodes a token into a NYSIIS value.

string

Encodes a token into a Refined Soundex value.

string

Encodes a token into a Soundex value.

#Microsoft.Azure.Search.PhoneticTokenFilter

A URI fragment specifying the type of token filter.

PhoneticEncoder

The phonetic encoder to use. Default is "metaphone".

string

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.

boolean

A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true.

SemanticField[]

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.

SemanticField[]

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.

SemanticField

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.

string

Enables canonical equivalence.

string

Enables case-insensitive matching.

string

Permits whitespace and comments in the pattern.

string

Enables dotall mode.

string

Enables literal parsing of the pattern.

string

Enables multiline mode.

string

Enables Unicode-aware case folding.

string

Enables Unix lines mode.

VectorSearchCompressionTargetDataType

The quantized data type of compressed vector values.

number

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.

scalarQuantization

The name of the kind of compression method being configured for use with vector search.

string

The name to associate with this particular configuration.

boolean

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.

ScalarQuantizationParameters

Contains the parameters specific to Scalar Quantization.

string

Boost scores by the average of all scoring function results.

string

Boost scores using the first applicable scoring function in the scoring profile.

string

Boost scores by the maximum of all scoring function results.

string

Boost scores by the minimum of all scoring function results.

string

Boost scores by the sum of all scoring function results.

string

Boosts scores by a constant factor.

string

Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions.

string

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.

string

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.

ScoringFunctionAggregation

A value indicating how the results of individual scoring functions should be combined. Defaults to "Sum". Ignored if there are no scoring functions.

• DistanceScoringFunction[]
• FreshnessScoringFunction[]
• MagnitudeScoringFunction[]
• TagScoringFunction[]

The collection of functions that influence the scoring of documents.

string

The name of the scoring profile.

TextWeights

Parameters that boost scoring based on text matches in certain index fields.

LexicalAnalyzerName

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.

integer

The dimensionality of the vector field.

boolean

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.

SearchField[]

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.

boolean

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.

LexicalAnalyzerName

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.

boolean

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.

string

The name of the field, which must be unique within the fields collection of the index or parent field.

boolean

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.

LexicalAnalyzerName

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.

boolean

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.

boolean

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.

boolean

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.

string[]

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.

SearchFieldDataType

The data type of the field.

VectorEncodingFormat

The encoding format to interpret the field contents.

string

The name of the vector search profile that specifies the algorithm and vectorizer to use when searching the vector field.

string

Indicates that a field contains a Boolean value (true or false).

string

Indicates that a field contains a 8-bit unsigned integer. This is only valid when used with Collection(Edm.Byte).

string

Indicates that a field contains one or more complex objects that in turn have sub-fields of other types.

string

Indicates that a field contains a date/time value, including timezone information.

string

Indicates that a field contains an IEEE double-precision floating point number.

string

Indicates that a field contains a geo-location in terms of longitude and latitude.

string

Indicates that a field contains a half-precision floating point number. This is only valid when used with Collection(Edm.Half).

string

Indicates that a field contains a 16-bit signed integer. This is only valid when used with Collection(Edm.Int16).

string

Indicates that a field contains a 32-bit signed integer.

string

Indicates that a field contains a 64-bit signed integer.

string

Indicates that a field contains a 8-bit signed integer. This is only valid when used with Collection(Edm.SByte).

string

Indicates that a field contains a single-precision floating point number. This is only valid when used with Collection(Edm.Single).

string

Indicates that a field contains a string.

string

The ETag of the index.

• CustomAnalyzer[]
• LuceneStandardAnalyzer[]
• PatternAnalyzer[]
• StopAnalyzer[]

The analyzers for the index.

• MappingCharFilter[]
• PatternReplaceCharFilter[]

The character filters for the index.

CorsOptions

Options to control Cross-Origin Resource Sharing (CORS) for the index.

string

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.

SearchResourceEncryptionKey

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.

SearchField[]

The fields of the index.

string

The name of the index.

ScoringProfile[]

The scoring profiles for the index.

SemanticSettings

Defines parameters for a search index that influence semantic capabilities.

• BM25Similarity
• ClassicSimilarity

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.

Suggester[]

The suggesters for the index.

• AsciiFoldingTokenFilter[]
• CjkBigramTokenFilter[]
• CommonGramTokenFilter[]
• DictionaryDecompounderTokenFilter[]
• EdgeNGramTokenFilter[]
• EdgeNGramTokenFilterV2[]
• ElisionTokenFilter[]
• KeepTokenFilter[]
• KeywordMarkerTokenFilter[]
• LengthTokenFilter[]
• LimitTokenFilter[]
• NGramTokenFilter[]
• NGramTokenFilterV2[]
• PatternCaptureTokenFilter[]
• PatternReplaceTokenFilter[]
• PhoneticTokenFilter[]
• ShingleTokenFilter[]
• SnowballTokenFilter[]
• StemmerOverrideTokenFilter[]
• StemmerTokenFilter[]
• StopwordsTokenFilter[]
• SynonymTokenFilter[]
• TruncateTokenFilter[]
• UniqueTokenFilter[]
• WordDelimiterTokenFilter[]

The token filters for the index.

• ClassicTokenizer[]
• EdgeNGramTokenizer[]
• KeywordTokenizer[]
• KeywordTokenizerV2[]
• LuceneStandardTokenizer[]
• LuceneStandardTokenizerV2[]
• MicrosoftLanguageStemmingTokenizer[]
• MicrosoftLanguageTokenizer[]
• NGramTokenizer[]
• PathHierarchyTokenizerV2[]
• PatternTokenizer[]
• UaxUrlEmailTokenizer[]

The tokenizers for the index.

VectorSearch

Contains configuration options related to vector search.

#Microsoft.Azure.Search.DataNoneIdentity

A URI fragment specifying the type of identity.

#Microsoft.Azure.Search.DataUserAssignedIdentity

A URI fragment specifying the type of identity.

string

The fully qualified Azure resource Id of a user assigned managed identity typically in the form "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" that should have been assigned to the search service.

AzureActiveDirectoryApplicationCredentials

Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.

string

The name of your Azure Key Vault key to be used to encrypt your data at rest.

string

The version of your Azure Key Vault key to be used to encrypt your data at rest.

string

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.

string

The name of the semantic configuration.

PrioritizedFields

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.

string

SemanticConfiguration[]

The semantic configurations for the index.

string

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.

#Microsoft.Azure.Search.ShingleTokenFilter

A URI fragment specifying the type of token filter.

string

The string to insert for each position at which there is no token. Default is an underscore ("_").

integer

The maximum shingle size. Default and minimum value is 2.

integer

The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize.

string

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.

boolean

A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true.

boolean

A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false.

string

The string to use when joining adjacent tokens to form a shingle. Default is a single space (" ").

#Microsoft.Azure.Search.SnowballTokenFilter

A URI fragment specifying the type of token filter.

SnowballTokenFilterLanguage

The language to use.

string

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.

string

Selects the Lucene Snowball stemming tokenizer for Armenian.

string

Selects the Lucene Snowball stemming tokenizer for Basque.

string

Selects the Lucene Snowball stemming tokenizer for Catalan.

string

Selects the Lucene Snowball stemming tokenizer for Danish.

string

Selects the Lucene Snowball stemming tokenizer for Dutch.

string

Selects the Lucene Snowball stemming tokenizer for English.

string

Selects the Lucene Snowball stemming tokenizer for Finnish.

string

Selects the Lucene Snowball stemming tokenizer for French.

string

Selects the Lucene Snowball stemming tokenizer for German.

string

Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm.

string

Selects the Lucene Snowball stemming tokenizer for Hungarian.

string

Selects the Lucene Snowball stemming tokenizer for Italian.

string

Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm.

string

Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm.

string

Selects the Lucene Snowball stemming tokenizer for Norwegian.

string

Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm.

string

Selects the Lucene Snowball stemming tokenizer for Portuguese.

string

Selects the Lucene Snowball stemming tokenizer for Romanian.

string

Selects the Lucene Snowball stemming tokenizer for Russian.

string

Selects the Lucene Snowball stemming tokenizer for Spanish.

string

Selects the Lucene Snowball stemming tokenizer for Swedish.

string

Selects the Lucene Snowball stemming tokenizer for Turkish.

#Microsoft.Azure.Search.StemmerOverrideTokenFilter

A URI fragment specifying the type of token filter.

string

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.

string[]

A list of stemming rules in the following format: "word => stem", for example: "ran => run".

#Microsoft.Azure.Search.StemmerTokenFilter

A URI fragment specifying the type of token filter.

StemmerTokenFilterLanguage

The language to use.

string

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.

string

Selects the Lucene stemming tokenizer for Arabic.

string

Selects the Lucene stemming tokenizer for Armenian.

string

Selects the Lucene stemming tokenizer for Basque.

string

Selects the Lucene stemming tokenizer for Portuguese (Brazil).

string

Selects the Lucene stemming tokenizer for Bulgarian.

string

Selects the Lucene stemming tokenizer for Catalan.

string

Selects the Lucene stemming tokenizer for Czech.

string

Selects the Lucene stemming tokenizer for Danish.

string

Selects the Lucene stemming tokenizer for Dutch.

string

Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm.

string

Selects the Lucene stemming tokenizer for English.

string

Selects the Lucene stemming tokenizer for Finnish.

string

Selects the Lucene stemming tokenizer for French.

string

Selects the Lucene stemming tokenizer for Galician.

string

Selects the Lucene stemming tokenizer for German.

string

Selects the Lucene stemming tokenizer that uses the German variant algorithm.

string

Selects the Lucene stemming tokenizer for Greek.

string

Selects the Lucene stemming tokenizer for Hindi.

string

Selects the Lucene stemming tokenizer for Hungarian.

string

Selects the Lucene stemming tokenizer for Indonesian.

string

Selects the Lucene stemming tokenizer for Irish.

string

Selects the Lucene stemming tokenizer for Italian.

string

Selects the Lucene stemming tokenizer for Latvian.

string

Selects the Lucene stemming tokenizer for English that does light stemming.

string

Selects the Lucene stemming tokenizer for Finnish that does light stemming.

string

Selects the Lucene stemming tokenizer for French that does light stemming.

string

Selects the Lucene stemming tokenizer for German that does light stemming.

string

Selects the Lucene stemming tokenizer for Hungarian that does light stemming.

string

Selects the Lucene stemming tokenizer for Italian that does light stemming.

string

Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming.

string

Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming.

string

Selects the Lucene stemming tokenizer for Portuguese that does light stemming.

string

Selects the Lucene stemming tokenizer for Russian that does light stemming.

string

Selects the Lucene stemming tokenizer for Spanish that does light stemming.

string

Selects the Lucene stemming tokenizer for Swedish that does light stemming.

string

Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm.

string

Selects the Lucene stemming tokenizer for English that does minimal stemming.

string

Selects the Lucene stemming tokenizer for French that does minimal stemming.

string

Selects the Lucene stemming tokenizer for Galician that does minimal stemming.

string

Selects the Lucene stemming tokenizer for German that does minimal stemming.

string

Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming.

string

Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming.

string

Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming.

string

Selects the Lucene stemming tokenizer for Norwegian (Bokmål).

string

Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm.

string

Selects the Lucene stemming tokenizer for Portuguese.

string

Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm.

string

Selects the Lucene stemming tokenizer for English that removes trailing possessives from words.

string

Selects the Lucene stemming tokenizer for Romanian.

string

Selects the Lucene stemming tokenizer for Russian.

string

Selects the Lucene stemming tokenizer for Sorani.

string

Selects the Lucene stemming tokenizer for Spanish.

string

Selects the Lucene stemming tokenizer for Swedish.

string

Selects the Lucene stemming tokenizer for Turkish.

#Microsoft.Azure.Search.StopAnalyzer

A URI fragment specifying the type of analyzer.

string

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.

string[]

A list of stopwords.

string

Selects the stopword list for Arabic.

string

Selects the stopword list for Armenian.

string

Selects the stopword list for Basque.

string

Selects the stopword list for Portuguese (Brazil).

string

Selects the stopword list for Bulgarian.

string

Selects the stopword list for Catalan.

string

Selects the stopword list for Czech.

string

Selects the stopword list for Danish.

string

Selects the stopword list for Dutch.

string

Selects the stopword list for English.

string

Selects the stopword list for Finnish.

string

Selects the stopword list for French.

string

Selects the stopword list for Galician.

string

Selects the stopword list for German.

string

Selects the stopword list for Greek.

string

Selects the stopword list for Hindi.

string

Selects the stopword list for Hungarian.

string

Selects the stopword list for Indonesian.

string

Selects the stopword list for Irish.

string

Selects the stopword list for Italian.

string

Selects the stopword list for Latvian.

string

Selects the stopword list for Norwegian.

string

Selects the stopword list for Persian.

string

Selects the stopword list for Portuguese.

string

Selects the stopword list for Romanian.

string

Selects the stopword list for Russian.

string

Selects the stopword list for Sorani.

string

Selects the stopword list for Spanish.

string

Selects the stopword list for Swedish.

string

Selects the stopword list for Thai.

string

Selects the stopword list for Turkish.

#Microsoft.Azure.Search.StopwordsTokenFilter

A URI fragment specifying the type of token filter.

boolean

A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false.

string

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.

boolean

A value indicating whether to ignore the last search term if it's a stop word. Default is true.

string[]

The list of stopwords. This property and the stopwords list property cannot both be set.

StopwordsList

A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English.

string

The name of the suggester.

SuggesterSearchMode

A value indicating the capabilities of the suggester.

string[]

The list of field names to which the suggester applies. Each field must be searchable.

string

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.

#Microsoft.Azure.Search.SynonymTokenFilter

A URI fragment specifying the type of token filter.

boolean

A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true.

boolean

A value indicating whether to case-fold input for matching. Default is false.

string

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.

string[]

A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted.

number

A multiplier for the raw score. Must be a positive number not equal to 1.0.

string

The name of the field used as input to the scoring function.

ScoringFunctionInterpolation

A value indicating how boosting will be interpolated across document scores; defaults to "Linear".

TagScoringParameters

Parameter values for the tag scoring function.

tag

Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case.

string

The name of the parameter passed in search queries to specify the list of tags to compare against the target field.

object

The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field.

string

Keeps digits in tokens.

string

Keeps letters in tokens.

string

Keeps punctuation in tokens.

string

Keeps symbols in tokens.

string

Keeps whitespace in tokens.

string

Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html

string

A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html

string

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

string

Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html

string

Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html

string

Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html

string

Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html

string

Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html

string

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

string

Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html

string

Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html

string

Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html

string

Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html

string

A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html

string

Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html

string

Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html

string

Normalizes token text to lower case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html

string

Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html

string

Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html

string

Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html

string

Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer

string

Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html

string

Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html

string

Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html

string

Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html

string

A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html

string

Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html

string

Language specific stemming filter. See https://zcusa.951200.xyz/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters

string

Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html

string

Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html

string

Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html

string

Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html

string

Normalizes token text to upper case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html

string

Splits words into subwords and performs optional transformations on subword groups.

#Microsoft.Azure.Search.TruncateTokenFilter

A URI fragment specifying the type of token filter.

integer

The length at which terms will be truncated. Default and maximum is 300.

string

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.

#Microsoft.Azure.Search.UaxUrlEmailTokenizer

A URI fragment specifying the type of tokenizer.

integer

The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters.

string

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.

#Microsoft.Azure.Search.UniqueTokenFilter

A URI fragment specifying the type of token filter.

string

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.

boolean

A value indicating whether to remove duplicates only at the same position. Default is false.

string

Encoding format representing bits packed into a wider data type.

• ExhaustiveKnnVectorSearchAlgorithmConfiguration[]
• HnswVectorSearchAlgorithmConfiguration[]

Contains configuration options specific to the algorithm used during indexing or querying.

• BinaryQuantizationVectorSearchCompressionConfiguration[]
• ScalarQuantizationVectorSearchCompressionConfiguration[]

Contains configuration options specific to the compression method used during indexing or querying.

VectorSearchProfile[]

Defines combinations of configurations to use with vector search.

• AzureOpenAIVectorizer[]
• WebApiVectorizer[]

Contains configuration options on how to vectorize text vector queries.

string

Exhaustive KNN algorithm which will perform brute-force search.

string

HNSW (Hierarchical Navigable Small World), a type of approximate nearest neighbors algorithm.

string

Measures the angle between vectors to quantify their similarity, disregarding magnitude. The smaller the angle, the closer the similarity.

string

Calculates the sum of element-wise products to gauge alignment and magnitude similarity. The larger and more positive, the closer the similarity.

string

Computes the straight-line distance between vectors in a multi-dimensional space. The smaller the distance, the closer the similarity.

string

Only applicable to bit-packed binary data types. Determines dissimilarity by counting differing positions in binary vectors. The fewer differences, the closer the similarity.

string

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.

string

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.

string

string

The name of the vector search algorithm configuration that specifies the algorithm and optional parameters.

string

The name of the compression method configuration that specifies the compression method and optional parameters.

string

The name to associate with this particular vector search profile.

string

The name of the vectorization being configured for use with vector search.

string

Generate embeddings using an Azure OpenAI resource at query time.

string

Generate embeddings using a custom web endpoint at query time.

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

The user-assigned managed identity used for outbound connections. If an authResourceId is provided 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.

string

Applies to custom endpoints that connect to external code in an Azure function or some other application that provides the transformations. This value should be the application ID created for the function or app when it was registered with Azure Active Directory. When specified, the vectorization connects to the function or app using a managed ID (either system or user-assigned) of the search service and the access token of the function or app, using this value as the resource id for creating the scope of the access token.

object

The headers required to make the HTTP request.

string

The method for the HTTP request.

string

The desired timeout for the request. Default is 30 seconds.

string

The URI of the Web API providing the vectorizer.

WebApiParameters

Specifies the properties of the user-defined vectorizer.

customWebApi

The name of the kind of vectorization method being configured for use with vector search.

string

The name to associate with this particular vectorization method.

#Microsoft.Azure.Search.WordDelimiterTokenFilter

A URI fragment specifying the type of token filter.

boolean

A value indicating whether all subword parts will be catenated. For example, if this is set to true, "Azure-Search-1" becomes "AzureSearch1". Default is false.

boolean

A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, "1-2" becomes "12". Default is false.

boolean

A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, "Azure-Search" becomes "AzureSearch". Default is false.

boolean

A value indicating whether to generate number subwords. Default is true.

boolean

A value indicating whether to generate part words. If set, causes parts of words to be generated; for example "AzureSearch" becomes "Azure" "Search". Default is true.

string

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.

boolean

A value indicating whether original words will be preserved and added to the subword list. Default is false.

string[]

A list of tokens to protect from being delimited.

boolean

A value indicating whether to split words on caseChange. For example, if this is set to true, "AzureSearch" becomes "Azure" "Search". Default is true.

boolean

A value indicating whether to split on numbers. For example, if this is set to true, "Azure1Search" becomes "Azure" "1" "Search". Default is true.

boolean

A value indicating whether to remove trailing "'s" for each subword. Default is true.