Documentation for query_vector base64 parameter by ah89 · Pull Request #142675 · elastic/elasticsearch

ah89 · 2026-02-19T06:22:17Z

Update documentation for query_vector parameter in diversify and knn retrievers to include base64-encoded vector string support and clarify hex-encoded byte vector usage.

Relates to #138190

Update documentation for query_vector parameter in diversify and knn retrievers to include base64-encoded vector string support and clarify hex-encoded byte vector usage. Relates to elastic#138190

elasticsearchmachine · 2026-02-19T06:22:41Z

Pinging @elastic/es-search-relevance (Team:Search Relevance)

github-actions · 2026-02-19T06:23:51Z

🔍 Preview links for changed docs

github-actions · 2026-02-19T06:23:52Z

ℹ️ Important: Docs version tagging

👋 Thanks for updating the docs! Just a friendly reminder that our docs are now cumulative. This means all 9.x versions are documented on the same page and published off of the main branch, instead of creating separate pages for each minor version.

We use applies_to tags to mark version-specific features and changes.

Expand for a quick overview

When to use applies_to tags:

✅ At the page level to indicate which products/deployments the content applies to (mandatory)
✅ When features change state (e.g. preview, ga) in a specific version
✅ When availability differs across deployments and environments

What NOT to do:

❌ Don't remove or replace information that applies to an older version
❌ Don't add new information that applies to a specific version without an applies_to tag
❌ Don't forget that applies_to tags can be used at the page, section, and inline level

🤔 Need help?

Check out the cumulative docs guidelines
Reach out in the #docs Slack channel

elasticsearchmachine · 2026-02-19T07:17:46Z

Pinging @elastic/core-docs (Team:Docs)

benwtrent

Looks mostly good. I am not sure how this versioning stuff works...

docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md

…triever.md Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com>

Adding big-endianess

leemthompo

Thanks @ah89 and @benwtrent for the versioning vigilance!

Couple suggestions here for clarity and syntax. Also makes me think if we're repeating the same info in multiple spots here, we could factor the common stuff out into a reusable snippet and include it wherever we need it. LMKWYT.

You can use the URL previews to verify everything looks OK

docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md

leemthompo · 2026-02-20T09:13:28Z

docs/reference/elasticsearch/rest-apis/retrievers/knn-retriever.md


-    Query vector. Must have the same number of dimensions as the vector field you are searching against. Must be either an array of floats or a hex-encoded byte vector.
+    Query vector. Must have the same number of dimensions as the vector field you are searching against.
+    Must be either an array of floats or a hex-encoded byte vector (one byte per dimension; for `bit`, one byte per 8 dimensions).


copy/paste error here and let's use a list like the first suggestion :)

yeah, @ah89 we need a list here like the diversified retriever and same goes for the knn-query docs please.

docs/reference/query-languages/query-dsl/query-dsl-knn-query.md

Co-authored-by: Liam Thompson <leemthompo@gmail.com>

…triever.md Co-authored-by: Liam Thompson <leemthompo@gmail.com>

Co-authored-by: Liam Thompson <leemthompo@gmail.com>

Eliminates an unnecessary code block for improved clarity and readability in the documentation. No content functionality is affected.

Improves documentation by explicitly listing supported input formats for the kNN retriever and query APIs. Enhances clarity on when to use array, hex, or base64-encoded vectors and the applicable product versions for each format.

github-actions · 2026-03-03T17:54:29Z

Vale Linting Results

Summary: 1 suggestion found

💡 Suggestions (1)

File	Line	Rule	Message
docs/reference/query-languages/query-dsl/query-dsl-knn-query.md	114	Elastic.Semicolons	Use semicolons judiciously.

The Vale linter checks documentation changes against the Elastic Docs style guide.

To use Vale locally or report issues, refer to Elastic style guide for Vale.

* Documentation for query_vector parameter Update documentation for query_vector parameter in diversify and knn retrievers to include base64-encoded vector string support and clarify hex-encoded byte vector usage. Relates to elastic#138190 * Added tag * Update docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com> * Update documentation for query_vector parameter Adding big-endianess * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Removes redundant code block from documentation Eliminates an unnecessary code block for improved clarity and readability in the documentation. No content functionality is affected. --------- Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com> Co-authored-by: Liam Thompson <leemthompo@gmail.com>

…locations * upstream/main: (51 commits) ESQL: Remaining serialization tests (elastic#143470) Eagerly release resources in `TransportAwaitClusterStateVersionAppliedAction` (elastic#143477) Stop and relocate sliced reindex on shutdown (elastic#143183) Documentation for query_vector base64 parameter (elastic#142675) ES|QL: Fix LIMIT after all columns are dropped (elastic#143463) Update docs-build.yml (elastic#142958) Fix KnnIndexTester to work with byte vectors (elastic#143493) Fix IndexInputUtils.withSlice to produce native-safe MemorySegments on Java 21 (elastic#143479) CPS fix: include only relevant projects in the search response metadata (elastic#143367) apm-data: explicit map of timestamp.us to long (elastic#143173) [Inference API] Add custom headers for Azure OpenAI Service (elastic#142969) ESQL: Add name IDs to golden tests and fix synthetic names (elastic#143450) Add getUnavailableShards to BaseBroadcastResponse (elastic#143406) Add description to reindex API without sensitive info (elastic#143112) SQL: fix CLI tests (elastic#143451) ES|QL: Add note of future removal of FORK implicit LIMIT (elastic#143457) [Test] Randomly disable doc values skippers in time-series indices (elastic#143389) Improve pattern text downgrade license test (elastic#143102) [Transform] Stop transforms at the end of tests (elastic#139783) Mute org.elasticsearch.compute.lucene.read.ValueSourceReaderTypeConversionTests testLoadAll elastic#143471 ...

* Documentation for query_vector parameter Update documentation for query_vector parameter in diversify and knn retrievers to include base64-encoded vector string support and clarify hex-encoded byte vector usage. Relates to elastic#138190 * Added tag * Update docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com> * Update documentation for query_vector parameter Adding big-endianess * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md Co-authored-by: Liam Thompson <leemthompo@gmail.com> * Removes redundant code block from documentation Eliminates an unnecessary code block for improved clarity and readability in the documentation. No content functionality is affected. --------- Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com> Co-authored-by: Liam Thompson <leemthompo@gmail.com>

ah89 added 2 commits February 18, 2026 22:05

Documentation for query_vector parameter

70a6cdd

Update documentation for query_vector parameter in diversify and knn retrievers to include base64-encoded vector string support and clarify hex-encoded byte vector usage. Relates to elastic#138190

Merge branch 'elastic:main' into docs/knn-query-vector-base64

9327a1e

ah89 added :Search Relevance/Vectors Vector search documentation v9.4.0 labels Feb 19, 2026

elasticsearchmachine added the Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch label Feb 19, 2026

Added tag

d5b57a8

ah89 added >docs General docs changes and removed documentation labels Feb 19, 2026

elasticsearchmachine added the Team:Docs Meta label for docs team label Feb 19, 2026

benwtrent reviewed Feb 19, 2026

View reviewed changes

docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md Outdated Show resolved Hide resolved

docs/reference/elasticsearch/rest-apis/retrievers/diversify-retriever.md Outdated Show resolved Hide resolved

Update docs/reference/elasticsearch/rest-apis/retrievers/diversify-re…

8495aa5

…triever.md Co-authored-by: Benjamin Trent <ben.w.trent@gmail.com>

ah89 requested a review from a team as a code owner February 19, 2026 20:49

Update documentation for query_vector parameter

e839d7c

Adding big-endianess

leemthompo reviewed Feb 20, 2026

View reviewed changes

ah89 and others added 7 commits February 23, 2026 09:26

Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md

e1f601c

Co-authored-by: Liam Thompson <leemthompo@gmail.com>

Update docs/reference/elasticsearch/rest-apis/retrievers/diversify-re…

033f9be

…triever.md Co-authored-by: Liam Thompson <leemthompo@gmail.com>

Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md

8f76709

Co-authored-by: Liam Thompson <leemthompo@gmail.com>

Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md

b523683

Co-authored-by: Liam Thompson <leemthompo@gmail.com>

Update docs/reference/query-languages/query-dsl/query-dsl-knn-query.md

edf33b2

Co-authored-by: Liam Thompson <leemthompo@gmail.com>

Merge branch 'main' into docs/knn-query-vector-base64

56daae2

Removes redundant code block from documentation

3e07efa

Eliminates an unnecessary code block for improved clarity and readability in the documentation. No content functionality is affected.

ah89 requested review from benwtrent and leemthompo February 24, 2026 17:43

ah89 enabled auto-merge (squash) February 26, 2026 16:01

Clarifies kNN query vector input formats in docs

3aa90cf

Improves documentation by explicitly listing supported input formats for the kNN retriever and query APIs. Enhances clarity on when to use array, hex, or base64-encoded vectors and the applicable product versions for each format.

ah89 and others added 2 commits February 27, 2026 12:48

Merge branch 'main' into docs/knn-query-vector-base64

7ed782b

Merge branch 'main' into docs/knn-query-vector-base64

267ac7e

benwtrent approved these changes Mar 3, 2026

View reviewed changes

ah89 merged commit 590534b into elastic:main Mar 3, 2026
12 checks passed

This was referenced Mar 6, 2026

[ML] Wait for cluster state in test #143767

Merged

[Transform] Disable PIT for CPS #143876

Closed

Conversation

ah89 commented Feb 19, 2026

Uh oh!

elasticsearchmachine commented Feb 19, 2026

Uh oh!

github-actions bot commented Feb 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🔍 Preview links for changed docs

Uh oh!

github-actions bot commented Feb 19, 2026

ℹ️ Important: Docs version tagging

When to use applies_to tags:

What NOT to do:

🤔 Need help?

Uh oh!

elasticsearchmachine commented Feb 19, 2026

Uh oh!

benwtrent left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

leemthompo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

leemthompo Feb 20, 2026

Choose a reason for hiding this comment

Uh oh!

benwtrent Feb 25, 2026

Choose a reason for hiding this comment

Uh oh!

ah89 Feb 27, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Mar 3, 2026

Vale Linting Results

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

github-actions bot commented Feb 19, 2026 •

edited

Loading