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 SourceAnalyzer
The analyzer name used to analyze the query
Declaration
[DataMember(Name = "analyzer")]
string Analyzer { get; set; }
Property Value
Type | Description |
---|---|
string |
AutoGenerateSynonymsPhraseQuery
Declaration
[DataMember(Name = "auto_generate_synonyms_phrase_query")]
bool? AutoGenerateSynonymsPhraseQuery { get; set; }
Property Value
Type | Description |
---|---|
bool? |
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 |
FuzzyRewrite
Controls how the query is rewritten if Fuzziness is set.
In this scenario, the default is Top
Declaration
[DataMember(Name = "fuzzy_rewrite")]
MultiTermQueryRewrite FuzzyRewrite { get; set; }
Property Value
Type | Description |
---|---|
Multi |
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? |
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? |
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? |
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 |
---|---|
Minimum |
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? |
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? |
Query
The query to execute
Declaration
[DataMember(Name = "query")]
string Query { get; set; }
Property Value
Type | Description |
---|---|
string |
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, Zero
Declaration
[DataMember(Name = "zero_terms_query")]
ZeroTermsQuery? ZeroTermsQuery { get; set; }
Property Value
Type | Description |
---|---|
Zero |