This is an earlier version of the OpenSearch documentation. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
The k-NN plugin adds several new cluster settings.
| ||1||The number of threads used for native library index creation. Keeping this value low reduces the CPU impact of the k-NN plugin, but also reduces indexing performance.|
| ||false||Whether to remove native library indices that have not been accessed for a certain duration from memory.|
| ||3h||If enabled, the idle time before removing a native library index from memory.|
| ||75%||The native memory usage threshold for the circuit breaker. Memory usage must be below this percentage of |
| ||false||True when memory usage exceeds the |
| ||50%||The native memory limit for native library indices. At the default value, if a machine has 100 GB of memory and the JVM uses 32 GB, the k-NN plugin uses 50% of the remaining 68 GB (34 GB). If memory usage exceeds this value, k-NN removes the least recently used native library indices.|
| ||true||Whether to enable the k-NN memory circuit breaker.|
| ||true||Enables or disables the k-NN plugin.|
| ||1||Number of shards to use for the model system index, the OpenSearch index that stores the models used for Approximate k-NN Search.|
| ||1||Number of replica shards to use for the model system index. Generally, in a multi-node cluster, this should be at least 1 to increase stability.|