Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Update k-NN plugin documentation to reflect explain API for Exact/ANN/Radial/Disk/Filtering k-nn search. #9155

Open
1 of 4 tasks
neetikasinghal opened this issue Feb 5, 2025 · 1 comment
Assignees
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v3.0.0

Comments

@neetikasinghal
Copy link

neetikasinghal commented Feb 5, 2025

What do you want to do?

  • Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request.
With recent changes the end users of knn plugin should be able to use explain API for Exact/ANN/Radial/Disk/Filtering based k-nn search which can help them debug and troubleshoot issues on their own.

Version: 3.0 & +

What other resources are available?
PR: opensearch-project/k-NN#2403
Proposal for explain is given here: opensearch-project/k-NN#875 (comment)
Output : opensearch-project/k-NN#875 (comment)

@Naarcha-AWS Naarcha-AWS added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Feb 5, 2025
@opensearch-ci-bot
Copy link

Hi @neetikasinghal
,

As part of the entrance criteria, all the documentation pull requests need to be drafted and in technical review.

Since there is no pull request linked to this issue, please take one of the following actions:

  • Create the pull request and link it to this issue.
  • If you already have a pull request created, please link it to this issue.
  • If this feature is not targeted for the currently labeled release version, please update the issue with the correct release version.

Please note: Missing documentation can block the release and cause delays in the overall process.

Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. v3.0.0
Projects
None yet
Development

No branches or pull requests

3 participants