docs: document AI assistance in the ES|QL editor (#6552, #6681)#6714
Draft
florent-leborgne wants to merge 1 commit into
Draft
docs: document AI assistance in the ES|QL editor (#6552, #6681)#6714florent-leborgne wants to merge 1 commit into
florent-leborgne wants to merge 1 commit into
Conversation
Add an AI assistance subsection covering comment-driven ES|QL generation and "Fix with AI" on validation errors. Add the cmd+J/ctrl+J keyboard shortcut and a cross-reference to the search bar's natural-language mode. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Contributor
🔍 Preview links for changed docs |
Contributor
Vale Linting ResultsSummary: 1 warning found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/query-filter/languages/esql-kibana.md | 3 | Elastic.MappedPages | mapped_pages should only be added or updated in rare scenarios. Talk with your local technical writer before pushing changes to this key. |
The Vale linter checks documentation changes against the Elastic Docs style guide.
To use Vale locally or report issues, refer to Elastic style guide for Vale.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents two new AI-assisted features that ship in the {{esql}} editor in 9.5.0 and on Elastic Cloud Serverless. Both features share the same Enterprise license + LLM connector gate, so a single
#### AI assistancesubsection covers both with two H5 children.explore-analyze/query-filter/languages/esql-kibana.md:#### AI assistanceunder Editor tools with two sub-sections:##### Generate {{esql}} from a comment(closes Write ES|QL faster with AI-assisted code completion in the editor #6552) and##### Fix query errors with AI(closes Fix ES|QL query errors with AI in the editor #6681). Each documents the entry point, in-editor hints, generating state, review widget, and keyboard shortcuts.cmd+J/ctrl+Jrow to the Keyboard shortcuts table, tagged for 9.5+ stack and serverless GA.descriptionto mention AI assistance.Source verification
All UI strings, shortcuts, and prerequisites verified at HEAD on
elastic/kibana:Type // and press ⌘+J…,Press ⌘+J to generate) —src/platform/packages/private/kbn-esql-editor/src/comment_to_esql/use_ghost_line_hint.tsGenerating...indicator —src/platform/packages/private/kbn-esql-editor/src/editor_ai.styles.tssrc/platform/packages/private/kbn-esql-editor/src/comment_to_esql/review_actions_widget.tsanduse_comment_to_esql.tssrc/platform/packages/shared/kbn-monaco/src/languages/esql/lib/providers/hover_provider.tssrc/platform/packages/private/kbn-esql-editor/src/suggest_fix/use_suggest_fix.tssrc/platform/packages/private/kbn-esql-editor/src/hooks/use_nl_to_esql_check.tssrc/platform/packages/private/kbn-esql-editor/src/editor_footer/keyboard_shortcuts.tsxReference PRs in
elastic/kibana:[ES|QL] Code completion driven by AI[ES|QL] Fixes with AIResolves
Closes #6552
Closes #6681
Screenshots to add or update
explore-analyze/query-filter/languages/esql-kibana.md— new AI assistance section: consider adding one screenshot illustrating the comment-to-{{esql}} review widget (Keep/Undo on a generated pipe) and one illustrating the ✨ Fix with AI hover link. The flow is non-obvious for first-time readers and the existing sibling sections on this page use illustrations. Source screenshots are available in the linked Kibana PRs.