ES|QL Composer

• ... provides a novel approach to building Elasticsearch Query Language queries.
• ... is not an official Elastic project.
• ... is under construction.

Usage

Requirements

To take advantage of all ES|QL Composer features, you should have:

• An Anthropic API key (since we use beta features, only direct access is supported).
• Credentials for an Elasticsearch cluster (CORS should be set up to allow access from the browser).

Features

Core workflows:

1. Generate schema for your ES indices.
2. Edit ES|QL using natural language.
3. Compose ES|QL blocks visually.
4. Run queries against your data.

The following features help save your money, time and network bandwith:

• Cached prompts have lower pricing and latency.
• External requests provide visual indication with a loader.
• You can also edit the query text manually.
• The cheapest model is used by default.
• A LIMIT visual block is shown when fetching data.

It is especially useful for R&D of ES|QL-related tasks, as you can:

• Customize the provided ES|QL reference guide.
• Count the number of tokens in the guides.
• See the request statistics and export history.
• Run it locally.

In terms of the user experince, ES|QL Composer:

• Progressively discloses available actions.
• Can store configuration in LocalStorage.
• Does not track you.

Screenshot

Design Language

Color	Related to...
Orange	Anthropic API
Teal	Your Elasticsearch instance
Purple	ES|QL concepts
Green	Simple action
Red	Destructive action

Shape	Concept	Interaction
Solid Button	API request	Click to start, visual feedback
Outline Button	Free API request	Click to start, visual feedback
Ghost Button	Action	Click to perform immediately
Outline Text	ES|QL Field	Drag to change order
'Out' icon + text	External link	Click to open in a new tab

Feedback

A good way to provide feedback is through GitHub issues.

Developer Stuff

Tech Stack

This is a purely client-side app, built with:

• Typescript
• React
• Chakra UI
• Anthropic SDK
• other open-source libraries

Queries are run directly against Elasticsearch instance, as the SDK does not support running in the browser.

We use some recently shipped and beta features of Anthropic API:

• Haiku 3.5 and the new Sonnet 3.5 (waiting for Opus 3.5!)
• Token counting (beta)
• Prompt caching (beta)

Local Installation

Just the regular frontend stuff:

git clone git@github.com:ilyannn/esql-composer.git && cd esql-composer
npm install && npm start

Roadmap

Some features that I might (no promise) get to implement if I have time:

• Visual Composer support for more commands and actions.
• Better text editor with syntax highlighting and classic autocomplete.
• More examples of non-trivial queries and for ES|QL functions.
• Read Prompt Engineering Text-to-QueryDSL Using Claude 3 Models.
• Healing queries with and without an LLM trip.
• More useful descriptions of user-provided indices.
• Importing Data Views from Kibana.
• Improve the color palette.
• Show ES|QL errors inside the editor.
• Modernize the dependencies.
• Switch to react-aria for better accessibility.
• Provide additional demo datasets.

Acknowledgements

• My employer and various colleagues (too many to mention).