KeepTokenFilter Class

Definition

Namespace:: Azure.Search.Documents.Indexes.Models

Assembly:: Azure.Search.Documents.dll

Package:: Azure.Search.Documents v11.6.1

Package:: Azure.Search.Documents v11.7.0-beta.7

Source:: KeepTokenFilter.cs

Source:: KeepTokenFilter.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.

public class KeepTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter

public class KeepTokenFilter : Azure.Search.Documents.Indexes.Models.TokenFilter, System.ClientModel.Primitives.IJsonModel<Azure.Search.Documents.Indexes.Models.KeepTokenFilter>, System.ClientModel.Primitives.IPersistableModel<Azure.Search.Documents.Indexes.Models.KeepTokenFilter>

type KeepTokenFilter = class
    inherit TokenFilter

type KeepTokenFilter = class
    inherit TokenFilter
    interface IJsonModel<KeepTokenFilter>
    interface IPersistableModel<KeepTokenFilter>

Public Class KeepTokenFilter
Inherits TokenFilter

Public Class KeepTokenFilter
Inherits TokenFilter
Implements IJsonModel(Of KeepTokenFilter), IPersistableModel(Of KeepTokenFilter)

Inheritance: Object

TokenFilter
KeepTokenFilter

Implements: IJsonModel<KeepTokenFilter> IPersistableModel<KeepTokenFilter> IPersistableModel<T>

Constructors

KeepTokenFilter(String, IEnumerable<String>)

Initializes a new instance of KeepTokenFilter.

Properties

KeepWords	The list of words to keep.
LowerCaseKeepWords	A value indicating whether to lower case all words first. Default is false.
Name	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)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<KeepTokenFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<KeepTokenFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<TokenFilter>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from TokenFilter)
IJsonModel<TokenFilter>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from TokenFilter)
IPersistableModel<KeepTokenFilter>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<KeepTokenFilter>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<KeepTokenFilter>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<TokenFilter>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from TokenFilter)
IPersistableModel<TokenFilter>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from TokenFilter)
IPersistableModel<TokenFilter>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from TokenFilter)

Applies to