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.

public class CustomAnalyzer : Azure.Search.Documents.Indexes.Models.LexicalAnalyzer
public class CustomAnalyzer : Azure.Search.Documents.Indexes.Models.LexicalAnalyzer, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.CustomAnalyzer>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.CustomAnalyzer>
type CustomAnalyzer = class
    inherit LexicalAnalyzer
type CustomAnalyzer = class
    inherit LexicalAnalyzer
    interface IJsonModel<CustomAnalyzer>
    interface IPersistableModel<CustomAnalyzer>
Public Class CustomAnalyzer
Inherits LexicalAnalyzer
Public Class CustomAnalyzer
Inherits LexicalAnalyzer
Implements IJsonModel(Of CustomAnalyzer), IPersistableModel(Of CustomAnalyzer)
Inheritance
CustomAnalyzer
Implements

Constructors

CustomAnalyzer(String, LexicalTokenizerName)

Initializes a new instance of CustomAnalyzer.

Properties

CharFilters

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

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 LexicalAnalyzer)
TokenFilters

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.

TokenizerName

The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<CustomAnalyzer>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<CustomAnalyzer>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<LexicalAnalyzer>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from LexicalAnalyzer)
IJsonModel<LexicalAnalyzer>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from LexicalAnalyzer)
IPersistableModel<CustomAnalyzer>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CustomAnalyzer>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<CustomAnalyzer>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<LexicalAnalyzer>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from LexicalAnalyzer)
IPersistableModel<LexicalAnalyzer>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from LexicalAnalyzer)
IPersistableModel<LexicalAnalyzer>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from LexicalAnalyzer)

Applies to