Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/esql/functions/description/match.asciidoc

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/reference/esql/functions/kibana/definition/match.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/reference/esql/functions/kibana/docs/match.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 3 additions & 1 deletion docs/reference/mapping/types/semantic-text.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ If you don’t specify an inference endpoint, the `inference_id` field defaults

Using `semantic_text`, you won't need to specify how to generate embeddings for your data, or how to index it.
The {infer} endpoint automatically determines the embedding generation, indexing, and query to use.
Newly created indices with `semantic_text` fields using dense embeddings will be <<dense-vector-quantization,quantized>> to `bbq_hnsw` automatically.

If you use the preconfigured `.elser-2-elasticsearch` endpoint, you can set up `semantic_text` with the following API request:

Expand Down Expand Up @@ -225,7 +226,8 @@ In these cases - when you use `sparse_vector` or `dense_vector` field types inst
For indices containing `semantic_text` fields, updates that use scripts have the following behavior:

* Are supported through the https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update[Update API].
* Are not supported through the https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk-1[Bulk API] and will fail. Even if the script targets non-`semantic_text` fields, the update will fail when the index contains a `semantic_text` field.
* Are not supported through the https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk-1[Bulk API] and will fail.
Even if the script targets non-`semantic_text` fields, the update will fail when the index contains a `semantic_text` field.

[discrete]
[[copy-to-support]]
Expand Down
125 changes: 61 additions & 64 deletions docs/reference/query-dsl/match-query.asciidoc
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
[[query-dsl-match-query]]
=== Match query

++++
<titleabbrev>Match</titleabbrev>
++++

Returns documents that match a provided text, number, date or boolean value. The
provided text is analyzed before matching.

The `match` query is the standard query for performing a full-text search,
including options for fuzzy matching.
Returns documents that match a provided text, number, date or boolean value.
The provided text is analyzed before matching.

`Match` will also work against <<semantic-text, semantic_text>> fields,
however when performing `match` queries against `semantic_text` fields options
that specifically target lexical search such as `fuzziness` or `analyzer` will be ignored.
The `match` query is the standard query for performing a full-text search, including options for fuzzy matching.

`Match` will also work against <<semantic-text, semantic_text>> fields.
As `semantic_text` does not support lexical text search, `match` queries against `semantic_text` fields will automatically perform the correct semantic search.
Because of this, options that specifically target lexical search such as `fuzziness` or `analyzer` will be ignored.

[[match-query-ex-request]]
==== Example request
Expand All @@ -32,85 +31,89 @@ GET /_search
}
--------------------------------------------------


[[match-top-level-params]]
==== Top-level parameters for `match`

`<field>`::
(Required, object) Field you wish to search.


[[match-field-params]]
==== Parameters for `<field>`

`query`::
+
--
(Required) Text, number, boolean value or date you wish to find in the provided
`<field>`.

The `match` query <<analysis,analyzes>> any provided text before performing a
search. This means the `match` query can search <<text,`text`>> fields for
analyzed tokens rather than an exact term.
The `match` query <<analysis,analyzes>> any provided text before performing a search.
This means the `match` query can search <<text,`text`>> fields for analyzed tokens rather than an exact term.
--

`analyzer`::
(Optional, string) <<analysis,Analyzer>> used to convert the text in the `query`
value into tokens. Defaults to the <<specify-index-time-analyzer,index-time
analyzer>> mapped for the `<field>`. If no analyzer is mapped, the index's
default analyzer is used.
value into tokens.
Defaults to the <<specify-index-time-analyzer,index-time analyzer>> mapped for the `<field>`.
If no analyzer is mapped, the index's default analyzer is used.

`auto_generate_synonyms_phrase_query`::
+
--
(Optional, Boolean) If `true`, <<query-dsl-match-query-phrase,match phrase>>
queries are automatically created for multi-term synonyms. Defaults to `true`.
queries are automatically created for multi-term synonyms.
Defaults to `true`.

