Text expansion query
editText expansion query
editThe text expansion query 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.
Example request
editGET _search { "query":{ "text_expansion":{ "<sparse_vector_field>":{ "model_id":"the model to produce the token weights", "model_text":"the query string" } } } }
Top level parameters for text_expansion
edit-
<sparse_vector_field>
- (Required, object) The name of the field that contains the token-weight pairs the NLP model created based on the input text.
Top level parameters for <sparse_vector_field>
edit-
model_id
- (Required, string) The ID of the model to use to convert the query text into token-weight pairs. It must be the same model ID that was used to create the tokens from the input text.
-
model_text
- (Required, string) The query text you want to use for search.
Example
editThe following is an example of the text_expansion
query that references the
ELSER model to perform semantic search. For a more detailed description of how
to perform semantic search by using ELSER and the text_expansion
query, refer
to this tutorial.
response = client.search( index: 'my-index', body: { query: { text_expansion: { 'ml.tokens' => { model_id: '.elser_model_1', model_text: 'How is the weather in Jamaica?' } } } } ) puts response
GET my-index/_search { "query":{ "text_expansion":{ "ml.tokens":{ "model_id":".elser_model_1", "model_text":"How is the weather in Jamaica?" } } } }
Optimizing the search performance of the text_expansion query
editMax WAND
is an optimization technique used by Elasticsearch to skip documents that cannot score
competitively against the current best matching documents. However, the tokens
generated by the ELSER model don’t work well with the Max WAND optimization.
Consequently, enabling Max WAND can actually increase query latency for
text_expansion
. For datasets of a significant size, disabling Max
WAND leads to lower query latencies.
Max WAND is controlled by the
track_total_hits query parameter. Setting track_total_hits
to true forces Elasticsearch to consider all documents, resulting in lower query
latencies for the text_expansion
query. However, other Elasticsearch queries run slower
when Max WAND is disabled.
If you are combining the text_expansion
query with standard text queries in a
compound search, it is recommended to measure the query performance before
deciding which setting to use.
The track_total_hits
option applies to all queries in the search request
and may be optimal for some queries but not for others. Take into account the
characteristics of all your queries to determine the most suitable
configuration.