Add clarifications to semantic text documentation

Author: kderusso

docs/reference/elasticsearch/mapping-reference/semantic-text.md

@@ -28,7 +28,11 @@ service.
 
 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.
+the embedding generation, indexing, and query to use. Newly created
+`semantic_text`
+indices created in {{es}} with dense embeddings will be
+[quantized](/reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-quantization)
+to `bbq_hnsw` automatically.
 
 If you use the preconfigured `.elser-2-elasticsearch` endpoint, you can set up
 `semantic_text` with the following API request:
@@ -246,10 +250,15 @@ is not supported for querying the field data.
 
 ## Updates to `semantic_text` fields [update-script]
 
-For indices containing `semantic_text` fields, updates that use scripts have the following behavior:
+For indices containing `semantic_text` fields, updates that use scripts have the
+following behavior:
 
-* Are supported through the [Update API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update).
-* Are not supported through the [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk-1) 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 supported through
+  the [Update API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-update).
+* Are not supported through
+  the [Bulk API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-bulk-1)
+  and will fail. Even if the script targets non-`semantic_text` fields, the
+  update will fail when the index contains a `semantic_text` field.
 
 ## `copy_to` and multi-fields support [copy-to-support]
 
@@ -311,4 +320,5 @@ PUT test-index
   of [nested fields](/reference/elasticsearch/mapping-reference/nested.md).
 * `semantic_text` fields can’t currently be set as part
   of [Dynamic templates](docs-content://manage-data/data-store/mapping/dynamic-templates.md).
-* `semantic_text` fields are not supported with Cross-Cluster Search (CCS) or Cross-Cluster Replication (CCR).
+* `semantic_text` fields are not supported with Cross-Cluster Search (CCS) or
+  Cross-Cluster Replication (CCR).

docs/reference/query-languages/query-dsl/query-dsl-match-query.md

@@ -6,12 +6,19 @@ mapped_pages:
 
 # Match query [query-dsl-match-query]
 
+Returns documents that match a provided text, number, date or boolean value. The
+provided text is analyzed before matching.
 
-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.
 
-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](/reference/elasticsearch/mapping-reference/semantic-text.md) fields, however when performing `match` queries against `semantic_text` fields options that specifically target lexical search such as `fuzziness` or `analyzer` will be ignored.
+`Match` will also work
+against [semantic_text](/reference/elasticsearch/mapping-reference/semantic-text.md)
+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.
 
 ## Example request [match-query-ex-request]
 
@@ -28,89 +35,127 @@ GET /_search
 }
 ```
 
-
 ## Top-level parameters for `match` [match-top-level-params]
 
 `<field>`
 :   (Required, object) Field you wish to search.
 
-
 ## Parameters for `<field>` [match-field-params]
 
 `query`
-:   (Required) Text, number, boolean value or date you wish to find in the provided `<field>`.
+:   (Required) Text, number, boolean value or date you wish to find in the
+provided `<field>`.
 
-The `match` query [analyzes](docs-content://manage-data/data-store/text-analysis.md) any provided text before performing a search. This means the `match` query can search [`text`](/reference/elasticsearch/mapping-reference/text.md) fields for analyzed tokens rather than an exact term.
+The `match`
+query [analyzes](docs-content://manage-data/data-store/text-analysis.md) any
+provided text before performing a search. This means the `match` query can
+search [`text`](/reference/elasticsearch/mapping-reference/text.md) fields for
+analyzed tokens rather than an exact term.
 
 
 `analyzer`
-:   (Optional, string) [Analyzer](docs-content://manage-data/data-store/text-analysis.md) used to convert the text in the `query` value into tokens. Defaults to the [index-time analyzer](docs-content://manage-data/data-store/text-analysis/specify-an-analyzer.md#specify-index-time-analyzer) mapped for the `<field>`. If no analyzer is mapped, the index’s default analyzer is used.
+:   (Optional,
+string) [Analyzer](docs-content://manage-data/data-store/text-analysis.md) used
+to convert the text in the `query` value into tokens. Defaults to
+the [index-time analyzer](docs-content://manage-data/data-store/text-analysis/specify-an-analyzer.md#specify-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`, [match phrase](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md) queries are automatically created for multi-term synonyms. Defaults to `true`.
+:   (Optional, Boolean) If
+`true`, [match phrase](/reference/query-languages/query-dsl/query-dsl-match-query-phrase.md)
+queries are automatically created for multi-term synonyms. Defaults to `true`.
 
-See [Use synonyms with match query](#query-dsl-match-query-synonyms) for an example.
+See [Use synonyms with match query](#query-dsl-match-query-synonyms) for an
+example.
 
 
 `boost`
-:   (Optional, float) Floating point number used to decrease or increase the [relevance scores](/reference/query-languages/query-dsl/query-filter-context.md#relevance-scores) of the query. Defaults to `1.0`.
+:   (Optional, float) Floating point number used to decrease or increase
+the [relevance scores](/reference/query-languages/query-dsl/query-filter-context.md#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` increases the relevance score.
+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](/reference/elasticsearch/rest-apis/common-options.md#fuzziness) for valid values and more information. See [Fuzziness in the match query](#query-dsl-match-query-fuzziness) for an example.
+:   (Optional, string) Maximum edit distance allowed for matching.
+See [Fuzziness](/reference/elasticsearch/rest-apis/common-options.md#fuzziness)
+for valid values and more information.
+See [Fuzziness in the match query](#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 [`rewrite` parameter](/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite.md) for valid values and more information.
+:   (Optional, string) Method used to rewrite the query. See the [
+`rewrite` parameter](/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite.md)
+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.
+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 [numeric](/reference/elasticsearch/mapping-reference/number.md) field, are ignored. Defaults to `false`.
+:   (Optional, Boolean) If `true`, format-based errors, such as providing a text
+`query` value for
+a [numeric](/reference/elasticsearch/mapping-reference/number.md) field, are
+ignored. Defaults to `false`.
 
 `operator`
-:   (Optional, string) Boolean logic used to interpret text in the `query` value. Valid values are:
+:   (Optional, string) Boolean logic used to interpret text in the `query`
+value. Valid values are:
 
 `OR` (Default)
-:   For example, a `query` value of `capital of Hungary` is interpreted as `capital OR of OR Hungary`.
+:   For example, a `query` value of `capital of Hungary` is interpreted as
+`capital OR of OR Hungary`.
 
 `AND`
-:   For example, a `query` value of `capital of Hungary` is interpreted as `capital AND of AND Hungary`.
+:   For example, a `query` value of `capital of Hungary` is interpreted as
+`capital AND of AND Hungary`.
 
 
 `minimum_should_match`
-:   (Optional, string) Minimum number of clauses that must match for a document to be returned. See the [`minimum_should_match` parameter](/reference/query-languages/query-dsl/query-dsl-minimum-should-match.md) for valid values and more information.
+:   (Optional, string) Minimum number of clauses that must match for a document
+to be returned. See the [
+`minimum_should_match` parameter](/reference/query-languages/query-dsl/query-dsl-minimum-should-match.md)
+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:
+:   (Optional, string) Indicates whether no documents are returned if the
+`analyzer` 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.
 
 `all`
-:   Returns all documents, similar to a [`match_all`](/reference/query-languages/query-dsl/query-dsl-match-all-query.md) query.
+:   Returns all documents, similar to a [
+`match_all`](/reference/query-languages/query-dsl/query-dsl-match-all-query.md)
+query.
 
 See [Zero terms query](#query-dsl-match-query-zero) for an example.
 
-
-
 ## Notes [match-query-notes]
 
 ### Short request example [query-dsl-match-query-short-ex]
 
-You can simplify the match query syntax by combining the `<field>` and `query` parameters. For example:
+You can simplify the match query syntax by combining the `<field>` and `query`
+parameters. For example:
 
 ```console
 GET /_search
@@ -123,10 +168,15 @@ GET /_search
 }
 ```
 
-
 ### How the match query works [query-dsl-match-query-boolean]
 
-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 [`minimum_should_match`](/reference/query-languages/query-dsl/query-dsl-minimum-should-match.md) parameter.
+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 [
+`minimum_should_match`](/reference/query-languages/query-dsl/query-dsl-minimum-should-match.md)
+parameter.
 
 Here is an example with the `operator` parameter:
 
@@ -144,24 +194,37 @@ 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 `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 `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`.
 
 ### Fuzziness in the match query [query-dsl-match-query-fuzziness]
 
-`fuzziness` allows *fuzzy matching* based on the type of field being queried. See [Fuzziness](/reference/elasticsearch/rest-apis/common-options.md#fuzziness) for allowed settings.
+`fuzziness` allows *fuzzy matching* based on the type of field being queried.
+See [Fuzziness](/reference/elasticsearch/rest-apis/common-options.md#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 [rewrite method](/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite.md) the `fuzzy_rewrite` parameter allows to control how the query will get rewritten.
+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 [rewrite method](/reference/query-languages/query-dsl/query-dsl-multi-term-rewrite.md)
+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.
+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.
 ::::
 
-
 ```console
 GET /_search
 {
@@ -176,10 +239,12 @@ GET /_search
 }
 ```
 
-
 ### Zero terms query [query-dsl-match-query-zero]
 
-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.
+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.
 
 ```console
 GET /_search
@@ -196,10 +261,13 @@ GET /_search
 }
 ```
 
-
 ### Synonyms [query-dsl-match-query-synonyms]
 
-The `match` query supports multi-terms synonym expansion with the [synonym_graph](/reference/text-analysis/analysis-synonym-graph-tokenfilter.md) 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:
+The `match` query supports multi-terms synonym expansion with
+the [synonym_graph](/reference/text-analysis/analysis-synonym-graph-tokenfilter.md)
+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"))`
 
@@ -223,7 +291,8 @@ The example above creates a boolean query:
 
 `(ny OR (new AND york)) city`
 
-that matches documents with the term `ny` or the conjunction `new AND york`. By default the parameter `auto_generate_synonyms_phrase_query` is set to `true`.
+that matches documents with the term `ny` or the conjunction `new AND york`. By
+default the parameter `auto_generate_synonyms_phrase_query` is set to `true`.
 
 
 

x-pack/plugin/esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/fulltext/Match.java

@@ -142,6 +142,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.