Skip to content

Commit 754604e

Browse files
ctindelclaude
andcommitted
Improve technical accuracy and completeness of index_options documentation
Addresses feedback from issue #3804 by clarifying parameter references and expanding quantization strategy documentation. Changes: - Add explicit int4_hnsw documentation with 8x memory reduction guidance - Fix parameter reference: "model_settings.index_options" → "index_options" - Clarify that index_options is configured directly on the semantic_text field - Improve consistency across cross-references in dense-vector.md and knn.md These refinements ensure users have accurate information about configuring vector quantization strategies for semantic search. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent bb1544f commit 754604e

File tree

3 files changed

+4
-4
lines changed

3 files changed

+4
-4
lines changed

solutions/search/semantic-search/semantic-search-semantic-text.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,7 @@ serverless: unavailable
201201

202202
1. Use DiskBBQ for disk-based vector storage with minimal memory requirements. Available in Elasticsearch 9.2+. This option stores compressed vectors on disk, reducing RAM usage to as little as 100 MB while maintaining query latencies around 15ms.
203203

204-
Other quantization options include `int8_hnsw` and `int4_hnsw`:
204+
Other quantization options include `int8_hnsw` (8-bit integer quantization) and `int4_hnsw` (4-bit integer quantization):
205205

206206
```console
207207
PUT semantic-embeddings-int8
@@ -222,7 +222,7 @@ PUT semantic-embeddings-int8
222222
}
223223
```
224224

225-
1. Use 8-bit integer quantization for 4x memory reduction with high accuracy retention.
225+
1. Use 8-bit integer quantization for 4x memory reduction with high accuracy retention. For 4-bit quantization, use `"type": "int4_hnsw"` instead, which provides 8x memory reduction.
226226

227227
For HNSW-specific tuning parameters like `m` and `ef_construction`, you can include them in the `index_options`:
228228

solutions/search/vector/dense-vector.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,5 +48,5 @@ Better Binary Quantization (BBQ) is an advanced vector quantization technique fo
4848
Learn more about how BBQ works, supported algorithms, and configuration examples in the [Better Binary Quantization (BBQ) documentation](https://www.elastic.co/docs/reference/elasticsearch/index-settings/bbq).
4949

5050
::::{tip}
51-
When using the [`semantic_text` field type](../semantic-search/semantic-search-semantic-text.md), you can configure BBQ and other quantization options through the `model_settings.index_options` parameter. See [Optimizing vector storage with `index_options`](../semantic-search/semantic-search-semantic-text.md#semantic-text-index-options) for examples of using `bbq_hnsw`, `int8_hnsw`, and other quantization strategies with semantic text fields.
51+
When using the [`semantic_text` field type](../semantic-search/semantic-search-semantic-text.md), you can configure BBQ and other quantization options through the `index_options` parameter. See [Optimizing vector storage with `index_options`](../semantic-search/semantic-search-semantic-text.md#semantic-text-index-options) for examples of using `bbq_hnsw`, `int8_hnsw`, and other quantization strategies with semantic text fields.
5252
::::

solutions/search/vector/knn.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ For approximate kNN, {{es}} stores dense vector values per segment as an [HNSW g
137137
In addition to search-time parameters, HNSW exposes index-time settings that balance graph build cost, search speed, and accuracy. When defining your `dense_vector` mapping, use [`index_options`](elasticsearch://reference/elasticsearch/mapping-reference/dense-vector.md#dense-vector-index-options) to set these parameters.
138138

139139
::::{tip}
140-
When using the [`semantic_text` field type](../semantic-search/semantic-search-semantic-text.md) with dense vector embeddings, you can also configure `index_options` through the `model_settings` parameter. See [Optimizing vector storage with `index_options`](../semantic-search/semantic-search-semantic-text.md#semantic-text-index-options) for examples.
140+
When using the [`semantic_text` field type](../semantic-search/semantic-search-semantic-text.md) with dense vector embeddings, you can also configure `index_options` directly on the field. See [Optimizing vector storage with `index_options`](../semantic-search/semantic-search-semantic-text.md#semantic-text-index-options) for examples.
141141
::::
142142

143143
```console

0 commit comments

Comments
 (0)