Skip to content

ES|QL: Update docs for TOP_SNIPPETS and DECAY#143739

Merged
ioanatia merged 2 commits intoelastic:mainfrom
ioanatia:search_function_docs
Mar 6, 2026
Merged

ES|QL: Update docs for TOP_SNIPPETS and DECAY#143739
ioanatia merged 2 commits intoelastic:mainfrom
ioanatia:search_function_docs

Conversation

@ioanatia
Copy link
Copy Markdown
Member

@ioanatia ioanatia commented Mar 6, 2026

Changes in Decay docs

Decay docs are missing a description for options:

Screenshot 2026-03-06 at 13 45 15

Changes in TOP_SNIPPETS docs

TOP_SNIPPETS has a seemingly random note about controlling the cost of inference using num_words - but we lack any context of what this means, so I added an example using RERANK:

Screenshot 2026-03-06 at 13 46 11

@ioanatia ioanatia added >docs General docs changes Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch :Search Relevance/ES|QL Search functionality in ES|QL labels Mar 6, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 6, 2026 •
edited
Loading

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (2)
  • Team:Delivery
  • Team:Search - Inference

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 1c1a0ca5-0155-45b9-a896-eefcf26f905b

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 6, 2026

ℹ️ 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?

@ioanatia ioanatia marked this pull request as ready for review March 6, 2026 14:44
@ioanatia ioanatia requested a review from a team as a code owner March 6, 2026 14:44
@elasticsearchmachine
Copy link
Copy Markdown
Collaborator

elasticsearchmachine commented Mar 6, 2026

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

carlosdelest
carlosdelest approved these changes Mar 6, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@carlosdelest carlosdelest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗒️ 🖊️

leemthompo
leemthompo approved these changes Mar 6, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nice! One question

.../esql/src/main/java/org/elasticsearch/xpack/esql/expression/function/scalar/score/Decay.java
) Expression scale,
@MapParam(
name = "options",
description = "(Optional) Additional options such as `decay`, `offset` and `type`.",
Copy link
Copy Markdown
Member

@leemthompo leemthompo Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is decay an option on decay?

Copy link
Copy Markdown
Member Author

@ioanatia ioanatia Mar 6, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yep 👍

@ioanatia ioanatia merged commit 3c675d5 into elastic:main Mar 6, 2026
37 checks passed
szybia added a commit to szybia/elasticsearch that referenced this pull request Mar 6, 2026
@szybia
Merge remote-tracking branch 'upstream/main' into get-reindex-with-re…
fc6b97d 
…locations

* upstream/main: (153 commits)
  ES|QL: Update docs for TOP_SNIPPETS and DECAY (elastic#143739)
  Correctly include endpoint id in log msg in AuthorizationPoller (elastic#143743)
  Bar searching or sorting on _seq_no when disabled (elastic#143600)
  Generalize `testClientCancellation` test (elastic#143586)
  JSON_EXTRACT: zero-copy byte slicing for object, array, and number extraction (elastic#143702)
  Track recycler pages in circuit breaker (elastic#143738)
  [ESQL] Enable distributed pipeline breakers for external sources via FragmentExec (elastic#143696)
  Adding 'mode' and 'codec' fields to ES monitoring template (elastic#143673)
  [ESQL] Columnar I/O and vectorized block conversion for external sources (elastic#143703)
  Fix flaky MMR diversification YAML tests (elastic#143706)
  ES|QL codegen: check builder arguments for vector support (elastic#143724)
  Add Views Security Model (elastic#141050)
  ESQL: Prevent pushdown of unmapped fields in filters and sorts (elastic#143460)
  Don't run seq_no pruning tests in release CI (elastic#143725)
  ESQL: Support intra-row field references in ROW command (elastic#140217)
  ES|QL: Remove implicit limit in FORK branches in CSV tests (elastic#143601)
  IndexRoutingTests with and without synthetic id (elastic#143566)
  Synthetic id upgrade test in serverless (elastic#142471)
  Disable "Review skipped" comments for PRs without specified labels (elastic#143728)
  Cleanup ES|QL T-Digest code duplication, add memory accounting (elastic#143662)
  ...
@prwhelan prwhelan mentioned this pull request Mar 6, 2026
Merged
sidosera pushed a commit to sidosera/elasticsearch that referenced this pull request Mar 6, 2026
@ioanatia @sidosera
ES|QL: Update docs for TOP_SNIPPETS and DECAY (elastic#143739)
65f3ebd
@prwhelan prwhelan mentioned this pull request Mar 9, 2026
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@carlosdelest carlosdelest carlosdelest approved these changes

@leemthompo leemthompo leemthompo approved these changes

@pmpailis pmpailis Awaiting requested review from pmpailis

Assignees

No one assigned

Labels

>docs General docs changes :Search Relevance/ES|QL Search functionality in ES|QL Team:Search Relevance Meta label for the Search Relevance team in Elasticsearch v9.4.0

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@ioanatia @elasticsearchmachine @carlosdelest @leemthompo