Skip to content

Commit e487634

Browse files
authored
[ES|QL] Enable the TEXT_EMBEDDING function in non-snapshot build (#136103)
* Enable text_embedding function in non-snapshot builds. * Regenerate documentation for the TEXT_EMBEDDING function. * Clean useless conditional in tests. * Lint * Update docs/changelog/136103.yaml * Update usage to make sure text_embedding function is present in non-snapshot builds. * Add text_embedding to the doc. * Fix typo. * Fix typo again ... * Update examples. * Fix typo in code. * Fix typo * Improved doc for the TEXT_EMBEDDING function * Add missing link in the doc. * Apply changes from review. * Restore missing examples. * Update examples descriptions. * Few additional doc rework.
1 parent da2cc5d commit e487634

File tree

19 files changed

+91
-73
lines changed

19 files changed

+91
-73
lines changed

docs/changelog/136103.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
pr: 136103
2+
summary: Enable the TEXT_EMBEDDING function in non-snapshot build
3+
area: ES|QL
4+
type: feature
5+
issues: []

docs/reference/query-languages/esql/_snippets/functions/description/text_embedding.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/examples/text_embedding.md

Lines changed: 17 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/layout/text_embedding.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/functions/parameters/text_embedding.md

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/_snippets/lists/dense-vector-functions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
* {applies_to}`stack: preview 9.2` {applies_to}`serverless: preview` [`KNN`](../../functions-operators/dense-vector-functions.md#esql-knn)
2+
* {applies_to}`stack: preview 9.3` {applies_to}`serverless: preview` [`TEXT_EMBEDDING`](../../functions-operators/dense-vector-functions.md#esql-text_embedding)
23

34
% * {applies_to}`stack: preview 9.3` {applies_to}`serverless: preview` [`V_COSINE`](../../functions-operators/dense-vector-functions.md#esql-v_cosine)
45
% * {applies_to}`stack: preview 9.3` {applies_to}`serverless: preview` [`V_DOT_PRODUCT`](../../functions-operators/dense-vector-functions.md#esql-v_dot_product)

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ and require appropriate field mappings.
2323
:::{include} ../_snippets/functions/layout/knn.md
2424
:::
2525

26+
:::{include} ../_snippets/functions/layout/text_embedding.md
27+
:::
28+
2629
% V_COSINE is currently a hidden feature
2730
% To make it visible again, uncomment this and the line in
2831
% lists/dense-vector-functions.md

docs/reference/query-languages/esql/kibana/definition/functions/text_embedding.json

Lines changed: 7 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/reference/query-languages/esql/kibana/docs/functions/text_embedding.md

Lines changed: 1 addition & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

x-pack/plugin/esql/qa/testFixtures/src/main/resources/text-embedding.csv-spec

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ text_embedding using a row source operator
22
required_capability: text_embedding_function
33
required_capability: dense_vector_field_type_released
44

5-
// tag::embedding-eval[]
5+
// tag::text-embedding-eval[]
66
ROW input="Who is Victor Hugo?"
77
| EVAL embedding = TEXT_EMBEDDING("Who is Victor Hugo?", "test_dense_inference")
8+
// end::text-embedding-eval[]
89
;
9-
// end::embedding-eval[]
1010

1111
input:keyword | embedding:dense_vector
1212
Who is Victor Hugo? | [56.0, 50.0, 48.0]
@@ -32,9 +32,11 @@ required_capability: dense_vector_field_type_released
3232
required_capability: knn_function_v5
3333
required_capability: semantic_text_field_caps
3434

35+
// tag::text-embedding-knn[]
3536
FROM semantic_text METADATA _score
3637
| EVAL query_embedding = TEXT_EMBEDDING("be excellent to each other", "test_dense_inference")
3738
| WHERE KNN(semantic_text_dense_field, query_embedding)
39+
// end::text-embedding-knn[]
3840
| SORT _score DESC
3941
| LIMIT 10
4042
| KEEP semantic_text_field, query_embedding
@@ -52,8 +54,10 @@ required_capability: dense_vector_field_type_released
5254
required_capability: knn_function_v5
5355
required_capability: semantic_text_field_caps
5456

57+
// tag::text-embedding-knn-inline[]
5558
FROM semantic_text METADATA _score
5659
| WHERE KNN(semantic_text_dense_field, TEXT_EMBEDDING("be excellent to each other", "test_dense_inference"))
60+
// end::text-embedding-knn-inline[]
5761
| SORT _score DESC
5862
| LIMIT 10
5963
| KEEP semantic_text_field

0 commit comments

Comments
 (0)