Skip to content

Conversation

@ctindel
Copy link

@ctindel ctindel commented Nov 7, 2025

Summary

Addresses #3804 by adding comprehensive examples showing how to use index_options with semantic_text fields for dense vector quantization strategies.

Changes

  • Added new section "Optimizing vector storage with index_options" to semantic-search-semantic-text.md
  • Included 5 complete examples: bbq_hnsw, bbq_flat, bbq_disk (DiskBBQ), int8_hnsw, and custom HNSW tuning
  • Added cross-references from dense-vector.md and knn.md to semantic_text examples
  • All examples tested and verified on Elasticsearch 9.2

Examples Included

The examples demonstrate memory optimization strategies:

  • bbq_hnsw: Up to 32x memory reduction (default for 384+ dimensions)
  • bbq_flat: BBQ without HNSW for simpler use cases
  • bbq_disk: Disk-based storage with minimal memory requirements (ES 9.2+)
  • int8_hnsw: 8-bit quantization for 4x memory reduction
  • Custom HNSW: m and ef_construction parameter tuning

Testing

All 5 examples were tested against an Elasticsearch 9.2 cluster using the .multilingual-e5-small-elasticsearch inference endpoint. Each mapping successfully created indices with the specified quantization strategies.

Test plan

  • All examples use correct index_options.dense_vector syntax
  • Examples tested on Elasticsearch 9.2
  • Cross-references added to related documentation
  • Syntax follows existing documentation patterns
  • Documentation builds without errors
  • Links resolve correctly in preview

Addresses elastic#3804 by adding comprehensive examples showing how to use index_options with semantic_text fields for dense vector quantization strategies.

Changes:
- Added new section "Optimizing vector storage with index_options" to semantic-search-semantic-text.md
- Included 5 complete examples: bbq_hnsw, bbq_flat, bbq_disk (DiskBBQ), int8_hnsw, and custom HNSW tuning
- Added cross-references from dense-vector.md and knn.md to semantic_text examples
- All examples tested and verified on Elasticsearch 9.2

The examples demonstrate memory optimization strategies including:
- bbq_hnsw: Up to 32x memory reduction (default for 384+ dimensions)
- bbq_flat: BBQ without HNSW for simpler use cases
- bbq_disk: Disk-based storage with minimal memory requirements (ES 9.2+)
- int8_hnsw: 8-bit quantization for 4x memory reduction
- Custom HNSW parameters: m and ef_construction tuning

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@github-actions
Copy link

github-actions bot commented Nov 7, 2025

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant