Interface IMatchQuery

A match query for a single field

Inherited Members
Namespace: OpenSearch.Client
Assembly: OpenSearch.Client.dll
Syntax
public interface IMatchQuery : IFieldNameQuery, IQuery

Properties

| Edit this page View Source

Analyzer

The analyzer name used to analyze the query

Declaration
[DataMember(Name = "analyzer")]
string Analyzer { get; set; }
Property Value
Type Description
string
| Edit this page View Source

AutoGenerateSynonymsPhraseQuery

Declaration
[DataMember(Name = "auto_generate_synonyms_phrase_query")]
bool? AutoGenerateSynonymsPhraseQuery { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Fuzziness

Allows fuzzy matching based on the type of field being queried.

Declaration
[DataMember(Name = "fuzziness")]
IFuzziness Fuzziness { get; set; }
Property Value
Type Description
IFuzziness
| Edit this page View Source

FuzzyRewrite

Controls how the query is rewritten if Fuzziness is set. In this scenario, the default is TopTermsBlendedFreqs(int).

Declaration
[DataMember(Name = "fuzzy_rewrite")]
MultiTermQueryRewrite FuzzyRewrite { get; set; }
Property Value
Type Description
MultiTermQueryRewrite
| Edit this page View Source

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.
Declaration
[DataMember(Name = "fuzzy_transpositions")]
bool? FuzzyTranspositions { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

Lenient

If set to true will cause format based failures (like providing text to a numeric field) to be ignored

Declaration
[DataMember(Name = "lenient")]
bool? Lenient { get; set; }
Property Value
Type Description
bool?
| Edit this page View Source

MaxExpansions

Controls the number of terms fuzzy queries will expand to. Defaults to 50

Declaration
[DataMember(Name = "max_expansions")]
int? MaxExpansions { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

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.

Declaration
[DataMember(Name = "minimum_should_match")]
MinimumShouldMatch MinimumShouldMatch { get; set; }
Property Value
Type Description
MinimumShouldMatch
| Edit this page View Source

Operator

The operator used if no explicit operator is specified. The default operator is Or

Declaration
[DataMember(Name = "operator")]
Operator? Operator { get; set; }
Property Value
Type Description
Operator?
| Edit this page View Source

PrefixLength

Set the prefix length for fuzzy queries. Default is 0.

Declaration
[DataMember(Name = "prefix_length")]
int? PrefixLength { get; set; }
Property Value
Type Description
int?
| Edit this page View Source

Query

The query to execute

Declaration
[DataMember(Name = "query")]
string Query { get; set; }
Property Value
Type Description
string
| Edit this page View Source

ZeroTermsQuery

If the analyzer used removes all tokens in a query like a stop filter does, the default behavior is to match no documents at all. In order to change that, ZeroTermsQuery can be used, which accepts None (default) and All which corresponds to a match_all query.

Declaration
[DataMember(Name = "zero_terms_query")]
ZeroTermsQuery? ZeroTermsQuery { get; set; }
Property Value
Type Description
ZeroTermsQuery?

Extension Methods