[ES|QL] Add doc for the COMPLETION command #131010

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merged

afoucret merged 11 commits into elastic:main from afoucret:update-completion-docs

Jul 21, 2025

Contributor

afoucret commented Jul 10, 2025

No description provided.

afoucret added 2 commits

July 10, 2025 15:02


          Update COMPLETION command documentation with examples

b04a881


          Update COMPLETION docs to use new applies_to system

2fe94e4

afoucret added >docs :Analytics/ES|QL v9.1.0 labels

elasticsearchmachine added Team:Docs Team:Analytics v9.2.0 labels

Collaborator

elasticsearchmachine commented Jul 10, 2025

Pinging @elastic/es-docs (Team:Docs)

Collaborator

elasticsearchmachine commented Jul 10, 2025

Pinging @elastic/es-analytical-engine (Team:Analytics)

afoucret added 2 commits

July 10, 2025 15:15


          Added missing include.

9c9b0a9


          Fix typo

5f7c6ba

Contributor

github-actions bot commented Jul 10, 2025 •

edited

Loading

🔍 Preview links for changed docs

docs/reference/query-languages/esql/commands/processing-commands.md

leemthompo reviewed

View reviewed changes

Contributor

leemthompo left a comment •

edited

Loading

My main thought reading this is that "completion" is kind of a misnomer, or it's underselling the power of the command. This is really a more general-purpose LLM text generation interface using ESQL. I'm thinking the docs could be clearer if you agree:

for me "completion" suggests it only finishes incomplete text
actually does arbitrary text generation tasks (qa, summarization, translation, etc.) based on the model you use
- we could frame the capabilities as "text generation" instead of "completion"

TBC I'm not expecting we rename the command, just how we describe it 😄

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Show resolved Hide resolved

leemthompo mentioned this pull request

Add ESQL completions command to Kibana inline docs elastic/docs-content#2152

Closed

Contributor

leemthompo commented Jul 16, 2025

@afoucret just confirming, is COMPLETION landing in 9.1?

Checking because we need to add the command to the Kibana inline docs manually, unlike functions/operators which works automatically


          Addressing PR reviews.

409be85

afoucret commented

View reviewed changes

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated

Comment on lines 32 to 50

+              **Description**
+              The `COMPLETION` processing command provides a general-purpose interface for
+              text generation using a Large Language Model (LLM) in ES|QL.
+              `COMPLETION`supports a wide range of text generation tasks. Depending on your
+              prompt and the model you use, you can perform arbitrary text generation,
+              including:
+              - Question answering
+              - Summarization
+              - Translation
+              - Content rewriting
+              - Creative generation
+              - ...
+              The command works with any LLM deployed to
+              the [Elasticsearch inference API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put)
+              and can be chained with other ES|QL commands for further processing.

Contributor Author

afoucret Jul 21, 2025 •

edited

Loading

I have completely rewritten the command description to emphasize it's multi-purpose LLM based text generation capabilities. @leemthompo Is it better for you?


          Rewording.

700b147

leemthompo reviewed

View reviewed changes

Contributor

leemthompo left a comment •

edited

Loading

Thanks for iterating @afoucret, the power of COMPLETION is much clearer now! I have a suggestion for the intro sentence, and some minor edits.

The last outstanding question for me is how we make the inference endpoint requirement clearer.

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

afoucret and others added 3 commits

July 21, 2025 14:50


          Update docs/reference/query-languages/esql/_snippets/commands/layout/…

126e5dd

…completion.md

Co-authored-by: Liam Thompson <[email protected]>


          Update docs/reference/query-languages/esql/_snippets/commands/layout/…

93e5cdd

…completion.md

Co-authored-by: Liam Thompson <[email protected]>


          Apply suggestions from code review

ac57221

Co-authored-by: Liam Thompson <[email protected]>

leemthompo reviewed

View reviewed changes

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

leemthompo approved these changes

View reviewed changes

Contributor

leemthompo left a comment

Thanks for iterating, approving with few final nits, a fix for the broken link I provided, and knowing you will fix the Requirements section 👍

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

docs/reference/query-languages/esql/_snippets/commands/layout/completion.md Outdated Show resolved Hide resolved

afoucret and others added 2 commits

July 21, 2025 15:25


          Fix requirements section.

3db3597


          Apply suggestions from code review

e01f6c4

Co-authored-by: Liam Thompson <[email protected]>

leemthompo added the auto-backport label

afoucret merged commit 81606a3 into elastic:main