See <<query-dsl-match-query-synonyms,Use synonyms with match query>> for an
example.
See <<query-dsl-match-query-synonyms,Use synonyms with match query>> for an example.
--

`boost`::
+
--
(Optional, float) Floating point number used to decrease or increase the
<<relevance-scores,relevance scores>> of the query. Defaults to `1.0`.
<<relevance-scores,relevance scores>> of the query.
Defaults to `1.0`.

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`
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.
--

`fuzziness`::
(Optional, string) Maximum edit distance allowed for matching. See <<fuzziness>>
for valid values and more information. See <<query-dsl-match-query-fuzziness>>
(Optional, string) Maximum edit distance allowed for matching.
See <<fuzziness>>
for valid values and more information.
See <<query-dsl-match-query-fuzziness>>
for an example.

`max_expansions`::
(Optional, integer) Maximum number of terms to which the query will
expand. Defaults to `50`.
(Optional, integer) Maximum number of terms to which the query will expand.
Defaults to `50`.

`prefix_length`::
(Optional, integer) Number of beginning characters left unchanged for fuzzy
matching. Defaults to `0`.
(Optional, integer) Number of beginning characters left unchanged for fuzzy matching.
Defaults to `0`.

`fuzzy_transpositions`::
(Optional, Boolean) If `true`, edits for fuzzy matching include
transpositions of two adjacent characters (ab → ba). Defaults to `true`.
(Optional, Boolean) If `true`, edits for fuzzy matching include transpositions of two adjacent characters (ab → ba).
Defaults to `true`.

`fuzzy_rewrite`::
+
--
(Optional, string) Method used to rewrite the query. See the
<<query-dsl-multi-term-rewrite, `rewrite` parameter>> for valid values and more
information.
(Optional, string) Method used to rewrite the query.
See the
<<query-dsl-multi-term-rewrite, `rewrite` parameter>> for valid values and more information.

If the `fuzziness` parameter is not `0`, the `match` query uses a `fuzzy_rewrite`
method of `top_terms_blended_freqs_${max_expansions}` by default.
--

`lenient`::
(Optional, Boolean) If `true`, format-based errors, such as providing a text
`query` value for a <<number,numeric>> field, are ignored. Defaults to `false`.
`query` value for a <<number,numeric>> field, are ignored.
Defaults to `false`.

`operator`::
+
Expand All @@ -130,16 +133,17 @@ AND of AND Hungary`.
`minimum_should_match`::
+
--
(Optional, string) Minimum number of clauses that must match for a document to
be returned. See the <<query-dsl-minimum-should-match, `minimum_should_match`
(Optional, string) Minimum number of clauses that must match for a document to be returned.
See the <<query-dsl-minimum-should-match, `minimum_should_match`
parameter>> for valid values and more information.
--

`zero_terms_query`::
+
--
(Optional, string) Indicates whether no documents are returned if the `analyzer`
removes all tokens, such as when using a `stop` filter. Valid values are:
removes all tokens, such as when using a `stop` filter.
Valid values are:

`none` (Default)::
No documents are returned if the `analyzer` removes all tokens.
Expand All @@ -151,15 +155,15 @@ query.
See <<query-dsl-match-query-zero>> for an example.
--


[[match-query-notes]]
==== Notes

[[query-dsl-match-query-short-ex]]
===== Short request example

You can simplify the match query syntax by combining the `<field>` and `query`
parameters. For example:
parameters.
For example:

[source,console]
----
Expand All @@ -176,11 +180,11 @@ GET /_search
[[query-dsl-match-query-boolean]]
===== How the match query works

