Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
* <<esql-knn>>
* <<esql-v_cosine>>
* <<esql-v_dot_product>>
* <<esql-v_hamming>>
* <<esql-v_l1_norm>>
* <<esql-v_l2_norm>>
* <<esql-v_magnitude>>
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,12 @@ mapped_pages:
:::
::::

::::{dropdown} Vector functions
:open:
:::{include} _snippets/lists/vector-functions.md
:::
::::

::::{dropdown} Multi value functions
:open:
:::{include} _snippets/lists/mv-functions.md
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
applies_to:
stack: preview
serverless: preview
navigation_title: "Vector functions"
mapped_pages:
- https://www.elastic.co/guide/en/elasticsearch/reference/current/esql-functions-operators.html#esql-vector-functions
---

# {{esql}} vector functions [esql-vector-functions]

{{esql}} supports vector functions for dense vector similarity calculations and k-nearest neighbor search.

These functions are primarily used for:
- Computing similarity between dense vectors using various similarity metrics
- Finding the k-nearest neighbors in vector space
- Calculating vector magnitudes and norms

:::{note}
Vector functions are currently in **preview** and may change in future versions.
They work with `dense_vector` fields and require appropriate field mappings.
:::

{{esql}} supports these vector functions:

:::{include} ../_snippets/lists/vector-functions.md
:::

:::{include} ../_snippets/functions/layout/knn.md
:::

:::{include} ../_snippets/functions/layout/v_cosine.md
:::

:::{include} ../_snippets/functions/layout/v_dot_product.md
:::

:::{include} ../_snippets/functions/layout/v_hamming.md
:::

:::{include} ../_snippets/functions/layout/v_l1_norm.md
:::

:::{include} ../_snippets/functions/layout/v_l2_norm.md
:::

:::{include} ../_snippets/functions/layout/v_magnitude.md
:::
1 change: 1 addition & 0 deletions docs/reference/query-languages/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@ toc:
- file: esql/functions-operators/search-functions.md
- file: esql/functions-operators/spatial-functions.md
- file: esql/functions-operators/string-functions.md
- file: esql/functions-operators/vector-functions.md
- file: esql/functions-operators/type-conversion-functions.md
- file: esql/functions-operators/mv-functions.md
- file: esql/functions-operators/operators.md
Expand Down
Loading