Class MatchBoolPrefixQuery

A match_bool_prefix query analyzes its input and constructs a bool query from the terms. Each term except the last is used in a term query. The last term is used in a prefix query.

Inheritance

object

QueryBase

FieldNameQueryBase

MatchBoolPrefixQuery

Implements

IMatchBoolPrefixQuery

IFieldNameQuery

IQuery

Inherited Members

FieldNameQueryBase.Field

QueryBase.Boost

QueryBase.IsStrict

QueryBase.IsVerbatim

QueryBase.IsWritable

QueryBase.Name

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Client

Assembly: OpenSearch.Client.dll

Syntax

public class MatchBoolPrefixQuery : FieldNameQueryBase, IMatchBoolPrefixQuery, IFieldNameQuery, IQuery

Properties

Analyzer

The analyzer to use for the query

Declaration

public string Analyzer { get; set; }

Property Value

Type	Description
string

Conditionless

Declaration

protected override bool Conditionless { get; }

Property Value

Type	Description
bool

Overrides

QueryBase.Conditionless

Fuzziness

Allows fuzzy matching based on the type of field being queried. Applies only to the term sub queries constructed, and not the prefix query for the final term.

Declaration

public IFuzziness Fuzziness { get; set; }

Property Value

Type	Description
IFuzziness

FuzzyRewrite

Controls how the query is rewritten if Fuzziness is set. In this scenario, the default is TopTermsBlendedFreqs(int). Applies only to the term sub queries constructed, and not the prefix query for the final term.

Declaration

public MultiTermQueryRewrite FuzzyRewrite { get; set; }

Property Value

Type	Description
MultiTermQueryRewrite

FuzzyTranspositions

Sets whether transpositions are supported in fuzzy queries.

The default metric used by fuzzy queries to determine a match is the Damerau-Levenshtein distance formula which supports transpositions. Setting transposition to false will switch to classic Levenshtein distance. If not set, Damerau-Levenshtein distance metric will be used. Applies only to the term sub queries constructed, and not the prefix query for the final term.

Declaration

public bool? FuzzyTranspositions { get; set; }

Property Value

Type	Description
bool?

MaxExpansions

Controls the number of terms fuzzy queries will expand to. Defaults to 50. Applies only to the term sub queries constructed, and not the prefix query for the final term.

Declaration

public int? MaxExpansions { get; set; }

Property Value

Type	Description
int?

MinimumShouldMatch

A value controlling how many "should" clauses in the resulting boolean query should match. It can be an absolute value, a percentage or a combination of both. Applies to the bool query constructed.

Declaration

public MinimumShouldMatch MinimumShouldMatch { get; set; }

Property Value

Type	Description
MinimumShouldMatch

Operator

The operator used if no explicit operator is specified. The default operator is Or. Applies to the bool query constructed.

Declaration

public Operator? Operator { get; set; }

Property Value

Type	Description
Operator?

PrefixLength

Set the prefix length for fuzzy queries. Default is 0. Applies only to the term sub queries constructed, and not the prefix query for the final term.

Declaration

public int? PrefixLength { get; set; }

Property Value

Type	Description
int?

Query

The query

Declaration

public string Query { get; set; }

Property Value

Type	Description
string

Implements

IMatchBoolPrefixQuery

IFieldNameQuery

IQuery

Extension Methods

SuffixExtensions.Suffix(object, string)