Package com.azure.search.models

Package containing the data models for SearchServiceRestClient.

See: Description

Class Summary

Class	Description
Analyzer	Abstract base class for analyzers.
AnalyzeRequest	Specifies some text and analysis components used to break that text into tokens.
AnalyzerName	Defines values for AnalyzerName.
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.
AutocompleteOptions	Additional parameters for autocompleteGet operation.
AutocompleteRequest	Parameters for fuzzy matching, and other autocomplete query behaviors.
AutocompleteResult	The result of Autocomplete query.
AzureActiveDirectoryApplicationCredentials	Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault.
CharFilter	Abstract base class for character filters.
CharFilterName	Defines values for CharFilterName.
CjkBigramTokenFilter	Forms bigrams of CJK terms that are generated from StandardTokenizer.
ClassicTokenizer	Grammar-based tokenizer that is suitable for processing most European-language documents.
CognitiveServicesAccount	Abstract base class for describing any cognitive service resource attached to the 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.
CoordinateSystem	The EPSG:4326 is the coordinate system used for GeographyPoints in Azure Cognitive Search.
CorsOptions	Defines options to control Cross-Origin Resource Sharing (CORS) for an index.
CustomAnalyzer	Allows you to take control over the process of converting text into indexable/searchable tokens.
DataChangeDetectionPolicy	Abstract base class for data change detection policies.
DataContainer	Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed.
DataDeletionDetectionPolicy	Abstract base class for data deletion detection policies.
DataSource	Represents a datasource definition, which can be used to configure an indexer.
DataSourceCredentials	Represents credentials that can be used to connect to a datasource.
DataSourceType	Defines values for DataSourceType.
DataType	Defines values for DataType.
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.
EdgeNGramTokenFilter	Generates n-grams of the given size(s) starting from the front or the back of an input token.
EdgeNGramTokenFilterV2	Generates n-grams of the given size(s) starting from the front or the back of an input token.
EdgeNGramTokenizer	Tokenizes the input from an edge into n-grams of the given size(s).
ElisionTokenFilter	Removes elisions.
EncryptionKey	A customer-managed encryption key in Azure Key Vault.
EntityRecognitionSkill	Text analytics entity recognition.
EntityRecognitionSkillLanguage	Defines values for EntityRecognitionSkillLanguage.
FacetResult	A single bucket of a facet query result.
Field	Represents a field in an index definition, which describes the name, data type, and search behavior of a field.
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.
GeoPoint	Representation of GeographyPoint as used Azure Cognitive Search.
GetIndexStatisticsResult	Statistics for a given index.
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	Defines values for ImageAnalysisSkillLanguage.
Index	Represents a search index definition, which describes the fields and search behavior of an index.
IndexAction<T>	Represents an index action that operates on a document.
IndexBatchBase<T>	Contains a batch of document write actions to send to the index.
IndexDocumentsBatch<T>	Contains a batch of document write actions to send to the index.
IndexDocumentsResult	Response containing the status of operations for all documents in the indexing request.
Indexer	Represents an indexer.
IndexerExecutionInfo	Represents the current status and execution history of an indexer.
IndexerExecutionResult	Represents the result of an individual indexer execution.
IndexerLimits	The IndexerLimits model.
IndexingParameters	Represents parameters for indexer execution.
IndexingResult	Status of an indexing operation for a single document.
IndexingSchedule	Represents a schedule for indexer execution.
InputFieldMappingEntry	Input field mapping for a skill.
ItemError	Represents an item- or document-level indexing error.
ItemWarning	Represents an item-level warning.
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	Defines values for KeyPhraseExtractionSkillLanguage.
KeywordMarkerTokenFilter	Marks terms as keywords.
KeywordTokenizer	Emits the entire input as a single token.
KeywordTokenizerV2	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.
LimitTokenFilter	Limits the number of tokens while indexing.
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.
NamedEntityRecognitionSkill	Text analytics named entity recognition.
NGramTokenFilter	Generates n-grams of the given size(s).
NGramTokenFilterV2	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	Defines values for OcrSkillLanguage.
OutputFieldMappingEntry	Output field mapping for a skill.
PathHierarchyTokenizer	Tokenizer for path-like hierarchies.
PathHierarchyTokenizerV2	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.
PhoneticTokenFilter	Create tokens for phonetic matches.
RangeFacetResult	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 values for RegexFlags.
RequestOptions	Additional parameters for a set of operations.
ResourceCounter	Represents a resource's usage and quota.
ScoringFunction	Abstract base class for functions that can modify document scores during ranking.
ScoringProfile	Defines parameters for a search index that influence scoring in search queries.
SearchDocumentsResult	Response containing search results from an index.
SearchError	Describes an error condition for the Azure Cognitive Search API.
SearchOptions	Additional parameters for searchGet operation.
SearchRequest	Parameters for filtering, sorting, faceting, paging, and other search query behaviors.
SearchResult	Contains a document found by a search query, plus associated metadata.
SentimentSkill	Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.
SentimentSkillLanguage	Defines values for SentimentSkillLanguage.
ServiceCounters	Represents service-level resource counters and quotas.
ServiceLimits	Represents various service level limits.
ServiceStatistics	Response from a get service statistics request.
ShaperSkill	A skill for reshaping the outputs.
ShingleTokenFilter	Creates combinations of tokens as a single token.
Skill	Abstract base class for skills.
Skillset	A list of skills.
SnowballTokenFilter	A filter that stems words using a Snowball-generated stemmer.
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	Defines values for SplitSkillLanguage.
SqlIntegratedChangeTrackingPolicy	Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.
StandardAnalyzer	Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.
StandardTokenizer	Breaks text following the Unicode Text Segmentation rules.
StandardTokenizerV2	Breaks text following the Unicode Text Segmentation rules.
StemmerOverrideTokenFilter	Provides the ability to override other stemming filters with custom dictionary-based stemming.
StemmerTokenFilter	Language specific stemming filter.
StopAnalyzer	Divides text at non-letters; Applies the lowercase and stopword token filters.
StopwordsTokenFilter	Removes stop words from a token stream.
SuggestDocumentsResult	Response containing suggestion query results from an index.
Suggester	Defines how the Suggest API should apply to a group of fields in the index.
SuggestOptions	Additional parameters for suggestGet operation.
SuggestRequest	Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors.
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.
TextTranslationSkill	A skill to translate text from one language to another.
TextTranslationSkillLanguage	Defines values for TextTranslationSkillLanguage.
TextWeights	Defines weights on index fields for which matches should boost scoring in search queries.
TokenFilter	Abstract base class for token filters.
TokenFilterName	Defines values for TokenFilterName.
TokenInfo	Information about a token returned by an analyzer.
Tokenizer	Abstract base class for tokenizers.
TokenizerName	Defines values for TokenizerName.
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	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.
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.

Enum Summary

Enum	Description
AutocompleteMode	Defines values for AutocompleteMode.
CjkBigramTokenFilterScripts	Defines values for CjkBigramTokenFilterScripts.
EdgeNGramTokenFilterSide	Defines values for EdgeNGramTokenFilterSide.
EntityCategory	Defines values for EntityCategory.
ImageDetail	Defines values for ImageDetail.
IndexActionType	Defines values for IndexActionType.
IndexerExecutionStatus	Defines values for IndexerExecutionStatus.
IndexerStatus	Defines values for IndexerStatus.
MicrosoftStemmingTokenizerLanguage	Defines values for MicrosoftStemmingTokenizerLanguage.
MicrosoftTokenizerLanguage	Defines values for MicrosoftTokenizerLanguage.
NamedEntityRecognitionSkillLanguage	Defines values for NamedEntityRecognitionSkillLanguage.
PhoneticEncoder	Defines values for PhoneticEncoder.
QueryType	Defines values for QueryType.
ScoringFunctionAggregation	Defines values for ScoringFunctionAggregation.
ScoringFunctionInterpolation	Defines values for ScoringFunctionInterpolation.
SearchMode	Defines values for SearchMode.
SnowballTokenFilterLanguage	Defines values for SnowballTokenFilterLanguage.
StemmerTokenFilterLanguage	Defines values for StemmerTokenFilterLanguage.
StopwordsList	Defines values for StopwordsList.
TextExtractionAlgorithm	Defines values for TextExtractionAlgorithm.
TextSplitMode	Defines values for TextSplitMode.
TokenCharacterKind	Defines values for TokenCharacterKind.
VisualFeature	Defines values for VisualFeature.

Exception Summary

Exception	Description
SearchErrorException	Exception thrown for an invalid response with SearchError information.

Package com.azure.search.models Description

Package containing the data models for SearchServiceRestClient. Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.