@azure/search-documents package

A static-key-based credential that supports updating the underlying key value.

Represents a geographic point in global coordinates.

Class used to perform batch operations with multiple documents to the index.

Class used to perform operations against a search index, including querying documents in the index as well as adding, updating, and removing them.

Class to perform operations to manage (create, update, list/delete) indexes, & synonymmaps.

Class to perform operations to manage (create, update, list/delete) indexers, datasources & skillsets.

Class used to perform buffered operations against a search index, including adding, updating, and removing them.

Specifies some text and analysis components used to break that text into tokens.

The result of testing an analyzer on text.

Information about a token returned by an analyzer.

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. This token filter is implemented using Apache Lucene.

The result of Autocomplete requests.

Parameters for fuzzy matching, and other autocomplete query behaviors.

The result of Autocomplete query.

Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.

Allows you to generate a vector embedding for a given text input using the Azure OpenAI resource.

Contains the parameters specific to using an Azure Open AI service for vectorization at query time.

Contains the parameters specific to using an Azure Open AI service for vectorization at query time.

Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter).

Base type for character filters.

Base type for describing any Azure AI service resource attached to a skillset.

Base type for data change detection policies.

Base type for data deletion detection policies.

Base type for analyzers.

Base type for tokenizers.

Base type for functions that can modify document scores during ranking.

Abstract base type for data identities.

Base type for skills.

Parameters for filtering, sorting, faceting, paging, and other search query behaviors.

Base type for token filters.

The query parameters for vector and hybrid search queries.

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

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

Contains specific details for a vectorization method to be used during query time.

Contains configuration options specific to the binary quantization compression method used during indexing and querying.

Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.

Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries.

Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.

The multi-region account key of an Azure AI service resource that's attached to a skillset.

Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.

Represents a field in an index definition, which describes the name, data type, and search behavior of a field.

A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output.

Defines options to control Cross-Origin Resource Sharing (CORS) for an index.

Options for create/update index operation.

Options for create/update skillset operation.

Options for create/update synonymmap operation.

Options for create/update datasource operation.

Options for create/update indexer operation.

Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer.

An object that contains information about the matches that were found, and related metadata.

A complex object that can be used to specify alternative spellings or synonyms to the root entity name.

A skill looks for text from a custom, user-defined list of words and phrases.

An empty object that represents the default Azure AI service resource for a skillset.

Options for delete datasource operation.

Options for delete index operation.

Options for delete indexer operation.

Options for delete skillset operaion.

Options for delete synonymmap operation.

Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.

Defines a function that boosts scores based on distance from a geographic location.

Provides parameter values to a distance scoring function.

A skill that extracts content from a file within the enrichment pipeline.

Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.

Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.

Removes elisions. For example, "l'avion" (the plane) will be converted to "avion" (plane). This token filter is implemented using Apache Lucene.

Using the Text Analytics API, extracts linked entities from text.

Text analytics entity recognition.

Using the Text Analytics API, extracts entities of different types from text.

Contains the parameters specific to exhaustive KNN algorithm.

Extracts answer candidates from the contents of the documents returned in response to a query expressed as a question in natural language.

Extracts captions from the matching documents that contain passages relevant to the search query.

A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval.

Defines a mapping between a field in a data source and a target field in an index.

Represents a function that transforms a value from a data source before indexing.

Defines a function that boosts scores based on the value of a date-time field.

Provides parameter values to a freshness scoring function.

Options for retrieving a single document.

Defines a data change detection policy that captures changes based on the value of a high water mark column.

Contains the parameters specific to hnsw algorithm.

A skill that analyzes image files. It extracts a rich set of visual features based on the image content.

Index Documents Client

Options for the modify index batch operation.

Response containing the status of operations for all documents in the indexing request.

Represents the result of an individual indexer execution.

Represents parameters for indexer execution.

A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type.

Status of an indexing operation for a single document.

Represents a schedule for indexer execution.

Input field mapping for a skill.

A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.

A skill that uses text analytics for key phrase extraction.

Marks terms as keywords. This token filter is implemented using Apache Lucene.

Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.

A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis.

Removes words that are too long or too short. This token filter is implemented using Apache Lucene.

Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.

Arguments for retrieving the next page of search results.

Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.

Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.

Defines a function that boosts scores based on the magnitude of a numeric field.

Provides parameter values to a magnitude scoring function.

A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.

A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part.

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

Divides text using language-specific rules.

Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.

Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.

A skill that extracts text from image files.

Output field mapping for a skill.

Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.

Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.

Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.

Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.

A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This character filter is implemented using Apache Lucene.

A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the result would be "aa#bb aa#bb". This token filter is implemented using Apache Lucene.

Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.

Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.

An answer is a text passage extracted from the contents of the most relevant documents that matched the query. Answers are extracted from the top search results. Answer candidates are scored and the top answers are selected.

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.

Represents a resource's usage and quota.

Contains configuration options specific to the scalar quantization compression method used during indexing and querying.

Contains the parameters specific to Scalar Quantization.

Defines parameters for a search index that influence scoring in search queries.

Client options used to configure Cognitive Search API requests.

Response containing search page results from an index.

Response containing search results from an index.

Response containing search results from an index.

Represents a search index definition, which describes the fields and search behavior of an index.

Client options used to configure Cognitive Search API requests.

Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.

Represents an indexer.

Client options used to configure Cognitive Search API requests.

Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed.

Clears the identity property of a datasource.

Represents a datasource definition, which can be used to configure an indexer.

Specifies the identity for a datasource to use.

Represents an item- or document-level indexing error.

Definition of additional projections to secondary search indexes.

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.

Description for what data to store in the designated search index.

Definition of additional projections to azure blob, table, or files, of enriched data.

Abstract class to share properties between concrete selectors.

Projection definition for what data to store in Azure Files.

Projection definition for what data to store in Azure Blob.

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.

Container object for various projection selectors.

Abstract class to share properties between concrete selectors.

Description for what data to store in Azure Tables.

A list of skills.

Represents the current status and execution history of an indexer.

Represents an item-level warning.

Options for SearchIndexingBufferedSender.

A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps.

Response from a get service statistics request. If successful, it includes service level counters and limits.

Defines how the Suggest API should apply to a group of fields in the index.

Defines a specific configuration to be used in the context of semantic capabilities.

A field that is used as part of the semantic configuration.

Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers.

Defines parameters for a search index that influence semantic capabilities.

Defines options for semantic search queries

Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.

Using the Text Analytics API, evaluates unstructured text and for each record, provides sentiment labels (such as "negative", "neutral" and "positive") based on the highest confidence score found by the service at a sentence and document-level.

Represents service-level resource counters and quotas.

Represents various service level limits.

A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields).

Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.

Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.

Represents a field in an index definition, which describes the name, data type, and search behavior of a field.

A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.

Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.

A skill to split a string into chunks of text.

Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.

Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.

Language specific stemming filter. This token filter is implemented using Apache Lucene.

Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.

Removes stop words from a token stream. This token filter is implemented using Apache Lucene.

Response containing suggestion query results from an index.

Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.

Represents a synonym map definition.

Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.

Defines a function that boosts scores of documents with string values matching a given list of tags.

Provides parameter values to a tag scoring function.

A skill to translate text from one language to another.

Defines weights on index fields for which matches should boost scoring in search queries.

Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.

Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.

Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.

Contains configuration options related to vector search.

Defines options for vector search queries

Defines a combination of configurations to use with vector search.

The query parameters to use for vector search when a text value that needs to be vectorized is provided.

The query parameters to use for vector search when a raw vector value is provided.

Specifies the properties for connecting to a user-defined vectorizer.

A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.

Specifies a user-defined vectorizer for generating the vector embedding of a query string. Integration of an external vectorizer is achieved using the custom Web API interface of a skillset.

Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.

Options for analyze text operation.

Defines values for AutocompleteMode.

Options for retrieving completion text for a partial searchText.

Defines values for AzureOpenAIModelName.
KnownAzureOpenAIModelName can be used interchangeably with AzureOpenAIModelName, this enum contains the known values that the service supports.

Known values supported by the service

text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small

Contains the possible cases for CharFilter.

Defines values for CharFilterName.
<xref:KnownCharFilterName> can be used interchangeably with CharFilterName, this enum contains the known values that the service supports.

Known values supported by the service

html_strip: 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

Defines values for CjkBigramTokenFilterScripts.

Contains the possible cases for CognitiveServicesAccount.

Defines values for ComplexDataType. Possible values include: 'Edm.ComplexType', 'Collection(Edm.ComplexType)'

Options for performing the count operation on the index.

Options for create datasource operation.

Options for create index operation.

Options for create indexer operation.

Options for create skillset operation.

Options for create synonymmap operation.

Contains the possible cases for DataChangeDetectionPolicy.

Contains the possible cases for DataDeletionDetectionPolicy.

Options for the delete documents operation.

Defines values for EdgeNGramTokenFilterSide.

Contains configuration options specific to the exhaustive KNN algorithm used during querying, which will perform brute-force search across the entire vector index.

Options for get datasource operation.

Options for get index operation.

Options for get index statistics operation.

Options for get indexer operation.

Options for get indexer status operation.

Options for get service statistics operation.

Options for get skillset operation.

Options for get synonymmaps operation.

Contains configuration options specific to the hnsw approximate nearest neighbors algorithm used during indexing time.

Defines values for IndexActionType.

Represents an index action that operates on a document.

An iterator for listing the indexes that exist in the Search service. Will make requests as needed during iteration. Use .byPage() to make one request to the server per iteration.

An iterator for listing the indexes that exist in the Search service. Will make requests as needed during iteration. Use .byPage() to make one request to the server per iteration.

Defines values for IndexProjectionMode.
KnownIndexProjectionMode can be used interchangeably with IndexProjectionMode, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for IndexerExecutionStatus.

Defines values for IndexerStatus.

Contains the possible cases for Analyzer.

Defines values for LexicalAnalyzerName.
<xref:KnownLexicalAnalyzerName> can be used interchangeably with LexicalAnalyzerName, this enum contains the known values that the service supports.

Known values supported by the service

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

Contains the possible cases for Tokenizer.

Defines values for LexicalTokenizerName.
<xref:KnownLexicalTokenizerName> can be used interchangeably with LexicalTokenizerName, this enum contains the known values that the service supports.

Known values supported by the service

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

Options for a list data sources operation.

Options for a list indexers operation.

Options for a list indexes operation.

Options for a list skillsets operation.

Options for a list synonymMaps operation.

Options for the merge documents operation.

Options for the merge or upload documents operation.

Defines values for MicrosoftStemmingTokenizerLanguage.

Defines values for MicrosoftTokenizerLanguage.

Narrows the Model type to include only the selected Fields

Defines values for OcrLineEnding.
KnownOcrLineEnding can be used interchangeably with OcrLineEnding, this enum contains the known values that the service supports.

Known values supported by the service

space: Lines are separated by a single space character.
carriageReturn: Lines are separated by a carriage return ('\r') character.
lineFeed: Lines are separated by a single line feed ('\n') character.
carriageReturnLineFeed: Lines are separated by a carriage return and a line feed ('\r\n') character.

Defines values for PhoneticEncoder.

A value that specifies whether answers should be returned as part of the search response. This parameter is only valid if the query type is 'semantic'. If set to extractive, the query returns answers extracted from key passages in the highest ranked documents.

A value that specifies whether captions should be returned as part of the search response. 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 'extractive', highlighting is enabled by default. Defaults to 'none'.

Defines values for QueryType.

Options for reset indexer operation.

Options for run indexer operation.

Contains the possible cases for ScoringFunction.

Defines values for ScoringFunctionAggregation.

Defines values for ScoringFunctionInterpolation.

Defines values for ScoringStatistics.

Represents a field in an index definition, which describes the name, data type, and search behavior of a field.

If TModel is an untyped object, an untyped string array Otherwise, the slash-delimited fields of TModel.

Defines values for SearchFieldDataType.

Known values supported by the service:

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 as part of a collection type, i.e. Collection(Edm.Single).

Edm.Half: Indicates that a field contains a half-precision floating point number. This is only valid when used as part of a collection type, i.e. Collection(Edm.Half).

Edm.Int16: Indicates that a field contains a 16-bit signed integer. This is only valid when used as part of a collection type, i.e. Collection(Edm.Int16).

Edm.SByte: Indicates that a field contains a 8-bit signed integer. This is only valid when used as part of a collection type, i.e. Collection(Edm.SByte).

Edm.Byte: Indicates that a field contains a 8-bit unsigned integer. This is only valid when used as part of a collection type, i.e. Collection(Edm.Byte).

Contains the possible cases for SearchIndexerDataIdentity.

Contains the possible cases for Skill.

Options for SearchIndexingBufferedSenderDeleteDocuments.

Options for SearchIndexingBufferedSenderFlushDocuments.

Options for SearchIndexingBufferedSenderMergeDocuments.

Options for SearchIndexingBufferedSenderMergeOrUploadDocuments.

Options for SearchIndexingBufferedSenderUploadDocuments.

An iterator for search results of a paticular query. Will make requests as needed during iteration. Use .byPage() to make one request to the server per iteration.

Defines values for SearchMode.

Options for committing a full search request.

Deeply pick fields of T using valid Cognitive Search OData $select paths.

Parameters for filtering, sorting, faceting, paging, and other search query behaviors.

Contains a document found by a search query, plus associated metadata.

If TFields is never, an untyped string array Otherwise, a narrowed Fields[] type to be used elsewhere in the consuming type.

Produces a union of valid Cognitive Search OData $select paths for T using a post-order traversal of the field tree rooted at T.

Contains the possible cases for Similarity.

Defines values for SnowballTokenFilterLanguage.

Defines values for StemmerTokenFilterLanguage.

Defines values for StopwordsList.

Options for retrieving suggestions based on the searchText.

A result containing a document found by a suggestion query, plus associated metadata.

Defines values for TokenCharacterKind.

Contains the possible cases for TokenFilter.

Defines values for TokenFilterName.
<xref:KnownTokenFilterName> can be used interchangeably with TokenFilterName, this enum contains the known values that the service supports.

Known values supported by the service

arabic_normalization: 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
apostrophe: 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
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
cjk_bigram: 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
cjk_width: 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
classic: 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
common_grams: 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
edgeNGram_v2: 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
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
german_normalization: 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
hindi_normalization: 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
indic_normalization: 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
keyword_repeat: 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
kstem: 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
length: 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
limit: 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
lowercase: Normalizes token text to lower case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html
nGram_v2: 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
persian_normalization: Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html
phonetic: Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html
porter_stem: Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer
reverse: Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html
scandinavian_normalization: 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
scandinavian_folding: 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
shingle: 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
snowball: 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
sorani_normalization: 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
stemmer: Language specific stemming filter. See https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters
stopwords: 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
trim: 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
truncate: 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
unique: 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
uppercase: Normalizes token text to upper case. See https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html
word_delimiter: Splits words into subwords and performs optional transformations on subword groups.

Options for the upload documents operation.

Defines values for VectorEncodingFormat.
KnownVectorEncodingFormat can be used interchangeably with VectorEncodingFormat, this enum contains the known values that the service supports.

Known values supported by the service

packedBit: Encoding format representing bits packed into a wider data type.

The query parameters for vector and hybrid search queries.

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

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

Defines values for VectorSearchCompressionKind.
KnownVectorSearchCompressionKind can be used interchangeably with VectorSearchCompressionKind, this enum contains the known values that the service supports.

Known values supported by the service

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.

Defines values for VectorSearchCompressionTarget.
KnownVectorSearchCompressionTarget can be used interchangeably with VectorSearchCompressionTarget, this enum contains the known values that the service supports.

Known values supported by the service

int8

Contains configuration options on how to vectorize text vector queries.

Defines values for VectorSearchVectorizerKind.
KnownVectorSearchVectorizerKind can be used interchangeably with VectorSearchVectorizerKind, this enum contains the known values that the service supports.

Known values supported by the service

azureOpenAI: Generate embeddings using an Azure OpenAI resource at query time.
customWebApi: Generate embeddings using a custom web endpoint at query time.

Defines values for AnalyzerName. See https://docs.microsoft.com/rest/api/searchservice/Language-support

Known values of AzureOpenAIModelName that the service accepts.

Known values of BlobIndexerDataToExtract that the service accepts.

Known values of BlobIndexerImageAction that the service accepts.

Known values of BlobIndexerPDFTextRotationAlgorithm that the service accepts.

Known values of BlobIndexerParsingMode that the service accepts.

Known values of CharFilterName that the service accepts.

Known values of CustomEntityLookupSkillLanguage that the service accepts.

Known values of EntityCategory that the service accepts.

Known values of EntityRecognitionSkillLanguage that the service accepts.

Known values of ImageAnalysisSkillLanguage that the service accepts.

Known values of ImageDetail that the service accepts.

Known values of IndexProjectionMode that the service accepts.

Known values of IndexerExecutionEnvironment that the service accepts.

Known values of KeyPhraseExtractionSkillLanguage that the service accepts.

Known values of OcrLineEnding that the service accepts.

Known values of OcrSkillLanguage that the service accepts.

Known values of PIIDetectionSkillMaskingMode that the service accepts.

Known values of RegexFlags that the service accepts.

Known values for Search Audience

Known values of SearchFieldDataType that the service accepts.

Known values of SearchIndexerDataSourceType that the service accepts.

Known values of SemanticErrorMode that the service accepts.

Known values of SemanticErrorReason that the service accepts.

Known values of SemanticSearchResultsType that the service accepts.

Known values of SentimentSkillLanguage that the service accepts.

Known values of SplitSkillLanguage that the service accepts.

Known values of TextSplitMode that the service accepts.

Known values of TextTranslationSkillLanguage that the service accepts.

Known values of TokenFilterName that the service accepts.

Known values of LexicalTokenizerName that the service accepts.

Known values of VectorEncodingFormat that the service accepts.

Known values of VectorFilterMode that the service accepts.

Known values of VectorQueryKind that the service accepts.

Known values of VectorSearchAlgorithmKind that the service accepts.

Known values of VectorSearchAlgorithmMetric that the service accepts.

Known values of VectorSearchCompressionKind that the service accepts.

Known values of VectorSearchCompressionTarget that the service accepts.

Known values of VectorSearchVectorizerKind that the service accepts.

Known values of VisualFeature that the service accepts.

Helper method to create a SynonymMap object. This is a NodeJS only method.

Escapes an odata filter expression to avoid errors with quoting string literals. Example usage:

const baseRateMax = 200;
const ratingMin = 4;
const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;

For more information on supported syntax see: https://docs.microsoft.com/en-us/azure/search/search-query-odata-filter