Files
OpenSearch-Docs-Cn/_search-plugins/async/settings.md
T
f999e0a8a8 Add an overview of search methods and pages for each search method (#5636)
* Restructuring TOC

Signed-off-by: Fanit Kolchina <[email protected]>

* Resolve merge conflicts

Signed-off-by: Fanit Kolchina <[email protected]>

* More foundational rewrites of ML

Signed-off-by: Fanit Kolchina <[email protected]>

* TOC restructure

Signed-off-by: Fanit Kolchina <[email protected]>

* Rename and rewrite search pages and add keyword search

Signed-off-by: Fanit Kolchina <[email protected]>

* Small wording change

Signed-off-by: Fanit Kolchina <[email protected]>

* Small wording change

Signed-off-by: Fanit Kolchina <[email protected]>

* Updated response

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Small rewording

Signed-off-by: Fanit Kolchina <[email protected]>

* Move neural search to top of vector search list

Signed-off-by: Fanit Kolchina <[email protected]>

* Change terminology

Signed-off-by: Fanit Kolchina <[email protected]>

* Reorganize search methods list

Signed-off-by: Fanit Kolchina <[email protected]>

* Rename links

Signed-off-by: Fanit Kolchina <[email protected]>

* More link renames

Signed-off-by: Fanit Kolchina <[email protected]>

* Apply suggestions from code review

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>

* Implemented editorial comments

Signed-off-by: Fanit Kolchina <[email protected]>

---------

Signed-off-by: Fanit Kolchina <[email protected]>
Signed-off-by: kolchfa-aws <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
2023-11-29 15:28:20 -05:00

33 lines
1.5 KiB
Markdown

---
layout: default
title: Settings
parent: Asynchronous search
grand_parent: Improving search performance
nav_order: 4
---
# Asynchronous Search settings
The Asynchronous Search plugin adds several settings to the standard OpenSearch cluster settings. They are dynamic, so you can change the default behavior of the plugin without restarting your cluster. To learn more about static and dynamic settings, see [Configuring OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/configuring-opensearch/index/).
You can mark the settings as `persistent` or `transient`.
For example, to update the retention period of the result index:
```json
PUT _cluster/settings
{
"transient": {
"plugins.asynchronous_search.max_wait_for_completion_timeout": "5m"
}
}
```
Setting | Default | Description
:--- | :--- | :---
`plugins.asynchronous_search.max_search_running_time` | 12 hours | The maximum running time for the search beyond which the search is terminated.
`plugins.asynchronous_search.node_concurrent_running_searches` | 20 | The concurrent searches running per coordinator node.
`plugins.asynchronous_search.max_keep_alive` | 5 days | The maximum amount of time that search results can be stored in the cluster.
`plugins.asynchronous_search.max_wait_for_completion_timeout` | 1 minute | The maximum value for the `wait_for_completion_timeout` parameter.
`plugins.asynchronous_search.persist_search_failures` | false | Persist asynchronous search results that end with a search failure in the system index.