- Elasticsearch Guide: other versions:
- Elasticsearch basics
- Quick starts
- Set up Elasticsearch
- Run Elasticsearch locally
- 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
- Data stream lifecycle settings
- Field data cache settings
- Local gateway settings
- Health Diagnostic settings
- Index lifecycle management settings
- Index management settings
- Index recovery settings
- Indexing buffer settings
- Inference settings
- License settings
- Machine learning settings
- Monitoring settings
- Node settings
- Networking
- Node query cache settings
- Path settings
- Search settings
- Security settings
- Shard request cache settings
- Snapshot and restore settings
- Transforms settings
- Thread pools
- Watcher settings
- Set JVM options
- 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
- Search your data
- The search API
- Sort search results
- Paginate search results
- Retrieve selected fields
- Search multiple data streams and indices using a query
- Collapse search results
- Filter search results
- Highlighting
- Long-running searches
- Near real-time search
- Retrieve inner hits
- Search shard routing
- Searching with query rules
- Search templates
- Full-text search
- Search relevance optimizations
- Retrievers
- kNN search
- Semantic search
- Retrieval augmented generation
- Search across clusters
- Search with synonyms
- Search Applications
- Search analytics
- The search API
- Re-ranking
- Index modules
- Index templates
- Aliases
- 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
- Pass-through object
- Percolator
- Point
- Range
- Rank feature
- Rank features
- Rank Vectors
- Search-as-you-type
- Semantic text
- Shape
- Sparse vector
- Text
- Token count
- Unsigned long
- Version
- Metadata fields
- Mapping parameters
analyzer
coerce
copy_to
doc_values
dynamic
eager_global_ordinals
enabled
format
ignore_above
index.mapping.ignore_above
ignore_malformed
index
index_options
index_phrases
index_prefixes
meta
fields
normalizer
norms
null_value
position_increment_gap
properties
search_analyzer
similarity
store
subobjects
term_vector
- 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
- 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
- IP Location
- Join
- JSON
- KV
- Lowercase
- Network direction
- Pipeline
- Redact
- Registered domain
- Remove
- Rename
- Reroute
- Script
- Set
- Set security user
- Sort
- Split
- Terminate
- Trim
- Uppercase
- URL decode
- URI parts
- User agent
- Ingest pipelines in Search
- Connectors
- Data streams
- 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
- Roll up or transform your data
- Query DSL
- 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
- 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
- Watcher
- Monitor a cluster
- 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
- Set up a cluster for high availability
- Optimizations
- Autoscaling
- Snapshot and restore
- Cross-cluster replication
- Data store architecture
- 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 features
- 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
- Claim 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
- Advantages of using this endpoint before a cross-cluster search
- Rollover
- Shrink index
- Simulate index
- Simulate template
- Split 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
- Delete inference API
- Get inference API
- Perform inference API
- Chat completion inference API
- Create inference API
- Stream inference API
- Update inference API
- Elastic Inference Service (EIS)
- AlibabaCloud AI Search inference integration
- Amazon Bedrock inference integration
- Anthropic inference integration
- Azure AI studio inference integration
- Azure OpenAI inference integration
- Cohere inference integration
- Elasticsearch inference integration
- ELSER inference integration
- Google AI Studio inference integration
- Google Vertex AI inference integration
- HuggingFace inference integration
- JinaAI inference integration
- Mistral inference integration
- OpenAI inference integration
- Watsonx inference integration
- 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
- Bulk create or update roles API
- Bulk delete roles API
- 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
- Query Role
- 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
- 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
- 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
- Upgrade Elasticsearch
- Migration guide
- Release notes
- Dependencies and versions
Build a search experience with the Search Application client
editBuild a search experience with the Search Application client
editThis document is a how-to guide to building a search experience with a search application, using the Search Application client. The client is a JavaScript library designed to be used in the browser. You’ll integrate this library into your web app to simplify querying your search application.
A sandbox environment is available for testing and experimenting with the search-application-client
library.
Jump there if you’d like to try out the client without setting up your own web app.
Clone the repository and follow the instructions in the README to get started.
Goal
editThis guide assumes you want to build a web app with the following search features:
- Search bar and results with custom relevance
- Control over the presentation of results, such as inclusion/exclusion of fields and highlighting of matching terms
- UI controls such as facets, filters, sorts, pagination
You can think of the search application as the "server side" that persists changes to Elasticsearch. Your web app acts as the "client side" that queries the search application. You’ll be making edits to both your search application and your web app to complete the implementation.
Prerequisites
editTo follow this guide, you’ll need:
-
An Elastic deployment, that satisfies the prerequisites for running a search application.
- If you don’t have an Elastic deployment, start a free trial on Elastic Cloud.
-
A search application.
- A web app to query your search application, using Search Application client.
Install and configure the client
editInstall the client
editInstall the client using npm, yarn, or a CDN.
Option 1: Using package manager
To install the client using npm, run the following command:
npm install @elastic/search-application-client
To install the client using yarn, run the following command:
yarn add @elastic/search-application-client
Option 2: Using CDN with HTML <script>
tag
Alternatively, you can install the client using a CDN.
Add the following <script>
tag to your web app’s HTML:
<script src="https://cdn.jsdelivr.net/npm/@elastic/search-application-client@latest"></script>
Import and initialize the client
editOnce installed, you can import the client into your web app. You’ll need the following information to initialize the client:
- The name of your search application
- The URL endpoint for your search application
- The API key for your search application
Find this information on the Connect page in the Kibana UI.
Option 1: Using JavaScript modules
editUse the following import statement:
import SearchApplicationClient from '@elastic/search-application-client';
Configure the client with your deployment details to start making search requests. You can generate an API key on the Connect page in the Kibana UI. Go to Search > Search Applications > <MY_SEARCH_APPLICATION> > Connect. You’ll find the following information prepopulated to initialize the client:
import Client from '@elastic/search-application-client' const request = Client( 'my-search-application', // search application name 'url-from-connect-page', // url-host 'api-key-from-connect-page', // api-key { // optional configuration } )
Once configured you’ll be able to make search requests to your search application using the client API, like this:
const results = await request() .query('star wars') .search()
Option 2: Using CDN
editAlternatively, if you’re using a CDN, you can import the client using the following statement:
<script> const Client = window['SearchApplicationClient']; </script>
Configure the client with your deployment details to start making search requests. You can generate an API key on the Connect page in the Kibana UI. Go to Search > Search Applications > <MY_SEARCH_APPLICATION> > Connect. You’ll find the following information prepopulated to initialize the client:
<script> const request = Client( 'my-example-app', // search application name 'url-from-connect-page', // url-host 'api-key-from-connect-page', // api-key { // optional configuration } ) </script>
Once configured you’ll be able to make search requests to your search application using the client API, like this:
<script> const results = await request() .query('star wars') .search() </script>
Working with your search template
editThe Search Application client is designed to work with any search template you create. You’ll use the Search Application APIs to create and manage your search templates.
When working with the Search Application APIs to manage templates, we provide the API examples using Kibana Console syntax.
Here’s an example template:
resp = client.search_application.put( name="my-example-app", search_application={ "indices": [ "my-example-app" ], "template": { "script": { "lang": "mustache", "source": "\n {\n \"query\": {\n \"bool\": {\n \"must\": [\n {{#query}}\n {\n \"query_string\": {\n \"query\": \"{{query}}\",\n \"search_fields\": {{#toJson}}search_fields{{/toJson}}\n }\n }\n {{/query}}\n ]\n }\n }\n }\n ", "params": { "query": "", "search_fields": "" } } } }, ) print(resp)
const response = await client.searchApplication.put({ name: "my-example-app", search_application: { indices: ["my-example-app"], template: { script: { lang: "mustache", source: '\n {\n "query": {\n "bool": {\n "must": [\n {{#query}}\n {\n "query_string": {\n "query": "{{query}}",\n "search_fields": {{#toJson}}search_fields{{/toJson}}\n }\n }\n {{/query}}\n ]\n }\n }\n }\n ', params: { query: "", search_fields: "", }, }, }, }, }); console.log(response);
PUT _application/search_application/my-example-app { "indices": ["my-example-app"], "template": { "script": { "lang": "mustache", "source": """ { "query": { "bool": { "must": [ {{#query}} { "query_string": { "query": "{{query}}", "search_fields": {{#toJson}}search_fields{{/toJson}} } } {{/query}} ] } } } """, "params": { "query": "", "search_fields": "" } } } }
This will allow you to add any template parameters you need to your template and then provide the values in your client request.
Use addParameter
to inject actual values into your template parameters.
For example, pass in values for search_fields
like this:
const results = await request() .query('star wars') // requires the template to use query parameter .addParameter('search_fields', ['title', 'description']) .search()
Example template
editWe recommend getting started with the boilerplate template provided in the client repository.
View this script to see how this is used.
The dictionary
parameter is used to pass in a JSON schema definition that describes structure and validation rules for the request object.
This schema is important, because it restricts the use of certain features in the Elasticsearch query.
View the schema.
Each search functionality in this guide requires a feature included in this template. These features require specific parameters to be present in the template:
-
Query:
query
-
Filters:
_es_filters
-
Faceting:
_es_filters
and_es_aggs
-
Sorting:
_es_sort_fields
-
Pagination:
from
andsize
Search features
editWe will explore all the essential basics you’ll need for a search experience. You’ll learn how to implement them using your search application and query them using the client.
Refer to the client repo for information on the available methods and their parameters.
Customizing relevance
editOur simple template uses query_string
searching across all fields, but this may not suit your use case.
You can update the template to provide better relevance recall.
In the below example, we’re using a multi-match
query against our template, with best_fields
and phrase_prefix
queries targeting different search fields.
resp = client.search_application.put( name="my-example-app", search_application={ "indices": [ "example-index" ], "template": { "script": { "lang": "mustache", "source": "\n {\n \"query\": {\n \"bool\": {\n \"must\": [\n {{#query}}\n {\n \"multi_match\" : {\n \"query\": \"{{query}}\",\n \"fields\": [ \"title^4\", \"plot\", \"actors\", \"directors\" ]\n }\n },\n {\n \"multi_match\" : {\n \"query\": \"{{query}}\",\n \"type\": \"phrase_prefix\",\n \"fields\": [ \"title^4\", \"plot\"]\n }\n },\n {{/query}}\n ],\n \"filter\": {{#toJson}}_es_filters{{/toJson}}\n }\n },\n \"aggs\": {{#toJson}}_es_aggs{{/toJson}},\n \"from\": {{from}},\n \"size\": {{size}},\n \"sort\": {{#toJson}}_es_sort_fields{{/toJson}}\n }\n ", "params": { "query": "", "_es_filters": {}, "_es_aggs": {}, "_es_sort_fields": {}, "size": 10, "from": 0 }, "dictionary": {} } } }, ) print(resp)
const response = await client.searchApplication.put({ name: "my-example-app", search_application: { indices: ["example-index"], template: { script: { lang: "mustache", source: '\n {\n "query": {\n "bool": {\n "must": [\n {{#query}}\n {\n "multi_match" : {\n "query": "{{query}}",\n "fields": [ "title^4", "plot", "actors", "directors" ]\n }\n },\n {\n "multi_match" : {\n "query": "{{query}}",\n "type": "phrase_prefix",\n "fields": [ "title^4", "plot"]\n }\n },\n {{/query}}\n ],\n "filter": {{#toJson}}_es_filters{{/toJson}}\n }\n },\n "aggs": {{#toJson}}_es_aggs{{/toJson}},\n "from": {{from}},\n "size": {{size}},\n "sort": {{#toJson}}_es_sort_fields{{/toJson}}\n }\n ', params: { query: "", _es_filters: {}, _es_aggs: {}, _es_sort_fields: {}, size: 10, from: 0, }, dictionary: {}, }, }, }, }); console.log(response);
PUT _application/search_application/my-example-app { "indices": ["example-index"], "template": { "script": { "lang": "mustache", "source": """ { "query": { "bool": { "must": [ {{#query}} { "multi_match" : { "query": "{{query}}", "fields": [ "title^4", "plot", "actors", "directors" ] } }, { "multi_match" : { "query": "{{query}}", "type": "phrase_prefix", "fields": [ "title^4", "plot"] } }, {{/query}} ], "filter": {{#toJson}}_es_filters{{/toJson}} } }, "aggs": {{#toJson}}_es_aggs{{/toJson}}, "from": {{from}}, "size": {{size}}, "sort": {{#toJson}}_es_sort_fields{{/toJson}} } """, "params": { "query": "", "_es_filters": {}, "_es_aggs": {}, "_es_sort_fields": {}, "size": 10, "from": 0 }, "dictionary": { // add dictionary restricting // _es_filters, _es_sort_fields & _es_aggs params // Use example provided in repo: https://github.com/elastic/search-application-client/blob/main/bin/request_schema.json } } } }
Refer to for examples of different types of queries, including combinations of text search, kNN search, ELSER search, hybrid search with RRF, and more.
Use case: I want to dynamically adjust the search fields
If you need to adjust search_fields
at query request time, you can add a new parameter to the template (for example: search_fields
) and use the addParameter
method to provide the fields to the template.
Use case: I want to boost results given a certain proximity to the user
You can add additional template parameters to send the geo-coordinates of the user.
Then use function_score
to boost documents which match a certain geo_distance
from the user.
Result fields
editBy default, all fields are returned in the _source
field.
To restrict the fields returned, specify the fields in the template.
resp = client.search_application.put( name="my-example-app", search_application={ "indices": [ "example-index" ], "template": { "script": { "lang": "mustache", "source": "\n {\n \"query\": {\n \"bool\": {\n \"must\": [\n {{#query}}\n {{/query}}\n ],\n \"filter\": {{#toJson}}_es_filters{{/toJson}}\n }\n },\n \"_source\": {\n \"includes\": [\"title\", \"plot\"]\n },\n \"aggs\": {{#toJson}}_es_aggs{{/toJson}},\n \"from\": {{from}},\n \"size\": {{size}},\n \"sort\": {{#toJson}}_es_sort_fields{{/toJson}}\n }\n ", "params": { "query": "", "_es_filters": {}, "_es_aggs": {}, "_es_sort_fields": {}, "size": 10, "from": 0 }, "dictionary": {} } } }, ) print(resp)
const response = await client.searchApplication.put({ name: "my-example-app", search_application: { indices: ["example-index"], template: { script: { lang: "mustache", source: '\n {\n "query": {\n "bool": {\n "must": [\n {{#query}}\n {{/query}}\n ],\n "filter": {{#toJson}}_es_filters{{/toJson}}\n }\n },\n "_source": {\n "includes": ["title", "plot"]\n },\n "aggs": {{#toJson}}_es_aggs{{/toJson}},\n "from": {{from}},\n "size": {{size}},\n "sort": {{#toJson}}_es_sort_fields{{/toJson}}\n }\n ', params: { query: "", _es_filters: {}, _es_aggs: {}, _es_sort_fields: {}, size: 10, from: 0, }, dictionary: {}, }, }, }, }); console.log(response);
PUT _application/search_application/my-example-app { "indices": ["example-index"], "template": { "script": { "lang": "mustache", "source": """ { "query": { "bool": { "must": [ {{#query}} // ... {{/query}} ], "filter": {{#toJson}}_es_filters{{/toJson}} } }, "_source": { "includes": ["title", "plot"] }, "aggs": {{#toJson}}_es_aggs{{/toJson}}, "from": {{from}}, "size": {{size}}, "sort": {{#toJson}}_es_sort_fields{{/toJson}} } """, "params": { "query": "", "_es_filters": {}, "_es_aggs": {}, "_es_sort_fields": {}, "size": 10, "from": 0 }, "dictionary": { // add dictionary restricting _es_filters and _es_aggs params // Use the dictionary example provided in repo: https://github.com/elastic/search-application-client/blob/main/bin/request_schema.json } } } }
Use case: I want to dynamically adjust the result fields
If you need to adjust the fields returned at query request time, you can add a new parameter to the template (for example: result_fields
) and use the addParameter
method to provide the fields to the template.
Highlighting and snippets
editHighlighting support is straightforward to add to the template. With the highlighting API, you can specify which fields you want to highlight for matches.
In the following example, we specify title
and plot
as the highlighted fields.
title
typically has a short value length, compared to plot
which is variable and tends to be longer.
We specify the title to be fragment_size
of 0
to return all of the text when there is a highlight.
We specify the plot to be fragment_size
of 200
, where each highlighted fragment will be up to 200 characters long.
resp = client.search_application.put( name="my-example-app", search_application={ "indices": [ "example-index" ], "template": { "script": { "lang": "mustache", "source": "\n {\n \"query\": {\n \"bool\": {\n \"must\": [\n {{#query}}\n {{/query}}\n ],\n \"filter\": {{#toJson}}_es_filters{{/toJson}}\n }\n },\n \"_source\": {\n \"includes\": [\"title\", \"plot\"]\n },\n \"highlight\": {\n \"fields\": {\n \"title\": { \"fragment_size\": 0 },\n \"plot\": { \"fragment_size\": 200 }\n }\n },\n \"aggs\": {{#toJson}}_es_aggs{{/toJson}},\n \"from\": {{from}},\n \"size\": {{size}},\n \"sort\": {{#toJson}}_es_sort_fields{{/toJson}}\n }\n ", "params": { "query": "", "_es_filters": {}, "_es_aggs": {}, "_es_sort_fields": {}, "size": 10, "from": 0 }, "dictionary": {} } } }, ) print(resp)
const response = await client.searchApplication.put({ name: "my-example-app", search_application: { indices: ["example-index"], template: { script: { lang: "mustache", source: '\n {\n "query": {\n "bool": {\n "must": [\n {{#query}}\n {{/query}}\n ],\n "filter": {{#toJson}}_es_filters{{/toJson}}\n }\n },\n "_source": {\n "includes": ["title", "plot"]\n },\n "highlight": {\n "fields": {\n "title": { "fragment_size": 0 },\n "plot": { "fragment_size": 200 }\n }\n },\n "aggs": {{#toJson}}_es_aggs{{/toJson}},\n "from": {{from}},\n "size": {{size}},\n "sort": {{#toJson}}_es_sort_fields{{/toJson}}\n }\n ', params: { query: "", _es_filters: {}, _es_aggs: {}, _es_sort_fields: {}, size: 10, from: 0, }, dictionary: {}, }, }, }, }); console.log(response);
PUT _application/search_application/my-example-app { "indices": ["example-index"], "template": { "script": { "lang": "mustache", "source": """ { "query": { "bool": { "must": [ {{#query}} // ... {{/query}} ], "filter": {{#toJson}}_es_filters{{/toJson}} } }, "_source": { "includes": ["title", "plot"] }, "highlight": { "fields": { "title": { "fragment_size": 0 }, "plot": { "fragment_size": 200 } } }, "aggs": {{#toJson}}_es_aggs{{/toJson}}, "from": {{from}}, "size": {{size}}, "sort": {{#toJson}}_es_sort_fields{{/toJson}} } """, "params": { "query": "", "_es_filters": {}, "_es_aggs": {}, "_es_sort_fields": {}, "size": 10, "from": 0 }, "dictionary": { // add dictionary restricting _es_filters and _es_aggs params // Use the dictionary example provided in repo: https://github.com/elastic/search-application-client/blob/main/bin/request_schema.json } } } }
If a match was found, this will return the results with a highlight field. For example:
{ "hits": [ { "_index": "movies", "_type": "_doc", "_id": "1", "_score": 0.2876821, "_source": { "title": "The Great Gatsby", "plot": "The Great Gatsby is a novel by F. Scott Fitzgerald that follows the story of Jay Gatsby, a wealthy and mysterious man, as he tries to win back the love of his life, Daisy Buchanan." }, "highlight": { "title": ["The Great <em>Gatsby</em>"], "plot": [ "The Great <em>Gatsby</em> is a novel by F. Scott Fitzgerald that follows the story of <em>Jay</em> <em>Gatsby</em>, a wealthy and mysterious man, as he tries to win back the love of his life, Daisy Buchanan." ] } } ] }
Highlighting helper
editWhen displaying the fields in the frontend, you will need to first determine if the field has a highlight. To simplify this, we provide a helper.
import Client, { Highlight } from '@elastic/search-application-client' // example React component const ResultsList = ({ hits } ) => { return hits.map((hit) => ( <div className="result"> <div className="title">{Highlight(hit, "title")}</div> <div className="description">{Highlight(hit, "plot")}</div> </div> )) }
Pagination
editTo use pagination, set the page number and the page size.
By default, the page size is 10.
The size
and from
parameters allow you to control the page and number of hits returned in the response.
We can do this using the client with the setSize
and setFrom
methods.
// page 1 const results = await request() .setSize(20) .setFrom(0) .search() // page 2 const results = await request() .setSize(20) .setFrom(20) .search()
Sorting
editTo use sorting, specify the field name and the sort order or pass _score
to sort by relevance.
Requires the _es_sort_fields_fields
param in the search template.
Refer to our example template to see where this is used.
By default, the results will be sorted in order of score.
If you need to sort on a field other than the score, use the setSort
method with an array of objects.
const results = await request() .setSort([{ year: 'asc' }, '_score']) .search()
Filtering
editThe Search application client also supports filters and facets. To use these, you need to add two parameters:
-
_es_filters
-
_es_aggs
Refer to our example template to see where these are used.
Base Filtering
editWith a template that’s configured to use filters, use the setFilter
method to add filters to your query.
The boilerplate template schema only supports term, range, match, nested, geo_bounding_box and geo_distance filters. If you need to use a particular clause, you can update the template schema.
Below is an example of using setFilter
.
// return only "star wars" movies that are rated PG const results = await request() .query('star wars') .setFilter({ term: { 'rated.enum': 'PG', }, }) .search()
Facets
editThe client supports the ability to configure facets with your results. Specify facets in the client initialization call. For example, say we want to add facets for actors, directors and IMDB rating.
const request = Client( 'my-example-app', // search application name 'https://d1bd36862ce54c7b903e2aacd4cd7f0a.us-east4.gcp.elastic-cloud.com:443', // api-host 'api-key-from-connect-page', // api-key { facets: { actors: { type: 'terms', field: 'actors.keyword', disjunctive: true, }, directors: { type: 'terms', field: 'director.keyword', size: 20, disjunctive: true, }, imdbrating: { type: 'stats', field: 'imdbrating', }, }, } )
In Elasticsearch, the keyword
type is used for fields that need to be searchable in their exact, unmodified form.
This means these queries are case-sensitive.
We use this type for facets because facets require aggregating and filtering data based on exact values or terms.
Use the addFacetFilter
method to add facets to your query.
In the following example, we only want to return movies:
- Featuring Harrison Ford as actor
- Directed by George Lucas or Ridley Scott
- With an IMBD rating greater than 7.5
const results = await request() .addFacetFilter('actors', 'Harrison Ford') .addFacetFilter('directors', 'George Lucas') .addFacetFilter('directors', 'Ridley Scott') .addFacetFilter('imdbrating', { gte: 7.5, }) .search()
You can access the facets in the results:
{ "took": 1, "timed_out": false, "_shards": { "total": 1, "successful": 1, "skipped": 0, "failed": 0 }, "hits": { "total": { "value": 2, "relation": "eq" }, "max_score": 0, "hits": [ { "_index": "imdb_movies", "_id": "tt0076759", "_score": 0, "_source": { "title": "Star Wars: Episode IV - A New Hope", "actors": [ "Mark Hamill", "Harrison Ford", "Carrie Fisher", "Peter Cushing" ], "plot": "Luke Skywalker joins forces with a Jedi Knight, a cocky pilot, a wookiee and two droids to save the universe from the Empire's world-destroying battle-station, while also attempting to rescue Princess Leia from the evil Darth Vader.", "poster": "https://s3-eu-west-1.amazonaws.com/imdbimages/images/MV5BMTU4NTczODkwM15BMl5BanBnXkFtZTcwMzEyMTIyMw@@._V1_SX300.jpg" } }, { "_index": "imdb_movies", "_id": "tt0083658", "_score": 0, "_source": { "title": "Blade Runner", "actors": [ "Harrison Ford", "Rutger Hauer", "Sean Young", "Edward James Olmos" ], "plot": "Deckard, a blade runner, has to track down and terminate 4 replicants who hijacked a ship in space and have returned to Earth seeking their maker.", "poster": "https://s3-eu-west-1.amazonaws.com/imdbimages/images/MV5BMTA4MDQxNTk2NDheQTJeQWpwZ15BbWU3MDE2NjIyODk@._V1_SX300.jpg" } } ] }, "aggregations": {}, "facets": [ { "name": "imdbrating_facet", "stats": { "min": 8.300000190734863, "max": 8.800000190734863, "avg": 8.550000190734863, "sum": 17.100000381469727, "count": 2 } }, { "name": "actors_facet", "entries": [ { "value": "Harrison Ford", "count": 2 }, { "value": "Carrie Fisher", "count": 1 }, { "value": "Edward James Olmos", "count": 1 }, { "value": "Mark Hamill", "count": 1 }, { "value": "Peter Cushing", "count": 1 }, { "value": "Rutger Hauer", "count": 1 }, { "value": "Sean Young", "count": 1 } ] }, { "name": "directors_facet", "entries": [ { "value": "Steven Spielberg", "count": 3 }, { "value": "Andrew Davis", "count": 1 }, { "value": "George Lucas", "count": 1 }, { "value": "Irvin Kershner", "count": 1 }, { "value": "Richard Marquand", "count": 1 }, { "value": "Ridley Scott", "count": 1 } ] } ] }
On this page
- Goal
- Prerequisites
- Install and configure the client
- Install the client
- Import and initialize the client
- Option 1: Using JavaScript modules
- Option 2: Using CDN
- Working with your search template
- Example template
- Search features
- Customizing relevance
- Result fields
- Highlighting and snippets
- Highlighting helper
- Pagination
- Sorting
- Filtering
- Base Filtering
- Facets