The `match` query is of type `boolean`. It means that the text
provided is analyzed and the analysis process constructs a boolean query
from the provided text. The `operator` parameter can be set to `or` or `and`
to control the boolean clauses (defaults to `or`). The minimum number of
optional `should` clauses to match can be set using the
The `match` query is of type `boolean`.
It means that the text provided is analyzed and the analysis process constructs a boolean query from the provided text.
The `operator` parameter can be set to `or` or `and`
to control the boolean clauses (defaults to `or`).
The minimum number of optional `should` clauses to match can be set using the
<<query-dsl-minimum-should-match,`minimum_should_match`>>
parameter.

Expand All @@ -201,13 +205,11 @@ GET /_search
}
--------------------------------------------------

The `analyzer` can be set to control which analyzer will perform the
analysis process on the text. It defaults to the field explicit mapping
definition, or the default search analyzer.
The `analyzer` can be set to control which analyzer will perform the analysis process on the text.
It defaults to the field explicit mapping definition, or the default search analyzer.

The `lenient` parameter can be set to `true` to ignore exceptions caused by
data-type mismatches, such as trying to query a numeric field with a text
query string. Defaults to `false`.
The `lenient` parameter can be set to `true` to ignore exceptions caused by data-type mismatches, such as trying to query a numeric field with a text query string.
Defaults to `false`.

[[query-dsl-match-query-fuzziness]]
===== Fuzziness in the match query
Expand All @@ -218,17 +220,12 @@ See <<fuzziness>> for allowed settings.
The `prefix_length` and
`max_expansions` can be set in this case to control the fuzzy process.
If the fuzzy option is set the query will use `top_terms_blended_freqs_${max_expansions}`
as its <<query-dsl-multi-term-rewrite,rewrite
method>> the `fuzzy_rewrite` parameter allows to control how the query will get
rewritten.
as its <<query-dsl-multi-term-rewrite,rewrite method>> the `fuzzy_rewrite` parameter allows to control how the query will get rewritten.

Fuzzy transpositions (`ab` -> `ba`) are allowed by default but can be disabled
by setting `fuzzy_transpositions` to `false`.
Fuzzy transpositions (`ab` -> `ba`) are allowed by default but can be disabled by setting `fuzzy_transpositions` to `false`.

NOTE: Fuzzy matching is not applied to terms with synonyms or in cases where the
analysis process produces multiple tokens at the same position. Under the hood
these terms are expanded to a special synonym query that blends term frequencies,
which does not support fuzzy expansion.
NOTE: Fuzzy matching is not applied to terms with synonyms or in cases where the analysis process produces multiple tokens at the same position.
Under the hood these terms are expanded to a special synonym query that blends term frequencies, which does not support fuzzy expansion.

[source,console]
--------------------------------------------------
Expand All @@ -247,9 +244,9 @@ GET /_search

[[query-dsl-match-query-zero]]
===== Zero terms query
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 the `zero_terms_query` option can be used, which accepts

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 the `zero_terms_query` option can be used, which accepts
`none` (default) and `all` which corresponds to a `match_all` query.

[source,console]
Expand All @@ -271,8 +268,8 @@ GET /_search
[[query-dsl-match-query-synonyms]]
===== Synonyms

The `match` query supports multi-terms synonym expansion with the <<analysis-synonym-graph-tokenfilter,
synonym_graph>> token filter. When this filter is used, the parser creates a phrase query for each multi-terms synonyms.
The `match` query supports multi-terms synonym expansion with the <<analysis-synonym-graph-tokenfilter, synonym_graph>> token filter.
When this filter is used, the parser creates a phrase query for each multi-terms synonyms.
For example, the following synonym: `"ny, new york"` would produce:

`(ny OR ("new york"))`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ public class Match extends FullTextFunction implements OptionalArgument, PostAna

Match can be used on fields from the text family like <<text, text>> and <<semantic-text, semantic_text>>,
as well as other field types like keyword, boolean, dates, and numeric types.
When Match is used on a <<semantic-text, semantic_text>> field, it will perform a semantic query on the field.

Match can use <<esql-function-named-params,function named parameters>> to specify additional options for the match query.
All <<match-field-params,match query parameters>> are supported.
Expand Down