Skip to content

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

Merged
afoucret merged 11 commits intoelastic:mainfrom
afoucret:update-completion-docs
Jul 21, 2025
Merged

[ES|QL] Add doc for the COMPLETION command#131010
afoucret merged 11 commits intoelastic:mainfrom
afoucret:update-completion-docs

Conversation

@afoucret
Copy link
Contributor

@afoucret afoucret commented Jul 10, 2025

No description provided.

@afoucret afoucret added >docs General docs changes :Analytics/ES|QL AKA ESQL v9.1.0 labels Jul 10, 2025
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) v9.2.0 labels Jul 10, 2025
@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Jul 10, 2025

Pinging @elastic/es-docs (Team:Docs)
@elasticsearchmachine
Copy link
Collaborator

elasticsearchmachine commented Jul 10, 2025

Pinging @elastic/es-analytical-engine (Team:Analytics)
@github-actions
Copy link
Contributor

github-actions bot commented Jul 10, 2025 •
edited
Loading

🔍 Preview links for changed docs
leemthompo
leemthompo reviewed Jul 11, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 😄
@leemthompo leemthompo mentioned this pull request Jul 16, 2025
Closed
@leemthompo
Copy link
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
afoucret
afoucret commented Jul 21, 2025
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.
Copy link
Contributor Author

@afoucret afoucret Jul 21, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have completely rewritten the command description to emphasize it's multi-purpose LLM based text generation capabilities. @leemthompo Is it better for you?
leemthompo
leemthompo reviewed Jul 21, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
afoucret and others added 3 commits July 21, 2025 14:50
@afoucret @leemthompo
Update docs/reference/query-languages/esql/_snippets/commands/layout/…
126e5dd 
…completion.md

Co-authored-by: Liam Thompson <leemthompo@gmail.com>
@afoucret @leemthompo
Update docs/reference/query-languages/esql/_snippets/commands/layout/…
93e5cdd 
…completion.md

Co-authored-by: Liam Thompson <leemthompo@gmail.com>
@afoucret @leemthompo
Apply suggestions from code review
ac57221 
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
leemthompo
leemthompo approved these changes Jul 21, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for iterating, approving with few final nits, a fix for the broken link I provided, and knowing you will fix the Requirements section 👍
afoucret and others added 2 commits July 21, 2025 15:25
Fix requirements section.
3db3597
@afoucret @leemthompo
Apply suggestions from code review
e01f6c4 
Co-authored-by: Liam Thompson <leemthompo@gmail.com>
@leemthompo leemthompo added the auto-backport Automatically create backport pull requests when merged label Jul 21, 2025
@afoucret afoucret merged commit 81606a3 into elastic:main Jul 21, 2025
10 checks passed
@afoucret afoucret mentioned this pull request Jul 21, 2025
Merged
@elasticsearchmachine
Copy link
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 Jul 21, 2025
@afoucret
[ES|QL] Add doc for the COMPLETION command (elastic#131010)
5eab5ed
elasticsearchmachine pushed a commit that referenced this pull request Jul 21, 2025
@afoucret
[ES|QL] Add doc for the COMPLETION command (#131010) (#131632)
d4fc667
szybia added a commit to szybia/elasticsearch that referenced this pull request Jul 22, 2025
@szybia
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 Jul 22, 2025
@szybia
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 AKA ESQL auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Analytics Meta label for analytical engine team (ESQL/Aggs/Geo) Team:Docs Meta label for docs team v9.1.0 v9.2.0

3 participants

@afoucret @elasticsearchmachine @leemthompo