EdgeNGramTokenFilter Class

Definition

Warning

This API is now obsolete.

Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.

[Newtonsoft.Json.JsonObject("#Microsoft.Azure.Search.EdgeNGramTokenFilter")]
[System.Obsolete("This type is obsolete. Please use EdgeNGramTokenFilterV2 instead.")]
public class EdgeNGramTokenFilter : Microsoft.Azure.Search.Models.TokenFilter
type EdgeNGramTokenFilter = class
    inherit TokenFilter
Public Class EdgeNGramTokenFilter
Inherits TokenFilter
Inheritance
EdgeNGramTokenFilter
Attributes

Constructors

EdgeNGramTokenFilter()

Initializes a new instance of the EdgeNGramTokenFilter class.

EdgeNGramTokenFilter(String, Nullable<Int32>, Nullable<Int32>, Nullable<EdgeNGramTokenFilterSide>)

Initializes a new instance of the EdgeNGramTokenFilter class.

Properties

MaxGram

Gets or sets the maximum n-gram length. Default is 2.

MinGram

Gets or sets the minimum n-gram length. Default is 1. Must be less than the value of maxGram.

Name

Gets or sets the name of the token filter. 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 TokenFilter)
Side

Gets or sets specifies which side of the input the n-gram should be generated from. Default is "front". Possible values include: 'front', 'back'

Methods

Validate()

Validate the object.

Applies to