10 checks passed

afoucret mentioned this pull request

[9.1] [ES|QL] Add doc for the COMPLETION command (#131010) #131632

Merged

Collaborator

elasticsearchmachine commented Jul 21, 2025

💚 Backport successful

Status	Branch	Result
✅	9.1

afoucret added a commit to afoucret/elasticsearch that referenced this pull request


          [ES|QL] Add doc for the COMPLETION command (elastic#131010)

5eab5ed

elasticsearchmachine pushed a commit that referenced this pull request


          [ES|QL] Add doc for the COMPLETION command (#131010) (#131632)

d4fc667

szybia added a commit to szybia/elasticsearch that referenced this pull request


          Merge remote-tracking branch 'upstream/main' into index-pipeline-trac…

190db87

…king

* upstream/main: (100 commits)
  Term vector API on stateless search nodes (elastic#129902)
  TEST Fix ThreadPoolMergeSchedulerStressTestIT testMergingFallsBehindAndThenCatchesUp (elastic#131636)
  Add inference.put_custom rest-api-spec (elastic#131660)
  ESQL: Fewer serverless docs in tests (elastic#131651)
  Skip search on indices with INDEX_REFRESH_BLOCK (elastic#129132)
  Mute org.elasticsearch.indices.cluster.RemoteSearchForceConnectTimeoutIT testTimeoutSetting elastic#131656
  [jdk] Resolve EA OpenJDK builds to our JDK archive (elastic#131237)
  Add optimized path for intermediate values aggregator (elastic#131390)
  Correctly handling download_database_on_pipeline_creation within a pipeline processor within a default or final pipeline (elastic#131236)
  Refresh potential lost connections at query start for `_search` (elastic#130463)
  Add template_id to patterned-text type (elastic#131401)
  Integrate LIKE/RLIKE LIST with ReplaceStringCasingWithInsensitiveRegexMatch rule (elastic#131531)
  [ES|QL] Add doc for the COMPLETION command (elastic#131010)
  ESQL: Add times to topn status (elastic#131555)
  ESQL: Add asynchronous pre-optimization step for logical plan (elastic#131440)
  ES|QL: Improve generative tests for FORK [130015] (elastic#131206)
  Update index mapping update privileges (elastic#130894)
  ESQL: Added Sample operator NamedWritable to plugin (elastic#131541)
  update `kibana_system` to grant it access to `.chat-*` system index (elastic#131419)
  Clarify heap size configuration (elastic#131607)
  ...

szybia added a commit to szybia/elasticsearch that referenced this pull request


          Merge remote-tracking branch 'upstream/main' into component-templates…

b8f21b1

…-tracking

* upstream/main: (44 commits)
  Term vector API on stateless search nodes (elastic#129902)
  TEST Fix ThreadPoolMergeSchedulerStressTestIT testMergingFallsBehindAndThenCatchesUp (elastic#131636)
  Add inference.put_custom rest-api-spec (elastic#131660)
  ESQL: Fewer serverless docs in tests (elastic#131651)
  Skip search on indices with INDEX_REFRESH_BLOCK (elastic#129132)
  Mute org.elasticsearch.indices.cluster.RemoteSearchForceConnectTimeoutIT testTimeoutSetting elastic#131656
  [jdk] Resolve EA OpenJDK builds to our JDK archive (elastic#131237)
  Add optimized path for intermediate values aggregator (elastic#131390)
  Correctly handling download_database_on_pipeline_creation within a pipeline processor within a default or final pipeline (elastic#131236)
  Refresh potential lost connections at query start for `_search` (elastic#130463)
  Add template_id to patterned-text type (elastic#131401)
  Integrate LIKE/RLIKE LIST with ReplaceStringCasingWithInsensitiveRegexMatch rule (elastic#131531)
  [ES|QL] Add doc for the COMPLETION command (elastic#131010)
  ESQL: Add times to topn status (elastic#131555)
  ESQL: Add asynchronous pre-optimization step for logical plan (elastic#131440)
  ES|QL: Improve generative tests for FORK [130015] (elastic#131206)
  Update index mapping update privileges (elastic#130894)
  ESQL: Added Sample operator NamedWritable to plugin (elastic#131541)
  update `kibana_system` to grant it access to `.chat-*` system index (elastic#131419)
  Clarify heap size configuration (elastic#131607)
  ...

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

Labels

:Analytics/ES|QL auto-backport >docs Team:Analytics Team:Docs v9.1.0 v9.2.0