Skip to content

Commit 0946c62

Browse files
committed
Add a section for vector functions in the doc.
1 parent f9c72c1 commit 0946c62

File tree

3 files changed

+61
-0
lines changed

3 files changed

+61
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
* <<esql-knn>>
2+
* <<esql-v_cosine>>
3+
* <<esql-v_dot_product>>
4+
* <<esql-v_hamming>>
5+
* <<esql-v_l1_norm>>
6+
* <<esql-v_l2_norm>>
7+
* <<esql-v_magnitude>>

docs/reference/query-languages/esql/esql-functions-operators.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,12 @@ mapped_pages:
8080
:::
8181
::::
8282

83+
::::{dropdown} Vector functions
84+
:open:
85+
:::{include} _snippets/lists/vector-functions.md
86+
:::
87+
::::
88+
8389
::::{dropdown} Multi value functions
8490
:open:
8591
:::{include} _snippets/lists/mv-functions.md
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
applies_to:
3+
stack: preview
4+
serverless: preview
5+
navigation_title: "Vector functions"
6+
mapped_pages:
7+
- https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-functions-operators.html#esql-vector-functions
8+
---
9+
10+
# {{esql}} vector functions [esql-vector-functions]
11+
12+
{{esql}} supports vector functions for dense vector similarity calculations and k-nearest neighbor search.
13+
14+
These functions are primarily used for:
15+
- Computing similarity between dense vectors using various similarity metrics
16+
- Finding the k-nearest neighbors in vector space
17+
- Calculating vector magnitudes and norms
18+
19+
:::{note}
20+
Vector functions are currently in **preview** and may change in future versions.
21+
They work with `dense_vector` fields and require appropriate field mappings.
22+
:::
23+
24+
{{esql}} supports these vector functions:
25+
26+
:::{include} ../_snippets/lists/vector-functions.md
27+
:::
28+
29+
:::{include} ../_snippets/functions/layout/knn.md
30+
:::
31+
32+
:::{include} ../_snippets/functions/layout/v_cosine.md
33+
:::
34+
35+
:::{include} ../_snippets/functions/layout/v_dot_product.md
36+
:::
37+
38+
:::{include} ../_snippets/functions/layout/v_hamming.md
39+
:::
40+
41+
:::{include} ../_snippets/functions/layout/v_l1_norm.md
42+
:::
43+
44+
:::{include} ../_snippets/functions/layout/v_l2_norm.md
45+
:::
46+
47+
:::{include} ../_snippets/functions/layout/v_magnitude.md
48+
:::

0 commit comments

Comments
 (0)