Query
Description
An Elasticsearch Query DSL (Domain Specific Language) object that defines a query.
Read the reference documentationProperties
-
boolobject -
matches documents matching boolean combinations of other queries.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
filteroneOf -
The clause (query) must appear in matching documents. However, unlike
must, the score of the query will be ignored. -
minimum_should_matchnumber | string -
Specifies the number or percentage of
shouldclauses returned documents must match. -
boostingobject -
Returns documents matching a
positivequery while reducing the relevance score of documents that also match anegativequery. -
combined_fieldsobject -
The
combined_fieldsquery supports searching multiple text fields as if their contents had been indexed into one combined field. -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
fieldsstringrequired -
List of fields to search. Field wildcard patterns are allowed. Only
textfields are supported, and they must all have the same searchanalyzer. -
querystringrequired -
Text to search for in the provided
fields. Thecombined_fieldsquery analyzes the provided text before performing a search. -
auto_generate_synonyms_phrase_queryboolean · default: true -
If true, match phrase queries are automatically created for multi-term synonyms.
-
minimum_should_matchnumber | string -
Minimum number of clauses that must match for a document to be returned.
-
zero_terms_query· default: none -
Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a
stopfilter.Supported values include:
none: No documents are returned if the analyzer removes all tokens.all: Returns all documents, similar to amatch_allquery.
-
Values:
noneall -
constant_scoreobject -
Wraps a filter query and returns every matching document with a relevance score equal to the
boostparameter value. -
dense_vectorobject -
Scores every document that has a value for a
dense_vectorfield, with the exact similarity between its vector and a query vector. Unlike theknnquery, it doesn't use an index structure, or a cutoff based onkornum_candidates. -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
fieldstringrequired -
The name of the
dense_vectorfield to search against. The field can be indexed, or not indexed (index: false). -
query_vectoroneOf -
The query vector. It must have the same number of dimensions as the field. You must provide either
query_vectororquery_vector_builder, but not both. -
query_vector_builderobject -
The configuration to build the query vector, for example by running a text embedding model. You must provide either
query_vectororquery_vector_builder, but not both. -
similarity_function -
The similarity used for scoring, which overrides the similarity of the field for this query. It defaults to the similarity of the field, or to
cosinefor a field that is not indexed. Forbitfields, onlyl2_normis supported. It can't be combined withquantized: true.Supported values include:
cosine: Computes the cosine similarity. During indexing Elasticsearch automatically normalizes vectors withcosinesimilarity to unit length. This allows to internally usedot_productfor computing similarity, which is more efficient. Original un-normalized vectors can be still accessed through scripts.
The document
_scoreis computed as(1 + cosine(query, vector)) / 2.The
cosinesimilarity does not allow vectors with zero magnitude, since cosine is not defined in this case.dot_product: Computes the dot product of two unit vectors. This option provides an optimized way to perform cosine similarity. The constraints and computed score are defined byelement_type.
When
element_typeisfloat, all vectors must be unit length, including both document and query vectors.The document
_scoreis computed as(1 + dot_product(query, vector)) / 2.When
element_typeisbyte, all vectors must have the same length including both document and query vectors or results will be inaccurate.The document
_scoreis computed as0.5 + (dot_product(query, vector) / (32768 * dims))wheredimsis the number of dimensions per vector.l2_norm: Computes similarity based on theL2distance (also known as Euclidean distance) between the vectors.
The document
_scoreis computed as1 / (1 + l2_norm(query, vector)^2).For
bitvectors, instead of usingl2_norm, thehammingdistance between the vectors is used.The
_scoretransformation is(numBits - hamming(a, b)) / numBits.max_inner_product: Computes the maximum inner product of two vectors. This is similar todot_product, but doesn't require vectors to be normalized. This means that each vector’s magnitude can significantly effect the score.
The document
_scoreis adjusted to prevent negative values. Formax_inner_productvalues< 0, the_scoreis1 / (1 + -1 * max_inner_product(query, vector)). For non-negativemax_inner_productresults the_scoreis calculatedmax_inner_product(query, vector) + 1. -
Values:
cosinedot_productl2_normmax_inner_product -
quantizedboolean · default: false -
If
false, the documents are scored with the full-precision vectors, regardless of the index options of the field. Iftrue, the documents are scored with the quantized vectors of a quantized field, which is faster but less accurate. For a field that is not quantized,truehas no effect. -
dis_maxobject -
Returns documents matching one or more wrapped queries, called query clauses or clauses. If a returned document matches multiple query clauses, the
dis_maxquery assigns the document the highest relevance score from any matching clause, plus a tie breaking increment for any additional matching subqueries. -
distance_featureoneOf -
Boosts the relevance score of documents closer to a provided origin date or point. For example, you can use this query to give more weight to documents closer to a certain date or location.
-
function_scoreobject -
The
function_scoreenables you to modify the score of documents that are retrieved by a query. -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
boost_mode· default: multiply -
Defines how he newly computed score is combined with the score of the query
Supported values include:
multiply: Query score and function score are multipliedreplace: Only the function score is used. The query score is ignored.sum: Query score and function score are addedavg: Query score and function score are averagedmax: Max of query score and function scoremin: Min of query score and function score
-
Values:
multiplyreplacesumavgmaxmin -
functionsobject -
One or more functions that compute a new score for each document returned by the query.
-
exponeOf -
Function that scores a document with a exponential decay, depending on the distance of a numeric field value of the document from an origin.
-
gaussoneOf -
Function that scores a document with a normal decay, depending on the distance of a numeric field value of the document from an origin.
-
linearoneOf -
Function that scores a document with a linear decay, depending on the distance of a numeric field value of the document from an origin.
-
field_value_factorobject -
Function allows you to use a field from a document to influence the score. It’s similar to using the script_score function, however, it avoids the overhead of scripting.
-
missingnumber -
Value used if the document doesn’t have that field. The modifier and factor are still applied to it as though it were read from the document.
-
modifier -
Modifier to apply to the field value.
Supported values include:
none: Do not apply any multiplier to the field value.log: Take the common logarithm of the field value. Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to uselog1pinstead.log1p: Add 1 to the field value and take the common logarithm.log2p: Add 2 to the field value and take the common logarithm.ln: Take the natural logarithm of the field value. Because this function will return a negative value and cause an error if used on values between 0 and 1, it is recommended to useln1pinstead.ln1p: Add 1 to the field value and take the natural logarithm.ln2p: Add 2 to the field value and take the natural logarithm.square: Square the field value (multiply it by itself).sqrt: Take the square root of the field value.reciprocal: Reciprocate the field value, same as1/xwherexis the field’s value.
-
Values:
noneloglog1plog2plnln1pln2psquaresqrtreciprocal -
score_mode· default: multiply -
Specifies how the computed scores are combined
Supported values include:
multiply: Scores are multiplied.sum: Scores are summed.avg: Scores are averaged.first: The first function that has a matching filter is applied.max: Maximum score is used.min: Minimum score is used.
-
Values:
multiplysumavgfirstmaxmin -
fuzzymap string to object · min properties: 1 · max properties: 1 -
Returns documents that contain terms similar to the search term, as measured by a Levenshtein edit distance.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
prefix_lengthnumber · default: 0 -
Number of beginning characters left unchanged when creating expansions.
-
rewritestring · default: constant_score -
Number of beginning characters left unchanged when creating expansions.
-
geo_bounding_boxobject -
Matches geo_point and geo_shape values that intersect a bounding box.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
validation_method· default: 'strict' -
Set to
IGNORE_MALFORMEDto accept geo points with invalid latitude or longitude. Set toCOERCEto also try to infer correct latitude or longitude.Supported values include:
coerce: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.ignore_malformed: Accept geo points with invalid latitude or longitude.strict
-
Values:
coerceignore_malformedstrict -
geo_distanceobject -
Matches
geo_pointandgeo_shapevalues within a given distance of a geopoint. -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distancestringrequired -
The radius of the circle centred on the specified location. Points which fall into this circle are considered to be matches.
-
distance_type· default: 'arc' -
How to compute the distance. Set to
planefor a faster calculation that's inaccurate on long distances and close to the poles.Supported values include:
arc: Thearccalculation is the most accurate.plane: Theplanecalculation is faster but less accurate.
-
Values:
arcplane -
validation_method· default: 'strict' -
Set to
IGNORE_MALFORMEDto accept geo points with invalid latitude or longitude. Set toCOERCEto also try to infer correct latitude or longitude.Supported values include:
coerce: Accept geo points with invalid latitude or longitude and additionally try and infer correct coordinates.ignore_malformed: Accept geo points with invalid latitude or longitude.strict
-
Values:
coerceignore_malformedstrict -
geo_gridmap string to object · min properties: 1 · max properties: 1 -
Matches
geo_pointandgeo_shapevalues that intersect a grid cell from a GeoGrid aggregation. -
<string>object -
geo_polygonobject -
has_childobject -
Returns parent documents whose joined child documents match a provided query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
ignore_unmappedboolean · default: false -
Indicates whether to ignore an unmapped
typeand not return any documents instead of an error. -
inner_hitsobject -
If defined, each search hit will contain inner hits.
-
namestring -
The name for the particular inner hit definition in the response. Useful when a search request contains multiple inner hits.
-
highlightobject -
typeanyOf -
Supported values include:
plain: Theplainhighlighter uses the standard Lucene highlighterfvh: The fvh highlighter uses the Lucene Fast Vector highlighter.unified: The unified highlighter uses the Lucene Unified Highlighter.
-
Values:
plainfvhunified -
boundary_scanner -
Specifies how to break the highlighted fragments: chars, sentence, or word. Only valid for the unified and fvh highlighters. Defaults to
sentencefor theunifiedhighlighter. Defaults tocharsfor thefvhhighlighter.Supported values include:
chars: Use the characters specified byboundary_charsas highlighting boundaries. Theboundary_max_scansetting controls how far to scan for boundary characters. Only valid for thefvhhighlighter.sentence: Break highlighted fragments at the next sentence boundary, as determined by Java’sBreakIterator. You can specify the locale to use withboundary_scanner_locale. When used with theunifiedhighlighter, thesentencescanner splits sentences bigger thanfragment_sizeat the first word boundary next to fragment_size. You can setfragment_sizeto0to never split any sentence.word: Break highlighted fragments at the next word boundary, as determined by Java’sBreakIterator. You can specify the locale to use withboundary_scanner_locale.
-
Values:
charssentenceword -
boundary_scanner_localestring · default: Locale.ROOT -
Controls which locale is used to search for sentence and word boundaries. This parameter takes a form of a language tag, for example:
"en-US","fr-FR","ja-JP". -
fragmenter· default: span -
Specifies how text should be broken up in highlight snippets:
simpleorspan. Only valid for theplainhighlighter. -
Values:
simplespan -
highlight_queryQuery -
Highlight matches for a query other than the search query. This is especially useful if you use a rescore query because those are not taken into account by highlighting by default.
-
max_analyzed_offsetnumber -
If set to a non-negative value, highlighting stops at this defined maximum limit. The rest of the text is not processed, thus not highlighted and no error is returned The
max_analyzed_offsetquery setting does not override theindex.highlight.max_analyzed_offsetsetting, which prevails when it’s set to lower value than the query setting. -
no_match_sizenumber · default: 0 -
The amount of text you want to return from the beginning of the field if there are no matching fragments to highlight.
-
number_of_fragmentsnumber · default: 5 -
The maximum number of fragments to return. If the number of fragments is set to
0, no fragments are returned. Instead, the entire field contents are highlighted and returned. This can be handy when you need to highlight short texts such as a title or address, but fragmentation is not required. Ifnumber_of_fragmentsis0,fragment_sizeis ignored. -
order· default: none -
Sorts highlighted fragments by score when set to
score. By default, fragments will be output in the order they appear in the field (order:none). Setting this option toscorewill output the most relevant fragments first. Each highlighter applies its own logic to compute relevancy scores. -
Values:
score -
phrase_limitnumber · default: 256 -
Controls the number of matching phrases in a document that are considered. Prevents the
fvhhighlighter from analyzing too many phrases and consuming too much memory. When usingmatched_fields,phrase_limitphrases per matched field are considered. Raising the limit increases query time and consumes more memory. Only supported by thefvhhighlighter. -
Use in conjunction with
pre_tagsto define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in<em>and</em>tags. -
Use in conjunction with
post_tagsto define the HTML tags to use for the highlighted text. By default, highlighted text is wrapped in<em>and</em>tags. -
require_field_matchboolean · default: true -
By default, only fields that contains a query match are highlighted. Set to
falseto highlight all fields. -
Set to
styledto use the built-in tag schema. -
Values:
styled -
max_childrennumber -
Maximum number of child documents that match the query allowed for a returned parent document. If the parent document exceeds this limit, it is excluded from the search results.
-
min_childrennumber -
Minimum number of child documents that match the query required to match the query for a returned parent document. If the parent document does not meet this limit, it is excluded from the search results.
-
queryQueryrequired -
Query you wish to run on child documents of the
typefield. If a child document matches the search, the query returns the parent document. -
has_parentobject -
Returns child documents whose joined parent document matches a provided query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
ignore_unmappedboolean · default: false -
Indicates whether to ignore an unmapped
parent_typeand not return any documents instead of an error. You can use this parameter to query multiple indices that may not contain theparent_type. -
idsobject -
Returns documents based on their IDs. This query uses document IDs stored in the
_idfield. -
intervalsmap string to object · min properties: 1 · max properties: 1 -
Returns documents based on the order and proximity of matching terms.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
all_ofobject -
Returns matches that span a combination of other rules.
-
intervalsobjectrequired -
An array of rules to combine. All rules must produce a match in a document for the overall source to match.
-
any_ofobject -
Returns intervals produced by any of its sub-rules.
-
filterobject -
Rule used to filter returned intervals.
-
not_contained_byobject -
Query used to return intervals that are not contained by an interval from the
filterrule. -
not_containingobject -
Query used to return intervals that do not contain an interval from the
filterrule. -
not_overlappingobject -
Query used to return intervals that do not overlap with an interval from the
filterrule. -
matchobject -
Matches analyzed text.
-
max_gapsnumber · default: -1 -
Maximum number of positions between the matching terms. Terms further apart than this are not considered matches.
-
use_fieldstring -
If specified, match intervals from this field rather than the top-level field. The
termis normalized using the search analyzer from this field, unlessanalyzeris specified separately. -
filterobject -
An optional interval filter.
-
not_contained_byobject -
Query used to return intervals that are not contained by an interval from the
filterrule. -
not_containingobject -
Query used to return intervals that do not contain an interval from the
filterrule. -
not_overlappingobject -
Query used to return intervals that do not overlap with an interval from the
filterrule. -
max_gapsnumber · default: -1 -
Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches.
-
orderedboolean · default: false -
If
true, intervals produced by the rules should appear in the order in which they are specified. -
filterobject -
Rule used to filter returned intervals.
-
afterobject -
Query used to return intervals that follow an interval from the
filterrule. -
not_contained_byobject -
Query used to return intervals that are not contained by an interval from the
filterrule. -
not_containingobject -
Query used to return intervals that do not contain an interval from the
filterrule. -
not_overlappingobject -
Query used to return intervals that do not overlap with an interval from the
filterrule. -
any_ofobject -
Returns intervals produced by any of its sub-rules.
-
intervalsobjectrequired -
An array of rules to match.
-
all_ofobject -
Returns matches that span a combination of other rules.
-
intervalsobjectrequired -
An array of rules to combine. All rules must produce a match in a document for the overall source to match.
-
max_gapsnumber · default: -1 -
Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches.
-
orderedboolean · default: false -
If
true, intervals produced by the rules should appear in the order in which they are specified. -
filterobject -
Rule used to filter returned intervals.
-
not_contained_byobject -
Query used to return intervals that are not contained by an interval from the
filterrule. -
not_containingobject -
Query used to return intervals that do not contain an interval from the
filterrule. -
not_overlappingobject -
Query used to return intervals that do not overlap with an interval from the
filterrule. -
filterobject -
Rule used to filter returned intervals.
-
afterobject -
Query used to return intervals that follow an interval from the
filterrule. -
all_ofobject -
Returns matches that span a combination of other rules.
-
intervalsobjectrequired -
An array of rules to combine. All rules must produce a match in a document for the overall source to match.
-
max_gapsnumber · default: -1 -
Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches.
-
matchobject -
Matches analyzed text.
-
not_contained_byobject -
Query used to return intervals that are not contained by an interval from the
filterrule. -
not_containingobject -
Query used to return intervals that do not contain an interval from the
filterrule. -
not_overlappingobject -
Query used to return intervals that do not overlap with an interval from the
filterrule. -
fuzzyobject -
Matches terms that are similar to the provided term, within an edit distance defined by
fuzziness. -
matchobject -
Matches analyzed text.
-
max_gapsnumber · default: -1 -
Maximum number of positions between the matching terms. Terms further apart than this are not considered matches.
-
use_fieldstring -
If specified, match intervals from this field rather than the top-level field. The
termis normalized using the search analyzer from this field, unlessanalyzeris specified separately. -
filterobject -
An optional interval filter.
-
afterobject -
Query used to return intervals that follow an interval from the
filterrule. -
all_ofobject -
Returns matches that span a combination of other rules.
-
intervalsobjectrequired -
An array of rules to combine. All rules must produce a match in a document for the overall source to match.
-
max_gapsnumber · default: -1 -
Maximum number of positions between the matching terms. Intervals produced by the rules further apart than this are not considered matches.
-
not_contained_byobject -
Query used to return intervals that are not contained by an interval from the
filterrule. -
not_containingobject -
Query used to return intervals that do not contain an interval from the
filterrule. -
not_overlappingobject -
Query used to return intervals that do not overlap with an interval from the
filterrule. -
knnobject -
Finds the k nearest vectors to a query vector, as measured by a similarity metric. knn query finds nearest vectors through approximate search on indexed dense_vectors.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
query_vector_builderobject -
The query vector builder. You must provide a query_vector_builder or query_vector, but not both.
-
kqlobject -
Returns documents matching a provided Kibana Query Language (KQL) expression. The expression is parsed and rewritten into standard Query DSL.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
case_insensitiveboolean · default: false -
If
true, performs case-insensitive matching for field names and keyword or text terms. -
matchmap string to object · min properties: 1 · max properties: 1 -
Returns documents that match a provided text, number, date or boolean value. The provided text is analyzed before matching.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
auto_generate_synonyms_phrase_queryboolean · default: true -
If
true, match phrase queries are automatically created for multi-term synonyms. -
fuzzy_transpositionsboolean · default: true -
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). -
lenientboolean · default: false -
If
true, format-based errors, such as providing a text query value for a numeric field, are ignored. -
minimum_should_matchnumber | string -
Minimum number of clauses that must match for a document to be returned.
-
operator· default: 'or' -
Boolean logic used to interpret text in the query value.
-
Values:
andANDorOR -
queryboolean | number | stringrequired -
Text, number, boolean value or date you wish to find in the provided field.
-
zero_terms_query· default: 'none' -
Indicates whether no documents are returned if the
analyzerremoves all tokens, such as when using astopfilter.Supported values include:
all: Returns all documents, similar to amatch_allquery.none: No documents are returned if theanalyzerremoves all tokens.
-
Values:
allnone -
match_bool_prefixmap string to object · min properties: 1 · max properties: 1 -
Analyzes its input and constructs a
boolquery from the terms. Each term except the last is used in atermquery. The last term is used in a prefix query. -
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
fuzzinessnumber | string -
Maximum edit distance allowed for matching. Can be applied to the term subqueries constructed for all terms but the final term.
-
fuzzy_rewritestring -
Method used to rewrite the query. Can be applied to the term subqueries constructed for all terms but the final term.
-
fuzzy_transpositionsboolean · default: true -
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). Can be applied to the term subqueries constructed for all terms but the final term. -
max_expansionsnumber · default: 50 -
Maximum number of terms to which the query will expand. Can be applied to the term subqueries constructed for all terms but the final term.
-
minimum_should_matchnumber | string -
Minimum number of clauses that must match for a document to be returned. Applied to the constructed bool query.
-
operator· default: 'or' -
Boolean logic used to interpret text in the query value. Applied to the constructed bool query.
-
Values:
andANDorOR -
match_phrasemap string to object · min properties: 1 · max properties: 1 -
Analyzes the text and creates a phrase query out of the analyzed text.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
zero_terms_query· default: 'none' -
Indicates whether no documents are returned if the
analyzerremoves all tokens, such as when using astopfilter.Supported values include:
all: Returns all documents, similar to amatch_allquery.none: No documents are returned if theanalyzerremoves all tokens.
-
Values:
allnone -
match_phrase_prefixmap string to object · min properties: 1 · max properties: 1 -
Returns documents that contain the words of a provided text, in the same order as provided. The last term of the provided text is treated as a prefix, matching any words that begin with that term.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
max_expansionsnumber · default: 50 -
Maximum number of terms to which the last provided term of the query value will expand.
-
zero_terms_query· default: none -
Indicates whether no documents are returned if the analyzer removes all tokens, such as when using a
stopfilter.Supported values include:
all: Returns all documents, similar to amatch_allquery.none: No documents are returned if theanalyzerremoves all tokens.
-
Values:
allnone -
more_like_thisobject -
Returns documents that are "like" a given set of documents.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
analyzerstring -
The analyzer that is used to analyze the free form text. Defaults to the analyzer associated with the first field in fields.
-
boost_termsnumber · default: 0 -
Each term in the formed query could be further boosted by their tf-idf score. This sets the boost factor to use when using this feature. Defaults to deactivated (0).
-
fail_on_unsupported_fieldboolean · default: true -
Controls whether the query should fail (throw an exception) if any of the specified fields are not of the supported types (
textorkeyword). -
fieldsstring -
A list of fields to fetch and analyze the text from. Defaults to the
index.query.default_fieldindex setting, which has a default value of*. -
includeboolean · default: false -
Specifies whether the input documents should also be included in the search results returned.
-
likeoneOfrequired -
Specifies free form text and/or a single or multiple documents for which you want to find similar documents.
-
max_doc_freqnumber -
The maximum document frequency above which the terms are ignored from the input document.
-
max_word_lengthnumber · default: 0 -
The maximum word length above which the terms are ignored. Defaults to unbounded (
0). -
min_doc_freqnumber · default: 5 -
The minimum document frequency below which the terms are ignored from the input document.
-
minimum_should_matchnumber | string -
After the disjunctive query has been formed, this parameter controls the number of terms that must match.
-
min_term_freqnumber · default: 2 -
The minimum term frequency below which the terms are ignored from the input document.
-
stop_wordsoneOf -
An array of stop words. Any word in this set is ignored.
-
Values:
_arabic__armenian__basque__bengali__brazilian__bulgarian__catalan__cjk__czech__danish__dutch__english__estonian__finnish__french__galician__german__greek__hindi__hungarian__indonesian__irish__italian__latvian__lithuanian__norwegian__persian__portuguese__romanian__russian__serbian__sorani__spanish__swedish__thai__turkish__none_ -
unlikeoneOf -
Used in combination with
liketo exclude documents that match a set of terms. -
version_type· default: 'internal' -
Supported values include:
internal: Use internal versioning that starts at 1 and increments with each update or delete.external: Only index the document if the specified version is strictly higher than the version of the stored document or if there is no existing document.external_gte: Only index the document if the specified version is equal or higher than the version of the stored document or if there is no existing document. NOTE: Theexternal_gteversion type is meant for special use cases and should be used with care. If used incorrectly, it can result in loss of data.
-
Values:
internalexternalexternal_gte -
multi_matchobject -
Enables you to search for a provided text, number, date or boolean value across multiple fields. The provided text is analyzed before matching.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
auto_generate_synonyms_phrase_queryboolean · default: true -
If
true, match phrase queries are automatically created for multi-term synonyms. -
fieldsoneOf -
The fields to be queried. Defaults to the
index.query.default_fieldindex settings, which in turn defaults to*. -
fuzzy_transpositionsboolean · default: true -
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). Can be applied to the term subqueries constructed for all terms but the final term. -
lenientboolean · default: false -
If
true, format-based errors, such as providing a text query value for a numeric field, are ignored. -
minimum_should_matchnumber | string -
Minimum number of clauses that must match for a document to be returned.
-
operator· default: 'or' -
Boolean logic used to interpret text in the query value.
-
Values:
andANDorOR -
tie_breakernumber · default: 0 -
Determines how scores for each per-term blended query and scores across groups are combined.
-
type· default: 'best_fields' -
How
themulti_match query is executed internally.Supported values include:
best_fields: Finds documents that match any field, but uses the_scorefrom the best field.most_fields: Finds documents that match any field and combines the_scorefrom each field.cross_fields: Treats fields with the same analyzer as though they were one big field. Looks for each word in any field.phrase: Runs amatch_phrasequery on each field and uses the_scorefrom the best field.phrase_prefix: Runs amatch_phrase_prefixquery on each field and uses the_scorefrom the best field.bool_prefix: Creates amatch_bool_prefixquery on each field and combines the_scorefrom each field.
-
Values:
best_fieldsmost_fieldscross_fieldsphrasephrase_prefixbool_prefix -
zero_terms_query· default: 'none' -
Indicates whether no documents are returned if the
analyzerremoves all tokens, such as when using astopfilter.Supported values include:
all: Returns all documents, similar to amatch_allquery.none: No documents are returned if theanalyzerremoves all tokens.
-
Values:
allnone -
nestedobject -
Wraps another query to search nested fields. If an object matches the search, the nested query returns the root parent document.
-
parent_idobject -
Returns child documents joined to a specific parent document.
-
percolateobject -
Matches queries stored in an index.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
fieldstringrequired -
Field that holds the indexed queries. The field must use the
percolatormapping type. -
pinnedobject -
Promotes selected documents to rank higher than those matching a given query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
organicQueryrequired -
Any choice of query used to rank documents which will be ranked below the "pinned" documents.
-
prefixmap string to object · min properties: 1 · max properties: 1 -
Returns documents that contain a specific prefix in a provided field.
-
<string>object -
query_stringobject -
Returns documents based on a provided query string, using a parser with a strict syntax.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
allow_leading_wildcardboolean · default: true -
If
true, the wildcard characters*and?are allowed as the first character of the query string. -
analyze_wildcardboolean · default: false -
If
true, the query attempts to analyze wildcard terms in the query string. -
auto_generate_synonyms_phrase_queryboolean · default: true -
If
true, match phrase queries are automatically created for multi-term synonyms. -
default_fieldstring -
Default field to search if no field is provided in the query string. Supports wildcards (
*). Defaults to theindex.query.default_fieldindex setting, which has a default value of*. -
default_operator· default: 'or' -
Default boolean logic used to interpret text in the query string if no operators are specified.
-
Values:
andANDorOR -
enable_position_incrementsboolean · default: true -
If
true, enable position increments in queries constructed from aquery_stringsearch. -
fuzzy_max_expansionsnumber · default: 50 -
Maximum number of terms to which the query expands for fuzzy matching.
-
fuzzy_prefix_lengthnumber · default: 0 -
Number of beginning characters left unchanged for fuzzy matching.
-
fuzzy_transpositionsboolean · default: true -
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). -
lenientboolean · default: false -
If
true, format-based errors, such as providing a text value for a numeric field, are ignored. -
max_determinized_statesnumber · default: 10000 -
Maximum number of automaton states required for the query.
-
minimum_should_matchnumber | string -
Minimum number of clauses that must match for a document to be returned.
-
phrase_slopnumber · default: 0 -
Maximum number of positions allowed between matching tokens for phrases.
-
quote_analyzerstring -
Analyzer used to convert quoted text in the query string into tokens. For quoted text, this parameter overrides the analyzer specified in the
analyzerparameter. -
quote_field_suffixstring -
Suffix appended to quoted text in the query string. You can use this suffix to use a different analysis method for exact matches.
-
tie_breakernumber -
How to combine the queries generated from the individual search terms in the resulting
dis_maxquery. -
time_zonestring -
Coordinated Universal Time (UTC) offset or IANA time zone used to convert date values in the query string to UTC.
-
type· default: 'best_fields' -
Determines how the query matches and scores documents.
Supported values include:
best_fields: Finds documents that match any field, but uses the_scorefrom the best field.most_fields: Finds documents that match any field and combines the_scorefrom each field.cross_fields: Treats fields with the same analyzer as though they were one big field. Looks for each word in any field.phrase: Runs amatch_phrasequery on each field and uses the_scorefrom the best field.phrase_prefix: Runs amatch_phrase_prefixquery on each field and uses the_scorefrom the best field.bool_prefix: Creates amatch_bool_prefixquery on each field and combines the_scorefrom each field.
-
Values:
best_fieldsmost_fieldscross_fieldsphrasephrase_prefixbool_prefix -
rangemap string to oneOf · min properties: 1 · max properties: 1 -
Returns documents that contain terms within a provided range.
-
<string>oneOf -
rank_featureobject -
Boosts the relevance score of documents based on the numeric value of a
rank_featureorrank_featuresfield. -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
saturationobject -
Saturation function used to boost relevance scores based on the value of the rank feature
field. -
logobject -
Logarithmic function used to boost relevance scores based on the value of the rank feature
field. -
regexpmap string to object · min properties: 1 · max properties: 1 -
Returns documents that contain terms matching a regular expression.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
case_insensitiveboolean · default: false -
Allows case insensitive matching of the regular expression value with the indexed field values when set to
true. Whenfalse, case sensitivity of matching depends on the underlying field’s mapping. -
scriptobject -
Filters documents based on a provided script. The script query is typically used in a filter context.
-
script_scoreobject -
Uses a script to provide a custom score for returned documents.
-
simple_query_stringobject -
Returns documents based on a provided query string, using a parser with a limited but fault-tolerant syntax.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
analyze_wildcardboolean · default: false -
If
true, the query attempts to analyze wildcard terms in the query string. -
auto_generate_synonyms_phrase_queryboolean · default: true -
If
true, the parser creates a match_phrase query for each multi-position token. -
default_operator· default: 'or' -
Default boolean logic used to interpret text in the query string if no operators are specified.
-
Values:
andANDorOR -
fieldsstring -
Array of fields you wish to search. Accepts wildcard expressions. You also can boost relevance scores for matches to particular fields using a caret (
^) notation. Defaults to theindex.query.default_field indexsetting, which has a default value of*. -
flags· default: ALL -
List of enabled operators for the simple query string syntax.
-
Values:
NONEANDNOTORPREFIXPHRASEPRECEDENCEESCAPEWHITESPACEFUZZYNEARSLOPALL -
fuzzy_max_expansionsnumber · default: 50 -
Maximum number of terms to which the query expands for fuzzy matching.
-
fuzzy_prefix_lengthnumber · default: 0 -
Number of beginning characters left unchanged for fuzzy matching.
-
fuzzy_transpositionsboolean -
If
true, edits for fuzzy matching include transpositions of two adjacent characters (for example,abtoba). -
lenientboolean · default: false -
If
true, format-based errors, such as providing a text value for a numeric field, are ignored. -
minimum_should_matchnumber | string -
Minimum number of clauses that must match for a document to be returned.
-
span_containingobject -
Returns matches which enclose another span query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
bigobjectrequired -
Can be any span query. Matching spans from
bigthat contain matches fromlittleare returned. -
span_containingobject -
Accepts a list of span queries, but only returns those spans which also match a second span query.
-
span_firstobject -
Accepts another span query whose matches must appear within the first N positions of the field.
-
span_nearobject -
Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
-
span_notobject -
Wraps another span query, and excludes any documents which match that query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distnumber -
The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both
preandpost. -
span_orobject -
Combines multiple span queries and returns documents which match any of the specified queries.
-
span_termmap string to object · min properties: 1 · max properties: 1 -
The equivalent of the
termquery but for use with other span queries. -
<string>object -
span_withinobject -
The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.
-
span_field_maskingobject -
Wrapper to allow span queries to participate in composite single-field span queries by lying about their search field.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
queryobjectrequired -
span_containingobject -
Accepts a list of span queries, but only returns those spans which also match a second span query.
-
span_firstobject -
Accepts another span query whose matches must appear within the first N positions of the field.
-
span_nearobject -
Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
-
span_notobject -
Wraps another span query, and excludes any documents which match that query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distnumber -
The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both
preandpost. -
span_orobject -
Combines multiple span queries and returns documents which match any of the specified queries.
-
span_termmap string to object · min properties: 1 · max properties: 1 -
The equivalent of the
termquery but for use with other span queries. -
<string>object -
span_withinobject -
The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.
-
span_firstobject -
Matches spans near the beginning of a field.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
matchobjectrequired -
Can be any other span type query.
-
span_containingobject -
Accepts a list of span queries, but only returns those spans which also match a second span query.
-
span_firstobject -
Accepts another span query whose matches must appear within the first N positions of the field.
-
span_nearobject -
Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
-
span_notobject -
Wraps another span query, and excludes any documents which match that query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distnumber -
The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both
preandpost. -
span_orobject -
Combines multiple span queries and returns documents which match any of the specified queries.
-
span_termmap string to object · min properties: 1 · max properties: 1 -
The equivalent of the
termquery but for use with other span queries. -
<string>object -
span_withinobject -
The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.
-
span_multiobject -
Allows you to wrap a multi term query (one of
wildcard,fuzzy,prefix,range, orregexpquery) as aspanquery, so it can be nested. -
span_nearobject -
Matches spans which are near one another. You can specify
slop, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order. -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
clausesobjectrequired -
Array of one or more other span type queries.
-
span_containingobject -
Accepts a list of span queries, but only returns those spans which also match a second span query.
-
span_firstobject -
Accepts another span query whose matches must appear within the first N positions of the field.
-
span_nearobject -
Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
-
span_notobject -
Wraps another span query, and excludes any documents which match that query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distnumber -
The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both
preandpost. -
span_orobject -
Combines multiple span queries and returns documents which match any of the specified queries.
-
span_termmap string to object · min properties: 1 · max properties: 1 -
The equivalent of the
termquery but for use with other span queries. -
<string>object -
span_withinobject -
The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.
-
span_notobject -
Removes matches which overlap with another span query or which are within x tokens before (controlled by the parameter
pre) or y tokens after (controlled by the parameterpost) another span query. -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distnumber -
The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both
preandpost. -
excludeobjectrequired -
Span query whose matches must not overlap those returned.
-
span_containingobject -
Accepts a list of span queries, but only returns those spans which also match a second span query.
-
span_firstobject -
Accepts another span query whose matches must appear within the first N positions of the field.
-
span_nearobject -
Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
-
span_orobject -
Combines multiple span queries and returns documents which match any of the specified queries.
-
span_termmap string to object · min properties: 1 · max properties: 1 -
The equivalent of the
termquery but for use with other span queries. -
<string>object -
span_withinobject -
The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.
-
span_orobject -
Matches the union of its span clauses.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
clausesobjectrequired -
Array of one or more other span type queries.
-
span_containingobject -
Accepts a list of span queries, but only returns those spans which also match a second span query.
-
span_firstobject -
Accepts another span query whose matches must appear within the first N positions of the field.
-
span_nearobject -
Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
-
span_notobject -
Wraps another span query, and excludes any documents which match that query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distnumber -
The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both
preandpost. -
span_orobject -
Combines multiple span queries and returns documents which match any of the specified queries.
-
span_termmap string to object · min properties: 1 · max properties: 1 -
The equivalent of the
termquery but for use with other span queries. -
<string>object -
span_withinobject -
The result from a single span query is returned as long is its span falls within the spans returned by a list of other span queries.
-
span_termmap string to object · min properties: 1 · max properties: 1 -
Matches spans containing a term.
-
<string>object -
span_withinobject -
Returns matches which are enclosed inside another span query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
bigobjectrequired -
Can be any span query. Matching spans from
littlethat are enclosed withinbigare returned. -
span_containingobject -
Accepts a list of span queries, but only returns those spans which also match a second span query.
-
span_firstobject -
Accepts another span query whose matches must appear within the first N positions of the field.
-
span_nearobject -
Accepts multiple span queries whose matches must be within the specified distance of each other, and possibly in the same order.
-
span_notobject -
Wraps another span query, and excludes any documents which match that query.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
distnumber -
The number of tokens from within the include span that can’t have overlap with the exclude span. Equivalent to setting both
preandpost. -
span_orobject -
Combines multiple span queries and returns documents which match any of the specified queries.
-
sparse_vectorobject -
Using input query vectors or a natural language processing model to convert a query into a list of token-weight pairs, queries against a sparse vector field.
-
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
fieldstringrequired -
The name of the field that contains the token-weight pairs to be searched against. This field must be a mapped sparse_vector field.
-
querystring -
The query text you want to use for search. If inference_id is specified, query must also be specified.
-
pruneboolean -
Whether to perform pruning, omitting the non-significant tokens from the query to improve query performance. If prune is true but the pruning_config is not specified, pruning will occur but default values will be used. Default: false
-
pruning_configobject -
Optional pruning configuration. If enabled, this will omit non-significant tokens from the query in order to improve query performance. This is only used if prune is set to true. If prune is set to true but pruning_config is not specified, default values will be used.
-
query_vectormap string to number -
Dictionary of precomputed sparse vectors and their associated weights. Only one of inference_id or query_vector may be supplied in a request.
-
inference_idstring -
The inference ID to use to convert the query text into token-weight pairs. It must be the same inference ID that was used to create the tokens from the input text. Only one of inference_id and query_vector is allowed. If inference_id is specified, query must also be specified. Only one of inference_id or query_vector may be supplied in a request.
-
termmap string to object · min properties: 1 · max properties: 1 -
Returns documents that contain an exact term in a provided field. To return a document, the query term must exactly match the queried field's value, including whitespace and capitalization.
-
<string>object -
termsobject -
Returns documents that contain one or more exact terms in a provided field. To return a document, one or more terms must exactly match a field value, including whitespace and capitalization.
-
terms_setmap string to object · min properties: 1 · max properties: 1 -
Returns documents that contain a minimum number of exact terms in a provided field. To return a document, a required number of terms must exactly match the field values, including whitespace and capitalization.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
minimum_should_matchnumber | string -
Specification describing number of matching terms required to return a document.
-
minimum_should_match_fieldstring -
Numeric field containing the number of matching terms required to return a document.
-
text_expansionmap string to object · min properties: 1 · max properties: 1 -
Uses a natural language processing model to convert the query text into a list of token-weight pairs which are then used in a query against a sparse vector or rank features field.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
pruning_configobject -
Token pruning configurations
-
weighted_tokensmap string to object · min properties: 1 · max properties: 1 -
Supports returning text_expansion query results by sending in precomputed tokens with the query.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
pruning_configobject -
Token pruning configurations
-
wildcardmap string to object · min properties: 1 · max properties: 1 -
Returns documents that contain terms matching a wildcard pattern.
-
<string>object -
boostnumber · default: 1 -
Floating point number used to decrease or increase the relevance scores of the query. Boost values are relative to the default value of 1.0. A boost value between 0 and 1.0 decreases the relevance score. A value greater than 1.0 increases the relevance score.
-
case_insensitiveboolean -
Allows case insensitive matching of the pattern with the indexed field values when set to true. Default is false which means the case sensitivity of matching depends on the underlying field’s mapping.