Skip to content

[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.

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

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

afoucret
Copy link
Contributor

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

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

@elasticsearchmachine
Copy link
Collaborator

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

Copy link
Contributor

🔍 Preview links for changed docs

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.

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 😄


`column`
: (Optional) The name of the output column that will contain the completion results.
If not specified, the results will be stored in a column named `completion`.
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: we don't have an example using the default behavior, might be nice, along with an annotation to make it clear

@leemthompo
Copy link
Contributor

@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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Analytics/ES|QL AKA ESQL >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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants