elasticsearch/docs/reference
Benjamin Trent 5add44d7d1
Adds new `bit` element_type for dense_vectors (#110059)
This commit adds `bit` vector support by adding `element_type: bit` for
vectors. This new element type works for indexed and non-indexed
vectors. Additionally, it works with `hnsw` and `flat` index types. No
quantization based codec works with this element type, this is
consistent with `byte` vectors.

`bit` vectors accept up to `32768` dimensions in size and expect vectors
that are being indexed to be encoded either as a hexidecimal string or a
`byte[]` array where each element of the `byte` array represents `8`
bits of the vector.

`bit` vectors support script usage and regular query usage. When
indexed, all comparisons done are `xor` and `popcount` summations (aka,
hamming distance), and the scores are transformed and normalized given
the vector dimensions. Note, indexed bit vectors require `l2_norm` to be
the similarity.

For scripts, `l1norm` is the same as `hamming` distance and `l2norm` is
`sqrt(l1norm)`. `dotProduct` and `cosineSimilarity` are not supported.

Note, the dimensions expected by this element_type are always to be
divisible by `8`, and the `byte[]` vectors provided for index must be
have size `dim/8` size, where each byte element represents `8` bits of
the vectors.

closes: https://github.com/elastic/elasticsearch/issues/48322
2024-06-27 04:48:41 +10:00
..
aggregations
analysis Correct positioning for unique token filter (#109395) 2024-06-22 09:44:24 +10:00
autoscaling
behavioral-analytics/apis
cat [ML] Handle the "output memory allocator bytes" field (#109653) 2024-06-18 15:25:05 +12:00
ccr
cluster Add SparseVectorStats (#108793) 2024-06-17 11:42:14 -04:00
commands Add remove index setting command (#109276) 2024-06-03 18:23:13 -07:00
connector/apis [Connector API] Add metadata to sync job stats endpoint (#109927) 2024-06-25 08:04:56 +02:00
data-management
data-streams Remove obsolete sentence from TSDS docs (#110162) 2024-06-26 08:21:52 -07:00
docs Fix Bulk Helpers link of Python (#108694) (#109939) 2024-06-20 02:19:44 +10:00
eql
esql ES|QL ST_DISTANCE Function (#108764) 2024-06-21 11:59:44 +02:00
features/apis Remove trappy timeouts in snapshot APIs (#109828) 2024-06-21 07:11:12 +10:00
fleet
graph
health
high-availability
how-to [DOCS] Address local vs. remote storage + shard limits feedback (#109360) 2024-06-12 13:50:23 -04:00
ilm
images
index-modules
indices Lazily create the failure store (#109289) 2024-06-19 13:18:47 +02:00
inference Fix put inference API docs (#110025) 2024-06-21 16:01:08 +02:00
ingest Ingest geoip new databases release highlight (#109355) 2024-06-04 12:48:19 -04:00
licensing
mapping Adds new `bit` element_type for dense_vectors (#110059) 2024-06-27 04:48:41 +10:00
migration Forward port release notes for v8.14.0 (#109403) 2024-06-05 14:52:38 -04:00
ml [ML] Handle the "output memory allocator bytes" field (#109653) 2024-06-18 15:25:05 +12:00
modules Revert "(+Doc) link split-brain wiki from quorom decision making (#108915)" 2024-06-16 08:54:44 +01:00
monitoring
query-dsl Mark Query Rules as GA (#110004) 2024-06-21 15:26:51 -04:00
query-rules/apis Add documentation for individual query rules (#110006) 2024-06-25 14:35:08 -04:00
quickstart
release-notes Forward port release notes for v8.14.1 (#109641) 2024-06-12 16:27:51 -04:00
repositories-metering-api
rest-api Fix cluster level dense vector stats (#107962) 2024-06-18 17:45:02 +01:00
rollup
scripting
search [DOCS] Adds link to ES-Cohere notebook and clarifies requirements. (#110195) 2024-06-26 17:22:40 +02:00
search-application/apis
searchable-snapshots
security
settings [ML] Increase response size limit for batched requests (#110112) 2024-06-26 10:31:06 +01:00
setup update package-security.asciidoc to include link to reset password (#109314) 2024-06-05 11:38:52 +02:00
shutdown/apis
slm/apis
snapshot-restore Add wait_for_completion parameter to delete snapshot request (#109462) 2024-06-15 12:27:35 +10:00
sql Removing server from the version compatibility table (#109168) 2024-05-29 11:57:46 -06:00
synonyms/apis Enforce synonyms limit on APIs (#109981) 2024-06-21 18:16:16 +02:00
tab-widgets Merge remote-tracking branch 'upstream/main' into lucene_snapshot_9_11 2024-06-12 08:05:36 -04:00
text-structure/apis
transform
troubleshooting
upgrade
vectors Adds new `bit` element_type for dense_vectors (#110059) 2024-06-27 04:48:41 +10:00
watcher
aggregations.asciidoc
alias.asciidoc
analysis.asciidoc
api-conventions.asciidoc
cat.asciidoc
cluster.asciidoc
data-management.asciidoc
data-rollup-transform.asciidoc
datatiers.asciidoc [DOCS] Address local vs. remote storage + shard limits feedback (#109360) 2024-06-12 13:50:23 -04:00
dependencies-versions.asciidoc
docs.asciidoc
geospatial-analysis.asciidoc
gs-index.asciidoc
high-availability.asciidoc
how-to.asciidoc
index-modules.asciidoc Limit the value in prefix query (#108537) 2024-06-05 14:51:07 -04:00
index.asciidoc
index.x.asciidoc
indices.asciidoc
ingest.asciidoc
intro.asciidoc
landing-page.asciidoc
links.asciidoc
mapping.asciidoc
query-dsl.asciidoc
redirects.asciidoc
release-notes.asciidoc Forward port release notes for v8.14.1 (#109641) 2024-06-12 16:27:51 -04:00
scripting.asciidoc
search.asciidoc
setup.asciidoc
troubleshooting.asciidoc
upgrade.asciidoc