Share via


CustomAnalyzer Class

Definition

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.

[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.CustomAnalyzer")]
public class CustomAnalyzer : Microsoft.Azure.Search.Models.Analyzer
[<Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.CustomAnalyzer")>]
type CustomAnalyzer = class
    inherit Analyzer
Public Class CustomAnalyzer
Inherits Analyzer
Inheritance
CustomAnalyzer
Attributes
Newtonsoft.Json.JsonObjectAttribute

Constructors

CustomAnalyzer()

Initializes a new instance of the CustomAnalyzer class.

CustomAnalyzer(String, TokenizerName, IList<TokenFilterName>, IList<CharFilterName>)

Initializes a new instance of the CustomAnalyzer class.

Properties

CharFilters

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

Name

Gets or sets the name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters.

(Inherited from Analyzer)
TokenFilters

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

Tokenizer

Gets or sets the name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words. Possible values include: 'classic', 'edgeNGram', 'keyword_v2', 'letter', 'lowercase', 'microsoft_language_tokenizer', 'microsoft_language_stemming_tokenizer', 'nGram', 'path_hierarchy_v2', 'pattern', 'standard_v2', 'uax_url_email', 'whitespace'

Methods

Validate()

Validate the object.

Applies to