- Elasticsearch Guide: other versions:
- What is Elasticsearch?
- What’s new in 8.14
- Quickstart
- Set up Elasticsearch
- Installing Elasticsearch
- Configuring Elasticsearch
- Important Elasticsearch configuration
- Secure settings
- Auditing settings
- Circuit breaker settings
- Cluster-level shard allocation and routing settings
- Miscellaneous cluster settings
- Cross-cluster replication settings
- Discovery and cluster formation settings
- Field data cache settings
- Health Diagnostic settings
- Index lifecycle management settings
- Data stream lifecycle settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- License settings
- Local gateway settings
- Logging
- Machine learning settings
- Monitoring settings
- Nodes
- Networking
- Node query cache settings
- Search settings
- Security settings
- Shard allocation, relocation, and recovery
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Advanced configuration
- Important system configuration
- Bootstrap Checks
- Heap size check
- File descriptor check
- Memory lock check
- Maximum number of threads check
- Max file size check
- Maximum size virtual memory check
- Maximum map count check
- Client JVM check
- Use serial collector check
- System call filter check
- OnError and OnOutOfMemoryError checks
- Early-access check
- All permission check
- Discovery configuration check
- Bootstrap Checks for X-Pack
- Starting Elasticsearch
- Stopping Elasticsearch
- Discovery and cluster formation
- Add and remove nodes in your cluster
- Full-cluster restart and rolling restart
- Remote clusters
- Plugins
- Upgrade Elasticsearch
- Index modules
- Mapping
- Dynamic mapping
- Explicit mapping
- Runtime fields
- Field data types
- Aggregate metric
- Alias
- Arrays
- Binary
- Boolean
- Completion
- Date
- Date nanoseconds
- Dense vector
- Flattened
- Geopoint
- Geoshape
- Histogram
- IP
- Join
- Keyword
- Nested
- Numeric
- Object
- Percolator
- Point
- Range
- Rank feature
- Rank features
- Search-as-you-type
- Semantic text
- Shape
- Sparse vector
- Text
- Token count
- Unsigned long
- Version
- Metadata fields
- Mapping parameters
- Mapping limit settings
- Removal of mapping types
- Text analysis
- Overview
- Concepts
- Configure text analysis
- Built-in analyzer reference
- Tokenizer reference
- Token filter reference
- Apostrophe
- ASCII folding
- CJK bigram
- CJK width
- Classic
- Common grams
- Conditional
- Decimal digit
- Delimited payload
- Dictionary decompounder
- Edge n-gram
- Elision
- Fingerprint
- Flatten graph
- Hunspell
- Hyphenation decompounder
- Keep types
- Keep words
- Keyword marker
- Keyword repeat
- KStem
- Length
- Limit token count
- Lowercase
- MinHash
- Multiplexer
- N-gram
- Normalization
- Pattern capture
- Pattern replace
- Phonetic
- Porter stem
- Predicate script
- Remove duplicates
- Reverse
- Shingle
- Snowball
- Stemmer
- Stemmer override
- Stop
- Synonym
- Synonym graph
- Trim
- Truncate
- Unique
- Uppercase
- Word delimiter
- Word delimiter graph
- Character filters reference
- Normalizers
- Index templates
- Data streams
- Ingest pipelines
- Example: Parse logs
- Enrich your data
- Processor reference
- Append
- Attachment
- Bytes
- Circle
- Community ID
- Convert
- CSV
- Date
- Date index name
- Dissect
- Dot expander
- Drop
- Enrich
- Fail
- Fingerprint
- Foreach
- Geo-grid
- GeoIP
- Grok
- Gsub
- HTML strip
- Inference
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Aliases
- Search your data
- Query DSL
- Aggregations
- Bucket aggregations
- Adjacency matrix
- Auto-interval date histogram
- Categorize text
- Children
- Composite
- Date histogram
- Date range
- Diversified sampler
- Filter
- Filters
- Frequent item sets
- Geo-distance
- Geohash grid
- Geohex grid
- Geotile grid
- Global
- Histogram
- IP prefix
- IP range
- Missing
- Multi Terms
- Nested
- Parent
- Random sampler
- Range
- Rare terms
- Reverse nested
- Sampler
- Significant terms
- Significant text
- Terms
- Time series
- Variable width histogram
- Subtleties of bucketing range fields
- Metrics aggregations
- Pipeline aggregations
- Average bucket
- Bucket script
- Bucket count K-S test
- Bucket correlation
- Bucket selector
- Bucket sort
- Change point
- Cumulative cardinality
- Cumulative sum
- Derivative
- Extended stats bucket
- Inference bucket
- Max bucket
- Min bucket
- Moving function
- Moving percentiles
- Normalize
- Percentiles bucket
- Serial differencing
- Stats bucket
- Sum bucket
- Bucket aggregations
- Geospatial analysis
- EQL
- ES|QL
- SQL
- Overview
- Getting Started with SQL
- Conventions and Terminology
- Security
- SQL REST API
- SQL Translate API
- SQL CLI
- SQL JDBC
- SQL ODBC
- SQL Client Applications
- SQL Language
- Functions and Operators
- Comparison Operators
- Logical Operators
- Math Operators
- Cast Operators
- LIKE and RLIKE Operators
- Aggregate Functions
- Grouping Functions
- Date/Time and Interval Functions and Operators
- Full-Text Search Functions
- Mathematical Functions
- String Functions
- Type Conversion Functions
- Geo Functions
- Conditional Functions And Expressions
- System Functions
- Reserved keywords
- SQL Limitations
- Scripting
- Data management
- ILM: Manage the index lifecycle
- Tutorial: Customize built-in policies
- Tutorial: Automate rollover
- Index management in Kibana
- Overview
- Concepts
- Index lifecycle actions
- Configure a lifecycle policy
- Migrate index allocation filters to node roles
- Troubleshooting index lifecycle management errors
- Start and stop index lifecycle management
- Manage existing indices
- Skip rollover
- Restore a managed data stream or index
- Data tiers
- Autoscaling
- Monitor a cluster
- Roll up or transform your data
- Set up a cluster for high availability
- Snapshot and restore
- Secure the Elastic Stack
- Elasticsearch security principles
- Start the Elastic Stack with security enabled automatically
- Manually configure security
- Updating node security certificates
- User authentication
- Built-in users
- Service accounts
- Internal users
- Token-based authentication services
- User profiles
- Realms
- Realm chains
- Security domains
- Active Directory user authentication
- File-based user authentication
- LDAP user authentication
- Native user authentication
- OpenID Connect authentication
- PKI user authentication
- SAML authentication
- Kerberos authentication
- JWT authentication
- Integrating with other authentication systems
- Enabling anonymous access
- Looking up users without authentication
- Controlling the user cache
- Configuring SAML single-sign-on on the Elastic Stack
- Configuring single sign-on to the Elastic Stack using OpenID Connect
- User authorization
- Built-in roles
- Defining roles
- Role restriction
- Security privileges
- Document level security
- Field level security
- Granting privileges for data streams and aliases
- Mapping users and groups to roles
- Setting up field and document level security
- Submitting requests on behalf of other users
- Configuring authorization delegation
- Customizing roles and authorization
- Enable audit logging
- Restricting connections with IP filtering
- Securing clients and integrations
- Operator privileges
- Troubleshooting
- Some settings are not returned via the nodes settings API
- Authorization exceptions
- Users command fails due to extra arguments
- Users are frequently locked out of Active Directory
- Certificate verification fails for curl on Mac
- SSLHandshakeException causes connections to fail
- Common SSL/TLS exceptions
- Common Kerberos exceptions
- Common SAML issues
- Internal Server Error in Kibana
- Setup-passwords command fails due to connection failure
- Failures due to relocation of the configuration files
- Limitations
- Watcher
- Command line tools
- elasticsearch-certgen
- elasticsearch-certutil
- elasticsearch-create-enrollment-token
- elasticsearch-croneval
- elasticsearch-keystore
- elasticsearch-node
- elasticsearch-reconfigure-node
- elasticsearch-reset-password
- elasticsearch-saml-metadata
- elasticsearch-service-tokens
- elasticsearch-setup-passwords
- elasticsearch-shard
- elasticsearch-syskeygen
- elasticsearch-users
- How to
- Troubleshooting
- Fix common cluster issues
- Diagnose unassigned shards
- Add a missing tier to the system
- Allow Elasticsearch to allocate the data in the system
- Allow Elasticsearch to allocate the index
- Indices mix index allocation filters with data tiers node roles to move through data tiers
- Not enough nodes to allocate all shard replicas
- Total number of shards for an index on a single node exceeded
- Total number of shards per node has been reached
- Troubleshooting corruption
- Fix data nodes out of disk
- Fix master nodes out of disk
- Fix other role nodes out of disk
- Start index lifecycle management
- Start Snapshot Lifecycle Management
- Restore from snapshot
- Troubleshooting broken repositories
- Addressing repeated snapshot policy failures
- Troubleshooting an unstable cluster
- Troubleshooting discovery
- Troubleshooting monitoring
- Troubleshooting transforms
- Troubleshooting Watcher
- Troubleshooting searches
- Troubleshooting shards capacity health issues
- Troubleshooting an unbalanced cluster
- Capture diagnostics
- REST APIs
- API conventions
- Common options
- REST API compatibility
- Autoscaling APIs
- Behavioral Analytics APIs
- Compact and aligned text (CAT) APIs
- cat aliases
- cat allocation
- cat anomaly detectors
- cat component templates
- cat count
- cat data frame analytics
- cat datafeeds
- cat fielddata
- cat health
- cat indices
- cat master
- cat nodeattrs
- cat nodes
- cat pending tasks
- cat plugins
- cat recovery
- cat repositories
- cat segments
- cat shards
- cat snapshots
- cat task management
- cat templates
- cat thread pool
- cat trained model
- cat transforms
- Cluster APIs
- Cluster allocation explain
- Cluster get settings
- Cluster health
- Health
- Cluster reroute
- Cluster state
- Cluster stats
- Cluster update settings
- Nodes feature usage
- Nodes hot threads
- Nodes info
- Prevalidate node removal
- Nodes reload secure settings
- Nodes stats
- Cluster Info
- Pending cluster tasks
- Remote cluster info
- Task management
- Voting configuration exclusions
- Create or update desired nodes
- Get desired nodes
- Delete desired nodes
- Get desired balance
- Reset desired balance
- Cross-cluster replication APIs
- Connector APIs
- Create connector
- Delete connector
- Get connector
- List connectors
- Update connector API key id
- Update connector configuration
- Update connector index name
- Update connector filtering
- Update connector name and description
- Update connector pipeline
- Update connector scheduling
- Update connector service type
- Create connector sync job
- Cancel connector sync job
- Delete connector sync job
- Get connector sync job
- List connector sync jobs
- Check in a connector
- Update connector error
- Update connector last sync stats
- Update connector status
- Check in connector sync job
- Set connector sync job error
- Set connector sync job stats
- Data stream APIs
- Document APIs
- Enrich APIs
- EQL APIs
- ES|QL APIs
- Features APIs
- Fleet APIs
- Graph explore API
- Index APIs
- Alias exists
- Aliases
- Analyze
- Analyze index disk usage
- Clear cache
- Clone index
- Close index
- Create index
- Create or update alias
- Create or update component template
- Create or update index template
- Create or update index template (legacy)
- Delete component template
- Delete dangling index
- Delete alias
- Delete index
- Delete index template
- Delete index template (legacy)
- Exists
- Field usage stats
- Flush
- Force merge
- Get alias
- Get component template
- Get field mapping
- Get index
- Get index settings
- Get index template
- Get index template (legacy)
- Get mapping
- Import dangling index
- Index recovery
- Index segments
- Index shard stores
- Index stats
- Index template exists (legacy)
- List dangling indices
- Open index
- Refresh
- Resolve index
- Resolve cluster
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split index
- Unfreeze index
- Update index settings
- Update mapping
- Index lifecycle management APIs
- Create or update lifecycle policy
- Get policy
- Delete policy
- Move to step
- Remove policy
- Retry policy
- Get index lifecycle management status
- Explain lifecycle
- Start index lifecycle management
- Stop index lifecycle management
- Migrate indices, ILM policies, and legacy, composable and component templates to data tiers routing
- Inference APIs
- Info API
- Ingest APIs
- Licensing APIs
- Logstash APIs
- Machine learning APIs
- Machine learning anomaly detection APIs
- Add events to calendar
- Add jobs to calendar
- Close jobs
- Create jobs
- Create calendars
- Create datafeeds
- Create filters
- Delete calendars
- Delete datafeeds
- Delete events from calendar
- Delete filters
- Delete forecasts
- Delete jobs
- Delete jobs from calendar
- Delete model snapshots
- Delete expired data
- Estimate model memory
- Flush jobs
- Forecast jobs
- Get buckets
- Get calendars
- Get categories
- Get datafeeds
- Get datafeed statistics
- Get influencers
- Get jobs
- Get job statistics
- Get model snapshots
- Get model snapshot upgrade statistics
- Get overall buckets
- Get scheduled events
- Get filters
- Get records
- Open jobs
- Post data to jobs
- Preview datafeeds
- Reset jobs
- Revert model snapshots
- Start datafeeds
- Stop datafeeds
- Update datafeeds
- Update filters
- Update jobs
- Update model snapshots
- Upgrade model snapshots
- Machine learning data frame analytics APIs
- Create data frame analytics jobs
- Delete data frame analytics jobs
- Evaluate data frame analytics
- Explain data frame analytics
- Get data frame analytics jobs
- Get data frame analytics jobs stats
- Preview data frame analytics
- Start data frame analytics jobs
- Stop data frame analytics jobs
- Update data frame analytics jobs
- Machine learning trained model APIs
- Clear trained model deployment cache
- Create or update trained model aliases
- Create part of a trained model
- Create trained models
- Create trained model vocabulary
- Delete trained model aliases
- Delete trained models
- Get trained models
- Get trained models stats
- Infer trained model
- Start trained model deployment
- Stop trained model deployment
- Update trained model deployment
- Migration APIs
- Node lifecycle APIs
- Query rules APIs
- Reload search analyzers API
- Repositories metering APIs
- Rollup APIs
- Root API
- Script APIs
- Search APIs
- Search Application APIs
- Searchable snapshots APIs
- Security APIs
- Authenticate
- Change passwords
- Clear cache
- Clear roles cache
- Clear privileges cache
- Clear API key cache
- Clear service account token caches
- Create API keys
- Create or update application privileges
- Create or update role mappings
- Create or update roles
- Create or update users
- Create service account tokens
- Delegate PKI authentication
- Delete application privileges
- Delete role mappings
- Delete roles
- Delete service account token
- Delete users
- Disable users
- Enable users
- Enroll Kibana
- Enroll node
- Get API key information
- Get application privileges
- Get builtin privileges
- Get role mappings
- Get roles
- Get service accounts
- Get service account credentials
- Get Security settings
- Get token
- Get user privileges
- Get users
- Grant API keys
- Has privileges
- Invalidate API key
- Invalidate token
- OpenID Connect prepare authentication
- OpenID Connect authenticate
- OpenID Connect logout
- Query API key information
- Query User
- Update API key
- Update Security settings
- Bulk update API keys
- SAML prepare authentication
- SAML authenticate
- SAML logout
- SAML invalidate
- SAML complete logout
- SAML service provider metadata
- SSL certificate
- Activate user profile
- Disable user profile
- Enable user profile
- Get user profiles
- Suggest user profile
- Update user profile data
- Has privileges user profile
- Create Cross-Cluster API key
- Update Cross-Cluster API key
- Snapshot and restore APIs
- Snapshot lifecycle management APIs
- SQL APIs
- Synonyms APIs
- Text structure APIs
- Transform APIs
- Usage API
- Watcher APIs
- Definitions
- Migration guide
- Release notes
- Elasticsearch version 8.14.3
- Elasticsearch version 8.14.2
- Elasticsearch version 8.14.1
- Elasticsearch version 8.14.0
- Elasticsearch version 8.13.4
- Elasticsearch version 8.13.3
- Elasticsearch version 8.13.2
- Elasticsearch version 8.13.1
- Elasticsearch version 8.13.0
- Elasticsearch version 8.12.2
- Elasticsearch version 8.12.1
- Elasticsearch version 8.12.0
- Elasticsearch version 8.11.4
- Elasticsearch version 8.11.3
- Elasticsearch version 8.11.2
- Elasticsearch version 8.11.1
- Elasticsearch version 8.11.0
- Elasticsearch version 8.10.4
- Elasticsearch version 8.10.3
- Elasticsearch version 8.10.2
- Elasticsearch version 8.10.1
- Elasticsearch version 8.10.0
- Elasticsearch version 8.9.2
- Elasticsearch version 8.9.1
- Elasticsearch version 8.9.0
- Elasticsearch version 8.8.2
- Elasticsearch version 8.8.1
- Elasticsearch version 8.8.0
- Elasticsearch version 8.7.1
- Elasticsearch version 8.7.0
- Elasticsearch version 8.6.2
- Elasticsearch version 8.6.1
- Elasticsearch version 8.6.0
- Elasticsearch version 8.5.3
- Elasticsearch version 8.5.2
- Elasticsearch version 8.5.1
- Elasticsearch version 8.5.0
- Elasticsearch version 8.4.3
- Elasticsearch version 8.4.2
- Elasticsearch version 8.4.1
- Elasticsearch version 8.4.0
- Elasticsearch version 8.3.3
- Elasticsearch version 8.3.2
- Elasticsearch version 8.3.1
- Elasticsearch version 8.3.0
- Elasticsearch version 8.2.3
- Elasticsearch version 8.2.2
- Elasticsearch version 8.2.1
- Elasticsearch version 8.2.0
- Elasticsearch version 8.1.3
- Elasticsearch version 8.1.2
- Elasticsearch version 8.1.1
- Elasticsearch version 8.1.0
- Elasticsearch version 8.0.1
- Elasticsearch version 8.0.0
- Elasticsearch version 8.0.0-rc2
- Elasticsearch version 8.0.0-rc1
- Elasticsearch version 8.0.0-beta1
- Elasticsearch version 8.0.0-alpha2
- Elasticsearch version 8.0.0-alpha1
- Dependencies and versions
Search Applications search API and templates
editSearch Applications search API and templates
editYour search applications use search templates to perform searches. Templates help reduce complexity by exposing only template parameters, while using the full power of Elasticsearch’s query DSL to formulate queries. Templates may be set when creating or updating a search application, and can be customized. This template can be edited or updated at any time using the Put Search Application API API call.
In a nutshell, you create search templates with parameters instead of specific hardcoded search values. At search time, you pass in the actual values for these parameters, enabling customized searches without rewriting the entire query structure. Search Application templates:
- Simplify query requests
- Reduce request size
- Ensure security and performance, as the query is predefined and can’t be changed arbitrarily
This document provides information and sample templates to get you started using search applications for additional use cases. These templates are designed to be easily modified to meet your needs. Once you’ve created a search application with a template, you can search your search application using this template.
Search templates use the Mustache templating language.
Mustache variables are typically enclosed in double curly brackets like this: {{my-var}}
.
Learn more by reading about search templates.
Default template example
editIf no template is stored with a search application, a minimal default search template will be applied at search time. The default template implements a simple search use case.
To create a search application with the default template, issue a create or update Search Application request without specifying a template:
PUT _application/search_application/my_search_application { "indices": ["index1", "index2"] }
You can then use the get search application API call to view your newly created search application, which will also include the default template that was created for you:
GET _application/search_application/my_search_application
In this case, the response would be:
{ "name": "my_search_application", "indices": [ "index1", "index2" ], "updated_at_millis": 1715802354482, "template": { "script": { "source": """{ "query": { "query_string": { "query": "{{query_string}}", "default_field": "{{default_field}}" } } } """, "lang": "mustache", "params": { "default_field": "*", "query_string": "*" } } } }
The default template is very minimal:
{ "template": { "script": { "source": { "query": { "query_string": { "query": "{{query_string}}", "default_field": "{{default_field}}" } } }, "params": { "query_string": "*", "default_field": "*" } } } }
This may be useful for initial exploration of search templates, but you’ll likely want to update this.
This template does not support additional parameters, including from
, size
or boost
.
If you need to use these, you can customize the template associated with your search application accordingly to include them as parameters.
You can see the parameters and their default values by viewing the template, but it also may be valuable to view the query that will be generated if you search your search application with various parameters.
You can use the render search application query to view the query this template would generate, including with default parameters. For example, searching the search application with no parameters:
POST _application/search_application/my_search_application/_render_query
will return:
{ "query": { "query_string": { "query": "*", "default_field": "*", "fields": [] } } }
This uses the default parameters that were defined with the template. You can also specify one or mre parameters to the render call, for example:
POST _application/search_application/my_search_application/_render_query { "params": { "query_string": "rock climbing" } }
will return:
{ "query": { "query_string": { "query": "rock climbing", "default_field": "*", "fields": [] } } }
In this case, the {{query_string}}
parameter has been replaced with the value rock climbing
, and the {{default_field}}
parameter was not specified so used the default value of *
.
When you actually perform a search with no parameters, it will execute the underlying query that the render call returned.
In this case, a search with no parameters will return all results, in a similar manner to a parameterless call to /_search
.
POST _application/search_application/my_search_application/_search
Searching with the query_string
and/or default_field
parameters will perform a query_string
query.
The default template is subject to change in future versions of the Search Applications feature.
Try some of the other examples in this document to experiment with specific use cases, or try creating your own!
Searching a search application
editTemplate search
editThe simplest way to interact with a search application is to use the search template that’s created and stored with it. Each search application has a single template associated with it, which defines search criteria, parameters and defaults.
You send search requests to a search application using the Search Application Search API.
With the default template, a search looks like this:
POST _application/search_application/my_search_application/_search { "params": { "query_string": "kayaking" } }
In this example, we’ve overridden the query_string
parameter’s default value of *
.
Since we didn’t specify default_field
the value of this parameter will still be *
.
Alias search
editIf you don’t want to set up a search template for your search application, an alias will be created with the same name as your search application. This may be helpful when experimenting with specific search queries that you want to use when building your search application’s search template.
If your search application’s name is my_search_application
, your alias will be my_search_application
.
You can search this using the search API.
You should use the Search Applications management APIs to update your application and not directly use Elasticsearch APIs such as the alias API.
For example, use PUT Search Application with the indices
parameter.
This will automatically keep the associated alias up to date and ensure that indices are added to the search application correctly.
Search template examples
editWe have created a number of examples to explore specific use cases. Use these as a starting point for creating your own search templates.
Text search example
editThe following template supports a multi_match
search over specified fields and boosts:
PUT _application/search_application/my_search_application { "indices": ["index1", "index2"], "template": { "script": { "lang": "mustache", "source": """ { "query": { "multi_match": { "query": "{{query_string}}", "fields": [{{#text_fields}}"{{name}}^{{boost}}",{{/text_fields}}] } }, "explain": "{{explain}}", "from": "{{from}}", "size": "{{size}}" } """, "params": { "query_string": "*", "text_fields": [ {"name": "title", "boost": 10}, {"name": "description", "boost": 5} ], "explain": false, "from": 0, "size": 10 } } } }
A search query using this template might look like this:
POST _application/search_application/my_search_application/_search { "params": { "size": 5, "query_string": "mountain climbing", "text_fields": [ {"name": "title", "boost": 10}, {"name": "description", "boost": 2}, {"name": "state", "boost": 1} ] } }
The text_fields
parameters can be overridden with new/different fields and boosts to experiment with the best configuration for your use case.
This template also supports pagination and explain
via parameters.
Text search + ELSER with RRF
editThis example supports the reciprocal rank fusion (RRF)] method for combining BM25 and ELSER searches. Reciprocal Rank Fusion consistently improves the combined results of different search algorithms. It outperforms all other ranking algorithms, and often surpasses the best individual results, without calibration.
PUT _application/search_application/my-search-app { "indices": [ "index1" ], "template": { "script": { "lang": "mustache", "source": """ { "retriever": { "rrf": { "retrievers": [ {{#text_fields}} { "standard": { "query": { "match": { "{{.}}": "{{query_string}}" } } } }, {{/text_fields}} {{#elser_fields}} { "standard": { "query": { "text_expansion": { "ml.inference.{{.}}_expanded.predicted_value": { "model_text": "{{query_string}}", "model_id": "<elser_model_id>" } } } } }, {{/elser_fields}} ], "window_size": {{rrf.window_size}}, "rank_constant": {{rrf.rank_constant}} } } } """, "params": { "elser_fields": ["title", "meta_description"], "text_fields": ["title", "meta_description"], "query_string": "", "rrf": { "window_size": 100, "rank_constant": 60 } } } } }
Replace <elser_model_id>
with the model ID of your ELSER deployment.
A sample query for this template will look like the following example:
POST _application/search_application/my-search-app/_search { "params": { "query_string": "What is the most popular brand of coffee sold in the United States?", "elser_fields": ["title", "meta_description"], "text_fields": ["title", "meta_description"], "rrf": { "window_size": 50, "rank_constant": 25 } } }
Text search + ELSER
editThe Elastic Learned Sparse EncodeR (ELSER) improves search relevance through text-expansion, which enables semantic search.
This experimental template requires ELSER to be enabled for one or more fields.
Refer to Semantic search with ELSER for more information on how to use ELSER.
In this case, ELSER is enabled on the title
and description
fields.
This example provides a single template that you can use for various search application scenarios: text search, ELSER, or all of the above.
It also provides a simple default query_string
query if no parameters are specified.
PUT _application/search_application/my_search_application { "indices": [ "index1", "index2" ], "template": { "script": { "lang": "mustache", "source": """ { "query": { "bool": { "should": [ {{#text}} { "multi_match": { "query": "{{query_string}}", "fields": [{{#text_fields}}"{{name}}^{{boost}}",{{/text_fields}}], "boost": "{{text_query_boost}}" } }, {{/text}} {{#elser}} {{#elser_fields}} { "text_expansion": { "ml.inference.{{name}}_expanded.predicted_value": { "model_text": "{{query_string}}", "model_id": ".elser_model_1", "boost": "{{boost}}" } } }, {{/elser_fields}} { "bool": { "must": [] } }, {{/elser}} {{^text}} {{^elser}} { "query_string": { "query": "{{query_string}}", "default_field": "{{default_field}}", "default_operator": "{{default_operator}}", "boost": "{{text_query_boost}}" } }, {{/elser}} {{/text}} { "bool": { "must": [] } } ], "minimum_should_match": 1 } }, "min_score": "{{min_score}}", "explain": "{{explain}}", "from": "{{from}}", "size": "{{size}}" } """, "params": { "text": false, "elser": false, "elser_fields": [ {"name": "title", "boost": 1}, {"name": "description", "boost": 1} ], "text_fields": [ {"name": "title", "boost": 10}, {"name": "description", "boost": 5}, {"name": "state", "boost": 1} ], "query_string": "*", "text_query_boost": 4, "default_field": "*", "default_operator": "OR", "explain": false, "from": 0, "size": 10, "min_score": 0 } } } }
A text search query using this template might look like this:
POST _application/search_application/my_search_application/_search { "params": { "text": true, "size": 5, "query_string": "mountain climbing", "text_fields": [ {"name": "title", "boost": 10}, {"name": "description", "boost": 5}, {"name": "state", "boost": 1} ] } }
An ELSER search query using this template will look like the following example:
POST _application/search_application/my_search_application/_search { "params": { "elser": true, "query_string": "where is the best mountain climbing?", "elser_fields": [ {"name": "title", "boost": 1}, {"name": "description", "boost": 1} ] } }
A combined text search and ELSER search query using this template will look like the following example:
POST _application/search_application/my_search_application/_search { "params": { "elser": true, "text": true, "query_string": "where is the best mountain climbing?", "elser_fields": [ {"name": "title", "boost": 1}, {"name": "description", "boost": 1} ], "text_query_boost": 4, "min_score": 10 } }
Text search results and ELSER search results are expected to have significantly different scores in some cases, which makes ranking challenging. To find the best search result mix for your dataset, we suggest experimenting with the boost values provided in the example template:
The above boosts should be sufficient for many use cases, but there are cases when adding a rescore query or index boost to your template may be beneficial. Remember to update your search application to use the new template using the put search application command.
Finally, a parameterless search using this template would fall back to a default search returning all documents:
POST _application/search_application/my_search_application/_search
ELSER search
editThis example supports a streamlined version of ELSER search.
PUT _application/search_application/my_search_application { "indices": [ "index1", "index2" ], "template": { "script": { "lang": "mustache", "source": """ { "query": { "bool": { "should": [ {{#elser_fields}} { "text_expansion": { "ml.inference.{{name}}_expanded.predicted_value": { "model_text": "{{query_string}}", "model_id": "<elser_model_id>" } } }, {{/elser_fields}} ] } }, "min_score": "{{min_score}}" } """, "params": { "query_string": "*", "min_score": "10", "elser_fields": [ { "name": "title" }, { "name": "description" } ] } } } }
Replace <elser_model_id>
with the model ID of your ELSER deployment.
A sample query for this template will look like the following example:
POST _application/search_application/my_search_application/_search { "params": { "query_string": "Where is the best place for mountain climbing?" } }
kNN search
editThis example supports k-nearest neighbor (kNN) search
A template supporting exact kNN search will look like the following example:
PUT _application/search_application/my_search_application { "indices": [ "index1" ], "template": { "script": { "lang": "mustache", "source": """ { "query": { "script_score": { "query": { "bool": { "filter": { "range": { "{{field}}": { "{{operator}}": {{value}} } } } } }, "script": { "source": "cosineSimilarity({{#toJson}}query_vector{{/toJson}}, '{{dense_vector_field}}') + 1.0" } } } } """, "params": { "field": "price", "operator": "gte", "value": 1000, "dense_vector_field": "product-vector", "query_vector": [] } } } }
A search query using this template will look like the following example:
POST _application/search_application/my_search_application/_search { "params": { "field": "price", "operator": "gte", "value": 500 } }
A template supporting approximate kNN search will look like the following example:
PUT _application/search_application/my_search_application { "indices": [ "index1" ], "template": { "script": { "lang": "mustache", "source": """ { "knn": { "field": "{{knn_field}}", "query_vector": {{#toJson}}query_vector{{/toJson}}, "k": "{{k}}", "num_candidates": {{num_candidates}} }, "fields": {{#toJson}}fields{{/toJson}} } """, "params": { "knn_field": "image-vector", "query_vector": [], "k": 10, "num_candidates": 100, "fields": ["title", "file-type"] } } } }
A search query using this template will look like the following example:
POST _application/search_application/my_search_application/_search { "params": { "knn_field": "image-vector", "query_vector": [-5, 9, -12], "k": 10, "num_candidates": 100, "fields": ["title", "file-type"] } }
On this page