documentation-website icon indicating copy to clipboard operation
documentation-website copied to clipboard

Published 20 hours ago • verified publisher icon opensearch-project

Add documentation for k-NN clear cache api

Open naveentatikonda opened this issue 9 months ago • 6 comments

Description

Add documentation for k-NN clear cache api

Issues Resolved

Closes https://github.com/opensearch-project/documentation-website/issues/4346

Checklist

  • [x] By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin. For more information on following Developer Certificate of Origin and signing off your commits, please check here.

naveentatikonda avatar Apr 26 '24 00:04 naveentatikonda

@jmazanec15 Can you please review this PR? Thanks!

naveentatikonda avatar Apr 26 '24 00:04 naveentatikonda

@kolchfa-aws Can you pls review this PR. Thanks!

naveentatikonda avatar Apr 26 '24 16:04 naveentatikonda

@kolchfa-aws Can you pls review this PR. Thanks!

Thanks, @naveentatikonda. @kolchfa-aws is on leave, but another tech writer will review it.

hdhalter avatar Apr 26 '24 17:04 hdhalter

@kolchfa-aws Can you pls review this PR. Thanks!

Thanks, @naveentatikonda. @kolchfa-aws is on leave, but another tech writer will review it.

Got it. Thanks @hdhalter

naveentatikonda avatar Apr 26 '24 17:04 naveentatikonda

@naveentatikonda Certain sections appear to be redundant information to existing documentation, for example, the get model, search model, delete model, and train model. Are these sections different from what we already have published in the Model APIs documentation (https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/index/).

If it's the same, can we delete those section in this PR and direct the users to the Model API documentation instead?

cc: @natebower

vagimeli avatar May 01 '24 20:05 vagimeli

@naveentatikonda Certain sections appear to be redundant information to existing documentation, for example, the get model, search model, delete model, and train model. Are these sections different from what we already have published in the Model APIs documentation (https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/index/).

If it's the same, can we delete those section in this PR and direct the users to the Model API documentation instead?

cc: @natebower

@vagimeli both are different. The link you shared are the ml-commons plugin apis. The model apis we are seeing here are k-NN plugin model apis.

naveentatikonda avatar May 01 '24 20:05 naveentatikonda

@vagimeli Can you pls prioritize this PR and help get this merged asap. Thanks!

naveentatikonda avatar May 07 '24 17:05 naveentatikonda