Skip to content

docs: add Explain API Support report for v3.0.0#350

Merged
tkykenmt merged 1 commit intomainfrom
docs/explain-api-support-v3.0.0
Jan 8, 2026
Merged

docs: add Explain API Support report for v3.0.0#350
tkykenmt merged 1 commit intomainfrom
docs/explain-api-support-v3.0.0

Conversation

@tkykenmt
Copy link
Copy Markdown
Owner

@tkykenmt tkykenmt commented Jan 8, 2026

Summary

This PR adds documentation for the Explain API Support feature introduced in OpenSearch v3.0.0 for the k-NN plugin.

Changes

Release Report

  • docs/releases/v3.0.0/features/k-nn/explain-api-support.md

Feature Report

  • docs/features/k-nn/explain-api.md

Index Updates

  • Updated docs/releases/v3.0.0/index.md
  • Updated docs/features/index.md

Key Changes in v3.0.0

  • Added Explain API support for k-NN queries using the Faiss engine
  • Supports Exact, Approximate-NN (ANN), Radial, and Disk-based k-NN searches
  • Provides detailed scoring explanations including raw scores and score translation formulas
  • Explains why exact search was chosen over ANN in filtered scenarios

Related

@tkykenmt tkykenmt merged commit b5170f8 into main Jan 8, 2026
@tkykenmt tkykenmt deleted the docs/explain-api-support-v3.0.0 branch January 8, 2026 23:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant