Uses of Package
com.azure.search.documents.indexes.models
Package
Description
Package containing classes for creating
SearchClient
or
SearchAsyncClient
used to perform document management, autocomplete, search, or
suggestion operations using an Azure Cognitive Search service index.Package containing classes for creating
SearchIndexClient
,
SearchIndexAsyncClient
,
SearchIndexerClient
, or
SearchIndexerAsyncClient
used to perform resource management operations
on an Azure Cognitive Search service.Package containing the data models for SearchServiceClient.
-
ClassDescriptionContains a batch of document write actions to send to the index.
-
ClassDescriptionInformation about a token returned by an analyzer.Specifies some text and analysis components used to break that text into tokens.This model represents a property bag containing all options for creating or updating a
data source connection
.This model represents a property bag containing all options for creating or updating anindexer
.This model represents a property bag containing all options for creating or updating askillset
.Base type for data change detection policies.Base type for data deletion detection policies.Additional parameters to buildSearchField
.Represents an index alias, which describes a mapping from the alias name to an index.Represents a field in an index definition, which describes the name, data type, and search behavior of a field.Represents a search index definition, which describes the fields and search behavior of an index.Represents an indexer.Represents a datasource definition, which can be used to configure an indexer.A list of skills.Represents the current status and execution history of an indexer.Statistics for a given index.Response from a get service statistics request.Represents a synonym map definition. -
ClassDescriptionSpecifies some text and analysis components used to break that text into tokens.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.The AML skill allows you to extend AI enrichment with a custom Azure Machine Learning (AML) model.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".Determines how to process embedded images and image files in Azure blob storage.Represents the parsing mode for indexing from an Azure blob data source.Determines algorithm for text extraction from PDF files in Azure blob storage.Ranking function based on the Okapi BM25 similarity algorithm.Base type for character filters.Defines the names of all character filters supported by Azure Cognitive Search.Forms bigrams of CJK terms that are generated from the standard tokenizer.Scripts that can be ignored by CjkBigramTokenFilter.Grammar-based tokenizer that is suitable for processing most European-language documents.Base type for describing any cognitive service resource attached to a skillset.A cognitive service resource provisioned with a key that is attached to a skillset.Construct bigrams for frequently occurring terms while indexing.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.This model represents a property bag containing all options for creating or updating a
data source connection
.This model represents a property bag containing all options for creating or updating anindexer
.This model represents a property bag containing all options for creating or updating askillset
.Allows you to take control over the process of converting text into indexable/searchable tokens.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.The language codes supported for input text by CustomEntityLookupSkill.Allows you to configure normalization for filterable, sortable, and facetable fields, which by default operate with strict matching.Base type for data change detection policies.Base type for data deletion detection policies.An empty object that represents the default cognitive service resource for a skillset.Decomposes compound words found in many Germanic languages.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.Specifies which side of the input an n-gram should be generated from.Tokenizes the input from an edge into n-grams of the given size(s).Removes elisions.A string indicating what entity categories to return.Using the Text Analytics API, extracts linked entities from text.Text analytics entity recognition.The language codes supported for input text by EntityRecognitionSkill.Represents the version ofEntityRecognitionSkill
.Additional parameters to buildSearchField
.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.A skill that analyzes image files.The language codes supported for input by ImageAnalysisSkill.A string indicating which domain-specific details to return.Contains a batch of document write actions to send to the index.Represents all of the state that defines and dictates the indexer's current execution.Specifies the environment in which the indexer should execute.Represents the result of an individual indexer execution.Represents the status of an individual indexer execution.Details the status of an individual indexer execution.Represents the overall indexer status.Represents the mode the indexer is executing in.Represents parameters for indexer execution.A dictionary of indexer-specific configuration properties.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.A skill that uses text analytics for key phrase extraction.The language codes supported for input text by KeyPhraseExtractionSkill.Marks terms as keywords.Emits the entire input as a single token.A skill that detects the language of input text and reports a single language code for every document submitted on the request.Removes words that are too long or too short.Base type for analyzers.Defines the names of all text analyzers supported by Azure Cognitive Search.Base type for normalizers.Defines the names of all text normalizers supported by Azure Cognitive Search.Base type for tokenizers.Defines the names of all tokenizers supported by Azure Cognitive Search.Limits the number of tokens while indexing.Defines the sequence of characters to use between the lines of text recognized by the OCR skill.Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.Breaks text following the Unicode Text Segmentation rules.Defines a function that boosts scores based on the magnitude of a numeric field.Provides parameter values to a magnitude scoring function.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.Lists the languages supported by the Microsoft language stemming tokenizer.Lists the languages supported by the Microsoft language tokenizer.Generates n-grams of the given size(s).Tokenizes the input into n-grams of the given size(s).A skill that extracts text from image files.The language codes supported for input by OcrSkill.Output field mapping for a skill.Tokenizer for path-like hierarchies.Flexibly separates text into terms via a regular expression pattern.Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns.Tokenizer that uses regex pattern matching to construct distinct tokens.Identifies the type of phonetic encoder to use with a PhoneticTokenFilter.Create tokens for phonetic matches.Using the Text Analytics API, extracts personal information from an input text and gives you the option of masking it.A string indicating what maskingMode to use to mask the personal information detected in the input text.Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers.Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.Represents a resource's usage and quota.Base type for functions that can modify document scores during ranking.Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile.Defines the function used to interpolate score boosting across a range of documents.Defines parameters for a search index that influence scoring in search queries.Represents an index alias, which describes a mapping from the alias name to an index.Represents a field in an index definition, which describes the name, data type, and search behavior of a field.Defines the data type of a field in a search index.Represents a search index definition, which describes the fields and search behavior of an index.Represents an indexer.The SearchIndexerCache model.Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed.Abstract base type for data identities.Represents a datasource definition, which can be used to configure an indexer.Defines the type of a datasource.Represents an item- or document-level indexing error.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.Container object for various projection selectors.Abstract class to share properties between concrete selectors.Description for what data to store in Azure Tables.The SearchIndexerLimits model.Base type for skills.A list of skills.Represents an item-level warning.A customer-managed encryption key in Azure Key Vault.Represents service-level resource counters and quotas.Represents various service level 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.Defines parameters for a search index that influence semantic capabilities.Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1.The language codes supported for input text by SentimentSkill.Represents the version ofSentimentSkill
.A skill for reshaping the outputs.Creates combinations of tokens as a single token.Base type for similarity algorithms.The language to use for a Snowball token filter.Defines a data deletion detection policy that implements a soft-deletion strategy.A skill to split a string into chunks of text.The language codes supported for input text by SplitSkill.The language to use for a stemmer token filter.Divides text at non-letters; Applies the lowercase and stopword token filters.Identifies a predefined list of language-specific stopwords.Removes stop words from a token stream.Represents a synonym map definition.Matches single or multi-word synonyms in a token stream.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 value indicating which split mode to perform.A skill to translate text from one language to another.The language codes supported for input text by TextTranslationSkill.Defines weights on index fields for which matches should boost scoring in search queries.Represents classes of characters on which a token filter can operate.Base type for token filters.Defines the names of all token filters supported by Azure Cognitive Search.Truncates the terms to a specific length.Tokenizes urls and emails as one token.Filters out tokens with same text as the previous token.The strings indicating what visual feature types to return.A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code.Splits words into subwords and performs optional transformations on subword groups.