Skip to content

Conversation

@Naarcha-AWS
Copy link
Contributor

@Naarcha-AWS Naarcha-AWS commented Oct 28, 2024

Updates the capitalization of new default for engine setting, according to developer feedback.

Frontend features

If you're submitting documentation for an OpenSearch Dashboards feature, add a video that shows how a user will interact with the UI step by step. A voiceover is optional.

Checklist

  • 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.

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
@github-actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@Naarcha-AWS Naarcha-AWS added the Tech review PR: Tech review in progress label Oct 28, 2024
@Naarcha-AWS
Copy link
Contributor Author

This PR does not need to be backported since it is related to a 2.18 change, #8620

`name` | true | n/a | false | The identifier for the nearest neighbor method.
`space_type` | false | l2 | false | The vector space used to calculate the distance between vectors. Note: This value can also be specified at the top level of the mapping.
`engine` | false | Faiss | false | The approximate k-NN library to use for indexing and search. The available libraries are Faiss, nmslib, and Lucene.
`engine` | false | faiss | false | The approximate k-NN library to use for indexing and search. The available libraries are Faiss, nmslib, and Lucene.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
`engine` | false | faiss | false | The approximate k-NN library to use for indexing and search. The available libraries are Faiss, nmslib, and Lucene.
`engine` | false | faiss | false | The approximate k-NN library to use for indexing and search. The available libraries are faiss, nmslib, and lucene.

Copy link
Member

Choose a reason for hiding this comment

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

shall we make this change as well?

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

LGTM

@VijayanB
Copy link
Member

Can this be merged?

@Naarcha-AWS Naarcha-AWS merged commit 21ac0cc into main Oct 28, 2024
8 checks passed
epugh pushed a commit to o19s/documentation-website that referenced this pull request Nov 23, 2024
* Fix capitilzation of default engine example

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
@Naarcha-AWS Naarcha-AWS deleted the faiss-example branch December 19, 2024 19:00
epugh pushed a commit to o19s/documentation-website that referenced this pull request Jul 2, 2025
* Fix capitilzation of default engine example

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

* Apply suggestions from code review

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>

---------

Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Eric Pugh <epugh@opensourceconnections.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tech review PR: Tech review in progress

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants