All Classes and Interfaces

Class	Description
AnalyzedTokenInfo	Information about a token returned by an analyzer.
AnalyzeTextOptions	Specifies some text and analysis components used to break that text into tokens.
AnswerResult	An answer is a text passage extracted from the contents of the most relevant documents that matched the query.
AsciiFoldingTokenFilter	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.
AutocompleteItem	The result of Autocomplete requests.
AutocompleteMode	Specifies the mode for Autocomplete.
AutocompleteOptions	Parameter group.
AutocompletePagedFlux	Implementation of PagedFluxBase where the element type is AutocompleteItem and the page type is AutocompletePagedResponse.
AutocompletePagedIterable	Implementation of PagedIterableBase where the element type is AutocompleteItem and the page type is AutocompletePagedResponse.
AutocompletePagedResponse	This class represents a response from the autocomplete API.
AutocompleteResult	The result of Autocomplete query.
AzureMachineLearningSkill	The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model.
BlobIndexerDataToExtract	Specifies the data to extract from Azure blob storage and tells the indexer which data to extract from image content when "imageAction" is set to a value other than "none".
BlobIndexerImageAction	Determines how to process embedded images and image files in Azure blob storage.
BlobIndexerParsingMode	Represents the parsing mode for indexing from an Azure blob data source.
BlobIndexerPdfTextRotationAlgorithm	Determines algorithm for text extraction from PDF files in Azure blob storage.
BM25SimilarityAlgorithm	Ranking function based on the Okapi BM25 similarity algorithm.
CaptionResult	Captions are the most representative passages from the document relatively to the search query.
CharFilter	Base type for character filters.
CharFilterName	Defines the names of all character filters supported by Azure Cognitive Search.
CjkBigramTokenFilter	Forms bigrams of CJK terms that are generated from the standard tokenizer.
CjkBigramTokenFilterScripts	Scripts that can be ignored by CjkBigramTokenFilter.
ClassicSimilarityAlgorithm	Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF.
ClassicTokenizer	Grammar-based tokenizer that is suitable for processing most European-language documents.
CognitiveServicesAccount	Base type for describing any cognitive service resource attached to a skillset.
CognitiveServicesAccountKey	A cognitive service resource provisioned with a key that is attached to a skillset.
CommonGramTokenFilter	Construct bigrams for frequently occurring terms while indexing.
ConditionalSkill	A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output.
CorsOptions	Defines options to control Cross-Origin Resource Sharing (CORS) for an index.
CreateOrUpdateDataSourceConnectionOptions	This model represents a property bag containing all options for creating or updating a data source connection.
CreateOrUpdateIndexerOptions	This model represents a property bag containing all options for creating or updating an indexer.
CreateOrUpdateSkillsetOptions	This model represents a property bag containing all options for creating or updating a skillset.
CustomAnalyzer	Allows you to take control over the process of converting text into indexable/searchable tokens.
CustomEntity	An object that contains information about the matches that were found, and related metadata.
CustomEntityAlias	A complex object that can be used to specify alternative spellings or synonyms to the root entity name.
CustomEntityLookupSkill	A skill looks for text from a custom, user-defined list of words and phrases.
CustomEntityLookupSkillLanguage	The language codes supported for input text by CustomEntityLookupSkill.
CustomNormalizer	Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching.
DataChangeDetectionPolicy	Base type for data change detection policies.
DataDeletionDetectionPolicy	Base type for data deletion detection policies.
DefaultCognitiveServicesAccount	An empty object that represents the default cognitive service resource for a skillset.
DictionaryDecompounderTokenFilter	Decomposes compound words found in many Germanic languages.
DistanceScoringFunction	Defines a function that boosts scores based on distance from a geographic location.
DistanceScoringParameters	Provides parameter values to a distance scoring function.
DocumentExtractionSkill	A skill that extracts content from a file within the enrichment pipeline.
EdgeNGramTokenFilter	Generates n-grams of the given size(s) starting from the front or the back of an input token.
EdgeNGramTokenFilterSide	Specifies which side of the input an n-gram should be generated from.
EdgeNGramTokenizer	Tokenizes the input from an edge into n-grams of the given size(s).
ElisionTokenFilter	Removes elisions.
EntityCategory	A string indicating what entity categories to return.
EntityLinkingSkill	Using the Text Analytics API, extracts linked entities from text.
EntityRecognitionSkill	Text analytics entity recognition.
EntityRecognitionSkillLanguage	The language codes supported for input text by EntityRecognitionSkill.
EntityRecognitionSkillVersion	Represents the version of EntityRecognitionSkill.
FacetResult	A single bucket of a facet query result.
FieldBuilderIgnore	Marker annotation that indicates the field or method is to be ignored by converting to SearchField.
FieldBuilderOptions	Additional parameters to build SearchField.
FieldMapping	Defines a mapping between a field in a data source and a target field in an index.
FieldMappingFunction	Represents a function that transforms a value from a data source before indexing.
FreshnessScoringFunction	Defines a function that boosts scores based on the value of a date-time field.
FreshnessScoringParameters	Provides parameter values to a freshness scoring function.
HighWaterMarkChangeDetectionPolicy	Defines a data change detection policy that captures changes based on the value of a high water mark column.
ImageAnalysisSkill	A skill that analyzes image files.
ImageAnalysisSkillLanguage	The language codes supported for input by ImageAnalysisSkill.
ImageDetail	A string indicating which domain-specific details to return.
IndexAction<T>	Represents an index action that operates on a document.
IndexActionType	The operation to perform on a document in an indexing batch.
IndexBatchBase<T>	Contains a batch of document write actions to send to the index.
IndexBatchException	An IndexBatchException is thrown whenever Azure Cognitive Search index call was only partially successful.
IndexDocumentsBatch<T>	Contains a batch of document write actions to send to the index.
IndexDocumentsOptions	Options for document index operations.
IndexDocumentsResult	Response containing the status of operations for all documents in the indexing request.
IndexerCurrentState	Represents all of the state that defines and dictates the indexer's current execution.
IndexerExecutionEnvironment	Specifies the environment in which the indexer should execute.
IndexerExecutionResult	Represents the result of an individual indexer execution.
IndexerExecutionStatus	Represents the status of an individual indexer execution.
IndexerExecutionStatusDetail	Details the status of an individual indexer execution.
IndexerStatus	Represents the overall indexer status.
IndexingMode	Represents the mode the indexer is executing in.
IndexingParameters	Represents parameters for indexer execution.
IndexingParametersConfiguration	A dictionary of indexer-specific configuration properties.
IndexingResult	Status of an indexing operation for a single document.
IndexingSchedule	Represents a schedule for indexer execution.
InputFieldMappingEntry	Input field mapping for a skill.
KeepTokenFilter	A token filter that only keeps tokens with text contained in a specified list of words.
KeyPhraseExtractionSkill	A skill that uses text analytics for key phrase extraction.
KeyPhraseExtractionSkillLanguage	The language codes supported for input text by KeyPhraseExtractionSkill.
KeywordMarkerTokenFilter	Marks terms as keywords.
KeywordTokenizer	Emits the entire input as a single token.
LanguageDetectionSkill	A skill that detects the language of input text and reports a single language code for every document submitted on the request.
LengthTokenFilter	Removes words that are too long or too short.
LexicalAnalyzer	Base type for analyzers.
LexicalAnalyzerName	Defines the names of all text analyzers supported by Azure Cognitive Search.
LexicalNormalizer	Base type for normalizers.
LexicalNormalizerName	Defines the names of all text normalizers supported by Azure Cognitive Search.
LexicalTokenizer	Base type for tokenizers.
LexicalTokenizerName	Defines the names of all tokenizers supported by Azure Cognitive Search.
LimitTokenFilter	Limits the number of tokens while indexing.
LineEnding	Defines the sequence of characters to use between the lines of text recognized by the OCR skill.
LuceneStandardAnalyzer	Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.
LuceneStandardTokenizer	Breaks text following the Unicode Text Segmentation rules.
MagnitudeScoringFunction	Defines a function that boosts scores based on the magnitude of a numeric field.
MagnitudeScoringParameters	Provides parameter values to a magnitude scoring function.
MappingCharFilter	A character filter that applies mappings defined with the mappings option.
MergeSkill	A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part.
MicrosoftLanguageStemmingTokenizer	Divides text using language-specific rules and reduces words to their base forms.
MicrosoftLanguageTokenizer	Divides text using language-specific rules.
MicrosoftStemmingTokenizerLanguage	Lists the languages supported by the Microsoft language stemming tokenizer.
MicrosoftTokenizerLanguage	Lists the languages supported by the Microsoft language tokenizer.
NGramTokenFilter	Generates n-grams of the given size(s).
NGramTokenizer	Tokenizes the input into n-grams of the given size(s).
OcrSkill	A skill that extracts text from image files.
OcrSkillLanguage	The language codes supported for input by OcrSkill.
OnActionAddedOptions<T>	Options passed when onActionAdded(Consumer) is called.
OnActionErrorOptions<T>	Options passed when onActionError(Consumer) is called.
OnActionSentOptions<T>	Options passed when onActionSent(Consumer) is called.
OnActionSucceededOptions<T>	Options passed when onActionSucceeded(Consumer) is called.
OutputFieldMappingEntry	Output field mapping for a skill.
PathHierarchyTokenizer	Tokenizer for path-like hierarchies.
PatternAnalyzer	Flexibly separates text into terms via a regular expression pattern.
PatternCaptureTokenFilter	Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns.
PatternReplaceCharFilter	A character filter that replaces characters in the input string.
PatternReplaceTokenFilter	A character filter that replaces characters in the input string.
PatternTokenizer	Tokenizer that uses regex pattern matching to construct distinct tokens.
PhoneticEncoder	Identifies the type of phonetic encoder to use with a PhoneticTokenFilter.
PhoneticTokenFilter	Create tokens for phonetic matches.
PiiDetectionSkill	Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.
PiiDetectionSkillMaskingMode	A string indicating what maskingMode to use to mask the personal information detected in the input text.
PrioritizedFields	Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers.
QueryAnswerType	This parameter is only valid if the query type is 'semantic'.
QueryCaptionType	This parameter is only valid if the query type is 'semantic'.
QueryLanguage	The language of the query.
QuerySpellerType	Improve search recall by spell-correcting individual search query terms.
QueryType	Specifies the syntax of the search query.
RangeFacetResult<T>	A single bucket of a range facet query result that reports the number of documents with a field value falling within a particular range.
RegexFlags	Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.
ResourceCounter	Represents a resource's usage and quota.
ScoringFunction	Base type for functions that can modify document scores during ranking.
ScoringFunctionAggregation	Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile.
ScoringFunctionInterpolation	Defines the function used to interpolate score boosting across a range of documents.
ScoringParameter	Represents a parameter value to be used in scoring functions (for example, referencePointParameter).
ScoringProfile	Defines parameters for a search index that influence scoring in search queries.
ScoringStatistics	A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency.
SearchableField	An annotation that directs SearchIndexAsyncClient.buildSearchFields(Class, FieldBuilderOptions) to turn the field or method into a searchable field.
SearchAlias	Represents an index alias, which describes a mapping from the alias name to an index.
SearchAsyncClient	This class provides a client that contains the operations for querying an index and uploading, merging, or deleting documents in an Azure Cognitive Search service.
SearchAudience	Cloud audiences available for Search.
SearchClient	This class provides a client that contains the operations for querying an index and uploading, merging, or deleting documents in an Azure Cognitive Search service.
SearchClientBuilder	This class provides a fluent builder API to help aid the configuration and instantiation of SearchClients and SearchAsyncClients.
SearchDocument	Represents an untyped document returned from a search or document lookup.
SearchField	Represents a field in an index definition, which describes the name, data type, and search behavior of a field.
SearchFieldDataType	Defines the data type of a field in a search index.
SearchFilter	This class is used to help construct valid OData filter expressions by automatically replacing, quoting, and escaping string parameters.
SearchIndex	Represents a search index definition, which describes the fields and search behavior of an index.
SearchIndexAsyncClient	This class provides a client that contains the operations for creating, getting, listing, updating, or deleting indexes or synonym map and analyzing text in an Azure Cognitive Search service.
SearchIndexClient	This class provides a client that contains the operations for creating, getting, listing, updating, or deleting indexes or synonym map and analyzing text in an Azure Cognitive Search service.
SearchIndexClientBuilder	This class provides a fluent builder API to help aid the configuration and instantiation of SearchIndexClients and SearchIndexAsyncClients.
SearchIndexer	Represents an indexer.
SearchIndexerAsyncClient	This class provides a client that contains the operations for creating, getting, listing, updating, or deleting data source connections, indexers, or skillsets and running or resetting indexers in an Azure Cognitive Search service.
SearchIndexerCache	The SearchIndexerCache model.
SearchIndexerClient	This class provides a client that contains the operations for creating, getting, listing, updating, or deleting data source connections, indexers, or skillsets and running or resetting indexers in an Azure Cognitive Search service.
SearchIndexerClientBuilder	This class provides a fluent builder API to help aid the configuration and instantiation of SearchIndexerClients and SearchIndexerAsyncClients.
SearchIndexerDataContainer	Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed.
SearchIndexerDataIdentity	Abstract base type for data identities.
SearchIndexerDataNoneIdentity	Clears the identity property of a datasource.
SearchIndexerDataSourceConnection	Represents a datasource definition, which can be used to configure an indexer.
SearchIndexerDataSources	Utility class that aids in the creation of SearchIndexerDataSourceConnections.
SearchIndexerDataSourceType	Defines the type of a datasource.
SearchIndexerDataUserAssignedIdentity	Specifies the identity for a datasource to use.
SearchIndexerError	Represents an item- or document-level indexing error.
SearchIndexerKnowledgeStore	Definition of additional projections to azure blob, table, or files, of enriched data.
SearchIndexerKnowledgeStoreBlobProjectionSelector	Abstract class to share properties between concrete selectors.
SearchIndexerKnowledgeStoreFileProjectionSelector	Projection definition for what data to store in Azure Files.
SearchIndexerKnowledgeStoreObjectProjectionSelector	Projection definition for what data to store in Azure Blob.
SearchIndexerKnowledgeStoreProjection	Container object for various projection selectors.
SearchIndexerKnowledgeStoreProjectionSelector	Abstract class to share properties between concrete selectors.
SearchIndexerKnowledgeStoreTableProjectionSelector	Description for what data to store in Azure Tables.
SearchIndexerLimits	The SearchIndexerLimits model.
SearchIndexerSkill	Base type for skills.
SearchIndexerSkillset	A list of skills.
SearchIndexerStatus	Represents the current status and execution history of an indexer.
SearchIndexerWarning	Represents an item-level warning.
SearchIndexingBufferedAsyncSender<T>	This class provides a buffered sender that contains operations for conveniently indexing documents to an Azure Search index.
SearchIndexingBufferedSender<T>	This class provides a buffered sender that contains operations for conveniently indexing documents to an Azure Search index.
SearchIndexStatistics	Statistics for a given index.
SearchMode	Specifies whether any or all of the search terms must be matched in order to count the document as a match.
SearchOptions	Additional parameters for searchGet operation.
SearchPagedFlux	Implementation of ContinuablePagedFlux where the continuation token type is SearchRequest, the element type is SearchResult, and the page type is SearchPagedResponse.
SearchPagedIterable	Implementation of ContinuablePagedIterable where the continuation token type is SearchRequest, the element type is SearchResult, and the page type is SearchPagedResponse.
SearchPagedResponse	Represents an HTTP response from the search API request that contains a list of items deserialized into a Page.
SearchResourceEncryptionKey	A customer-managed encryption key in Azure Key Vault.
SearchResult	Contains a document found by a search query, plus associated metadata.
SearchServiceCounters	Represents service-level resource counters and quotas.
SearchServiceLimits	Represents various service level limits.
SearchServiceStatistics	Response from a get service statistics request.
SearchServiceVersion	The versions of Azure Cognitive Search supported by this client library.
SearchSuggester	Defines how the Suggest API should apply to a group of fields in the index.
SemanticConfiguration	Defines a specific configuration to be used in the context of semantic capabilities.
SemanticField	A field that is used as part of the semantic configuration.
SemanticSettings	Defines parameters for a search index that influence semantic capabilities.
SentimentSkill	Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.
SentimentSkillLanguage	The language codes supported for input text by SentimentSkill.
SentimentSkillVersion	Represents the version of SentimentSkill.
ShaperSkill	A skill for reshaping the outputs.
ShingleTokenFilter	Creates combinations of tokens as a single token.
SimilarityAlgorithm	Base type for similarity algorithms.
SimpleField	An annotation that directs SearchIndexAsyncClient.buildSearchFields(Class, FieldBuilderOptions) to turn the field or method into a non-searchable field.
SnowballTokenFilter	A filter that stems words using a Snowball-generated stemmer.
SnowballTokenFilterLanguage	The language to use for a Snowball token filter.
SoftDeleteColumnDeletionDetectionPolicy	Defines a data deletion detection policy that implements a soft-deletion strategy.
SplitSkill	A skill to split a string into chunks of text.
SplitSkillLanguage	The language codes supported for input text by SplitSkill.
SqlIntegratedChangeTrackingPolicy	Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.
StemmerOverrideTokenFilter	Provides the ability to override other stemming filters with custom dictionary-based stemming.
StemmerTokenFilter	Language specific stemming filter.
StemmerTokenFilterLanguage	The language to use for a stemmer token filter.
StopAnalyzer	Divides text at non-letters; Applies the lowercase and stopword token filters.
StopwordsList	Identifies a predefined list of language-specific stopwords.
StopwordsTokenFilter	Removes stop words from a token stream.
SuggestOptions	Parameter group.
SuggestPagedFlux	Implementation of PagedFluxBase where the element type is SuggestResult and the page type is SuggestPagedResponse.
SuggestPagedIterable	Implementation of PagedIterableBase where the element type is SuggestResult and the page type is SuggestPagedResponse.
SuggestPagedResponse	Represents an HTTP response from the suggest API request that contains a list of items deserialized into a Page.
SuggestResult	A result containing a document found by a suggestion query, plus associated metadata.
SynonymMap	Represents a synonym map definition.
SynonymTokenFilter	Matches single or multi-word synonyms in a token stream.
TagScoringFunction	Defines a function that boosts scores of documents with string values matching a given list of tags.
TagScoringParameters	Provides parameter values to a tag scoring function.
TextSplitMode	A value indicating which split mode to perform.
TextTranslationSkill	A skill to translate text from one language to another.
TextTranslationSkillLanguage	The language codes supported for input text by TextTranslationSkill.
TextWeights	Defines weights on index fields for which matches should boost scoring in search queries.
TokenCharacterKind	Represents classes of characters on which a token filter can operate.
TokenFilter	Base type for token filters.
TokenFilterName	Defines the names of all token filters supported by Azure Cognitive Search.
TruncateTokenFilter	Truncates the terms to a specific length.
UaxUrlEmailTokenizer	Tokenizes urls and emails as one token.
UniqueTokenFilter	Filters out tokens with same text as the previous token.
ValueFacetResult<T>	A single bucket of a simple or interval facet query result that reports the number of documents with a field falling within a particular interval or having a specific value.
VisualFeature	The strings indicating what visual feature types to return.
WebApiSkill	A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.
WordDelimiterTokenFilter	Splits words into subwords and performs optional transformations on subword groups.