Skip to content

[DOCS] Add timeout warning to ESQL completion command #131994

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

Merged
merged 8 commits into from
Jul 30, 2025
Merged

[DOCS] Add timeout warning to ESQL completion command #131994

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a74a777
[DOCS] Add timeout warning to ESQL completion command
leemthompo Jul 28, 2025
7dc6786
Improve sequencing
leemthompo Jul 28, 2025
fa74f83
add link to http client configuration page
leemthompo Jul 28, 2025
2abaefd
update link
leemthompo Jul 28, 2025
c137c1c
use headings, fix link
leemthompo Jul 28, 2025
6d3047c
fix heading levels
leemthompo Jul 28, 2025
b3d76e0
Standardized headings to bold, clarified and expanded timeout instruc…
leemthompo Jul 29, 2025
bd03512
delete repetition
leemthompo Jul 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion docs/reference/query-languages/esql/_snippets/commands/layout/completion.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,39 @@ including:
**Requirements**

To use this command, you must deploy your LLM model in Elasticsearch as
an [≈inference endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put) with the
an [inference endpoint](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-inference-put) with the
task type `completion`.

#### Handling timeouts

`COMPLETION` commands may time out when processing large datasets or complex prompts. The default timeout is 10 minutes, but you can increase this limit if necessary.

How you increase the timeout depends on your deployment type:

::::{tab-set}
:::{tab-item} {{ech}}
* You can adjust {{es}} settings in the [Elastic Cloud Console](docs-content://deploy-manage/deploy/elastic-cloud/edit-stack-settings.md)
* You can also adjust the `search.default_search_timeout` cluster setting using [Kibana's Advanced settings](kibana://reference/advanced-settings.md#kibana-search-settings)
:::

:::{tab-item} Self-managed
* You can configure at the cluster level by setting `search.default_search_timeout` in `elasticsearch.yml` or updating via [Cluster Settings API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-cluster-put-settings)
* You can also adjust the `search:timeout` setting using [Kibana's Advanced settings](kibana://reference/advanced-settings.md#kibana-search-settings)
* Alternatively, you can add timeout parameters to individual queries
:::

:::{tab-item} {{serverless-full}}
* Requires a manual override from Elastic Support because you cannot modify timeout settings directly
:::
::::

If you don't want to increase the timeout limit, try the following:

* Reduce data volume with `LIMIT` or more selective filters before the `COMPLETION` command
* Split complex operations into multiple simpler queries
* Configure your HTTP client's response timeout (Refer to [HTTP client configuration](/reference/elasticsearch/configuration-reference/networking-settings.md#_http_client_configuration))


**Examples**

Use the default column name (results stored in `completion` column):
Expand Down
Loading