Skip to content

docs: document AI assistance in the ES|QL editor (#6552, #6681)#6714

Draft
florent-leborgne wants to merge 1 commit into
mainfrom
docs-issue-6552-esql-ai
Draft

docs: document AI assistance in the ES|QL editor (#6552, #6681)#6714
florent-leborgne wants to merge 1 commit into
mainfrom
docs-issue-6552-esql-ai

Conversation

@florent-leborgne
Copy link
Copy Markdown
Member

@florent-leborgne florent-leborgne commented May 26, 2026

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 assistance subsection covers both with two H5 children.

  • explore-analyze/query-filter/languages/esql-kibana.md:
    • Adds #### AI assistance under 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.
    • Adds a cmd+J / ctrl+J row to the Keyboard shortcuts table, tagged for 9.5+ stack and serverless GA.
    • Adds a cross-reference between the new section and the existing Generate a query from natural language search-bar section so readers landing on one discover the other.
    • Updates the page frontmatter description to mention AI assistance.

Source verification

All UI strings, shortcuts, and prerequisites verified at HEAD on elastic/kibana:

  • Ghost hints (Type // and press ⌘+J…, Press ⌘+J to generate) — src/platform/packages/private/kbn-esql-editor/src/comment_to_esql/use_ghost_line_hint.ts
  • Generating... indicator — src/platform/packages/private/kbn-esql-editor/src/editor_ai.styles.ts
  • Keep / Undo / Replace review buttons + ⌘⇧↵ / ⌘⇧⌫ shortcuts — src/platform/packages/private/kbn-esql-editor/src/comment_to_esql/review_actions_widget.ts and use_comment_to_esql.ts
  • ✨ Fix with AI hover link — src/platform/packages/shared/kbn-monaco/src/languages/esql/lib/providers/hover_provider.ts
  • Keep AI fix / Undo AI fix labels — src/platform/packages/private/kbn-esql-editor/src/suggest_fix/use_suggest_fix.ts
  • Enterprise license + LLM connector gate (shared by both features) — src/platform/packages/private/kbn-esql-editor/src/hooks/use_nl_to_esql_check.ts
  • ⌘+J / Ctrl+J keyboard shortcut — src/platform/packages/private/kbn-esql-editor/src/editor_footer/keyboard_shortcuts.tsx

Reference PRs in elastic/kibana:

Related work

This PR is complementary to #6715, which documents the AI deep analysis of {{esql}} results in Discover via the discover-data-analysis Agent Builder skill. Together the two PRs cover the full AI-in-{{esql}} story: this PR helps you write or fix the query, #6715 helps you analyze the results.

The two PRs introduce new anchors that don't exist on main yet, so bidirectional cross-links between them are deferred. Whichever PR merges second should add the cross-link in a small follow-up commit before merge.

Resolves

Closes #6552
Closes #6681


AI-generated draft — created with Claude Opus 4.7.
Review all generated content for factual accuracy before merging.

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>
@github-actions
Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 26, 2026

🔍 Preview links for changed docs

@github-actions
Copy link
Copy Markdown
Contributor

Vale Linting Results

Summary: 1 warning found

⚠️ Warnings (1)
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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix ES|QL query errors with AI in the editor Write ES|QL faster with AI-assisted code completion in the editor

1 participant