Rank Vectors
This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
The rank_vectors
field type enables late-interaction dense vector scoring in Elasticsearch. The number of vectors per field can vary, but they must all share the same number of dimensions and element type.
The purpose of vectors stored in this field is second order ranking documents with max-sim similarity.
Here is a simple example of using this field with float
elements.
PUT my-rank-vectors-float
{
"mappings": {
"properties": {
"my_vector": {
"type": "rank_vectors"
}
}
}
}
PUT my-rank-vectors-float/_doc/1
{
"my_vector" : [[0.5, 10, 6], [-0.5, 10, 10]]
}
In addition to the float
element type, byte
and bit
element types are also supported.
Here is an example of using this field with byte
elements.
PUT my-rank-vectors-byte
{
"mappings": {
"properties": {
"my_vector": {
"type": "rank_vectors",
"element_type": "byte"
}
}
}
}
PUT my-rank-vectors-byte/_doc/1
{
"my_vector" : [[1, 2, 3], [4, 5, 6]]
}
Here is an example of using this field with bit
elements.
PUT my-rank-vectors-bit
{
"mappings": {
"properties": {
"my_vector": {
"type": "rank_vectors",
"element_type": "bit"
}
}
}
}
POST /my-rank-vectors-bit/_bulk?refresh
{"index": {"_id" : "1"}}
{"my_vector": [127, -127, 0, 1, 42]}
{"index": {"_id" : "2"}}
{"my_vector": "8100012a7f"}
The rank_vectors
field type supports the following parameters:
element_type
- (Optional, string) The data type used to encode vectors. The supported data types are
float
(default),byte
, andbit
.
Valid values for element_type
float
- indexes a 4-byte floating-point value per dimension. This is the default value.
byte
- indexes a 1-byte integer value per dimension.
bit
indexes a single bit per dimension. Useful for very high-dimensional vectors or models that specifically support bit vectors. NOTE: when using
bit
, the number of dimensions must be a multiple of 8 and must represent the number of bits.
dims
- (Optional, integer) Number of vector dimensions. Can’t exceed
4096
. Ifdims
is not specified, it will be set to the length of the first vector added to the field.
Stack Serverless
By default, dense_vector
fields are not included in _source
in responses from the _search
, _msearch
, _get
, and _mget
APIs.
This helps reduce response size and improve performance, especially in scenarios where vectors are used solely for similarity scoring and not required in the output.
To retrieve vector values explicitly, you can use:
- The
fields
option to request specific vector fields directly:
POST my-index-2/_search
{
"fields": ["my_vector"]
}
- The
_source.exclude_vectors
flag to re-enable vector inclusion in_source
responses:
POST my-index-2/_search
{
"_source": {
"exclude_vectors": false
}
}
By default, rank_vectors
fields are not stored in _source
on disk. This is also controlled by the index setting index.mapping.exclude_source_vectors
.
This setting is enabled by default for newly created indices and can only be set at index creation time.
When enabled:
rank_vectors
fields are removed from_source
and the rest of the_source
is stored as usual.- If a request includes
_source
and vector values are needed (e.g., during recovery or reindex), the vectors are rehydrated from their internal format.
This setting is compatible with synthetic _source
, where the entire _source
document is reconstructed from columnar storage. In full synthetic mode, no _source
is stored on disk, and all fields — including vectors — are rebuilt when needed.
When vector values are rehydrated (e.g., for reindex, recovery, or explicit _source
requests), they are restored from their internal format. Internally, vectors are stored at float precision, so if they were originally indexed as higher-precision types (e.g., double
or long
), the rehydrated values will have reduced precision. This lossy representation is intended to save space while preserving search quality.
If you want to preserve the original vector values exactly as they were provided, you can re-enable vector storage in _source
:
PUT my-index-include-vectors
{
"settings": {
"index.mapping.exclude_source_vectors": false
},
"mappings": {
"properties": {
"my_vector": {
"type": "rank_vectors",
"dims": 128
}
}
}
}
When this setting is disabled:
rank_vectors
fields are stored as part of the_source
, exactly as indexed.- The index will store both the original
_source
value and the internal representation used for vector search, resulting in increased storage usage. - Vectors are once again returned in
_source
by default in all relevant APIs, with no need to useexclude_vectors
orfields
.
This configuration is appropriate when full source fidelity is required, such as for auditing or round-tripping exact input values.
Rank vectors can be accessed and used in script_score
queries.
For example, the following query scores documents based on the maxSim similarity between the query vector and the vectors stored in the my_vector
field:
GET my-rank-vectors-float/_search
{
"query": {
"script_score": {
"query": {
"match_all": {}
},
"script": {
"source": "maxSimDotProduct(params.query_vector, 'my_vector')",
"params": {
"query_vector": [[0.5, 10, 6], [-0.5, 10, 10]]
}
}
}
}
}
Additionally, asymmetric similarity functions can be used to score against bit
vectors. For example, the following query scores documents based on the maxSimDotProduct similarity between a floating point query vector and bit vectors stored in the my_vector
field:
PUT my-rank-vectors-bit
{
"mappings": {
"properties": {
"my_vector": {
"type": "rank_vectors",
"element_type": "bit"
}
}
}
}
POST /my-rank-vectors-bit/_bulk?refresh
{"index": {"_id" : "1"}}
{"my_vector": [127, -127, 0, 1, 42]}
{"index": {"_id" : "2"}}
{"my_vector": "8100012a7f"}
GET my-rank-vectors-bit/_search
{
"query": {
"script_score": {
"query": {
"match_all": {}
},
"script": {
"source": "maxSimDotProduct(params.query_vector, 'my_vector')",
"params": {
"query_vector": [
[0.35, 0.77, 0.95, 0.15, 0.11, 0.08, 0.58, 0.06, 0.44, 0.52, 0.21,
0.62, 0.65, 0.16, 0.64, 0.39, 0.93, 0.06, 0.93, 0.31, 0.92, 0.0,
0.66, 0.86, 0.92, 0.03, 0.81, 0.31, 0.2 , 0.92, 0.95, 0.64, 0.19,
0.26, 0.77, 0.64, 0.78, 0.32, 0.97, 0.84]
]
}
}
}
}
}
- Note that the query vector has 40 elements, matching the number of bits in the bit vectors.